Template:Portal/doc

From Zoophilia Wiki
Revision as of 08:40, 18 July 2009 by meta>Eubulides (Document desired behavior for link and alt text.)
Jump to navigationJump to search

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

Optional parameters

{{portal|name|image|size|boxsize|break=yes|left=yes|margin=|alt=Alt text|link=Link}}

The units assumed for size (the width of the image) and boxsize (the width of the box containing the image and portal link) are pixels (px). 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).

Normally the image are assumed to be purely decorative, and no link is generated for it. However, if alt=Alt text is specified (see WP:ALT), a link to the image's page is generated; this link can be overridden with link=Page to link to. As per WP:ALT, if a link is specified, alt text for that link's function 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|size=50}}
{{portal|Spaceflight|RocketSunIcon.svg|boxsize=50}}
{{portal|Spaceflight|RocketSunIcon.svg|break=yes}}
{{portal|Spaceflight|RocketSunIcon.svg|break=yes|left=yes}}

See also