Merc: 1 revision imported

2025-05-04T08:32:17Z

1 revision imported

← Older revision	Revision as of 08:32, 4 May 2025
(No difference)

wikipedia>Jonesey95: make doc consistent with similar templates

2025-04-15T15:39:51Z

make doc consistent with similar templates

New page

{{Documentation subpage}}
{{High-use}}
{{Lua|Module:Commons link}}
This template relies on [[Template:Sister-inline]].

==Purpose==
This template can be used to generate a link to a page containing media related to a [[commons:Commons:Categories|Commons category]]. It is intended for use in the "[[WP:LAYOUTEL|External links]]" section of an article.

==Usage==
<syntaxhighlight lang="wikitext">
* {{Commons-inline|Commons-gallery-page-name}}
</syntaxhighlight>
Commons gallery page name is optional; if missing, the template will look up the associated gallery in Wikidata. If that's missing, it will find the associated category. If that's missing, it will finally fall back to a Commons search.

; Full syntax
<syntaxhighlight lang="wikitext">
* {{Commons-inline
|list= wikitext for a list
|links= wikitext to override default link
|Commons-gallery-page-name=
|extratext= extra text
|search= string to search in Commons
|notrack= turn off tracking categories
|italic= italicize link text
}}
</syntaxhighlight>

==Examples==
; Normal
<syntaxhighlight lang="wikitext">* {{Commons-inline|Work}}</syntaxhighlight>
* {{Commons-inline|Work}}

; Text override
Work is the link target and Puffle is the link label.
<syntaxhighlight lang="wikitext">* {{Commons-inline|Work|Puffle}}</syntaxhighlight>
* {{Commons-inline|Work|Puffle}}<br>

; Full link override
<syntaxhighlight lang="wikitext">* {{Commons-inline|links=[[commons:Foo|]] and [[commons:Bar|]]}}</syntaxhighlight>
* {{Commons-inline|links=[[commons:Foo|Foo]] and [[commons:Bar|Bar]]}}

; List format
<syntaxhighlight lang="wikitext">* {{Commons-inline|list=
* [[commons:Foo|Foo]]
* [[commons:Bar|Bar]]
* [[commons:Row|Row]]
* [[commons:Dee|Dee]]
}}</syntaxhighlight>
{{Commons-inline|list=
* [[commons:Foo|Foo]]
* [[commons:Bar|Bar]]
* [[commons:Row|Row]]
* [[commons:Dee|Dee]]
}}

; Another list format, including Commons templates:
<syntaxhighlight lang="wikitext">* {{Commons-inline|list=
:[[c:Commons:Timed Text|Commons:Timed Text]]
:<nowiki>{{</nowiki>[[Commons:Template:Captions requested|Captions requested]]<nowiki>}}</nowiki>
}}</syntaxhighlight>

* {{Commons-inline|list=
:[[c:Commons:Timed Text|Commons:Timed Text]]
:<nowiki>{{</nowiki>[[Commons:Template:Captions requested|Captions requested]]<nowiki>}}</nowiki>
}}

; Extra text
<syntaxhighlight lang="wikitext">* {{Commons-inline|Work|extratext= Extra text}}</syntaxhighlight>
* {{Commons-inline|Work|extratext= Extra text}}

; Force Commons search
<syntaxhighlight lang="wikitext">* {{Commons-inline|search=Work}}</syntaxhighlight>
* {{Commons-inline|search=Work}}

; Turn off tracking categories (for use inside other templates)
<syntaxhighlight lang="wikitext">* {{Commons-inline|Work|notrack=1}}</syntaxhighlight>
* {{Commons-inline|Work|notrack=1}}

== Tracking categories ==
=== Normal categories ===
* {{clc|Commons link from Wikidata}}
* {{clc|Commons link is on Wikidata}}
=== Maintenance categories ===
* {{clc|Commons link is defined as the pagename}}
* {{clc|Commons link is locally defined}}
* {{clc|Commons link is the pagename}}
* {{clc|Inconsistent wikidata for Commons gallery}}

==See also==
{{Commons templates see also}}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
"params": {
"1": {
"label": "Commons gallery",
"description": "Title of Commons gallery. If empty, looks up relevant gallery or category in Wikidata",
"type": "string"
},
"2": {
"label": "Display text",
"description": "Link text to display. If empty, uses gallery or category title",
"type": "string"
},
"short": {
"description": "Do not display any text, just logo and link",
"type": "boolean",
"default": "false"
},
"list": {
"description": "bulletted list to use instead of generated text",
"type": "content"
},
"links": {
"description": "wikitext to use instead of default links",
"type": "content"
},
"search": {
"description": "If non-empty, string to search for in Commons",
"type": "string"
},
"italic": {
"description": "whether to italicize link text",
"type": "boolean",
"default": "false"
},
"notrack": {
"description": "if true, turn off tracking categories",
"type": "boolean",
"default": "false"
},
"extratext": {
"description": "Extra text to add after normal template result",
"type": "content"
}
},
"description": "Add an inline link to Commons gallery or category related to article",
"paramOrder": [
"1",
"2",
"italic",
"notrack",
"links",
"list",
"extratext",
"short",
"search"
],
"format": "inline"
}
</templatedata>

<includeonly>{{Sandbox other||

[[Category:Inline interwiki link templates]]
[[Category:Wikimedia Commons templates]]
}}</includeonly>

Template:Commons-inline/doc - Revision history

Merc: 1 revision imported

wikipedia>Jonesey95: make doc consistent with similar templates