Template:Portal-inline/doc

From wikiNonStop

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.

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:

Using the name and size parameters

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

Using the name and text parameters

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

Using the name and short parameters

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

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:

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

Update this page

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"

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Portal-inline

Produce an inline link to a portal with an image.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
11

Name of the portal to link to.

Example
Science
Page namerequired
Sizesize

Set to "tiny" to show a 16×16 image instead of the usual size.

Example
tiny
Stringoptional
Texttext

Show a different name instead of the portal name.

Example
Portal of science
Stringoptional
Shortshort

Set to any value to exclude "portal" from the output.

Example
yes
Booleanoptional
Red linksredlinks

Set to "yes" to show the portal even if it is redlinked.

Example
yes
Booleanoptional

See also

This box: view · talk · edit Portal content templates

Main portal page formatting templates

Templates that configure links

Selected page templates, used on subpages of older portals

Related templates


Retrieved from "https://compusofia.com/w/index.php?title=Template:Portal-inline/doc&oldid=28041"