Wiktenauer logo.png

Template:Citation Style documentation

From Wiktenauer
(Redirected from Template:Csdoc)
Jump to navigation Jump to search
[edit] [history] [purge] Documentation icon Template documentation

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

[edit subtemplate]

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 aliased parameters are defined, then only one will show.

coins

[edit subtemplate]

This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata; see Wikipedia:COinS.

  • Be careful using templates within the citation template, as many will add a lot of extraneous HTML or CSS that will be rendered in the meta-data.
    • Known templates that should not be used: {{smallcaps}}.

sep_period

[edit subtemplate]

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

sep_comma

[edit subtemplate]

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

required

[edit subtemplate]

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

[edit subtemplate]

These parameters are deprecated and will no longer work. Use will place the page in Category:Pages containing cite templates with deprecated parameters.

Use accessdate:

  • access-date
  • accessed
  • accessdaymonth
  • accessday
  • accessmonthday
  • accessmonth
  • accessyear

Use date:

  • day

No longer supported:

  • dateformat
  • doilabel

Options for this field:

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

author

[edit subtemplate]

  • last: Surname of author. Do not wikilink—use authorlink instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use last to include the same format as the source. Aliases: last, author, authors, last1, author1
    • first: Given or first names of author, including title(s); for example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use authorlink instead. Aliases: first, first1.
    • OR: for multiple authors, use last1, first1 through last9, first9 for up to nine authors. By default, if nine authors are defined, then only eight will show and "et al." will show in place of the last author. Aliases: last1, author1 through last9, author9.
  • authorlink: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: authorlink, authorlink1, author-link, author1-link.
  • OR: for multiple authors, use authorlink1 through authorlink9. Aliases: authorlink1, author1-link through authorlink9, author9-link.
When using Shortened footnotes or Parenthetical referencing styles with templates, do not use multiple names in one field 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

[edit subtemplate]

  • 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-last, editor1-last, editor, editors.
    • 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-first, editor1-first.
    • OR: for multiple editors, use editor1-last, editor1-first through editor4-last, editor4-first for up to four editors.
  • editor-link: Title of existing Wikipedia article about the editor—not the editor's website; do not wikilink. Aliases: editor-link, editor1-link.
  • OR: for multiple editors, use editor1-link through editor4-link.
Display:
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."; more than three editors will be followed by "et al., eds."

title

[edit subtemplate]

  • 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.
    • 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 display and link incorrectly unless those characters are encoded.
newline [ ]
space [ ] |

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

[edit subtemplate]

  • title: Title of web page. Displays in quotes.
Titles containing certain characters will display and link incorrectly unless those characters are encoded.
newline [ ]
space [ ] |
  • trans_title: If the source cited is in a foreign language, an English translation of the title can be given here. The template will display this in square brackets after the work field and it will link to the url field, if used. Use of the language parameter is recommended.
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.
  • work: Title of website; can be wikilinked to an existing Wikipedia article or url may be used to add an external link, but not both. Displays in italics.

chapter

[edit subtemplate]

  • chapter: The title of the source. May be wikilinked or may use chapter-url, but not both. Displays in quotes.
    • trans_chapter: English translation of the title if the source cited is in a foreign language. Displays in square brackets after the chapter field; if chapter-url is defined, then trans_title is included in the link. Use of the language parameter is recommended.

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

[edit subtemplate]

  • type: Provides additional information about the media type of the source; format in sentence case. Displays in parentheses following the title. Examples: Thesis, Booklet, CD liner, Press release.

Options for this field:


  • type_default: Adds "Defaults to type_default"

journal

[edit subtemplate]

  • work: Name of the source periodical; may be wikilinked if relevant. Displays in italics. Aliases: work, journal, newspaper, magazine, periodical.
    • issue: When the publication is one of a series that is published periodically.
When set, work changes the formatting of other parameters:
title is not italicized and is enclosed in quotes.
chapter is italicized and is not enclosed in quotes.
location and publisher are enclosed in parentheses.
page and pages do not show p. or pp.
edition does not display.

