"ઢાંચો:Documentation/doc" ની આવૃત્તિઓ વચ્ચેનો તફાવત

નાનું
Bot: Replace deprecated <source> tag and "enclose" parameter [https://lists.wikimedia.org/pipermail/wikitech-ambassadors/2020-April/002284.html]; cosmetic changes
નાનું (en:Template:Documentation/doc માંથી આયાત કરેલ ૨૯૫ પુનરાવર્તનો)
નાનું (Bot: Replace deprecated <source> tag and "enclose" parameter [https://lists.wikimedia.org/pipermail/wikitech-ambassadors/2020-April/002284.html]; cosmetic changes)
This is the {{tlf|Documentation}} template, used on almost every template page to contain that template's [[Documentation|documented instructions and information]].
 
For detailed instructions on how and when to use this template, see [[Wikipediaવિકિપીડિયા:Template documentation]] (shortcut: [[WP:TDOC]]).
 
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.
 
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.
 
Use of this template allows templates to be [[Wikipediaવિકિપીડિયા:Protection policy|protected]] where necessary, while allowing anyone to edit the documentation and categories.
 
=== Usage ===
Normally this template is used without any parameters, placed at the bottom of the template or page being documented, within a {{tag|noinclude}} container:
 
<sourcesyntaxhighlight lang="xml+smarty">
<!--Last line of your template code--><noinclude>
{{Documentation}}
<!-- Add categories to the /doc subpage, not here! -->
</noinclude>
</syntaxhighlight>
</source>
 
Then this template automatically loads the content from the /doc subpage of the template it is used on.
This template can also load the content from any other page. Like this:
 
<sourcesyntaxhighlight lang="xml+smarty">
<!--Last line of your template code--><noinclude>
{{Documentation |Template:Other page/doc}}
</noinclude>
</syntaxhighlight>
</source>
 
Note that when loading the documentation from a page other than the local /doc page it becomes tricky to handle the categories.
The content can also be fed directly as text. Like this:
 
<sourcesyntaxhighlight lang="xml+smarty">
<!--Last line of your template code--><noinclude>
{{Documentation
(some documentation)
}}</noinclude>
</syntaxhighlight>
</source>
 
When the {{para|content}} parameter is used, the doc box normally does not show the [edit] [purge] links in the top right corner. Note that if the /doc page exists, a link to it is still shown in the link box below the doc box.
Parameter {{para|1}} and the {{para|content}} parameter can also be combined, like this:
 
<sourcesyntaxhighlight lang="xml+smarty">
<!--Last line of your template code--><noinclude>
{{Documentation |1=Template:Any page/doc
{{Template:Any page/doc |parameters}}
}}</noinclude>
</syntaxhighlight>
</source>
 
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 {{tnull|Template:Any page/doc{{!}}parameters}}. In this example a parameter is also fed to the /doc page being loaded.
 
=== Shortcut ===
To automatically insert the [[Wikipediaવિકિપીડિયા:Noinclude|noinclude tags]], the template call and the guiding comment, use this [[WP:Substitution|substitution]] code:<br>
 
:<code><nowiki>{{subst:doc-code}}</nowiki></code>
 
=== Best practice ===
The code should be added at the bottom of the template code, with no space before {{Tag|noinclude|o}} (which would cause extra space on pages where the template is used).
 
Categories that apply to the template itself should be added to the bottom of the /doc subpage, inside {{Tag|includeonly}} tags. Interwiki links that apply to the template should be listed at [[d:|Wikidata]] (more at [[Wikipediaવિકિપીડિયા:Wikidata|wp:Wikidata]]). For more complex cases, see [[Wikipediaવિકિપીડિયા:Template documentation#Categories and interwiki links]].
 
If the documentation page contains {{tag|includeonly|o}} or {{tag|noinclude|o}} tags as part of the visible documentation text, replace the "<code>&lt;</code>" with "<code>&amp;lt;</code>".
 
=== Heading ===
When in the Template namespace, this template shows this heading:
:[[Fileચિત્ર:Template-info.png|32px]] '''Template documentation'''
 
In most other namespaces, such as "Wikipedia:", it shows this heading:
:<code>heading-style=font-size:150%;color:red;</code>
 
=== Link box ===
Below the big doc box is a small link box that shows some meta-data about the documentation. The link box shows different things depending on what parameters are fed to this template, and in which namespace it is used. In some cases the link box is not shown at all.
 
</pre>
 
=== Automatic functions ===
If the documentation page does not exist, the [create] link includes a [[mw:Manual:Creating pages with preloaded text|preload]] page so that clicking it will pre-fill the edit form with the basic documentation page format. Preload text is also used for the /sandbox and /testcases [create] links.
 
When this template is on a /sandbox subpage it automatically adds the {{tl|Template sandbox notice}}.
 
=== Subject namespaces vs. talk namespaces ===
Terminology: ''Subject namespaces'' are the opposite of ''talk namespaces''. For instance "Template:" is the subject space of "Template talk:".
 
This template automatically points its [create] links for the /doc, /sandbox and /testcases to the right namespace.
 
=== Testing ===
You can simulate the output for a given page by using the {{para|page}} parameter. For example, if you use the code {{para|page|Template:Edit protected}}, the template will behave exactly as if it were on the page [[Templateઢાંચો:Edit protected]], including showing the documentation from [[Templateઢાંચો:Edit protected/doc]], linking to [[Templateઢાંચો:Edit protected/sandbox]], etc. This parameter is useful for testing and is used extensively on the [[Moduleવિભાગ:Documentation/testcases|module testcases page]].
 
=== Technical details ===
The preload page for the /doc [create] link is [[Templateઢાંચો:Documentation/preload]]. The preload pages for the /sandbox and /testcases [create] links are [[Templateઢાંચો:Documentation/preload-sandbox]] and [[Templateઢાંચો:Documentation/preload-testcases]].
 
For more details, see the [[Templateઢાંચાની talkચર્ચા:Documentation|talk page]].
 
==== Full syntax ====
<pre>
{{Documentation}}
</pre>
 
=== See also ===
* {{tl|Documentation subpage}}, a notice placed at the top of a /doc subpage explaining its role and including a link to the page it documents.
* {{tl|Barnstar documentation}}, a variant of {{tl|Documentation}} for use with [[Wikipediaવિકિપીડિયા:Barnstars|barnstar]] templates.
* {{tl|Documentation/color scheme}} presents the color scheme used by {{tl|Documentation}}.
* [[Wikipediaવિકિપીડિયા:Template documentation]] is a how-to guide to template documentation.
* [[Wikipediaવિકિપીડિયા:Template sandbox and test cases]] explains the use of /sandbox and /testcases subpages and includes more information about template testing.
* [[Userસભ્ય:Technical 13/Scripts/editTemplateNoDoc.js]], a beta script that enables documentation to be hidden by default when editing templates.
 
<includeonly>{{When pagename is |/sandbox= |/testcases= |other=
<!---- Categories below this line, please; interwikis to Wikidata ---->
[[Categoryશ્રેણી:Template documentation| ]]
[[Categoryશ્રેણી:Template-related templates]]
}}</includeonly>
૭,૯૧૬

edits