Templat:Pendokumenan

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.

Pendokumenan templat

Templat ini menggunakan ciri-ciri sintaks templat yang RUMIT. Anda digalakkan membiasakan diri dengan struktur dan fungsi-fungsi penghurai sebelum menerbitkan templat ini. Jika terbitan anda menyebabkan masalah yang tidak disangkakan, tolong baikinya semula dengan cepat, kerana templat ini muncul di beberapa laman rencana. Anda boleh mengendalikan uji kaji, dan harus memeriksa semua pembaikan, sama ada di Templat kotak pasir umum atau di laman pengguna anda sebelum menukarkan apa-apa di sini.

Templat ini memaparkan secara automatik sebuah kotak dokumentasi seperti apa yang anda ;lihat sekarang, yang mana kandungannya dipindahkan masuk dari laman lain. Ia ditujukan untuk laman-laman yang dipindahkan masuk daripada laman-laman lain, contohnya templat-templat, samada di dalam templat ruangnama atau tidak.

Penggunaan

Normal /doc

<noinclude>{{Documentation}}</noinclude>

Apa-apa laman /doc

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

Kandungan in-line

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

Kandungan In-line dengan pautan [lihat][sunting] seperti

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

Latihan terbaik

Kod ini seharusnya ditambahkan di hujung bawah kod templat, dengan tiada ruang tambahan sebelum "<noinclude>" (yang mana akan menyebabkan ruang tambahan pada laman-laman di mana templat digunakan). Parameter boleh digunakan seperti di atas dengan memindahkan masuk satu laman dokumentasi arbitrari.

Tambah pautan-pautan kategori dan interwiki kepada laman dokumentasi di dalam tag-tag <includeonly> </includeonly>.

Sekiranya laman dokumentasi mengandungi tag-tag includeonly atau noinclude sebagai sebahagian daripada dokumentasi, menggantikan "<" dengan "&lt;".

Paparan mengikut pesanan

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.

Fungsi

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.

Rasional

Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.

Lihat juga

Maklumat umum tentang dokumentasi bagi templat

• Wikipedia:Dokumentasi templat
• Wikipedia:Kes ujian templat

Keluarga {{ Documentation }}

Leluhur Meta Wiki {{ Documentation }}

• m:Template:Documentation (backlinks, edit)