View source for Template:Cite Q/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Lua|Module:Cite Q|Module:WikidataIB|Module:Wd|Module:String}}
{{Uses Wikidata}}

== Usage ==

A prototype wrapper for {{Tl|Citation}}, which calls available values from [[Wikidata:Main Page|Wikidata]].

=== Future developments ===

* <s>Convert to use Lua for more advanced functionality</s>
* 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!

===Parameters ===

* {{para|1}} = Wikidata QID for the article
* {{para|access-date}} = date an online resources was viewed
* {{para|author-mask|}} = replace author name(s) with em-dashes or text
* {{para|chapter}} = chapter title or number of a book or larger work; overrides Wikidata value
* {{para|date}} = date of publication; uses Wikidata value if not set
* {{para|df}} = date format
* {{para|display-authors}} = 
* {{Para|embargo}} = embargo date for PMC
* {{para|id}} = generic ID; may be wikilinked
* {{para|mode}} = Sets separator, terminal punctuation, and capitalization; use {{Para|mode|cs1}} or {{Para|mode|cs2}} 
* {{para|page}} = single page number
* {{para|pages}} = multiple page numbers, e.g. <code>27-29</code> or <code>34,36</code> 
* {{para|quote}} = quotation from the source; may include wikilinks
* {{para|series}} = series of which e.g. a book is part; may include wikilinks; uses Wikidata value if not set
* {{para|url}} = url to source; uses Wikidata value if not set

For all but {{para|1}}; see {{tl|citation}} for more details.

=== Blank ===

:<code><nowiki>{{Cite Q| XXQIDXX |page= |access-date= |quote= }}</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.
P734}}
{{Columns-start}}
====Bibliographic parameters====
*{{para|author''n''}} = {{Wikidata entity link|P50}}
*{{para|chapter}}     = {{Wikidata entity link|P792}}
*{{para|date}}        = {{Wikidata entity link|P577}}
*{{para|editor''n''}} = {{Wikidata entity link|P98}}
*{{para|issue}}       = {{Wikidata entity link|P433}}
*{{para|journal}}     = {{Wikidata entity link|P1433}}
*{{para|others}}      = {{Wikidata entity link|P110}}
*{{para|place}}       = {{Wikidata entity link|P291}}
*{{para|publisher}}   = {{Wikidata entity link|P123}}
*{{para|series}}      = {{Wikidata entity link|P179}}
*{{para|title}}       = {{Wikidata entity link|P1476}}
*{{para|title}}       = wikidata label
*{{para|url}}         = {{Wikidata entity link|P856}}
*{{para|volume}}      = {{Wikidata entity link|P478}}
{{Column}}
====Identifier parameters====
*{{para|arxiv}}       = {{Wikidata entity link|P818}}
*{{para|bibcode}}     = {{Wikidata entity link|P819}}
*{{para|biorxiv}}     = {{Wikidata entity link|P3951}}
*{{para|citeseerx}}   = {{Wikidata entity link|P3784}}
*{{para|doi}}         = {{Wikidata entity link|P356}}
*{{para|hdl}}         = {{Wikidata entity link|P1184}}
*{{para|isbn}}        = {{Wikidata entity link|P212}}
*{{para|isbn}}        = {{Wikidata entity link|P957}}
*{{para|ismn}}        = {{Wikidata entity link|P1208}}
*{{para|jstor}}       = {{Wikidata entity link|P888}}
*{{para|lccn}}        = {{Wikidata entity link|P1144}}
*{{para|mr}}          = {{Wikidata entity link|P889}}
*{{para|oclc}}        = {{Wikidata entity link|P243}}
*{{para|ol}}          = {{Wikidata entity link|P648}}
*{{para|osti}}        = {{Wikidata entity link|P3894}}
*{{para|pmc}}         = {{Wikidata entity link|P932}}
*{{para|pmid}}        = {{Wikidata entity link|P698}}
*{{para|ssrn}}        = {{Wikidata entity link|P893}}
{{Columns-end}}

=== Examples ===

Examples here are mostly test-cases, and will need to be thinned (and moved to a sub-page) before the template is widely deployed.

==== Journal ====

;<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|Q15625490|page=42|access-date=18 May 2017|quote=lorem ipsum}}</nowiki></code>
:{{Cite Q|Q15625490|page=42|access-date=18 May 2017|quote=lorem ipsum}}
;<code><nowiki>{{Cite Q|Q30000000}}</nowiki></code> (with issue; volume - needs work!)
:{{Cite Q|Q30000000}}
;<code><nowiki>{{Cite Q|Q14558831}}</nowiki></code> (with arxiv; bibcode)
:{{Cite Q|Q14558831}}
;<code><nowiki>{{Cite Q|Q28597702}}</nowiki></code> (with biorxiv)
:{{Cite Q|Q28597702}}
;<code><nowiki>{{Cite Q|Q22241718}}</nowiki></code> (with citeseerx)
:{{Cite Q|Q22241718}}
;<code><nowiki>{{Cite Q|Q28798299}}</nowiki></code> (with osti)
:{{Cite Q|Q28798299}}
;<code><nowiki>{{Cite Q|Q23327424}}</nowiki></code> (with ssrn)
:{{Cite Q|Q23327424}}

