Template:Cite Instagram/doc: Difference between revisions

< Template:Cite Instagram Browse history interactively ← Previous editContent deleted Content addedVisual WikitextInline

Revision as of 02:26, 1 January 2024 editPemilligan (talk \| contribs)Extended confirmed users27,727 edits →Examples: Trying to remove the error message caused by the exampleTag: Reverted← Previous edit		Latest revision as of 15:20, 26 December 2024 edit undoRjjiii (talk \| contribs)Extended confirmed users, Rollbackers, Template editors12,993 edits Adding a copy button to code sample, stable since 1.43.0 (21 December 2024 release) https://www.mediawiki.org/Extension:SyntaxHighlight
(6 intermediate revisions by 5 users not shown)
Line 14:		Line 14:
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\|		\|
	: <~~code><nowiki~~>{{Cite Instagram \|user= \|postid= \|title= \|date=}}</~~nowiki></code~~>		: <syntaxhighlight lang="wikitext" copy="1">{{Cite Instagram \|user= \|postid= \|title= \|date=}}</syntaxhighlight>
	{{end}}		{{end}}
	{{csdoc\|usage full}}		{{csdoc\|usage full}}
	: <~~code><nowiki~~>{{Cite Instagram \|author= (or \|last= and \|first=) \|author-link= \|user= \|postid= \|date= \|title= \|script-title= \|trans-title= \|language= \|location= \|access-date= \|link= \|url-status= \|archive-url= \|archive-date= \|ref=}}</~~nowiki></code~~>		: <syntaxhighlight lang="wikitext" copy="1">{{Cite Instagram \|author= (or \|last= and \|first=) \|author-link= \|user= \|postid= \|date= \|title= \|script-title= \|trans-title= \|language= \|location= \|access-date= \|link= \|url-status= \|archive-url= \|archive-date= \|ref=}}</syntaxhighlight>
	{{end}}		{{end}}
	{{A note}} When known, the author's real name should be specified in the {{para\|author}} parameter (or {{para\|last}} and {{para\|first}}). If their real name is not known, then the post is probably not an ].		{{A note}} When known, the author's real name should be specified in the {{para\|author}} parameter (or {{para\|last}} and {{para\|first}}). If their real name is not known, then the post is probably not an ].

	== Examples ==		== Examples ==
	'''<code><nowiki>{{Cite Instagram \|user=~~jackolantern~~ \|postid=CHDzGgCs568 \|date=2 November 2020 \|title=Happy Halloween \|access-date=9 November 2020}}</nowiki></code>'''		'''<code><nowiki>{{Cite Instagram \|user=instagram \|postid=CHDzGgCs568 \|date=2 November 2020 \|title=Happy Halloween \|access-date=9 November 2020}}</nowiki></code>'''
	: {{Cite Instagram \|user=instagram \|postid=CHDzGgCs568 \|date=2 November 2020 \|title=Happy Halloween \|access-date=9 November 2020}}		: {{Cite Instagram \|user=instagram \|postid=CHDzGgCs568 \|date=2 November 2020 \|title=Happy Halloween \|access-date=9 November 2020}}

