Template:Citation Style documentation: Difference between revisions

Nothing to hide, but nothing to show you either.
Jump to navigation Jump to search
Content added Content deleted
imported>Gadget850
(ce display)
imported>Gadget850
(→‎Display options: separator)
Line 101: Line 101:
** '''laydate''': Date of summary.
** '''laydate''': Date of summary.
|display=
|display=
* '''author-mask''': Primarily intended for use in bibliography lists for some styles where multiple works by a single author are listed. It replaces the name of the first author with a strike-thru dash (—) author-mask em in length. If {{para|author-mask|1}} then the dash will be one em in length and so on. 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. Do not use in reference lists generated by {{tl|reflist}} or {{tag|references|s}} as there is no control as to the order that references will display.
* '''author-mask''': Primarily intended for use in bibliographies for some styles where multiple works by a single author are listed. It replaces the name of the first author with a strike-thru dash (—) author-mask em in length. If {{para|author-mask|1}} then the dash will be one em in length and so on. Set author-mask to a text value to display a word instead:– for example, 'with'. You must still include the parameters for all authors for metadata purposes. Do not use in a list generated by {{tl|reflist}} or {{tag|references|s}} as there is no control as to the order that references will display.
* '''author-separator''': Changes the separator between authors; defaults to a semicolon (;)
* '''author-name-separator''': Changes the separator between last and first names; defaults to a comma (,)
* '''author-name-separator''': Changes the separator between last and first names; defaults to a comma (,)
* '''author-separator''': Changes the separator between authors; defaults to a semicolon (;)
* '''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."; for example {{para|display-authors|2}}. The "et al." may be suppressed by the use of {{para|display-authors|9}}.
* '''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." (e.g., {{para|display-authors|2); alternatively, the "et al." may be suppressed by the use of {{para|display-authors|9}}.
* '''postscript''': The closing punctuation for the citation; defaults to a period (.); if blank, no terminating punctuation will be used. Ignored if {{para|quote}} is specified.
* '''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 {{para|author-separator}} if set.
* '''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 {{para|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 {{tl|quote}} is specified.
* '''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.
}}<noinclude>
}}<noinclude>
{{documentation}}</noinclude>
{{documentation}}</noinclude>

Revision as of 11:23, 7 January 2012

{{#switch: |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)

|author=

  • last: Surname of author. Do not wikilink— use authorlink instead.
    • first: Given or first names) of author, including title(s)— e.g. Firstname Middlename or Firstname M. or Dr. Firstname M., Sr.. Do not wikilink— use authorlink instead.
      • The last and first parameters are not ideally suited to authors whose surname is usually written first (e.g. as in Chinese). Use last to include the same format as the source to handle these cases.
    • authorlink: Title of Wikipedia article about the author— not the author's website. Article should already exist. Must not be wikilinked itself. Must be used with author or first and last.
  • OR: for multiple authors, use the parameters first1, last1 ... firstn, lastn to correctly record all the information about the source (the first nine authors are displayed, then "et al." is appended if even more authors were specified). Do not wikilink as there are corresponding authorlink1 ... authorlink9 parameters as well. This usage is preferred to the use of coauthors.
  • OR: author: (deprecated) Full name of author, preferably surname first. Do not wikilink— use authorlink instead.
    • coauthors: (deprecated) Full name of additional author or authors— e.g. Joe Bloggs, John F. Kennedy, H. R. Dent. Use the same name order and separators as the author fields.

|editor=

  • editor: Name of editor(s). Do not Wikilink any values in the editor value but use editor-link instead. If chapter is not specified, then "ed." displays after the editor's name(s). If chapter is specified, then "In" shows before the editor's name(s). This implies that the author is responsible only for part of the source (including the cited chapter) and the editor responsible for the whole source. If, however, the author(s) and editor(s) are responsible for the whole source, then the editor parameter or its alternates described below should not be used if the chapter parameter is being used. Instead, the editor(s) should be included in an author parameter with possibly "(ed.)" after the surname(s). Alternatively, the editor parameter may be used if the chapter detail is included in the title parameter instead of using the chapter parameter.
  • OR: alternatively editor-first and editor-last can be used in the same way as first and last.
  • OR: for multiple editors up to four in number, use the parameters editor1-first, editor1-last ... editorn-first, editorn-last to correctly record all the information about the source in the same way as firstn and lastn.
    • editor-link or editor1-link ... editorn-link is used in the same way as authorlink or authorlinkn.

|others=

  • others: To record other contributors to the work, such as "Illustrated by Smith" or "Trans. Smith".

|title_italics= Template:Citation Style 1 documentation/titles

  • 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. Formatted in italics.
    • 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 title field and it will link to the url field, if used. Use of the language parameter is recommended.

|title_quotes= Template:Citation Style 1 documentation/titles

  • 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. Formatted in quotes.
    • 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 title field and it will link to the url field, if used. Use of the language parameter is recommended.

|chapter=

  • chapter: The chapter of the source, written in full. May be wikilinked or may use chapterurl, but not both. Formatted in quotations.
    • trans_chapter: Acts in the same way as trans_title. The parameter will be displayed in square brackets within the quotation marks which embrace the chapter field. Use of the language parameter is recommended.

|type=

  • type: Can be used to provide additional information about the publication type. Appears in parentheses following the title.

|journal=

  • journal or periodical or newspaper or magazine: Name of the source.

|edition=

  • edition: When the publication has more than one edition. E.g.: "2nd", "Revised" etc. Displays " ed." after this field, so |edition=2nd produces "2nd ed."

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

|volume=

  • volume: For one publication published in several volumes. This template displays the text in this parameter in bold type after the title and series parameters. An alternative is to include the volume information in the title parameter after the main title.

|issue=

  • issue: When the publication is one of a series that is published periodically.

|date=

  • date: Full date of publication edition being referenced, in the same format as other dates in citations in the same article. Must not be wikilinked. Use only the full date including month, day and year, else the anchor may be malformed.
  • OR: year: Year of publication edition being referenced.
    • month: Name of the month of publication. If you also have the day, use date instead. Must not be wikilinked.
    • origyear: Original publication year, for display alongside the date or year. For clarity, please supply specifics, for instance |origyear=First published 1859 or |origyear=Composed 1904. This field only displays if there is a value for year or date.

|publisher=

  • publisher: Name of publisher; do not include corporate designation such as "Ltd" or "Inc".
    • location: Geographical place of publication.

|language=

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

|pages=

  • page: Page in the source that supports the content.
  • 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 this parameter to indicate the total number of pages in the source.
  • 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.

|id1=

  • id: A unique identifier, used where none of the specialized identifiers are applicable.

|id2=

|url= Template:Citation Style 1 documentation/urls

  • 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 use this parameter to link to any commercial booksellers (such as Amazon.com). The ISBN link is a much better alternative which allows readers access to the books in their own countries or through their own choice of source, including Amazon, Google Books, thousands of libraries, and more.
    • format: Format of the work referred to by url, e.g. PDF. HTML implied if not specified.
    • accessdate: Full date when url was accessed. Should be in the same format as other dates in citations in the same article. Must not be wikilinked.
  • archive parameters
    • 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. Do not be wikilinked. Requires archiveurl.
    • deadurl: To change the order with the title retaining the original link and the archive linked at the end, set |deadurl=no

|chapterurl=

  • chapterurl: URL of an individual chapter of online source. Should be at the same site as url, if any. If chapterurl 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 chapterurl used, but not both.

|quote=

  • quote: Relevant text quoted from the source; enclosed in quotes. When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation.

|ref=

|lay=

  • laysummary: Link to a non-technical summary (or review) of the source.
    • laysource: Name of the source, such as the magazine or journal.
    • laydate: Date of summary.

|display=

  • author-mask: Primarily intended for use in bibliographies for some styles where multiple works by a single author are listed. It replaces the name of the first author with a strike-thru dash (—) author-mask em in length. If |author-mask=1 then the dash will be one em in length and so on. Set author-mask to a text value to display a word instead:– for example, 'with'. You must still include the parameters for all authors for metadata purposes. Do not use in a list generated by {{reflist}} or <references /> 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 (,)
  • author-separator: Changes the separator between authors; defaults to a semicolon (;)
  • 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." (e.g., |display-authors=2); alternatively, the "et al." may be suppressed by the use of |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 specified.
  • 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.