56,648
edits
Help:Templates: Difference between revisions
m
Text replacement - "<code><br style="clear:both;" /></code>" to "<code><nowiki><div style="clear:both"></div></nowiki></code>"
Serpent King (talk | contribs) mNo edit summary |
m (Text replacement - "<code><br style="clear:both;" /></code>" to "<code><nowiki><div style="clear:both"></div></nowiki></code>") |
||
| (5 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{helppage}} | {{helppage}} | ||
'''Templates''' are tools used in our articles that serve to both provide consistency and simplify the editing process. They may be used to quickly and easily build tables or infoboxes, or they could be used as link shortcuts. For a list of usable templates, see [[:Category:Templates]]. | '''Templates''' are tools used in our articles that serve to both provide consistency and simplify the editing process. They may be used to quickly and easily build tables or infoboxes, or they could be used as link shortcuts. For a list of usable templates, see [[:Category:Templates]]. | ||
==What are templates?== | |||
Wiki templates provide a means to insert the same content over and over in different (or the same) pages. This saves editors the hassle of duplicating the same text again and again, and also helps ensure consistency. | |||
Templates are generally shown with the format required to use the template (i.e. <code>{{t|stub}}</code>). Searching the template name takes you to the template's page, where you can see what it looks like and how it is used. | |||
'''Detailed instructions on the usage of each template should exist either on the template page, or the template's talk page.''' | |||
==Using templates== | ==Using templates== | ||
| Line 18: | Line 26: | ||
Substitution is a different form of transclusion in which the template is "written" directly to the page when used (that is, the text that the template produces actually gets inserted where substituted). If a template is substituted, the page the template is used on will not be added to the template's "What links here" page as it would if a normal transclusion occurred. | Substitution is a different form of transclusion in which the template is "written" directly to the page when used (that is, the text that the template produces actually gets inserted where substituted). If a template is substituted, the page the template is used on will not be added to the template's "What links here" page as it would if a normal transclusion occurred. | ||
*The most used template that should be substituted is {{t|Welcome}} | *The most used template that should be substituted is {{t|Welcome}} | ||
==Common templates== | |||
There are many '''templates''' in use on SmashWiki, and these are only subset, representing some of the most important and commonly used ones. If you feel that a template belongs on this page, do not hesitate to add it. | |||
* [[:Category:Templates]] should list all templates in the wiki, categorized into the various subcategories. | |||
* The Template namespace always has all templates in the wiki, unsorted. | |||
===User organization=== | |||
{{t|todo}} | |||
*Just Add it to your user page and then save. The To Do List Template should appear in blank with the options of edit -history - watch - refresh, from the template choose edit and add articles for you to Wikify, expand, merge, crate, etc. in the source code. | |||
===[[:Category:Article management templates|Article management templates]]=== | |||
====Nominate an article for deletion==== | |||
{{t|delete}} | |||
* Add this to an article to nominate it for deletion. It will add the article to [[:Category:Candidates for deletion]]. | |||
====Disambiguation articles==== | |||
{{t|disambig}} | |||
* If you have several articles that have similar or identical names, you may wish to create a "disambiguation" page at the main article name, with the articles taking an extra phrase in brackets afterwards. For example: | |||
: '''<nowiki>[[The Prince]]</nowiki>''' <-- disambiguation page, with links to: | |||
:: <nowiki>[[The Prince (frog)]]</nowiki> | |||
:: <nowiki>[[The Prince (human)]]</nowiki> | |||
* For more information, see [[wikipedia:Wikipedia:disambiguation|disambiguation on Wikipedia]]. | |||
* Using {{t|disambig}} marks an article as a disambiguation page by adding a banner to the article and categorizing it under [[:Category:Disambiguation]]. Add links to the various articles above the banner. | |||
====Stubbing==== | |||
{{t|stub}} | |||
* When a page has little or no useful information, then it is likely a stub. This template will include them in [[:Category:Stubs]], and is used to list which articles need expanding. | |||
===Template category template=== | |||
{{t|templatecategory}} | |||
* This should be added to any template-related categories, to list template-specific categorising details (these are different to those of normal pages). | |||
===[[:Category:General wiki templates|General wiki templates]]=== | |||
====Clear==== | |||
{{t|clr}}, plus {{t|clrl}} and {{t|clrr}} | |||
* This template is used to reduce the amount of non-wikicode used on pages, replacing the code <code><nowiki><div style="clear:both"></div></nowiki></code>. Its use should generally be avoided. | |||
* You can use {{t|clr}} instead of the HTML tag that clears space below things like images, pictures and tables, so the following stuff doesn't begin until the bottom of the image, picture or table box. | |||
* You can also use {{t|clrl}} or {{t|clrr}} to clear only left or right floats. | |||
====For==== | |||
{{t|for|name|link}} | |||
* Use at the top of articles as a simple "for x see y" template. | |||
====Main article==== | |||
{{t|main|main article}} | |||
* Use at the start of a section to link to the main article on it. | |||
====T is for template==== | |||
{{t|t|template}} | |||
* This template allows you to show example template code (with a link to the templates) without using the template itself. It is used extensively on this page. | |||
====Welcome==== | |||
{{t|welcome}} | |||
* A template to welcome new users with. Should be customized for the wiki. | |||
====Wikipedia==== | |||
{{t|wikipedia}}, <nowiki>{{wikipedia-deleted}}</nowiki> | |||
* Wikipedia-related templates. Use {{t|wikipedia}} for articles taken directly from Wikipedia. | |||
==Template creation - things to consider== | |||
Any [[SW:AUTO|autoconfirmed]] user can create a template on the Wiki. However, when deciding to make a template, some important things must be considered: | |||
*'''Is this template for personal use?''' Personal use templates should not be in the template namespace. Instead, they should be in [[SW:USER|user subpages]], and can be used with the formatting <nowiki>{{ [User subpage name] }}</nowiki>. | |||
*'''Is there already a template that serves this purpose?''' Always check the list of templates to see if such a template already exists. Duplicate templates will just cause unnecessary confusion. | |||
*'''Is this template needed?''' Consider if this template is really necessary. How often would it be used? Will other users agree with its creation? A good rule of thumb is to create a proposal, per [[SW:CONSENSUS]], to establish that this template is both wanted and needed. | |||
If you are satisfied with these considerations, then feel free to create the template. | |||
==Building templates== | ==Building templates== | ||
| Line 114: | Line 202: | ||
Inclusion tags serve the purpose of dictating what gets included where when transcluding. This is typically used for categories and template documentation. There are 3 tags: | Inclusion tags serve the purpose of dictating what gets included where when transcluding. This is typically used for categories and template documentation. There are 3 tags: | ||
*'''includeonly''' text will appear only in the transclusion, not in the template. | *'''includeonly''' text will appear only in the transclusion, not in the template. | ||
*''' | *'''noinclude''' text will not appear in the transclusion, only in the template. | ||
*'''onlyinclude''' is a bit different: only the text wrapped in the onlyinclude tags will be transcluded, nothing else. Does not affect the source template whatsoever. | *'''onlyinclude''' is a bit different: only the text wrapped in the onlyinclude tags will be transcluded, nothing else. Does not affect the source template whatsoever. | ||
| Line 121: | Line 209: | ||
!Template contents!!Template text!!Contents when transcluded | !Template contents!!Template text!!Contents when transcluded | ||
|- | |- | ||
|This template has <includeonly>stuff</includeonly>.||This template has .||This template has stuff. | |<code><nowiki>This template has <includeonly>stuff</includeonly>.</nowiki></code>||This template has .||This template has stuff. | ||
|- | |- | ||
|This template has <noinclude>stuff</noinclude>.||This template has stuff.||This template has . | |<code><nowiki>This template has <noinclude>stuff</noinclude>.</nowiki></code>||This template has stuff.||This template has . | ||
|- | |- | ||
|This template has <onlyinclude>stuff</onlyinclude>.||This template has stuff.||stuff | |<code><nowiki>This template has <onlyinclude>stuff</onlyinclude>.</nowiki></code>||This template has stuff.||stuff | ||
|} | |} | ||
{{helpnav}} | {{helpnav}} | ||