Template:Portal/doc: Difference between revisions
m (→TemplateData: update header) |
m (1 revision imported) |
(No difference)
| |
Latest revision as of 19:53, 26 November 2018
 | This is a documentation subpage for Template:Portal. It contains usage information, categories and other content that is not part of the original template page. |
 | This template uses Lua: |
This template produces a box with links to a portal or to multiple portals. It is most often used in 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 =
| margin =
| break =
| boxsize =
}}
Location
Within articles, this template is meant to be placed at the top of the article's See also section. If there is no See also section, you can put it in the External links section instead; there is no need to create a new section just to house this template. If there is no External links section either, just put it below the article text in the place that seems most appropriate.
There are no particular rules about the placement of portals on other kinds of pages.
Image
The portal image names are stored in subpages of Module:Portal/images, organised by the first letter of the portal name. For example, the first letter of Portal:Fishing is "F", so the image name is stored at Module: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 then File: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 page Module: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, please make 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 a free 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.
| List of image subpages | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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. |
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:
See also
Main portal creation templates
- {{Basic portal start page}}—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.
{{Numbered subpages|max=25}}—As hereinbefore, but with 25 links.{{Numbered subpages|max=75}}—As hereinbefore, but with 75 links.{{Numbered subpages|max=100}}—As hereinbefore, but with 100 links.
- {{Random box-header subpage}}—Used to transclude a numbered subpage.
Main portal page formatting templates
- {{Box-header}}
- {{Box-header-blank}}
- {{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}}
These templates are used to format the articles on the sub-pages
{{Selected X}}—Generic template for situations not listed hereafter.
- {{Selected article}}
- {{Selected biography}}
- {{Selected business}}
- {{Selected DYK}}
- {{Selected ingredient}}
- {{Selected location}}
- {{Selected picture}}
- {{Selected product}}
- {{Selected publication}}
- {{Selected quote}}
- {{Selected recipe}}
Related templates
TemplateData
| TemplateData documentation used by VisualEditor and other tools | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
See the monthly parameter usage report for this template.
TemplateData for Portal A template to create a list of portals
| ||||||||||||||||||||||||||||||||||||||||