Template:Portal-inline/doc

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

This template is used on approximately 225,000 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:Portal-inline (sandbox)

Template:Portal-inline is used to produce an inline link to a

that is supported by print and mobile versions of Wikipedia pages.

Differences between {{Portal}} and {{Portal-inline}}

{{Portal}} creates a list of one or more portal links within an accessible navigation region. It is hidden in printer and mobile view. This is useful, for example, in an article's "See also" section.

{{Portal-inline}} creates one portal link with no accessibility context. It is visible in printer and mobile view. This is useful, for example, if making a mid-sentence link on a talk page, or if there is an alternative list structure in a "See also" section.

• Mobile version of Template:Portal-inline/doc
• Desktop version of Template:Portal-inline/doc

Usage

• {{Portal-inline|<name> }}
• {{Portal-inline|<name> [|size= <size> ] [|text= <text> ] [|short= <anything> ]}}

Everything inside square brackets is optional, do not include the square brackets.

Parameters

• 1 — required; The first unnamed/positional parameter is the name of the portal.
• size— optional; Specify |size=tiny to show a 16×16 image instead of the usual size.
• text— optional; Specify |text=(name) for a different associated name to appear.
• short— optional; Specify |short=anything to remove portal from the output.
• redlinks— optional; Specify |redlinks=yes to show the portal if it is redlinked.

Examples

Using only the name parameter

• Code: {{Portal-inline|Canada}}
• Produces:  Canada portal

Using the name and size parameters

• Code: {{Portal-inline|Canada|size=tiny}}
• Produces:  Canada portal

Using the name and text parameters

• Code: {{Portal-inline|Canada|text=Canadian portal}}
• Produces:  Canadian portal

Using the name and short parameters

• Code: {{Portal-inline|Canada|short=yes}}
• Produces:  Canada

Right align element

See: {{Portal|border=no}}

Lists

In an article's "See also" section, to generate an accessible list of portal links, use {{portal}}. If a different list structure is preferred, prefix each {{portal-inline}} with an asterisk.

* {{Portal-inline|Canada}}
* {{Portal-inline|Feminism}}

• Produces:
•  Canada portal
•  Feminism portal

Right align element

See {{Portal|border=no}}

Image

The portal image name is found using Module:Portal. Please see Module:Portal#Image for instructions on how to add, update, or remove an image.

Error tracking

If the template is used incorrectly, the page will be added to a tracking category.

The tracking categories are not applied if any of the following is true:

1. Tracking is specially disabled for that usage. This is done by setting the optional parameter |tracking= to any the following values: no, n, false
2. the template is used on a page in any of these namespaces: Talk, User, User talk, Wikipedia talk, File talk, Template talk, Category talk, Portal talk, Draft, Draft talk, Module talk
3. The title page on which the template is used includes any of the following case-insensitive strings: "/archive", "/doc", "/test"

• Category:Portal-inline template with too few portals (0)
• Category:Portal-inline template with too many portals (0)
• Category:Portal-inline template with redlinked portals (0)
• Category:Pages with empty portal template (5)

TemplateData

Produce an inline link to a portal with an image.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
1	1	Name of the portal to link to. Example Science	Page name	required
Size	size	Set to "tiny" to show a 16×16 image instead of the usual size. Example tiny	String	optional
Text	text	Show a different name instead of the portal name. Example Portal of science	String	optional
Short	short	Set to any value to exclude "portal" from the output. Example yes	Boolean	optional
Red links	redlinks	Set to "yes" to show the portal even if it is redlinked. Example yes	Boolean	optional

See also

• Template:Subject bar

Portal content templates

• To display "selected content" on the portal main page
  • {{
    recognized content lists
    , which are populated by a bot.
  • {{Transclude random subpage}}—transcludes random portal subpage.
  • {{Random portal component}}—transcludes random portal subpage.
  • {{Random subpage}}—transcludes random portal subpages.
  • {{Portal pictures}}—transcludes a slideshow of pictures, utilizing a single-page gallery.
• To organize "selected content" on subpages
  • {{Numbered subpages}}—outputs an automatic index, transcluding numbered subpages.
  • {{Portal subpage}}—outputs a box linking to and transcluding a single subpage.
  • {{Portal subpage inline}}—outputs an unordered list item linking to and transcluding a single subpage.

Main portal page formatting templates

Templates that configure links

Selected page templates, used on subpages of older portals

Related templates

• {{Project template list}}