Ta‌̱mpi‌̱let:Portal-inline/doc

This is a documentation subpage for Ta‌̱mpi‌̱let:Portal-inline.
It contains usage information, categories and other content that is not part of the original ta‌̱mpi‌̱let page.

This template is used on approximately 210,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

Template:Portal-inline is used to produce an inline link to a portal 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. Ta‌̱mpi‌̱let:Quotation

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: Ghyuap a̱si̱ Lua: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal')

Using the name and size parameters

Code: {{Portal-inline|Canada|size=tiny}}
Produces: Ghyuap a̱si̱ Lua: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal')

Using the name and text parameters

Code: {{Portal-inline|Canada|text=Canadian portal}}
Produces: Ghyuap a̱si̱ Lua: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal')

Using the name and short parameters

Code: {{Portal-inline|Canada|short=yes}}
Produces: Ghyuap a̱si̱ Lua: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal')

Right align element

Ghyuap a̱si̱ Lua: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal') 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:
Ghyuap a̱si̱ Lua: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal')
Ghyuap a̱si̱ Lua: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal')

Right align element

Ghyuap a̱si̱ Lua: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal') 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

Ta‌̱mpi‌̱let:Purge button 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:

Tracking is specially disabled for that usage. This is done by setting the optional parameter |tracking= to any the following values: no, n, false
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
The title page on which the template is used includes any of the following case-insensitive strings: "/archive", "/doc", "/test"

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Portal-inline

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