Template:Portal-inline/doc

Jump to navigation Jump to search

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

Differences between {{Portal}} and {{Portal-inline}}[edit source]

{{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[edit source]

  • {{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[edit source]

  • 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[edit source]

Using only the name parameter[edit source]

  • Code: {{Portal-inline|Sexuality}}
  • Produces:

Using the name and size parameters[edit source]

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

Using the name and text parameters[edit source]

  • Code: {{Portal-inline|Sexuality|text=Sex portal}}
  • Produces:

Using the name and short parameters[edit source]

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

Lists[edit source]

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|Name}}
* {{Portal-inline|Name}}

Image[edit source]

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[edit source]

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, Starfleet Logistics 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"
Purge page to update totals

See also[edit source]

External links[edit source]

 
This box:

Main portal creation templates

  • {{Basic portal start page}} (deleted)—Used to create portal main pages.
  • {{Random portal component}}—Used on the portal main page to randomly display articles from the portal sub-pages.
  • {{Random subpage}}—Used on the portal main page to randomly display articles from the portal sub-pages. This template is best used for creating randomly populated Did you know... sections on the portal main page that are intended to include multiple Did you know... facts.
  • {{Portal subpage}}—Used to output a box containing a link to subpage.
  • {{Numbered subpages}}—Used to create article links on portal sub-pages.
  • {{Random box-header subpage}}—Used to transclude a numbered subpage.

Main portal page formatting templates

Templates that configure links

These templates are used to format the articles on the sub-pages

{{Selected X}}—Generic template for situations not listed hereafter.

Related templates

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