Template:Portal/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>FleetCommand
Reverted 1 edit by BigRobby510 (talk): Out-of-context contribution. (i.e. which images?).
meta>Rich Farmbrough
m Fix spelling encylo => encyclo or similar; using AWB
Line 9: Line 9:
; <code><var>Name</var></code> : The name of the portal.  If multiple portal names are used the other parameters will be ignored.
; <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.
The following additional parameters are available. They are all optional, the default values are chosen to give a good look and feel across the encyclopedia 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|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.
Line 17: Line 17:
; {{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|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".  
; {{Para|break|<var>Break</var>}} : If set to "Yes", adds a line break before the word "portal".


===Images===
===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]]. Have in mind that the "PortalName" variable should only have an upper case letter at the first word, the second and later words should be written in lower case, regardless of how is the name of the portal actually written. For example, [[Portal:Buenos Aires]] is written with two capital letters, but the subpage to host the image is [[Template:Portal/Images/Buenos aires]], with only one capital letter.
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]]. Have in mind that the "PortalName" variable should only have an upper case letter at the first word, the second and later words should be written in lower case, regardless of how is the name of the portal actually written. For example, [[Portal:Buenos Aires]] is written with two capital letters, but the subpage to host the image is [[Template:Portal/Images/Buenos aires]], with only one capital letter.


===Location===
===Location===
Line 49: Line 49:


<includeonly>
<includeonly>
<!--Categories-->
[[Category:Wikipedia Portal navflags| ]]
[[Category:Wikipedia Portal navflags| ]]
[[Category:Internal link templates]]
[[Category:Internal link templates]]

Revision as of 00:58, 26 November 2011

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 encyclopedia 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. Have in mind that the "PortalName" variable should only have an upper case letter at the first word, the second and later words should be written in lower case, regardless of how is the name of the portal actually written. For example, Portal:Buenos Aires is written with two capital letters, but the subpage to host the image is Template:Portal/Images/Buenos aires, with only one capital letter.

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}}
{{Portal|Science|size=15}}
{{Portal|Science|boxsize=50}}

See also