الگو:توضیحات

از ویکی‌نبشته
پرش به: گشتن، جستجو
{{مستندسازی الگو}}

This template automatically displays a documentation box with content transcluded from another page. It is intended for pages which are transcluded in other pages (ie templates), whether or not they are in the template namespace.

Usage[ویرایش]

Normal[ویرایش]

<noinclude>{{documentation}}</noinclude>
or <noinclude>{{documentation|template:any page/doc}}</noinclude>

Example use:

<noinclude>{{documentation|template:Hyphenated_word_start/doc}}</noinclude>

This code should be added at the bottom of the template code, with no extra space before "<noinclude>" (which would cause extra space on pages where the template is used). The default documentation page is Title/doc (for example, Template:Documentation/doc); the parameter can be used as shown above to transclude an arbitrary documentation page. The template links to the documentation page just under the header.

Categories and interwiki links can added to the documentation (inside <includeonly> tags), to allow anyone to edit them. If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;".

Functions[ویرایش]

If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format.

Rationale[ویرایش]

This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links.

See also[ویرایش]