Wikipedia

Template:Cite Q/doc

< Template:Cite Q
This template uses one or more Wikidata properties; see § Parameter / entity map for details.

Background

change

You can read about the template in:

Mike Peel; Andy Mabbett (14 January 2021). "Automatically maintained citations with Wikidata and Cite Q". Diff. Wikidata Q104831003.

Usage

change

A wrapper for {{Citation}}, which calls available values from Wikidata.

An example of an article using this template for all of its references is South Pole Telescope; an example using Harvard style citations is Suffix automaton.

By default, if there are more than eight author names, the template displays three, followed by "et al". This can be changed using |display-authors=; using that parameter with no value displays them all. The same applies to multiple editors - see the test-case pages.

Citations of papers which have been retracted (retracted by (P5824)) will appear in Category:Cite Q - cites a retracted work.

Citations of papers which have been replaced (replaced by (P1366)) will appear in Category:Cite Q - cites a replaced work.

You can also use {{Cite Q bulleted}} if you want to have a bullet returned before the citation (useful for automatic lists).

Parameters

change
  • |1= = Wikidata QID for the article

Additionally, any named parameter used in {{citation}} may be entered and will overwrite the value in Wikidata. Using such parameters, with a value of unset, will suppress display of data from Wikidata.

Blank

change
<ref name="">{{Cite Q| XXQIDXX }}</ref>

Reference naming

change

For ease of use, you may wish to name your references to reflect the cited work, for example:

<ref name="Williams-2010">{{Cite Q|Q15625490}}</ref>

Parameter / entity map

change

This section lists where each of the template's supported parameters gets its data.

Bibliographic parameters

change

Identifier parameters

change

Examples

