Actions

Module

Editing Documentation/config

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 save 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.
 +
 +
----------------------------------------------------------------------------------------------------
 +
-- Environment configuration
 +
----------------------------------------------------------------------------------------------------
 +
 +
-- cfg.errorPrefix
 +
-- The prefix before any error messages found by the script.
 +
cfg.errorPrefix = '[[Module:Documentation]] error:'
 +
 +
-- cfg.errorCategory
 +
-- The category pages are placed into if any errors are found.
 +
cfg.errorCategory = 'Documentation template invocations with errors'
 +
 +
----------------------------------------------------------------------------------------------------
 +
-- Environment configuration
 +
----------------------------------------------------------------------------------------------------
 +
 +
-- cfg.titleArgError
 +
-- The error message to display if the "page" argument does not result in a
 +
-- valid title.
 +
cfg.titleArgError = '$1 is not a valid title'
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 14: Line 35:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
-- cfg['protection-reason-edit']
+
-- cfg.protectionTemplate
−
-- The protection reason for edit-protected templates to pass to
+
-- The name of the template that displays the protection icon (a padlock on enwiki).
−
-- [[Module:Protection banner]].
+
cfg.protectionTemplate = 'pp-template'
−
cfg['protection-reason-edit'] = 'template'
+
 
 +
-- cfg.protectionTemplateArgs
 +
-- Any arguments to send to the protection template.
 +
cfg.protectionTemplateArgs = {docusage = 'yes'}
  
−
--[[
 
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
 
-- Sandbox notice configuration
 
-- Sandbox notice configuration
Line 25: Line 48:
 
-- On sandbox pages the module can display a template notifying users that the current page is a
 
-- 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, 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
+
-- sandbox or not based on the value of cfg.sandboxSubpage. The following settings configure the
 
-- messages that the notices contains.
 
-- messages that the notices contains.
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
−
--]]
 
  
−
-- cfg['sandbox-notice-image']
+
-- cfg.sandboxNoticeImage
 
-- The image displayed in the sandbox notice.
 
-- The image displayed in the sandbox notice.
−
cfg['sandbox-notice-image'] = '[[Image:Sandbox.svg|50px|alt=|link=]]'
+
cfg.sandboxNoticeImage = '[[Image:Sandbox.png|50px|alt=|link=]]'
  
−
--[[
+
-- cfg.sandboxNoticeBlurb
−
-- cfg['sandbox-notice-pagetype-template']
+
-- The opening sentence of the sandbox notice. $1 is a link to the main template page.
−
-- cfg['sandbox-notice-pagetype-module']
+
cfg.sandboxNoticeBlurb = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.'
−
-- cfg['sandbox-notice-pagetype-other']
 
−
-- The page type of the sandbox page. The message that is displayed depends on the current subject
 
−
-- namespace. This message is used in either cfg['sandbox-notice-blurb'] or
 
−
-- cfg['sandbox-notice-diff-blurb'].
 
−
--]]
 
−
cfg['sandbox-notice-pagetype-template'] = '[[Wikipedia:Template test cases|template sandbox]] page'
 
−
cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'
 
