Difference between revisions of "Template:Cricketarchive/doc"

From blackwiki
Jump to navigation Jump to search
imported>Galobtter
(fix lnt)
imported>Zyxw
(update Wikidata examples, document archive parameter)
Line 13: Line 13:
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | name= ''NAME'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | name= ''NAME'' <nowiki>}}</nowiki></code>
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | name= ''NAME'' | archive= ''NUMBER'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | name= ''NAME'' | accessdate= ''DATE'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | name= ''NAME'' | accessdate= ''DATE'' <nowiki>}}</nowiki></code>
  
Line 18: Line 19:
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' | name= ''NAME'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' | name= ''NAME'' <nowiki>}}</nowiki></code>
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' | name= ''NAME'' | archive= ''NUMBER'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' | name= ''NAME'' | accessdate= ''DATE'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' | name= ''NAME'' | accessdate= ''DATE'' <nowiki>}}</nowiki></code>
  
Line 23: Line 25:
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ref= ''REF'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ref= ''REF'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ref= ''REF'' | name= ''NAME'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ref= ''REF'' | name= ''NAME'' <nowiki>}}</nowiki></code>
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ref= ''REF'' | name= ''NAME'' | archive= ''NUMBER'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ref= ''REF'' | name= ''NAME'' | accessdate= ''DATE'' <nowiki>}}</nowiki></code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ref= ''REF'' | name= ''NAME'' | accessdate= ''DATE'' <nowiki>}}</nowiki></code>
  
Line 28: Line 31:
  
 
=== Using "id" from Wikidata ===
 
=== Using "id" from Wikidata ===
The Wikidata examples are simulated, they only work as shown if used in the [[Sachin Tendulkar]] article.
+
: ''The Wikidata examples are simulated; they only work as shown if used in the article for [[Sachin Tendulkar]].''
  
 
''Usage:''
 
''Usage:''
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}}}</code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}}}</code>
: {{{{BASEPAGENAME}} | id= 1933 | name= Sachin Tendulkar }}
+
: [https://cricketarchive.com/Archive/Players/1/1933/1933.html Sachin Tendulkar] at CricketArchive [[File:OOjs UI icon edit-ltr-progressive.svg |frameless |text-top |10px |alt=Edit this at Wikidata |link=https://www.wikidata.org/wiki/Q9488#P2698 |Edit this at Wikidata]] {{subscription required}}
  
 
''Usage with accessdate parameter:''
 
''Usage with accessdate parameter:''
Line 47: Line 50:
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= 1933 | name= Sachin Tendulkar }}</code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= 1933 | name= Sachin Tendulkar }}</code>
 
: {{{{BASEPAGENAME}} | id= 1933 | name= Sachin Tendulkar }}
 
: {{{{BASEPAGENAME}} | id= 1933 | name= Sachin Tendulkar }}
 +
 +
''Usage with archive parameter:''
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= 1933 | name= Sachin Tendulkar | archive= 20170221000549 }}</code>
 +
: {{{{BASEPAGENAME}} | id= 1933 | name= Sachin Tendulkar | archive= 20170221000549 }}
  
 
''Usage with accessdate parameter:''
 
''Usage with accessdate parameter:''
Line 63: Line 70:
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ref= Archive/Grounds/22/1547.html | name= Zafar Ali Stadium }}</code>
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ref= Archive/Grounds/22/1547.html | name= Zafar Ali Stadium }}</code>
 
: {{{{BASEPAGENAME}} | ref= Archive/Grounds/22/1547.html | name= Zafar Ali Stadium }}
 
: {{{{BASEPAGENAME}} | ref= Archive/Grounds/22/1547.html | name= Zafar Ali Stadium }}
 +
 +
''Usage with archive parameter:''
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |ref=Archive/Grounds/22/1547 |name=Zafar Ali Stadium |archive=20170113134139}}</code>
 +
: {{{{BASEPAGENAME}} |ref=Archive/Grounds/22/1547 |name=Zafar Ali Stadium |archive=20170113134139}}
  
 
''Usage with accessdate parameter:''
 
