Templat:Sublaman pendokumenan/doc

Penggunaan

{{sublaman pendokumenan}}

ATAU

{{sublaman pendokumenan|[[laman utama untuk dipautkan]]}}

Kotak pengguna

Apabila digunakan untuk mendokumenkan penggunaan kotak pengguna, adalah mungkin lebih disukai untuk menmpunyai keadaan templat ini "kotak pengguna"/"laman kotak pengguna" bukannya "templat"/"laman templat" atau "templat pengguna"/"laman templat pengguna". Jika ini lebih lebih disukai, gunakan:

{{sublaman pendokumenan kotak pengguna}}

OR

{{sublaman pendokuman kotak pengguna|[[laman kotak pengguna utama untuk dipautkan]]}}

Penyesuaian teks

Untuk menukar teks templat secara manual, parameter "text1=teks anda di sini" dan/atau "text2=teks anda yang lain di sini" boleh ditentukan. "text1=" mengubah teks automatik pada baris pertama kepada perkataan anda sendiri. "text2=" mengubah teks automatik pada baris kedua kepada perkataan anda sendiri. Jika parameter "text1=" ditentukan tanpa parameter "text2=", kedua-dua baris pertama dan kedua teks akan disesuaikan berdasarkan teks yang diberikan dalam parameter"text1=".

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.

Contoh penggunaan:

{{sublaman pendokumenan|text1=teks baris pertama dan kedua tersuai}}

{{sublaman pendokumenan|text2=teks baris kedua tersuai sahaja}}

{{sublaman pendokumenan|text1=teks baris pertama tersuai|text2=teks baris kedua tersuai}}

Bagaimana ianya dipaparkan

Templat ini hendaklah diletakkan di bahagian atas laman "/doc". Ianya mengubah output berdasarkan di mana ianya dilihat:

• Di laman "/doc", ianya memaparkan kotak menerangkan pendokumenan templat dan memautkan kepada laman templat.
• Di laman yang lain (iaitu laman yang mentransklusikan laman "/doc"), templat tidak akan ditunjukkan. Laman templat itu sendiri (yang mengandungi {{Pendokumenan}}) akan mengambil maklum secara automatik bahawa pendokumenan itu ialah ditransklusikan daripada sublaman.

Fungsi

Sebagai tambahan kepada mesej output, templat ini mengkategorikan laman kepada Kategori:Pendokumenan templat, Kategori:Pendokumenan pengguna, atau serupa (dinamakan sempena ruang subjek), tetapi hanya untuk laman pendokumenan dalam ruang nama dengan ciri sublaman. Ianya menjadikan kunci susunan tersedia kepada nama halaman tanpa ruang nama (iaitu, "Foo" pada "Templat:Foo", supaya ia akan disusun dalam kategori di bawah 'F').

Lihat juga

• Wikipedia:Pendokumenan templat untuk bagaimana templat ini digunakan.