"ഫലകം:Documentation/doc" എന്ന താളിന്റെ പതിപ്പുകൾ തമ്മിലുള്ള വ്യത്യാസം
Content deleted Content added
Updating/reworking the doc since the template has been updated. Intermediate save. |
Updating more. Intermediate save. |
||
വരി 10:
This template is intended for documenting templates and other pages which are [[Wikipedia:Transclusion|transcluded]] onto other pages. It can be used in template space and most other namespaces.
Use of this template allows templates to be [[Wikipedia:Protection policy|protected]] where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.▼
=== Normal /doc ===▼
Normally this template is used without any parameters and placed at the bottom of the template or page being documented, in a <noinclude> section. Like this:
Line 23 ⟶ 25:
Then this template automatically loads the content from the /doc subpage of the template it is used on.
This template can be told to load the content from any other page. Like this:
വരി 35:
</pre>
The content can also be fed directly as text. Like this:
Line 50 ⟶ 48:
</pre>
When the '''content''' parameter is used the doc box normally doesn't get the [edit] [purge] links in the top right corner, and no link to a /doc page is shown in the link box below the doc box.
But parameter 1 and the '''content''' parameter can also be combined, like this:
<pre>
വരി 57:
{{documentation
| 1 = Template:Any page/doc
| content = {{Template:Any page/doc|
}}
</noinclude>
</pre>
Then the pagename fed as parameter 1 is used for the [edit] [purge] links and for the /doc link in the link box below the doc box. But the '''content''' parameter is used for the content shown in the doc box. The above code means that the content is transcluded as "<code><nowiki>{{Template:Any page/doc|parameters}}</nowiki></code>". In this example a parameter is also fed to the /doc page being loaded.
=== Best practice ===
Line 73 ⟶ 75:
When in Template space this template shows this heading:
:[[File:Template-info.svg|
In most other namespaces, such as "Wikipedia:", it shows this heading:
Line 81 ⟶ 83:
:'''Summary'''
The '''heading''' parameter can be used to set the heading to something else. Like this:
:<code><nowiki>{{documentation| heading = Infobox documentation }}</nowiki></code>
=== Automatic functions ===▼
If the '''heading''' parameter is empty but defined, no heading is shown and no [edit] [purge] links are shown. Like this:
When this template is on a protected template page it now automatically adds {{tl|pp-template}} that shows the grey or red padlock in the top right corner. So no need to manually add {{tlf|pp-template}} to templates that use {{tl|documentation}}.▼
:<code><nowiki>{{documentation| heading = }}</nowiki></code>
When this template is on a /sandbox subpage it automatically adds the {{tl|template sandbox notice}}.▼
▲=== Automatic functions ===
If the documentation page doesn't exist, the "edit" link includes a [[mw:Manual:Creating pages with preloaded text|preload]] parameter so that clicking it will pre-fill the edit form with the basic documentation page format.▼
▲If the documentation page doesn't exist, the
▲When this template is on a protected template page it now automatically adds {{tl|pp-template}}
▲Use of this template allows templates to be [[Wikipedia:Protection policy|protected]] where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.
▲When this template is on a /sandbox subpage it automatically adds the {{tl|template sandbox notice}}.
=== See also ===
| |||