Module:Portal/doc

From Soyjak Wiki, the free ensoyclopedia
Jump to navigationJump to search

This is the documentation page for Module:Portal

This module implements {{Portal}} and provides other functionalities. See the template documentation for more usage info.

Portal images and aliases are defined in Module:Portal/images.

Portal image data

[edit source]

Portal images[a] and aliases[b]. /images uses the following format:

return {
    images = {
        ['portal name'] = 'icon.png|link=',

        ['another portal name'] = 'another icon.png|link=',

    },
    aliases = {
        ['alternate name'] = 'portal name',

        ['another alternate name'] = 'another portal name'

    },
}

Image keys must be lowercase portal names. Image values contain the filename without the File: prefix and may include additional file arguments after the filename. The only recommended argument is link=.

Alias keys must be lowercase. Each alias value must correspond directly to a key in the images table. Aliases must not point to other aliases.

Aliases affect image lookup only. They do not change the generated portal link or redirect one portal name to another.

Notes

  1. ↑ these are the small icons that appear in the template.
  2. ↑ aliases are alternate portal names that use the image assigned to another portal. They affect only image lookup and do not change portal links.