Changes
convert messages to use hyphens instead of camelCase, in line with MediaWiki
----------------------------------------------------------------------------------------------------
-- cfg.errorPrefix['error-prefix']
-- The prefix before any error messages found by the script.
cfg.errorPrefix ['error-prefix'] = '[[Module:Documentation]] error:'
-- cfg.errorCategory['error-category']
-- The category pages are placed into if any errors are found.
cfg.errorCategory ['error-category'] = 'Documentation template invocations with errors'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.titleArgError['title-arg-error']
-- The error message to display if the "page" argument does not result in a
-- valid title.
cfg.titleArgError ['title-arg-error'] = '$1 is not a valid title'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.protectionTemplate['protection-template']
-- The name of the template that displays the protection icon (a padlock on enwiki).
cfg.protectionTemplate ['protection-template'] = 'pp-template'
-- cfg.protectionTemplateArgs['protection-template-args']
-- Any arguments to send to the protection template.
cfg.protectionTemplateArgs ['protection-template-args'] = {docusage = 'yes'}
----------------------------------------------------------------------------------------------------
-- 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.sandboxSubpage['sandbox-subpage']. The following settings configure the
-- messages that the notices contains.
----------------------------------------------------------------------------------------------------
-- cfg.sandboxNoticeImage['sandbox-notice-image']
-- The image displayed in the sandbox notice.
cfg.sandboxNoticeImage ['sandbox-notice-image'] = '[[Image:Sandbox.png|50px|alt=|link=]]'
-- cfg.sandboxNoticeBlurb['sandbox-notice-blurb']
-- The opening sentence of the sandbox notice. $1 is a link to the main template page.
cfg.sandboxNoticeBlurb ['sandbox-notice-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.'
-- cfg.sandboxNoticeDiffBlurb['sandbox-notice-diff-blurb']-- cfg.sandboxNoticeDiffDisplay['sandbox-notice-diff-display']-- cfg.sandboxNoticeDiffBlurb ['sandbox-notice-diff-blurb'] is the opening sentence of the sandbox notice, with a diff link. $1 is a link
-- to the main template page, and $2 is a diff link between the sandbox and the main template. The
-- display value of the diff link is set by cfg.sandboxNoticeCompareLinkDisplay['sandbox-notice-compare-link-display'].cfg.sandboxNoticeDiffBlurb ['sandbox-notice-diff-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).'cfg.sandboxNoticeCompareLinkDisplay ['sandbox-notice-compare-link-display'] = 'diff'
-- cfg.sandboxNoticeTestcasesBlurb['sandbox-notice-testcases-blurb']-- cfg.sandboxNoticeTestcasesLinkDisplay['sandbox-notice-testcases-link-display']-- cfg.sandboxNoticeTestcasesBlurb ['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.sandboxNoticeTestcasesLinkDisplay ['sandbox-notice-testcases-link-display'] is the display value for that link.cfg.sandboxNoticeTestcasesBlurb ['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'cfg.sandboxNoticeTestcasesLinkDisplay ['sandbox-notice-testcases-link-display'] = 'test cases'
-- cfg.sandboxCategory['sandbox-category']
-- A category to add to all template sandboxes.
cfg.sandboxCategory ['sandbox-category'] = 'Template sandboxes'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.documentationIconWikitext['documentation-icon-wikitext']
-- The wikitext for the icon shown at the top of the template.
cfg.documentationIconWikitext ['documentation-icon-wikitext'] = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]'
-- cfg.templateNamespaceHeading['template-namespace-heading']
-- The heading shown in the template namespace.
cfg.templateNamespaceHeading ['template-namespace-heading'] = 'Template documentation'
-- cfg.moduleNamespaceHeading['module-namespace-heading']
-- The heading shown in the module namespace.
cfg.moduleNamespaceHeading ['module-namespace-heading'] = 'Module documentation'
-- cfg.fileNamespaceHeading['file-namespace-heading']
-- The heading shown in the file namespace.
cfg.fileNamespaceHeading ['file-namespace-heading'] = 'Summary'
-- cfg.otherNamespacesHeading['other-namespaces-heading']
-- The heading shown in other namespaces.
cfg.otherNamespacesHeading ['other-namespaces-heading'] = 'Documentation'
-- cfg.viewLinkDisplay['view-link-display']
-- The text to display for "view" links.
cfg.viewLinkDisplay ['view-link-display'] = 'view'
-- cfg.editLinkDisplay['edit-link-display']
-- The text to display for "edit" links.
cfg.editLinkDisplay ['edit-link-display'] = 'edit'
-- cfg.historyLinkDisplay['history-link-display']
-- The text to display for "history" links.
cfg.historyLinkDisplay ['history-link-display'] = 'history'
-- cfg.purgeLinkDisplay['purge-link-display']
-- The text to display for "purge" links.
cfg.purgeLinkDisplay ['purge-link-display'] = 'purge'
-- cfg.createLinkDisplay['create-link-display']
-- The text to display for "create" links.
cfg.createLinkDisplay ['create-link-display'] = 'create'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.transcludedFromBlurb['transcluded-from-blurb']
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
cfg.transcludedFromBlurb ['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'
-- cfg.createModuleDocBlurb['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.modulePreload ['module-preload'] and the-- display cfg.createLinkDisplay['create-link-display'].cfg.createModuleDocBlurb ['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.experimentBlurbTemplate['experiment-blurb-template']-- cfg.experimentBlurbModule['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
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
--
-- There are two versions, cfg.experimentBlurbTemplate ['experiment-blurb-template'] and cfg.experimentBlurbModule['experiment-blurb-module'], depending
-- on what namespace we are in.
--
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:
--
-- cfg.sandboxLinkDisplay ['sandbox-link-display'] (cfg.sandboxEditLinkDisplay ['sandbox-edit-link-display'] | cfg.compareLinkDisplay['compare-link-display'])
--
-- If the sandbox doesn't exist, it is in the format:
--
-- cfg.sandboxLinkDisplay ['sandbox-link-display'] (cfg.sandboxCreateLinkDisplay ['sandbox-create-link-display'] | cfg.mirrorLinkDisplay['mirror-link-display'])
--
-- The link for cfg.sandboxCreateLinkDisplay ['sandbox-create-link-display'] link preloads the page with cfg.templateSandboxPreload['template-sandbox-preload']-- or cfg.moduleSandboxPreload['module-sandbox-preload'], depending on the current namespace. The link for cfg.mirrorLinkDisplay['mirror-link-display']-- loads a default edit summary of cfg.mirrorEditSummary['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.testcasesLinkDisplay ['testcases-link-display'] (cfg.testcasesEditLinkDisplay['testcases-edit-link-display'])
--
-- If the test cases page doesn't exist, it is in the format:
--
-- cfg.testcasesLinkDisplay ['testcases-link-display'] (cfg.testcasesCreateLinkDisplay['testcases-create-link-display'])
--
-- If the test cases page doesn't exist, the link for cfg.testcasesCreateLinkDisplay ['testcases-create-link-display'] preloads the-- page with cfg.templateTestcasesPreload ['template-testcases-preload'] or cfg.moduleTestcasesPreload['module-testcases-preload'], depending on the current
-- namespace.
cfg.experimentBlurbTemplate ['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages."cfg.experimentBlurbModule ['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages."
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.sandboxSubpage['sandbox-subpage']
-- The name of the template subpage typically used for sandboxes.
cfg.sandboxSubpage ['sandbox-subpage'] = 'sandbox'
-- cfg.templateSandboxPreload['template-sandbox-preload']
-- Preload file for template sandbox pages.
cfg.templateSandboxPreload ['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'
-- cfg.moduleSandboxPreload['module-sandbox-preload']
-- Preload file for Lua module sandbox pages.
cfg.moduleSandboxPreload ['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'
-- cfg.sandboxLinkDisplay['sandbox-link-display']
-- The text to display for "sandbox" links.
cfg.sandboxLinkDisplay ['sandbox-link-display'] = 'sandbox'
-- cfg.sandboxEditLinkDisplay['sandbox-edit-link-display']
-- The text to display for sandbox "edit" links.
cfg.sandboxEditLinkDisplay ['sandbox-edit-link-display'] = 'edit'
-- cfg.sandboxCreateLinkDisplay['sandbox-create-link-display']
-- The text to display for sandbox "create" links.
cfg.sandboxCreateLinkDisplay ['sandbox-create-link-display'] = 'create'
-- cfg.compareLinkDisplay['compare-link-display']
-- The text to display for "compare" links.
cfg.compareLinkDisplay ['compare-link-display'] = 'diff'
-- cfg.mirrorEditSummary['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.mirrorEditSummary ['mirror-edit-summary'] = 'Create sandbox version of $1'
-- cfg.mirrorLinkDisplay['mirror-link-display']
-- The text to display for "mirror" links.
cfg.mirrorLinkDisplay ['mirror-link-display'] = 'mirror'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.testcasesSubpage['testcases-subpage']
-- The name of the template subpage typically used for test cases.
cfg.testcasesSubpage ['testcases-subpage'] = 'testcases'
-- cfg.templateTestcasesPreload['template-testcases-preload']
-- Preload file for template test cases pages.
cfg.templateTestcasesPreload ['template-testcases-preload'] = 'Template:Documentation/preload-testcases'
-- cfg.moduleTestcasesPreload['module-testcases-preload']
-- Preload file for Lua module test cases pages.
cfg.moduleTestcasesPreload ['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'
-- cfg.testcasesLinkDisplay['testcases-link-display']
-- The text to display for "testcases" links.
cfg.testcasesLinkDisplay ['testcases-link-display'] = 'testcases'
-- cfg.testcasesEditLinkDisplay['testcases-edit-link-display']
-- The text to display for test cases "edit" links.
cfg.testcasesEditLinkDisplay ['testcases-edit-link-display'] = 'edit'
-- cfg.testcasesCreateLinkDisplay['testcases-create-link-display']
-- The text to display for test cases "create" links.
cfg.testcasesCreateLinkDisplay ['testcases-create-link-display'] = 'create'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.addCategoriesBlurb['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.docLinkDisplay['doc-link-display'].cfg.addCategoriesBlurb ['add-categories-blurb'] = 'Please add categories to the $1 subpage.'
-- cfg.docLinkDisplay['doc-link-display']
-- The text to display when linking to the /doc subpage.
cfg.docLinkDisplay ['doc-link-display'] = '/doc'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.subpagesLinkDisplay['subpages-link-display']-- The text to display for the "subpages of this page" link. $1 is cfg.templatePagetype['template-pagetype'],-- cfg.modulePagetype ['module-pagetype'] or cfg.defaultPagetype['default-pagetype'], depending on whether the current page is in th-- e the template namespace, the module namespace, or another namespace.cfg.subpagesLinkDisplay ['subpages-link-display'] = 'Subpages of this $1'
-- cfg.templatePagetype['template-pagetype']
-- The pagetype to display for template pages.
cfg.templatePagetype ['template-pagetype'] = 'template'
-- cfg.modulePagetype['module-pagetype']
-- The pagetype to display for Lua module pages.
cfg.modulePagetype ['module-pagetype'] = 'module'
-- cfg.defaultPagetype['default-pagetype']
-- The pagetype to display for pages other than templates or Lua modules.
cfg.defaultPagetype ['default-pagetype'] = 'page'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.docSubpage['doc-subpage']
-- The name of the subpage typically used for documentation pages.
cfg.docSubpage ['doc-subpage'] = 'doc'
-- cfg.fileDocpagePreload['file-docpage-preload']
-- Preload file for documentation page in the file namespace.
cfg.fileDocpagePreload ['file-docpage-preload'] = 'Template:Documentation/preload-filespace'
-- cfg.docpagePreload['docpage-preload']
-- Preload file for template documentation pages in all namespaces.
cfg.docpagePreload ['docpage-preload'] = 'Template:Documentation/preload'
-- cfg.modulePreload['module-preload']
-- Preload file for Lua module documentation pages.
cfg.modulePreload ['module-preload'] = 'Template:Documentation/preload-module-doc'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.printSubpage['print-subpage']
-- The name of the template subpage used for print versions.
cfg.printSubpage ['print-subpage'] = 'Print'
-- cfg.printLinkDisplay['print-link-display']
-- The text to display when linking to the /Print subpage.
cfg.printLinkDisplay ['print-link-display'] = '/Print'
-- cfg.printBlurb['print-blurb']-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg.printLinkDisplay['print-link-display'].cfg.printBlurb ['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'
.. ' If you make a change to this template, please update the print version as well.'
-- cfg.displayPrintCategory['display-print-category']-- Set to true to enable output of cfg.printCategory ['print-category'] if a /Print subpage exists.cfg.displayPrintCategory ['display-print-category'] = true
-- cfg.printCategory['print-category']-- Category to output if cfg.displayPrintCategory ['display-print-category'] is set to true, and a /Print subpage exists.cfg.printCategory ['print-category'] = 'Templates with print versions'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.mainDivId['main-div-id']
-- The "id" attribute of the main HTML "div" tag.
cfg.mainDivId ['main-div-id'] = 'template-documentation'
-- cfg.mainDivClasses['main-div-classes']
-- The CSS classes added to the main HTML "div" tag.
cfg.mainDivClasses ['main-div-classes'] = 'template-documentation iezoomfix'
-- cfg.startBoxLinkclasses['start-box-linkclasses']
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
cfg.startBoxLinkclasses ['start-box-linkclasses'] = 'mw-editsection plainlinks'
-- cfg.startBoxLinkId['start-box-link-id']
-- The HTML "id" attribute for the links in the start box.
cfg.startBoxLinkId ['start-box-link-id'] = 'doc_editlinks'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.fmboxId['fmbox-id']
-- The id sent to the "id" parameter of the {{fmbox}} template.
cfg.fmboxId ['fmbox-id'] = 'documentation-meta-data'
-- cfg.fmboxImageNone['fmbox-image-none']
-- The value to suppress image output from the "image" parameter of {{fmbox}}.
cfg.fmboxImageNone ['fmbox-image-none'] = 'none'
-- cfg.fmboxStyle['fmbox-style']
-- The value sent to the style parameter of {{fmbox}}.
cfg.fmboxStyle ['fmbox-style'] = 'background-color: #ecfcf4'
-- cfg.fmboxTextstyle['fmbox-textstyle']
-- The value sent to the "textstyle parameter of {{fmbox}}.
cfg.fmboxTextstyle ['fmbox-textstyle'] = 'font-style: italic'
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- cfg.displayStrangeUsageCategory['display-strange-usage-category']-- Set to true to enable output of cfg.strangeUsageCategory ['strange-usage-category'] if the module is used on a /doc subpage
-- or a /testcases subpage.
cfg.displayStrangeUsageCategory ['display-strange-usage-category'] = true
-- cfg.strangeUsageCategory['strange-usage-category']-- Category to output if cfg.displayStrangeUsageCategory ['display-strange-usage-category'] is set to true and the module is used on a
-- /doc subpage or a /testcases subpage.
cfg.strangeUsageCategory ['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'
-- cfg.strangeUsageCategoryMainspaceSort['strange-usage-category-mainspace-sort']-- Category sort key prefix to use for cfg.strangeUsageCategory ['strange-usage-category'] in the main namespace. The prefix
-- is followed by the full page name.
cfg.strangeUsageCategoryMainspaceSort ['strange-usage-category-mainspace-sort'] = 'Main:'
----------------------------------------------------------------------------------------------------