Templat:Sublaman pendokumenan

Daripada Wikipedia, ensiklopedia bebas.
Lompat ke: pandu arah, cari
Edit-copy green.svg
Ini merupakan pendokumenan sublaman untuk Templat:Sublaman pendokumenan (sila lihat laman tersebut untuk templat asal).
Ia mengandungi maklumat penggunaan, kategori dan kandungan lain yang bukan sebahagian daripada templat halaman asal.

Padlock.svg

Templat risiko tinggi ini telah dilindungi dari suntingan bagi menghalang laku musnah. (log perlindungan). Sila bincangkan perubahan pada laman perbualan atau mohon nyahlindung. Anda boleh gunakan {{editprotected}} pada laman perbualan untuk meminta bantuan dari penyelia bagi melakukan suntingan anda.

Documentation icon Pendokumenan templat[lihat] [sunting] [sejarah] [nyahcache]

Usage

{{documentation subpage}}

OR

{{documentation subpage|[[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 "templat"/"templat page" or "pengguna template"/"pengguna 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:

{{documentation subpage|text1=custom first and second line text}}
{{documentation subpage|text2=custom second line text only}}
{{documentation subpage|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:Template documentation, Category:User documentation, or similar (named after the subject space), 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

Maklumat umum tentang dokumentasi bagi templat

Keluarga {{ Documentation }}

Leluhur Meta Wiki {{ Documentation }}