Line 40:		Line 40:
	"params": {		"params": {
	"postid": {		"postid": {
	"label": "~~postid~~",		"label": "Post ID",
	"description": "Alpha-numeric ID of the post",		"description": "Alpha-numeric ID of the post",
	"type": "~~string~~",		"type": "line",
	"required": true		"required": true,
			"example": "CHDzGgCs568"
	},		},
	"user": {		"user": {
	"label": "~~username~~",		"label": "Username",
	"description": "Instagram account name, without the @",		"description": "Instagram account name, without the @",
	"type": "~~string~~",		"type": "line",
	"required": true		"required": true,
			"example": "instagram"
	},		},
	"title": {		"title": {
	"label": "~~post~~",		"label": "Post",
	"description": "Partial or entire content of the post, optionally including hashtags (#), at signs (@), and links. Note: double quote marks (\") should be replaced with single quote marks (') because the entire title will display surrounded by double quotes.",		"description": "Partial or entire content of the post, optionally including hashtags (#), at signs (@), and links. Note: double quote marks (\") should be replaced with single quote marks (') because the entire title will display surrounded by double quotes.",
	"type": "string",		"type": "string",
	"required": true		"required": true,
			"example": "Happy Halloween"
	},		},
	"date": {		"date": {
	"label": "~~date~~",		"label": "Date",
	"description": "~~date~~ of the post; do not wikilink; do not include time.",		"description": "Date of the post; do not wikilink; do not include time.",
	"required": true		"required": true,
			"type": "date"
			},
			"first": {
			"label": "First name",
			"description": "The first name of the author. If not known, then the post is probably not an acceptable usage of a self-published source (see WP:SPS)",
			"type": "line",
			"suggested": true,
			"example": "Sammy"
			},
			"last": {
			"label": "Last name",
			"description": "The last name of the author. If not known, then the post is probably not an acceptable usage of a self-published source (see WP:SPS)",
			"type": "line",
			"suggested": true,
			"example": "Smith"
	},		},
	"author": {		"author": {
	"label": "~~author~~",		"label": "Author",
	"description": "Author's real name, if known. If not known, then the post is probably not an acceptable usage of a self-published source (see ])",		"description": "Author's real name, if known. If not known, then the post is probably not an acceptable usage of a self-published source (see WP:SPS)",
	"suggested": true		"suggested": true,
			"example": "Wikimedia Foundation",
			"type": "line"
	},		},
	"author-link": {		"author-link": {
Line 71:		Line 91:
	"authorlink"		"authorlink"
	],		],
	"label": "~~author~~'s article",		"label": "Author's article",
	"description": "Title of existing Misplaced Pages article about the author"		"description": "Title of existing Misplaced Pages article about the author",
			"example": "Instagram",
			"type": "wiki-page-name"
	},		},
	"access-date": {		"access-date": {
Line 78:		Line 100:
	"accessdate"		"accessdate"
	],		],
	"label": "~~access~~ date",		"label": "Access date",
	"description": "The full date when the post was accessed; do not wikilink"		"description": "The full date when the post was accessed; do not wikilink",
			"type": "date"
	},		},
	"language": {		"language": {
	"label": "~~language~~",		"label": "Language",
	"description": "The language in which the post is written, if not in English.",		"description": "The language in which the post is written, if not in English.",
	"example": "fr",		"example": "fr",
	"type": "~~string~~"		"type": "line"
	},		},
	"location": {		"location": {
	"label": "~~location~~",		"label": "Location",
	"description": "The location from which a post was sent.",		"description": "The location from which a post was sent.",
	"example": "London",		"example": "London",
	"type": "~~string~~"		"type": "line"
	},		},
	"archive-url": {		"archive-url": {
	"label": "~~archive~~ URL",		"label": "Archive URL",
	"aliases": [		"aliases": [
	"archiveurl"		"archiveurl"
	],		],
	"description": "The URL of an archived copy of a web page, if or in case the URL becomes unavailable; requires 'archive-date'",		"description": "The URL of an archived copy of a web page, if or in case the URL becomes unavailable; requires 'archive-date'",
	"type": "~~string~~"		"type": "url"
	},		},
	"archive-date": {		"archive-date": {
	"label": "~~archive~~ date",		"label": "Archive date",
	"aliases": [		"aliases": [
	"archivedate"		"archivedate"
Line 112:		Line 135:
	"label": "URL status",		"label": "URL status",
	"description": "If set to 'live', the title displays as the live link; if set to dead, the title displays as the archive link",		"description": "If set to 'live', the title displays as the live link; if set to dead, the title displays as the archive link",
	"type": "~~string~~"		"type": "line",
			"aliases": [
			"dead-url",
			"deadurl"
			],
			"suggestedvalues": [
			"dead",
			"live",
			"deviated",
			"unfit",
			"usurped"
			],
			"default": "dead (when Archive URL given)"
	},		},
	"script-title": {		"script-title": {
	"label": "~~script~~ post",		"label": "Script post",
	"description": "For post in languages that do not use a Latin-based alphabet (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, Vietnamese, etc). Prefix with two-character ISO639-1 language code followed by a colon, e.g. for Japanese use: ja:...",		"description": "For post in languages that do not use a Latin-based alphabet (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, Vietnamese, etc). Prefix with two-character ISO639-1 language code followed by a colon, e.g. for Japanese use: ja:...",
	"example": "ja:東京タワー"		"example": "ja:東京タワー",
			"type": "string"
	},		},
	"trans-title": {		"trans-title": {
	"label": "~~translated~~ post",		"label": "Translated post",
	"description": "An English language translation, if the post cited is in a foreign language; use of 'language' parameter is recommended"		"description": "An English language translation, if the post cited is in a foreign language; use of 'language' parameter is recommended",
			"type": "string"
	},		},
	"link": {		"link": {
	"label": "Link to Instagram article?",		"label": "Link to Instagram article?",
	"description": "Set to \"no\" to not link to the Misplaced Pages article for Instagram. Useful for preventing overlinking when more than one ~~tweet~~ is cited."		"description": "Set to \"no\" to not link to the Misplaced Pages article for Instagram. Useful for preventing overlinking when more than one post is cited.",
			"example": "no",
			"type": "line",
			"suggestedvalues": [
			"no"
			],
			"default": "yes"
			},
			"df": {
			"label": "Date format",
		⚫	"description": "Valid values: dmy, dmy-all, mdy, mdy-all",
			"type": "line",
			"suggestedvalues": [
			"dmy",
			"dmy-all",
			"mdy",
			"mdy-all"
			]
	},		},
	"df": {		"ref": {
	"label": "~~Date format~~",		"label": "Anchor",
			"description": "The citation's HTML anchor identifier, when different from its default. To inhibit anchor ID creation, set to \"none\".",
⚫	"description": "Valid values: dmy, dmy-all, mdy, mdy-all"
			"type": "line",
	}
			"suggestedvalues": [
			"none"
			]
			}
	},		},
	"description": "A template for citing content posted on Instagram"		"description": "A template for citing content posted on Instagram",
			"paramOrder": [
			"postid",
			"user",
			"title",
			"first",
			"last",
			"author",
			"author-link",
			"date",
			"access-date",
			"language",
			"location",
			"archive-url",
			"archive-date",
			"url-status",
			"script-title",
			"trans-title",
			"link",
			"df",
			"ref"
			],
			"format": "{{_ \|_=_}}"
	}		}
	</templatedata>		</templatedata>

