View source for Template:Cite Q/doc

{{Documentation subpage}}
{{high use}}
{{warning|From the [[Wikipedia:Templates for discussion/Log/2017 September 15#Template:Cite Q|TfD closure]]: "Until the matter of transcluding Wikidata on Wikipedia is resolved (most likely with a huge and contentious RFC) usage of this template should be extremely vetted to ensure that all of the transcluded information is accurate."}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Lua|Module:Cite Q}}
{{Uses Wikidata|section=Parameter / entity map}}

== Purpose ==
This template returns a formatted citation from statements stored on a [[Wikidata]] item (referred to by its ''Q identifier'' or ''QID'') describing a citable source such as a scholarly article.

For example, Wikidata item {{Q|Q15625490}} is a scholarly item. To cite this as a source:
:<code><nowiki>{{Cite Q|Q15625490}}</nowiki></code> →
::{{Cite Q|Q15625490}}

You can read about the template in:
:{{cite Q|Q104831003}}

'''Note:''' While Wikipedia [[Wikipedia:Citing sources#Wikidata|does not regard Wikidata as a reliable source]], citations using Cite Q are ''not'' citing Wikidata; they cite the individual work stated, using metadata about that work, which is held on Wikidata for convenience.

== Usage ==

A wrapper for {{Tl|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 {{para|display-authors}}; setting that parameter to <code>all</code> displays them all. The same applies to multiple editors – see the test-case pages.

Citations of papers which have been retracted ({{WDP|P5824}}) will appear in [[:Category:Cite Q - cites a retracted work]].

Citations of papers which have been replaced ({{WDP|P1366}}) will appear in [[:Category:Cite Q - cites a replaced work]].

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

===Parameters ===

* {{para|1}} = Wikidata QID for the article

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

=== Blank ===

:<code><nowiki><ref name="">{{Cite Q| XXQIDXX }}</ref></nowiki></code>

=== Reference naming ===

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

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

===Parameter / entity map===
This section lists where each of the template's supported parameters gets its data.

{{Columns-start}} 
====Bibliographic parameters====
*{{para|at}}                    = {{WDP|P958}}
*{{para|author''n''}}           = {{WDP|P50}}; {{WDP|P2093}}
*{{para|chapter}}               = {{WDP|P792}}
<!-- *{{para|contributor''n''}} = {{WDP|P2680}}, {{WDP|P1891}} -->
*{{para|edition}}               = {{WDP|P393}}
*{{para|editor''n''}}           = {{WDP|P98}}; {{WDP|P5769}}
*{{para|issue}}                 = {{WDP|P433}}
*{{para|journal}}               = {{WDP|P1433}}
*{{para|language}}              = {{WDP|P407}}
*{{para|pages}}                 = {{WDP|P304}}
*{{para|place}}                 = {{WDP|P1071}} (for written-at place)
*{{para|publication-date}}      = {{WDP|P577}} (treated like {{para|date}} unless both are given)
*{{para|publication-place}}     = {{WDP|P291}} (for publication place, treated like {{para|place}} unless both are given)
*{{para|publisher}}             = {{WDP|P123}}
*{{para|series}}                = {{WDP|P179}}
*{{para|title}}                 = {{WDP|P1476}} (Wikidata label)
*{{para|translator''n''}}       = {{WDP|P655}}
*{{para|url}}                   = {{WDP|P953}}, {{WDP|P856}}, {{WDP|P2699}}
*{{para|version}}               = {{WDP|P348}}
*{{para|volume}}                = {{WDP|P478}}
*{{para|others}}                = {{WDP|P86}}, {{WDP|P110}}, {{WDP|P2679}}, {{WDP|P371}}, {{WDP|P175}}

{{column}}
====Identifier parameters====
*{{para|asin}}        = {{WDP|P5749}} (add {{para|asin-tld}} for some locales)
*{{para|arxiv}}       = {{WDP|P818}}
*{{para|bibcode}}     = {{WDP|P819}} (add {{para|bibcode-access}} to indicate free)
*{{para|biorxiv}}     = {{WDP|P3951}}
*{{para|citeseerx}}   = {{WDP|P3784}}
*{{para|doi}}         = {{WDP|P356}} (add {{para|doi-access}} to indicate free; add {{para|doi-broken-date}} if deprecated)
*{{para|hdl}}         = {{WDP|P1184}} (add {{para|hdl-access}} to indicate free)
*{{para|isbn}}        = {{WDP|P212}} (falls back to {{WDP|P957}})
*{{para|ismn}}        = {{WDP|P1208}}
*{{para|issn}}        = {{WDP|P236}}
*{{para|jstor}}       = {{WDP|P888}} (add {{para|jstor-access}} to indicate free)
*{{para|lccn}}        = {{WDP|P1144}}
*{{para|mr}}          = {{WDP|P889}}
*{{para|oclc}}        = {{WDP|P243}}
*{{para|ol}}          = {{WDP|P648}} (add {{para|ol-access}} to indicate free)
*{{para|osti}}        = {{WDP|P3894}} (add {{para|osti-access}} to indicate free)
*{{para|pmc}}         = {{WDP|P932}} (add {{para|pmc-embargo-date}} if embargoed)
*{{para|pmid}}        = {{WDP|P698}}
*{{para|rfc}}         = {{WDP|P892}}
*{{para|ssrn}}        = {{WDP|P893}}
*{{para|s2cid}}       = {{WDP|P8299}} (add {{para|s2cid-access}} to indicate free)
*{{para|zbl}}         = {{WDP|P894}}
{{Columns-end}}

=== Examples ===

;<code><nowiki>{{Cite Q|Q15625490}}</nowiki></code>
:{{Cite Q|Q15625490}}
;<code><nowiki>{{Cite Q|Q15625490|page=42}}</nowiki></code>
:{{Cite Q|Q15625490|page=42}}
;<code><nowiki>{{Cite Q|Q15625490|access-date=18 May 2017}}</nowiki></code>
:{{Cite Q|Q15625490|access-date=18 May 2017}}
;<code><nowiki>{{Cite Q|Q15625490|quote=lorem ipsum}}</nowiki></code>
:{{Cite Q|Q15625490|quote=lorem ipsum}}
;<code><nowiki>{{Cite Q|Q25766745}}</nowiki></code>
:{{Cite Q|Q25766745}}
;<code><nowiki>{{Cite Q|Q25766745 |chapter=The Final Cut}}</nowiki></code> (with chapter specified)
:{{Cite Q|Q25766745 |chapter=The Final Cut}}
;<code><nowiki>{{Cite Q|Q25766745 |pages=48-52}}</nowiki></code> (with pages)
:{{Cite Q|Q25766745 |pages=48-52}}
;<code><nowiki>{{Cite Q|Q15625490|access-date=18 May 2017}}</nowiki></code>
:{{Cite Q|Q15625490|access-date=18 May 2017}}
;<code><nowiki>{{Cite Q|Q25766745|mode=cs1}}</nowiki></code>
:{{Cite Q|Q25766745|mode=cs1}}
;<code><nowiki>{{Cite Q|Q25766745|mode=cs2}}</nowiki></code>
:{{Cite Q|Q25766745|mode=cs2}}
;<code><nowiki>{{Cite Q|Q25766745|author-mask=1}}</nowiki></code>
:{{Cite Q|Q25766745|author-mask=1}}
;<code><nowiki>{{Cite Q|Q25766745|editor=unset}}</nowiki></code>
:{{Cite Q|Q25766745|editor=unset}}

For an example of a bibliography, updated periodically by [https://listeria.toolforge.org/ Listeriabot], see [[User:Mike Peel/publications]].

For additional examples, see [[Template:Cite Q/testcases|testcases]] and [[Template:Cite Q/testcases/many names|testcases/many names]].

== Workflow ==

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, {{tl|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 {{tl|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:
# Order of editor names:
#: A typical output might be:
#* <code><nowiki>{{Cite Q |Q15625490}}</nowiki></code> →
#* {{Cite Q |Q15625490}}
#: 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:
#* <code><nowiki>{{Cite Q |Q15625490 |expand=yes}}</nowiki></code> →
#* {{Cite Q |Q15625490 |expand=yes}}
#: That would make the author names (and author-links) easily available for copy and paste, followed by tweaking into the desired format:
#* <code><nowiki>{{Cite Q |Q15625490 |author6=Etnoyer, Peter |author4=Hoetjes, Paul |author7=Smith, Michael |author5=Toller, Wes |author3=van Tassell, James L |author-link2=Kent E. Carpenter |author1=Williams, Jeffrey T |author2=Carpenter, Kent E}}</nowiki></code> →
#* {{Cite Q |Q15625490 |author6=Etnoyer, Peter |author4=Hoetjes, Paul |author7=Smith, Michael |author5=Toller, Wes |author3=van Tassell, James L |author-link2=Kent E. Carpenter |author1=Williams, Jeffrey T |author2=Carpenter, Kent E}}
# Punctuation:
#: The separators between elements in the above citation is a comma, which is the default for a CS2-style format produced by {{tl|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 {{para|mode|cs1}}:
#* <code><nowiki>{{Cite Q |Q15625490 |author6=Etnoyer, Peter |author4=Hoetjes, Paul |author7=Smith, Michael |author5=Toller, Wes |author3=van Tassell, James L |author-link2=Kent E. Carpenter |author1=Williams, Jeffrey T |author2=Carpenter, Kent E |mode=cs1}}</nowiki></code> →
#* {{Cite Q |Q15625490 |author6=Etnoyer, Peter |author4=Hoetjes, Paul |author7=Smith, Michael |author5=Toller, Wes |author3=van Tassell, James L |author-link2=Kent E. Carpenter |author1=Williams, Jeffrey T |author2=Carpenter, Kent E |mode=cs1}}
#* Sometimes, the article will have author names with initials, and those initials are terminated with a full stop (period). It may be necessary to manually add or remove the punctuation in the author names to match the style of the target article (note: this does not apply to author-links, which match the title of the author's article):
#* <code><nowiki>{{Cite Q |Q15625490 |author6=Etnoyer, Peter |author4=Hoetjes, Paul |author7=Smith, Michael |author5=Toller, Wes |author3=van Tassell, James L. |author-link2=Kent E. Carpenter |author1=Williams, Jeffrey T. |author2=Carpenter, Kent E. |mode=cs1}}</nowiki></code> →
#* {{Cite Q |Q15625490 |author6=Etnoyer, Peter |author4=Hoetjes, Paul |author7=Smith, Michael |author5=Toller, Wes |author3=van Tassell, James L. |author-link2=Kent E. Carpenter |author1=Williams, Jeffrey T. |author2=Carpenter, Kent E. |mode=cs1}}
# Italicisation in titles:
#: Titles drawn from Wikidata cannot contain formatting, so editors using {{tl|Cite Q}} may have to add appropriate formatting.
#: {{tl|Citation}} will automatically apply italicisation to titles of books, etc. so that does not need to be added:
#* <code><nowiki>{{Cite Q |Q25766745}}</nowiki></code> → 
#* {{Cite Q |Q25766745}}
#: 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:
#* For example (from {{isbn|978-0-521-32115-0}}): <code><nowiki>|chapter= ''Porphyra'' as food: cultivation and economic</nowiki></code>

== Module:Wd ==

[[Module:Wd]] can automatically cause this template to be invoked, e.g.,
;<code><nowiki>{{Wikidata|references|raw|Q2978|P2046}}</nowiki></code>
:{{Wikidata|references|raw|Q2978|P2046}}
currently causes the following to be invoked:
;<code><nowiki>{{Cite Q|Q15707237|pages=242}}</nowiki></code>
:{{Cite Q|Q15707237|pages=242}}
because an {{wikidata entity link|P2046}} statement on {{wikidata entity link|Q2978}} is referenced to be {{wikidata entity link|P248}} {{wikidata entity link|Q15707237}} with {{wikidata entity link|P304}} = 242.
{{hatnote|See [[d:Q2978#P2046]]}}

== Issues ==

=== Future developments ===
* Once robust the functionality should be merged into {{Tl|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 [[WP:CITEVAR|CiteVar]] wars!
* We should have a [[:mw:Global templates|global template repository]], so the code can be used by multiple wikis, without having to manually copy it after every update.

=== To do list ===
* 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:
*# <s>{{Wikidata entity link|P1932}} qualifier on {{Wikidata entity link|P50}}</s>
*# <s>{{Wikidata entity link|P1810}} qualifier on {{Wikidata entity link|P50}}</s>
*# <s>{{Wikidata entity link|P2093}}</s>
*# <s>{{Wikidata entity link|P50}} label in English</s>
*# {{Wikidata entity link|P50}} label in any other language
** <s>Regardless of which of the above is used, link to the author biography article if available, via {{Wikidata entity link|P50}} (matched via {{Wikidata entity link|P1545}} if applicable)</s>
* 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
**Avoid <code><nowiki><ref name="dicc">{{Cite Q|Q100160262}} {{cite wikisource|wslanguage=pt|wslink=Diccionario Bibliographico Brazileiro/Francisco Antonio de Almeida|title=Transcription}}</ref></nowiki></code>!
**Also add links to authors who have pages on Wikisource but not on Wikipedia. Related query: [https://w.wiki/qTu Authors on Wikisource but not other projects, who are linked to by an item which is a subclass of Q47461344 (written work)] 
* Consider case where author is given as {{Q|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}
*** Disputed; see [[Template talk:Citation#Et al]]
* Link to Wikisource should take priority over all URL properties, but only if accompanied by {{WDP|P996}}. If not, {{WDP|P996}} should take precedence over URLs.<!-- The rationale is that Wikisource books with the originals are both verifiable and can link to Wikipedia, Wiktionary etc. Wikisource books without the originals are not as trustworthy as the original files on Commons, so Commons files should be preferred -->
* <s>Where there is a Wikipedia article about the work cited, link the title to that, overriding the URL if necessary (example: [[:d:Q25766745]])</s>
** 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, [[Special:EntityUsage/Q101607488|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 {{Q|2818964}}, the label should start with an upper case letter
**Quick and dirty workaround: <code><nowiki>{{ucfirst:{{Cite Q|xxxx}}</nowiki></code>
* Convert WikiData's edition number (e.g., ''1'') into the ordinal (''1st'') expected by {{tl|citation}}.
* Make [https://species.wikimedia.org/w/index.php?title=Module:Cite_Q&diff=8090723&oldid=8090081 this fix] unnecessary.
* Add indication alongside citations of retracted/ replaced works
* Consider cases where citing a retracted/ replaced work is deliberate
* Make use of {{para|archive-url}}, {{para|archive-date}}, and consider how to use {{para|url-status}}
* Use {{WDP|P6833}}, where present.
* Improve rendering when both {{WDP|P50}} and {{WDP|2093}} are present.
** Example: ''<nowiki>{{Cite Q|Q108740476}}</nowiki>'' → {{Cite Q|Q108740476}}
** Current rendering of author name uses semicolon: “Camelia-Manuela Lățăianu; Manuela Lataianu”
** Suggested improved rendering of author name: “Manuela Lataianu [= Camelia-Manuela Lățăianu]”
** Such instances should be fixed on Wikidata, [https://www.wikidata.org/w/index.php?title=Q108740476&type=revision&diff=1630505802&oldid=1505280341 as done here]

=== Deferred ===
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 [[Tussenvoegsel]]s 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===
* <s>Multiple author names treated as one blob</s>
* <s>Linking author name(s)</s>
* <s>Title for a book uses <code><nowiki>{{ #invoke:WikidataIB |getLink |{{{1}}} }}</nowiki></code> and may be expensive</s>
* <s>Fix {{para|ol}} values</s>
* <s>Need to add manual date for newspaper articles/ website articles.</s> 
* <s>Make publisher a link, where appropriate</s>
* <s>Improve handing of unexpected multiple values</s>
** <s>e.g. Handle multiple DOIs</s>
* <s>Author name string ({{Wikidata entity link|P2093}}) values (e.g. on [[d:Q38000000|Q38000000]])</s>
* <s>Pseudonymous author personas such as [[P. D. Q. Bach]] or [[Mark Twain]]</s>
* <s>Title not in English</s>
* <s>Handle volume, issue and page(s) as qualifiers of {{Wikidata entity link|P1433}}</s>
* <s>Wider variety of examples/ test cases</s>
* <s>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</s>
* <s>The <code>url</code> parameter should also pick up data from the properties {{Wikidata property link|953}} and {{Wikidata property link|2699}}</s>
* <s>Linking title to Wikipedia article, if any</s>
* <s>Fetch ISSN etc. from item about journal</s>
* <s>Move Wikidata link before {{para|quote}} (and after other IDs like {{Para|pmid}})</s>
** <s>Also fixes postscript character issues in conjunction with {{para|mode|cs1}} and with {{para|quote}}</s>
* <s>Fix page evaluation code to accept comma- and semicolon-separated lists</s>
* <s>Use canonical parameter names when calling down to {citation} (f.e. |page= rather than |p=)</s>
* <s>Is there a Pxxxx code for SBNs ([[Standard Book Number]] to support |sbn= parameter?</s>
**<s>Apparently not</s> -> Add SBN property to WD. (Also add [[Serial Item and Contribution Identifier|SICI]] and [[Book Item and Component Identifier|BICI]] properties corresponding with COinS &rft.sici and &rft.bici.)
* <s>Is there a Pxxxx code for JFM ([[Jahrbuch über die Fortschritte der Mathematik]]) to support |jfm= parameter?</s>
**<s>{{WDP|P894}}? No, Zbl uses the same resolving link, but it is a different ID.</s>
* Are there values of {{para||others}} which are not illustrators? Possibly:
** <s>{{WDP|P2679}}</s>
** <s>{{WDP|1891}}</s>
*** <s>Fails for very high numbers</s>
** <s>{{WDP|P371}}</s>
** <s>{{WDP|P175}}</s>
* <s>Add a tracking category for references with a {{WDP|P1366}} statement</s>
* <s>Add a tracking category for references with a {{WDP|P5824}} statement</s>
* <s>Render {{Wikidata entity link|P1680}}, following the title with a <code>:</code></s>

=== Won't fix ===
* Improve date formatting options 
** This is done in {{tl|Citation}}
* Fix unnecessary piping of author/editor and journal links if link and label are the same, f.e. <nowiki>[[Author|Author]]</nowiki> -> <nowiki>[[Author]]</nowiki>, <nowiki>[[Journal|Journal]]</nowiki> -> <nowiki>[[Journal]]</nowiki> for improved reusability, cleaniness of output, reduced size of resulting page code, and to avoid potential future extra text errors thrown by the underlying {citation} template
** See talk
* Fix invocation with {{para|qid|}} instead of unnamed parameter. At present <nowiki>{{cite Q|qid=Q12345}}</nowiki> instead of <nowiki>{{cite Q|Q12345}}</nowiki> gives an error.
** This is intended; please discuss on talk
** Fix ready for test in template sandbox: <nowiki>{{cite Q/sandbox|qid=Q15625490}}</nowiki> gives {{cite Q/sandbox|qid=Q15625490}}
* Replace the QID with a pen icon
** The QID is valid metadata about the cited work.

== See also ==

[[:meta:WikiCite]] and [[:d:Wikidata:WikiProject Source Metadata]] - goals of those projects include the management of citations across Wikimedia projects and better insight into research resources through Wikimedia projects.

== Template data ==

<templatedata>
{
	"description": "Generate citations from Wikidata by passing the QID to this template", 
	"params": {
		"1": {
			"label": "QID", 
			"description": "The Wikidata QID of the cited source", 
			"type": "string", 
			"suggested": true, 
			"required": true
		}
	}
}
</templatedata>

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Templates that wrap Citation]]
[[Category:Templates using data from Wikidata]]
}}</includeonly>