Template:Portal/doc

From GarantPlus Alvis Wiki
Jump to: navigation, search

{{#ifeq: portal/doc | doc

 | 

{{

   #ifeq: show | show
   | Template:Mbox
   }}{{
   #if: 
   | 
   | [[Category:{{
     #if: Template
     | Template
     | Article
   }} documentation {{#ifeq:Template|Template|pages}}]]
 }}

| }} {{#ifeq:|yes

| {{#ifeq:{{#if:| {{{smallimage}}} | }}|none | | }}

{{#if:{{#if: | {{{smallimageright}}} | }} | {{#ifeq:{{#if: | {{{smallimageright}}} | }}|none

 | 
|
 }}

}}

{{#switch:content

| | speedy | delete | content | style | move | protection | notice =

| #default =
This message box is using an invalid "type=content" parameter and needs fixing.
[[Category:Wikipedia message box parameter needs fixing|Template:Main otherTemplate:Portal/doc]]

}}

| {{#ifeq:|none | | }}

{{#if: | {{#ifeq:|none

 | 
|
 }}

}}

{{#switch:content

| | speedy | delete | content | style | move | protection | notice =

| #default =
This message box is using an invalid "type=content" parameter and needs fixing.
[[Category:Wikipedia message box parameter needs fixing|Template:Main otherTemplate:Portal/doc]]

}} }} 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 encylopedia and should not be overridden without good reason.

|{{#if:size|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.
|{{#if:boxsize|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.
|{{#if:margin|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 |{{#if:margin|margin=|}}top right bottom left (e.g., |{{#if:margin|margin=|}}0.25em 0 0.25em 0.25em) or removed using |{{#if:margin|margin=|}}0 (zero).
|{{#if:break|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.

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}}
Template:Portal box|
[[Image:{{#ifexist:Template:Portal/Images/Science Nuvola apps kalzium.svg Portal-puzzle.svg

}} |{{#if:

px x28px

}}{{#ifeq:File:|File:|||link=}}{{#ifeq:¬|¬|||alt=}}]]

Science{{#ifeq:|yes
}}portal
}}
{{Portal|Science|size=15}}
Template:Portal box|
[[Image:{{#ifexist:Template:Portal/Images/Science Nuvola apps kalzium.svg Portal-puzzle.svg

}} |{{#if:15

15px x28px

}}{{#ifeq:File:|File:|||link=}}{{#ifeq:¬|¬|||alt=}}]]

Science{{#ifeq:|yes
}}portal
}}
{{Portal|Science|boxsize=50}}
Template:Portal box|
[[Image:{{#ifexist:Template:Portal/Images/Science Nuvola apps kalzium.svg Portal-puzzle.svg

}} |{{#if:

px x28px

}}{{#ifeq:File:|File:|||link=}}{{#ifeq:¬|¬|||alt=}}]]

Science{{#ifeq:|yes
}}portal
}}

See also