Options for this field:

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

edition

[edit subtemplate]

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

series

[edit subtemplate]

  • 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

[edit subtemplate]

  • series: The name of the series the episode belongs to; may be wikilinked.

event

[edit subtemplate]

  • event: Event where the speech was given.

agency

[edit subtemplate]

volume

[edit subtemplate]

  • volume: For one publication published in several volumes. Displays in bold after the title and series fields; if bolding is not desired, then include the volume information in the title field.

date

[edit subtemplate]

  • date: Full date of source being referenced in the same format as other publication dates in the citations. Do not wikilink. Displays after the authors and enclosed in parentheses. If there is no author, then displays after publisher.
  • OR: year: Year of source being referenced.
    • month: Name of the month of publication. If you also have the day, use date instead; do not wikilink.
    • origyear: Original publication year; displays after the date or year. For clarity, please supply specifics; example: |origyear=First published 1859 or |origyear=Composed 1904.

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

[edit subtemplate]

  • publisher: Name of publisher; may be wikilinked if relevant. Not normally included for periodicals. Corporate designations such as "Ltd", "Inc" or "GmbH" are not usually included. Displays after title; if work is defined, then publisher and location are enclosed in parentheses.
  • location: 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 preceding publisher.
  • 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

[edit subtemplate]

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

language

[edit subtemplate]

  • 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

[edit subtemplate]

  • page: Page in the source that supports the content. Displays preceded with {{{1}}} unless |nopp=y.
  • 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. Displays preceded with {{{1}}} unless |nopp=y.
    • nopp: Set to y to suppress the {{{1}}} or {{{1}}} 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=.
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

[edit subtemplate]

  • 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

[edit subtemplate]

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

id2

[edit subtemplate]

url

[edit subtemplate]

  • 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 URL was accessed; use the same format as other accessdates in the citations; do not wikilink. Can be hidden 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 and the Internet Archive; requires archivedate.
      • archivedate: Date when the item was archived; use the same format as other archive dates; 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 have error checking to ensure that all the required parameters are included, else {{citation error}} is invoked. 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.
  • format: Format of the work referred to by url; examples: PDF, DOC, XLS; HTML is implied and should not be specified; displayed in parentheses after title. Does not change external link icon.
URLs must begin with a supported URI scheme: http:// and https:// will be supported by all browsers; irc://, ircs://, ftp://, news:, mailto: and gopher:// will require a plugin or an external application and should normally be avoided. IPv6 host-names are currently not supported.
If URLs in citation template parameters contain certain characters they will display and link incorrectly. Those characters need to be percent-encoded. For example, a space must be replaced by %20. To encode the URL, replace these characters:
sp " ' < > [ ] | }
%20 %22 %27 %3c %3e %5b %5d %7c %7d
Single apostrophes do not need to be encoded; but unencoded multiples will be parsed as italic or bold markup. Single curly closing braces also do not need to be encoded; but an unencoded pair will be parsed as the double closing braces for the template transclusion.

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

[edit subtemplate]

  • 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: chapter-url, chapterurl

lay

[edit subtemplate]

  • laysummary: URL link to a non-technical summary or review of the source; the URL title is set to "Lay summary".
    • laysource: Name of the source of the laysummary. Displays in italics and preceded by an endash.
    • laydate: Date of the summary. Displays in parentheses.

quote

[edit subtemplate]

  • 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 needs to include terminating punctuation.

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

[edit subtemplate]

ref2

[edit subtemplate]

display

