Templat:Csdoc/doc

Penggunaan

Templat ini digunakan bagi maksud membuat laman dokumentasi templat Citation Style 1 yang konsisten.

Contoh: {{Citation Style documentation|author}} akan memaparkan dokumentasi pengarang.

Jika terdapat sesuatu bahagian di mana penggunaan templat tidak bersesuaian, tambah teks secara insani atau buat subtemplat baharu.

Setiap modul teks ialah subtemplat yang dapat disunting dengan menggunakan pautan.

Penggunaan bahagian

Apabila membuat dokumentasi templat, gunakan urutan berikut bagi bahagian dan kandungan:

• Pendahulu (Lead): gamabaran ringkas tentang tujuan templat
• Penggunaan (Usage): sampel parameter kosong yang boleh disalin dan ditampal
• Contoh (Examples): contoh penggunaan
• Parameter: Pemerian terperinci setiap parameter
  • Sintaks: gambaran menyeluruh tentang sintaks templat
  • Dicemuh (Deprecated): Senarai parameter yang dicemuh
  • Pemerian (Description): Pemerian parameter yang dibezakan mengikut fungsi dalam urutan am berikut:
    • Pengarang (Author)
    • Tajuk (Title)
    • Haribulan (Date)
    • Penerbit (Publisher)
    • Edisi, siri, jilid (Edition, series, volume)
    • Lokasi dalam sumber (In-source location)
    • URL (URL)
    • Sauh (Anchor)
    • Pengenal pasti (Identifiers)
    • Petikan (Quotes)
    • Editor (Editors)
    • Ringkasan biasa (Lay summary)
    • Opsyen paparan (Display options)

Bahagian pendahulu

Gunakan {{csdoc|lead|content}} bagi membuat kandungan yang konsisten bagi pendahulu:

Penanda	Dipaparkan sebagai
{{csdoc|lead|books}}

Bahagian penggunaan

Mulakan bahagian penggunaan dengan {{csdoc|usage}}:

Salin versi kosong. Semua nama paramater mesti dalam huruf kecil. Gunakan aksara "|" (paip) di antara setiap parameter. Padamkan parameter yang tidak diguna bagi mengelak penyelerakan dalam tetingkap suntingan. Beberapa sampel mungkin memuatkan haribulan semasa. Sekiranya haribulan bukan haribulan semasa, halaman.

Parameters yang perlu disalin di letak dalam jadual yang dijana subtemplat.

Full horizontal style

• Start with {{csdoc|usage full}}
• Precede the sample markup with : to create an indent
• Enclose the sample in <code><nowiki>...</nowiki></code>
• Close the table with {{end}}

{{csdoc|usage full}}
:<code><nowiki>{{cite book |last1= |first1= |authorlink1= |last2= |first2= |authorlink2= |editor1-first= |editor1-last= |editor1-link= |others= |title= |trans_title= |url= |archiveurl= |archivedate= |format= |accessdate= |type= |edition= |series= |volume= |date= |year= |month= |origyear= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans_chapter= |chapter= |chapterurl= |quote= |ref= |bibcode= |laysummary= |laydate= |author-mask= |author-name-separator= |author-separator= |display-authors= |separator= |postscript= |lastauthoramp=}}</nowiki></code>
{{end}}

Parameter penuh dalam keadaan melintang

{{cite book |last1= |first1= |authorlink1= |last2= |first2= |authorlink2= |editor1-first= |editor1-last= |editor1-link= |others= |title= |trans_title= |url= |archiveurl= |archivedate= |format= |accessdate= |type= |edition= |series= |volume= |date= |year= |month= |origyear= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans_chapter= |chapter= |chapterurl= |quote= |ref= |bibcode= |laysummary= |laydate= |author-mask= |author-name-separator= |author-separator= |display-authors= |separator= |postscript= |lastauthoramp=}}

Most commonly used horizontal style

• Start with {{csdoc|usage common}}
• Precede the sample markup with : to create an indent
• Enclose the sample in <code><nowiki>...</nowiki></code>
• Close the table with {{end}}

{{csdoc|usage common}}
:<code><nowiki>{{cite book |last= |first= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=}}</nowiki></code>
{{end}}

Parameter yang sentiasa digunakan dalam keadaan melintang

{{cite book |last= |first= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=}}

Full vertical style

The full vertical style is created in three columns: Vertical list, Prerequisites and Brief instructions / notes.

• Start with:

{{csdoc|usage vertical}}
<pre style="margin:0px;">

• Create the vertical list column
• Seperate the next column with:

</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">

• Create the prerequisites column; blank lines must include a  
• Seperate the next column with:

</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">

• Create the instructions column; blank lines must include a  
• End with:

</pre>
{{csdoc|usage vertical end}}

Example:

{{csdoc|usage vertical}}
<pre style="margin:0px;">
{{cite book
| last                  =
| first                 =
| authorlink            =
}}
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
&nbsp;
&nbsp;
last
&nbsp;
&nbsp;
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
&nbsp;
same as last1
same as first1
&nbsp;
&nbsp;
</pre>
{{csdoc|usage vertical end}}

Parameter penuh dalam format menegak

Senarai menegak	Parameter yang sama	Arahan/nota ringkas
{{cite book | last = | first = | authorlink = }}	last	same as last1 same as first1

* Jika ada ruang nama yang tersenarai dalam kolum Parameter yang sama, ruang nama/parameter itu boleh digunakan dan sama fungsinya.

Sub-templates

Usage

|}

Usage full

|}

Usage common

|}

Usage vertical

|}

Usage vertical mid

|}

Examples section

When creating examples, use these styles for consistency:

• A title before the example, formatted in bold by the use of '''
• The sample markup for the example: preceded by * to create a bullet, then the markup enclosed in <code><nowiki>...</nowiki></code>
• The live markup: preceded by : to create an indent

Penanda	Dipaparkan sebagai
'''Title''' *<code><nowiki>{{cite book |title=Mysterious book}}</nowiki></code> :{{cite book |title=Mysterious book}}	Title {{cite book |title=Mysterious book}} Mysterious book.