Template:Subject bar/doc
This is a documentation subpage for Template:Subject bar. It contains usage information, categories and other content that is not part of the original template page. |
40px | This template is used on approximately Template:Significant figures/rnd pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
30px | Uses Lua: {{safesubst:#invoke:list|bulleted}} |
This navigational template offers a variant to several floating box templates that link to portals, and Wikipedia's sister projects but also typically cause formatting issues because of their size and alignment.
It is intended to be placed at the end of an article, after the references, external links, navboxes and before any authority control template or categories.
Contents
Usage
No single parameter is required, however, at least one portal or sister project should be utilized with the use of this template. Since Wikipedia articles typically are in the domain of one or more WikiProjects, and since WikiProjects often have a portal, almost every article should list at least one portal. None of the parameters should be capitalized.
Parameters
When copying all parameters in either the vertical or horizontal layouts, delete those which are not needed. If no links are needed for a particular type, such as the historical "books", that part of the template will not appear on the page.
Parameter meanings (quick list). Alphabetical order: b: Wikibooks. commons: WikiMedia Commons. d: Wikidata. n: Wikinews. q: Wikiquote. s: Wikisource. species: Wikispecies. v: Wikiversity. voy: Wikivoyage. wikt: Wiktionary.
- All parameters, horizontal. Parameters in order they show up in subject bar.
-
{{Subject bar|commons = y|species = y|voy = y|n = y|wikt = y|b = y|q = y|s = y|v = y|d = y|portal = }}
- All parameters, horizontal. In alphabetical order, except for
portal
which is often removed. -
{{Subject bar|b = |commons = |d = |n = |q = |s = |species = |v = |voy = |wikt = |portal = }}
- All parameters, vertical. In alphabetical order, except for
portal
which is often removed.
{{Subject bar |b = |commons = |d = |n = |q = |s = |species = |v = |voy = |wikt = |portal = }}
Parameters explained
- b
- Wikibooks page to link to, "yes" means use wikidata to search for page
- commons
- WikiMedia Commons page (or Category:) to link to, "yes" means use wikidata to search for page
- d
- Wikidata page to link to, "yes" means use wikidata to search for page
- n
- Wikinews page to link to, "yes" means use wikidata to search for page
- q
- Wikiquote page to link to, "yes" means use wikidata to search for page
- s
- Wikisource page (or Author:) to link to, "yes" means use wikidata to search for page
- species
- Wikispecies page to link to, "yes" means use wikidata to search for page
- v
- Wikiversity page to link to, "yes" means use wikidata to search for page
- voy
- Wikivoyage page to link to, "yes" means use wikidata to search for page
- wikt
- Wiktionary page to link to, "yes" means use wikidata to search for page
Other parameters
- portal
- Use
portal###
where ### is any number to link to a portal - auto
- set
|auto=1
to use Wikidata to find sister links - search
- override default search string (= title of page)
- display
- set the display string on the sister links bar
- commonscat
- link to Commons category instead of gallery
- author
- link to Species author instead of taxon
Note: positional arguments are interpreted as portals, will be appended after any named portal arguments.
Examples
Example. Simplest.
auto=1: try this first to look sister project links up in wikidata
- Markup
-
{{Subject bar|auto=1}}
- Result (if used on Lemur)
{{#invoke:subject bar|main}}
Example page: Lemur
- Markup
-
{{Subject bar|commons= Category:Lemuriformes|species = Lemuriformes|portal1 = Primates|portal2 = Madagascar}}
- Result
{{#invoke:subject bar|main}}
Example page: Ring-tailed lemur
- Markup
-
{{Subject bar|portal1 = Primates|portal2 = Madagascar|commons = Category:Lemur catta |species = Lemur catta|n = Ring-tailed lemur|wikt = Lemur|b = Ring-tailed lemur|q = Ring-tailed lemur|s = Ring-tailed lemur|v = Ring-tailed lemur|voy = Madagascar}}
- Result
{{#invoke:subject bar|main}}
Portal bar
{{Portal bar}} is a subset of {{Subject bar}}, where only positional arguments are allowed. For example:
- Markup
-
{{Portal bar|COVID-19|Medicine|Viruses}}
- Result
{{#invoke:Portal bar|main}}
See also
- Wikipedia:Template messages/Sister projects
- {{Commons}}
- {{Commons category}}
- {{Commons category multi}}
- {{Commons and category}}
- {{Commons-inline}}
- {{Commons category-inline}}
- {{Portal}}
- {{Portal bar}}
- {{Sister project links}}
- {{Cross-wiki user}}
TemplateData
TemplateData documentation used by VisualEditor and other tools |
---|
See the monthly error report for this template. TemplateData for Subject bar <templatedata> { "params": { "portal1": { "required": false, "type": "string/line", "aliases": ["1"], "description": "The first portal, without surrounding text. For example, use \"Science\" to display the science portal." }, "portal2": { "type": "string/line", "aliases": ["2"], "description": "The second portal." }, "portal3": { "type": "string/line", "aliases": ["3"], "description": "The third portal." }, "portal4": { "type": "string/line", "aliases": ["4"], "description": "The fourth portal" }, "portal5": { "type": "string/line", "aliases": ["5"], "description": "The fifth portal." }, "auto": { "label": "Use wikidata to fill sister link defaults", "type": "string", "required": false, "description": "If auto=\"yes\", then sister projects with wikidata sitelinks are filled-in, others are off by default. Each project can be overridden with its own parameter." }, "display": { "label": "Display name", "type": "string", "required": false, "description": "Use if the display name is different from the search term. For example, the bear article would be 'Bears'." }, "search": { "label": "Search string", "type": "string", "required": false, "description": "String to search in sister projects.", "default": "Page title" }, "commonscat": { "label": "Commons category", "type": "string", "required": false, "description": "Use if link to Commons category is desired instead of gallery." }, "author": { "label": "Wikispecies author", "type": "string", "required": false, "description": "Use if link to Wikispecies author is desired instead of taxon." }, "wikt": { "label": "Wiktionary link", "type": "string", "required": false, "description": "Wiktionary link to show. Acceptable values are a page name, \"yes\" (find page automatically) and \"no\".", "aliases": ["wikt-search"], "default": "No" }, "commons": { "label": "Commons link", "type": "string", "required": false, "description": "Commons link to show. Acceptable values are a page name, \"yes\" (find page automatically) and \"no\".", "aliases": ["c", "c-search", "commons-search"], "default": "No" }, "n": { "label": "Wikinews link", "type": "string", "required": false, "description": "Wikinews link to show. Acceptable values are a page name, \"yes\" (find page automatically) and \"no\".", "aliases": ["n-search"], "default": "No" }, "q": { "label": "Wikiquote link", "type": "string", "required": false, "description": "Wikiquote link to show. Acceptable values are a page name, \"yes\" (find page automatically) and \"no\".", "aliases": ["q-search"], "default": "No" }, "s": { "label": "Wikisource link", "type": "string", "required": false, "description": "Wikisource link to show. Acceptable values are a page name, \"yes\" (find page automatically) and \"no\".", "aliases": ["s-search"], "default": "No" }, "b": { "label": "Wikibooks link", "type": "string", "required": false, "description": "Wikibooks link to show. Acceptable values are a page name, \"yes\" (find page automatically) and \"no\".", "aliases": ["b-search"], "default": "No" }, "voy": { "label": "Wikivoyage link", "type": "string", "required": false, "description": "Wikivoyage link to show. Acceptable values are a page name, \"yes\" (find page automatically), and \"no\".", "aliases": ["voy-search"], "default": "No" }, "v": { "label": "Wikiversity link", "type": "string", "required": false, "description": "Wikiversity link to show. Acceptable values are a page name, \"yes\", (find page automatically) and \"no\".", "aliases": ["v-search"], "default": "No" }, "d": { "label": "Wikidata link", "type": "string", "required": false, "description": "Wikidata link to show. Acceptable values are a QID, \"yes\" (find page automatically), and \"no\".", "aliases": ["d-search"], "default": "No" }, "species": { "label": "Wikispecies taxon link", "type": "string", "required": false, "description": "Wikispecies link to show. Acceptable values are a page name, \"yes\" (find page automatically), and \"no\". The default is \"No\".", "aliases": ["species-search"], "default": "No" } }, "description": "This template adds a bar of portals and sister links. It is usually used just above an article's navboxes." } </templatedata> |