Template:Documentation subpage/doc: Difference between revisions
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: | ||
< | {{Documentation subpage}} <!-- Adds [[Category:Documentation subpage]] --> | ||
<noinclude>This template displays a notice that the current page is a [[:Category:Documentation subpages|documentation subpage]] of a template.</noinclude> | |||
== Basic usage == | == Basic usage == | ||
In most cases, the following code is sufficient on its own: | |||
<pre><nowiki> | <pre><nowiki> | ||
<noinclude> | <noinclude> | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
</noinclude></nowiki></pre> | |||
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. <code><nowiki>Module:</nowiki></code> pages) | |||
* One or both pages use non-standard naming conventions. (e.g. <code><nowiki>{{Documentation subpage|Template:Artist/Album}}</nowiki></code>) | |||
<pre><nowiki> | |||
<noinclude> | |||
{{Documentation subpage|The page you want to point to}} | |||
</noinclude></nowiki></pre> | </noinclude></nowiki></pre> | ||
| Line 12: | Line 23: | ||
Below is a working example using a subpage at [[:Template:Documentation subpage/doc]]: | Below is a working example using a subpage at [[:Template:Documentation subpage/doc]]: | ||
{{Documentation subpage}} | <blockquote>{{Documentation subpage}}</blockquote> | ||
[[Category:Documentation subpages]] | [[Category:Documentation subpages]] | ||
</noinclude> | </noinclude> | ||
Latest revision as of 16:00, 30 July 2025
This is the /doc subpage of Template:Documentation subpage. Any changes made here will reflect on the main template page.
This template displays a notice that the current page is a documentation subpage of a template.
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
/docsubpage of Template:Documentation subpage. Any changes made here will reflect on the main template page.