Template:Cite map/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search
Citation Style 1 templates
{{Cite AV media}}audio and visual media
{{Cite book}}books and chapters
{{Cite CiteSeerX}}CiteSeerX papers
{{Cite conference}}conference papers
{{cite document}}short, stand-alone, offline documents
{{Cite encyclopedia}}edited collections
{{Cite episode}}radio or TV episodes
{{Cite interview}}interviews
{{Cite journal}}academic journals
{{Cite magazine}}magazines, periodicals
{{Cite mailing list}}public mailing lists
{{Cite map}}maps
{{Cite news}}news articles
{{Cite newsgroup}}online newsgroups
{{Cite press release}}press releases
{{Cite report}}reports
{{Cite sign}}signs, plaques
{{Cite speech}}speeches
{{Cite tech report}}technical reports
{{Cite thesis}}theses
{{Cite web}}web sources not covered by the above
See alsoSpecific-source templates
Citation Style 1 wrapper templates

This Citation Style 1 template is used to create citations for maps.

These specific-source templates use {{cite map}} as a meta-template:

Usage

Copy a blank version to use. Almost all parameter names are supported only in lower case (some initialisms, such as |isbn= have upper-case aliases like |ISBN=, which are acceptable for use). Use the "|" (pipe) character between each parameter. Unused parameters may be deleted to avoid clutter in the edit window. Some samples on this documentation page may include the current date. If the date is not current, then purge the page.

  • {{cite map |author = |title = |trans-title = |map = |map-url = |date = |year = |url = |scale = |series = |publisher = |cartography = |page = |pages = |section = |sections = |inset = |edition = |location = |language = |format = |isbn = |id = |ref = |access-date = |archive-url = |archive-date =}}
{{cite map
 |author      =
 |title       =
 |trans-title =
 |map         =
 |map-url     =
 |date        =
 |year        =
 |url         =
 |scale       =
 |series      =
 |version     =
 |cartography =
 |publisher   =
 |page        =
 |pages       =
 |section     =
 |sections    =
 |inset       =
 |edition     =
 |location    =
 |language    =
 |format      =
 |isbn        =
 |id          =
 |ref         =
 |access-date =
 |archive-url =
 |archive-date=
}}

Examples

