Template:Portal-inline/doc

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

Differences between and
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.

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

Parameters

 * — required; The first unnamed/positional parameter is the name of the portal.
 * — optional; Specify  to show a 16×16 image instead of the usual size.
 * — optional; Specify  for a different associated name to appear.
 * — optional; Specify  to remove portal from the output.
 * — optional; Specify  to show the portal if it is redlinked.

Using only the name parameter

 * Code:
 * Produces:

Using the name and size parameters

 * Code:
 * Produces:

Using the name and text parameters

 * Code:
 * Produces:

Using the name and short parameters

 * Code:
 * Produces:

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.



Image
The portal image name is found using Module:Portal. Please see Module:Portal 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: ,  ,
 * 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 more than one portal parameter (population: )
 * Category:Portal-inline template with redlinked portals (population: )
 * Category:Portal-inline template without a parameter (population: )
 * Category:Portal templates with all redlinked portals (population: )
 * Category:Portal templates with redlinked portals (population: )
 * Category:Portal templates without a parameter (population: )

TemplateData
{	"params": { "1": {			"description": "Name of the portal to link to.", "example": "Science", "type": "wiki-page-name", "required": true },		"size": { "label": "Size", "description": "Set to \"tiny\" to show a 16×16 image instead of the usual size.", "example": "tiny", "type": "string" },		"text": { "label": "Text", "description": "Show a different name instead of the portal name.", "example": "Portal of science", "type": "string" },		"short": { "label": "Short", "description": "Set to any value to exclude \"portal\" from the output.", "example": "yes", "type": "boolean" },		"redlinks": { "label": "Red links", "description": "Set to \"yes\" to show the portal even if it is redlinked.", "example": "yes", "type": "boolean" }	},	"description": "Produce an inline link to a portal with an image.", "format": "inline" }