Template:Quickstart/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
ArrowHead294 (talk | contribs)
Docpage
 
ArrowHead294 (talk | contribs)
mNo edit summary
 
(7 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.


For example, on a guide page for [[5L 2s]], adding the following code produces the message box:
If a page is not provided and one is intended to be made, then the following message box is produced:
: <code>{{((}}Quickstart{{pipe}}5L 2s{{))}}</code>
 
<pre>{{Quickstart}}</pre>
{{Mbox
{{Mbox
| icon=Icon-Quickstart.png
| icon=Icon-Quickstart.png
| 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.
| text='''This is a [[:Category:Quickstart guides|quickstart guide]]&#46;'''<br />Information on how to start composing or playing can be found here.
}}
}}
If a page is not provided and one is intended to be made, then the following message box is produced:
 
: <code>{{((}}Quickstart{{))}}</code>
On a guide page for [[5L&nbsp;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]]. No corresponding article currently exists for this guide.'''<br>Information on how to start composing or playing can be found here.
| text='''This is a [[:Category:Quickstart guides|quickstart guide]]&#32;for [[5L&nbsp;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:
: <code>{{((}}Quickstart{{pipe}}nopage{{))}}</code>
 
<pre>{{Quickstart|nopage}}</pre>
{{Mbox
{{Mbox
| icon=Icon-Quickstart.png
| icon=Icon-Quickstart.png
| text='''This is a [[:Category:Quickstart guides|quickstart guide]].'''<br>Information on how to start composing or playing can be found here.
| 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]]

Latest revision as of 22:01, 25 May 2025

This template should not be substituted.

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

This template should be placed at the top of the page, with a single unnamed argument that indicates the corresponding article.

If a page is not provided and one is intended to be made, then the following message box is produced:

{{Quickstart}}
This is a quickstart guide.
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:

{{Quickstart|5L 2s}}
This is a quickstart guide for 5L 2s.
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 nopage as an unnamed argument produces the following:

{{Quickstart|nopage}}
This is a quickstart guide. No corresponding article currently exists for this guide.
Information on how to start composing or playing can be found here.

See also