Module:Documentation/config: Difference between revisions
Content added Content deleted
m (1 revision imported from w:Module:Documentation/config) |
(Revert to revision 22267835 dated 2021-10-29 20:02:27 by GeneralNotability using popups) |
||
Line 7: | Line 7: | ||
-- should be string values. |
-- should be string values. |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
local _format = require('Module:TNT').format |
|||
local function format(id) |
|||
return _format('I18n/Documentation', id) |
|||
end |
|||
local cfg = {} -- Do not edit this line. |
local cfg = {} -- Do not edit this line. |
||
cfg['templatestyles-scr'] = 'Module:Documentation/styles.css' |
|||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- Protection template configuration |
-- Protection template configuration |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg['protection-template'] |
|||
-- The name of the template that displays the protection icon (a padlock on enwiki). |
|||
cfg['protection-template'] = 'PP-template' |
|||
-- cfg['protection-reason-edit'] |
-- cfg['protection-reason-edit'] |
||
Line 18: | Line 29: | ||
-- [[Module:Protection banner]]. |
-- [[Module:Protection banner]]. |
||
cfg['protection-reason-edit'] = 'template' |
cfg['protection-reason-edit'] = 'template' |
||
--[[ |
|||
-- cfg['protection-template-args'] |
|||
-- Any arguments to send to the protection template. This should be a Lua table. |
|||
-- For example, if the protection template is "pp-template", and the wikitext template invocation |
|||
-- looks like "{{pp-template|docusage=yes}}", then this table should look like "{docusage = 'yes'}". |
|||
--]] |
|||
cfg['protection-template-args'] = {docusage = 'yes'} |
|||
--[[ |
--[[ |
||
Line 32: | Line 51: | ||
-- 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'] = '[[ |
cfg['sandbox-notice-image'] = '[[Image:Edit In Sandbox Icon - Color.svg|40px|alt=|link=]]' |
||
--[[ |
--[[ |
||
Line 42: | Line 61: | ||
-- cfg['sandbox-notice-diff-blurb']. |
-- cfg['sandbox-notice-diff-blurb']. |
||
--]] |
--]] |
||
cfg['sandbox-notice-pagetype-template'] = ' |
cfg['sandbox-notice-pagetype-template'] = format('sandbox-notice-pagetype-template') |
||
cfg['sandbox-notice-pagetype-module'] = ' |
cfg['sandbox-notice-pagetype-module'] = format('sandbox-notice-pagetype-module') |
||
cfg['sandbox-notice-pagetype-other'] = 'sandbox |
cfg['sandbox-notice-pagetype-other'] = format('sandbox-notice-pagetype-other') |
||
--[[ |
--[[ |
||
Line 58: | Line 77: | ||
-- cfg['sandbox-notice-compare-link-display']. |
-- cfg['sandbox-notice-compare-link-display']. |
||
--]] |
--]] |
||
cfg['sandbox-notice-blurb'] = ' |
cfg['sandbox-notice-blurb'] = format('sandbox-notice-blurb') |
||
cfg['sandbox-notice-diff-blurb'] = |
cfg['sandbox-notice-diff-blurb'] = format('sandbox-notice-diff-blurb') |
||
cfg['sandbox-notice-compare-link-display'] = ' |
cfg['sandbox-notice-compare-link-display'] = format('sandbox-notice-compare-link-display') |
||
--[[ |
--[[ |
||
Line 76: | Line 95: | ||
-- cases. |
-- cases. |
||
--]] |
--]] |
||
cfg['sandbox-notice-testcases-blurb'] = ' |
cfg['sandbox-notice-testcases-blurb'] = format('sandbox-notice-testcases-blurb') |
||
cfg['sandbox-notice-testcases-link-display'] = ' |
cfg['sandbox-notice-testcases-link-display'] = format('sandbox-notice-testcases-link-display') |
||
cfg['sandbox-notice-testcases-run-blurb'] = |
cfg['sandbox-notice-testcases-run-blurb'] = format('sandbox-notice-testcases-run-blurb') |
||
cfg['sandbox-notice-testcases-run-link-display'] = 'run' |
cfg['sandbox-notice-testcases-run-link-display'] = format('sandbox-notice-testcases-run-link-display') |
||
-- cfg['sandbox-category'] |
-- cfg['sandbox-category'] |
||
Line 91: | Line 110: | ||
-- 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: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' |
|||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 135: | Line 118: | ||
-- cfg['transcluded-from-blurb'] |
-- cfg['transcluded-from-blurb'] |
||
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page. |
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page. |
||
cfg['transcluded-from-blurb'] = ' |
cfg['transcluded-from-blurb'] = format('transcluded-from-blurb') |
||
--[[ |
--[[ |
||
Line 143: | Line 126: | ||
-- display cfg['create-link-display']. |
-- display cfg['create-link-display']. |
||
--]] |
--]] |
||
cfg['create-module-doc-blurb'] = ' |
cfg['create-module-doc-blurb'] = format('create-module-doc-blurb') |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 179: | Line 162: | ||
-- $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 |
-- 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 189: | Line 172: | ||
-- namespace. |
-- namespace. |
||
--]] |
--]] |
||
cfg['experiment-blurb-template'] = |
cfg['experiment-blurb-template'] = format('experiment-blurb-template') |
||
cfg['experiment-blurb-module'] = |
cfg['experiment-blurb-module'] = format('experiment-blurb-module') |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 210: | Line 193: | ||
-- cfg['sandbox-link-display'] |
-- cfg['sandbox-link-display'] |
||
-- The text to display for "sandbox" links. |
-- The text to display for "sandbox" links. |
||
cfg['sandbox-link-display'] = 'sandbox' |
cfg['sandbox-link-display'] = format('sandbox-link-display') |
||
-- cfg['sandbox-edit-link-display'] |
-- cfg['sandbox-edit-link-display'] |
||
-- The text to display for sandbox "edit" links. |
-- The text to display for sandbox "edit" links. |
||
cfg['sandbox-edit-link-display'] = 'edit' |
cfg['sandbox-edit-link-display'] = format('sandbox-edit-link-display') |
||
-- cfg['sandbox-create-link-display'] |
-- cfg['sandbox-create-link-display'] |
||
-- The text to display for sandbox "create" links. |
-- The text to display for sandbox "create" links. |
||
cfg['sandbox-create-link-display'] = 'create' |
cfg['sandbox-create-link-display'] = format('sandbox-create-link-display') |
||
-- cfg['compare-link-display'] |
-- cfg['compare-link-display'] |
||
-- The text to display for "compare" links. |
-- The text to display for "compare" links. |
||
cfg['compare-link-display'] = ' |
cfg['compare-link-display'] = format('compare-link-display') |
||
-- cfg['mirror-edit-summary'] |
-- cfg['mirror-edit-summary'] |
||
Line 231: | Line 214: | ||
-- cfg['mirror-link-display'] |
-- cfg['mirror-link-display'] |
||
-- The text to display for "mirror" links. |
-- The text to display for "mirror" links. |
||
cfg['mirror-link-display'] = 'mirror' |
cfg['mirror-link-display'] = format('mirror-link-display') |
||
-- cfg['mirror-link-preload'] |
-- cfg['mirror-link-preload'] |
||
Line 255: | Line 238: | ||
-- cfg['testcases-link-display'] |
-- cfg['testcases-link-display'] |
||
-- The text to display for "testcases" links. |
-- The text to display for "testcases" links. |
||
cfg['testcases-link-display'] = 'testcases' |
cfg['testcases-link-display'] = format('testcases-link-display') |
||
-- cfg['testcases-edit-link-display'] |
-- cfg['testcases-edit-link-display'] |
||
-- 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'] = format('testcases-edit-link-display') |
||
-- 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'] |
||
-- The text to display for test cases "create" links. |
-- The text to display for test cases "create" links. |
||
cfg['testcases-create-link-display'] = 'create' |
cfg['testcases-create-link-display'] = format('testcases-create-link-display') |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 279: | Line 258: | ||
-- 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'] = ' |
cfg['add-categories-blurb'] = format('add-categories-blurb') |
||
-- cfg['doc-link-display'] |
-- cfg['doc-link-display'] |
||
Line 295: | Line 274: | ||
-- the link followed by a period, and the link display provides the actual text. |
-- the link followed by a period, and the link display provides the actual text. |
||
--]] |
--]] |
||
cfg['subpages-blurb'] = ' |
cfg['subpages-blurb'] = format('subpages-blurb') |
||
--[[ |
--[[ |
||
Line 303: | Line 282: | ||
-- the template namespace, the module namespace, or another namespace. |
-- the template namespace, the module namespace, or another namespace. |
||
--]] |
--]] |
||
cfg['subpages-link-display'] = ' |
cfg['subpages-link-display'] = format('subpages-link-display') |
||
-- cfg['template-pagetype'] |
-- cfg['template-pagetype'] |
||
-- The pagetype to display for template pages. |
-- The pagetype to display for template pages. |
||
cfg['template-pagetype'] = 'template' |
cfg['template-pagetype'] = format('template-pagetype') |
||
-- cfg['module-pagetype'] |
-- cfg['module-pagetype'] |
||
-- The pagetype to display for Lua module pages. |
-- The pagetype to display for Lua module pages. |
||
cfg['module-pagetype'] = 'module' |
cfg['module-pagetype'] = format('module-pagetype') |
||
-- cfg['default-pagetype'] |
-- cfg['default-pagetype'] |
||
-- The pagetype to display for pages other than templates or Lua modules. |
-- The pagetype to display for pages other than templates or Lua modules. |
||
cfg['default-pagetype'] = ' |
cfg['default-pagetype'] = format('default-pagetype') |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 324: | Line 303: | ||
-- The name of the subpage typically used for documentation pages. |
-- The name of the subpage typically used for documentation pages. |
||
cfg['doc-subpage'] = 'doc' |
cfg['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'] |
-- cfg['docpage-preload'] |
||
Line 334: | Line 317: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- |
-- Print version configuration |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg[' |
-- cfg['print-subpage'] |
||
-- The name of the |
-- The name of the template subpage used for print versions. |
||
cfg['print-subpage'] = 'Print' |
|||
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed. |
|||
cfg['templatestyles'] = 'Module:Documentation/styles.css' |
|||
-- cfg[' |
-- cfg['print-link-display'] |
||
-- The text to display when linking to the /Print subpage. |
|||
-- Class which can be used to set flex or grid CSS on the |
|||
cfg['print-link-display'] = '/Print' |
|||
-- two child divs documentation and documentation-metadata |
|||
cfg['container'] = 'documentation-container' |
|||
-- cfg[' |
-- 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']. |
|||
-- Classes added to the main HTML "div" tag. |
|||
cfg[' |
cfg['print-blurb'] = format('print-blurb') |
||
-- cfg[' |
-- cfg['display-print-category'] |
||
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists. |
|||
-- Class for the main heading for templates and modules and assoc. talk spaces |
|||
-- This should be a boolean value (either true or false). |
|||
cfg['main-div-heading-class'] = 'documentation-heading' |
|||
cfg['display-print-category'] = true |
|||
-- cfg[' |
-- cfg['print-category'] |
||
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists. |
|||
-- Class for the start box |
|||
cfg[' |
cfg['print-category'] = 'Templates with print versions' |
||
---------------------------------------------------------------------------------------------------- |
|||
-- cfg['start-box-link-classes'] |
|||
-- HTML and CSS configuration |
|||
-- 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[' |
-- cfg['main-div-id'] |
||
-- |
-- The "id" attribute of the main HTML "div" tag. |
||
cfg[' |
cfg['main-div-id'] = 'template-documentation' |
||
-- cfg[' |
-- cfg['main-div-classes'] |
||
-- The CSS classes added to the main HTML "div" tag. |
|||
-- Plainlinks |
|||
cfg[' |
cfg['main-div-class'] = 'ts-doc-doc' |
||
cfg['header-div-class'] = 'ts-doc-header' |
|||
cfg['heading-div-class'] = 'ts-doc-heading' |
|||
cfg['content-div-class'] = 'ts-doc-content' |
|||
cfg['footer-div-class'] = 'ts-doc-footer plainlinks' |
|||
cfg['sandbox-class'] = 'ts-doc-sandbox' |
|||
-- Class added for toolbar links. |
|||
cfg['toolbar-class'] = 'documentation-toolbar' |
|||
-- cfg[' |
-- cfg['start-box-linkclasses'] |
||
-- The CSS classes used for the [view][edit][history] or [create] links in the start box. |
|||
-- Just used to clear things. |
|||
cfg['start-box-linkclasses'] = 'ts-tlinks-tlinks mw-editsection-like plainlinks' |
|||
cfg['clear'] = 'documentation-clear' |
|||
-- cfg['start-box-link-id'] |
|||
-- The HTML "id" attribute for the links in the start box. |
|||
cfg['start-box-link-id'] = 'doc_editlinks' |
|||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |