Template:Portal/doc: Difference between revisions
meta>Mr. Stradivarius better wording |
meta>Mr. Stradivarius don't use the opening blurb for the module docs |
||
| Line 3: | Line 3: | ||
{{high-risk|4,800,000+}} | {{high-risk|4,800,000+}} | ||
{{lua|Module:Portal}} | {{lua|Module:Portal}} | ||
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE.---> | <!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE.---> | ||
This {{{type|template}}} produces a box with links to a [[Portal:Contents/Portals|portal]] or to multiple portals. It is most often used in the "See also" section of an article. | This {{{type|template}}} produces a box with links to a [[Portal:Contents/Portals|portal]] or to multiple portals. It is most often used in the "See also" section of an article. | ||
}} | |||
=== Usage === | === Usage === | ||
{{Portal |Louisiana |Missouri |Arkansas |Texas |Minnesota |Kansas |Nebraska |Colorado |North Dakota |Montana |Wyoming |Saskatchewan |Alberta |Oklahoma |New Mexico |History }} | {{Portal |Louisiana |Missouri |Arkansas |Texas |Minnesota |Kansas |Nebraska |Colorado |North Dakota |Montana |Wyoming |Saskatchewan |Alberta |Oklahoma |New Mexico |History }} | ||
Revision as of 15:40, 2 September 2013
 | 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 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 bottom of the article in the See also section. There are no particular rules about the placement of portals on other kinds of page.
Image
The portal image names are stored in subpages of Module:Portal/images, organised by the first letter of the portal name. If there is an entry for a portal on the correct page then then the corresponding image will be shown next to the portal link. 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 make a protected edit request at Template talk:Portal to get an administrator to edit the correct subpage for you.
List of image subpages
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Example
| Code | Result |
|---|---|
|
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
TemplateData
| ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
A template to create a list of portals
| ||||||||||||||||||||||||||||||||||||||||
