Module:DYK nompage links/doc

This is a documentation subpage for Module:DYK nompage links.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used on approximately 87,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 produces the list of links used on Wikipedia:Did you know nomination pages. It implements {{DYK nompage links}}.

Usage from wikitext

Usually, this module should be used via the {{DYK nompage links}} template. However, it can also be used with the syntax {{#invoke:DYK nompage links|main|arguments}}. See Template:DYK nompage links for a list of arguments.

Usage from other Lua modules

To use this module from other Lua modules, first load the module:

local mDYKlinks = require('Module:DYK nompage links')

You can then use the _main function like this:

mDYKlinks._main(nominationPage, historyPages)

nominationPage is the nomination page name, as a string. historyPages is an array of page names to display (also strings). Both parameters are required, and historyPages must have a length of at least one.