Module:Citation mode/doc
 | This is a documentation subpage for Module:Citation mode. It may contain usage information, categories and other content that is not part of the original module page. |
| This is a documentation subpage for Module:Citation mode. 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 4,700 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 function is intended to be used in |mode= for templates which wrap other citation templates. It outputs its argument unless {{CS1 config}} configures a page-wide mode on the current page, in which case it outputs nothing. The effect of this is that templates invoking this module do not set a mode, allowing the parent template to obey the page-wide mode set in {{CS1 config}}.
Wrapper templates should not attempt to access {{CS1 config}} directly, because this would cause them to be incorrectly added to Category:CS1 maint: overridden setting.
Usage
[edit]{{#invoke:Citation mode|main|mode}}
- returns empty if {{CS1 config}} mode is set on page, otherwise returns mode argument.
Tests
[edit]Because the behavior of this module depends on global read-only state, tests are split between two files:
- The tests without {{CS1 config}} being used are here, with results here.
- The tests with {{CS1 config}} being used are here, with results here.
See also
[edit]- Help:Citation Style 1 § csdoc mode
- Help talk:Citation Style 1/Archive 95 § CS1 wrapper templates using "mode"