FANDOM


[edit] [[[:قالب:Purge]]] 50px Template documentation

Usage

{{documentation subpage}}

OR

{{documentation subpage|[[<var>main page to link to]]</var>}}

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:

{{documentation subpage|text1=<var>custom first and second line text</var>}}
{{documentation subpage|text2=<var>custom second line text only</var>}}
{{documentation subpage|text1=<var>custom first line text</var>|text2=<var>custom second line text</var>}}

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 {{توثيق}}) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to the output message, the template categorizes pages to Category:Template documentation, though only for documentation pages in the template namespace. 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

Community content is available under CC-BY-SA unless otherwise noted.