Template:Portal/doc

2010-05-23T20:28:28Z

95.30.170.142:

{{documentation subpage}}
<includeonly>{{high-risk|2,700,000}}</includeonly>

This template is used to produce a link in a box to a [[Portal:List of portals|portal]].

===Parameters===
: <code>'''<nowiki>{{</nowiki>Portal|<var>Name</var>|image=<var>Image</var>|size=<var>Size</var>|boxsize=<var>Boxsize</var>|break=yes|left=yes|margin=<var>Margin</var>|link=<var>Target</var>|alt=<var>Alt text</var>}}'''</code>

The following 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.

; <code><var>Name</var></code> : The name of the portal. 

; {{Para|image|<var>Image</var>}} : The image to use for the portal's icon. This defaults to an image that is specified in Template:Portal/Images/PortalName for the portal, or a generic image, and should not be overridden without good reason. There is a [[Template:Portal/Images|list of all such images]].

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

; {{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|break|yes}} : In the text, put a line break between the portal's name and the word "portal".

; {{Para|left|yes}} : Float the box to the left instead of to the right.

; {{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|link|<var>Target</var>}} : the link target for the image. If the target is empty, the image does not link to anything; if "<code>File:</code>", the image links to its file page; otherwise, the image links to the specified Wikipeda page or URL. The default is "<code>File:</code>" if <code><var>Image</var></code> is specified, and is empty otherwise. <code><var>Target</var></code> 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 [[WP:OVERLINKING|overlinking]]. If <code><var>Image</var></code> or nonempty <code><var>Target</var></code> is specified, nonempty <code><var>Alt text</var></code> should also be specified. The {{para|link}} parameter should not be used if that would conflict with the licensing requirements of the image; see ''[[Wikipedia:Alternative text for images #Purely decorative images|Purely decorative images]]''.

; {{Para|alt|<var>Alt text</var>}} : The alt text for the image, for visually impaired readers; see ''[[Wikipedia:Alternative text for images]]''. The default is empty. If {{para|link|File:}} (or <code><var>Image</var></code> without any use of the {{para|link}} parameter) is specified, the alt text should describe the image's visual appearance; if {{para|link}} specifies some other nonempty link target, the alt text should describe the icon's function.

===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/>
|-
| <pre>{{Portal}}</pre>
| {{Portal}}
|-
| <pre>{{Portal|Science}}</pre>
| {{Portal|Science}}
|-
| <pre>{{Portal|Spaceflight|RocketSunIcon.svg|alt=Rocket orbiting star}}</pre>
| {{Portal|Spaceflight|RocketSunIcon.svg|alt=Rocket orbiting star}}
|-
| <pre>{{Portal|Spaceflight|RocketSunIcon.svg|link=}}</pre>
| {{Portal|Spaceflight|RocketSunIcon.svg|link=}}
|-
| <pre>{{Portal|Spaceflight|RocketSunIcon.svg |link=Special:Search
|alt=Search spaceflight portal
}}</pre>
| {{Portal|Spaceflight|RocketSunIcon.svg |link=Special:Search
|alt=Search spaceflight portal
}}
|-
| <pre>{{Portal|Science|size=15}}</pre>
| {{Portal|Science|size=15}}
|-
| <pre>{{Portal|Science|boxsize=50}}</pre>
| {{Portal|Science|boxsize=50}}
|-
| <pre>{{Portal|Science|break=yes}}</pre>
| {{Portal|Science|break=yes}}
|-
| <pre>{{Portal|Science|break=yes|left=yes}}</pre>
| {{Portal|Science|break=yes|left=yes}}
|}

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

<includeonly>

[[Category:Wikipedia Portal navflags| ]]
[[Category:Internal link templates]]
[[Category:Exclude in print|{{PAGENAME}}]]


[[ar:قالب:بوابة]]
[[be-x-old:Шаблён:Партал]]
[[bs:Šablon:Portal]]
[[ca:Plantilla:Portal]]
[[cs:Šablona:Portál]]
[[da:Skabelon:Portal]]
[[de:Vorlage:Portal]]
[[el:Πρότυπο:Portal]]
[[hi:साँचा:Portal/doc]]
[[es:Plantilla:Portal2]]
[[et:Mall:Portaal]]
[[eo:Ŝablono:Portalo]]
[[eu:Txantiloi:Atari]]
[[fr:Modèle:Portail]]
[[zh-classical:Template:門]]
[[he:תבנית:פורטל]]
[[hr:Predložak:Portal]]
[[hsb:Předłoha:Portal]]
[[id:Templat:Wikiportal]]
[[ia:Patrono:Portal]]
[[it:Template:Portale]]
[[ja:Template:ウィキポータルリンク]]
[[ko:틀:들머리]]
[[lb:Template:Portal]]
[[lt:Šablonas:Portal]]
[[hu:Sablon:Portál]]
[[mk:Шаблон:Портал]]
[[mr:साचा:दालन]]
[[ms:Templat:Portal]]
[[nl:Sjabloon:Portaal]]
[[no:Mal:Portal]]
[[pl:Szablon:Portal]]
[[pt:Predefinição:Portal]]
[[ro:Format:Portal]]
[[ru:Шаблон:Портал]]
[[sq:Stampa:Portal]]
[[sk:Šablóna:Portál]]
[[sl:Predloga:Portal]]
[[sr:Шаблон:Портал]]
[[sh:Template:Portal]]
[[fi:Malline:Teemasivu]]
[[tl:Template:Portal]]
[[vi:Tiêu bản:Portal]]
[[tr:Şablon:Portal]]
[[uk:Шаблон:Портал]]
[[zh:Template:Portal]]
</includeonly>

The Official Website for Mark Eitzel & American Music Club - User contributions [en]

Template:Portal/doc