Template:Portal/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>GermanJoe
+ TD header
meta>Christian75
update page count
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}
{{high-risk|4,600,000+}}
{{high-risk|4,800,000+}}
{{lua|Module:Portal}}
{{lua|Module:Portal}}
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE.--->
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE.--->

Revision as of 13:45, 2 September 2013

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

This template can be used to add multiple portal links to the "See also" section of an article.

Usage

Basic usage
{{Portal |Portal 1 |Portal 2 |Portal 3 |... }}
All options
{{Portal 
 | Portal 1 
 | Portal 2 
 | Portal 3 
 | ... 
 | left = <!-- yes -->
 | margin = <!-- CSS margin -->
 | break = <!-- yes -->
 | boxsize = <!-- custom box width in pixels -->
}}

Location

Within articles, this template is meant to be placed at the bottom of the article in the See also section.

Image

There is a list of portal images at Module:Portal/images. If the portal name is listed on that page then the corresponding image will be shown. It is also possible to specify aliases for portal images. If no image is found then File:Portal-puzzle.svg will be shown instead. To add new images to the list, read the instructions at Module:Portal/images and then use a protected edit request to get an administrator to edit the page for you.

Example

Code
Result
{{Portal|Science}}

Parameters

Name Value Description
1, 2, 3 ... The portal name, e.g. Literature The positional parameters specify the portals to be displayed. An unlimited number are allowed.
left yes If set to yes, the portal appears on the left side of the page instead of the right.
margin CSS margin value, e.g. 1.2em 3em 0.5em 1em This allows you to set a custom margin. All valid CSS margin values are accepted.
break yes If set to yes, a line break is inserted after the portal name and before the word portal.
boxsize Size in pixels, e.g. 300 This sets a custom box width in pixels.

Maintenance

The following tracking category lists instances where the template is used incorrectly:


TemplateData

This is the TemplateData for this template, used by TemplateWizard, VisualEditor and other tools.
TemplateData for Portal

A template to create a list of portals

Template parameters

ParameterDescriptionTypeStatus
Portal (1)1

Inserts the portal image and text. Further portals can be added to the template by increasing the number

Stringrequired
Portal (2)2

Insert the portal image and text

Stringoptional
Portal (3)3

Insert the portal image and text

Stringoptional
Sideleft

If set to yes, the portal appears on the left side of the page instead of the right.

Default
no
Stringoptional
Margin sizemargin

Alters the margin size. Any valid CSS margin is accepted

Numberoptional
Line breakbreak

If set to yes, a line break is inserted after the portal name and before the word portal

Stringoptional
Box sizeboxsize

This sets a custom box width in pixels.

Numberoptional

See also