แม่แบบ:เอกสารรูปแบบการอ้างอิง

คู่มือการใช้งานแม่แบบ[ดู] [แก้] [ประวัติ] [ล้างแคช]

Usage

This template is used to build consistent documentation pages for Citation Style 1 templates.

For example: {{Citation Style documentation|author}} will show the author documentation.

Where a particular section of documentation is not appropriate for a certain template, simply add the text manually or create a new subtemplate.

Each module of text is a subtemplate that can be edited using the link.

Section usage

When creating template documentation, use the following order of sections and content:

• Lead: a brief overview of the template intent
• Usage: samples of blank parameters that can be copied and pasted
• Examples: examples of various usage
• Parameters: detailed descriptions of each parameter
  • Syntax: overview of the template syntax
  • Deprecated: list of deprecated parameters
  • Description: parameter descriptions separated by function in this general order:
    • Authors
    • Title
    • Date
    • Publisher
    • Edition, series, volume
    • In-source locations
    • URL
    • Anchor
    • Identifiers
    • Quote
    • Editors
    • Lay summary
    • Display options

Lead section

Use {{csdoc|lead|content}} to create consistent content for the lead:

แม่แบบ Citation Style 1 นี้ใช้เพื่อสร้างการอ้างอิงสำหรับ แม่แบบ:Citation Style documentation/opt

มาร์กอัป	แสดงผลเป็น
{{csdoc|lead|books}}	แม่แบบ Citation Style 1 นี้ใช้เพื่อสร้างการอ้างอิงสำหรับbooks

Lua notice

Usage section

Start the usage section with {{csdoc|usage}}:

คัดลอกเวอร์ชันเปล่าไปใช้ ชื่อพารามิเตอร์เกือบทั้งหมดรองรับเฉพาะตัวพิมพ์เล็กเท่านั้น (ชื่อย่อบางตัว เช่น |isbn= มีชื่อแทนตัวพิมพ์ใหญ่ เช่น |ISBN= ซึ่งเป็นที่ยอมรับสำหรับการใช้งาน) ใช้เครื่องหมาย "|" (ไปป์) อักขระระหว่างแต่ละพารามิเตอร์ พารามิเตอร์ที่ไม่ได้ใช้อาจถูกลบเพื่อหลีกเลี่ยงความยุ่งเหยิงในหน้าต่างแก้ไข ตัวอย่างบางส่วนในหน้าเอกสารนี้อาจมีวันที่ปัจจุบัน หากวันที่ไม่เป็นปัจจุบัน ให้ purge หน้านั้น

Parameters to copy are enclosed in tables created by sub-templates.

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= |layurl= |laysource= |laydate= |author-mask= |author-name-separator= |author-separator= |display-authors= |separator= |postscript= |lastauthoramp=}}</nowiki></code>
{{end}}

ตั้งพารามิเตอร์แบบเต็มในรูปแบบแนวนอน

{{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= |layurl= |laysource= |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}}

พารามิเตอร์ที่ใช้บ่อยที่สุดในรูปแบบแนวนอน

{{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
• Separate the next column with:

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

• Create the prerequisites column; blank lines must include a  
• Separate 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}}

ตั้งพารามิเตอร์ทั้งหมดในรูปแบบแนวตั้ง

รายการแนวตั้ง	ข้อกำหนดเบื้องต้น	คำแนะนำสั้น ๆ / หมายเหตุ
{{cite book | last = | first = | authorlink = }}	last	same as last1 same as first1

• ถ้าชื่อเขตข้อมูลแสดงอยู่ในคอลัมน์ ข้อกำหนดเบื้องต้น นั้นเป็นสิ่งที่จำเป็นต้องมีสำหรับเขตข้อมูลทางด้านซ้าย

Sub-templates

Usage

คัดลอกเวอร์ชันเปล่าไปใช้ ชื่อพารามิเตอร์เกือบทั้งหมดรองรับเฉพาะตัวพิมพ์เล็กเท่านั้น (ชื่อย่อบางตัว เช่น |isbn= มีชื่อแทนตัวพิมพ์ใหญ่ เช่น |ISBN= ซึ่งเป็นที่ยอมรับสำหรับการใช้งาน) ใช้เครื่องหมาย "|" (ไปป์) อักขระระหว่างแต่ละพารามิเตอร์ พารามิเตอร์ที่ไม่ได้ใช้อาจถูกลบเพื่อหลีกเลี่ยงความยุ่งเหยิงในหน้าต่างแก้ไข ตัวอย่างบางส่วนในหน้าเอกสารนี้อาจมีวันที่ปัจจุบัน หากวันที่ไม่เป็นปัจจุบัน ให้ purge หน้านั้น

|}

Usage full

ตั้งพารามิเตอร์แบบเต็มในรูปแบบแนวนอน

Usage common

พารามิเตอร์ที่ใช้บ่อยที่สุดในรูปแบบแนวนอน

Usage vertical

ตั้งพารามิเตอร์ทั้งหมดในรูปแบบแนวตั้ง

รายการแนวตั้ง	ข้อกำหนดเบื้องต้น	คำแนะนำสั้น ๆ / หมายเหตุ

Usage vertical mid

| style="vertical-align:top;" |

|}

Usage vertical end

|}

• ถ้าชื่อเขตข้อมูลแสดงอยู่ในคอลัมน์ ข้อกำหนดเบื้องต้น นั้นเป็นสิ่งที่จำเป็นต้องมีสำหรับเขตข้อมูลทางด้านซ้าย

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

มาร์กอัป	แสดงผลเป็น
'''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

syntax

Nested parameters rely on their parent parameters:

• parent
• OR: parent2—may be used instead of parent
  • child—may be used with parent (and is ignored if parent is not used)
  • OR: child2—may be used instead of child (and is ignored if parent2 is not used)

Where aliases are listed, only one of the parameters may be defined; if multiple aliased parameters are defined, then only one will show.

coins

sep_period

sep_comma

required

deprecated

author

• last: Surname of a single author. Do not wikilink—use author-link instead. For corporate authors or authors for whom only one name is listed by the source, use last or one of its aliases (e.g. |author=Bono). Aliases: surname, author, last1, surname1, author1.
  • author: this parameter is used to hold the complete name of a single author (first and last) or to hold the name of a corporate author. This parameter should never hold the names of more than one author.
  • first: Given or first names of author; for example: Firstname Middlename or Firstname M. or Firstname M. Sr. Do not wikilink—use author-link instead. Aliases: given, first1, given1. Requires last; first name will not display if last is empty. Use generational and regnal suffixes only in accordance with MOS:JRSR and use honorifics only in accordance with MOS:HON.
  • OR: for multiple authors, use last1, first1 through lastn, firstn, where n is any consecutive number for an unlimited number of authors (each firstn requires a corresponding lastn, but not the other way around). See the display parameters to change how many authors are displayed. Aliases: surname1, given1 through surnamen, givenn, or author1 through authorn. For an individual author plus an institutional author, you can use |first1=...|last1=...|author2=....
  • author-link: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: author-link1, author1-link, authorlink.
  • OR: for multiple authors, use author-link1 through author-linkn. Aliases: author1-link through authorn-link.
  • name-list-style: accepts a limited list of keywords as value; when set to amp, ampersand, or &, inserts an ampersand between the last two names in a name list; when set to and, inserts the conjunction 'and' between the last two names of a name list; when set to vancdisplays name lists in Vancouver style when the lists use the last/first forms of name parameters.
• vauthors: comma-separated list of author names in Vancouver style; enclose corporate or institutional author names in doubled parentheses. End with etal if appropriate:

  |vauthors=Smythe JB, ((Megabux Corp.)), etal

  • author-link and author-mask may be used for the individual names in |vauthors= as described above
• authors: Free-form list of author names; use of this parameter is discouraged because it does not contribute to a citation's metadata; not an alias of last.
• translator-last: Surname of translator. Do not wikilink—use translator-link instead. Aliases: translator-surname, translator1, translator1-last, translator-last1.
  • translator-first: Given or first names of translator. Do not wikilink—use translator-link instead. Aliases: translator-given, translator1-first, translator-first1.
  • OR: for multiple translators, use translator-last1, translator-first1 through translator-lastn, translator-firstn, where n is any consecutive number for an unlimited number of translators (each translator-firstn requires a corresponding translator-lastn, but not the other way around). Aliases: translator1-last, translator1-first through translatorn-last, translatorn-first, or translator1 through translatorn.
  • translator-link: Title of existing Wikipedia article about the translator—not the translator's website; do not wikilink. Aliases: translator-link1, translator1-link.
  • OR: for multiple translators, use translator-link1 through translator-linkn. Aliases: translator1-link through translatorn-link.
• collaboration: Name of a group of authors or collaborators; requires author, last, or vauthors listing one or more primary authors; follows author name-list; appends "et al." to author name-list.
• Note: When using เชิงอรรถอย่างย่อ or การอ้างอิงในวงเล็บ styles with templates, do not use multiple names in one field, or else the anchor will not match the inline link.

editor

title

(See also Help:Citation Style 1 § Titles and chapters.)

• title: Title of source. Can be wikilinked to an existing Wikipedia article or url may be used to add an external link, but not both. Displays in italics. If script-title is defined, use title to hold a Romanization (if available) of the title in script-title.
  • script-title: Original title for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc.); not italicized, follows italicized Romanization defined in title (if present). Must be prefixed with one of the supported language codes to help browsers properly display the script:

    ... |title=Tōkyō tawā |script-title=ja:東京タワー |trans-title=Tokyo Tower ...

  • trans-title: English translation of the title if the source cited is in a foreign language. Displays in square brackets after title. Use of the language parameter is recommended.

Titles containing certain characters will not display and link correctly unless those characters are encoded.

newline	[	]	|
space	[	]	{{!}} (preferred)
	{{bracket|text}}		| or {{pipe}} – see also Help:Table § Rendering the pipe

• title-link: Title of existing Wikipedia article about the source named in title – do not use a web address; do not wikilink.

web

chapter

type

journal

edition

series

series_episode

event

agency

volume

date

• date: Date of source being referenced. Can be full date (day, month, and year) or partial date (month and year, season and year, or year). Use same format as other publication dates in the citations. Required when year is used to disambiguate {{sfn}} links to multiple-work citations by the same author in the same year.^[more] Do not wikilink. Displays after the authors and is enclosed in parentheses. If there is no author, then displays after publisher. For acceptable date formats, see Help:Citation Style 1 § Dates.

For approximate year, precede with "c. ", like this: |date=c. 1900.

For no date, or "undated", add as |date=n.d.

• year: Year of source being referenced. Use of |date= is recommended unless all of the following conditions are met:
  1. The template uses |ref=harv, or the template is {{citation}}, or |mode=cs2
  2. The |date= format is YYYY-MM-DD.
  3. The citation requires a CITEREF disambiguator.
• orig-year: Original publication year; displays after the date or year. For clarity, please supply specifics. For example: |orig-year=First published 1859 or |orig-year=Composed 1904. Alias: origyear
• df: date format; sets rendered dates to the specified format; does not support date ranges or seasonal dates. Accepts one value which may be one of these:

  dmy – set publication dates to day month year format; access- and archive-dates are not modified;

  mdy – as above for month day, year format

  ymd – as above for year initial numeric format YYYY-MM-DD

  dmy-all – set publication, access-, and archive-dates to day month year format;

  mdy-all – as above for month day, year format

  ymd-all – as above for year initial numeric format YYYY-MM-DD

publisher

newsgroup

language

• language: The language (or a comma-separated list of the languages) in which the source is written, as either the ISO 639 language code (preferred) or the full language name. Examples: |language=ru; |lang=fr, pt-br; |lang=รัสเซีย; |language=ฝรั่งเศส, โปรตุเกส. See the list of supported codes and names. Do not use templates or wikilinks. Displays in parentheses with "in" before the language name or names. When the only source language is English, no language is displayed in the citation. The use of languages recognized by the citation module adds the page to the appropriate subcategory of หมวดหมู่:CS1 แหล่งที่มาภาษาต่างประเทศ. Because cs1|2 templates are often copied from en.wiki to other wikis, the use of language codes is preferred so that language names render in the correct language and form: espagnol at a French-language wiki instead of the English word "Spanish". Aliases: lang

pages

time

id1

id2

url

chapterurl

lay

quote

ref

ref2

display

Subscription or registration required

map_series

map_pages

interview_id

interview_author

interview_interviewer

album_name

album_artist

season

network

transcript

notestitle

conference

See also

คู่มือการใช้งานที่ปรากฏด้านบนนี้ดึงมาจาก แม่แบบ:เอกสารรูปแบบการอ้างอิง/doc (แก้ | ประวัติ)
ผู้เขียนสามารถทำการทดลองได้ที่กระบะทราย (สร้าง | คัดลอก) และชุดทดสอบ (สร้าง) ของแม่แบบนี้
โปรดเพิ่มหมวดหมู่ไปที่หน้าย่อย /doc หน้าย่อยของแม่แบบนี้