Module:Check DYK hook/doc
 | This is a documentation subpage for Module:Check DYK hook. It may contain usage information, categories and other content that is not part of the original module page. |
This module checks the format of Wikipedia:Did you know hooks used in {{DYK talk}} and {{Article history}}.
Usage
[edit]This module can be used from templates or from other Lua modules.
From templates
[edit]From templates, call the isValidHook function, and use the |hook= parameter to specify the hook.
{{#invoke:Check DYK hook|isValidHook|hook=hook}}
Valid hooks will return a value of "yes"; invalid hooks will return the empty string.
You can also use the first positional parameter to specify the hook. If you do this, it is recommended to use |1= explicitly; if not, and the hook contains an equals sign, the text before the equals sign will be treated as a parameter name and the hook will not be recognised.
From modules
[edit]From modules, call the _isValidHook function with the hook as the first positional parameter.
mCheckDYKHook = require('Module:Check DYK hook')
result = mCheckDYKHook._isValidHook(hook)
Valid hooks will return true; invalid hooks will return false.