==== Book ====

;<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|Q4784}}</nowiki></code> (with ISBN 10 & OCLC)
:{{Cite Q|Q4784}}
;<code><nowiki>{{Cite Q|Q14944010}}</nowiki></code> (edition; with LCCN & OCLC)
:{{Cite Q|Q14944010}}
;<code><nowiki>{{Cite Q|Q21707170}}</nowiki></code> (with MR)
:{{Cite Q|Q21707170}}
;<code><nowiki>{{Cite Q|Q24969482|volume=1|date=1873}}</nowiki></code> (with volume & year; note<nowiki>:</nowiki> it is better to create an item for the specific volume)
:{{Cite Q|Q24969482|volume=1|date=1873}}
;<code><nowiki>{{Cite Q|Q29581627|series=A series}}</nowiki></code> (with series)
:{{Cite Q|Q29581627|series=A series}}

==== News ====

Not working at present; needs special handling.

<!--
;<code><nowiki>{{Cite Q|Q9684|title= Movie Ticket Sales Sagging? Time to Bring Out the Toys|url=https://www.nytimes.com/2017/05/22/business/media/at-warner-bros-former-disney-exec-leads-new-charge-on-merchandise.html|date=2017-05-22}}
</nowiki></code>
{{Cite Q|Q9684|title= Movie Ticket Sales Sagging? Time to Bring Out the Toys|url=https://www.nytimes.com/2017/05/22/business/media/at-warner-bros-former-disney-exec-leads-new-charge-on-merchandise.html|date=2017-05-22}}
-->

==== Manuscript ====

;<code><nowiki>{{Cite Q|Q15664389}}</nowiki></code> (with hdl)
:{{Cite Q|Q15664389}}

==== Misc ====
;<code><nowiki>{{Cite Q|Q15901614}}</nowiki></code> (with ISMN)
:{{Cite Q|Q15901614}}

==== Mode ====

;<code><nowiki>{{Cite Q|Q15625490|access-date=18 May 2017|mode=cs1}}</nowiki></code>
:{{Cite Q|Q15625490|access-date=18 May 2017|mode=cs1}}
;<code><nowiki>{{Cite Q|Q15625490|access-date=18 May 2017|mode=cs2}}</nowiki></code>
:{{Cite Q|Q15625490|access-date=18 May 2017|mode=cs2}}
;<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}}

==== Authormask ====

;<code><nowiki>{{Cite Q|Q25766745|author-mask=1}}</nowiki></code>
:{{Cite Q|Q25766745|author-mask=1}}

== 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]]}}

{{tlx|wikidata|references}} is used in a number of places including {{tl|Infobox World Heritage Site}} resulting in the above reference appearing as a reference footnote at {{section link|Regensburg|History after 1945}}.

== Issues ==

* <s>Multiple author names treated as one blob</s>
* <s>Linking author name(s)</s>
* Title for a book uses <code><nowiki>{{ #invoke:WikidataIB |getLink |{{{1}}} }}</nowiki></code> and may be expensive
* What to do if title not in English
* Linking title to Wikipedia article, if any
* Need to fetch ISSN etc. from item about journal
* More properties/ parameters to add
* Parameters with no equivalent property?
* Move Wikidata link before {{para|quote}} (and after other IDs like {{Para|pmid}})
* <s>Fix {{para|ol}} values</s>
* Need to handle volume, issue and page(s) as qualifiers of journal (see [[d:Q30000000|Q30000000]] example)
* Check/ resolve handling of redirected QIDs
* Need wider variety of examples/ test cases
* <s>Need to add manual date for newspaper articles/ website articles.</s> 
* Resolve special case of newspaper articles
* Improve date formatting options
* Make publisher a link, where appropriate
* Handle volume in a serial
* Improve handing of unexpected multiple values
** e.g. Handle multiple DOIs
* <s>Handle author name string ({{Wikidata entity link|P2093}}) values (e.g. on [[d:Q38000000|Q38000000]])</s>
* Order of precedence for rendering author names:
*# {{Wikidata entity link|P1932}} qualifier on {{Wikidata entity link|P50}}
*# {{Wikidata entity link|P2093}}
*# {{Wikidata entity link|P50}} label in English
*# {{Wikidata entity link|P50}} label in any other language
** 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>Handle pseudonymous author personas such as [[P. D. Q. Bach]] or [[Mark Twain]]</s>
<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Templates that wrap Citation]]
[[Category:Templates using data from Wikidata]]
}}</includeonly>