Module:Documentation/config: Difference between revisions

-- 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'

--[[

----------------------------------------------------------------------------------------------------

----------------------------------------------------------------------------------------------------

--]]

-- cfg['sandbox-notice-image']

-- The image displayed in the sandbox notice.

cfg['sandbox-notice-image'] = '[[Image:Sandbox.svg|50px|alt=|link=]]'

--[[

-- cfg['sandbox-notice-pagetype-template']

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'] = 'This is the $1 for $2 ($3).'

cfg['sandbox-notice-compare-link-display'] = 'diff'

--[[

-- cfg['sandbox-notice-testcases-blurb']

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=Documentation icon]]'

-- 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']

--]]

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-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'

----------------------------------------------------------------------------------------------------

-- 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-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']

--]]

cfg['add-categories-blurb'] = 'Please 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']

--]]

cfg['subpages-blurb'] = '$1.'

--[[

-- cfg['subpages-link-display']

--]]

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'

----------------------------------------------------------------------------------------------------

-- Print version configuration

----------------------------------------------------------------------------------------------------

-- cfg['print-subpage']

-- The name of the template subpage used for print versions.

cfg['print-subpage'] = 'Print'

-- cfg['print-link-display']

-- The text to display when linking to the /Print subpage.

cfg['print-link-display'] = '/Print'

-- cfg['print-blurb']

-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].

cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'

.. ' If you make a change to this template, please update the print version as well.'

-- cfg['display-print-category']

-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.

-- This should be a boolean value (either true or false).

cfg['display-print-category'] = true

-- cfg['print-category']

-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.

cfg['print-category'] = 'Templates with print versions'

----------------------------------------------------------------------------------------------------

-- HTML and CSS configuration

----------------------------------------------------------------------------------------------------

-- cfg['main-div-id']

-- The "id" attribute of the main HTML "div" tag.

cfg['main-div-id'] = 'template-documentation'

-- cfg['main-div-classes']

-- The CSS classes added to the main HTML "div" tag.

cfg['main-div-classes'] = 'template-documentation iezoomfix'

-- cfg['start-box-linkclasses']

-- 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-link-id']

-- The HTML "id" attribute for the links in the start box.

cfg['start-box-link-id'] = 'doc_editlinks'

----------------------------------------------------------------------------------------------------

-- {{fmbox}} template configuration

----------------------------------------------------------------------------------------------------

-- cfg['fmbox-id']

-- The id sent to the "id" parameter of the {{fmbox}} template.

cfg['fmbox-id'] = 'documentation-meta-data'

-- cfg['fmbox-style']

-- The value sent to the style parameter of {{fmbox}}.

cfg['fmbox-style'] = 'background-color: #ecfcf4'

-- cfg['fmbox-textstyle']

-- The value sent to the "textstyle parameter of {{fmbox}}.

cfg['fmbox-textstyle'] = 'font-style: italic'

----------------------------------------------------------------------------------------------------

-- 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'

--[[

----------------------------------------------------------------------------------------------------

----------------------------------------------------------------------------------------------------

--]]

return cfg