खाँचा:Template doc page

विकिपीडिया से

साँचा चक्र मिला: खाँचा:प्रलेखन उपपन्ना

उपयोग[स्रोत सम्पादित करैं]

{{प्रलेखन उपपन्ना}}

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[स्रोत सम्पादित करैं]

General information about documentation for templates:

{{Documentation}} family:

Meta-Wiki {{Documentation}} ancestor:


उपयोग[स्रोत सम्पादित करैं]

{{प्रलेखन उपपन्ना}}

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[स्रोत सम्पादित करैं]

General information about documentation for templates:

{{Documentation}} family:

Meta-Wiki {{Documentation}} ancestor: