ទំព័រគំរូ:Citation Style documentation

Template documentation[view] [edit] [history] [purge]

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.

Parameters

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

This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata. See: Wikipedia:COinS. As a general rule, only one data item per parameter. Do not include explanatory or alternate text:

• Use |date=27 September 2007 not ទំព័រគំរូ:!xt

Use of templates within the citation template, is generally discouraged as many of these templates will add a lot of extraneous HTML or CSS that will be rendered in the metadata.

COinS metadata is created for these parameters:

• |periodical=, |journal=, |newspaper=, |magazine=, |work=, |website=, |encyclopedia=, |encyclopaedia=, |dictionary=
• |chapter=, |contribution=, |entry=, |article=, |section=
• |title=
• |publicationplace=, |publication-place=
• |date=, |year=, |publicationdate=, |publication-date=
• |series=
• |volume=
• |issue=, |number=
• |page=, |pages=, |at=
• |edition=
• |publisher=, |distributor=, |institution=
• |url=
• |chapterurl=, |chapter-url=, |contributionurl=, |contribution-url=, |sectionurl=
• |author#=, |Author#=, |authors#=, |author#-last=, |author-last#=, |last#=, |surname#=
• any of the identifiers (|isbn=, |issn=, |doi=, |pmc=, etc)

sep_period

By default, sets of fields are terminated with a period (.). This can be an issue when the last field uses an abbreviation or initial that ends with a period, as then two periods will display (..). The only solution is to not include the last period in the value for the set of fields.

sep_comma

By default, sets of fields are terminated with a comma (,).

required

This parameter is required and will generate an error if not defined. On errors, main, help and template pages are placed into Category:Articles with incorrect citation syntax. Set |template doc demo=true to disable categorization; mainly used for documentation where the error is demonstrated.

deprecated

Options for this field:

• |date2=yes adds:
  • date2
  • month2
  • year2

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. Do not wikilink—use author-link instead.
  • 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.
  • 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). ទំព័រគំរូ:Crossref 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 shortened footnotes or ទំព័រគំរូ:Paren styles with templates, do not use multiple names in one field, or else the anchor will not match the inline link.

Options for this field:

• |coauthors=yes adds the coauthors parameter.
• |others=yes adds the others parameter.
• |aliases= includes aliases for last.

editor

• editor-last: surname of editor. Do not wikilink—use editor-link instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use editor-last to include the same format as the source. Aliases: editor-last1, editor1-last, editor-surname, editor-surname1, editor1-surname, editor, editor1.
  • editor: This parameter is used to hold the complete name of a single editor (first and last), or the name of an editorial committee. This parameter should never hold the names of more than one editor.
  • editor-first: given or first names of editor, including title(s); example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use editor-link instead. Aliases: editor-first1, editor1-first, editor-given, editor-given1, editor1-given.
  • OR: for multiple editors, use editor-last1, editor-first1 through editor-lastn, editor-firstn (Aliases: editorn-last, editor-surnamen or editorn-surname; editorn-first, editor-givenn or editorn-given; editorn). For an individual editor plus an institutional editor, you can use |editor-first1=...|editor-last1=... |editor2=....
  • editor-link: title of existing Wikipedia article about the editor—not the editor's website; do not wikilink. Aliases: editor-link1.
  • OR: for multiple editors, use editor-link1 through editor-linkn (alias editorn-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.
• veditors: comma separated list of editor names in Vancouver style; enclose corporate or institutional names in doubled parentheses. End with etal if appropriate:

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

  • editor-linkn and editor-maskn may be used for the individual names in |veditors=, as described above
• Display:

  Use display-editors to control the length of the displayed editor name list and to specify when "et al." is included.

  If authors: Authors are first, followed by the included work, then "In" and the editors, then the main work.

  If no authors: Editors appear before the included work; a single editor is followed by "ed."; multiple editors are followed by "eds."

title

• 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; if url is defined, then trans-title is included in the link. 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}} – ទំព័រគំរូ:Crossref

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

Options for this field:

title_format sets the display format:

• quotes = Displays in quotes.
• work = If work is defined, then title is displayed in quotes, else displays in italics.
• default = Displays in italics.

title_title sets the display title:

• encyclopedia = encyclopedia
• default = title

web

• title: Title of source page on website. Displays in quotes. 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); follows 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; trans-title is included in the link. Use of the language parameter is recommended.

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

newline	[	]	|
space	[	]	|
	{{bracket|text}}		{{pipe}} – ទំព័រគំរូ:Crossref

This parameter is required and will generate an error if not defined. On errors, main, help and template pages are placed into Category:Articles with incorrect citation syntax. Set |template doc demo=true to disable categorization; mainly used for documentation where the error is demonstrated.

• website: Title of website; may be wikilinked. Displays in italics. Aliases: work

chapter

Options for this field:

title_format sets the display format:

• italics = Displays in italics.
• work = If work is defined, then title is displayed in quotes, else displays in italics.
• default = Displays in quotes.

title_title sets the display title:

• booktitle = booktitle
• default = chapter

type

Options for this field:

• type_default: Adds "Defaults to type_default"

journal

• work (required by {{cite journal}} and {{cite magazine}}): Name of the work containing the source; may be wikilinked if relevant. Displays in italics. If the name of the periodical changed over time use the name at the time of the source's publication. If script-work is defined, use work to hold a Romanization (if available) of the title in script-work. Aliases: journal, newspaper, magazine, periodical, website. Use Latin script. For languages written in non-Latin based scripts (Arabic, Chinese, Cyrillic, Greek, Hebrew, Indic, Japanese, Korean, etc.) use a standard Romanization in this field.
  • script-work: Work title in its original, non-Latin script; not italicized, follows italicized Romanization defined in work (if present). Must be prefixed with one of the supported language codes to help browsers properly display the script. Leave empty for Latin-based scripts (Czech, French, Turkish, Vietnamese, etc.). Aliases: script-journal, script-newspaper, script-magazine, script-periodical, script-website.
  • trans-work: English translation of the work title if the source cited is in a foreign language. Displays in square brackets after work or script-work. Aliases: trans-journal, trans-newspaper, trans-magazine, trans-periodical, trans-website.

    ... |work=Zhōngguó piàofáng |script-work=zh:中国票房 |trans-work=China Box Office ...

  • issue: When the publication is one of a series that is published periodically. Alias: number. When the issue has a special title of its own, this may be given, in italics, along with the issue number, e.g. |issue=2, ''Modern Canadian Literature''. Please choose either |issue= or |number= depending on what is used in the actual publication. If a publication carries both, issue and number designations (typically one being a year-relative and the other an absolute value), provide them both, for example |issue=2 #143. Displayed in parentheses following volume.

When set, work changes the formatting of other parameters in the same citation:

title is not italicized and is enclosed in quotes.

chapter does not display (and will produce an error message).

Options for this field:

• department adds:

• department: Regular department within the periodical. Displays after work and is in plain text.

edition

• edition: When the publication has more than one edition; for example: "2nd", "Revised", and so forth. Appends the string " ed." after the field, so |edition=2nd produces "2nd ed." Does not display if a periodical field is defined.

series

• series or version: When the source is part of a series, such as a book series or a journal where the issue numbering has restarted.

series_episode

event

agency

volume

• volume: For one publication published in several volumes. Displays after the title and series fields; volume numbers should be entered just as a numeral (e.g. 37). Volume values that are wholly digits, wholly uppercase Roman numerals, or fewer than five characters will appear in bold. Any alphanumeric value of five or more characters will not appear in bold. In rare cases, publications carry both, an ongoing volume and a year-related value; if so, provide them both, for example |volume=IV / #10.

date

• date: Date of referenced source. 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 the publisher. ទំព័រគំរូ:Crossref

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

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

Automatic date formatting: Citation Style 1 and 2 templates, including this template, automatically render dates in all date parameters (such as |date=, |publication-date=, |access-date=, |archive-date=, etc.) except for |orig-date= in the style specified by the article's {{use dmy dates}} or {{use mdy dates}} template. See those templates' documentation for details.

• year: Year of source being referenced. The usage of this parameter is discouraged; use the more flexible |date= parameter instead unless both of the following conditions are met:
  1. The |date= format is YYYY-MM-DD.
  2. The citation requires a CITEREF disambiguator.
• orig-date: Original publication date or year; displays in square brackets after the date (or year). For clarity, please supply specifics. For example: |orig-date=First published 1859 or |orig-date=Composed 1904. As |orig-date= does not support automatic date formatting, use the same date format as defined by |df= (or, if it exists in the article, by |cs1-dates= of a {{use dmy dates}} or {{use mdy dates}} template), or as used in the |date= parameter. Alias: orig-year
• df: date format; sets rendered dates to the specified format; does not support date ranges or seasonal dates; overrides the automatic date formatting described above. 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

Options for this field:

• aliases includes aliases for date
• began adds:

• OR: began: Full date the first part of the program or episode aired.
  • AND: ended: Full date the last part of the program or episode aired.

publisher

• publisher: Name of publisher; may be wikilinked if relevant. The publisher is the company that publishes the work being cited. Do not use the publisher parameter for the name of a work (e.g., a book, encyclopedia, newspaper, magazine, journal, website). Not normally used for periodicals. Corporate designations such as "Ltd", "Inc" or "GmbH" are not usually included. Omit where the publisher's name is substantially the same as the name of the work (for example, The New York Times Co. publishes The New York Times newspaper, so there is no reason to name the publisher). Displays after title; if work is defined, then publisher is enclosed in parentheses.
• place: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the location; examples: The Boston Globe, The Times of India. Displays after the title; if work is defined, then location is enclosed in parentheses. Alias: location
• publication-place: If any one of publication-place, place or location are defined, then the location shows after the title; if publication-place and place or location are defined, then place or location are shown before the title prefixed with "written at" and publication-place is shown after the title.
• publication-date: Date of publication when different from the date the work was written. Displays only if year or date are defined and only if different, else publication-date is used and displayed as date. Use the same format as other dates in the article; do not wikilink. Follows publisher; if work is not defined, then publication-date is preceded by "published" and enclosed in parenthesis.

Options for this field:

• |work=no suppresses "; if work is defined, then publisher and location are enclosed in parentheses"
• |map=yes changes:
  • publisher: Name of publisher. Displays before title. Do not wikilink—use publisher-link instead.
  • publisher-link: Title of existing Wikipedia article about the publisher—not the publisher's website; do not wikilink.

newsgroup

• newsgroup: Name of newsgroup; a link is automatically created; do not wikilink.

language

• language: The language the source is written in, if not English. Displays in parentheses with "in" before the language name. Use the full language name; do not use icons or templates.

pages

• page: The number of a single page in the source that supports the content. Use either |page= or |pages=, but not both. Displays preceded by p. unless |nopp=y.
• OR: pages: A range of pages in the source that supports the content. Use either |page= or |pages=, but not both. Separate using an en dash (–); separate non-sequential pages with a comma (,); do not use to indicate the total number of pages in the source. Displays preceded by pp. unless |nopp=y.
  • nopp: Set to y to suppress the p. or pp. notations where this is inappropriate; for example, where |page=Front cover.
• OR: at: For sources where a page number is inappropriate or insufficient. Overridden by |page= or |pages=. Use only one of |page=, |pages=, or |at=.

Examples: page (p.) or pages (pp.); section (sec.), column (col.), paragraph (para.); track; hours, minutes and seconds; act, scene, canto, book, part, folio, stanza, back cover, liner notes, indicia, colophon, dust jacket, verse.

Options for this field:

• work adds "or work is defined"

time

• minutes: Time the event occurs in the source; followed by "minutes in".
• OR: time: Time the event occurs in the source; preceded by default text "Event occurs at time".
  • timecaption: Changes the default text displayed before time.

id1

• id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use a template as applicable.

id2

These identifiers create links and are designed to accept a single value. Using multiple values or other text will break the link and/or invalidate the identifier.

• arxiv: arXiv identifier; for example: arxiv=hep-th/9205027
• asin: Amazon Standard Identification Number
  • asin-tld: ASIN top-level domain for Amazon sites other than the US; valid values: ca, cn, co.jp, co.uk, de, es, fr, it
• bibcode: Bibcode; used by a number of astronomical data systems; for example: 1974AJ.....79..819H
• doi: Digital object identifier; for example: 10.1038/news070508-7. It is checked to ensure it begins with (10.).
  • doi_brokendate: Date the DOI is broken; use the same format as other dates in the article.
• isbn: International Standard Book Number; for example: 978-0-8126-9593-9. (See: Wikipedia:ISBN and ISBN). Dashes in the ISBN are optional, but preferred. Use the 13-digit ISBN wherever possible; this can normally be found beneath the barcode as a number beginning with 978 or 979 (barcodes beginning with any other numbers are not ISBNs). For sources with the older 9 digit SBN system, prefix the number with a zero; thus, SBN 902888-45-5 should be entered as |isbn=0-902888-45-5. It is checked for length, invalid characters and the proper check digit.
• issn: International Standard Serial Number; eight characters may be split into two groups of four using a hyphen, but not an en dash or a space.
• jfm: Jahrbuch über die Fortschritte der Mathematik
• jstor: JSTOR abstract; for example: "jstor=3793107" will generate JSTOR 3793107.
• lccn: Library of Congress Control Number
• mr: Mathematical Reviews
• oclc: OCLC
• ol: Open Library
• osti: Office of Scientific and Technical Information
• pmc: PubMed Central; use article number for full-text free repository of a journal article.
• pmid: PubMed; use unique identifier.
• rfc: Request for Comments
• ssrn: Social Science Research Network
• zbl: Zentralblatt MATH

url

• url: URL of an online location where the text of the publication can be found. Cannot be used if title is wikilinked. If applicable, the link may point to the specific page(s) referenced. Do not link to any commercial booksellers, such as Amazon.com. See: WP:PAGELINKS.
  • accessdate: Full date when original URL was accessed; use the same format as other access and archive dates in the citations. Do not wikilink. Not required for web pages or linked documents that do not change; mainly for use of web pages that change frequently or have no publication date. Can be hidden or styled by registered editors.
  • archiveurl: The URL of an archived copy of a web page, if or in case the url becomes unavailable. Typically used to refer to services like WebCite (see: Wikipedia:Using WebCite) and Internet Archive (see: Wikipedia:Using the Wayback Machine); requires archivedate.
    • archivedate: Date when the original URL was archived; preceded by default text "archived from the original on". Use the same format as other access and archive dates in the citations. Do not wikilink.
    • deadurl: When the URL is still live, but preemptively archived, then set |deadurl=no. This changes the display order with the title retaining the original link and the archive linked at the end.
  • template doc demo: The archive parameters will be error checked to ensure that all the required parameters are included, or else {{citation error}} is invoked. With errors, main, help and template pages are placed into Category:Articles with incorrect citation syntax. Set |template doc demo=true to disable categorization; mainly used for documentation where the error is demonstrated.
• format: Format of the work referred to by url; for example: PDF, DOC, or XLS; displayed in parentheses after title. HTML is implied and should not be specified. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add format information for the visually impaired.

Options for this field:

• pmc adds:

" If url is not defined but pmc is, then url is set to the pmc link.

• Embargo: Date that pmc goes live; if this is in the future, then then url is not set to the pmc link until that date."

chapterurl

• chapter-url: URL of an individual chapter of online source. Should be at the same site as url, if any. If chapter-url is used, url should only be used if the beginning of the work and the cited chapter are on separate webpages at the site. chapter may be wikilinked or chapter-url used, but not both. Aliases: chapterurl.

lay

quote

• quote: Relevant text quoted from the source. Displays enclosed in quotes. When supplied, the citation terminator (a period by default) is suppressed, so the quote must include terminating punctuation. If script-quote is defined, use quote to hold a Romanization (if available) of the text in script-quote.
  • script-quote: Original quotation 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 quote (if available). Alias: none. Must be prefixed with one of the supported language codes to help browsers properly display the script:

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

  • trans-quote: English translation of the quotation if the source quoted is in a foreign language. Displays in square brackets. Alias: none.
• quote-page: The number of a single page quoted in |quote=. Use either |quote-page= or |quote-pages=, but not both. Should be a subset of the page(s) specified in |page=, |pages= or |at=. Displays preceded by p. unless |no-pp=yes. If hyphenated, use {{hyphen}} to indicate this is intentional (e.g. |quote-page=3{{hyphen}}12). Alias: none.
• OR: quote-pages: A list or range of pages quoted in |quote=. Use either |quote-page= or |quote-pages=, but not both. Should be a subset of the pages specified in |pages= or |at=. Separate using an en dash (–); separate non-sequential pages with a comma (,). Displays preceded by pp. unless |no-pp=yes is defined. Hyphens are automatically converted to en dashes; if hyphens are appropriate because individual page numbers contain hyphens, for example: pp. 3-1–3-15, use double parentheses to tell the template to display the value of |quote-pages= without processing it, and use {{hyphen}} to indicate to editors that a hyphen is really intended: |quote-pages=((3{{hyphen}}1{{ndash}}3{{hyphen}}15)). Alias: none.

Options for this field:

• |cs2=yes suppresses "When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation."

ref

ref2

display

Options for this field:

• cs2: When set, changes:
  • postscript to "defaults to none"
  • separator to "Defaults to a comma (,)"

map_series

map_id

map_pages

• page: Page in the source that supports the content; overridden by at.
• OR: pages: Pages in the source that supports the content; separate page ranges with an en dash (–); separate non-sequential pages with a comma (,); do not use to indicate the total number of pages in the source.
• OR: at: For sources where a page number is inappropriate or insufficient.

Examples: page (p.) or pages (pp.); section (Section), inset or other custom location on the map or in the atlas.

• section: The map section of the feature referenced; example: 6A, 9B, 11L, etc.
• inset: The name of the focused inset referenced; example: Downtown Fooburg.

interview_id

interview_author

interview_interviewer

DVD-notes_date

album_name

album_artist

season

network

transcript

notestitle

conference

See also

The above documentation is transcluded from ទំព័រគំរូ:Citation Style documentation/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.