Templat ini digunakan untuk menjana dokumentasi untuk templat amaran pengguna notis tunggal seperti {{uw-tilde}}. Templat amaran pengguna yang menggunakan templat dokumentasi ini hendaklah mengikut garis panduan yang ditetapkan oleh projek amaran pengguna.
Syntax
[sunting sumber]Semua parameter
{{single notice | param1 = | param1 required = | nopage = | nothankyou = | required named params = | extra usage = | template data = | see also = | hatnote = | banners = | s1 = | s2 = | s3 = }}
Parameter
[sunting sumber]|param1=
- perihalan parameter dua atau tiga perkataan
|1=
, untuk masuk ke dalam contoh templat. (|1=
biasanya mengandungi nama halaman untuk halaman apa sahaja yang dibincangkan.) Lalai kepada "artikel". |param1 required=
- ditetapkan kepada
yes
jika|1=
diperlukan. |nopage=
- ditetapkan kepada
yes
jika tiada parameter|1=
. |nothankyou=
- ditetapkan kepada
yes
jika mesej tidak berakhir dengan "Terima kasih." Secara lalai, templat akan menyatakan bahawa set teks tambahan dengan|2=
parameter akan digunakan dan bukannya teks "Terima kasih"; jika anda menetapkan ini kepadayes
, templat sebaliknya akan berkata demikian|2=
akan ditambah pada akhir mesej. |required named params=
- gunakan parameter ini untuk menambah parameter bernama yang diperlukan pada semua contoh seruan templat. Mereka akan ditambah sebagai parameter pertama kepada Templat:Tlsc, jadi anda harus melarikan diri tanda-tanda yang sama. Contohnya,
myparam{{=}}''nilai contoh''
akan memberikan kodmyparam=nilai contoh
. |extra usage=
- ruang untuk menambah maklumat tambahan tentang penggunaan templat.
|template data=
- ruang untuk menambah TemplateData.
|see also=
- ruang untuk menambah "see also" pautan untuk templat.
|hatnote=
- tempat sebelum sepanduk untuk meletakkan hatnote.
|banners=
- ruang untuk menambah sepanduk seperti {{Twinkle standard installation}}.
|s1=
,|s2=
,|s3=
- pintasan templat.
|nocat=
- menyekat pengkategorian automatik
Lihat juga
[sunting sumber]- {{Templatesnotice}}: menjana dokumentasi untuk templat halaman pengguna berbilang isu.