 | This is thetemplate sandbox page forTemplate:Portal (diff). See also the companion subpage fortest cases. |
 | This template is used onapproximately 10,600,000 pages, or roughly 16% of all pages. To avoid major disruption and server load, any changes should be tested in the template's/sandbox or/testcases subpages, or in your ownuser subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on thetalk page before implementing them. |
 | This template usesLua: |
This template produces a box with links to aportal or to multiple portals. It is most often used in the "See also" section of an article.If a portal does not exist, then it will not be displayed. As of December 11, 2021 (UTC), this portal template is now mobile-friendly, meaning that the portal links will appear on mobile devices.
Basic usage
{{Portal |Portal 1 |Portal 2 |Portal 3 |... }}Within articles, this template is meant to be placed at the top of the article'sSee also section. If there is noSee also section, you may put it in theExternal links section instead, if other external links are in the article. Do not create an "External links" sectionjust for this box: if there is noExternal links section, consider using{{Portal bar}} at the end of the article. If using{{Portal bar}}, considering combining it with links tosister projects via{{Subject bar}}.
There are no particular rules about the placement of portals on other kinds of pages.
The portal image names are stored in subpages ofModule:Portal/images, organised by the first letter of the portal name. For example, the first letter ofPortal:Feminism is "F", so the image name is stored atModule:Portal/images/f. If there is an entry for a portal on the correct page then the corresponding image will be shown next to the portal link. If no image is found thenFile:Portal-puzzle.svg will be shown instead.
It is also possible to specify aliases for portal images. For example, the code{{Portal|Detroit}} produces the same image as the code{{Portal|Metro Detroit}}. The "Detroit" alias is found on the pageModule:Portal/images/aliases.
The image-detection algorithm is case-insensitive. For example, the code{{Portal|Detroit}} will produce the same image as the code{{Portal|detroit}} (although the portal links will be different). Portal names are stored in lower case in the image subpages, and input is converted to lower case before being checked.
To add new images to the list, pleasemake a protected edit request at Template talk:Portal to get an administrator to edit the correct subpage for you. Portal images must be either in the public domain or available under afree license that allows commercial reuse and derivative works;fair-use images are not acceptable. The template{{Portal icon demonstration}} may be of use when deciding whether an image is suitable for use as a portal icon; it formats an image using the same size and style that the{{Portal}} template uses by default.
A list of portals and aliases of portals without icons can be found atCategory:Portal templates with default image.
List of image subpages | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
The box on the right format with small text can incorporate multiple portals.
Box
{{Portal|Canada}}
{{Portal|Canada|Example}}
Inline format for the left side with normal sized text; SeeTemplate:Portal-inline for a listing of parameters.
Inline
{{Portal-inline|Canada}}.svg)
Canada portalInline format for the right side with normal sized text: SeeTemplate:Portal for more information.
{{Portal|border=no|Canada}}Bar
The bar format is normally used for multiple portals. This template does not belong in the "See also" section. PerMOS:SECTIONORDER, this template is bottom matter and goes below standard navigation templates.
{{Portal bar|Canada|Example|border=no}}
| Name | Value | Description |
|---|---|---|
1,2,3 ... | The portal name, e.g.Literature | The positional parameters specify the portals to be displayed. |
left | yes | If set toyes, the portal appears on the left side of the page instead of the right. |
margin | CSS margin value, e.g.1.2em 3em 0.5em 1em | This allows you to set a custom margin. All valid CSS margin values are accepted. |
break | yes | If set toyes, a line break is inserted after the portal name and before the wordportal. |
redlinks | Any of the following values:yes,y,true, orinclude | Redlinks will be displayed. The default is to suppress redlinks. |
nominimum | Any of the following values:yes,y, ortrue | Suppresses the warning if no parameters are supplied. This can be useful when Template:Portal is called by another template. |
border | Any of the following values:no,n, orfalse | Turn off border and background |
tracking | Any of the following values:no,n,false | Tracking categories will be suppressed. The default is to use tracking categories, except on certain namespaces and on pagenames which contain "/archive", "/doc" or "/test". |
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= to any the following values:no,n,falsePortal content templates
Main portal page formatting templates
Templates that configure links
Selected page templates, used on subpages of older portals
Related templates
TemplateData documentation used byVisualEditor and other tools | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
See a monthly parameter usage report forTemplate:Portal in articles based on its TemplateData. TemplateData for Portal A template to create a list of portals
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{{reply to}} one or more of theprevious editors.