Saintapedia

Template:Portal-inline/doc

< Template:Portal-inline
icon 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.

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.

  1. REDIRECT Template:Blockquote

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=small to show a 23x20 image or |size=tiny for a 17×15 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.
  • nowrap— optional; Specify |nowrap=yes to prevent the entire output from wrapping.

Examples

Using only the name parameter

  • Code: {{Portal-inline|Canada}}
  • Produces: Script error: No such module "portal-inline".

Using the name and size parameters

  • Code: {{Portal-inline|Canada|size=tiny}}
  • Produces: Script error: No such module "portal-inline".

Using the name and text parameters

  • Code: {{Portal-inline|Canada|text=Canadian portal}}
  • Produces: Script error: No such module "portal-inline".

Using the name and short parameters

  • Code: {{Portal-inline|Canada|short=yes}}
  • Produces: Script error: No such module "portal-inline".

Right align element

File:Portal-puzzle.png Canada 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:
  • Script error: No such module "portal-inline".
  • Script error: No such module "portal-inline".

Right align element

File:Portal-puzzle.png Canada portal
File:Portal-puzzle.png Feminism 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

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 for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Portal-inline in articles based on its TemplateData.

TemplateData for 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 17px image, or "small" to show a 23px image, instead of the usual size.

Suggested values
tiny, small
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

Main portal creation templates
  • {{Box portal skeleton}} - 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 portal component with nominate}} - Used on the portal main page to randomly display articles from the portal sub-pages, adding the option to nominate other Featured foo articles.
  • {{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.
  • {{Subpage}} - Used to output a box containing a link to subpage.
  • {{Numbered subpages}} - Used to create article links on portal sub-pages with 50 links.
  • {{Random box-header subpage}} - Used to transclude a numbered subpage.
Main portal page formatting templates
3
The unnamed parameter 2= is no longer supported. Please see the documentation for {{columns-list}}.
Templates that configure links
3
The unnamed parameter 2= is no longer supported. Please see the documentation for {{columns-list}}.
These templates are used to format the articles on the sub-pages

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

3
The unnamed parameter 2= is no longer supported. Please see the documentation for {{columns-list}}.
Related templates

This box: view · talk · edit


Retrieved from "https://saintapedia.org/w/index.php?title=Template:Portal-inline/doc&oldid=12574"