Template:Quickstart/doc: Difference between revisions
Substitute templates so the documentation doesn't get categorized under quickstart guides |
ArrowHead294 (talk | contribs) mNo edit summary |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{dochead}} | {{dochead}}{{substitute|no}} | ||
The '''Quickstart''' template adds a message box to inform readers that a page is a quickstart guide. Quickstart guides contain information needed to start composing or playing with a tuning, temperament, or scale. Pages with this template are placed in [[:Category:Quickstart guides]]. | |||
=== Usage === | === Usage === | ||
This template should be placed at the top of the page, with a single unnamed argument that indicates the corresponding article. | This template should be placed at the top of the page, with a single unnamed argument that indicates the corresponding article. | ||
Line 5: | Line 7: | ||
If a page is not provided and one is intended to be made, then the following message box is produced: | If a page is not provided and one is intended to be made, then the following message box is produced: | ||
<pre>{{Quickstart}}</pre> | |||
{{Mbox | {{Mbox | ||
| icon=Icon-Quickstart.png | | icon=Icon-Quickstart.png | ||
| text='''This is a [[:Category:Quickstart guides|quickstart guide]] | | text='''This is a [[:Category:Quickstart guides|quickstart guide]].'''<br />Information on how to start composing or playing can be found here. | ||
}} | }} | ||
On a guide page for [[5L 2s]], adding the following code produces the message box: | On a guide page for [[5L 2s]], adding the following code produces the message box: | ||
<pre>{{Quickstart|5L 2s}}</pre> | |||
{{Mbox | {{Mbox | ||
| icon=Icon-Quickstart.png | | icon=Icon-Quickstart.png | ||
| text='''This is a [[:Category:Quickstart guides|quickstart guide]] | | text='''This is a [[:Category:Quickstart guides|quickstart guide]] for [[5L 2s]].'''<br />Information on how to start composing or playing can be found here. | ||
}} | }} | ||
If a quickstart guide is not meant to have a corresponding article, then passing in <code>nopage</code> as an unnamed argument produces the following: | If a quickstart guide is not meant to have a corresponding article, then passing in <code>nopage</code> as an unnamed argument produces the following: | ||
<pre>{{Quickstart|nopage}}</pre> | |||
{{Mbox | {{Mbox | ||
| icon=Icon-Quickstart.png | | icon=Icon-Quickstart.png | ||
| text='''This is a [[:Category:Quickstart guides|quickstart guide]] | | text='''This is a [[:Category:Quickstart guides|quickstart guide]]. No corresponding article currently exists for this guide.'''<br />Information on how to start composing or playing can be found here. | ||
}} | }} | ||
=== See also === | === See also === | ||
* [[Template:Has quickstart]] | * [[Template:Has quickstart]] | ||
* [[Template:Beginner]] | * [[Template:Beginner]] |