−
cfg['sandbox-notice-pagetype-other'] = 'sandbox page'
 
  
−
--[[
+
-- cfg.sandboxNoticeDiffBlurb
−
-- cfg['sandbox-notice-blurb']
+
-- cfg.sandboxNoticeDiffDisplay
−
-- cfg['sandbox-notice-diff-blurb']
+
-- cfg.sandboxNoticeDiffBlurb is the opening sentence of the sandbox notice, with a diff link. $1 is a link
−
-- cfg['sandbox-notice-diff-display']
+
-- to the main template page, and $2 is a diff link between the sandbox and the main template. The
−
-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence
+
-- display value of the diff link is set by cfg.sandboxNoticeDiffDisplay.
−
-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page
+
cfg.sandboxNoticeDiffBlurb = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).'
−
-- type, which is either cfg['sandbox-notice-pagetype-template'],
+
cfg.sandboxNoticeDiffDisplay = 'diff'
−
-- cfg['sandbox-notice-pagetype-module'] or cfg['sandbox-notice-pagetype-other'] depending what
 
−
-- namespace we are in. $2 is a link to the main template page, and $3 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-blurb'] = 'This is the $1 for $2.'
 
−
cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'
 
−
cfg['sandbox-notice-compare-link-display'] = 'diff'
 
  
−
--[[
+
-- cfg.sandboxNoticeTestcasesBlurb
−
-- cfg['sandbox-notice-testcases-blurb']
+
-- cfg.sandboxNoticeTestcasesLinkDisplay
−
-- cfg['sandbox-notice-testcases-link-display']
+
-- cfg.sandboxNoticeTestcasesBlurb is a sentence notifying the user that there is a test cases page
−
-- 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
 
 
-- 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.sandboxNoticeTestcasesLinkDisplay 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
+
cfg.sandboxNoticeTestcasesBlurb = 'See also the companion subpage for $1.'
−
-- corresponding to this sandbox that they can edit, along with a link to run it. $1 is a link to the test
+
cfg.sandboxNoticeTestcasesLinkDisplay = 'test cases'
−
-- 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-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']
 
−
-- A category to add to all template sandboxes.
 
−
cfg['sandbox-category'] = 'Template sandboxes'
 
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 89: Line 80:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
-- cfg['documentation-icon-wikitext']
+
-- cfg.documentationIconWikitext
 
-- 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.documentationIconWikitext = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]'
  
−
-- cfg['template-namespace-heading']
+
-- cfg.templateNamespaceHeading
 
-- The heading shown in the template namespace.
 
-- The heading shown in the template namespace.
−
cfg['template-namespace-heading'] = 'Template documentation'
+
cfg.templateNamespaceHeading = 'Template documentation'
  
−
-- cfg['module-namespace-heading']
+
-- cfg.moduleNamespaceHeading
 
-- The heading shown in the module namespace.
 
-- The heading shown in the module namespace.
−
cfg['module-namespace-heading'] = 'Module documentation'
+
cfg.moduleNamespaceHeading = 'Module documentation'
  
−
-- cfg['file-namespace-heading']
+
-- cfg.fileNamespaceHeading
 
-- The heading shown in the file namespace.
 
-- The heading shown in the file namespace.
−
cfg['file-namespace-heading'] = 'Summary'
+
cfg.fileNamespaceHeading = 'Summary'
  
−
-- cfg['other-namespaces-heading']
+
-- cfg.otherNamespacesHeading
 
-- The heading shown in other namespaces.
 
-- The heading shown in other namespaces.
−
cfg['other-namespaces-heading'] = 'Documentation'
+
cfg.otherNamespacesHeading = 'Documentation'
  
−
-- cfg['view-link-display']
+
-- cfg.viewLinkDisplay
 
-- The text to display for "view" links.
 
-- The text to display for "view" links.
−
cfg['view-link-display'] = 'view'
+
cfg.viewLinkDisplay = 'view'
  
−
-- cfg['edit-link-display']
+
-- cfg.editLinkDisplay
 
-- The text to display for "edit" links.
 
-- The text to display for "edit" links.
−
cfg['edit-link-display'] = 'edit'
+
cfg.editLinkDisplay = 'edit'
  
−
-- cfg['history-link-display']
+
-- cfg.historyLinkDisplay
 
-- The text to display for "history" links.
 
-- The text to display for "history" links.
−
cfg['history-link-display'] = 'history'
+
cfg.historyLinkDisplay = 'history'
  
−
-- cfg['purge-link-display']
+
-- cfg.purgeLinkDisplay
 
-- The text to display for "purge" links.
 
-- The text to display for "purge" links.
−
cfg['purge-link-display'] = 'purge'
+
cfg.purgeLinkDisplay = 'purge'
  
−
-- cfg['create-link-display']
+
-- cfg.createLinkDisplay
 
-- The text to display for "create" links.
 
-- The text to display for "create" links.
−
cfg['create-link-display'] = 'create'
+
cfg.createLinkDisplay = 'create'
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 133: Line 124:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
-- cfg['transcluded-from-blurb']
+
-- cfg.transcludedFromBlurb
 
-- 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.transcludedFromBlurb = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'
  
−
--[[
+
-- cfg.createModuleDocBlurb
−
-- 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.modulePreload and the
−
-- display cfg['create-link-display'].
+
-- display cfg.createLinkDisplay.
−
--]]
+
cfg.createModuleDocBlurb = '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 [[Wikipedia:Lua|Scribunto module]].'
 
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 149: Line 138:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
--[[
+
-- cfg.experimentBlurbTemplate
−
-- cfg['experiment-blurb-template']
+
-- cfg.experimentBlurbModule
−
-- cfg['experiment-blurb-module']
 
 
-- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages.
 
-- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages.
 
-- It is only shown in the template and module namespaces. With the default English settings, it
 
-- It is only shown in the template and module namespaces. With the default English settings, it
Line 160: Line 148:
 
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
 
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
 
--
 
--
−
-- There are two versions, cfg['experiment-blurb-template'] and cfg['experiment-blurb-module'], depending
+
-- There are two versions, cfg.experimentBlurbTemplate and cfg.experimentBlurbModule, depending
 
-- on what namespace we are in.
 
-- on what namespace we are in.
 
--  
 
--  
Line 167: Line 155:
 
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:
 
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:
 
--
 
--
−
--    cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display'])
+
--    cfg.sandboxLinkDisplay (cfg.sandboxEditLinkDisplay | cfg.compareLinkDisplay)
 
--  
 
--  
 
-- If the sandbox doesn't exist, it is in the format:
 
-- If the sandbox doesn't exist, it is in the format:
 
--
 
--
−
--    cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display'])
+
--    cfg.sandboxLinkDisplay (cfg.sandboxCreateLinkDisplay | cfg.mirrorLinkDisplay)
 
--  
 
--  
−
-- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload']
+
-- The link for cfg.sandboxCreateLinkDisplay link preloads the page with cfg.templateSandboxPreload
−
-- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display']
+
-- or cfg.moduleSandboxPreload, depending on the current namespace. The link for cfg.mirrorLinkDisplay
−
-- loads a default edit summary of cfg['mirror-edit-summary'].
+
-- loads a default edit summary of cfg.mirrorEditSummary.
 
--
 
--
 
-- $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.testcasesLinkDisplay (cfg.testcasesEditLinkDisplay)
 
--
 
--
 
-- 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:
 
--  
 
--  
−
--    cfg['testcases-link-display'] (cfg['testcases-create-link-display'])
+
--    cfg.testcasesLinkDisplay (cfg.testcasesCreateLinkDisplay)
 
--
 
--
−
-- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the
+
-- If the test cases page doesn't exist, the link for cfg.testcasesCreateLinkDisplay preloads the
−
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current
+
-- page with cfg.templateTestcasesPreload or cfg.moduleTestcasesPreload, depending on the current
 
-- namespace.
 
-- namespace.
−
--]]
+
cfg.experimentBlurbTemplate = "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.experimentBlurbModule = "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 196: Line 183:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
-- cfg['sandbox-subpage']
+
-- cfg.sandboxSubpage
 
-- The name of the template subpage typically used for sandboxes.
 
-- The name of the template subpage typically used for sandboxes.
−
cfg['sandbox-subpage'] = 'sandbox'
+
cfg.sandboxSubpage = 'sandbox'
  
−
-- cfg['template-sandbox-preload']
+
-- cfg.templateSandboxPreload
 
-- Preload file for template sandbox pages.
 
-- Preload file for template sandbox pages.
−
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'
+
cfg.templateSandboxPreload = 'Template:Documentation/preload-sandbox'
  
−
-- cfg['module-sandbox-preload']
+
-- cfg.moduleSandboxPreload
 
-- Preload file for Lua module sandbox pages.
 
-- Preload file for Lua module sandbox pages.
−
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'
+
cfg.moduleSandboxPreload = 'Template:Documentation/preload-module-sandbox'
  
−
-- cfg['sandbox-link-display']
+
-- cfg.sandboxLinkDisplay
 
-- The text to display for "sandbox" links.
 
-- The text to display for "sandbox" links.
−
cfg['sandbox-link-display'] = 'sandbox'
+
cfg.sandboxLinkDisplay = 'sandbox'
  
−
-- cfg['sandbox-edit-link-display']
+
-- cfg.sandboxEditLinkDisplay
 
-- The text to display for sandbox "edit" links.
 
-- The text to display for sandbox "edit" links.
−
cfg['sandbox-edit-link-display'] = 'edit'
+
cfg.sandboxEditLinkDisplay = 'edit'
  
−
-- cfg['sandbox-create-link-display']
+
-- cfg.sandboxCreateLinkDisplay
 
-- The text to display for sandbox "create" links.
 
-- The text to display for sandbox "create" links.
−
cfg['sandbox-create-link-display'] = 'create'
+
cfg.sandboxCreateLinkDisplay = 'create'
  
−
-- cfg['compare-link-display']
+
-- cfg.compareLinkDisplay
 
-- The text to display for "compare" links.
 
-- The text to display for "compare" links.
−
cfg['compare-link-display'] = 'diff'
+
cfg.compareLinkDisplay = 'diff'
  
−
-- cfg['mirror-edit-summary']
+
-- cfg.mirrorEditSummary
 
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
 
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
 
-- template page.
 
-- template page.
−
cfg['mirror-edit-summary'] = 'Create sandbox version of $1'
+
cfg.mirrorEditSummary = 'Create sandbox version of $1'
  
−
-- cfg['mirror-link-display']
+
-- cfg.mirrorLinkDisplay
 
-- The text to display for "mirror" links.
 
-- The text to display for "mirror" links.
−
cfg['mirror-link-display'] = 'mirror'
+
cfg.mirrorLinkDisplay = 'mirror'
−
 
 
−
-- cfg['mirror-link-preload']
 
−
-- The page to preload when a user clicks the "mirror" link.
 
−
cfg['mirror-link-preload'] = 'Template:Documentation/mirror'
 
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 241: Line 224:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
-- cfg['testcases-subpage']
+
-- cfg.testcasesSubpage
 
-- The name of the template subpage typically used for test cases.
 
-- The name of the template subpage typically used for test cases.
−
cfg['testcases-subpage'] = 'testcases'
+
cfg.testcasesSubpage = 'testcases'
  
−
-- cfg['template-testcases-preload']
+
-- cfg.templateTestcasesPreload
 
-- Preload file for template test cases pages.
 
-- Preload file for template test cases pages.
−
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'
+
cfg.templateTestcasesPreload = 'Template:Documentation/preload-testcases'
  
−
-- cfg['module-testcases-preload']
+
-- cfg.moduleTestcasesPreload
 
-- Preload file for Lua module test cases pages.
 
-- Preload file for Lua module test cases pages.
−
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'
+
cfg.moduleTestcasesPreload = 'Template:Documentation/preload-module-testcases'
  
−
-- cfg['testcases-link-display']
+
-- cfg.testcasesLinkDisplay
 
-- The text to display for "testcases" links.
 
-- The text to display for "testcases" links.
−
cfg['testcases-link-display'] = 'testcases'
+
cfg.testcasesLinkDisplay = 'testcases'
  
−
-- cfg['testcases-edit-link-display']
+
-- cfg.testcasesEditLinkDisplay
 
-- 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.testcasesEditLinkDisplay = '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.testcasesCreateLinkDisplay
 
-- The text to display for test cases "create" links.
 
-- The text to display for test cases "create" links.
−
cfg['testcases-create-link-display'] = 'create'
+
cfg.testcasesCreateLinkDisplay = 'create'
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 273: Line 252:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
--[[
+
-- cfg.addCategoriesBlurb
−
-- 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.docLinkDisplay.
−
--]]
+
cfg.addCategoriesBlurb = 'Please add categories to the $1 subpage.'
−
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.'
 
  
−
-- cfg['doc-link-display']
+
-- cfg.docLinkDisplay
 
-- The text to display when linking to the /doc subpage.
 
-- The text to display when linking to the /doc subpage.
−
cfg['doc-link-display'] = '/doc'
+
cfg.docLinkDisplay = '/doc'
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 289: Line 266:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
--[[
+
-- cfg.subpagesLinkDisplay
−
-- cfg['subpages-blurb']
+
-- The text to display for the "subpages of this page" link. $1 is cfg.templatePagetype,
−
-- The "Subpages of this template" blurb. $1 is a link to the main template's subpages with a
+
-- cfg.modulePagetype or cfg.defaultPagetype, depending on whether the current page is in th
−
-- display value of cfg['subpages-link-display']. In the English version this blurb is simply
+
-- e template namespace, the module namespace, or another namespace.
−
-- the link followed by a period, and the link display provides the actual text.
+
cfg.subpagesLinkDisplay = 'Subpages of this $1'
−
--]]
 
−
cfg['subpages-blurb'] = '$1.'
 
−
 
 
−
--[[
 
−
-- cfg['subpages-link-display']
 
−
-- 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
 
−
-- the template namespace, the module namespace, or another namespace.
 
−
--]]
 
−
cfg['subpages-link-display'] = 'Subpages of this $1'
 
  
−
-- cfg['template-pagetype']
+
-- cfg.templatePagetype
 
-- The pagetype to display for template pages.
 
-- The pagetype to display for template pages.
−
cfg['template-pagetype'] = 'template'
+
cfg.templatePagetype = 'template'
  
−
-- cfg['module-pagetype']
+
-- cfg.modulePagetype
 
-- The pagetype to display for Lua module pages.
 
-- The pagetype to display for Lua module pages.
−
cfg['module-pagetype'] = 'module'
+
cfg.modulePagetype = 'module'
  
−
-- cfg['default-pagetype']
+
-- cfg.defaultPagetype
 
-- The pagetype to display for pages other than templates or Lua modules.
 
-- The pagetype to display for pages other than templates or Lua modules.
−
cfg['default-pagetype'] = 'page'
+
cfg.defaultPagetype = 'page'
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 321: Line 288:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
-- cfg['doc-subpage']
+
-- cfg.docSubpage
 
-- 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.docSubpage = 'doc'
  
−
-- cfg['file-docpage-preload']
+
-- cfg.fileDocpagePreload
 
-- Preload file for documentation page in the file namespace.
 
-- Preload file for documentation page in the file namespace.
−
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'
+
cfg.fileDocpagePreload = 'Template:Documentation/preload-filespace'
  
−
-- cfg['docpage-preload']
+
-- cfg.docpagePreload
 
-- Preload file for template documentation pages in all namespaces.
 
-- Preload file for template documentation pages in all namespaces.
−
cfg['docpage-preload'] = 'Template:Documentation/preload'
+
cfg.docpagePreload = 'Template:Documentation/preload'
  
−
-- cfg['module-preload']
+
-- cfg.modulePreload
 
-- Preload file for Lua module documentation pages.
 
-- Preload file for Lua module documentation pages.
−
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'
+
cfg.modulePreload = 'Template:Documentation/preload-module-doc'
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 341: Line 308:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
-- cfg['print-subpage']
+
-- cfg.printSubpage
 
-- The name of the template subpage used for print versions.
 
-- The name of the template subpage used for print versions.
−
cfg['print-subpage'] = 'Print'
+
cfg.printSubpage = 'Print'
  
−
-- cfg['print-link-display']
+
-- cfg.printLinkDisplay
 
-- The text to display when linking to the /Print subpage.
 
-- The text to display when linking to the /Print subpage.
−
cfg['print-link-display'] = '/Print'
+
cfg.printLinkDisplay = '/Print'
  
−
-- cfg['print-blurb']
+
-- cfg.printBlurb
−
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].
+
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg.printLinkDisplay.
−
cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'
+
cfg.printBlurb = '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.'
 
.. ' If you make a change to this template, please update the print version as well.'
  
−
-- cfg['display-print-category']
+
-- cfg.displayPrintCategory
−
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
+
-- Set to true to enable output of cfg.printCategory if a /Print subpage exists.
−
-- This should be a boolean value (either true or false).
+
cfg.displayPrintCategory = true
−
cfg['display-print-category'] = true
 
  
−
-- cfg['print-category']
+
-- cfg.printCategory
−
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
+
-- Category to output if cfg.displayPrintCategory is set to true, and a /Print subpage exists.
−
cfg['print-category'] = 'Templates with print versions'
+
cfg.printCategory = 'Templates with print versions'
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 367: Line 333:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
-- cfg['main-div-id']
+
-- cfg.mainDivId
 
-- The "id" attribute of the main HTML "div" tag.
 
-- The "id" attribute of the main HTML "div" tag.
−
cfg['main-div-id'] = 'template-documentation'
+
cfg.mainDivId = 'template-documentation'
  
−
-- cfg['main-div-classes']
+
-- cfg.mainDivClasses
 
-- The CSS classes added to the main HTML "div" tag.
 
-- The CSS classes added to the main HTML "div" tag.
−
cfg['main-div-classes'] = 'template-documentation iezoomfix'
+
cfg.mainDivClasses = 'template-documentation iezoomfix'
  
−
-- cfg['start-box-linkclasses']
+
-- cfg.startBoxLinkclasses
 
-- The CSS 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.
−
cfg['start-box-linkclasses'] = 'mw-editsection-like plainlinks'
+
cfg.startBoxLinkclasses = 'mw-editsection plainlinks'
  
−
-- cfg['start-box-link-id']
+
-- cfg.startBoxLinkId
 
-- The HTML "id" attribute for the links in the start box.
 
-- The HTML "id" attribute for the links in the start box.
−
cfg['start-box-link-id'] = 'doc_editlinks'
+
cfg.startBoxLinkId = 'doc_editlinks'
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 387: Line 353:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
-- cfg['fmbox-id']
+
-- cfg.fmboxId
 
-- The id sent to the "id" parameter of the {{fmbox}} template.
 
-- The id sent to the "id" parameter of the {{fmbox}} template.
−
cfg['fmbox-id'] = 'documentation-meta-data'
+
cfg.fmboxId = 'documentation-meta-data'
 +
 
 +
-- cfg.fmboxImageNone
 +
-- The value to suppress image output from the "image" parameter of {{fmbox}}.
 +
cfg.fmboxImageNone = 'none'
  
−
-- cfg['fmbox-style']
+
-- cfg.fmboxStyle
 
-- The value sent to the style parameter of {{fmbox}}.
 
-- The value sent to the style parameter of {{fmbox}}.
−
cfg['fmbox-style'] = 'background-color: #ecfcf4'
+
cfg.fmboxStyle = 'background-color: #ecfcf4'
  
−
-- cfg['fmbox-textstyle']
+
-- cfg.fmboxTextstyle
 
-- The value sent to the "textstyle parameter of {{fmbox}}.
 
-- The value sent to the "textstyle parameter of {{fmbox}}.
−
cfg['fmbox-textstyle'] = 'font-style: italic'
+
cfg.fmboxTextstyle = 'font-style: italic'
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 403: Line 373:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
-- cfg['display-strange-usage-category']
+
-- cfg.displayStrangeUsageCategory
−
-- 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.strangeUsageCategory 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.displayStrangeUsageCategory = true
  
−
-- cfg['strange-usage-category']
+
-- cfg.strangeUsageCategory
−
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a
+
-- Category to output if cfg.displayStrangeUsageCategory is set to true and the module is used on a
 
-- /doc subpage or a /testcases subpage.
 
-- /doc subpage or a /testcases subpage.
−
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'
+
cfg.strangeUsageCategory = 'Wikipedia pages with strange ((documentation)) usage'
 +
 
 +
-- cfg.strangeUsageCategoryMainspaceSort
 +
-- Category sort key prefix to use for cfg.strangeUsageCategory in the main namespace. The prefix
 +
-- is followed by the full page name.
 +
cfg.strangeUsageCategoryMainspaceSort = 'Main:'
  
−
--[[
 
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
 
-- End configuration
 
-- End configuration
Line 419: Line 393:
 
-- Don't edit anything below this line.
 
-- Don't edit anything below this line.
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
−
--]]
 
  
 
return cfg
 
return cfg

Please note that all contributions to Unofficial Stationeers 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 Unofficial Stationeers Wiki:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)
Retrieved from "https://stationeers-wiki.com/Module:Documentation/config"