साँचा:Documentation subpage/doc
यह प्रलेखन उपपृष्ठ साँचा:Documentation subpage के लिए है। इसमें उपयोग विधि की जानकारी, श्रेणियाँ और वह वस्तुएँ हैं जो कि असली साँचा के पृष्ठ पर नही हैं। |
यह साँचा:Documentation subpage का प्रलेखन उपपृष्ठ है। यहाँ उपयोग हेतु जानकारी, श्रेणियाँ और अन्य सामग्री मौजूद है जो की मूल साँचा पृष्ठ का हिस्सा नहीं है। |
उपयोग
[स्रोत सम्पादित करौ]{{प्रलेखन उपपृष्ठ}}
OR
{{प्रलेखन उपपृष्ठ|[[main page to link to]]}}
Userboxes
[स्रोत सम्पादित करौ]When used to document usage of a userbox, it may be preferred to have this template state "userbox"/"userbox page" instead of "साँचा"/"साँचा page" or "यूजर template"/"यूजर template page". If this is preferred, use:
{{userbox documentation subpage}}
OR
{{userbox documentation subpage|[[main userbox page to link to]]}}
Customization of text
[स्रोत सम्पादित करौ]To manually change the text of the template, the "text1=your text here
" and/or "text2=your other text here
" parameters can be specified. "text1=
" changes the automatic text on the first line to your own word(s). "text2=
" changes the automatic text on the second line to your own word(s). If "text1=
" parameter is specified without the "text2=
" parameter, both the first and second line of text will be custom based on the text given in the "text1=
" parameter.
Example usage:
{{प्रलेखन उपपृष्ठ|text1=custom first and second line text}}
{{प्रलेखन उपपृष्ठ|text2=custom second line text only}}
{{प्रलेखन उपपृष्ठ|text1=custom first line text|text2=custom second line text}}
How it is displayed
[स्रोत सम्पादित करौ]This template should be placed at the top of "/doc" pages. It changes output depending on where it is viewed:
- On a "/doc" page, it displays a box explaining template documentation and links to the template page.
- On other pages (ie, pages transcluding the "/doc" page), the template will not show. The template page itself (which contains
{{Documentation}}
) will automatically note that the documentation is transcluded from a subpage.
Functions
[स्रोत सम्पादित करौ]In addition to the output message, the template categorizes pages to Category:साँचा प्रलेखन पृष्ठ, Category:मॉड्यूल प्रलेखन पृष्ठ, Category:सदस्य प्रलेखन पृष्ठ or Category:विकिपीडिया प्रलेखन पृष्ठ, but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').
See also
[स्रोत सम्पादित करौ]- Wikipedia:Template sandbox and test cases for how this template is used.