''Usage with accessdate parameter:''
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ref= Archive/Grounds/22/1547 | name= Zafar Ali Stadium | accessdate= 25 February 2017 }}</code>
+
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |ref=Archive/Grounds/22/1547 |name=Zafar Ali Stadium |accessdate=25 February 2017}}</code>
: {{{{BASEPAGENAME}} | ref= Archive/Grounds/22/1547 | name= Zafar Ali Stadium | accessdate= 25 February 2017 }}
+
: {{{{BASEPAGENAME}} |ref=Archive/Grounds/22/1547 |name=Zafar Ali Stadium |accessdate=25 February 2017}}
  
 
== TemplateData ==
 
== TemplateData ==
Line 78: Line 89:
 
     "type": "number",
 
     "type": "number",
 
     "required": false,
 
     "required": false,
     "default": "Wikidata property P2697"
+
     "default": "Wikidata property P2698"
 
   },
 
   },
 
   "ref": {
 
   "ref": {
Line 92: Line 103:
 
     "required": false,
 
     "required": false,
 
     "default": "{{PAGENAMEBASE}}"
 
     "default": "{{PAGENAMEBASE}}"
 +
  },
 +
  "archive": {
 +
    "label": "archive",
 +
    "description": "The optional \"archive\" parameter may be used to display a link to archive of the page. The value of this parameter should be a number representing the date/time in an Internet Archive URL, such as 20170221000549 in https://web.archive.org/web/20170221000549/https://cricketarchive.com/Archive/Players/1/1933/1933.html.",
 +
    "type": "number",
 +
    "required": false
 
   },
 
   },
 
   "accessdate": {
 
   "accessdate": {
 
     "label": "accessdate",
 
     "label": "accessdate",
     "description": "The \"accessdate\" parameter may be used to document the date when the link was accessed or retrieved. This parameter is optional.",
+
     "description": "The optional \"accessdate\" parameter may be used to document the date when the link was accessed or retrieved. It also changes the output to a citation format, such as \"Name\". CricketArchive. Retrieved 25 February 2017.",
 
     "type": "date",
 
     "type": "date",
 
     "required": false
 
     "required": false
Line 114: Line 131:
 
[[Category:Cricket external link templates]]
 
[[Category:Cricket external link templates]]
 
[[Category:People and person external link templates]]
 
[[Category:People and person external link templates]]
 +
[[Category:External link templates using Wikidata]]
 +
[[Category:External link templates with archive parameter]]
 
[[Category:External link templates with accessdate parameter]]
 
[[Category:External link templates with accessdate parameter]]
[[Category:External link templates using Wikidata]]
 
 
[[Category:Templates that add a tracking category]]
 
[[Category:Templates that add a tracking category]]
 
}}</includeonly>
 
}}</includeonly>

Revision as of 00:46, 10 December 2019

Template:Template redirect Template:Uses Wikidata

Template:Cricketarchive displays an external link to a CricketArchive web page. Links to cricket player profiles are created with the "id" parameter and links to other pages are created with the "ref" parameter. It is intended for use in the external links section of an article.

For players, the "id" value should be added to the Template:Wpl property in Wikidata. Then, if the "id" or "ref" parameters are not specified, the template will retrieve the id from Wikidata.

Usage

Using "id" from Wikidata:

{{Cricketarchive}}
{{Cricketarchive | name= NAME }}
{{Cricketarchive | name= NAME | archive= NUMBER }}
{{Cricketarchive | name= NAME | accessdate= DATE }}

Using "id" parameter:

{{Cricketarchive | id= ID }}
{{Cricketarchive | id= ID | name= NAME }}
{{Cricketarchive | id= ID | name= NAME | archive= NUMBER }}
{{Cricketarchive | id= ID | name= NAME | accessdate= DATE }}

Using "ref" parameter:

{{Cricketarchive | ref= REF }}
{{Cricketarchive | ref= REF | name= NAME }}
{{Cricketarchive | ref= REF | name= NAME | archive= NUMBER }}
{{Cricketarchive | ref= REF | name= NAME | accessdate= DATE }}

Examples

Using "id" from Wikidata

