Template:Portal/doc
 | This is a documentation subpage for Template:Portal. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on 9,340,000+ pages, or roughly 135677% 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 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. |
 | This template uses Lua: |
This template is used to produce a link in a box to a portal or portals.
This template can be used to add multiple portal links to the "See also" section of an article.
Usage
- Basic usage
{{Portal |Portal 1 |Portal 2 |Portal 3 |... }}
- All options
{{Portal
| Portal 1
| Portal 2
| Portal 3
| ...
| left = <!-- yes -->
| margin = <!-- CSS margin -->
| break = <!-- yes -->
| boxsize = <!-- custom box width in pixels -->
}}
Location
Within articles, this template is meant to be placed at the bottom of the article in the See also section.
Image
There is a list of portal images at Module:Portal/images. If the portal name is listed on that page then the corresponding image will be shown. It is also possible to specify aliases for portal images. If no image is found then File:Portal-puzzle.svg will be shown instead. To add new images to the list, read the instructions at Module:Portal/images and then use a protected edit request to get an administrator to edit the page for you.
Example
| Code |
Result |
|---|---|
{{Portal|Science}}
|
Parameters
| Name | Value | Description |
|---|---|---|
1, 2, 3 ... |
The portal name, e.g. Literature |
The positional parameters specify the portals to be displayed. An unlimited number are allowed. |
left |
yes |
If set to yes, 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 to yes, a line break is inserted after the portal name and before the word portal.
|
boxsize |
Size in pixels, e.g. 300 |
This sets a custom box width in pixels. |
Maintenance
The following tracking category lists instances where the template is used incorrectly:
TemplateData
TemplateData for Portal
A template to create a list of portals
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Portal (1) | 1 | Inserts the portal image and text. Further portals can be added to the template by increasing the number | String | required |
| Portal (2) | 2 | Insert the portal image and text | String | optional |
| Portal (3) | 3 | Insert the portal image and text | String | optional |
| Side | left | If set to yes, the portal appears on the left side of the page instead of the right.
| String | optional |
| Margin size | margin | Alters the margin size. Any valid CSS margin is accepted | Number | optional |
| Line break | break | If set to yes, a line break is inserted after the portal name and before the word portal | String | optional |
| Box size | boxsize | This sets a custom box width in pixels. | Number | optional |
See also
