Difference between revisions of "Module:Documentation/config"

From Game Detectives Wiki
Jump to: navigation, search
(test to see how messages break if fed invalid parameters)
m (1 revision imported)
 
(48 intermediate revisions by 14 users not shown)
Line 1: Line 1:
−
----------------------------------------------------------------------------
+
----------------------------------------------------------------------------------------------------
−
-- Configuration for Module:Documentation
 
 
--
 
--
−
-- Here you can set the values of the parameters and messages used in
+
--                              Configuration for Module:Documentation
−
-- Module:Documentation to localise it to your wiki and your language.
+
--
−
----------------------------------------------------------------------------
+
-- Here you can set the values of the parameters and messages used in Module:Documentation to
 +
-- localise it to your wiki and your language. Unless specified otherwise, values given here
 +
-- should be string values.
 +
----------------------------------------------------------------------------------------------------
 +
 
 +
local cfg = {} -- Do not edit this line.
 +
 
 +
----------------------------------------------------------------------------------------------------
 +
-- Protection template configuration
 +
----------------------------------------------------------------------------------------------------
 +
 
 +
-- cfg['protection-reason-edit']
 +
-- The protection reason for edit-protected templates to pass to
 +
-- [[Module:Protection banner]].
 +
cfg['protection-reason-edit'] = 'template'
 +
 
 +
--[[
 +
----------------------------------------------------------------------------------------------------
 +
-- 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.
 +
----------------------------------------------------------------------------------------------------
 +
--]]
  
−
local cfg = {}
+
-- cfg['sandbox-notice-image']
 +
-- The image displayed in the sandbox notice.
 +
cfg['sandbox-notice-image'] = '[[File:Sandbox.svg|50px|alt=|link=]]'
  
