Module:Subject bar/doc

This is the documentation page for Module:Subject bar

This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected.

This Lua module is used on approximately 17,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them.

This module depends on the following other modules:

This module implements the {{Subject bar}} template. Please don't use this module from an article or from another wiki page. You should use the {{Subject bar}} template instead. To use the module from another Lua module, read on.

For test cases, see {{Subject bar/testcases}}.

Use from another Lua module

Load the module like this:

local subjectBar = require('Module:Subject bar')._main

Then you can use the subjectBar function like this:

local myBar = subjectBar{
    portal = 'Portal 1',
    portal2 = 'Portal 2',
    -- ...
    commons = true,
    commons-search = 'Commons search string',
    wikt = true,
    wikt-search = 'Wiktionary search string'
    -- ...
}

Please see Template:Subject bar/doc for a full list of possible parameters.