Template:Portal/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
← Older editNewer edit →
VisualWikitext
meta>Eubulides
Undid revision 328902521 by Eubulides (talk) Revert self, since the change isn't installed yet.
meta>Eubulides
Document new alt= and link= parameters, and clean up documentation a bit.
Line 4: Line 4:
This template is used to produce a link in a box to a [[Portal:List of portals|portal]].
This template is used to produce a link in a box to a [[Portal:List of portals|portal]].


===Optional parameters===
===Parameters===
<nowiki>{{</nowiki>'''portal'''|name|image|size|boxsize|break=yes|left=yes|margin=}}
: <code>'''<nowiki>{{</nowiki>portal|<var>Name</var>|<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&nbsp;text</var> }}'''</code>
The units assumed for <code>size</code> (the width of the image) and <code>boxsize</code> (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 <code>margin=''top'' ''right'' ''bottom'' ''left''</code> (e.g. <code style="font-size:95%;">margin=0.25em 0 0.25em 0.25em</code>) or removed using <code>margin=0</code> (zero).
 
The following parameters are available. They are all optional.
 
; <code><var>Name</var></code> : The name of the portal. This defaults to the current page's name.
 
; <code><var>Image</var></code> : The image to use for the portal's icon. This defaults to a generic image.
 
; {{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&nbsp;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===
===Location===
Within articles, this template is meant to be placed at the bottom of the article in the "See also" section.
Within articles, this template is meant to be placed at the bottom of the article in the ''See also'' section.


===Examples===
===Examples===
{| style="background:transparent;"
{| style="background:transparent;"
|- style="font-size:120%;"  
|- style="font-size:120%;"
! Code<hr/> !! Result<hr/>
! Code<hr/> !! Result<hr/>
|-
|-
Line 22: Line 41:
| {{portal|Science}}
| {{portal|Science}}
|-
|-
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg}}</pre></small>
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg|alt=Rocket orbiting star}}</pre></small>
| {{portal|Spaceflight|RocketSunIcon.svg}}
| {{portal|Spaceflight|RocketSunIcon.svg|alt=Rocket orbiting star}}
|-
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg|link=}}</pre></small>
| {{portal|Spaceflight|RocketSunIcon.svg|link=}}
|-
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg |link=Special:Search
|alt=Search spaceflight portal
}}</pre></small>
| {{portal|Spaceflight|RocketSunIcon.svg |link=Special:Search
|alt=Search spaceflight portal
}}
|-
|-
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg|size=50}}</pre></small>
| <small><pre>{{portal|Science|size=15}}</pre></small>
| {{portal|Spaceflight|RocketSunIcon.svg|size=50}}
| {{portal|Science|size=15}}
|-
|-
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg|boxsize=50}}</pre></small>
| <small><pre>{{portal|Science|boxsize=50}}</pre></small>
| {{portal|Spaceflight|RocketSunIcon.svg|boxsize=50}}
| {{portal|Science|boxsize=50}}
|-
|-
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg|break=yes}}</pre></small>
| <small><pre>{{portal|Science|break=yes}}</pre></small>
| {{portal|Spaceflight|RocketSunIcon.svg|break=yes}}
| {{portal|Science|break=yes}}
|-
|-
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg|break=yes|left=yes}}</pre></small>
| <small><pre>{{portal|Science|break=yes|left=yes}}</pre></small>
| {{portal|Spaceflight|RocketSunIcon.svg|break=yes|left=yes}}
| {{portal|Science|break=yes|left=yes}}
|}
|}


Revision as of 00:06, 2 December 2009

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

Parameters

{{portal|Name|Image|size=Size |boxsize=Boxsize |break=yes |left=yes |margin=Margin |link=Target |alt=Alt text }}

The following parameters are available. They are all optional.

Name
The name of the portal. This defaults to the current page's name.
Image
The image to use for the portal's icon. This defaults to a generic image.
|size=Size
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.
|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:" if Image is specified, and is empty otherwise. Target 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 overlinking. If Image or nonempty Target is specified, nonempty Alt text should 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.
|alt=Alt text
The alt text for the image, for visually impaired readers; see Wikipedia:Alternative text for images. The default is empty. If |link=File: (or Image without any use of the |link= parameter) is specified, the alt text should describe the image's visual appearance; if |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

Code
 Result
{{portal}}
 
{{portal|Science}}
 
{{portal|Spaceflight|RocketSunIcon.svg|alt=Rocket orbiting star}}
 
{{portal|Spaceflight|RocketSunIcon.svg|link=}}
 
{{portal|Spaceflight|RocketSunIcon.svg |link=Special:Search
 |alt=Search spaceflight portal
}}
 
{{portal|Science|size=15}}
 
{{portal|Science|boxsize=50}}
 
{{portal|Science|break=yes}}
 
{{portal|Science|break=yes|left=yes}}

See also


Retrieved from "https://zoophilia.wiki/index.php?title=Template:Portal/doc&oldid=103654"