Module:Portal/doc
 | This is a documentation subpage for Module:Portal. It may contain usage information, categories and other content that is not part of the original module page. |
 | This Lua module is used on approximately 10,300,000 pages, or roughly 17% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This module depends on the following other modules: |
 | This module uses TemplateStyles: |
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.
See here, here, and here for test cases.
Portal function
[edit]The portal function produces a box of portal links.
Usage
[edit]
Basic usage
{{#invoke:Portal|portal |Portal 1 |Portal 2 |Portal 3 |... }}
Location
[edit]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 may 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
[edit]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:Feminism 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.
A list of portals and aliases of portals without icons can be found at Category:Portal templates with default image.
List of image subpages
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Example
[edit]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; See Template:Portal-inline for a listing of parameters.
- Inline
{{Portal-inline|Canada}}
Canada portal
Inline format for the right side with normal sized text: See Template: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. Per MOS:SECTIONORDER, this template is bottom matter and goes below standard navigation template.
{{Portal bar|Canada|Example|border=no}}
Parameters
[edit]| 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.
|
redlinks |
Any of the following values: yes, y, true, or include |
Redlinks will be displayed. The default is to suppress redlinks. |
nominimum |
Any of the following values: yes, y, or true |
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, or false |
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". |
Error tracking
[edit]If the module 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 templates with too few portals (0)
- Category:Portal templates with too many portals (0)
- Category:Portal templates with redlinked portals (488)
- Category:Pages with empty portal template (13)
- Category:Portal templates with default image (14)
Image function
[edit]The image function produces the name of the image used by the specified portal.
Usage
[edit]{{#invoke:Portal|image|portal}}
Example
[edit]{{#invoke:Portal|image|Art}}→ Ballerina-icon.jpg
Image dupes function
[edit]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
[edit]{{#invoke:Portal|imageDupes}}
Display all function
[edit]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 1000 portals with images, and displaying 1000 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. The output of this function can be seen at Template:Portal/doc/all.
Usage
[edit]{{#invoke:Portal|displayAll}}