Template:Citation Style documentation: Difference between revisions

Content added Content deleted

Inline

Revision as of 01:44, 12 January 2012

Template documentation[create]

Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.

@@ Line 1: / Line 1: @@
 {{#switch: {{{1|}}}
-|syntax={{Citation Style documentation/syntax}}
+|syntax={{../syntax}}
-|coins={{Citation Style documentation/coins}}
+|coins={{../coins}}
-|sep_period={{Citation Style documentation/sep_period}}
+|sep_period={{../sep_period}}
-|sep_comma={{Citation Style documentation/sep_comma}}
+|sep_comma={{../sep_comma}}
-|author={{Citation Style documentation/author}}
+|author={{../author}}
+|editor={{../editor}}
+|others={{../others}}
-|editor=
+|title_italics={{../title_italics}}
-* '''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.
+|title_quotes={{../title_quotes}}
-*OR: alternatively '''editor-first''' and '''editor-last''' can be used in the same way as '''first''' and '''last'''.
+|chapter={{../chapter}}
-*OR: for multiple editors up to four in number, use the '''editor1-first''', '''editor1-last''' through '''editor4-first''', '''editor4-last'''.
+|type={{../type}}
-** '''editor-link''' or '''editor1-link''' through '''editor4-link''': Title of existing Wikipedia article about the editor— not the editor's website. Must not be wikilinked.
+|journal={{../journal}}
-|others=
+|edition={{../edition}}
-* '''others''': To record other contributors to the work, such as "Illustrated by Smith" or "Trans. Smith".
+|series={{../series}}
-|title_italics=
+|volume={{../volume}}
-{{Citation Style  documentation/titles}}
+|issue={{../issue}}
-* '''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.
+|date={{../date}}
-** '''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.
+|publisher={{../publisher}}
-|title_quotes=
+|language={{../language}}
-{{Citation Style  documentation/titles}}
+|pages={{../pages}}
-* '''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.
+|time={{../time}}
-** '''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.
+|id1={{../id1}}
-|chapter=
+|id2={{../id2}}
-* '''chapter''': The chapter of the source, written in full. May be wikilinked or may use '''chapterurl''', but not both. Formatted in quotations.
+|url={{../url}}
-** '''trans_chapter''': If the source cited is in a foreign language, an English translation of the chapter can be given here. The template will display this in square brackets after the '''chapter''' field and it will link to the '''chapterurl''' field, if used. Use of the '''language''' parameter is recommended.
+|chapterurl={{../chapterurl}}
-|type=
+|quote={{../quote}}
-* '''type''': Can be used to provide additional information about the publication type. Appears in parentheses following the title.{{#if:{{{type_default|}}}|&#32;Defaults to {{{type_default}}}.}}
+|ref={{../ref}}
-|journal=
+|lay={{../lay}}
-* '''journal''' or '''periodical''' or '''newspaper''' or '''magazine''': Name of the source.
+|display={{../display}}
-|edition=
-* '''edition''': When the publication has more than one edition. E.g.: "2nd", "Revised" etc. Displays " ed." after this field, so {{para|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 field in bold type after the '''title''' and '''series''' fields. An alternative is to include the volume information using '''title''' 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 {{para|origyear|First published 1859}} or {{para|origyear|Composed 1904}}.
-|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 to indicate the total number of pages in the source.
-* '''at''': For sources where a page number is inappropriate or insufficient; overridden by {{para|page}} or {{para|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.
-|time=
-* '''time''': Time the event occurs in the source.
-|id1=
-* '''id''': A [[unique identifier]], used where none of the specialized identifiers are applicable. Wikilink as applicable.
-|id2=
-* '''arxiv''': [[ArXiv]]; must not be wikilinked.
-* '''asin''': [[Amazon Standard Identification Number]]; must not be wikilinked.
-* '''bibcode''': [[Bibcode]]; used by a number of astronomical data systems; e.g., ''1924MNRAS..84..308E''; must not be wikilinked.
-* '''doi''': [[Digital object identifier]]; e.g., ''10.1038/news070508-7''; must not be wikilinked.
-** '''doi_brokendate''': Date the DOI is broken; must not be wikilinked.
-* '''isbn''': [[International Standard Book Number]] such as ''1-111-22222-9''; see [[Wikipedia:ISBN]] and [[ISBN#Overview|ISBN]]. Dashes in the ISBN are optional, but preferred. Use the 13-digit ISBN where possible; this can normally be found beneath the barcode as a number beginning 978 or 979. For sources with the older 9 digit SBN system, prefix the number with a zero; thus ''SBN 902888-45-5'' should be entered as {{para|isbn|0-902888-45-5}}; must not be wikilinked.
-* '''issn''': [[International Standard Serial Number]]; eight characters may be split into two groups of four using a [[hyphen]], but not an [[Dash#En dash|N-dash]] or a space; must not be wikilinked. <!-- space separates URL from linkable text; n-dash is not recognised by WorldCat -->
-* '''jfm''': [[Jahrbuch über die Fortschritte der Mathematik]]; must not be wikilinked.
-* '''jstor''': [[JSTOR]]; mainly for use as part of an <code>id</code> option in a {{tl|cite journal}} reference; must not be wikilinked.
-* '''lccn''': [[Library of Congress Control Number]]; must not be wikilinked.
-* '''mr''': [[Mathematical Reviews]]; must not be wikilinked.
-* '''oclc''': [[Online Computer Library Center]]; must not be wikilinked.
-* '''ol''': [[Open Library]]; must not be wikilinked.
-* '''osti''': [[Office of Scientific and Technical Information]]; must not be wikilinked.
-* '''PMC''': [[PubMed Central]] article number for full-text free repository of an article; must not be wikilinked.
-* '''PMID''': [[PubMed]] Unique Identifier; must not be wikilinked.
-* '''rfc''': [[Request for Comments]]; must not be wikilinked.
-* '''ssrn''': [[Social Science Research Network]]; must not be wikilinked.
-* '''zbl''': [[Zentralblatt MATH]]; must not be wikilinked.
-|url=
-{{Citation Style  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 link to any commercial booksellers (such as Amazon.com).
-** '''format''': Format of the work referred to by '''url''', e.g. PDF. HTML is implied and should not be 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.
-** '''archiveurl''': The URL of an [[Web archiving|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 {{para|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=
-* '''ref''': ID for anchor. By default, no anchor is generated. The ordinary nonempty value {{para|ref|<var>ID</var>}} generates an anchor with the given <var>ID</var>; such a linkable reference can be made the target of [[Wikipedia:Citing sources/Further considerations#Wikilinks to full references|wikilinks to full references]], especially useful in short citations like [[Wikipedia:Citing sources#Shortened footnotes|shortened notes]] and [[Wikipedia:Parenthetical referencing|parenthetical referencing]]. The special value {{para|ref|harv}} generates an anchor suitable for the {{tl|harv}} template; see [[Template:Citation/doc#Anchors for Harvard referencing templates|anchors for Harvard referencing templates]].
-|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 {{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 a list generated by {{tl|reflist}} or {{tag|references|s}} 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 percent encoded as <code>&amp#32;</code>; do not use a semicolon (;), 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 percent encoded as <code>&amp#32;</code>; do not use a semicolon (;), 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." (e.g., {{para|display-authors|2}}; alternatively, the "et al." may be suppressed by the use of {{para|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 {{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 {{para|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; do not use a semicolon (;), colon (:) or hash (#) as they will be interpreted as wikimarkup.
 }}<noinclude>
 {{documentation}}</noinclude>