Template:Portal/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
← Older editNewer edit →
VisualWikitext
meta>Eubulides
Make it clearer that this default is only if an image is specified.
meta>Eubulides
Revert my recent changes to the documentation, as the proposed patch has not been installed yet, and the documentation should reflect current behavior.
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]].


===Parameters===
===Optional parameters===
: <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> |title=<var>Title&nbsp;text</var> }}'''</code>
<nowiki>{{</nowiki>'''portal'''|name|image|size|boxsize|break=yes|left=yes|margin=|alt=''Alt text''|link=''Link''}}
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.
By default the image is assumed to be purely decorative, and no link is generated for it; in this case the image should not have a license that requires attribution, for technical reasons involving copyright law and the current implementation of Wikipedia. However, if <code>alt=''Alt text''</code> is specified (see [[WP:ALT]]), a link to the image's page is generated; this link can be overridden with <code>link=''Page to link to''</code>. As per [[WP:ALT]], if a link is specified, alt text for that link's function should also be specified.
 
; <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. The default is empty, which means the image does not link to anything. A target of <code>File:</code> means that the image links to its file page. The 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 [[WP:OVERLINKING|overlinking]]. If a nonempty link is specified, nonempty {{para|alt}} should also be specified.
 
; {{para|alt|<var>Alt&nbsp;text</var>}} : The alt text for the image, for visually impaired readers.  The default is empty. If {{para|link|File:}} is specified, the alt text should describe the image's visual appearance; if some other nonempty link target is specified, the alt text should describe the function of the image, not its visual appearance. For more, please see ''[[Wikipedia:Alternative text for images]]''.
 
; {{para|title|<var>Title&nbsp;text</var>}} : The title text for the image, which is typically displayed as [[tooltip]] with graphical browsers. If an image is specified, it defaults to the URL of the file page for the image, to satisfy any licensing requirements; this URL is by default placed here, rather than in the usual way as a link from the image, to avoid [[WP:ACCESSIBILITY|accessibility]] problems by visually impaired readers. If an image's license requires attribution (see ''[[Wikipedia:Alternative text for images#Purely decorative images|guideline]]''), and if {{para|title}} is used with a parameter that does not contain the file page's URL, then {{para|link|File:}} and {{para|alt|<var>Alt&nbsp;text</var>}} should also be specified.


===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 46: Line 27:
| {{portal|Spaceflight|RocketSunIcon.svg}}
| {{portal|Spaceflight|RocketSunIcon.svg}}
|-
|-
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg |title= }}</pre></small>
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg|size=50}}</pre></small>
| {{portal|Spaceflight|RocketSunIcon.svg |title= }}
| {{portal|Spaceflight|RocketSunIcon.svg|size=50}}
|-
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg |link=Special:Search
|alt=Search spaceflight portal
|title=Explore space!
}}</pre></small>
| {{portal|Spaceflight|RocketSunIcon.svg |link=Special:Search
|alt=Search spaceflight portal
|title=Explore space!
}}
|-
| <small><pre>{{portal|Science|size=15}}</pre></small>
| {{portal|Science|size=15}}
|-
|-
| <small><pre>{{portal|Science|boxsize=50}}</pre></small>
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg|boxsize=50}}</pre></small>
| {{portal|Science|boxsize=50}}
| {{portal|Spaceflight|RocketSunIcon.svg|boxsize=50}}
|-
|-
| <small><pre>{{portal|Science|break=yes}}</pre></small>
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg|break=yes}}</pre></small>
| {{portal|Science|break=yes}}
| {{portal|Spaceflight|RocketSunIcon.svg|break=yes}}
|-
|-
| <small><pre>{{portal|Science|break=yes|left=yes}}</pre></small>
| <small><pre>{{portal|Spaceflight|RocketSunIcon.svg|break=yes|left=yes}}</pre></small>
| {{portal|Science|break=yes|left=yes}}
| {{portal|Spaceflight|RocketSunIcon.svg|break=yes|left=yes}}
|}
|}


Revision as of 23:31, 20 November 2009

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

Optional parameters

{{portal|name|image|size|boxsize|break=yes|left=yes|margin=|alt=Alt text|link=Link}}

The units assumed for size (the width of the image) and boxsize (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 margin=top right bottom left (e.g. margin=0.25em 0 0.25em 0.25em) or removed using margin=0 (zero).

By default the image is assumed to be purely decorative, and no link is generated for it; in this case the image should not have a license that requires attribution, for technical reasons involving copyright law and the current implementation of Wikipedia. However, if alt=Alt text is specified (see WP:ALT), a link to the image's page is generated; this link can be overridden with link=Page to link to. As per WP:ALT, if a link is specified, alt text for that link's function should also be specified.

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}}
 
{{portal|Spaceflight|RocketSunIcon.svg|size=50}}
 
{{portal|Spaceflight|RocketSunIcon.svg|boxsize=50}}
 
{{portal|Spaceflight|RocketSunIcon.svg|break=yes}}
 
{{portal|Spaceflight|RocketSunIcon.svg|break=yes|left=yes}}

See also


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