change
{{Cite Q|Q15625490}}
Jeffrey T. Williams; Kent E. Carpenter; James L. Van Tassell; Paul Hoetjes; Wes Toller; Peter Etnoyer; Michael Smith (21 May 2010). "Biodiversity Assessment of the Fishes of Saba Bank Atoll, Netherlands Antilles". PLOS One. 5 (5). Bibcode:2010PLoSO...510676W. doi:10.1371/JOURNAL.PONE.0010676. ISSN 1932-6203. PMC 2873961. PMID 20505760. Wikidata Q15625490.{{cite journal}}: CS1 maint: unflagged free DOI (link)
{{Cite Q|Q15625490|page=42}}
Jeffrey T. Williams; Kent E. Carpenter; James L. Van Tassell; Paul Hoetjes; Wes Toller; Peter Etnoyer; Michael Smith (21 May 2010). "Biodiversity Assessment of the Fishes of Saba Bank Atoll, Netherlands Antilles". PLOS One. 5 (5): 42. Bibcode:2010PLoSO...510676W. doi:10.1371/JOURNAL.PONE.0010676. ISSN 1932-6203. PMC 2873961. PMID 20505760. Wikidata Q15625490.{{cite journal}}: CS1 maint: unflagged free DOI (link)
{{Cite Q|Q15625490|access-date=18 May 2017}}
Jeffrey T. Williams; Kent E. Carpenter; James L. Van Tassell; Paul Hoetjes; Wes Toller; Peter Etnoyer; Michael Smith (21 May 2010). "Biodiversity Assessment of the Fishes of Saba Bank Atoll, Netherlands Antilles". PLOS One. 5 (5). Bibcode:2010PLoSO...510676W. doi:10.1371/JOURNAL.PONE.0010676. ISSN 1932-6203. PMC 2873961. PMID 20505760. Wikidata Q15625490. Retrieved 18 May 2017.{{cite journal}}: CS1 maint: unflagged free DOI (link)
{{Cite Q|Q15625490|quote=lorem ipsum}}
Jeffrey T. Williams; Kent E. Carpenter; James L. Van Tassell; Paul Hoetjes; Wes Toller; Peter Etnoyer; Michael Smith (21 May 2010). "Biodiversity Assessment of the Fishes of Saba Bank Atoll, Netherlands Antilles". PLOS One. 5 (5). Bibcode:2010PLoSO...510676W. doi:10.1371/JOURNAL.PONE.0010676. ISSN 1932-6203. PMC 2873961. PMID 20505760. Wikidata Q15625490. lorem ipsum{{cite journal}}: CS1 maint: unflagged free DOI (link)
{{Cite Q|Q25766745}}
Andy Mabbett (2010), Chris Charlesworth (ed.), Pink Floyd: The Music and the Mystery, Omnibus Press, OCLC 762731304, OL 16228023W, Wikidata Q25766745
{{Cite Q|Q25766745 |chapter=The Final Cut}} (with chapter specified)
Andy Mabbett (2010), "The Final Cut", in Chris Charlesworth (ed.), Pink Floyd: The Music and the Mystery, Omnibus Press, OCLC 762731304, OL 16228023W, Wikidata Q25766745
{{Cite Q|Q25766745 |pages=48-52}} (with pages)
Andy Mabbett (2010), Chris Charlesworth (ed.), Pink Floyd: The Music and the Mystery, Omnibus Press, pp. 48–52, OCLC 762731304, OL 16228023W, Wikidata Q25766745
{{Cite Q|Q15625490|access-date=18 May 2017}}
Jeffrey T. Williams; Kent E. Carpenter; James L. Van Tassell; Paul Hoetjes; Wes Toller; Peter Etnoyer; Michael Smith (21 May 2010). "Biodiversity Assessment of the Fishes of Saba Bank Atoll, Netherlands Antilles". PLOS One. 5 (5). Bibcode:2010PLoSO...510676W. doi:10.1371/JOURNAL.PONE.0010676. ISSN 1932-6203. PMC 2873961. PMID 20505760. Wikidata Q15625490. Retrieved 18 May 2017.{{cite journal}}: CS1 maint: unflagged free DOI (link)
{{Cite Q|Q25766745|mode=cs1}}
Andy Mabbett (2010). Chris Charlesworth (ed.). Pink Floyd: The Music and the Mystery. Omnibus Press. OCLC 762731304. OL 16228023W. Wikidata Q25766745.
{{Cite Q|Q25766745|mode=cs2}}
Andy Mabbett (2010), Chris Charlesworth (ed.), Pink Floyd: The Music and the Mystery, Omnibus Press, OCLC 762731304, OL 16228023W, Wikidata Q25766745
{{Cite Q|Q25766745|author-mask=1}}
— (2010), Chris Charlesworth (ed.), Pink Floyd: The Music and the Mystery, Omnibus Press, OCLC 762731304, OL 16228023W, Wikidata Q25766745

For additional examples, see testcases and testcases/many names.

Workflow

change

The template used with a single parameter, the Q-number of the article on Wikidata, will produce a citation using the default display parameters from Template:Citation and the styling of the author and editor names as they are stored on Wikidata. This is rarely the same as required by the citation formatting in any given article. The guidance at WP:CITEVAR requires that editors match the formatting of citations that they add to that of the article where it is added. At present, {{Cite Q}} does not know what style the formatting in an article requires (although it is possible that common styles could be marked or recognised automatically as is done for date formatting).

