Template:Cite Q/doc: Difference between revisions

(2 intermediate revisions by 2 users not shown)

Line 1:

{{warning|From the [[Wikipedia:Templates for discussion/Log/2017 September 15#Template:Cite Q|TfD closure]]: "~~[...] works-in-progress should rarely be used in the article space until they are 99% finished/accurate/etc.~~ 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."}}

{{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."}}

~~== Background ==~~

This template, a wrapper for {{Tl|Citation}}, 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.

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

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]]~~.

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

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}}; ~~using~~ that parameter ~~with no value~~ displays them all. The same applies to multiple editors - see the test-case pages.

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]].

Line 22:

Line 27:

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).

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

===Parameters ===

Line 91:

Line 96:

*{{para|s2cid}} = {{WDP|P8299}} (add {{para|s2cid-access}} to indicate free)

*{{para|zbl}} = {{WDP|P894}}

====Archival parameters====

*{{para|archive-url}} = {{WDP|P1065}} (the long URL with a date is needed; see [[WP:WEBARCHIVES]] for e.g. Archive Today)

Line 117:

Line 127:

;<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]].

Line 210:

Line 224:

** 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 ===

Line 268:

Line 283:

** 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 ==

Line 273:

Line 294:

{

"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

},

"author": {

"label": "Author",

"description": "Use for Last, First format",

"example": "Prymachenko, Maria",

"type": "string"

},

"authorlink": {

"label": "Author Link",

"description": "Wikipedia article title, use with Author",

"example": "Maria Prymachenko",

"type": "string"

}

},

"paramOrder": [

"1",

"author",

"authorlink"

]

}

</templatedata>

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
 {{high use}}
-{{warning|From the [[Wikipedia:Templates for discussion/Log/2017 September 15#Template:Cite Q|TfD closure]]: "[...] works-in-progress should rarely be used in the article space until they are 99% finished/accurate/etc. 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."}}
+{{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}}
-== Background ==
+This template, a wrapper for {{Tl|Citation}}, 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.
-You can read about the template in:{{Blockquote|{{cite Q|Q104831003}}}}
+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]].
+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}}
 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}}; using that parameter with no value displays them all. The same applies to multiple editors - see the test-case pages.
+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]].
@@ Line 22: / Line 27: @@
 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).
+You can also use {{tl|Cite Q bulleted}} if you want to have a bullet returned before the citation (useful for automatic lists)
 ===Parameters ===
@@ Line 91: / Line 96: @@
 *{{para|s2cid}}       = {{WDP|P8299}} (add {{para|s2cid-access}} to indicate free)
 *{{para|zbl}}         = {{WDP|P894}}
+{{Columns-end}}
+{{Columns-start}}
+====Archival parameters====
+*{{para|archive-url}} = {{WDP|P1065}} (the long URL with a date is needed; see [[WP:WEBARCHIVES]] for e.g. Archive Today)
 {{Columns-end}}
@@ Line 117: / Line 127: @@
 ;<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]].
@@ Line 210: / Line 224: @@
 ** 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 ===
@@ Line 268: / Line 283: @@
 ** 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 ==
@@ Line 273: / Line 294: @@
 <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
+		},
+		"author": {
+			"label": "Author",
+			"description": "Use for Last, First format",
+			"example": "Prymachenko, Maria",
+			"type": "string"
+		},
+		"authorlink": {
+			"label": "Author Link",
+			"description": "Wikipedia article title, use with Author",
+			"example": "Maria Prymachenko",
+			"type": "string"
 		}
-	}
+	},
+	"paramOrder": [
+		"1",
+		"author",
+		"authorlink"
+	]
 }
 </templatedata>