Template:Suite/doc: Difference between revisions
From MediaWiki
Jump to navigationJump to searchGeewunling (talk | contribs) |
Updating now some of the code has been split to subsuite. |
||
| Line 1: | Line 1: | ||
'''<tt><nowiki>{{suite}}</nowiki></tt>''' | '''<tt><nowiki>{{suite}}</nowiki></tt>''' and '''<tt><nowiki>{{subsuite}}</nowiki></tt>''' are templates which create a quicknav for an article "suite"; usually one article which has been broken into many pieces for length. | ||
Add '''<tt><nowiki>{{ | Add '''<tt><nowiki>{{subsuite}}</nowiki></tt>''' to the top of each page with the article names in a list. | ||
{{ | {{subsuite|content=* [[Optimus Prime (G1)]] | ||
* [[Optimus Prime (G1)/toys]] | * [[Optimus Prime (G1)/toys]] | ||
}} | }} | ||
<pre>{{ | <pre>{{subsuite|content=* [[Optimus Prime (G1)]] | ||
* [[Optimus Prime (G1)/toys]] | * [[Optimus Prime (G1)/toys]] | ||
}}</pre> | }}</pre> | ||
When '''<tt><nowiki>{{ | When '''<tt><nowiki>{{subsuite}}</nowiki></tt>''' is used after a ''disambig'' tag, it will automatically switch to a truncated form and 'hug' the template above. (Occupying the empty space to the right of the continuity note without pushing article content down.) | ||
==<nowiki>{{ | ==<nowiki>{{suite}}</nowiki>== | ||
If a page is broken into ''many pieces'' (such as [[Optimus Prime (G1)]]) it may be preferable to create a single sub-page with the suite contents rather than updating it on all the pages by hand. Create a page such as [[Optimus Prime (G1)/suite]], and include the template as described above | If a page is broken into ''many pieces'' (such as [[Optimus Prime (G1)]]) it may be preferable to create a single sub-page with the suite contents rather than updating it on all the pages by hand. Create a page such as [[Optimus Prime (G1)/suite]], and include the template as described above. | ||
You can then add the bare tag '''<tt><nowiki>{{suite}}</nowiki></tt>''' with ''no'' parameters and the "/suite" subpage will be automatically included. | You can then add the bare tag '''<tt><nowiki>{{suite}}</nowiki></tt>''' with ''no'' parameters and the "/suite" subpage will be automatically included. | ||
| Line 19: | Line 19: | ||
==Technical notes== | ==Technical notes== | ||
* [[Template: Subsuite]] | * [[Template: Subsuite]] was previously a redirect to suite, but now holds the actual template code for generating the suite contents. | ||
<noinclude>[[Category: Externalized documentation]]</noinclude> | <noinclude>[[Category: Externalized documentation]]</noinclude> | ||
Revision as of 02:24, 17 January 2013
{{suite}} and {{subsuite}} are templates which create a quicknav for an article "suite"; usually one article which has been broken into many pieces for length.
Add {{subsuite}} to the top of each page with the article names in a list.
{{subsuite|content=* [[Optimus Prime (G1)]]
* [[Optimus Prime (G1)/toys]]
}}
When {{subsuite}} is used after a disambig tag, it will automatically switch to a truncated form and 'hug' the template above. (Occupying the empty space to the right of the continuity note without pushing article content down.)
{{suite}}
If a page is broken into many pieces (such as Optimus Prime (G1)) it may be preferable to create a single sub-page with the suite contents rather than updating it on all the pages by hand. Create a page such as Optimus Prime (G1)/suite, and include the template as described above.
You can then add the bare tag {{suite}} with no parameters and the "/suite" subpage will be automatically included.
The automatic inclusion checks for the existence of a "/suite" page, and if not found moves one level 'up' the page heirarchy. So a page such as "Optimus Prime (G1)/Machine Wars/toys" would break this function because it would need to go up two levels. Since at this time no page on the wiki uses such a format... the template author doesn't really care, but he'll add another layer of checks if it ever becomes an issue.
Technical notes
- Template: Subsuite was previously a redirect to suite, but now holds the actual template code for generating the suite contents.
