Module:Documentation/config: Difference between revisions
Jump to navigation
Jump to search
Created page with "---------------------------------------------------------------------------------------------------- -- -- Configuration for Module:Documentation..." |
MeowyCats2 (talk | contribs) m 105 revisions imported |
||
(78 intermediate revisions by 54 users not shown) | |||
Line 7: | Line 7: | ||
-- should be string values. | -- should be string values. | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
local cfg = {} -- Do not edit this line. | local cfg = {} -- Do not edit this line. | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- Start box configuration | -- Start box configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- 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:Template- | cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]' | ||
-- cfg['template-namespace-heading'] | -- cfg['template-namespace-heading'] | ||
-- The heading shown in the template namespace. | -- The heading shown in the template namespace. | ||
cfg['template-namespace-heading'] = 'Template documentation' | cfg['template-namespace-heading'] = 'Template documentation' | ||
-- cfg['module-namespace-heading'] | -- cfg['module-namespace-heading'] | ||
-- The heading shown in the module namespace. | -- The heading shown in the module namespace. | ||
cfg['module-namespace-heading'] = 'Module documentation' | cfg['module-namespace-heading'] = 'Module documentation' | ||
-- cfg['file-namespace-heading'] | -- cfg['file-namespace-heading'] | ||
-- The heading shown in the file namespace. | -- The heading shown in the file namespace. | ||
cfg['file-namespace-heading'] = 'Summary' | cfg['file-namespace-heading'] = 'Summary' | ||
-- cfg['other-namespaces-heading'] | -- cfg['other-namespaces-heading'] | ||
-- The heading shown in other namespaces. | -- The heading shown in other namespaces. | ||
cfg['other-namespaces-heading'] = 'Documentation' | cfg['other-namespaces-heading'] = 'Documentation' | ||
-- cfg['view-link-display'] | -- cfg['view-link-display'] | ||
-- The text to display for "view" links. | -- The text to display for "view" links. | ||
cfg['view-link-display'] = 'view' | cfg['view-link-display'] = 'view' | ||
-- cfg['edit-link-display'] | -- cfg['edit-link-display'] | ||
-- The text to display for "edit" links. | -- The text to display for "edit" links. | ||
cfg['edit-link-display'] = 'edit' | cfg['edit-link-display'] = 'edit' | ||
-- cfg['history-link-display'] | -- cfg['history-link-display'] | ||
-- The text to display for "history" links. | -- The text to display for "history" links. | ||
cfg['history-link-display'] = 'history' | cfg['history-link-display'] = 'history' | ||
-- cfg['purge-link-display'] | -- cfg['purge-link-display'] | ||
-- The text to display for "purge" links. | -- The text to display for "purge" links. | ||
cfg['purge-link-display'] = 'purge' | cfg['purge-link-display'] = 'purge' | ||
-- cfg['create-link-display'] | -- cfg['create-link-display'] | ||
-- The text to display for "create" links. | -- The text to display for "create" links. | ||
cfg['create-link-display'] = 'create' | cfg['create-link-display'] = 'create' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- Link box (end box) configuration | -- Link box (end box) configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- 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'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[ | cfg['transcluded-from-blurb'] = 'The above [[w:Wikipedia:Template documentation|documentation]] is [[mw:Help:Transclusion|transcluded]] from $1.' | ||
--[[ | --[[ | ||
-- cfg['create-module-doc-blurb'] | -- cfg['create-module-doc-blurb'] | ||
Line 141: | Line 68: | ||
-- display cfg['create-link-display']. | -- display cfg['create-link-display']. | ||
--]] | --]] | ||
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[ | cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[mw:Extension:Scribunto/Lua reference manual|Scribunto module]].' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- Experiment blurb configuration | -- Experiment blurb configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
--[[ | --[[ | ||
-- cfg['experiment-blurb-template'] | -- cfg['experiment-blurb-template'] | ||
Line 177: | Line 104: | ||
-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format: | -- $2 is a link to the test cases page. If the test cases page exists, it is in the following format: | ||
-- | -- | ||
-- cfg['testcases-link-display'] (cfg['testcases-edit-link-display']) | -- cfg['testcases-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: | -- If the test cases page doesn't exist, it is in the format: | ||
Line 189: | Line 116: | ||
cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages." | cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages." | ||
cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages." | cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages." | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- Sandbox link configuration | -- Sandbox link configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg['sandbox-subpage'] | -- cfg['sandbox-subpage'] | ||
-- The name of the template subpage typically used for sandboxes. | -- The name of the template subpage typically used for sandboxes. | ||
cfg['sandbox-subpage'] = 'sandbox' | cfg['sandbox-subpage'] = 'sandbox' | ||
-- cfg['template-sandbox-preload'] | -- cfg['template-sandbox-preload'] | ||
-- Preload file for template sandbox pages. | -- Preload file for template sandbox pages. | ||
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox' | cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox' | ||
-- cfg['module-sandbox-preload'] | -- cfg['module-sandbox-preload'] | ||
-- Preload file for Lua module sandbox pages. | -- Preload file for Lua module sandbox pages. | ||
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox' | cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox' | ||
-- 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'] = 'sandbox' | ||
-- 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'] = 'edit' | ||
-- 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'] = 'create' | ||
-- 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'] = 'diff' | cfg['compare-link-display'] = 'diff' | ||
-- cfg['mirror-edit-summary'] | -- cfg['mirror-edit-summary'] | ||
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the | -- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the | ||
-- template page. | -- template page. | ||
cfg['mirror-edit-summary'] = 'Create sandbox version of $1' | cfg['mirror-edit-summary'] = 'Create sandbox version of $1' | ||
-- 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'] = '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 | -- Test cases link configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg['testcases-subpage'] | -- cfg['testcases-subpage'] | ||
-- The name of the template subpage typically used for test cases. | -- The name of the template subpage typically used for test cases. | ||
cfg['testcases-subpage'] = 'testcases' | cfg['testcases-subpage'] = 'testcases' | ||
-- cfg['template-testcases-preload'] | -- cfg['template-testcases-preload'] | ||
-- Preload file for template test cases pages. | -- Preload file for template test cases pages. | ||
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases' | cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases' | ||
-- cfg['module-testcases-preload'] | -- cfg['module-testcases-preload'] | ||
-- Preload file for Lua module test cases pages. | -- Preload file for Lua module test cases pages. | ||
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases' | cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases' | ||
-- 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'] = 'testcases' | ||
-- 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'] = 'edit' | ||
-- cfg['testcases-run-link-display'] | |||
-- The text to display for test cases "run" links. | |||
cfg['testcases-run-link-display'] = 'run' | |||
-- cfg['testcases-create-link-display'] | -- cfg['testcases-create-link-display'] | ||
-- 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'] = 'create' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- Add categories blurb configuration | -- Add categories blurb configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
--[[ | --[[ | ||
-- cfg['add-categories-blurb'] | -- cfg['add-categories-blurb'] | ||
Line 269: | Line 204: | ||
-- 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'] = 'Add categories to the $1 subpage.' | ||
-- cfg['doc-link-display'] | -- cfg['doc-link-display'] | ||
-- The text to display when linking to the /doc subpage. | -- The text to display when linking to the /doc subpage. | ||
cfg['doc-link-display'] = '/doc' | cfg['doc-link-display'] = '/doc' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- Subpages link configuration | -- Subpages link configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
--[[ | --[[ | ||
-- cfg['subpages-blurb'] | -- cfg['subpages-blurb'] | ||
Line 286: | Line 221: | ||
--]] | --]] | ||
cfg['subpages-blurb'] = '$1.' | cfg['subpages-blurb'] = '$1.' | ||
--[[ | --[[ | ||
-- cfg['subpages-link-display'] | -- cfg['subpages-link-display'] | ||
Line 294: | Line 229: | ||
--]] | --]] | ||
cfg['subpages-link-display'] = 'Subpages of this $1' | cfg['subpages-link-display'] = 'Subpages of this $1' | ||
-- 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'] = 'template' | ||
-- 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'] = 'module' | ||
-- 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'] = 'page' | cfg['default-pagetype'] = 'page' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- Doc link configuration | -- Doc link configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg['doc-subpage'] | -- cfg['doc-subpage'] | ||
-- 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['docpage-preload'] | -- cfg['docpage-preload'] | ||
-- Preload file for template documentation pages in all namespaces. | -- Preload file for template documentation pages in all namespaces. | ||
cfg['docpage-preload'] = 'Template:Documentation/preload' | cfg['docpage-preload'] = 'Template:Documentation/preload' | ||
-- cfg['module-preload'] | -- cfg['module-preload'] | ||
-- Preload file for Lua module documentation pages. | -- Preload file for Lua module documentation pages. | ||
cfg['module-preload'] = 'Template:Documentation/preload-module-doc' | cfg['module-preload'] = 'Template:Documentation/preload-module-doc' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- HTML and CSS configuration | -- HTML and CSS configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg[' | -- cfg['templatestyles'] | ||
-- The | -- The name of the TemplateStyles page where CSS is kept. | ||
cfg[' | -- 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'] | -- cfg['main-div-classes'] | ||
-- | -- Classes added to the main HTML "div" tag. | ||
cfg['main-div-classes'] = ' | cfg['main-div-classes'] = 'documentation' | ||
-- cfg[' | -- cfg['main-div-heading-class'] | ||
-- | -- Class for the main heading for templates and modules and assoc. talk spaces | ||
cfg['start-box- | cfg['main-div-heading-class'] = 'documentation-heading' | ||
-- cfg['start-box-link- | -- cfg['start-box-class'] | ||
-- | -- Class for the start box | ||
cfg['start-box-link- | 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[' | |||
-- | -- cfg['end-box-class'] | ||
cfg[' | -- Class for the end box. | ||
cfg['end-box-class'] = 'documentation-metadata' | |||
-- cfg[' | |||
-- | -- cfg['end-box-plainlinks'] | ||
cfg[' | -- Plainlinks | ||
cfg['end-box-plainlinks'] = 'plainlinks' | |||
-- cfg[' | |||
-- | -- cfg['toolbar-class'] | ||
cfg[' | -- Class added for toolbar links. | ||
cfg['toolbar-class'] = 'documentation-toolbar' | |||
-- cfg['clear'] | |||
-- Just used to clear things. | |||
cfg['clear'] = 'documentation-clear' | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- Tracking category configuration | -- Tracking category configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg['display-strange-usage-category'] | -- cfg['display-strange-usage-category'] | ||
-- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage | -- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage | ||
-- or a /testcases subpage. This should be a boolean value (either true or false). | -- or a /testcases subpage. This should be a boolean value (either true or false). | ||
cfg['display-strange-usage-category'] = true | cfg['display-strange-usage-category'] = true | ||
-- cfg['strange-usage-category'] | -- cfg['strange-usage-category'] | ||
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a | -- 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. | -- /doc subpage or a /testcases subpage. | ||
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage' | cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage' | ||
--[[ | --[[ | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 410: | Line 327: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
--]] | --]] | ||
return cfg | return cfg |