Template:Documentation subpage: Difference between revisions
Jump to navigation
Jump to search
FaeriMagic (talk | contribs) mNo edit summary |
FaeriMagic (talk | contribs) mNo edit summary |
||
(4 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{#ifeq:{{SUBPAGENAME}}|doc| | {{#ifeq:{{SUBPAGENAME}}|doc| | ||
<div class="documentation-subpage" style="border: 1px solid #ccc; background-color: #f9f9f9; padding: 1em; margin: 1em 0;"> | <div class="documentation-subpage" style="border: 1px solid #ccc; background-color: #f9f9f9; padding: 1em; margin: 1em 0;"> | ||
This is the <code>/doc</code> subpage of [[{{{1 | This is the <code>/doc</code> subpage of [[{{#titleparts:{{FULLPAGENAME}}|1}}]]. Any changes made here will reflect on the main template page. | ||
[[Category:Documentation subpages]] | [[Category:{{{cat|Documentation subpages}}}]] | ||
</div>}}<noinclude> | </div>}}<noinclude> | ||
<templatedata> | |||
{ | |||
"params": { | |||
"cat": { | |||
"label": "Category", | |||
"description": "Specifies which category to label the template under.", | |||
"type": "string", | |||
"default": "Documentation subpages", | |||
"suggested": true | |||
}, | |||
"1": { | |||
"label": "Base page name", | |||
"description": "If set, overrides the automatically detected base template name (used when this template fails to detect the parent template).", | |||
"type": "string", | |||
"required": false, | |||
"example": "Template:MyTemplate" | |||
} | |||
}, | |||
"description": "Used on /doc subpages to display that the current page is a documentation subpage of a template. If no parameter is passed, it defaults to the base name of the current page.", | |||
"paramOrder": [ | |||
"1", | |||
"cat" | |||
] | |||
} | |||
</templatedata> | |||
{{Documentation}} | {{Documentation}} | ||
Line 12: | Line 37: | ||
This is the <code>/doc</code> subpage of [[:Template:Documentation subpage]]. Any changes made here will reflect on the main template page.</div> | This is the <code>/doc</code> subpage of [[:Template:Documentation subpage]]. Any changes made here will reflect on the main template page.</div> | ||
[[Category:Documentation templates]] | [[Category:Documentation templates]] | ||
[[Category:Templates with parameters (optional)]] | |||
</noinclude> | </noinclude> |
Latest revision as of 17:38, 31 July 2025
Used on /doc subpages to display that the current page is a documentation subpage of a template. If no parameter is passed, it defaults to the base name of the current page.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Base page name | 1 | If set, overrides the automatically detected base template name (used when this template fails to detect the parent template).
| String | optional |
Category | cat | Specifies which category to label the template under.
| String | suggested |
Basic usage
In most cases, the following code is sufficient on its own:
<noinclude> {{Documentation subpage}} </noinclude>
However, a parameter may need to be specified if:
- The documentation is used on a page that is not a subpage. (e.g. test pages)
- The documentation is for a non-template page. (e.g.
Module:
pages) - One or both pages use non-standard naming conventions. (e.g.
{{Documentation subpage|Template:Artist/Album}}
)
<noinclude> {{Documentation subpage|The page you want to point to}} </noinclude>
Example
Below is a working example using a subpage at Template:Documentation subpage/doc:
This is the
/doc
subpage of Template:Documentation subpage. Any changes made here will reflect on the main template page.