Modul:Portal/doc

Ini ialah laman pendokumenan untuk Modul:Portal

This Lua module is used on approximately 10,200,000 pages, or roughly 178885% of all pages.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This module depends on the following other modules:

This module uses TemplateStyles:

Module:Portal/styles.css

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.

See here, here, and here for test cases.

Portal function

The portal function produces a box of portal links. Templat: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}} → Ralat Lua pada baris 80 di package.lua: module 'Module:Portal/images/a' not found.

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