Editing Module:Documentation/config

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 9: Line 9:


local cfg = {} -- Do not edit this line.
local cfg = {} -- Do not edit this line.
----------------------------------------------------------------------------------------------------
-- Protection template configuration
----------------------------------------------------------------------------------------------------
-- cfg['protection-template']
-- The name of the template that displays the protection icon (a padlock on enwiki).
cfg['protection-template'] = 'pp-template'
-- cfg['protection-template-args']
-- Any arguments to send to the protection template.
cfg['protection-template-args'] = {docusage = 'yes'}
----------------------------------------------------------------------------------------------------
-- Sandbox notice configuration
--
-- On sandbox pages the module can display a template notifying users that the current page is a
-- sandbox, and the location of test cases pages, etc. The module decides whether the page is a
-- sandbox or not based on the value of cfg['sandbox-subpage']. The following settings configure the
-- messages that the notices contains.
----------------------------------------------------------------------------------------------------
-- cfg['sandbox-notice-image']
-- The image displayed in the sandbox notice.
cfg['sandbox-notice-image'] = '[[Image:Sandbox.png|50px|alt=|link=]]'
-- cfg['sandbox-notice-blurb']
-- The opening sentence of the sandbox notice. $1 is a link to the main template page.
cfg['sandbox-notice-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.'
-- cfg['sandbox-notice-diff-blurb']
-- cfg['sandbox-notice-diff-display']
-- cfg['sandbox-notice-diff-blurb'] is the opening sentence of the sandbox notice, with a diff link. $1 is a link
-- to the main template page, and $2 is a diff link between the sandbox and the main template. The
-- display value of the diff link is set by cfg['sandbox-notice-compare-link-display'].
cfg['sandbox-notice-diff-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).'
cfg['sandbox-notice-compare-link-display'] = 'diff'
-- cfg['sandbox-notice-testcases-blurb']
-- cfg['sandbox-notice-testcases-link-display']
-- 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.
-- cfg['sandbox-notice-testcases-link-display'] is the display value for that link.
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'
cfg['sandbox-notice-testcases-link-display'] = 'test cases'
-- cfg['sandbox-category']
-- A category to add to all template sandboxes.
cfg['sandbox-category'] = 'Template sandboxes'


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Line 16: Line 65:
-- 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:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
cfg['documentation-icon-wikitext'] = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]'


-- cfg['template-namespace-heading']
-- cfg['template-namespace-heading']
Line 60: Line 109:
-- 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 [[w:Wikipedia:Template documentation|documentation]] is [[mw:Help:Transclusion|transcluded]] from $1.'
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'


--[[
-- cfg['create-module-doc-blurb']
-- cfg['create-module-doc-blurb']
-- Notice displayed in the module namespace when the documentation subpage does not exist.
-- Notice displayed in the module namespace when the documentation subpage does not exist.
-- $1 is a link to create the documentation page with the preload cfg['module-preload'] and the
-- $1 is a link to create the documentation page with the preload cfg['module-preload'] and the
-- display cfg['create-link-display'].
-- display cfg['create-link-display'].
--]]
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[mw:Extension:Scribunto/Lua reference manual|Scribunto module]].'


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Line 74: Line 121:
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------