Latest revision as of 15:20, 26 December 2024

This is a documentation subpage for Template:Cite Instagram.
It may contain usage information, categories and other content that is not part of the original template page.

Instagram posts are usually unacceptable as sources. Instagram posts and other self-published material may be acceptable if the conditions specified at WP:SPS, WP:SOCIALMEDIA, or WP:INSTAGRAM are met. For further information, see the Misplaced Pages:Verifiability policy and the Misplaced Pages:Identifying reliable sources guideline.

This template is a Citation Style 1 wrapper template based on {{Cite web}}. For centralised Citation Style 1 discussions, see Help talk:Citation Style 1.

Redirect

{{Cite instagram}}

This template is used on approximately 3,900 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

A template for citing content posted on Instagram.

Usage

Copy a blank version to use. Almost all parameter names are supported only in lower case (some initialisms, such as |isbn= have upper-case aliases like |ISBN=, which are acceptable for use). Use the "|" (pipe) character between each parameter. Unused parameters may be deleted to avoid clutter in the edit window. Some samples on this documentation page may include the current date. If the date is not current, then purge the page.

Required parameters only, in horizontal format
{{Cite Instagram \|user= \|postid= \|title= \|date=}}

Full parameter set in horizontal format
{{Cite Instagram \|author= (or \|last= and \|first=) \|author-link= \|user= \|postid= \|date= \|title= \|script-title= \|trans-title= \|language= \|location= \|access-date= \|link= \|url-status= \|archive-url= \|archive-date= \|ref=}}

Full parameter set in horizontal format

{{Cite Instagram |author= (or |last= and |first=) |author-link= |user= |postid= |date= |title= |script-title= |trans-title= |language= |location= |access-date= |link= |url-status= |archive-url= |archive-date= |ref=}}

