Difference between revisions of "Template:Documentation/doc"

From CWCki
Jump to navigation Jump to search
(copied in from Wikipedia)
 
(shortening, fixing links)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation subpage}}
This is the '''{{tlx|documentation}}''' template used on a template page to contain that template's documented instructions and information.
This is the '''{{tlx|documentation}}''' template used on a template page to contain that template's documented instructions and information.


This template displays a green documentation box, like you are seeing now, and automatically loads the content from a /doc subpage. It can also load the content from other places, if instructed to do so.
This template displays a green documentation box, like you are seeing now, and automatically loads the content from a /doc subpage. It can also load the content from other places, if instructed to do so.


This template is intended for documenting templates and other pages that are [[Wikipedia:Transclusion|transcluded]] onto other pages. It can be used in the [[Wikipedia:Template namespace|template namespace]] and most other [[Wikipedia:Namespace|namespace]]s.
This template is intended for documenting templates and other pages that are {{w|Help:Transclusion|transcluded}} onto other pages. It can be used in the {{w|Wikipedia:Template namespace|template namespace}} and most other {{w|Wikipedia:Namespace|namespaces}}.


Use of this template allows templates to be [[Wikipedia:Protection policy|protected]], where necessary, while allowing anyone to edit the documentation and categories.
Use of this template allows templates to be {{w|Wikipedia:Protection policy|protected}}, where necessary, while allowing anyone to edit the documentation and categories.


==Usage==
==Usage==
Normally, this template is used without any parameters, and is placed at the bottom of the template page or other page being documented.
Normally, this template is used without any parameters, and is placed at the bottom of the template page or other page being documented.
<includeonly><!-- Make sure that only page [[Template:Documentation]] is categorised. No other page (no subpages, not when transcluded).
-->{{#ifeq:{{FULLPAGENAME}}|Template:Documentation|
[[Category:Template documentation| ]]
[[Category:Template namespace templates|Documentation]]
}}</includeonly>

Latest revision as of 11:52, 30 September 2021

This is the {{documentation}} template used on a template page to contain that template's documented instructions and information.

This template displays a green documentation box, like you are seeing now, and automatically loads the content from a /doc subpage. It can also load the content from other places, if instructed to do so.

This template is intended for documenting templates and other pages that are transcluded onto other pages. It can be used in the template namespace and most other namespaces.

Use of this template allows templates to be protected, where necessary, while allowing anyone to edit the documentation and categories.

Usage

Normally, this template is used without any parameters, and is placed at the bottom of the template page or other page being documented.