Template:Portal-inline/doc
This is a documentation subpage for Template:Portal-inline. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 214,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. Transclusion count updated automatically (see documentation). |
This template uses Lua: |
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.
- Mobile version of Template:Portal-inline/doc
- Desktop version of Template:Portal-inline/doc
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
Template: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"
- Category:Portal-inline template with too few portals (0)
- Category:Portal-inline template with too many portals (0)
- Category:Portal-inline template with redlinked portals (0)
- Category:Pages with empty portal template (0)
TemplateData
TemplateData for Portal-inline
Produce an inline link to a portal with an image.
Parameter | Description | Type | Status | |
---|---|---|---|---|
1 | 1 | Name of the portal to link to.
| Page name | required |
Size | size | Set to "tiny" to show a 16×16 image instead of the usual size.
| String | optional |
Text | text | Show a different name instead of the portal name.
| String | optional |
Short | short | Set to any value to exclude "portal" from the output.
| Boolean | optional |
Red links | redlinks | Set to "yes" to show the portal even if it is redlinked.
| Boolean | optional |
See also
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
- {{Box-header}}
- {{Box-header-plain}}
- {{Box-header-round}}
- {{Box-header-square}}
- {{Box-header-watch}}
- {{Box-footer}}
Templates that configure links
- {{Portal}}
- {{Portal bar}}
- {{Portal-inline}}
- {{Portals}}
- {{Portal-image}}
- {{Portals browsebar}}
- {{Related portals}}
- {{Related portals2}}
- {{Wikimedia for portals}}
Selected page templates, used on subpages of older portals
- {{Selected article}}
- {{Selected biography}}
- {{Selected business}}
- {{Selected DYK}}
- {{Selected ingredient}}
- {{Selected location}}
- {{Selected picture}}
- {{Selected product}}
- {{Selected publication}}
- {{Selected quote}}
- {{Selected recipe}}
- {{Selected X}}
Related templates