Module:Portal/doc
This is the documentation page for Module:Portal
 | This Lua module is used on many pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. ꠇꠤꠔꠣ ꠛꠖꠟꠣꠁꠔꠣ ꠅꠔꠣ ꠟꠂꠀ ꠀꠟꠥꠌꠘꠣ ꠇꠞ꠆ꠔꠣ ꠙꠣꠞꠋꠘ ꠝꠣꠔꠇꠕꠣꠞ ꠙꠣꠔꠣꠔ ꠎꠦꠍꠣꠔꠣ ꠛꠖꠟꠣ ꠛꠖꠟꠤ ꠇꠞꠣꠞ ꠀꠉꠦ ⁕ |
 | This module depends on the following other modules: |
 | This module 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. ꠐꠦꠝ꠆ꠙꠟꠦꠐ: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 1000 portals with images, and displaying 1000 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. The output of this function can be seen at Template:Portal/doc/all.
Usage
[ꠃꠔꠡ ꠟꠦꠈꠁꠘ]{{#invoke:Portal|displayAll}}