Jump to navigation
Jump to search
→Creating a template: addition, added Documentation Subpages section
m (→Using parameters in templates: Fixed links) |
Notmyhandle (talk | contribs) (→Creating a template: addition, added Documentation Subpages section) |
||
| Line 10: | Line 10: | ||
Every template must be placed within a category, either [[:Category:Templates]] or [[:Category:Guide-specific templates]]. | Every template must be placed within a category, either [[:Category:Templates]] or [[:Category:Guide-specific templates]]. | ||
If you want to modify a template it's usually good to discuss it within the talk page if it's a major change. Making multiple changes to templates used on multiple pages can cause disastrous effects and bog down the job queue, so it's best to discuss changes on the talk page or try your idea in a sandbox before any changes are made. Most widely-used templates, like [[Template:Infobox]] are protected to avoid this, so a discussion is the perfect way to get your ideas heard. Protected templates will require a [[StrategyWiki:Administrators|sysop/admin]] to make the change. | If you want to modify a template it's usually good to discuss it within the talk page if it's a major change. Making multiple changes to templates used on multiple pages can cause disastrous effects and bog down the job queue (increasing the server workload), so it's best to discuss changes on the talk page or try your idea in a sandbox before any changes are made. Most widely-used templates, like [[Template:Infobox]] are protected to avoid this, so a discussion is the perfect way to get your ideas heard. Protected templates will require a [[StrategyWiki:Administrators|sysop/admin]] to make the change. | ||
Categorization, careful naming, and maintaining a hierarchy is key in ensuring that our templates don't get cluttered. Templates are critical for reducing redundancy, but they are powerful tools that must be given respect and much thought so that they don't in themselves become redundant. | Categorization, careful naming, and maintaining a hierarchy is key in ensuring that our templates don't get cluttered. Templates are critical for reducing redundancy, but they are powerful tools that must be given respect and much thought so that they don't in themselves become redundant. | ||
=== Documentation Subpages === | |||
When a template becomes widely used, such as [[:Template:Infobox]], it's necessary to move the documentation (a.k.a. explanation) of the template to another page. By doing this, it allows users to modify the examples and explanations while not increasing the job queue. | |||
Rules for creating a documentation subpage: | |||
*The page must be titled "Documentation" - for example: {{t|Infobox/Documentation}}. | |||
*The subpage should not be categorized, however the template's categories should be listed here, surrounded by <nowiki><includeonly></nowiki> tags. | |||
*{{t|Documentation subpage}} should be placed at the top. | |||
==Using a template== | ==Using a template== | ||