−
-- Argument names
+
--[[
−
-- The following are all names of arguments that affect the behaviour of {{documentation}}.
+
-- cfg['sandbox-notice-pagetype-template']
−
-- The comments next to the configuration values are the effects that the argument has
+
-- cfg['sandbox-notice-pagetype-module']
−
-- on the module. (Not the effects of the argument names themselves.)
+
-- 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.livepageArg = 'livepage' -- Name of the live template; used in {{template sandbox notice}}.
+
--[[
−
cfg.headingArg = 'heading' -- Custom heading used in the start box.
+
-- cfg['sandbox-notice-blurb']
−
cfg.preloadArg = 'preload' -- Custom preload page for creating documentation.
+
-- cfg['sandbox-notice-diff-blurb']
−
cfg.headingStyleArg = 'heading-style' -- Custom CSS style for the start box heading.
+
-- cfg['sandbox-notice-diff-display']
−
cfg.contentArg = 'content' -- Passes documentation content directly from the {{documentation}} invocation.
+
-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence
−
cfg.linkBoxArg = 'link box' -- Specifies a custom link box (end box) or prevents it from being generated.
+
-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page
 +
-- type, which is either cfg['sandbox-notice-pagetype-template'],
 +
-- 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'
  
−
-- Argument values
+
--[[
−
-- The following are argument values that are checked by the module.
+
-- cfg['sandbox-notice-testcases-blurb']
 +
-- 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
 +
-- 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-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-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.linkBoxOff = 'off' -- The value to send to cfg.linkBoxArg to turn the link box off.
+
-- cfg['sandbox-category']
 +
-- A category to add to all template sandboxes.
 +
cfg['sandbox-category'] = 'Template sandboxes'
  
−
-- Software settings
+
----------------------------------------------------------------------------------------------------
−
-- The following are software settings that may change from wiki to wiki. For example, the classes
+
-- Start box configuration
−
-- defined in commons.css or the names of templates.
+
----------------------------------------------------------------------------------------------------
  
−
cfg.docSubpage = 'doc' -- The name of the subpage typically used for documentation pages.
+
-- cfg['documentation-icon-wikitext']
−
cfg.sandboxSubpage = 'sandbox' -- The name of the template subpage typically used for sandboxes.
+
-- The wikitext for the icon shown at the top of the template.
−
cfg.testcasesSubpage = 'testcases' -- The name of the template subpage typically used for test cases.
+
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
−
cfg.printSubpage = 'Print' -- The name of the template subpage used for print versions.
 
−
cfg.mainDivId = 'template-documentation' -- The "id" attribute of the main HTML "div" tag.
 
−
cfg.mainDivClasses = 'template-documentation iezoomfix' -- The CSS classes added to the main HTML "div" tag.
 
−
cfg.sandboxNoticeTemplate = 'template sandbox notice' -- The name of the template to display at the top of sandbox pages.
 
−
cfg.sandboxNoticeLivepageParam = 1 -- The parameter of the sandbox notice template to send the cfg.livepageArg to.
 
−
cfg.protectionTemplate = 'pp-template' -- The name of the template that displays the protection icon (a padlock on enwiki).
 
−
cfg.protectionTemplateArgs = {docusage = 'yes'} -- Any arguments to send to the protection template.
 
−
cfg.startBoxLinkclasses = 'mw-editsection plainlinks' -- The CSS classes used for the [view][edit][history] or [create] links in the start box.
 
−
cfg.startBoxLinkId = 'doc_editlinks' -- The HTML "id" attribute for the links in the start box.
 
−
cfg.fileDocpagePreload = 'Template:Documentation/preload-filespace' -- Preload file for documentation page in the file namespace.
 
−
cfg.docpagePreload = 'Template:Documentation/preload-filespace' -- Preload file for template documentation pages in all namespaces.
 
−
cfg.modulePreload = 'Template:Documentation/preload-module-doc' -- Preload file for Lua module documentation pages.
 
−
cfg.templateSandboxPreload = 'Template:Documentation/preload-sandbox' -- Preload file for template sandbox pages.
 
−
cfg.moduleSandboxPreload = 'Template:Documentation/preload-module-sandbox' -- Preload file for Lua module sandbox pages.
 
−
cfg.templateTestcasesPreload = 'Template:Documentation/preload-testcases' -- Preload file for template test cases pages.
 
−
cfg.moduleTestcasesPreload = 'Template:Documentation/preload-module-testcases' -- Preload file for Lua module test cases pages.
 
  
−
-- Settings for the {{fmbox}} template.
+
-- cfg['template-namespace-heading']
 +
-- The heading shown in the template namespace.
 +
cfg['template-namespace-heading'] = 'Template documentation'
  
−
cfg.fmboxIdParam = 'id' -- The name of the "id" parameter of {{fmbox}}.
+
-- cfg['module-namespace-heading']
−
cfg.fmboxId = 'documentation-meta-data' -- The id sent to the "id" parameter of the {{fmbox}} template.
+
-- The heading shown in the module namespace.
−
cfg.fmboxImageParam = 'image' -- The name of the "image" parameter of {{fmbox}}.
+
cfg['module-namespace-heading'] = 'Module documentation'
−
cfg.fmboxImageNone = 'none' -- The value to suppress image output from the "image" parameter of {{fmbox}}.
 
−
cfg.fmboxStyleParam = 'style' -- The name of the "style" parameter of {{fmbox}}.
 
−
cfg.fmboxStyle = 'background-color: #ecfcf4' -- The value sent to the style parameter of {{fmbox}}.
 
−
cfg.fmboxTextstyleParam = 'textstyle' -- The name of the "textstyle" parameter of {{fmbox}}.
 
−
cfg.fmboxTextstyle = 'font-style: italic' -- The value sent to the "textstyle parameter of {{fmbox}}.
 
  
−
-- Display settings
+
-- cfg['file-namespace-heading']
−
-- The following settings configure the values displayed by the module.
+
-- The heading shown in the file namespace.
 +
cfg['file-namespace-heading'] = 'Summary'
  
−
-- Text displayed in wikilinks.
+
-- cfg['other-namespaces-heading']
−
cfg.viewLinkDisplay = 'view' -- The text to display for "view" links.
+
-- The heading shown in other namespaces.
−
cfg.editLinkDisplay = 'edit' -- The text to display for "edit" links.
+
cfg['other-namespaces-heading'] = 'Documentation'
−
cfg.historyLinkDisplay = 'history' -- The text to display for "history" links.
 
−
cfg.purgeLinkDisplay = 'purge' -- The text to display for "purge" links.
 
−
cfg.createLinkDisplay = 'create' -- The text to display for "create" links.
 
−
cfg.sandboxLinkDisplay = 'sandbox' -- The text to display for "sandbox" links.
 
−
cfg.sandboxEditLinkDisplay = 'edit' -- The text to display for sandbox "edit" links.
 
−
cfg.sandboxCreateLinkDisplay = 'create' -- The text to display for sandbox "create" links.
 
−
cfg.compareLinkDisplay = 'diff' -- The text to display for "compare" links.
 
−
cfg.mirrorLinkDisplay = 'mirror' -- The text to display for "mirror" links.
 
−
cfg.testcasesLinkDisplay = 'testcases' -- The text to display for "testcases" links.
 
−
cfg.testcasesEditLinkDisplay = 'edit' -- The text to display for test cases "edit" links.
 
−
cfg.testcasesCreateLinkDisplay = 'create' -- The text to display for test cases "create" links.
 
−
cfg.docLinkDisplay = '/' .. cfg.docSubpage -- The text to display when linking to the /doc subpage.
 
−
cfg.subpagesLinkDisplay = 'Subpages of this $1' -- The text to display for the "subpages of this page" link. $1 is cfg.templatePagetype, cfg.modulePagetype or cfg.defaultPagetype, depending on whether the current page is in the template namespace, the module namespace, or another namespace.
 
−
cfg.printLinkDisplay = '/' .. cfg.printSubpage -- The text to display when linking to the /doc subpage.
 
  
−
-- Sentences used in the end box.
+
-- cfg['view-link-display']
−
cfg.transcludedFromBlurb = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.' -- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
+
-- The text to display for "view" links.
−
cfg.createModuleDocBlurb = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].' -- 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.modulePreload and the display cfg.createLinkDisplay.
+
cfg['view-link-display'] = 'view'
−
cfg.templatePossessive = "template's" -- Possessive case for "template".
 
−
cfg.modulePossessive = "module's" -- Possessive case for "module".
 
−
cfg.mirrorEditSummary = 'Create sandbox version of $1' -- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the template page.
 
−
cfg.experimentBlurb = 'Editors can experiment in this $1 $2 and $5 pages.' -- Text inviting editors to experiment in sandbox and test cases pages. It is only shown in the template and module namespaces. $1 is cfg.templatePossessive or cfg.modulePossessive depending on what namespace we are in. $2 is a link to the sandbox in the format "cfg.sandboxLinkDisplay (cfg.sandboxEditLinkDisplay | cfg.compareLinkDisplay)" if the sandbox exists, and the format "cfg.sandboxLinkDisplay (cfg.sandboxCreateLinkDisplay | cfg.mirrorLinkDisplay)" if the sandbox doesn't exist. If the sandbox link doesn't exist, the create link preloads the page with cfg.templateSandboxPreload or cfg.moduleSandboxPreload depending on the current namespace. If the page doesn't exist, the mirror link uses the edit summar cfg.mirrorEditSummary. $3 is a link to the test cases page in the format "cfg.testcasesLinkDisplay (cfg.testcasesEditLinkDisplay)" if the test cases page exists, and in the format "cfg.testcasesLinkDisplay (cfg.testcasesCreateLinkDisplay)" if the test cases page doesn't exist. If the test cases page doesn't exist, the create link preloads the page with cfg.templateTestcasesPreload or cfg.moduleTestcasesPreload depending on the current namespace.
 
−
cfg.addCategoriesBlurb = 'Please add categories to the $1 subpage.' -- 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 link to the /doc subpage with a display value of cfg.docLinkDisplay.
 
−
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.' -- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg.printLinkDisplay.
 
  
−
-- Other display settings
+
-- cfg['edit-link-display']
−
cfg.documentationIconWikitext = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]' -- The wikitext for the icon shown at the top of the template.
+
-- The text to display for "edit" links.
−
cfg.templateNamespaceHeading = 'Template documentation' -- The heading shown in the template namespace.
+
cfg['edit-link-display'] = 'edit'
−
cfg.moduleNamespaceHeading = 'Module documentation' -- The heading shown in the module namespace.
 
−
cfg.fileNamespaceHeading = 'Summary' -- The heading shown in the file namespace.
 
−
cfg.otherNamespacesHeading = 'Documentation' -- The heading shown in other namespaces.
 
−
cfg.templatePagetype = 'template' -- The pagetype to display for template pages.
 
−
cfg.modulePagetype = 'module' -- The pagetype to display for Lua module pages.
 
−
cfg.defaultPagetype = 'page' -- The pagetype to display for pages other than templates or Lua modules.
 
  
−
-- Category settings
+
-- cfg['history-link-display']
−
cfg.displayPrintCategory = true -- Set to true to enable output of cfg.printCategory if a /Print subpage exists.
+
-- The text to display for "history" links.
−
cfg.printCategory = 'Templates with print versions' -- Category to output if cfg.displayPrintCategory is set to true, and a /Print subpage exists.
+
cfg['history-link-display'] = 'history'
−
cfg.displayStrangeUsageCategory = true -- Set to true to enable output of cfg.strangeUsageCategory if the module is used on a /doc subpage or a /testcases subpage.
+
 
−
cfg.strangeUsageCategory = 'Wikipedia pages with strange ((documentation)) usage' -- Category to output if cfg.displayStrangeUsageCategory is set to true and the module is used on a /doc subpage or a /testcases subpage.
+
-- cfg['purge-link-display']
−
cfg.strangeUsageCategoryMainspaceSort = 'Main:' -- Category sort key prefix to use for cfg.strangeUsageCategory in the main namespace. The prefix is followed by the full page name.
+
-- The text to display for "purge" links.
 +
cfg['purge-link-display'] = 'purge'
 +
 
 +
-- cfg['create-link-display']
 +
-- The text to display for "create" links.
 +
cfg['create-link-display'] = 'create'
 +
 
 +
----------------------------------------------------------------------------------------------------
 +
-- Link box (end box) configuration
 +
----------------------------------------------------------------------------------------------------
 +
 
 +
-- cfg['transcluded-from-blurb']
 +
-- 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['create-module-doc-blurb']
 +
-- 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
 +
-- display cfg['create-link-display'].
 +
--]]
 +
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
 +
 
 +
----------------------------------------------------------------------------------------------------
 +
-- Experiment blurb configuration
 +
----------------------------------------------------------------------------------------------------
 +
 
 +
--[[
 +
-- cfg['experiment-blurb-template']
 +
-- cfg['experiment-blurb-module']
 +
-- 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
 +
-- might look like this:
 +
--
 +
-- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
 +
--
 +
-- 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
 +
-- on what namespace we are in.
 +
--
 +
-- Parameters:
 +
--
 +
-- $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'])
 +
--
 +
-- If the sandbox doesn't exist, it is in the format:
 +
--
 +
--    cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display'])
 +
--
 +
-- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload']
 +
-- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display']
 +
-- loads a default edit summary of cfg['mirror-edit-summary'].
 +
--
 +
-- $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'])
 +
--
 +
-- If the test cases page doesn't exist, it is in the format:
 +
--
 +
--    cfg['testcases-link-display'] (cfg['testcases-create-link-display'])
 +
--
 +
-- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the
 +
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current
 +
-- namespace.
 +
--]]
 +
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."
 +
 
 +
----------------------------------------------------------------------------------------------------
 +
-- Sandbox link configuration
 +
----------------------------------------------------------------------------------------------------
 +
 
 +
-- cfg['sandbox-subpage']
 +
-- The name of the template subpage typically used for sandboxes.
 +
cfg['sandbox-subpage'] = 'sandbox'
 +
 
 +
-- cfg['template-sandbox-preload']
 +
-- Preload file for template sandbox pages.
 +
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'
 +
 
 +
-- cfg['module-sandbox-preload']
 +
-- Preload file for Lua module sandbox pages.
 +
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'
 +
 
 +
-- cfg['sandbox-link-display']
 +
-- The text to display for "sandbox" links.
 +
cfg['sandbox-link-display'] = 'sandbox'
 +
 
 +
-- cfg['sandbox-edit-link-display']
 +
-- The text to display for sandbox "edit" links.
 +
cfg['sandbox-edit-link-display'] = 'edit'
 +
 
 +
-- cfg['sandbox-create-link-display']
 +
-- The text to display for sandbox "create" links.
 +
cfg['sandbox-create-link-display'] = 'create'
 +
 
 +
-- cfg['compare-link-display']
 +
-- The text to display for "compare" links.
 +
cfg['compare-link-display'] = 'diff'
 +
 
 +
-- cfg['mirror-edit-summary']
 +
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
 +
-- template page.
 +
cfg['mirror-edit-summary'] = 'Create sandbox version of $1'
 +
 
 +
-- cfg['mirror-link-display']
 +
-- The text to display for "mirror" links.
 +
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'
 +
 
 +
----------------------------------------------------------------------------------------------------
 +
-- Test cases link configuration
 +
----------------------------------------------------------------------------------------------------
 +
 
 +
-- cfg['testcases-subpage']
 +
-- The name of the template subpage typically used for test cases.
 +
cfg['testcases-subpage'] = 'testcases'
 +
 
 +
-- cfg['template-testcases-preload']
 +
-- Preload file for template test cases pages.
 +
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'
 +
 
 +
-- cfg['module-testcases-preload']
 +
-- Preload file for Lua module test cases pages.
 +
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'
 +
 
 +
-- cfg['testcases-link-display']
 +
-- The text to display for "testcases" links.
 +
cfg['testcases-link-display'] = 'testcases'
 +
 
 +
-- cfg['testcases-edit-link-display']
 +
-- The text to display for test cases "edit" links.
 +
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']
 +
-- The text to display for test cases "create" links.
 +
cfg['testcases-create-link-display'] = 'create'
 +
 
 +
----------------------------------------------------------------------------------------------------
 +
-- Add categories blurb configuration
 +
----------------------------------------------------------------------------------------------------
 +
 
 +
--[[
 +
-- cfg['add-categories-blurb']
 +
-- 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
 +
-- link to the /doc subpage with a display value of cfg['doc-link-display'].
 +
--]]
 +
cfg['add-categories-blurb'] = 'Add categories to the $1 subpage.'
 +
 
 +
-- cfg['doc-link-display']
 +
-- The text to display when linking to the /doc subpage.
 +
cfg['doc-link-display'] = '/doc'
 +
 
 +
----------------------------------------------------------------------------------------------------
 +
-- Subpages link configuration
 +
----------------------------------------------------------------------------------------------------
 +
 
 +
--[[
 +
-- 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']
 +
-- 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']
 +
-- The pagetype to display for template pages.
 +
cfg['template-pagetype'] = 'template'
 +
 
 +
-- cfg['module-pagetype']
 +
-- The pagetype to display for Lua module pages.
 +
cfg['module-pagetype'] = 'module'
 +
 
 +
-- cfg['default-pagetype']
 +
-- The pagetype to display for pages other than templates or Lua modules.
 +
cfg['default-pagetype'] = 'page'
 +
 
 +
----------------------------------------------------------------------------------------------------
 +
-- Doc link configuration
 +
----------------------------------------------------------------------------------------------------
 +
 
 +
-- cfg['doc-subpage']
 +
-- The name of the subpage typically used for documentation pages.
 +
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']
 +
-- Preload file for template documentation pages in all namespaces.
 +
cfg['docpage-preload'] = 'Template:Documentation/preload'
 +
 
 +
-- cfg['module-preload']
 +
-- Preload file for Lua module documentation pages.
 +
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'
 +
 
 +
----------------------------------------------------------------------------------------------------
 +
-- HTML and CSS configuration
 +
----------------------------------------------------------------------------------------------------
 +
 
 +
-- cfg['templatestyles']
 +
-- The name of the TemplateStyles page where CSS is kept.
 +
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed.
 +
cfg['templatestyles'] = 'Module:Documentation/styles.css'
 +
 
 +
-- cfg['container']
 +
-- Class which can be used to set flex or grid CSS on the
 +
-- two child divs documentation and documentation-metadata
 +
cfg['container'] = 'documentation-container'
 +
 
 +
-- cfg['main-div-classes']
 +
-- Classes added to the main HTML "div" tag.
 +
cfg['main-div-classes'] = 'documentation'
 +
 
 +
-- cfg['main-div-heading-class']
 +
-- Class for the main heading for templates and modules and assoc. talk spaces
 +
cfg['main-div-heading-class'] = 'documentation-heading'
 +
 
 +
-- cfg['start-box-class']
 +
-- 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['end-box-class']
 +
-- Class for the end box.
 +
cfg['end-box-class'] = 'documentation-metadata'
 +
 
 +
-- cfg['end-box-plainlinks']
 +
-- Plainlinks
 +
cfg['end-box-plainlinks'] = 'plainlinks'
 +
 
 +
-- cfg['toolbar-class']
 +
-- Class added for toolbar links.
 +
cfg['toolbar-class'] = 'documentation-toolbar'
 +
 
 +
-- cfg['clear']
 +
-- Just used to clear things.
 +
cfg['clear'] = 'documentation-clear'
 +
 
 +
 
 +
----------------------------------------------------------------------------------------------------
 +
-- Tracking category configuration
 +
----------------------------------------------------------------------------------------------------
 +
 
 +
-- 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
 +
-- or a /testcases subpage. This should be a boolean value (either true or false).
 +
cfg['display-strange-usage-category'] = true
 +
 
 +
-- cfg['strange-usage-category']
 +
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a
 +
-- /doc subpage or a /testcases subpage.
 +
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'
 +
 
 +
--[[
 +
----------------------------------------------------------------------------------------------------
 +
-- End configuration
 +
--
 +
-- Don't edit anything below this line.
 +
----------------------------------------------------------------------------------------------------
 +
--]]
  
 
return cfg
 
return cfg

Latest revision as of 18:49, 9 December 2021

Documentation for this module may be created at Module:Documentation/config/doc 

----------------------------------------------------------------------------------------------------
--
--                               Configuration for Module:Documentation
--
-- Here you can set the values of the parameters and messages used in Module:Documentation to
-- localise it to your wiki and your language. Unless specified otherwise, values given here
-- should be string values.
----------------------------------------------------------------------------------------------------

local cfg = {} -- Do not edit this line.

----------------------------------------------------------------------------------------------------
-- Protection template configuration
----------------------------------------------------------------------------------------------------

-- cfg['protection-reason-edit']
-- The protection reason for edit-protected templates to pass to
-- [[Module:Protection banner]].
cfg['protection-reason-edit'] = 'template'

--[[
----------------------------------------------------------------------------------------------------
-- 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'] = '[[File:Sandbox.svg|50px|alt=|link=]]'

--[[
-- cfg['sandbox-notice-pagetype-template']
-- cfg['sandbox-notice-pagetype-module']
-- 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-display']
-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence
-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page
-- type, which is either cfg['sandbox-notice-pagetype-template'],
-- 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['sandbox-notice-testcases-blurb']
-- 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
-- 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-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-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'

----------------------------------------------------------------------------------------------------
-- Start box configuration
----------------------------------------------------------------------------------------------------

-- cfg['documentation-icon-wikitext']
-- 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['template-namespace-heading']
-- The heading shown in the template namespace.
cfg['template-namespace-heading'] = 'Template documentation'

-- cfg['module-namespace-heading']
-- The heading shown in the module namespace.
cfg['module-namespace-heading'] = 'Module documentation'

-- cfg['file-namespace-heading']
-- The heading shown in the file namespace.
cfg['file-namespace-heading'] = 'Summary'

-- cfg['other-namespaces-heading']
-- The heading shown in other namespaces.
cfg['other-namespaces-heading'] = 'Documentation'

-- cfg['view-link-display']
-- The text to display for "view" links.
cfg['view-link-display'] = 'view'

-- cfg['edit-link-display']
-- The text to display for "edit" links.
cfg['edit-link-display'] = 'edit'

-- cfg['history-link-display']
-- The text to display for "history" links.
cfg['history-link-display'] = 'history'

-- cfg['purge-link-display']
-- The text to display for "purge" links.
cfg['purge-link-display'] = 'purge'

-- cfg['create-link-display']
-- The text to display for "create" links.
cfg['create-link-display'] = 'create'

----------------------------------------------------------------------------------------------------
-- Link box (end box) configuration
----------------------------------------------------------------------------------------------------

-- cfg['transcluded-from-blurb']
-- 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['create-module-doc-blurb']
-- 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
-- display cfg['create-link-display'].
--]]
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'

----------------------------------------------------------------------------------------------------
-- Experiment blurb configuration
----------------------------------------------------------------------------------------------------

--[[
-- cfg['experiment-blurb-template']
-- cfg['experiment-blurb-module']
-- 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
-- might look like this:
--
-- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
--
-- 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
-- on what namespace we are in.
-- 
-- Parameters:
--
-- $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'])
-- 
-- If the sandbox doesn't exist, it is in the format:
--
--     cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display'])
-- 
-- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload']
-- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display']
-- loads a default edit summary of cfg['mirror-edit-summary'].
--
-- $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'])
--
-- If the test cases page doesn't exist, it is in the format:
-- 
--     cfg['testcases-link-display'] (cfg['testcases-create-link-display'])
--
-- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current
-- namespace.
--]]
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."

----------------------------------------------------------------------------------------------------
-- Sandbox link configuration
----------------------------------------------------------------------------------------------------

-- cfg['sandbox-subpage']
-- The name of the template subpage typically used for sandboxes.
cfg['sandbox-subpage'] = 'sandbox'

-- cfg['template-sandbox-preload']
-- Preload file for template sandbox pages.
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'

-- cfg['module-sandbox-preload']
-- Preload file for Lua module sandbox pages.
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'

-- cfg['sandbox-link-display']
-- The text to display for "sandbox" links.
cfg['sandbox-link-display'] = 'sandbox'

-- cfg['sandbox-edit-link-display']
-- The text to display for sandbox "edit" links.
cfg['sandbox-edit-link-display'] = 'edit'

-- cfg['sandbox-create-link-display']
-- The text to display for sandbox "create" links.
cfg['sandbox-create-link-display'] = 'create'

-- cfg['compare-link-display']
-- The text to display for "compare" links.
cfg['compare-link-display'] = 'diff'

-- cfg['mirror-edit-summary']
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
-- template page.
cfg['mirror-edit-summary'] = 'Create sandbox version of $1'

-- cfg['mirror-link-display']
-- The text to display for "mirror" links.
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'

----------------------------------------------------------------------------------------------------
-- Test cases link configuration
----------------------------------------------------------------------------------------------------

-- cfg['testcases-subpage']
-- The name of the template subpage typically used for test cases.
cfg['testcases-subpage'] = 'testcases'

-- cfg['template-testcases-preload']
-- Preload file for template test cases pages.
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'

-- cfg['module-testcases-preload']
-- Preload file for Lua module test cases pages.
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'

-- cfg['testcases-link-display']
-- The text to display for "testcases" links.
cfg['testcases-link-display'] = 'testcases'

-- cfg['testcases-edit-link-display']
-- The text to display for test cases "edit" links.
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']
-- The text to display for test cases "create" links.
cfg['testcases-create-link-display'] = 'create'

----------------------------------------------------------------------------------------------------
-- Add categories blurb configuration
----------------------------------------------------------------------------------------------------

--[[
-- cfg['add-categories-blurb']
-- 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
-- link to the /doc subpage with a display value of cfg['doc-link-display'].
--]]
cfg['add-categories-blurb'] = 'Add categories to the $1 subpage.'

-- cfg['doc-link-display']
-- The text to display when linking to the /doc subpage.
cfg['doc-link-display'] = '/doc'

----------------------------------------------------------------------------------------------------
-- Subpages link configuration
----------------------------------------------------------------------------------------------------

--[[
-- 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']
-- 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']
-- The pagetype to display for template pages.
cfg['template-pagetype'] = 'template'

-- cfg['module-pagetype']
-- The pagetype to display for Lua module pages.
cfg['module-pagetype'] = 'module'

-- cfg['default-pagetype']
-- The pagetype to display for pages other than templates or Lua modules.
cfg['default-pagetype'] = 'page'

----------------------------------------------------------------------------------------------------
-- Doc link configuration
----------------------------------------------------------------------------------------------------

-- cfg['doc-subpage']
-- The name of the subpage typically used for documentation pages.
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']
-- Preload file for template documentation pages in all namespaces.
cfg['docpage-preload'] = 'Template:Documentation/preload'

-- cfg['module-preload']
-- Preload file for Lua module documentation pages.
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'

----------------------------------------------------------------------------------------------------
-- HTML and CSS configuration
----------------------------------------------------------------------------------------------------

-- cfg['templatestyles']
-- The name of the TemplateStyles page where CSS is kept.
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed.
cfg['templatestyles'] = 'Module:Documentation/styles.css'

-- cfg['container']
-- Class which can be used to set flex or grid CSS on the
-- two child divs documentation and documentation-metadata
cfg['container'] = 'documentation-container'

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

-- cfg['main-div-heading-class']
-- Class for the main heading for templates and modules and assoc. talk spaces
cfg['main-div-heading-class'] = 'documentation-heading'

-- cfg['start-box-class']
-- 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['end-box-class']
-- Class for the end box.
cfg['end-box-class'] = 'documentation-metadata'

-- cfg['end-box-plainlinks']
-- Plainlinks
cfg['end-box-plainlinks'] = 'plainlinks'

-- cfg['toolbar-class']
-- Class added for toolbar links.
cfg['toolbar-class'] = 'documentation-toolbar'

-- cfg['clear']
-- Just used to clear things.
cfg['clear'] = 'documentation-clear'


----------------------------------------------------------------------------------------------------
-- Tracking category configuration
----------------------------------------------------------------------------------------------------

-- 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
-- or a /testcases subpage. This should be a boolean value (either true or false).
cfg['display-strange-usage-category'] = true

-- cfg['strange-usage-category']
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a
-- /doc subpage or a /testcases subpage.
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'

--[[
----------------------------------------------------------------------------------------------------
-- End configuration
--
-- Don't edit anything below this line.
----------------------------------------------------------------------------------------------------
--]]

return cfg
Retrieved from "https://wiki.gamedetectives.net/index.php?title=Module:Documentation/config&oldid=19731"