Mall:Dokumentatsioon/doc

Malli tuleb tõlkida ja kohandada!

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.

Kasutamine

Normal /doc

<noinclude>{{Dokumentatsioon}}</noinclude>

Any /doc page

<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

In-line content

<noinclude>{{Documentation|content=This is documentation.}}</noinclude>

In-line content with [view][edit] links

<noinclude>{{Documentation
|1=Template:any page/doc
|content={{Template:any page/doc|parameters}}
}}</noinclude>

Lisa lehe lõppu

<noinclude>
{{dokumentatsioon}}
<!-- Lisa kategooriad ja intervikid malli /doc lehele, aga mitte siia! -->
</noinclude>

Best practice

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 parameter can be used as shown above to transclude an arbitrary documentation page.

Add categories and interwiki links 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 "&lt;".

Customizing display

Overrides exist to customize the output in special cases:

• {{documentation|heading=}}: change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.

Funktsioonid

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.

Põhjendus

• Selle malli kasutamine võimaldab kaitsta malle, neid vajadusel lukustades, jättes aga igaühele võimaluse redigeerida dokumentatsiooni, kategooriaid ja interwiki linke.
• Tekst malli enda lehel suurendab teksti mahtu, mis on vaja läbi töödelda selleks, et kuvada malli ennast, ning see on piiratud sooritusvõimega (2 048 000 baiti). Dokumentatsiooni paigutamine alamleheküljele aga vähendab vikiteksti osa malli enda leheküljel üksnes malli väljakutsumise ja noinclude märgisteni. Sellel põhjusel on MediaWiki arendajad soovitanud taolist süsteemi.