Template:Portal/doc

From CWS Planet
Jump to navigation Jump to search

This template is used to produce a link in a box to a portal or portals.

Parameters

{{Portal|Name 1|Name 2|Name 3...|size=Size|boxsize=Boxsize|margin=Margin}}
Name
The name of the portal. If multiple portal names are used the other parameters will be ignored.

The following additional parameters are available. They are all optional, the default values are chosen to give a good look and feel across the encylopedia and should not be overridden without good reason.

|size=Size
The width of the icon, as an integer. This is in units of pixels. The default is 28 times the image aspect ratio, which produces an image 28 pixels high.
|boxsize=Boxsize
The width of the box, as an integer. This is in units of pixels. The default is to use a box wide enough to hold the text, if possible.
|margin=Margin
The margin around the box. By default, the box is surrounded by a margin of width 0.5em, but this can be customized using |margin=top right bottom left (e.g., |margin=0.25em 0 0.25em 0.25em) or removed using |margin=0 (zero).
|break=Break
If set to "Yes", adds a line break before the word "portal".

Images

The portal image defaults to one that is specified in Template:Portal/Images/PortalName for the portal, or a generic image. There is a list of all such images.

Location

Within articles, this template is meant to be placed at the bottom of the article in the See also section.

Examples

Code
Result
{{Portal|Science}}
Lua error in package.lua at line 80: module 'Module:Portal/images/s' not found.
{{Portal|Science|size=15}}
Lua error in package.lua at line 80: module 'Module:Portal/images/s' not found.
{{Portal|Science|boxsize=50}}
Lua error in package.lua at line 80: module 'Module:Portal/images/s' not found.

See also