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

નાનું
change source to syntaxhighlight
નાનું (Bot: Replace deprecated <source> tag and "enclose" parameter [https://lists.wikimedia.org/pipermail/wikitech-ambassadors/2020-April/002284.html]; cosmetic changes)
નાનું (change source to syntaxhighlight)
{{template shortcut|doc}}
<noinclude>{{pp-semi-indef}}
</noinclude>{{Distinguish|Template:Documentation subpage}}
{{Documentation subpage}}
{{High-use|67000 71768 }}
{{Shortcut|T:DOC}}
{{stack|{{Lua|Module:Documentation}}}}
<!---- Categories where indicated at the bottom of this page, please; interwikis at Wikidata ---->
 
This is the {{tlf|Documentation}} template, used on almost every template page to contain that template's [[Documentation|documented instructions and information]].
 
This is the '''{{tlf|Documentation}}''' template, used on almost every [[Help:A quick guide to templates|template page]] to contain that template's [[Documentation|documented instructions and information, including [[Wikipedia:TemplateData|<templatedata>]].
For detailed instructions on how and when to use this template, see [[વિકિપીડિયા:Template documentation]] (shortcut: [[WP:TDOC]]).
 
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:
 
<!--Last line of your template code--><noinclude>
{{Documentation}}
<!-- Add categories to the /doc subpage, interwikis to Wikidata, not here! -->
</noinclude>
</syntaxhighlight>
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.
 
===Place Shortcutand tags===
TheThis 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).: <syntaxhighlight lang=moin><noinclude>
To automatically insert the [[વિકિપીડિયા:Noinclude|noinclude tags]], the template call and the guiding comment, use this [[WP:Substitution|substitution]] code:<br>
{{documentation}}
</noinclude></syntaxhighlight>
 
To automatically insert the [[વિકિપીડિયાWikipedia:Noinclude|noinclude tags]], the template call and the guiding comment, you can also use this [[WPWikipedia:Substitution|substitution]] code shortcut:<br>
 
:<code><nowiki>{{subst:tlxs|doc-code}}</nowiki></code>
 
Which results in: <syntaxhighlight lang=moin><noinclude>
=== Best practice ===
{{documentation}}
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).
<!-- Add categories to the /doc subpage and interwikis in Wikidata, not here! -->
</noinclude></syntaxhighlight>
 
=== Best practice ===
Categories that apply to the template itself should be added to the bottom of the /doc subpage, inside {{Tagtag|includeonlynoinclude|p|content={{((}}Sandbox tagsother{{!!}}...{{))}}}}. Interwiki links that apply to the template should be listed at [[d:|Wikidata]] (more at [[વિકિપીડિયા:Wikidata|wpWikipedia: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>" or use [[Template:tag]].
 
=== Heading ===
When in the Template namespace, this template shows this heading:
:[[ચિત્રFile:Test Template Info-infoIcon - Version (2).pngsvg|32px|link=[[Wikipedia:Template documentation]]]] '''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 is usually placed in a subject namespace, within {{tag|noinclude|o}} tags. But in some cases this template needs to be on the talk page:
 
* In the Mediawiki namespace, since {{tag|noinclude|o}} often does not work in system messages, and since the Mediawiki namespace needs to be kept clean for performance reasons.
 
When placed on talk pages, this template usually is placed near the top of the page and without {{tag|noinclude}} tags.
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]]. The preload page for the /sandbox [mirror] link is [[Template:Documentation/mirror]].
 
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><!-- Make sure that only page [[Template:Documentation]] is categorised. No other page (no subpages, not when transcluded).
<includeonly>{{When pagename is |/sandbox= |/testcases= |other=
-->{{#ifeq:{{FULLPAGENAME}}|Template:Documentation|
<!---- Categories below this line, please; interwikis to Wikidata ---->
[[શ્રેણીCategory:Template documentation| ]]
[[શ્રેણીCategory:Template-related namespace templates|Documentation]]
}}</includeonly>
Anonymous user