תבנית:Documentation
- The following documentation is located at Template:Documentation/doc. [edit]
This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not.
Usage
[עריכה]- Normal /doc
<onlyinclude>template code . . .</onlyinclude>
{{documentation}}
- Any /doc page
<onlyinclude>template code . . .</onlyinclude>
{{documentation|any template/doc}}
- Best practice
The template code should be wrapped in <onlyinclude> tags, and the {{documentation}} template should be outside of those tags. This ensures that {{documentation}}, and any surrounding whitespace, do not end up on pages where the template is used. (Alternatively, you can put {{documentation}} inside <noinclude> tags, but then you need to be careful to make sure you don't accidentally put any whitespace outside the tags.) The parameter can be used as shown above to transclude an arbitrary documentation page.
Categories and interwiki links that apply to the template itself should be added to the documentation page, inside <includeonly> </includeonly> tags.
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "<".
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
[עריכה]Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.
See also
[עריכה]תבנית:תיעוד
תבנית זו נועדה לשימוש בתבניות. היא מאפשרת להציג תיעוד שנכתב בדף אחר (באמצעות הפרמטר 1) או בדף המשנה "תיעוד".