Module:Portal/doc

MyWikiBiz, Author Your Legacy — Wednesday November 13, 2024
Jump to navigationJump to search

This is the documentation page for Module:Portal

Template:High-use Template:Module rating Template:Lua Template:Uses TemplateStyles

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

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}} → Ballerina-icon.jpg

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}}