Mòideal:Portal/doc

O Wiktionary

This is the documentation page for Mòideal:Portal

(deasbaireachd⧼tpt-languages-separator⧽deasaich⧼tpt-languages-separator⧽eachdraidh⧼tpt-languages-separator⧽ceanglaichean⧼tpt-languages-separator⧽doc⧼tpt-languages-separator⧽bogsa-gainmhich⧼tpt-languages-separator⧽cùisean deuchainn)

This module has two functions, portal and image. The portal produces a box with links to a portal or to multiple portals, and is used by the {{Portal}} template. It is most often used in the "See also" section of an article. The image function produces the name of the image used by the specified portal.

Foincsean Portal - Portal function

The portal function produces a box of portal links.


This Module 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. If a portal does not exist, then it will not be displayed. This can be overridden with |redlinks=yes.

Ùsaid - Usage

Basic usage

{{Portal |Portal 1 |Portal 2 |Portal 3 |... }}

All options

{{Portal
 | Portal 1
 | Portal 2
 | Portal 3
 | ...
 | left = 
 | margin = 
 | break = 
 | boxsize = 
 | redlinks = 
}}

Location

Within articles, 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 can 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.

Faidhle - Image

The portal image names are stored in subpages of Mòideal: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 Mòideal: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 {{Portal|Detroit}} produces the same image as the code {{Portal|Metro Detroit}}. The "Detroit" alias is found on the page Mòideal:Portal/images/aliases.

The image-detection algorithm is case-insensitive. For example, the code {{Portal|Detroit}} will produce the same image as the code {{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 Mhàrt+2024&section=new make a protected edit request at Template talk:Portal to get an administrator to edit the correct subpage for you. Portal images must be either in the public domain or available under a free license that allows commercial reuse and derivative works; fair-use images are not acceptable. The template {{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 {{Portal}} template uses by default.

A list of portals and aliases of portals without icons can be found at User:Dreamy Jazz Bot/Portals needing icons. It is updated infrequently, so ping the bot owner to update the list.

List of image subpages
Page Description
Mòideal:Portal/images/a For portal names starting with "A".
Mòideal:Portal/images/b For portal names starting with "B".
Mòideal:Portal/images/c For portal names starting with "C".
Mòideal:Portal/images/d For portal names starting with "D".
Mòideal:Portal/images/e For portal names starting with "E".
Mòideal:Portal/images/f For portal names starting with "F".
Mòideal:Portal/images/g For portal names starting with "G".
Mòideal:Portal/images/h For portal names starting with "H".
Mòideal:Portal/images/i For portal names starting with "I".
Mòideal:Portal/images/j For portal names starting with "J".
Mòideal:Portal/images/k For portal names starting with "K".
Mòideal:Portal/images/l For portal names starting with "L".
Mòideal:Portal/images/m For portal names starting with "M".
Mòideal:Portal/images/n For portal names starting with "N".
Mòideal:Portal/images/o For portal names starting with "O".
Mòideal:Portal/images/p For portal names starting with "P".
Mòideal:Portal/images/q For portal names starting with "Q".
Mòideal:Portal/images/r For portal names starting with "R".
Mòideal:Portal/images/s For portal names starting with "S".
Mòideal:Portal/images/t For portal names starting with "T".
Mòideal:Portal/images/u For portal names starting with "U".
Mòideal:Portal/images/v For portal names starting with "V".
Mòideal:Portal/images/w For portal names starting with "W".
Mòideal:Portal/images/x For portal names starting with "X".
Mòideal:Portal/images/y For portal names starting with "Y".
Mòideal:Portal/images/z For portal names starting with "Z".
Mòideal:Portal/images/other For portal names starting with any other letters. This includes numbers, letters with diacritics, and letters in non-Latin alphabets.
Mòideal: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.

Eisimpleirean - Examples

Code Result
{{Portal|Science}}


Paramadairean - 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.
redlinks Any of the following values: yes, y, true, or include Redlinks will be displayed. The default is to suppress redlinks.
nominimum Any of the following values: yes, y, or true Suppresses the warning if no parameters are supplied. This can be useful when Template:Portal is called by another template.
tracking Any of the following values: no, n, false 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 Module 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:

  1. Tracking is specially disabled for that usage. This is done by setting the optional parameter |tracking= to any the following values: no, n, false
  2. 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
  3. The title page on which the template is used includes any of the following case-insensitive strings: "/archive", "/doc", "/test"
Purge page to update totals

Faic cuideachd - Also see

Teamplaid:Portal template list

Teamplaid-dàta - TemplateData

TemplateData documentation used by VisualEditor and other tools
See the monthly parameter usage report for this template.

TemplateData for Portal

A template to create a list of portals

Paramadairean na teamplaide

Is fhearr leis an teamplaid seo fòrmatadh nam paramadairean ann am bloca.

ParamadairTuairisgeulSeòrsaStaid
Portal (1)1

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

Sreangriatanach
Portal (2)2

Insert the portal image and text

Sreangroghainneil
Portal (3)3

Insert the portal image and text

Sreangroghainneil
Sideleft

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

Bun-roghainn
no
Sreangroghainneil
Margin sizemargin

Alters the margin size. Any valid CSS margin is accepted

Àireamhroghainneil
Line breakbreak

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

Sreangroghainneil
Box sizeboxsize

This sets a custom box width in pixels.

Àireamhroghainneil
typetype

gun tuairisgeul

Chan eil fhiosroghainneil

Foincsean Image - Image function

The image function produces the name of the image used by the specified portal.

Ùsaid - Usage

{{#invoke:Portal|image|portal}}

Eisimpleir - Example

  • {{#invoke:Portal|image|Art}} → Portal-puzzle.svg

Foincsean Image dupes - Image dupes function

The image dupes function returns a list of all images that are being used by more than one portal (aliases are not included). This can be helpful in identifying image entries that should be changed to use aliases.

Ùsaid - Usage

{{#invoke:Portal|imageDupes}}

Foincsean Display all - Display all function

The display all function returns a box containing all portals that have images. This is used for maintenance, and should not be displayed in articles, because a) there are around 1500 portals with images, and displaying 1500 images on one page takes up a lot of server resources, and b) the module has no way to know the correct capitalisation of a portal name, so some links to portals will be broken. This function can be seen at Teamplaid:Portal/doc/all.

Ùsaid - Usage

{{#invoke:Portal|displayAll}}