--[[
-- cfg['experiment-blurb-template']
-- cfg['experiment-blurb-template']
-- cfg['experiment-blurb-module']
-- cfg['experiment-blurb-module']
Line 104: Line 150:
-- $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-run-link-display'])
--    cfg['testcases-link-display'] (cfg['testcases-edit-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:
Line 113: Line 159:
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current
-- namespace.
-- namespace.
--]]
cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages."
cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages."
cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages."
cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages."
Line 157: Line 202:
-- 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'


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Line 185: Line 226:
-- 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']
Line 198: Line 235:
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------


--[[
-- cfg['add-categories-blurb']
-- cfg['add-categories-blurb']
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a
-- 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']
Line 214: Line 249:
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------


--[[
-- cfg['subpages-blurb']
-- The "Subpages of this template" blurb. $1 is a link to the main template's subpages with a
-- display value of cfg['subpages-link-display']. In the English version this blurb is simply
-- the link followed by a period, and the link display provides the actual text.
--]]
cfg['subpages-blurb'] = '$1.'
--[[
-- cfg['subpages-link-display']
-- cfg['subpages-link-display']
-- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'],
-- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'],
-- cfg['module-pagetype'] or cfg['default-pagetype'], depending on whether the current page is in
-- cfg['module-pagetype'] or cfg['default-pagetype'], depending on whether the current page is in
-- the template namespace, the module namespace, or another namespace.
-- the template namespace, the module namespace, or another namespace.
--]]
cfg['subpages-link-display'] = 'Subpages of this $1'
cfg['subpages-link-display'] = 'Subpages of this $1'


Line 249: Line 274:
-- 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['file-docpage-preload']
-- Preload file for documentation page in the file namespace.
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'


-- cfg['docpage-preload']
-- cfg['docpage-preload']
Line 259: Line 288:


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- HTML and CSS configuration
-- Print version configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------


-- cfg['templatestyles']
-- cfg['print-subpage']
-- The name of the TemplateStyles page where CSS is kept.
-- The name of the template subpage used for print versions.
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed.
cfg['print-subpage'] = 'Print'
cfg['templatestyles'] = 'Module:Documentation/styles.css'
 
-- cfg['print-link-display']
-- The text to display when linking to the /Print subpage.
cfg['print-link-display'] = '/Print'
 
-- cfg['print-blurb']
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].
cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'
.. ' If you make a change to this template, please update the print version as well.'
 
-- cfg['display-print-category']
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
cfg['display-print-category'] = true


-- cfg['container']
-- cfg['print-category']
-- Class which can be used to set flex or grid CSS on the
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
-- two child divs documentation and documentation-metadata
cfg['print-category'] = 'Templates with print versions'
cfg['container'] = 'documentation-container'


-- cfg['main-div-classes']
----------------------------------------------------------------------------------------------------
-- Classes added to the main HTML "div" tag.
-- HTML and CSS configuration
cfg['main-div-classes'] = 'documentation'
----------------------------------------------------------------------------------------------------


-- cfg['main-div-heading-class']
-- cfg['main-div-id']
-- Class for the main heading for templates and modules and assoc. talk spaces
-- The "id" attribute of the main HTML "div" tag.
cfg['main-div-heading-class'] = 'documentation-heading'
cfg['main-div-id'] = 'template-documentation'


-- cfg['start-box-class']
-- cfg['main-div-classes']
-- Class for the start box
-- The CSS classes added to the main HTML "div" tag.
cfg['start-box-class'] = 'documentation-startbox'
cfg['main-div-classes'] = 'template-documentation iezoomfix'


-- cfg['start-box-link-classes']
-- cfg['start-box-linkclasses']
-- Classes used for the [view][edit][history] or [create] links in the start box.
-- The CSS 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-linkclasses'] = 'mw-editsection plainlinks'
cfg['start-box-link-classes'] = 'mw-editsection-like plainlinks'


-- cfg['end-box-class']
-- cfg['start-box-link-id']
-- Class for the end box.
-- The HTML "id" attribute for the links in the start box.
cfg['end-box-class'] = 'documentation-metadata'
cfg['start-box-link-id'] = 'doc_editlinks'


-- cfg['end-box-plainlinks']
----------------------------------------------------------------------------------------------------
-- Plainlinks
-- {{fmbox}} template configuration
cfg['end-box-plainlinks'] = 'plainlinks'
----------------------------------------------------------------------------------------------------


-- cfg['toolbar-class']
-- cfg['fmbox-id']
-- Class added for toolbar links.
-- The id sent to the "id" parameter of the {{fmbox}} template.
cfg['toolbar-class'] = 'documentation-toolbar'
cfg['fmbox-id'] = 'documentation-meta-data'


-- cfg['clear']
-- cfg['fmbox-style']
-- Just used to clear things.
-- The value sent to the style parameter of {{fmbox}}.
cfg['clear'] = 'documentation-clear'
cfg['fmbox-style'] = 'background-color: #ecfcf4'


-- cfg['fmbox-textstyle']
-- The value sent to the "textstyle parameter of {{fmbox}}.
cfg['fmbox-textstyle'] = 'font-style: italic'


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Line 312: Line 354:
-- cfg['display-strange-usage-category']
-- cfg['display-strange-usage-category']
-- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage
-- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage
-- or a /testcases subpage. This should be a boolean value (either true or false).
-- or a /testcases subpage.
cfg['display-strange-usage-category'] = true
cfg['display-strange-usage-category'] = true


Line 320: Line 362:
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'


--[[
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- End configuration
-- End configuration
Line 326: Line 367:
-- Don't edit anything below this line.
-- Don't edit anything below this line.
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
--]]


return cfg
return cfg
Please note that all contributions to Meta Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Meta Wiki:Copyrights for details). Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Retrieved from "https://meta.skywiki.org/wiki/Module:Documentation/config"