Note: When known, the author's real name should be specified in the |author= parameter (or |last= and |first=). If their real name is not known, then the post is probably not an acceptable usage of a self-published source.

Examples

{{Cite Instagram |user=instagram |postid=CHDzGgCs568 |date=2 November 2020 |title=Happy Halloween |access-date=9 November 2020}}

@instagram (2 November 2020). "Happy Halloween". Retrieved 9 November 2020 – via Instagram.

Error detection

The parameters |user=, |postid=, |title=, |date= are required. If omitted or left blank, errors will be reported. For example:
{{Cite Instagram |title=I'm an incomplete citation!}}
"I'm an incomplete citation!" – via Instagram. {{Cite Instagram}}: Missing or empty |user= (help); {{Cite Instagram}}: Missing or empty |postid= (help); {{Cite Instagram}}: Missing or empty |date= (help)
The post URL depends on |postid=; if it is missing, the URL defaults to https://www.instagram.com/
Templates are checked for |ref=harv, which is an error. The |ref= parameter must use {{harvid}} in the value.
The template also checks for parameters that are unsupported (e.g. misspellings of parameter names).
Errors are tracked in Category:Cite instagram templates with errors

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Cite Instagram in articles based on its TemplateData.

TemplateData for Cite Instagram

A template for citing content posted on Instagram

Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
Post ID	`postid`	Alpha-numeric ID of the post Example CHDzGgCs568	Line	required
Username	`user`	Instagram account name, without the @ Example instagram	Line	required
Post	`title`	Partial or entire content of the post, optionally including hashtags (#), at signs (@), and links. Note: double quote marks (") should be replaced with single quote marks (') because the entire title will display surrounded by double quotes. Example Happy Halloween	String	required
First name	`first`	The first name of the author. If not known, then the post is probably not an acceptable usage of a self-published source (see WP:SPS) Example Sammy	Line	suggested
Last name	`last`	The last name of the author. If not known, then the post is probably not an acceptable usage of a self-published source (see WP:SPS) Example Smith	Line	suggested
Author	`author`	Author's real name, if known. If not known, then the post is probably not an acceptable usage of a self-published source (see WP:SPS) Example Wikimedia Foundation	Line	suggested
Author's article	`author-link` `authorlink`	Title of existing Misplaced Pages article about the author Example Instagram	Page name	optional
Date	`date`	Date of the post; do not wikilink; do not include time.	Date	required
Access date	`access-date` `accessdate`	The full date when the post was accessed; do not wikilink	Date	optional
Language	`language`	The language in which the post is written, if not in English. Example fr	Line	optional
Location	`location`	The location from which a post was sent. Example London	Line	optional
Archive URL	`archive-url` `archiveurl`	The URL of an archived copy of a web page, if or in case the URL becomes unavailable; requires 'archive-date'	URL	optional
Archive date	`archive-date` `archivedate`	Date when the original URL was archived; do not wikilink	String	optional
URL status	`url-status` `dead-url` `deadurl`	If set to 'live', the title displays as the live link; if set to dead, the title displays as the archive link Suggested values `dead` `live` `deviated` `unfit` `usurped` Default dead (when Archive URL given)	Line	optional
Script post	`script-title`	For post in languages that do not use a Latin-based alphabet (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, Vietnamese, etc). Prefix with two-character ISO639-1 language code followed by a colon, e.g. for Japanese use: ja:... Example ja:東京タワー	String	optional
Translated post	`trans-title`	An English language translation, if the post cited is in a foreign language; use of 'language' parameter is recommended	String	optional
Link to Instagram article?	`link`	Set to "no" to not link to the Misplaced Pages article for Instagram. Useful for preventing overlinking when more than one post is cited. Suggested values `no` Default yes Example no	Line	optional
Date format	`df`	Valid values: dmy, dmy-all, mdy, mdy-all Suggested values `dmy` `dmy-all` `mdy` `mdy-all`	Line	optional
Anchor	`ref`	The citation's HTML anchor identifier, when different from its default. To inhibit anchor ID creation, set to "none". Suggested values `none`	Line	optional

Latest revision as of 15:20, 26 December 2024

Usage

Examples

Error detection

TemplateData

See also