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['error-prefix']
 +
-- The prefix before any error messages found by the script.
 +
cfg['error-prefix'] = '[[Module:Documentation]] error:'
 +
 +
-- cfg['error-category']
 +
-- The category pages are placed into if any errors are found.
 +
cfg['error-category'] = 'Documentation template invocations with errors'
 +
 +
----------------------------------------------------------------------------------------------------
 +
-- Environment configuration
 +
----------------------------------------------------------------------------------------------------
 +
 +
-- cfg['title-arg-error']
 +
-- The error message to display if the "page" argument does not result in a
 +
-- valid title.
 +
cfg['title-arg-error'] = '$1 is not a valid title'
  
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 14: Line 35:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
-- cfg['protection-reason-edit']
+
-- cfg['protection-template']
−
-- 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['protection-template'] = 'pp-template'
−
cfg['protection-reason-edit'] = 'template'
+
 
 +
-- cfg['protection-template-args']
 +
-- Any arguments to send to the protection template.
 +
cfg['protection-template-args'] = {docusage = 'yes'}
  
−
--[[
 
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
 
-- Sandbox notice configuration
 
-- Sandbox notice configuration
Line 28: Line 51:
 
-- messages that the notices contains.
 
-- messages that the notices contains.
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
−
--]]
 
  
 
-- 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.svg|50px|alt=|link=]]'
+
cfg['sandbox-notice-image'] = '[[Image:Sandbox.png|50px|alt=|link=]]'
  
−
--[[
+
-- cfg['sandbox-notice-blurb']
−
-- 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['sandbox-notice-blurb'] = '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['sandbox-notice-blurb']
 
 
-- cfg['sandbox-notice-diff-blurb']
 
-- cfg['sandbox-notice-diff-blurb']
 
-- cfg['sandbox-notice-diff-display']
 
-- cfg['sandbox-notice-diff-display']
−
-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence
+
-- cfg['sandbox-notice-diff-blurb'] is the opening sentence of the sandbox notice, with a diff link. $1 is a link
−
-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page
+
-- to the main template page, and $2 is a diff link between the sandbox and the main template. The
−
-- type, which is either cfg['sandbox-notice-pagetype-template'],
+
-- display value of the diff link is set by cfg['sandbox-notice-compare-link-display'].
−
-- cfg['sandbox-notice-pagetype-module'] or cfg['sandbox-notice-pagetype-other'] depending what
+
cfg['sandbox-notice-diff-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).'
−
-- 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['sandbox-notice-compare-link-display'] = 'diff'
  
−
--[[
 
 
-- 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']
Line 91: Line 86:
 
-- 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 137: Line 132:
 
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 [[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 [[Wikipedia:Lua|Scribunto module]].'
  
Line 149: Line 142:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
--[[
 
 
-- cfg['experiment-blurb-template']
 
-- cfg['experiment-blurb-template']
 
-- cfg['experiment-blurb-module']
 
-- cfg['experiment-blurb-module']
Line 179: Line 171:
 
-- $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 188: Line 180:
 
-- 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 232: Line 223:
 
-- 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 260: Line 247:
 
-- 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 273: Line 256:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
--[[
 
 
-- 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'] = 'Please add categories to the $1 subpage.'
  
Line 289: Line 270:
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
  
−
--[[
 
−
-- 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 356: Line 327:
 
-- cfg['display-print-category']
 
-- cfg['display-print-category']
 
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
 
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
−
-- This should be a boolean value (either true or false).
 
 
cfg['display-print-category'] = true
 
cfg['display-print-category'] = true
  
Line 377: Line 347:
 
-- cfg['start-box-linkclasses']
 
-- cfg['start-box-linkclasses']
 
-- 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['start-box-linkclasses'] = 'mw-editsection plainlinks'
  
 
-- cfg['start-box-link-id']
 
-- cfg['start-box-link-id']
Line 390: Line 360:
 
-- 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['fmbox-id'] = 'documentation-meta-data'
 +
 +
-- cfg['fmbox-image-none']
 +
-- The value to suppress image output from the "image" parameter of {{fmbox}}.
 +
cfg['fmbox-image-none'] = 'none'
  
 
-- cfg['fmbox-style']
 
-- cfg['fmbox-style']
Line 405: Line 379:
 
-- 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 413: Line 387:
 
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'
 
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'
  
−
--[[
+
-- cfg['strange-usage-category-mainspace-sort']
 +
-- Category sort key prefix to use for cfg['strange-usage-category'] in the main namespace. The prefix
 +
-- is followed by the full page name.
 +
cfg['strange-usage-category-mainspace-sort'] = 'Main:'
 +
 
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
 
-- End configuration
 
-- End configuration
Line 419: Line 397:
 
-- 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"