Template:Documentation: Difference between revisions

From IxWiki
Jump to navigation Jump to search
m 1 revision imported
mp>A876
m A876 moved page Template:Doc to Template:Documentation over redirect: because what is a "Doc"? because shorter redirects to longer. (almost no templates have any "Doc".)
Line 1: Line 1:
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}<noinclude>
<includeonly><div class="template-documentation">
<!-- Add categories to the /doc subpage -->
<div style="clear:both; padding-bottom:3px; border-bottom: 1px solid #aaa; margin-bottom:1ex">
<span class="editsection plainlinks" id="doc_editlinks">{{#ifexist: {{{1|{{FULLPAGENAME}}/doc}}}
    |<!--**    /doc EXISTS**  -->[[{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit}} edit]] [{{purge|purge}}]
    |<!--**/doc DOESN'T EXIST**-->[[{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit&preload=Template:Doc/preload}} create]]
}}</span>
<span style="font-weight: bold; font-size: 125%">Documentation</span>
</div>
{{hatnote|{{#ifexist: {{FULLPAGENAME}}/sandbox|This template has a [[/sandbox|sandbox]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /sandbox }}|action=edit}} edit])</small> {{#ifexist: {{FULLPAGENAME}}/testcases| and [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small>}} for editors to experiment.|{{#ifexist: {{FULLPAGENAME}}/testcases|This template has [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small> for editors to experiment.}} }} }}
{{#ifexist: {{{1|{{FULLPAGENAME}}/doc}}}|{{ {{{1|{{FULLPAGENAME}}/doc}}} }} | [[Category:Templates without documentation|{{PAGENAME}}]] }}
</div></includeonly><noinclude>
{{doc}}[[Category:Framework templates]]{{DEFAULTSORT:{{PAGENAME}}}}
</noinclude>
</noinclude>

Revision as of 14:51, 28 August 2022

[edit] [purge] Documentation

Template loop detected: Template:Documentation The documentation template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc".

Usage

Place {{documentation}} at the top of the documentation page.

If the page to be documented is a subpage, use {{documentation}} at the top of the documentation page. For example, Template:Foo/bar's documentation page would use {{documentation}}.

The template will attempt to auto detect and link {{#Invoke:}} calls on template documentations or the require()/mw.loadData() depedency list on module documentations. If you want to supress the auto generated dependency list, use {{documentation}}

Note

This template links to a /doc that may appear useless, however, it exists in order to link navboxes and userboxes to their base template's documentation.


TemplateData

The documentation template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc".

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
No parameters specified