Templat:Citation Style documentation
| Apabila mengemas kini templat ini sila ambil perhatian bahwa ia digunakan dalam beberapa halaman dokumentasi templat. Sekiranya sesuatu parameter itu unik kepada templat, anda boleh menambahnya secara insani ataupun membuat bahagian baharu di sini untuk transklusi. |
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
| Penanda | Dipaparkan sebagai |
|---|---|
{{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, 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}}
|
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}}
|
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
- 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;">
last
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
same as last1
same as first1
</pre>
{{csdoc|usage vertical end}}
| Senarai menegak | Parameter yang sama | Arahan/nota ringkas |
|---|---|---|
{{cite book
| last =
| first =
| authorlink =
}}
|
last |
same as last1 same as first1 |
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]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
| Penanda | Dipaparkan sebagai |
|---|---|
'''Title'''
*<code>{{cite book |title=Mysterious book}}</code>
:{{cite book |title=Mysterious book}} |
Title
|
Parameters section
[sunting sumber]syntax
[sunting sumber]coins
[sunting sumber]sep_period
[sunting sumber]sep_comma
[sunting sumber]required
[sunting sumber]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]title
[sunting sumber]web
[sunting sumber]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]series
[sunting sumber]series_episode
[sunting sumber]event
[sunting sumber]agency
[sunting sumber]volume
[sunting sumber]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]language
[sunting sumber]pages
[sunting sumber]Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt
time
[sunting sumber]id1
[sunting sumber]id2
[sunting sumber]url
[sunting sumber]Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt
chapterurl
[sunting sumber]lay
[sunting sumber]quote
[sunting sumber]Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt
ref
[sunting sumber]ref2
[sunting sumber]display
[sunting sumber]Templat:Citation Style documentation/edit Templat:Citation Style documentation/opt