Module:Documentation/config: Difference between revisions
Jump to navigation
Jump to search
m>Mr. Stradivarius don't reuse values as it causes errors if the order is changed |
MeowyCats2 (talk | contribs) m 105 revisions imported |
||
(98 intermediate revisions by 55 users not shown) | |||
Line 9: | Line 9: | ||
local cfg = {} -- Do not edit this line. | local cfg = {} -- Do not edit this line. | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 49: | Line 14: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg | -- 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 | cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]' | ||
-- cfg | -- cfg['template-namespace-heading'] | ||
-- | |||
-- The heading shown in the template namespace. | -- The heading shown in the template namespace. | ||
cfg | cfg['template-namespace-heading'] = 'Template documentation' | ||
-- cfg | -- cfg['module-namespace-heading'] | ||
-- The heading shown in the module namespace. | -- The heading shown in the module namespace. | ||
cfg | cfg['module-namespace-heading'] = 'Module documentation' | ||
-- cfg | -- cfg['file-namespace-heading'] | ||
-- The heading shown in the file namespace. | -- The heading shown in the file namespace. | ||
cfg | cfg['file-namespace-heading'] = 'Summary' | ||
-- cfg | -- cfg['other-namespaces-heading'] | ||
-- The heading shown in other namespaces. | -- The heading shown in other namespaces. | ||
cfg | cfg['other-namespaces-heading'] = 'Documentation' | ||
-- cfg | -- cfg['view-link-display'] | ||
-- The text to display for "view" links. | -- The text to display for "view" links. | ||
cfg | cfg['view-link-display'] = 'view' | ||
-- cfg | -- cfg['edit-link-display'] | ||
-- The text to display for "edit" links. | -- The text to display for "edit" links. | ||
cfg | cfg['edit-link-display'] = 'edit' | ||
-- cfg | -- cfg['history-link-display'] | ||
-- The text to display for "history" links. | -- The text to display for "history" links. | ||
cfg | cfg['history-link-display'] = 'history' | ||
-- cfg | -- cfg['purge-link-display'] | ||
-- The text to display for "purge" links. | -- The text to display for "purge" links. | ||
cfg | cfg['purge-link-display'] = 'purge' | ||
-- cfg | -- cfg['create-link-display'] | ||
-- The text to display for "create" links. | -- The text to display for "create" links. | ||
cfg | cfg['create-link-display'] = 'create' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 117: | Line 58: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg | -- 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 | cfg['transcluded-from-blurb'] = 'The above [[w:Wikipedia:Template documentation|documentation]] is [[mw:Help:Transclusion|transcluded]] from $1.' | ||
-- cfg | --[[ | ||
-- cfg['create-module-doc-blurb'] | |||
-- Notice displayed in the module namespace when the documentation subpage does not exist. | -- 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 | -- $1 is a link to create the documentation page with the preload cfg['module-preload'] and the | ||
-- display cfg. | -- display cfg['create-link-display']. | ||
cfg | --]] | ||
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[mw:Extension:Scribunto/Lua reference manual|Scribunto module]].' | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 139: | Line 74: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg | --[[ | ||
-- | -- cfg['experiment-blurb-template'] | ||
-- cfg['experiment-blurb-module'] | |||
-- like this: | -- 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. | -- 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. | -- 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: | -- Parameters: | ||
-- | -- | ||
-- $1 | -- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format: | ||
-- | -- | ||
-- cfg | -- cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display']) | ||
-- | -- | ||
-- If the sandbox doesn't exist, it is in the format: | -- If the sandbox doesn't exist, it is in the format: | ||
-- | -- | ||
-- cfg | -- cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display']) | ||
-- | -- | ||
-- The link for cfg | -- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload'] | ||
-- or cfg | -- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display'] | ||
-- loads a default edit summary of cfg | -- 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 | -- 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: | ||
-- | -- | ||
-- cfg | -- cfg['testcases-link-display'] (cfg['testcases-create-link-display']) | ||
-- | -- | ||
-- If the test cases page doesn't exist, the link for cfg | -- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the | ||
-- page with cfg | -- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current | ||
-- namespace. | -- namespace. | ||
cfg | --]] | ||
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 | |||
-- | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 190: | Line 121: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg | -- cfg['sandbox-subpage'] | ||
-- The name of the template subpage typically used for sandboxes. | -- The name of the template subpage typically used for sandboxes. | ||
cfg | cfg['sandbox-subpage'] = 'sandbox' | ||
-- cfg | -- cfg['template-sandbox-preload'] | ||
-- Preload file for template sandbox pages. | -- Preload file for template sandbox pages. | ||
cfg | cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox' | ||
-- cfg | -- cfg['module-sandbox-preload'] | ||
-- Preload file for Lua module sandbox pages. | -- Preload file for Lua module sandbox pages. | ||
cfg | cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox' | ||
-- cfg | -- cfg['sandbox-link-display'] | ||
-- The text to display for "sandbox" links. | -- The text to display for "sandbox" links. | ||
cfg | cfg['sandbox-link-display'] = 'sandbox' | ||
-- cfg | -- cfg['sandbox-edit-link-display'] | ||
-- The text to display for sandbox "edit" links. | -- The text to display for sandbox "edit" links. | ||
cfg | cfg['sandbox-edit-link-display'] = 'edit' | ||
-- cfg | -- cfg['sandbox-create-link-display'] | ||
-- The text to display for sandbox "create" links. | -- The text to display for sandbox "create" links. | ||
cfg | cfg['sandbox-create-link-display'] = 'create' | ||
-- cfg | -- cfg['compare-link-display'] | ||
-- The text to display for "compare" links. | -- The text to display for "compare" links. | ||
cfg | cfg['compare-link-display'] = 'diff' | ||
-- cfg | -- 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 | cfg['mirror-edit-summary'] = 'Create sandbox version of $1' | ||
-- cfg | -- cfg['mirror-link-display'] | ||
-- The text to display for "mirror" links. | -- The text to display for "mirror" links. | ||
cfg. | 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' | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 231: | Line 166: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg | -- 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 | cfg['testcases-subpage'] = 'testcases' | ||
-- cfg | -- cfg['template-testcases-preload'] | ||
-- Preload file for template test cases pages. | -- Preload file for template test cases pages. | ||
cfg | cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases' | ||
-- cfg | -- cfg['module-testcases-preload'] | ||
-- Preload file for Lua module test cases pages. | -- Preload file for Lua module test cases pages. | ||
cfg | cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases' | ||
-- cfg | -- cfg['testcases-link-display'] | ||
-- The text to display for "testcases" links. | -- The text to display for "testcases" links. | ||
cfg | cfg['testcases-link-display'] = 'testcases' | ||
-- cfg | -- cfg['testcases-edit-link-display'] | ||
-- The text to display for test cases "edit" links. | -- The text to display for test cases "edit" links. | ||
cfg | cfg['testcases-edit-link-display'] = 'edit' | ||
-- cfg. | -- 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. | -- The text to display for test cases "create" links. | ||
cfg | cfg['testcases-create-link-display'] = 'create' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 259: | Line 198: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg | --[[ | ||
-- cfg['add-categories-blurb'] | |||
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or | -- 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 | -- "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. | -- link to the /doc subpage with a display value of cfg['doc-link-display']. | ||
cfg | --]] | ||
cfg['add-categories-blurb'] = 'Add categories to the $1 subpage.' | |||
-- cfg | -- 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 | cfg['doc-link-display'] = '/doc' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 273: | Line 214: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg | --[[ | ||
-- The | -- cfg['subpages-blurb'] | ||
-- cfg. | -- 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 | ||
cfg | -- the link followed by a period, and the link display provides the actual text. | ||
--]] | |||
cfg['subpages-blurb'] = '$1.' | |||
-- cfg. | --[[ | ||
-- 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. | -- The pagetype to display for template pages. | ||
cfg | cfg['template-pagetype'] = 'template' | ||
-- cfg | -- cfg['module-pagetype'] | ||
-- The pagetype to display for Lua module pages. | -- The pagetype to display for Lua module pages. | ||
cfg | cfg['module-pagetype'] = 'module' | ||
-- cfg | -- 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 | cfg['default-pagetype'] = 'page' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 295: | Line 246: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg | -- cfg['doc-subpage'] | ||
-- The name of the subpage typically used for documentation pages. | -- The name of the subpage typically used for documentation pages. | ||
cfg | cfg['doc-subpage'] = 'doc' | ||
-- cfg | -- cfg['docpage-preload'] | ||
- | |||
-- Preload file for template documentation pages in all namespaces. | -- Preload file for template documentation pages in all namespaces. | ||
cfg | cfg['docpage-preload'] = 'Template:Documentation/preload' | ||
-- cfg | -- cfg['module-preload'] | ||
-- Preload file for Lua module documentation pages. | -- Preload file for Lua module documentation pages. | ||
cfg | cfg['module-preload'] = 'Template:Documentation/preload-module-doc' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 340: | Line 262: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- 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 | -- cfg['container'] | ||
-- | -- Class which can be used to set flex or grid CSS on the | ||
cfg | -- two child divs documentation and documentation-metadata | ||
cfg['container'] = 'documentation-container' | |||
-- cfg | -- cfg['main-div-classes'] | ||
-- | -- Classes added to the main HTML "div" tag. | ||
cfg | 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 | cfg['main-div-heading-class'] = 'documentation-heading' | ||
---- | -- cfg['start-box-class'] | ||
-- | -- Class for the start box | ||
--- | cfg['start-box-class'] = 'documentation-startbox' | ||
-- cfg | -- cfg['start-box-link-classes'] | ||
-- | -- Classes used for the [view][edit][history] or [create] links in the start box. | ||
cfg | -- 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'] | ||
-- | -- Class for the end box. | ||
cfg | cfg['end-box-class'] = 'documentation-metadata' | ||
-- cfg | -- cfg['end-box-plainlinks'] | ||
-- | -- Plainlinks | ||
cfg | cfg['end-box-plainlinks'] = 'plainlinks' | ||
-- cfg | -- cfg['toolbar-class'] | ||
-- | -- Class added for toolbar links. | ||
cfg | cfg['toolbar-class'] = 'documentation-toolbar' | ||
-- cfg | -- cfg['clear'] | ||
-- | -- Just used to clear things. | ||
cfg | cfg['clear'] = 'documentation-clear' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 396: | Line 310: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg | -- cfg['display-strange-usage-category'] | ||
-- Set to true to enable output of cfg | -- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage | ||
-- or a /testcases subpage. | -- or a /testcases subpage. This should be a boolean value (either true or false). | ||
cfg | cfg['display-strange-usage-category'] = true | ||
-- cfg | -- cfg['strange-usage-category'] | ||
-- Category to output if cfg | -- 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 | cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage' | ||
--[[ | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- End configuration | -- End configuration | ||
Line 416: | Line 326: | ||
-- Don't edit anything below this line. | -- Don't edit anything below this line. | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
--]] | |||
return cfg | return cfg |