View source for Template:Portal/doc

{{#ifeq: {{{type|}}} | module ||<!-- section not transcluded if type = module -->
{{documentation subpage}}
{{high-use}}
{{lua|Module:Portal}}
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE.--->
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. '''If a portal does not exist, then it will not be displayed'''. As of December 11, 2021 (UTC), this portal template is now mobile-friendly, meaning that the portal links will appear on mobile devices.
}}<!-- end of section not transcluded if type = module -->
== Usage ==
{{Portal |Canada | Biography |History |Science}}

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

== Location ==
Within articles, {{#ifeq: {{{type|}}} | module | the output of the portal function | this template }} is meant to be placed at the top of the article's ''See also'' section. If there is no ''See also'' section, you may put it in the ''External links'' section instead; there is no need to create a new section just to house this template. If there is no ''External links'' section either, just put it below the article text in the place that seems most appropriate.

There are no particular rules about the placement of portals on other kinds of pages.

== Image ==
The portal image names are stored in subpages of [[Module:Portal/images]], organised by the first letter of the portal name. For example, the first letter of [[Portal:Feminism]] is "F", so the image name is stored at [[Module:Portal/images/f]]. If there is an entry for a portal on the correct page then the corresponding image will be shown next to the portal link. If no image is found then [[:File:Portal-puzzle.svg]] will be shown instead.

It is also possible to specify aliases for portal images. For example, the code {{tlx|Portal|Detroit}} produces the same image as the code {{tlx|Portal|Metro Detroit}}. The "Detroit" alias is found on the page [[Module:Portal/images/aliases]].

The image-detection algorithm is case-insensitive. For example, the code {{tlx|Portal|Detroit}} will produce the same image as the code {{tlx|Portal|detroit}} (although the portal links will be different). Portal names are stored in lower case in the image subpages, and input is converted to lower case before being checked.

To add new images to the list, please <span class="plainlinks">[https://en.wikipedia.org/w/index.php?title=Template_talk:Portal&action=edit&preload=Template:Edit_protected/preload&preloadparams%5b%5d=edit%20template-protected&preloadparams%5b%5d=&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. Portal images must be either in the public domain or available under a [[WP:ICTIC|free license]] that allows commercial reuse and derivative works; [[Wikipedia:Non-free content|fair-use]] images are not acceptable. The template {{tl|Portal icon demonstration}} may be of use when deciding whether an image is suitable for use as a portal icon; it formats an image using the same size and style that the {{tl|Portal}} template uses by default.

A list of portals and aliases of portals without icons can be found at [[:Category:Portal templates with default image]].

{{Collapse top|List of image subpages}}
{| class="wikitable"
|-
! Page !! Description
|-
| [[Module:Portal/images/a]] || For portal names starting with "A".
|-
| [[Module:Portal/images/b]] || For portal names starting with "B".
|-
| [[Module:Portal/images/c]] || For portal names starting with "C".
|-
| [[Module:Portal/images/d]] || For portal names starting with "D".
|-
| [[Module:Portal/images/e]] || For portal names starting with "E".
|-
| [[Module:Portal/images/f]] || For portal names starting with "F".
|-
| [[Module:Portal/images/g]] || For portal names starting with "G".
|-
| [[Module:Portal/images/h]] || For portal names starting with "H".
|-
| [[Module:Portal/images/i]] || For portal names starting with "I".
|-
| [[Module:Portal/images/j]] || For portal names starting with "J".
|-
| [[Module:Portal/images/k]] || For portal names starting with "K".
|-
| [[Module:Portal/images/l]] || For portal names starting with "L".
|-
| [[Module:Portal/images/m]] || For portal names starting with "M".
|-
| [[Module:Portal/images/n]] || For portal names starting with "N".
|-
| [[Module:Portal/images/o]] || For portal names starting with "O".
|-
| [[Module:Portal/images/p]] || For portal names starting with "P".
|-
| [[Module:Portal/images/q]] || For portal names starting with "Q".
|-
| [[Module:Portal/images/r]] || For portal names starting with "R".
|-
| [[Module:Portal/images/s]] || For portal names starting with "S".
|-
| [[Module:Portal/images/t]] || For portal names starting with "T".
|-
| [[Module:Portal/images/u]] || For portal names starting with "U".
|-
| [[Module:Portal/images/v]] || For portal names starting with "V".
|-
| [[Module:Portal/images/w]] || For portal names starting with "W".
|-
| [[Module:Portal/images/x]] || For portal names starting with "X".
|-
| [[Module:Portal/images/y]] || For portal names starting with "Y".
|-
| [[Module:Portal/images/z]] || For portal names starting with "Z".
|-
| [[Module:Portal/images/other]] || For portal names starting 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.
|}
{{Collapse bottom}}

== Example ==
The box on the right format with small text can incorporate multiple portals.

'''Box'''

{{Portal|Canada}}     
{{tlx|Portal|Canada}}

{{Portal|Canada|Example|tracking=no}}     
{{tlx|Portal|Canada|Example}}

{{-}}
Inline format for the left side with normal sized text; See [[Template:Portal-inline]] for a listing of parameters.

'''Inline '''
* {{tlx|Portal-inline|Canada}}
* {{Portal-inline|Canada}}

Inline format for the right side with normal sized text: See [[Template:Portal]] for more information.
{{portal|border=no|Canada}}
* {{tlx|Portal|border{{=}}no|Canada}}

{{-}}
'''Bar'''

The bar format is normally used for multiple portals. This template does not belong in the "See also" section. Per [[MOS:SECTIONORDER]], this template is bottom matter and goes below standard navigation templates.

{{Tlx|Portal bar|Canada|Example|<nowiki>border=no</nowiki>}}

{{Portal bar|Canada|Example|border=no|tracking=no}}

== Parameters ==
{| class="wikitable"
|-
! 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.
|-
| <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>'''margin'''</code> || CSS margin value, e.g. <code>1.2em 3em 0.5em 1em</code> || This allows you to set a custom margin. All valid CSS margin values are accepted.
|-
| <code>'''break'''</code> || <code>yes</code> || If set to <code>yes</code>, a line break is inserted after the portal name and before the word ''portal''.
|-
| <code>'''redlinks'''</code> || Any of the following values: <code>yes</code>, <code>y</code>, <code>true</code>, or <code>include</code> || Redlinks will be displayed. The default is to suppress redlinks.
|-
| <code>'''nominimum'''</code> || Any of the following values: <code>yes</code>, <code>y</code>, or <code>true</code> || Suppresses the warning if no parameters are supplied. This can be useful when Template:Portal is called by another template.
|-
| <code>'''border'''</code> || Any of the following values: <code>no</code>, <code>n</code>, or <code>false</code> || Turn off border and background
|-
| <code>'''tracking'''</code> || Any of the following values: <code>no</code>, <code>n</code>, <code>false</code> || Tracking categories will be suppressed. The default is to use tracking categories, except on certain namespaces and on pagenames which contain "/archive", "/doc" or "/test".
|}

== Error tracking ==
If the {{{type|template}}} is used incorrectly, the page will be added to a tracking category.

The tracking categories are not applied if any of the following is true:
# Tracking is specially disabled for that usage. This is done by setting the optional parameter {{para|tracking}} to any the following values: <code><nowiki>no</nowiki></code>, <code><nowiki>n</nowiki></code>, <code><nowiki>false</nowiki></code>
# the template is used on a page in any of these namespaces: Talk, User, User talk, Wikipedia talk, File talk, Template talk, Category talk, Portal talk, Draft, Draft talk, Module talk
# The title page on which the template is used includes any of the following case-insensitive strings: "/archive", "/doc", "/test"
* {{clc|Portal templates with too few portals}}
* {{clc|Portal templates with too many portals}}
* {{clc|Portal templates with redlinked portals}}
* {{clc|Pages with empty portal template}}
* {{clc|Portal templates with default image}}
:{{Purge page|''Purge page to update totals''}}

{{#ifeq: {{{type|}}} | module ||<!-- section not transcluded if type = module -->

== See also ==

* [[Wikipedia:Contents/Portals|List of portals]]
* {{Tl|Subject bar}}
{{Portal template list}}

==TemplateData==
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<TemplateData>
{
	"description": "A template to create a list of portals",
	"params": {
		"1": {
			"label": "Portal (1)",
			"description": "Inserts the portal image and text. Further portals can be added to the template by increasing the number",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "Portal (2)",
			"description": "Inserts the portal image and text",
			"type": "string"
		},
		"3": {
			"label": "Portal (3)",
			"inherits": "2"
		},
        "4": {
            "label": "Portal (4)",
            "inherits": "3"
        },
        "5": {
            "label": "Portal (5)",
            "inherits": "4"
        },
        "6": {
            "label": "Portal (6)",
            "inherits": "5"
        },
		"left": {
			"label": "Side",
			"description": "If set to yes, the portal appears on the left side of the page instead of the right.",
			"type": "string",
			"default": "no"
		},
		"margin": {
			"label": "Margin size",
			"description": "Alters the margin size. Any valid CSS margin is accepted",
			"type": "number"
		},
		"break": {
			"label": "Line break",
			"description": "If set to yes, a line break is inserted after the portal name and before the word portal",
			"type": "string"
		},
        "redlink": {
            "description": "Allow links to non-existent portals",
            "type": "string",
            "default": "false"
        },
        "nominimum": {
            "description": "Do not check for at least one portal",
            "type": "string",
            "default": "false"
        },
        "border": {
            "description": "Put border around portal links",
            "type": "string",
            "default": "true"
        },
        "tracking": {
            "description": "In case of warning, add to tracking category",
            "type": "string",
            "default": "true"
        },
		"type": {}
	},
	"format": "block"
}
</TemplateData>
{{Collapse bottom}}
{{help}}
<includeonly>{{Sandbox other||
<!--Categories below this line, please; interwikis at Wikidata-->
[[Category:Internal link templates]]
[[Category:Wikipedia Portal navflags]]
}}</includeonly> <noinclude>
[[Category:Record production portal|Templates]]</noinclude>

}}<!-- end of section not transcluded if type = module -->