The result is that editors using {{Cite Q}} must take care to preview their edits and ensure that the formatting rendered matches that of the rest of the article. The commonest formatting issues are:

  1. Order of editor names:
    A typical output might be:
    If that were used in an article that used "Last, First" format for author names, then the editor would have to supply those author names manually in the desired format. It's often worth previewing the citation in expanded form to show what is being passed to the actual citation template:
    • {{Cite Q |Q15625490 |expand=yes}} →
    • {{Cite journal |author1=Jeffrey T. Williams |author2=Kent E. Carpenter |author3=James L. Van Tassell |author4=Paul Hoetjes |author5=Wes Toller |author6=Peter Etnoyer |author7=Michael Smith |bibcode=2010PLoSO...510676W |doi=10.1371/JOURNAL.PONE.0010676 |id=Wikidata Q15625490 |issn=1932-6203 |issue=5 |journal=PLOS One |language=en |pmc=2873961 |pmid=20505760 |publication-date=21 May 2010 |title=Biodiversity Assessment of the Fishes of Saba Bank Atoll, Netherlands Antilles |url=http://europepmc.org/abstract/MED/20505760 |volume=5}}
    That would make the author names (and author-links) easily available for copy and paste, followed by tweaking into the desired format:
  2. Punctuation:
    The separators between elements in the above citation is a comma, which is the default for a CS2-style format produced by {{Citation}}. Careful examination in a particular article will often show the separator punctuation to be a full stop (period). That may be selected by setting |mode=cs1:
  3. Italicisation in titles:
    Titles drawn from Wikidata cannot contain formatting, so editors using {{Cite Q}} may have to add appropriate formatting.
    {{Citation}} will automatically apply italicisation to titles of books, etc. so that does not need to be added:
    However, some titles require partial italicisation, and that has to be done manually when the whole title is not italicised, although that is rare. Titles of chapters may also need to be checked:

Module:Wd

change

Module:Wd can automatically cause this template to be invoked, e.g.,

{{Wikidata|references|raw|Q2978|P2046}}
Error: Unable to display the reference properly. See the documentation for details. "Alle politisch selbständigen Gemeinden mit ausgewählten Merkmalen am 31.12.2018 (4. Quartal)". Federal Statistical Office. Archived from the original on 10 March 2019. Retrieved 10 March 2019.

currently causes the following to be invoked:

{{Cite Q|Q15707237|pages=242}}
Bavarian State Office for Statistics and Data, ed. (1991), Amtliches Ortsverzeichnis für Bayern (in German), Munich: Bavarian State Office for Statistics and Data, p. 242, Wikidata Q15707237

because an area (P2046) statement on Regensburg (Q2978) is referenced to be stated in (P248) Amtliches Ortsverzeichnis für Bayern (1991) (Q15707237) with page(s) (P304) = 242.

See d:Q2978#P2046

Issues

change

Future developments

change
  • Once robust the functionality should be merged into {{Citation}}
  • Eventually, each signed-in reader should be able to set, under their "Preferences", the style in which they wish to see citations rendered. No more CiteVar wars!
  • We should have a global template repository, so the code can be used by multiple wikis, without having to manually copy it after every update.

To do list

change
  • Properties
    • More properties/ parameters to add
    • Parameters with no equivalent property?
  • Internationalisation
  • Check/resolve handling of redirected QID
  • Order of precedence for rendering author names:
    1. object named as (P1932) qualifier on author (P50)
    2. subject named as (P1810) qualifier on author (P50)
    3. author name string (P2093)
    4. author (P50) label in English
    5. author (P50) label in any other language
  • Add tracking categories for each parameter where the local value differs from the corresponding WD value so that either the WD entry can be updated/corrected or the local override can be corrected/removed
    • Other tracking categories?
  • Links to sister projects: Wikisource, if a transcription project exists; Wikibooks; Wikiversity (esp. the Wikijournals there); perhaps more
  • Consider case where author is given as et al. (Q311624)
    • If last author/editor is named "et al." (and variants), mute this entry and set display-authors/editors=etal instead before passing down to {citation}
  • Link to Wikisource should take priority over all URL properties, but only if accompanied by document file on Wikimedia Commons (P996). If not, document file on Wikimedia Commons (P996) should take precedence over URLs.
  • Where there is a Wikipedia article about the work cited, link the title to that, overriding the URL if necessary (example: d:Q25766745)
    • Ditto for editions of works
  • At present a WD pages entry of "1" will result in |pages=1–1 (and metadata &rft.pages=1-1) rather than |page=1 (and metadata &rft.pages=1).
  • Implement evaluation of generic keyword for all parameters to denote that a WD value should be accepted by framing its value in accept-this-as-written markup ((..)). See talk thread for possible keyword names.
  • Check all parameter aliases when scanning for override parameters (at present some alias parameter names are ignored, possibly leading to inconsistent behaviour if they are set as well).
  • Consider including a link to Special:EntityUsage, in the form, say, Other cites or with a small icon.
  • Take possible template parameter usage as hint which parameter to use in the generated output. F.e. if the journal/magazine/newspaper parameter is used, the template should use the same in the output. The underlying template {citation} will switch the output format accordingly.
  • Try to utilize given parameter values as filter for retrieved WD data. If an editor specifies |edition=2 or |volume=3, cite Q should select correlating data (f.e. page ranges, identifiers etc.) while retrieving data from WD (in cases where more than one entry is available for a particular parameter)
  • When the author is cited as various authors (Q2818964), the label should start with an upper case letter
    • Quick and dirty workaround: {{ucfirst:{{Cite Q|xxxx}}
  • Convert WikiData's edition number (e.g., 1) into the ordinal (1st) expected by {{citation}}.
  • Make this fix unnecessary.
  • Add indication alongside citations of retracted/ replaced works
  • Consider cases where citing a retracted/ replaced work is deliberate
  • Make use of |archive-url=, |archive-date=, and consider how to use |url-status=
  • Use title in HTML (P6833), where present.
  • Improve rendering when both author (P50) and author name string (P2093) are present.

Deferred

change

Feel free to tackle these; the core team working on Cite Q sees them as low priority, or too complex.

  • Resolve special case of newspaper articles
    • Is the following topic of "hint parameters" related to this?
  • Author names (Western-style, at least) should display as "Last, First Middle" to match Wikipedia house style
    • How to deal with Tussenvoegsels etc.
      • In Romance languages, it should be, e.g., "Quental, Antero de" instead of "de Quental, Antero"
  • Handle volume in a serial
    • Clarification needed: What is meant by this? |part=, or output format differences journal vs. magazine?
  • Is there a Pxxxx code for book series editors to add them to the list of "normal" editors?
    • resolve at Wikidata first

Done

change
  • Multiple author names treated as one blob
  • Linking author name(s)
  • Title for a book uses {{ #invoke:WikidataIB |getLink |{{{1}}} }} and may be expensive
  • Fix |ol= values
  • Need to add manual date for newspaper articles/ website articles.
  • Make publisher a link, where appropriate
  • Improve handing of unexpected multiple values
    • e.g. Handle multiple DOIs
  • Author name string (author name string (P2093)) values (e.g. on Q38000000)
  • Pseudonymous author personas such as P. D. Q. Bach or Mark Twain
  • Title not in English
  • Handle volume, issue and page(s) as qualifiers of published in (P1433)
  • Wider variety of examples/ test cases
  • If language of work or name is set (and not the local language); pass that; if not but language of title is set (and not the local language), use that
  • The url parameter should also pick up data from the properties full work available at URL (P953) and URL (P2699)
  • Linking title to Wikipedia article, if any
  • Fetch ISSN etc. from item about journal
  • Move Wikidata link before |quote= (and after other IDs like |pmid=)
    • Also fixes postscript character issues in conjunction with |mode=cs1 and with |quote=
  • Fix page evaluation code to accept comma- and semicolon-separated lists
  • Use canonical parameter names when calling down to {citation} (f.e. |page= rather than |p=)
  • Is there a Pxxxx code for SBNs (Standard Book Number to support |sbn= parameter?
    • Apparently not -> Add SBN property to WD. (Also add SICI and BICI properties corresponding with COinS &rft.sici and &rft.bici.)
  • Is there a Pxxxx code for JFM (Jahrbuch über die Fortschritte der Mathematik) to support |jfm= parameter?
  • Are there values of |others which are not illustrators? Possibly:
  • Add a tracking category for references with a replaced by (P1366) statement
  • Add a tracking category for references with a retracted by (P5824) statement
  • Render subtitle (P1680), following the title with a :

Won't fix

change

Template data

change

Generate citations from Wikidata by passing the QID to this template

Template parameters

ParameterDescriptionTypeStatus
QID1

The Wikidata QID of the cited source

Stringrequired


Retrieved from "https://simple.wikipedia.org/w/index.php?title=Template:Cite_Q/doc&oldid=7969974"