View source for Template:Portal/doc

{{documentation subpage}}
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE.--->
This template is used to produce a link in a box to a [[Portal:List of portals|portal]] or portals.

===Parameters===
: <code>'''<nowiki>{{</nowiki>Portal|<var>Name 1</var>|<var>Name 2</var>|<var>Name 3</var>...|size=<var>Size</var>|boxsize=<var>Boxsize</var>|margin=<var>Margin</var>}}'''</code>

; <code><var>Name</var></code> : 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.

; {{Para|size|<var>Size</var>}} : 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.

; {{Para|boxsize|<var>Boxsize</var>}} : 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.

; {{Para|margin|<var>Margin</var>}} : The margin around the box. By default, the box is surrounded by a margin of width 0.5em, but this can be customized using {{para|margin|<var>top right bottom left</var>}} (''e.g.'', {{para|margin|0.25em 0 0.25em 0.25em}}) or removed using {{para|margin|0}} (zero).

; {{Para|break|<var>Break</var>}} : 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 [[Template:Portal/Images|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===
{| style="background:transparent;"
|- style="font-size:120%;"
! Code<hr/> !! Result<hr/>
|-
| <small><pre>{{Portal|Science}}</pre></small>
| {{Portal|Science}}
|-
| <small><pre>{{Portal|Science|size=15}}</pre></small>
| {{Portal|Science|size=15}}
|-
| <small><pre>{{Portal|Science|boxsize=50}}</pre></small>
| {{Portal|Science|boxsize=50}}
|}

===See also===
* {{Tl|Portal box}}
* {{tl|Portal bar}}

<includeonly>
<!--Categories-->
[[Category:Internal link templates]]
</includeonly>