Template:Portal/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
← Older editNewer edit →
VisualWikitext
meta>Christian75
update page count
meta>Mr. Stradivarius
update so this documentation can be used at Module:Portal/doc as well
Line 1: Line 1:
{{#ifeq: {{{type|}}} | module ||
{{documentation subpage}}
{{documentation subpage}}
{{high-risk|4,800,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.--->}}
This template is used to produce a link in a box to a [[Portal:Contents/Portals|portal]] or portals.


This template can be used to add multiple portal links to the "See also" section of an article.
This {{{type|template}}} produces a box with links to a [[Portal:Contents/Portals|portal]] or to multiple portals. It is most often used in the "See also" section of an article.


==Usage==
=== Usage ===
{{Portal |Louisiana |Missouri |Arkansas |Texas |Minnesota |Kansas |Nebraska |Colorado |North Dakota |Montana |Wyoming |Saskatchewan |Alberta |Oklahoma |New Mexico |History }}
{{Portal |Louisiana |Missouri |Arkansas |Texas |Minnesota |Kansas |Nebraska |Colorado |North Dakota |Montana |Wyoming |Saskatchewan |Alberta |Oklahoma |New Mexico |History }}


;Basic usage
;Basic usage
<pre style="overflow:auto">
<div style="overflow:auto">
{{Portal |Portal 1 |Portal 2 |Portal 3 |... }}
<code>&#123;&#123;{{#ifeq: {{{type|}}} | module | &#35;invoke:Portal&#124;portal | Portal }} |''Portal 1'' |''Portal 2'' |''Portal 3'' |... &#125;&#125;</code>
</pre>
</div>


;All options
;All options
<pre style="overflow:auto">
<div style="overflow:auto"><code>
{{Portal  
&#123;&#123;{{#ifeq: {{{type|}}} | module | &#35;invoke:Portal&#124;portal | Portal }}
| Portal 1  
  | ''Portal 1''
| Portal 2  
  | ''Portal 2''
| Portal 3  
  | ''Portal 3''
| ...  
  | ...  
| left = <!-- yes -->
  | left = <!-- yes -->
| margin = <!-- CSS margin -->
  | margin = <!-- CSS margin -->
| break = <!-- yes -->
  | break = <!-- yes -->
| boxsize = <!-- custom box width in pixels -->
  | boxsize = <!-- custom box width in pixels -->
}}
&#125;&#125;
</pre>
</code></div>


==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 {{{type|template}}} is meant to be placed at the bottom of the article in the ''See also'' section. There are no particular rules about the placement of portals on other kinds of page.


==Image==
=== 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 [[WP:PER|protected edit request]] to get an administrator to edit the page for you.
The portal image names are stored in subpages of [[Module:Portal/images]], organised by the first letter of the portal name. If there is an entry for a portal on the correct page then then the corresponding image will be shown next to the portal link. 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 <span class="plainlinks">[https://en.wikipedia.org/w/index.php?title=Template_talk:Portal&action=edit&preload=Template:Edit_protected/preload&editintro=Template:Edit_protected/editintro&preloadtitle=Image+edit+request+on+{{CURRENTDAY}}+{{CURRENTMONTHNAME}}+{{CURRENTYEAR}}&section=new make a protected edit request at Template talk:Portal]</span> to get an administrator to edit the correct subpage for you.


==Example==
{{cot|List of image subpages}}
{| class="wikitable"
|-
! Page !! Description
|-
| [[Module:Portal/images/a]] || For portal names beginning with "A".
|-
| [[Module:Portal/images/b]] || For portal names beginning with "B".
|-
| [[Module:Portal/images/c]] || For portal names beginning with "C".
|-
| [[Module:Portal/images/d]] || For portal names beginning with "D".
|-
| [[Module:Portal/images/e]] || For portal names beginning with "E".
|-
| [[Module:Portal/images/f]] || For portal names beginning with "F".
|-
| [[Module:Portal/images/g]] || For portal names beginning with "G".
|-
| [[Module:Portal/images/h]] || For portal names beginning with "H".
|-
| [[Module:Portal/images/i]] || For portal names beginning with "I".
|-
| [[Module:Portal/images/j]] || For portal names beginning with "J".
|-
| [[Module:Portal/images/k]] || For portal names beginning with "K".
|-
| [[Module:Portal/images/l]] || For portal names beginning with "L".
|-
| [[Module:Portal/images/m]] || For portal names beginning with "M".
|-
| [[Module:Portal/images/n]] || For portal names beginning with "N".
|-
| [[Module:Portal/images/o]] || For portal names beginning with "O".
|-
| [[Module:Portal/images/p]] || For portal names beginning with "P".
|-
| [[Module:Portal/images/q]] || For portal names beginning with "Q".
|-
| [[Module:Portal/images/r]] || For portal names beginning with "R".
|-
| [[Module:Portal/images/s]] || For portal names beginning with "S".
|-
| [[Module:Portal/images/t]] || For portal names beginning with "T".
|-
| [[Module:Portal/images/u]] || For portal names beginning with "U".
|-
| [[Module:Portal/images/v]] || For portal names beginning with "V".
|-
| [[Module:Portal/images/w]] || For portal names beginning with "W".
|-
| [[Module:Portal/images/x]] || For portal names beginning with "X".
|-
| [[Module:Portal/images/y]] || For portal names beginning with "Y".
|-
| [[Module:Portal/images/z]] || For portal names beginning with "Z".
|-
| [[Module:Portal/images/other]] || For portal names beginning with any other letters. This includes numbers, letters with diacritics, and letters in non-Latin alphabets.
|-
| [[Module:Portal/images/aliases]] || For adding aliases for existing portal names. Use this page for variations in spelling and diacritics, etc., no matter what letter the portal begins with.
|-
|}
{{cob}}
 
=== Example ===
{| style="background:transparent;"
{| style="background:transparent;"
|- style="font-size:120%;"
! Code<hr/> !! Result<hr/>
|-
|-
| <small><pre>{{Portal|Science}}</pre></small>
! Code !! Result
|-
|
  <span style="font-size: 90%;"><code>&#123;&#123;{{#ifeq: {{{type|}}} | module | &#35;invoke:Portal&#124;portal | Portal }}|Science&#125;&#125;</code></span>
| {{Portal|Science}}
| {{Portal|Science}}
|}
|}


== Parameters ==
=== Parameters ===


{| class="wikitable"
{| class="wikitable"
Line 50: Line 115:
! Name !! Value !! Description
! Name !! Value !! Description
|-
|-
| <code>'''1'''</code>, <code>'''2'''</code>, <code>'''3'''</code> ... || The portal name, e.g. <code>Literature</code> || The positional parameters specify the portals to be displayed. An unlimited number are allowed.
| <code>'''1'''</code>, <code>'''2'''</code>, <code>'''3'''</code> ... || The portal name, e.g. <code>Literature</code> || The positional parameters specify the portals to be displayed.
|-
|-
| <code>'''left'''</code> || <code>yes</code> || If set to <code>yes</code>, the portal appears on the left side of the page instead of the right.
| <code>'''left'''</code> || <code>yes</code> || If set to <code>yes</code>, the portal appears on the left side of the page instead of the right.
Line 61: Line 126:
|}
|}


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


The following tracking category lists instances where the {{{type|template}}} is used incorrectly:
* [[:Category:Portal templates without a parameter]]
* [[:Category:Portal templates without a parameter]]
{{#ifeq: {{{type|}}} | module ||
=== See also ===
* [[Template:Portal bar]]
* [[Template:Portal-inline]]
* [[Template:Related portals]]
* [[Template:Related portals2]]
<includeonly>
[[Category:Internal link templates]]
[[Category:Wikipedia Portal navflags]]
[[Category:Exclude in print]]


 
[[bn:টেমপ্লেট:Portal]]
==TemplateData==
</includeonly>
{{TemplateDataHeader}}
{{cot|TemplateData}}
<TemplateData>
<TemplateData>
{
{
Line 112: Line 187:
}
}
</TemplateData>
</TemplateData>
 
{{cob}}
==See also==
}}
* [[Template:Portal bar]]
* [[Template:Portal-inline]]
* [[Template:Related portals]]
* [[Template:Related portals2]]
 
 
<includeonly>
[[Category:Internal link templates]]
[[Category:Wikipedia Portal navflags]]
[[Category:Exclude in print]]
 
[[bn:টেমপ্লেট:Portal]]
</includeonly>

Revision as of 15:36, 2 September 2013

This template produces a box with links to a portal or to multiple portals. It is most often used in 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 = 
 | margin = 
 | break = 
 | boxsize = 
}}

Location

Within articles, this template is meant to be placed at the bottom of the article in the See also section. There are no particular rules about the placement of portals on other kinds of page.

Image

The portal image names are stored in subpages of Module:Portal/images, organised by the first letter of the portal name. If there is an entry for a portal on the correct page then then the corresponding image will be shown next to the portal link. 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 make a protected edit request at Template talk:Portal to get an administrator to edit the correct subpage for you.

List of image subpages
Page Description
Module:Portal/images/a For portal names beginning with "A".
Module:Portal/images/b For portal names beginning with "B".
Module:Portal/images/c For portal names beginning with "C".
Module:Portal/images/d For portal names beginning with "D".
Module:Portal/images/e For portal names beginning with "E".
Module:Portal/images/f For portal names beginning with "F".
Module:Portal/images/g For portal names beginning with "G".
Module:Portal/images/h For portal names beginning with "H".
Module:Portal/images/i For portal names beginning with "I".
Module:Portal/images/j For portal names beginning with "J".
Module:Portal/images/k For portal names beginning with "K".
Module:Portal/images/l For portal names beginning with "L".
Module:Portal/images/m For portal names beginning with "M".
Module:Portal/images/n For portal names beginning with "N".
Module:Portal/images/o For portal names beginning with "O".
Module:Portal/images/p For portal names beginning with "P".
Module:Portal/images/q For portal names beginning with "Q".
Module:Portal/images/r For portal names beginning with "R".
Module:Portal/images/s For portal names beginning with "S".
Module:Portal/images/t For portal names beginning with "T".
Module:Portal/images/u For portal names beginning with "U".
Module:Portal/images/v For portal names beginning with "V".
Module:Portal/images/w For portal names beginning with "W".
Module:Portal/images/x For portal names beginning with "X".
Module:Portal/images/y For portal names beginning with "Y".
Module:Portal/images/z For portal names beginning with "Z".
Module:Portal/images/other For portal names beginning with any other letters. This includes numbers, letters with diacritics, and letters in non-Latin alphabets.
Module:Portal/images/aliases For adding aliases for existing portal names. Use this page for variations in spelling and diacritics, etc., no matter what letter the portal begins with.

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.
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:

See also

TemplateData

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
Retrieved from "https://zoophilia.wiki/index.php?title=Template:Portal/doc&oldid=103739"