Module:Portal

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.

Portal function

The portal function produces a box of portal links.

Usage

Basic usage

{{#invoke:Portal|portal |Portal 1 |Portal 2 |Portal 3 |... }}

All options

{{#invoke:Portal|portal
 | Portal 1
 | Portal 2
 | Portal 3
 | ...
 | left = 
 | margin = 
 | break = 
 | boxsize = 
 | redlinks = 
}}

Location

Within articles, the output of the portal function 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 {{Portal|Detroit}} produces the same image as the code {{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 {{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 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 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.

Example

Code	Result
{{#invoke:Portal|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.
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"

• Category:Portal templates without a parameter — (population 0)
• Category:Portal templates with redlinked portals — (population 11)
• Category:Portal templates with all redlinked portals — (population 4)

Image function

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

Usage

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

Example

• {{#invoke:Portal|image|Art}} →

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.

Usage

{{#invoke:Portal|imageDupes}}

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 Template:Portal/doc/all.

Usage

{{#invoke:Portal|displayAll}}

---

-- This module implements {{Portal}}

local p = {}
 
local HtmlBuilder = require('Module:HtmlBuilder')
local HtmlError = require('Module:Error')

-- This function generates the html code.
local function _portal(args)

    local root = HtmlBuilder.create('div')
    
    root
        .addClass('noprint')
        .addClass((args.left == 'yes' and 'tleft') or 'tright')
        .addClass('portal')
        .css('border', 'solid #aaa 1px')
        .css('margin', args.margin or (args.left == 'yes' and '0.5em 1em 0.5em 0') or '0.5em 0 0.5em 1em')
        .newline()

    -- Start the table. This corresponds to the start of the wikitext table
    -- in the old [[Template:Portal]].
    tableroot = root.tag('table')
        .css('background', '#f9f9f9')
        .css('font-size', '85%')
        .css('line-height', '110%')
        .css('max-width', '175px')
        .css(args.boxsize and 'width', args.boxsize and (args.boxsize .. 'px'))
    
    -- If no portals have been specified, display an error and add the page to a tracking category.
    if not args[1] then
        tableroot.wikitext(
            tostring(HtmlError.error{'No portals specified: please specify at least one portal'})
            .. '[[Category:Portal templates without a parameter]]'
        )
    end
    -- Display the portals specified in the positional parameters.
    for i,v in ipairs(args) do
        v = mw.ustring.match(v, '^%s*(.*%S)') or ''  -- Trim whitespace.
        
        -- Portal image names are stored in subtemplates of [[Template:Portal/Images]].
        -- The name of the subtemplate is the portal name in all lower case, but with
        -- the first character in upper case.
        
        -- Work out the image subtemplate location.
        local vfirst, vbody = mw.ustring.match(v, '^(.)(.*)') -- Get the first character and the following characters.
        local imageloc = 'Portal/Images/' .. mw.ustring.upper(vfirst or '') .. mw.ustring.lower(vbody or '')
        vfirst, vbody = nil, nil -- We've no more use for these variables now.
        
        imageloc = mw.title.new(imageloc, 'Template') -- Get title object. This is nil if the title is bad.

        -- Check if imageloc is a good title, and if the image subtemplate exists.
        -- If so, expand it to get the name. Otherwise, use the default of Portal-puzzle.svg.
        local imagename
        if imageloc and imageloc.exists then
            imagename = mw.getCurrentFrame():expandTemplate{ title = imageloc }
        else
            imagename = 'Portal-puzzle.svg'
        end
        imageloc = nil -- No more use for this variable now.
            
        -- Generate the html for the image and the portal name.
        tablerow = tableroot.newline().tag('tr').attr('valign', 'middle')
            tablerow.tag('td')
                .css('text-align', 'center')
                .wikitext('[[File:' .. imagename .. '|32x28px|alt=Portal icon]]')
            tablerow.tag('td')
                .css('padding', '0 0.2em')
                .css('vertical-align', 'middle')
                .css('font-style', 'italic')
                .css('font-weight', 'bold')
                .wikitext('[[Portal:' .. v .. '|' .. v .. ((args['break'] == 'yes' and '<br />') or ' ') .. 'portal]]')
    end

    return tostring(root)
end

-- This function gets the arguments passed to the module and passes them
-- to the _portal() function above.
function p.portal(frame)
    local orig_args
    if frame == mw.getCurrentFrame() then
        -- We're being called via #invoke. If the invoking template passed any args, use
        -- them. Otherwise, use the args that were passed into the template.
        orig_args = frame:getParent().args
        for k, v in pairs(frame.args) do
            orig_args = frame.args
            break
        end
    else
        -- We're being called from another module or from the debug console, so assume
        -- the args are passed in directly.
        orig_args = frame
    end
    
    -- We want to list all the portals in the order they were passed to the template. 
    -- We also want to be able to deal with positional parameters passed explicitly, 
    -- for example {{portal|2=Politics}}. However, pairs() doesn't guarantee the correct 
    -- order, and ipairs() will stop after the first nil value. To get around this, we 
    -- create a new table of arguments where nil values have been removed, so that we 
    -- can traverse the numerical arguments using ipairs(). We also remove whitespace 
    -- values, as ParserFunctions considers them to be false.
    
    local args = {} -- Arguments table.
    local name_args = {} -- Temporary table for named arguments.
    for k, v in pairs(orig_args) do
        if mw.ustring.match(v, '%S') then -- Remove values that are only whitespace.
            if type(k) == 'number' then
                table.insert(args, k) -- Put positional parameter keys into the arguments table so we can sort them.
            else
                -- Put named parameter values in their own table while we sort the positional parameters,
                -- so that we don't have to cycle through all the original parameters again.
                name_args[k] = v 
            end
        end
    end
    table.sort(args) -- Sort the positional argument keys into numerical order.
    for i,v in ipairs(args) do
        args[i] = orig_args[v] -- Replace positional argument keys with their corresponding values.
    end
    for k,v in pairs(name_args) do
        args[k] = v -- Add named parameters to the args table
    end
    name_args = nil -- This table won't be used any more.

    return _portal(args)
end

return p