Bureaucrats, Interface administrators, Administrators (Semantic MediaWiki), Curators (Semantic MediaWiki), Editors (Semantic MediaWiki), Suppressors, Administrators
19,911
edits
Changes
Jump to navigation
Jump to search
mLine 14:
Line 14: − + − + − cfg['protection-template'] = 'pp-template'+ − + − − -- cfg['protection-template-args'] − -- Any arguments to send to the protection template. This should be a Lua table. − -- For example, if the protection template is "pp-template", and the wikitext template invocation − -- looks like "{{pp-template|docusage=yes}}", then this table should look like "{docusage = 'yes'}". − --]] − Line 39:
Line 32: − + Line 72:
Line 65: + + + + + + + + + Line 89:
Line 91: − + Line 133:
Line 135: − + Line 177:
Line 179: − + Line 230:
Line 232: + + + + Line 254:
Line 260: + + + + Line 269:
Line 279: − + Line 314:
Line 324: − − -- cfg['file-docpage-preload'] − -- Preload file for documentation page in the file namespace. − cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace' Line 328:
Line 334: − + − + − + − + + − + − + − + + − + − + − + − .. ' If you make a change to this template, please update the print version as well.' − + − + − + − − + − + − cfg['print-category'] = 'Templates with print versions'+ − ----------------------------------------------------------------------------------------------------+ − -- HTML and CSS configuration+ − ----------------------------------------------------------------------------------------------------+ − + − − -- The "id" attribute of the main HTML "div" tag. − cfg['main-div-id'] = 'template-documentation' − − -- cfg['main-div-classes'] − − cfg['main-div-classes'] = 'template-documentation iezoomfix' − − -- cfg['start-box-linkclasses'] − -- The CSS classes used for the [view][edit][history] or [create] links in the start box. − − + − + − + − + − + − + − + − + − + − + − + − + − -- cfg['fmbox-textstyle'] − -- The value sent to the "textstyle parameter of {{fmbox}}. − cfg['fmbox-textstyle'] = 'font-style: italic'
Module:Documentation/config (view source)
Revision as of 23:41, 14 March 2022
, 23:41, 14 March 20221 revision imported
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg['protection-template']
-- cfg['protection-reason-edit']
-- The name of the template that displays the protection icon (a padlock on enwiki).
-- The protection reason for edit-protected templates to pass to
-- [[Module:Protection banner]].
cfg['protection-reason-edit'] = 'template'
--[[
cfg['protection-template-args'] = {docusage = 'yes'}
--[[
--[[
-- cfg['sandbox-notice-image']
-- cfg['sandbox-notice-image']
-- The image displayed in the sandbox notice.
-- The image displayed in the sandbox notice.
cfg['sandbox-notice-image'] = '[[Image:Sandbox.png|50px|alt=|link=]]'
cfg['sandbox-notice-image'] = '[[File:Sandbox.svg|50px|alt=|link=]]'
--[[
--[[
-- cfg['sandbox-notice-testcases-blurb']
-- cfg['sandbox-notice-testcases-blurb']
-- cfg['sandbox-notice-testcases-link-display']
-- cfg['sandbox-notice-testcases-link-display']
-- cfg['sandbox-notice-testcases-run-blurb']
-- cfg['sandbox-notice-testcases-run-link-display']
-- cfg['sandbox-notice-testcases-blurb'] is a sentence notifying the user that there is a test cases page
-- cfg['sandbox-notice-testcases-blurb'] is a sentence notifying the user that there is a test cases page
-- corresponding to this sandbox that they can edit. $1 is a link to the test cases page.
-- corresponding to this sandbox that they can edit. $1 is a link to the test cases page.
-- cfg['sandbox-notice-testcases-link-display'] is the display value for that link.
-- cfg['sandbox-notice-testcases-link-display'] is the display value for that link.
-- cfg['sandbox-notice-testcases-run-blurb'] is a sentence notifying the user that there is a test cases page
-- corresponding to this sandbox that they can edit, along with a link to run it. $1 is a link to the test
-- cases page, and $2 is a link to the page to run it.
-- cfg['sandbox-notice-testcases-run-link-display'] is the display value for the link to run the test
-- cases.
--]]
--]]
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'
cfg['sandbox-notice-testcases-link-display'] = 'test cases'
cfg['sandbox-notice-testcases-link-display'] = 'test cases'
cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).'
cfg['sandbox-notice-testcases-run-link-display'] = 'run'
-- cfg['sandbox-category']
-- cfg['sandbox-category']
-- cfg['documentation-icon-wikitext']
-- cfg['documentation-icon-wikitext']
-- The wikitext for the icon shown at the top of the template.
-- The wikitext for the icon shown at the top of the template.
cfg['documentation-icon-wikitext'] = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]'
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
-- cfg['template-namespace-heading']
-- cfg['template-namespace-heading']
-- cfg['transcluded-from-blurb']
-- cfg['transcluded-from-blurb']
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Help:Transclusion|transcluded]] from $1.'
--[[
--[[
-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format:
-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format:
--
--
-- cfg['testcases-link-display'] (cfg['testcases-edit-link-display'])
-- cfg['testcases-link-display'] (cfg['testcases-edit-link-display'] | cfg['testcases-run-link-display'])
--
--
-- If the test cases page doesn't exist, it is in the format:
-- If the test cases page doesn't exist, it is in the format:
-- The text to display for "mirror" links.
-- The text to display for "mirror" links.
cfg['mirror-link-display'] = 'mirror'
cfg['mirror-link-display'] = 'mirror'
-- cfg['mirror-link-preload']
-- The page to preload when a user clicks the "mirror" link.
cfg['mirror-link-preload'] = 'Template:Documentation/mirror'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- The text to display for test cases "edit" links.
-- The text to display for test cases "edit" links.
cfg['testcases-edit-link-display'] = 'edit'
cfg['testcases-edit-link-display'] = 'edit'
-- cfg['testcases-run-link-display']
-- The text to display for test cases "run" links.
cfg['testcases-run-link-display'] = 'run'
-- cfg['testcases-create-link-display']
-- cfg['testcases-create-link-display']
-- link to the /doc subpage with a display value of cfg['doc-link-display'].
-- link to the /doc subpage with a display value of cfg['doc-link-display'].
--]]
--]]
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.'
cfg['add-categories-blurb'] = 'Add categories to the $1 subpage.'
-- cfg['doc-link-display']
-- cfg['doc-link-display']
-- The name of the subpage typically used for documentation pages.
-- The name of the subpage typically used for documentation pages.
cfg['doc-subpage'] = 'doc'
cfg['doc-subpage'] = 'doc'
-- cfg['docpage-preload']
-- cfg['docpage-preload']
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Print version configuration
-- HTML and CSS configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg['print-subpage']
-- cfg['templatestyles']
-- The name of the template subpage used for print versions.
-- The name of the TemplateStyles page where CSS is kept.
cfg['print-subpage'] = 'Print'
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed.
cfg['templatestyles'] = 'Module:Documentation/styles.css'
-- cfg['print-link-display']
-- cfg['container']
-- The text to display when linking to the /Print subpage.
-- Class which can be used to set flex or grid CSS on the
cfg['print-link-display'] = '/Print'
-- two child divs documentation and documentation-metadata
cfg['container'] = 'documentation-container'
-- cfg['print-blurb']
-- cfg['main-div-classes']
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].
-- Classes added to the main HTML "div" tag.
cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'
cfg['main-div-classes'] = 'documentation'
-- cfg['display-print-category']
-- cfg['main-div-heading-class']
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
-- Class for the main heading for templates and modules and assoc. talk spaces
-- This should be a boolean value (either true or false).
cfg['main-div-heading-class'] = 'documentation-heading'
cfg['display-print-category'] = true
-- cfg['print-category']
-- cfg['start-box-class']
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
-- Class for the start box
cfg['start-box-class'] = 'documentation-startbox'
-- cfg['start-box-link-classes']
-- Classes used for the [view][edit][history] or [create] links in the start box.
-- mw-editsection-like is per [[Wikipedia:Village pump (technical)/Archive 117]]
cfg['start-box-link-classes'] = 'mw-editsection-like plainlinks'
-- cfg['main-div-id']
-- The CSS classes added to the main HTML "div" tag.
cfg['start-box-linkclasses'] = 'mw-editsection-like plainlinks'
-- cfg['start-box-link-id']
-- cfg['end-box-class']
-- The HTML "id" attribute for the links in the start box.
-- Class for the end box.
cfg['start-box-link-id'] = 'doc_editlinks'
cfg['end-box-class'] = 'documentation-metadata'
----------------------------------------------------------------------------------------------------
-- cfg['end-box-plainlinks']
-- {{fmbox}} template configuration
-- Plainlinks
----------------------------------------------------------------------------------------------------
cfg['end-box-plainlinks'] = 'plainlinks'
-- cfg['fmbox-id']
-- cfg['toolbar-class']
-- The id sent to the "id" parameter of the {{fmbox}} template.
-- Class added for toolbar links.
cfg['fmbox-id'] = 'documentation-meta-data'
cfg['toolbar-class'] = 'documentation-toolbar'
-- cfg['fmbox-style']
-- cfg['clear']
-- The value sent to the style parameter of {{fmbox}}.
-- Just used to clear things.
cfg['fmbox-style'] = 'background-color: #ecfcf4'
cfg['clear'] = 'documentation-clear'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------