Template:Portal/doc

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

Parameters

{{portal|Name|Image |size=Size |boxsize=Boxsize |break=yes |left=yes |margin=Margin |link=Target |alt=Alt text |title=Title text }}

The following parameters are available. They are all optional.

Name

The name of the portal. This defaults to the current page's name.

Image

The image to use for the portal's icon. This defaults to a generic image.

|size=Size

The width of the icon, as an integer. This is in units of pixels. The default is 32. The icon is also constrained to be at most 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.

|break=yes

In the text, put a line break between the portal's name and the word "portal".

|left=yes

Float the box to the left instead of to the right.

|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).

|link=Target

the link target for the image. The default is empty, which means the image does not link to anything. A target of File: means that the image links to its file page. The target can be the name of a Wikipedia page, and it can be a URL. Normally the target should not also be a target of the adjacent text, as that would be overlinking. If a nonempty link is specified, nonempty |alt= should also be specified.

|alt=Alt text

The alt text for the image, for visually impaired readers. The default is empty. If |link=File: is specified, the alt text should describe the image's visual appearance; if some other nonempty link target is specified, the alt text should describe the function of the image, not its visual appearance. For more, please see Wikipedia:Alternative text for images.

|title=Title text

The title text for the image, which is typically displayed as tooltip with graphical browsers. It defaults to the URL of the file page for the image, to satisfy any licensing requirements; this URL is by default placed here, rather than in the usual way as a link from the image, to avoid accessibility problems by visually impaired readers. If an image's license requires attribution (see guideline), and if |title= is used with a parameter that does not contain the file page's URL, then |link=File: and |alt=Alt text should also be specified.

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}}
{{portal|Science}}
{{portal|Spaceflight|RocketSunIcon.svg}}
{{portal|Spaceflight|RocketSunIcon.svg |title= }}
{{portal|Spaceflight|RocketSunIcon.svg |link=Special:Search |alt=Search spaceflight portal |title=Explore space! }}
{{portal|Science|size=15}}
{{portal|Science|boxsize=50}}
{{portal|Science|break=yes}}
{{portal|Science|break=yes|left=yes}}

See also

• {{portalbox}}