[edit subtemplate]

  • author-mask: Replaces the name of the first author with em dashes or text. Set author-mask to a numeric value to set the dash in em spaces; set author-mask to a text value to display a word instead; for example, "with". You must still include the values for all authors for metadata purposes. Primarily intended for use in bibliographies for some styles where multiple works by a single author are listed. Do not use in a list generated by {{reflist}}, <references></references> or similar as there is no control as to the order that references will display.
  • author-name-separator: Changes the separator between last and first names; defaults to a comma and space (, ); if the parameter is present, but blank, no separator punctuation will be used; a space must be encoded as &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.
  • author-separator: Changes the separator between authors; defaults to a semicolon and space (; ); if the parameter is present, but blank, no separator punctuation will be used; a space must be encoded as &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.
  • display-authors: By default, the number of authors displayed is limited to 8; if 9 are provided, the ninth is displayed as "et al." This parameter allows display of fewer authors before the "et al."; example: |display-authors=2; "et al." may be suppressed altogether by setting |display-authors=9.
  • lastauthoramp: When set to any value, changes the separator to use between the last two names in lists of authors to an ampersand (&); defaults to a semicolon and space (; ), else author-separator if set.
  • postscript: The closing punctuation for the citation; defaults to a period (.); if the parameter is present, but blank, no terminating punctuation will be used. Ignored if quote is defined.
  • separator: The punctuation used to separate lists of authors, editors, etc. Defaults to a period (.); if the parameter is present but blank, no separator punctuation will be used; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.

Options for this field:


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

map_series

[edit subtemplate]

  • scale: Scale of map.
  • series: Title of map series.
  • version: Version of map.
  • cartography: Person or entity that did the cartography. Displays preceded by "Cartography by".

map_id

[edit subtemplate]

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

map_pages

[edit subtemplate]

  • 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.

interview_id

[edit subtemplate]

  • program: News program or event.
  • callsign: Radio or TV callsign.

interview_author

[edit subtemplate]

  • last: Surname of subject. Do not wikilink—use authorlink instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use last to include the same format as the source.
    • first: Given or first names of author, including title(s); example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr.. Do not wikilink—use authorlink instead.
    • OR: for multiple subjects, use first1, last1 through first9, last9 for up to nine subjects. By default, if nine subjects are defined, then only eight will show and "et al." will show in place of the last author.
  • authorlink: Title of existing Wikipedia article about the subject—not the subject's website; do not wikilink.
  • OR: for multiple subjects, use subjectlink1 through subjectlink9.
Aliases: subject, last, last1, author1, author, authors; subject2, last2, author2 through subject9, last9, author9; subjectlink, authorlink, authorlink1; subjectlink2, authorlink2 through subjectlink9, authorlink9.

interview_interviewer

[edit subtemplate]

  • interviewer: Full name of interviewer(s); separate interviewers with a semicolon (;); wikilink as desired.
  • cointerviewers: (deprecated) Full names of co-interviewers

DVD-notes_date

[edit subtemplate]

Note: The date parameters in this template differ from other templates in this series.

  • date: Full date of the video was originally released; use the same format as other dates in the article; do not wikilink.
  • OR: titleyear: Year of source being referenced.
    • month: Name of the month of publication. If you also have the day, use date instead; do not wikilink.
    • year: Year DVD published if different from the release year.

album_name

[edit subtemplate]

  • name: Name of the release; may be wikilinked. Displays in italics by default
    • type: Set |type=single to display name in quotes.

album_artist

[edit subtemplate]

  • artist: The artist or band name; may be wikilinked; Various artists may be used as needed.

season

[edit subtemplate]

  • season: Season number, usually for US shows.
  • OR: seriesno: Series number, usually for British shows.
  • number: Many episodic shows are identified by separate season and episode numbers. Alternately, some shows prefer the format of a single episode number that includes the season within it; this format can be used by omitting the season field.

network

[edit subtemplate]

  • network: The network the episode was aired on. (e.g. ABC, NBC, CBS, Fox, Disney, USA Network, BBC)
    • station: Call letters of the local station (if any).

transcript

[edit subtemplate]

  • transcript: Transcript of the original source.
    • transcripturl: URL of the transcript.

notestitle

[edit subtemplate]

  • notestitle: The title of the notes, if different from the title of the album.

conference

[edit subtemplate]

  • conference: Name of the conference, may include location if different from location and date if different from date or year.
    • conferenceurl: URL of conference proceedings, if different from url.

See also