Template:Portal/doc: Difference between revisions
From Zoophilia Wiki
Jump to navigationJump to search
meta>Pandukht No edit summary |
meta>WOSlinker remove image & alt params from docs as not generally used anymore |
||
| Line 5: | Line 5: | ||
===Parameters=== | ===Parameters=== | ||
: <code>'''<nowiki>{{</nowiki>Portal|<var>Name | : <code>'''<nowiki>{{</nowiki>Portal|<var>Name</var>|size=<var>Size</var>|boxsize=<var>Boxsize</var>|break=yes|left=yes|margin=<var>Margin</var>|link=<var>Target</var>}}'''</code> | ||
; <code><var>Name</var></code> : The name of the portal. <!-- This defaults to the current page's name - true but lets not encourage this. If pages or sections are moved or copied stuff breaks. --> | ; <code><var>Name</var></code> : The name of the portal. <!-- This defaults to the current page's name - true but lets not encourage this. If pages or sections are moved or copied stuff breaks. --> | ||
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 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|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 25: | Line 23: | ||
; {{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|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]]''. | ||
===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=== | ===Location=== | ||
| Line 34: | Line 33: | ||
|- style="font-size:120%;" | |- style="font-size:120%;" | ||
! Code<hr/> !! Result<hr/> | ! Code<hr/> !! Result<hr/> | ||
|- | |- | ||
| <small><pre>{{Portal|Science}}</pre></small> | | <small><pre>{{Portal|Science}}</pre></small> | ||
| {{Portal|Science}} | | {{Portal|Science}} | ||
|- | |- | ||
| <small><pre>{{Portal|Spaceflight | | <small><pre>{{Portal|Spaceflight|link=}}</pre></small> | ||
| {{Portal|Spaceflight|link=}} | |||
| {{Portal|Spaceflight | |||
|- | |- | ||
| <small><pre>{{Portal|Spaceflight | | <small><pre>{{Portal|Spaceflight|link=Special:Search}}</pre></small> | ||
| {{Portal|Spaceflight|link=Special:Search}} | |||
}}</pre></small> | |||
| {{Portal|Spaceflight | |||
}} | |||
|- | |- | ||
| <small><pre>{{Portal|Science|size=15}}</pre></small> | | <small><pre>{{Portal|Science|size=15}}</pre></small> | ||
Revision as of 19:03, 22 June 2010
 | This is a documentation subpage for Template:Portal. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used to produce a link in a box to a portal.
Parameters
{{Portal|Name|size=Size|boxsize=Boxsize|break=yes|left=yes|margin=Margin|link=Target}}
Name- The name of the portal.
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.
|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.
|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. If the target is empty, the image does not link to anything; if "
File:", the image links to its file page; otherwise, the image links to the specified Wikipeda page or URL. The default is "File:" ifImageis specified, and is empty otherwise.Targetcan 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. IfImageor nonemptyTargetis specified, nonemptyAlt textshould also be specified. The|link=parameter should not be used if that would conflict with the licensing requirements of the image; see Purely decorative 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 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
| Code |
Result |
|---|---|
{{Portal|Science}}
|
|
{{Portal|Spaceflight|link=}}
|
|
{{Portal|Spaceflight|link=Special:Search}}
|
|
{{Portal|Science|size=15}}
|
|
{{Portal|Science|boxsize=50}}
|
|
{{Portal|Science|break=yes}}
|
|
{{Portal|Science|break=yes|left=yes}}
|
See also
- {{Portal box}}
