Template:Catalog lookup link/doc

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

This template is used on approximately 516,000 pages, or roughly 1330% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Catalog lookup link

This template uses TemplateStyles:

Module:Citation/CS1/styles.css (sandbox)

This generic link template is used by other more specific templates to create short links to ID-based entries in external databases or catalogs, however, it can also be used to link to internal articles. The purpose of this template is to ensure a consistent appearance and easier maintenance of links to external databases/catalogs.

The template supports up to 9 unnamed parameters for the ID entries as well as a number of optional named parameters to adjust the link format to the target database and to modify the display format to make it suitable for as many catalog links as possible.

While additional format options might be provided in the future, the default output should always remain a short, but clear and unobtrusive single-line format suitable for inclusion as argument of the |id= parameter of the various {{citation}} templates. Typically, the template is not used directly, but indirectly called through other more specific templates (like those listed below under See also).

Parameters

|1=, |2=, |3=, |4=, |5=, |6=, |7=, |8=, |9=: Optional unnamed parameters for 0 to 9 items to be listed. Whitespace is trimmed off both ends and the strings are urlencoded as if they were query strings.
|article-link=: Optional Wikipedia article name to link to.
|article-name=: Optional alternative text to be displayed for |article-link= link in front of catalog link. If not specified, |article-link= is used for display as well. If both parameters are not specified, the prefix is omitted completely.
|article-suffix=: Optional symbol to be displayed after article name or link (f.e. ":"; omitted, if not defined).
|link-prefix=: Optional prefix portion of url to external catalog item(s).
|link-suffix=: Optional suffix portion of url to external catalog item(s).

|item-prefix=: Optional text displayed in front of each external link (omitted, if not defined)
|item-suffix=: Optional text displayed immediately after each external link (omitted, if not defined)
|list-separator=: Optional alternative separator displayed between list items (default: ", ", if not specified). Whitespace must be encoded.
|list-leadout=: Optional alternative leadout text displayed between the last two list items (f.e. "and", "or", "as well as", etc., default is the |list-separator= or ", ".)

|leadout-suffix=: Optional alternative suffix text of the leadout (see |list-leadout=) displayed between the last two list items. This gets added in front of the last list item instead of the default whitespace which is added without this parameter. This may be necessary if |list-separator= is used not only to define the list separator but also parts of the item prefix (except for the first one). (At present, this is used only to cope with format oddities of the {{MR}} template.)

|url-access1=, |url-access2=, ... |url-access9=, |url-access-all=: See Help:Citation Style 1 § Registration or subscription required.

Examples

The following examples do not reflect actual usage examples and are provided here mostly for quick output format checking. For actual usage examples, please study the templates listed further down under See also.

Example 1 (article-link and article-name):

{{Catalog lookup link|1|2|3|4|5|6|7|8|9|article-link=Wikipedia|article-name=WP|link-prefix=//en.wikipedia.org/wiki/}}

WP 1, 2, 3, 4, 5, 6, 7, 8, 9

Example 2 (only article-link):

{{Catalog lookup link|1|2|3|4|5|6|7|8|9|article-link=Wikipedia|link-prefix=//en.wikipedia.org/wiki/}}

Wikipedia 1, 2, 3, 4, 5, 6, 7, 8, 9

Example 3 (only article-name):

{{Catalog lookup link|1|2|3|4|5|6|7|8|9|article-name=WP|link-prefix=//en.wikipedia.org/wiki/}}

WP 1, 2, 3, 4, 5, 6, 7, 8, 9

Example 4 (neither article-link nor article-name):

{{Catalog lookup link|1|2|3|4|5|6|7|8|9|link-prefix=//en.wikipedia.org/wiki/}}

1, 2, 3, 4, 5, 6, 7, 8, 9

Example 5 (with article-suffix, item-prefix, item-suffix, link-suffix):

{{Catalog lookup link|1|2|3|4|5|6|7|8|9|article-link=Wikipedia|article-name=WP|article-suffix=:|link-prefix=//en.wikipedia.org/wiki/|link-suffix=#hash|item-prefix=<|item-suffix=>}}

WP: <1>, <2>, <3>, <4>, <5>, <6>, <7>, <8>, <9>

Example 6 (without link-prefix, with article-suffix, item-prefix, item-suffix):

{{Catalog lookup link|1|2|3|4|5|6|7|8|9|article-link=Wikipedia|article-name=WP|article-suffix=:|item-prefix=<|item-suffix=>}}

WP: <1>, <2>, <3>, <4>, <5>, <6>, <7>, <8>, <9>

Example 7 (list-leadout, list-separator):

{{Catalog lookup link|1|2|3|4|5|6|7|8|9|list-leadout=and|list-separator= / |article-link=Wikipedia|article-name=WP|link-prefix=//en.wikipedia.org/wiki/}}

WP 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 and 9