Module:Commons link/doc

icon This is a documentation subpage for Module:Commons link.
It may contain usage information, categories and other content that is not part of the original module page.

This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.

Warning This Lua module is used on approximately 297,000 pages .
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This module depends on the following other modules:

Usage

{{#invoke:Commons link|getGallery}}

Use wikidata to find Commons gallery corresponding to this article. If unable to find gallery in wikidata, default to searching for PAGENAME in Commons.

{{#invoke:Commons link|getGallery|title|linktext=text}}

Link to Commons gallery at title. Optionally, use text as displayed link text.

{{#invoke:Commons link|getGallery|search=string|linktext=text}}

Link to Commons search for string. Optionally, use text as displayed link text.

{{#invoke:Commons link|getCategory|fallback=string|linktext=text}}

Use wikidata first, then if failure, use Commons search for string. Optionally, use text as displayed link text.

{{#invoke:Commons link|getCategory}}

Use wikidata to find Commons category corresponding to this article. If unable to find category in wikidata, default to searching for Category:PAGENAME in Commons.

{{#invoke:Commons link|getCategory|title|linktext=text}}

Link to Commons category at Category:title. Optionally, use text as displayed link text.

{{#invoke:Commons link|getCategory|search=string|linktext=text}}

Link to Commons search for Category:string. Optionally, use text as displayed link text.

{{#invoke:Commons link|getCategory|fallback=string|linktext=text}}

Use wikidata first, then if failure, use Commons search for Category:string. Optionally, use text as displayed link text.

{{#invoke:Commons link|getGalleryOrCategory}}

Use wikidata to find "best" single Commons link: try gallery first, fall back to category. Other arguments as above.

{{#invoke:Commons link|getGalleryAndCategory}}

Lua to implement {{commons and category }}: return Commons gallery, Commons category, or both (if both found)

{{#invoke:Commons link|getGalleryAndCategory|GalleryName|CategoryName}}

Either GalleryName or CategoryName or both can be supplied, will override wikidata search

{{#invoke:Commons link|bold=1|italic=1|nowrap=1|lcfirst=1}}

Format of first link can be specified (any combination of bold, italic, nowrap, and lower-case first character)

{{#invoke:Commons link|linktext=link|categoryText=category}}

Text in the first link, and the second (category) link can be overridden, also.

{{#invoke:Commons link|tracking=1}}

Module can generate tracking categories for mismatch between supplied arguments and Wikidata.

Retrieved from "https://en.wikipedia.org/w/index.php?title=Module:Commons_link/doc&oldid=1022927453"