ᱢᱳᱰᱩᱞ:Portal/doc
This is the documentation page for ᱢᱳᱰᱩᱞ:Portal
 | This template is used on 6500000+ pages, and changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in a user subpage, and consider discussing changes at the talk page before implementing them. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of articles, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is is protected from editing. |
This module has two functions, portal and image. The portal produces a box with links to a portal or to multiple portals, and is used by the {{portal}} template. It is most often used in the "See also" section of an article. The image function produces the name of the image used by the specified portal.
Portal function
ᱥᱟᱯᱲᱟᱣThe portal function produces a box of portal links.
Usage
ᱥᱟᱯᱲᱟᱣ
Basic usage
{{#invoke:Portal|portal |Portal 1 |Portal 2 |Portal 3 |... }}
All options
{{#invoke:Portal|portal
| Portal 1
| Portal 2
| Portal 3
| ...
| left =
| margin =
| break =
| boxsize =
}}
Location
ᱥᱟᱯᱲᱟᱣWithin articles, the output of the portal function 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 |
|---|---|
{{#invoke:Portal|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 module is used incorrectly:
Image function
ᱥᱟᱯᱲᱟᱣThe image function produces the name of the image used by the specified portal.
Usage
ᱥᱟᱯᱲᱟᱣ{{#invoke:Portal|image|portal}}
Example
ᱥᱟᱯᱲᱟᱣ{{#invoke:Portal|image|Art}}→ Ballerina-icon.jpg
Image dupes function
ᱥᱟᱯᱲᱟᱣThe image dupes function returns a list of all images that are being used by more than one portal (aliases are not included). This can be helpful in identifying image entries that should be changed to use aliases.
Usage
ᱥᱟᱯᱲᱟᱣ{{#invoke:Portal|imageDupes}}
Display all function
ᱥᱟᱯᱲᱟᱣThe display all function returns a box containing all portals that have images. This is used for maintenance, and should not be displayed in articles, because a) there are around 1500 portals with images, and displaying 1500 images on one page takes up a lot of server resources, and b) the module has no way to know the correct capitalisation of a portal name, so some links to portals will be broken. This function can be seen at Template:Portal/doc/all.
Usage
ᱥᱟᱯᱲᱟᱣ{{#invoke:Portal|displayAll}}