Templat:Csdoc

Daripada Wikipedia, ensiklopedia bebas.
Jump to navigation Jump to search
Pendokumenan templat[lihat] [sunting] [sejarah] [nyahcache]

Penggunaan[sunting sumber]

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[sunting sumber]

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[sunting sumber]

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

Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt

Markup Renders as
{{csdoc|lead|books}} 

Bahagian penggunaan[sunting sumber]

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, singkir halaman.

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

Full horizontal style[sunting sumber]

  • 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[sunting sumber]

  • 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[sunting sumber]

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 &nbsp;
  • Seperate the next column with:
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
  • Create the instructions column; blank lines must include a &nbsp;
  • 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[sunting sumber]

Usage[sunting sumber]

Templat:Citation Style documentation/edit |}

Usage full[sunting sumber]

Templat:Citation Style documentation/edit |}

Usage common[sunting sumber]

Templat:Citation Style documentation/edit |}

Usage vertical[sunting sumber]

Templat:Citation Style documentation/edit |}

Usage vertical mid[sunting sumber]

Templat:Citation Style documentation/edit |}

Usage vertical end[sunting sumber]

Templat:Citation Style documentation/edit

Examples section[sunting sumber]

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
Markup Renders as
'''Title'''
*<code><nowiki>{{cite book |title=Mysterious book}}</nowiki></code>
:{{cite book |title=Mysterious book}} 

Title

  • {{cite book |title=Mysterious book}}
Mysterious book. 

Parameters section[sunting sumber]

syntax[sunting sumber]

Templat:Citation Style documentation/edit

coins[sunting sumber]

Templat:Citation Style documentation/edit

sep_period[sunting sumber]

Templat:Citation Style documentation/edit

sep_comma[sunting sumber]

Templat:Citation Style documentation/edit

required[sunting sumber]

Templat:Citation Style documentation/edit

deprecated[sunting sumber]

Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt

author[sunting sumber]

Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt

editor[sunting sumber]

Templat:Citation Style documentation/edit

title[sunting sumber]

Templat:Citation Style documentation/edit

Templat:Citation Style documentation/opt

web[sunting sumber]

Templat:Citation Style documentation/edit

chapter[sunting sumber]

Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt

type[sunting sumber]

Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt

journal[sunting sumber]

Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt

edition[sunting sumber]

Templat:Citation Style documentation/edit

series[sunting sumber]

Templat:Citation Style documentation/edit

series_episode[sunting sumber]

Templat:Citation Style documentation/edit

event[sunting sumber]

Templat:Citation Style documentation/edit

agency[sunting sumber]

Templat:Citation Style documentation/edit

volume[sunting sumber]

Templat:Citation Style documentation/edit

date[sunting sumber]

Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt

publisher[sunting sumber]

Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt

newsgroup[sunting sumber]

Templat:Citation Style documentation/edit

language[sunting sumber]

Templat:Citation Style documentation/edit

pages[sunting sumber]

Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt

time[sunting sumber]

Templat:Citation Style documentation/edit

id1[sunting sumber]

Templat:Citation Style documentation/edit

id2[sunting sumber]

Templat:Citation Style documentation/edit

url[sunting sumber]

Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt

chapterurl[sunting sumber]

Templat:Citation Style documentation/edit

lay[sunting sumber]

Templat:Citation Style documentation/edit

quote[sunting sumber]

Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt

ref[sunting sumber]

Templat:Citation Style documentation/edit

ref2[sunting sumber]

Templat:Citation Style documentation/edit

display[sunting sumber]

Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt

map_series[sunting sumber]

Templat:Citation Style documentation/edit

map_id[sunting sumber]

Templat:Citation Style documentation/edit

map_pages[sunting sumber]

Templat:Citation Style documentation/edit

interview_id[sunting sumber]

Templat:Citation Style documentation/edit

interview_author[sunting sumber]

Templat:Citation Style documentation/edit

interview_interviewer[sunting sumber]

Templat:Citation Style documentation/edit

album_name[sunting sumber]

Templat:Citation Style documentation/edit

album_artist[sunting sumber]

Templat:Citation Style documentation/edit

season[sunting sumber]

Templat:Citation Style documentation/edit

network[sunting sumber]

Templat:Citation Style documentation/edit

transcript[sunting sumber]

Templat:Citation Style documentation/edit

notestitle[sunting sumber]

Templat:Citation Style documentation/edit

conference[sunting sumber]

Templat:Citation Style documentation/edit

See also[sunting sumber]

Templat:Citation Style 1