The Wikidata examples are simulated; they only work as shown if used in the article for Sachin Tendulkar.

Usage:

{{Cricketarchive}}
Sachin Tendulkar at CricketArchive Edit this at Wikidata Template:Subscription required

Usage with accessdate parameter:

{{Cricketarchive | accessdate= 25 February 2017 }}
"Sachin Tendulkar". CricketArchive. Retrieved 25 February 2017. Template:Subscription required

Using "id" parameter

URL:

https://cricketarchive.com/Archive/Players/1/1933/1933.html

Usage:

{{Cricketarchive | id= 1933 | name= Sachin Tendulkar }}
Sachin Tendulkar at CricketArchiveScript error: No such module "EditAtWikidata". Template:Subscription required

Usage with archive parameter:

{{Cricketarchive | id= 1933 | name= Sachin Tendulkar | archive= 20170221000549 }}
Sachin Tendulkar at CricketArchiveScript error: No such module "EditAtWikidata". Template:Subscription required (archive)

Usage with accessdate parameter:

{{Cricketarchive | id= 1933 | name= Sachin Tendulkar | accessdate= 25 February 2017 }}
"Sachin Tendulkar". CricketArchive. Retrieved 25 February 2017. Template:Subscription required

Using "ref" parameter

URL:

https://cricketarchive.com/Archive/Grounds/22/1547.html

Usage:

{{Cricketarchive | ref= Archive/Grounds/22/1547 | name= Zafar Ali Stadium }}
Zafar Ali Stadium at CricketArchiveScript error: No such module "EditAtWikidata". Template:Subscription required

Usage with ".html" in ref parameter:

{{Cricketarchive | ref= Archive/Grounds/22/1547.html | name= Zafar Ali Stadium }}
Zafar Ali Stadium at CricketArchiveScript error: No such module "EditAtWikidata". Template:Subscription required

Usage with archive parameter:

{{Cricketarchive |ref=Archive/Grounds/22/1547 |name=Zafar Ali Stadium |archive=20170113134139}}
Zafar Ali Stadium at CricketArchiveScript error: No such module "EditAtWikidata". Template:Subscription required (archive)

Usage with accessdate parameter:

{{Cricketarchive |ref=Archive/Grounds/22/1547 |name=Zafar Ali Stadium |accessdate=25 February 2017}}
"Zafar Ali Stadium". CricketArchive. Retrieved 25 February 2017. Template:Subscription required

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Cricketarchive

This template displays an external link to a CricketArchive web page. Links to cricket player profiles are created with the "id" parameter and links to other pages are created with the "ref" parameter. It is intended for use in the external links section of an article.

Template parameters

ParameterDescriptionTypeStatus
idid

The "id" parameter should contain the ID number in the URL for the player's profile. Example: 1933 is the "id" in https://cricketarchive.com/Archive/Players/1/1933/1933.html. It is required when not using the "ref" parameter or the Wikidata property.

Default
Wikidata property P2698
Numberoptional
refref

The "ref" parameter is optional and only used when the player "id" is not specified. If used, it should contain the portion of the URL between "https://cricketarchive.com/" and ".html". Example: Archive/Grounds/22/1547 is the "ref" portion of https://cricketarchive.com/Archive/Grounds/22/1547.html. It is required when not using the "id" parameter or the Wikidata property.

Stringoptional
namename

The "name" parameter may be used to specify the link text. This parameter is optional; it defaults to the Wikipedia article name, without any disambiguation such as "(cricketer)".

Default
{{PAGENAMEBASE}}
Stringoptional
archivearchive

The optional "archive" parameter may be used to display a link to archive of the page. The value of this parameter should be a number representing the date/time in an Internet Archive URL, such as 20170221000549 in https://web.archive.org/web/20170221000549/https://cricketarchive.com/Archive/Players/1/1933/1933.html.

Numberoptional
accessdateaccessdate

The optional "accessdate" parameter may be used to document the date when the link was accessed or retrieved. It also changes the output to a citation format, such as "Name". CricketArchive. Retrieved 25 February 2017.

Dateoptional

Tracking category

See also