Sheet maps

  • {{Cite map |first1 = Charles B. |last1 = Kitterman |author2 = Kulshan Cartographic Services |year = 2000 |title = Mt. Rainier National Park |edition = Centennial |scale = 1:30,000 |publisher = Stanley Maps |isbn = 0-9662209-4-3}}
    • Kitterman, Charles B.; Kulshan Cartographic Services (2000). Mt. Rainier National Park (Map) (Centennial ed.). 1:30,000. Stanley Maps. ISBN 0-9662209-4-3.
  • {{Cite map |author1 = Skelly Oil Company |author2 = Diversified Map Co. |year = 1966 |title = Highway Map of Oklahoma |scale = [1:1,500,000] |location = St. Louis |publisher = Diversified Map Co. |section = C11 |oclc = 67708775}}
    • Skelly Oil Company; Diversified Map Co. (1966). Highway Map of Oklahoma (Map). [1:1,500,000]. St. Louis: Diversified Map Co. § C11. OCLC 67708775.
    • Note: for a map scale given only in library catalog records, enclose it in brackets as shown.
  • {{Cite map |author = Kansas Department of Transportation |year = 2005 |title = Official State Transportation Map |url = http://www.ksdot.org/burtransplan/maps/state-pdf/kansas0708.pdf |format = PDF |edition = 2005-06 |scale = [c. 1:780,000] |location = Topeka |publisher = Kansas Department of Transportation |section = F9 |access-date = 2007-03-30 |archive-url = https://web.archive.org/web/20070216021356/http://www.ksdot.org/BurTransPlan/maps/state-pdf/kansas0708.pdf |archive-date = 2007-02-16 |oclc = 63793104}}
    • Kansas Department of Transportation (2005). Official State Transportation Map (PDF) (Map) (2005-06 ed.). [c. 1:780,000]. Topeka: Kansas Department of Transportation. § F9. OCLC 63793104. Archived from the original (PDF) on 2007-02-16. Retrieved 2007-03-30.
    • Note: approximate map scales are represented prefixed with a "c.", which stands for circa, the Latin word for "approximately".
  • {{Cite map |author1 = New Zealand Department of Conservation |author-link = New Zealand Department of Conservation |author2 = GeoSmart |year = 2003 |title = Kepler Track |edition = 3rd |scale = 1:50,000 |series = Parkmap |location = Wellington |publisher = New Zealand Department of Conservation |oclc = 489215989}}
  • {{cite map |author = United States Geological Survey |author-link = United States Geological Survey |year = 1975 |title = Gwinn, MI |url = http://ims.er.usgs.gov/gda_services/download?item_id=5439266&quad=Gwinn&state=MI&grid=7.5X7.5&series=Map%20GeoPDF |format = PDF |type = Topographic map |series = 7.5 Minute Series |scale = 1:24,000 |location = Reston, VA |publisher = United States Geological Survey |access-date = March 29, 2012}}
    • United States Geological Survey (1975). Gwinn, MI (PDF) (Topographic map). 1:24,000. 7.5 Minute Series. Reston, VA: United States Geological Survey. Retrieved March 29, 2012.
    • Note: the type of map can be manually indicated; in this case this is a topographic map. The format of the computer file can also be manually indicated.

Maps contained within larger works

  • {{Cite map |author = Rand McNally |year = 2013 |map = Michigan |title = The Road Atlas |edition = 2013 Walmart |scale = c. 1:1,874,880 |location = Chicago |publisher = Rand McNally |pages = 50–51 |inset = Western Upper Peninsula |sections = C10–C14 |isbn = 0-528-00626-6}}
    • Rand McNally (2013). "Michigan" (Map). The Road Atlas (2013 Walmart ed.). c. 1:1,900,00. Chicago: Rand McNally. pp. 50–51. Western Upper Peninsula inset. §§ C10–C14. ISBN 0-528-00626-6.
    • Note: the printed scale on the map, "1 inch represents approximately 30 miles", or "1 in≈30 mi", can be represented as "c. 1:1,900,800". The ratio is determined by computing the number of the smaller units within the stated quantity of larger units. In this example, 30 miles equals 1,900,800 inches (30 mi × 5,280 ft/mi × 12 in/ft = 1,900,800 in), so the map has an approximate scale of 1:1,900,800.
  • {{Cite map |author = Colorado State Highway Department |date = July 1923 |url = https://books.google.com/books?id=czs5AQAAMAAJ&pg=RA10-PA12 |title = New Map Showing the 8,880 Miles Which Comprise Colorado's Primary Highway System |journal = Colorado Highways |scale = Scale not given |volume = 2 |issue = 7 |pages = 12–13 |oclc = 11880590 |access-date = November 18, 2013 |via = [[w:Google Books|Google Books]]}}
  • {{Cite map |author=((OpenStreetMap contributors)) |date=26 November 2011 |title=E.T. Seton Park |url=http://www.openstreetmap.org/?lat=43.70891&lon=-79.34334&zoom=15&layers=M&way=25480325 |website=[[w:OpenStreetMap|OpenStreetMap]] |access-date=26 November 2011}}
    • OpenStreetMap contributors (26 November 2011). "E.T. Seton Park" (Map). OpenStreetMap. Retrieved 26 November 2011.
    • Note: For dynamic maps without a fixed scale, omit any mention of a map scale. Dynamically generated online maps should also use the access date as the publication date.

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 |date=27 September 2007 (print version 25 September)

Use of templates within the citation template is discouraged because many of these templates will add extraneous HTML or CSS that will be included raw in the metadata. Also, HTML entities, for example  , –, etc., should not be used in parameters that contribute to the metadata.

COinS metadata is created for these parameters

Note: This table of metadata is displayed in the documentation of all Citation Style 1 templates. Not all of these parameters are supported by every CS1 template. Some of these parameters are mutually exclusive, some are aliases of another parameter, and some require other parameters to be present. A full list of this template's supported parameters, their aliases, and their dependencies is shown in the Usage section near the top of this documentation page.

  • |periodical=, |journal=, |newspaper=, |magazine=, |work=, |website=, |encyclopedia=, |encyclopaedia=, |dictionary=
  • |chapter=, |script-chapter=, |contribution=, |script-contribution=, |entry=, |script-entry=, |article=, |script-article=, |section=, |script-section=
  • |title=, |script-title=, |book-title=
  • |publication-place=, |place=, |location=
  • |date=, |year=, |publication-date=
  • |series=, |version=
  • |volume=, |issue=, |number=
  • |page=, |pages=, |at=, |quote-page=, |quote-pages=
  • |edition=
  • |publisher=, |institution=
  • |url=, |chapter-url=, |contribution-url=, |section-url=
  • |author-last=, |author-last#=, |author#-last=, |author-surname=, |author-surname#=, |author#-surname=, |last=, |last#=, |surname=, |surname#=, |author=, |author#=, |subject=, |subject#=, |host=, |host#=
  • |author-first=, |author-first#=, |author#-first=, |author-given=, |author-given#=, |author#-given=, |first=, |first#=, |given=, |given#=
  • |degree=
  • |arxiv=, |bibcode=, |biorxiv=, |citeseerx=, |doi=, |eissn=, |eprint=, |hdl=, |isbn=, |issn=, |jfm=, |jstor=, |lccn=, |message-id=, |mr=, |oclc=, |osti=, |pmc=, |pmid=, |rfc=, |ssrn=, |s2cid=, |zbl=

Deprecated

{{#lst:Help:CS1 errors|deprecated_params_table}} {{#lst:Help:CS1 errors|deleted_params_table}}

Description

Authors

  • 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.
  • others: To record other contributors to the work, including illustrators. For the parameter value, write Illustrated by John Smith.
  • Note: When using shortened footnotes or parenthetical referencing styles with templates, do not use multiple names in one field, or else the anchor will not match the inline link.

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.
  • map: The title of the map, if published in an atlas, book, or journal. May be wikilinked or may use map-url, but not both. Displays in quotes.
  • type: Provides additional information about the media type of the source. May alternatively be used to identify the type of manuscript linked to in the title, if this is not the final version of a manuscript (e.g. if a preprint of a manuscript is freely available, but the version of record is behind a paywall). Format in sentence case. Displays in parentheses following the title. The reserved keyword none can be used to disable the display of a type. Defaults to Map. Alias: medium.
  • 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=Russian; |language=French, Portuguese. 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 Category:CS1 foreign language sources. 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

Date

"Wikipedia:Undated" redirects here. For undated signatures, see Template:Undated.
  • 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.[date 1] 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 website and 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", use |date=n.d.
The date of a Web page, PDF, etc. with no visible date can sometimes be established by searching the page source or document code for a created or updated date; a comment for editors such as date=2021-12-25<!--date from page source-->|orig-date=Original date 2011-01-01 can be added.
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
  1. ^ Publication dates in references within an article should all have the same format. This may be a different format from that used for archive and access dates. See MOS:DATEUNIFY.

Publisher

  • publisher: Name of publisher; may be wikilinked if relevant. The publisher is the company, organization or other legal entity that publishes the work being cited. Do not use the publisher parameter for the name of a work (e.g. a website, book, encyclopedia, newspaper, magazine, journal, etc.). If the name of the publisher changed over time, use the name as stated in the publication or used at the time of the source's publication. Corporate designations such as "Ltd", "Inc.", or "GmbH" are not usually included. Not normally used for periodicals. 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.
  • place: For news stories with a dateline, the location where the story was written. If the name of the location changed over time, use the name as stated in the publication or used at the time of the source's publication. In earlier versions of the template this was the publication place, and for compatibility, will be treated as the publication place if the publication-place parameter is absent; see that parameter for further information. Alias: location
  • publication-place: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the publication place, for example, The Boston Globe, The Times of India. Displays after the title. If the name of the publication place changed over time, use the name as stated in the publication or used at the time of the source's publication. If only one of publication-place, place, or location is defined, it will be treated as the publication place and will show after the title; if publication-place and place or location are defined, then place or location is 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. If date (or year) is also defined and is different, then publication-date displays preceded by "published" and enclosed in parentheses, following publisher. If date (or year) is not defined, publication-date is displayed as date. Use the same format as other dates in the article; do not wikilink.
  • via: Name of the content deliverer (if different from publisher). via is not a replacement for publisher, but provides additional detail. It may be used when the content deliverer (e.g. NewsBank) presents the source in a format different from the original, when the URL provided does not make clear the identity of the deliverer, where no URL or DOI is available (EBSCO), or if the deliverer requests attribution. See the access level parameters to display access restrictions.

Edition, series

  • 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.
  • scale: Scale of map.
  • series: Title of map series.
  • cartography: Person or entity that did the cartography, if this needs to be differentiated from general authorship of the map. Displays preceded by "Cartography by".

In-source locations

  • 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.
  • inset: The name of the focused inset referenced; example: Downtown Fooburg. Output appends "inset" after the input, |inset=Downtown Fooburg becomes "Downtown Fooburg inset."; overridden by at.
  • section: The map section(s) of the feature referenced; example: A6, B9, L11, etc; overridden by at.
  • at: For sources where a single set of the above parameters is inappropriate or insufficient to describe the in-source location(s).
Examples: page (p.) or pages (pp.); inset(s); section (§) or sections (§§); other custom location on the map or in the atlas.

URL

  • url: URL of an online location where the text of the publication named by title can be found. Cannot be used if title is wikilinked. If applicable, the link may point to the specific page(s) referenced. Remove tracking parameters from URLs, e.g. #ixzz2rBr3aO94 or ?utm_source=google&utm_medium=...&utm_term=...&utm_campaign=.... For linking to pages in PDF files or in Google Books, see WP:PAGELINKS. Do not link to any commercial booksellers, such as Amazon; use |isbn= or |oclc= to provide neutral search links for books. Invalid URLs, including those containing spaces, will result in an error message.
    • access-date: Full date when the content pointed to by url was last verified to support the text in the article; do not wikilink; requires url; use the same format as other access and archive dates in the citations.[date 1] Not required for linked documents that do not change. For example, access-date is required for online sources, such as personal websites, that do not have a publication date; see WP:CITEWEB. Access dates are not required for links to published research papers or published books. Note that access-date is the date that the URL was found to be working and to support the text being cited. See "Automatic date formatting" above for details about interaction with {{use dmy dates}} and {{use mdy dates}}. Can be hidden or styled by registered editors. Alias: accessdate.
    • archive-url: The URL of an archived snapshot of a web page. Typically used to refer to services such as Internet Archive (see Wikipedia:Using the Wayback Machine) and archive.today (see Help:Using archive.today); requires archive-date and url. By default (overridden by |url-status=live) the archived link is displayed first, with the original link at the end. Alias: archiveurl.
      • archive-date: Archive-service snapshot-date; preceded in display by default text "archived from the original on". Use the same format as other access and archive dates in the citations. This does not necessarily have to be the same format that was used for citing publication dates.[date 1] Do not wikilink; templated dates are discouraged. See "Automatic date formatting" above for details about interaction with {{use dmy dates}} and {{use mdy dates}}. Alias: archivedate.
      • url-status: the |url-status= parameter should only be included if an |archive-url= is set (dead links without an archive URL can be marked with {{dead link}}). If |url-status= is omitted, or is specified with a null value, the default value is |url-status=dead. When the URL is still live, but pre-emptively archived, then set |url-status=live; this changes the display order, with the title retaining the original link and the archive linked at the end.
        If the original URL is 'live' but no longer supports the article text, set |url-status=deviated. When the original URL has been usurped for the purposes of spam, advertising, or is otherwise unsuitable, setting |url-status=unfit or |url-status=usurped suppresses display of the original URL (but |url= and |archive-url= are still required).
      • archive-format: File format of the work referred to by archive-url; for example: PDF, DOC, or XLS; displayed in parentheses after the archive link. HTML is implied and should not be specified. File format annotation is automatically rendered when a PDF icon is displayed. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add file format information for the visually impaired. See Using |format=
    • url-access: See Access indicators for url-holding parameters
  • format: File format of the work referred to by url; for example: PDF, DOC, or XLS; displayed in parentheses after title. (For media format, use type.) HTML is implied and should not be specified. File format annotation is automatically rendered when a PDF icon is displayed. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add file format information for the visually impaired. See Using |format=

URLs must begin with a supported URI scheme. http:// and https:// will be supported by all browsers; however, ftp://, gopher://, irc://, ircs://, mailto: and news: may require a plug-in 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, then they will not display and link correctly. Those characters need to be percent-encoded. For example, a space must be replaced by %20. To encode the URL, replace the following characters with:

Character space " ' < > [ ] { | }
Encoding %20 %22 %27 %3C %3E %5B %5D %7B %7C %7D

Single apostrophes do not need to be encoded; however, unencoded multiples will be parsed as italic or bold markup. Single curly closing braces also do not need to be encoded; however, an unencoded pair will be parsed as the double closing braces for the template transclusion.

  1. ^ a b Access-date and archive-date in references should all have the same format – either the format used for publication dates, or YYYY-MM-DD. See MOS:DATEUNIFY.

Anchor

  • ref: the citation's HTML anchor identifier, when different from its default. When set, |ref=ID generates an anchor with the given ID (the id= attribute in the citation's <cite id="ID"> HTML tag). Setting |ref=ID identifies the template as a target and allows wikilinking to full references, especially useful with short-form citations like shortened notes and parenthetical referencing. The default anchor ID is suitable for use with {{sfn}} and {{harv}} templates. Since April 2020, the parameter / keyword pair |ref=harv has no special meaning; this deprecated setting should not be used and may be removed from existing cs1|2 templates. To inhibit anchor ID creation, set |ref=none. Aliases: none. See Template:Citation/doc § Anchors for Harvard referencing templates.

Identifiers

The following 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. In general, the parameters should include only the variable part of the identifier, e.g. |rfc=822 or |pmc=345678.

  • arxiv: arXiv identifier; for example: |arxiv=hep-th/9205027 (before April 2007) or |arxiv=0706.0001 (April 2007 – December 2014) or |arxiv=1501.00001 (since January 2015). Do not include extraneous file extensions like ".pdf" or ".html". Aliases: eprint.
  • asin: Amazon Standard Identification Number; if first character of asin value is a digit, use isbn. Because this link favours one specific distributor, include it only if standard identifiers are not available. Example |asin=B00005N5PF. Aliases: ASIN.
    • asin-tld: ASIN top-level domain for Amazon sites other than the US; valid values: {{#lst:Help:CS1 errors|asin-tld_values_list}}. Aliases: none.
  • bibcode: bibcode; used by a number of astronomical data systems; for example: 1974AJ.....79..819H. Aliases: none.
  • biorxiv: bioRxiv id, as in the entire DOI (e.g. 10.1101/078733 for http://biorxiv.org/content/early/2016/10/01/078733 or https://doi.org/10.1101/078733; 10.1101/2020.07.24.220400 for https://doi.org/10.1101/2020.07.24.220400). Aliases: none.
  • citeseerx: CiteSeerX id, a string of digits and dots found in a CiteSeerX URL (e.g. 10.1.1.176.341 for http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.176.341). Aliases: none.
  • doi: Digital object identifier; for example: 10.1038/news070508-7. It is checked to ensure it begins with (10.). Aliases: DOI.
    • Supports accept-this-as-written markup to indicate valid DOIs using a non-standard format, see below.
    • doi-broken-date: Date a valid DOI was found to be non-working/inactive at https://doi.org. Use the same format as other dates in the article. Aliases: none.
  • eissn: International Standard Serial Number for the electronic media of a serial publication; eight characters may be split into two groups of four using a hyphen, but not an en dash or a space; example |eissn=1557-2986. Aliases: EISSN.
    • Supports accept-this-as-written markup to indicate valid eISSNs using a non-standard format, see below.
  • hdl: Handle System identifier for digital objects and other resources on the Internet; example |hdl=20.1000/100. Aliases: HDL.
  • isbn: International Standard Book Number; for example: 978-0-8126-9593-9. (See Wikipedia:ISBN and ISBN § Overview.) Hyphens in the ISBN are optional, but preferred. Use the ISBN actually printed on or in the book. Use the 13-digit ISBN – beginning with 978 or 979 – when it is available. If only a 10-digit ISBN is printed on or in the book, use it. ISBNs can be found on the page with the publisher's information – usually the back of the title page – or 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, use sbn. Do not convert a 10-digit ISBN to 13-digit by just adding the 978 prefix; the last digit is a calculated check digit and just making changes to the numbers will make the ISBN invalid. This parameter should hold only the ISBN without any additional characters. It is checked for length, invalid characters – anything other than numbers, spaces, and hyphens, with "X" permitted as the last character in a 10-digit ISBN – and the proper check digit. Aliases: ISBN.
    • Use the {{Format ISBN}} template within the parameter – in the form |isbn={{Format ISBN|9780812695939}} – if you are unsure of how any particular ISBN should be hyphenated, as the pattern varies by country and publisher.
    • Supports accept-this-as-written markup to indicate valid ISBNs using a non-standard format, see below.
  • ismn: International Standard Music Number; for example: 979-0-9016791-7-7. Hyphens or spaces in the ISMN are optional. Use the ISMN actually printed on or in the work. This parameter should hold only the ISMN without any additional characters. It is checked for length, invalid characters – anything other than numbers, spaces, and hyphens – and the proper check digit. Aliases: ISMN.
  • 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; example |issn=2049-3630. Aliases: ISSN.
    • Supports accept-this-as-written markup to indicate valid ISSNs using a non-standard format, see below.
  • jfm: Jahrbuch über die Fortschritte der Mathematik; do not include "JFM" in the value; example |jfm=53.0144.01. Aliases: JFM.
  • jstor: JSTOR reference number; for example: |jstor=3793107. Aliases: JSTOR.
  • lccn: Library of Congress Control Number. When present, alphabetic prefix characters are to be lower case and without a space; example |lccn=79-57364 or |lccn=2004042477 or |lccn=e09001178. Aliases: LCCN.
  • mr: Mathematical Reviews; example |mr=630583. Aliases: MR.
  • oclc: OCLC Number for looking up publications in the WorldCat union catalog; example |oclc=9355469. Aliases: OCLC.
  • ol: Open Library identifier; do not include "OL" in the value; example |ol=7030731M. Aliases: OL.
  • osti: Office of Scientific and Technical Information; example |osti=4367507. Aliases: OSTI.
  • pmc: PubMed Central; use article number for open repository full-text of a journal article, e.g. |pmc=345678. Do not include "PMC" in the value. See also the pmid parameter, below; these are two different identifiers. Aliases: PMC.
    • pmc-embargo-date: Date that pmc goes live; if this date is in the future, then pmc is not linked until that date. Aliases: none.
  • pmid: PubMed; use unique identifier; example |pmid=17322060 See also the pmc parameter, above; these are two different identifiers. Aliases: PMID.
  • rfc: Request for Comments; example |rfc=3143. Aliases: RFC.
  • sbn: Standard Book Number; example |sbn=356-02201-3. Aliases: SBN.
    • Supports accept-this-as-written markup to indicate valid SBNs using a non-standard format, see below.
  • ssrn: Social Science Research Network; example |ssrn=1900856. Aliases: SSRN.
  • s2cid: Semantic Scholar corpus ID; example |s2cid=37220927. Aliases: S2CID.
  • zbl: Zentralblatt MATH; example |zbl=0472.53010 For zbMATH search results like JFM 35.0387.02 use |jfm=35.0387.02. Aliases: ZBL.

In very rare cases, valid identifiers (f.e., as actually printed on publications) do not follow their defined standard format or use non-conforming checksums, which would typically cause an error message to be shown. Do not alter them to match a different checksum. In order to suppress the error message, some identifiers (|doi=, |eissn=, |isbn=, |issn=, and |sbn=) support a special accept-this-as-written markup which can be applied to disable the error-checking (as |<param>=((<value>))). If the problem is down to a mere typographical error in a third-party source, correct the identifier value instead of overriding the error message.

For some identifiers, it is possible to specify the access status using the corresponding |<param>-access= parameter.

For {{cite journal}}, some identifiers (specifying free resources) will automatically be linked to the title when |url= and |title-link= are not used to specify a different link target. This behaviour can be overridden by one out of a number of special keywords for |title-link= to manually select a specific source (|title-link=pmc or |title-link=doi) for auto-linking or to disable the feature (|title-link=none).

It is not necessary to specify a URL to a link identical to a link also produced by an identifier. The |url= parameter (or |title-link=) can then be used for providing a direct deep link to the corresponding document or a convenience link to a resource that would not otherwise be obviously accessible.

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.

Lay summary

These parameters are deprecated. If the source that they name is important to the Wikipedia article, create a separate cs1|2 template for that source.

  • lay-url: (deprecated) URL link to a non-technical summary or review of the source; the URL title is set to "Lay summary".
    • lay-source: (deprecated) Name of the source of the lay summary. Displays in italics and preceded by a spaced endash.
    • lay-date: (deprecated) Date of the lay summary. Displays in parentheses.
    • lay-format: (deprecated) File format of the work referred to by lay-url; for example: PDF, DOC, or XLS; displayed in parentheses after lay summary. HTML is implied and should not be specified. File format annotation is automatically rendered when a PDF icon is displayed. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add file format information for the visually impaired. See Using |format=

Display options

  • mode: Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For |mode=cs1, element separator and terminal punctuation is a period (.); where appropriate, initial letters of certain words are capitalized ('Retrieved...'). For |mode=cs2, element separator is a comma (,); terminal punctuation is omitted; where appropriate, initial letters of certain words are not capitalized ('retrieved...'). These styles correspond to Citation Style 1 and Citation Style 2 respectively. To override default terminal punctuation use postscript.
  • author-mask:
  • contributor-mask:
  • editor-mask:
  • interviewer-mask:
  • subject-mask:
  • translator-mask:
    Replaces the name of the (first) author with em dashes or text. Set <name>-mask to a numeric value n to set the dash n em spaces wide; set <name>-mask to a text value to display the text without a trailing author separator; for example, "with". The numeric value 0 is a special case to be used in conjunction with <name>-link—in this case, the value of <name>-link will be used as (linked) text. In either case, you must still include the values for all names for metadata purposes. Primarily intended for use with bibliographies or bibliography styles where multiple works by a single author are listed sequentially such as shortened footnotes. Do not use in a list generated by {{reflist}}, <references /> or similar as there is no control of the order in which references are displayed. Mask parameters can take an enumerator in the name of the parameter (e.g. |authorn-mask=) to apply the mask to a specific name.
  • display-authors:
  • display-contributors:
  • display-editors:
  • display-interviewers:
  • display-subjects:
  • display-translators:
    Controls the number of author or editor names that are displayed when a citation is published. To change the displayed number of names, set display-authors and/or display-editors to the desired number. For example, |display-authors=2 will display only the first two authors in a citation (and not affect the display of editors). Likewise, |display-editors=2 will display only the first two editors (and all authors). |display-authors=0 and |display-editors=0 are special cases suppressing the display of all authors or editors including the et al. By default, all authors and editors are displayed. |display-authors=etal displays all authors in the list followed by et al. Aliases: none.
  • postscript: Controls the closing punctuation for a citation; defaults to a period (.); for no terminating punctuation, specify |postscript=none – leaving |postscript= empty is the same as omitting it, but is ambiguous. Additional text, or templates that render more than a single terminating punctuation character, will generate a maintenance message. |postscript= is ignored if quote is defined.

See also

This template produces COinS metadata; see COinS in Wikipedia for background information.


Retrieved from "https://wiki.aaroads.com/w/index.php?title=Template:Cite_map/doc&oldid=194767"