Editing Module:Documentation/config
Jump to navigation
Jump to search
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 9: | Line 9: | ||
local cfg = {} -- Do not edit this line. | local cfg = {} -- Do not edit this line. | ||
---------------------------------------------------------------------------------------------------- | |||
-- 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-template-args'] | |||
-- Any arguments to send to the protection template. | |||
cfg['protection-template-args'] = {docusage = 'yes'} | |||
---------------------------------------------------------------------------------------------------- | |||
-- Sandbox notice configuration | |||
-- | |||
-- 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['sandbox-subpage']. The following settings configure the | |||
-- messages that the notices contains. | |||
---------------------------------------------------------------------------------------------------- | |||
-- cfg['sandbox-notice-image'] | |||
-- The image displayed in the sandbox notice. | |||
cfg['sandbox-notice-image'] = '[[Image:Sandbox.png|50px|alt=|link=]]' | |||
-- cfg['sandbox-notice-blurb'] | |||
-- The opening sentence of the sandbox notice. $1 is a link to the main template page. | |||
cfg['sandbox-notice-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.' | |||
-- cfg['sandbox-notice-diff-blurb'] | |||
-- cfg['sandbox-notice-diff-display'] | |||
-- cfg['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['sandbox-notice-compare-link-display']. | |||
cfg['sandbox-notice-diff-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).' | |||
cfg['sandbox-notice-compare-link-display'] = 'diff' | |||
-- cfg['sandbox-notice-testcases-blurb'] | |||
-- cfg['sandbox-notice-testcases-link-display'] | |||
-- cfg['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['sandbox-notice-testcases-link-display'] is the display value for that link. | |||
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.' | |||
cfg['sandbox-notice-testcases-link-display'] = 'test cases' | |||
-- cfg['sandbox-category'] | |||
-- A category to add to all template sandboxes. | |||
cfg['sandbox-category'] = 'Template sandboxes' | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 16: | Line 65: | ||
-- 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: | cfg['documentation-icon-wikitext'] = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]' | ||
-- cfg['template-namespace-heading'] | -- cfg['template-namespace-heading'] | ||
Line 60: | Line 109: | ||
-- 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 [[ | 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'] | ||
-- 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['module-preload'] and the | -- $1 is a link to create the documentation page with the preload cfg['module-preload'] and the | ||
-- 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 [[Wikipedia:Lua|Scribunto module]].' | |||
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[ | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 74: | Line 121: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg['experiment-blurb-template'] | -- cfg['experiment-blurb-template'] | ||
-- cfg['experiment-blurb-module'] | -- cfg['experiment-blurb-module'] | ||
Line 104: | Line 150: | ||
-- $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 113: | Line 159: | ||
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current | -- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current | ||
-- namespace. | -- namespace. | ||
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." | ||
Line 157: | Line 202: | ||
-- The text to display for "mirror" links. | -- The text to display for "mirror" links. | ||
cfg['mirror-link-display'] = 'mirror' | cfg['mirror-link-display'] = 'mirror' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 185: | Line 226: | ||
-- 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-create-link-display'] | -- cfg['testcases-create-link-display'] | ||
Line 198: | Line 235: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg['add-categories-blurb'] | -- 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['doc-link-display']. | -- link to the /doc subpage with a display value of cfg['doc-link-display']. | ||
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.' | |||
cfg['add-categories-blurb'] = ' | |||
-- cfg['doc-link-display'] | -- cfg['doc-link-display'] | ||
Line 214: | Line 249: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg['subpages-link-display'] | -- cfg['subpages-link-display'] | ||
-- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'], | -- 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 | -- cfg['module-pagetype'] or cfg['default-pagetype'], depending on whether the current page is in | ||
-- the template namespace, the module namespace, or another namespace. | -- the template namespace, the module namespace, or another namespace. | ||
cfg['subpages-link-display'] = 'Subpages of this $1' | cfg['subpages-link-display'] = 'Subpages of this $1' | ||
Line 249: | Line 274: | ||
-- 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 257: | Line 286: | ||
-- 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' | ||
---------------------------------------------------------------------------------------------------- | |||
-- 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. | |||
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' | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 262: | Line 316: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg[' | -- cfg['main-div-id'] | ||
-- The | -- The "id" attribute of the main HTML "div" tag. | ||
cfg['main-div-id'] = 'template-documentation' | |||
-- | |||
-- cfg['main-div-classes'] | -- cfg['main-div-classes'] | ||
-- | -- The CSS classes added to the main HTML "div" tag. | ||
cfg['main-div-classes'] = 'documentation' | cfg['main-div-classes'] = 'template-documentation iezoomfix' | ||
-- cfg[' | -- cfg['start-box-linkclasses'] | ||
-- | -- The CSS classes used for the [view][edit][history] or [create] links in the start box. | ||
cfg[' | cfg['start-box-linkclasses'] = 'mw-editsection plainlinks' | ||
-- cfg['start-box- | -- cfg['start-box-link-id'] | ||
-- | -- The HTML "id" attribute for the links in the start box. | ||
cfg['start-box- | cfg['start-box-link-id'] = 'doc_editlinks' | ||
-- | ---------------------------------------------------------------------------------------------------- | ||
-- | -- {{fmbox}} template configuration | ||
-- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg[' | -- cfg['fmbox-id'] | ||
-- | -- The id sent to the "id" parameter of the {{fmbox}} template. | ||
cfg[' | cfg['fmbox-id'] = 'documentation-meta-data' | ||
-- cfg[' | -- cfg['fmbox-image-none'] | ||
-- | -- The value to suppress image output from the "image" parameter of {{fmbox}}. | ||
cfg[' | cfg['fmbox-image-none'] = 'none' | ||
-- cfg[' | -- cfg['fmbox-style'] | ||
-- | -- The value sent to the style parameter of {{fmbox}}. | ||
cfg[' | cfg['fmbox-style'] = 'background-color: #ecfcf4' | ||
-- cfg['fmbox-textstyle'] | |||
-- The value sent to the "textstyle parameter of {{fmbox}}. | |||
cfg['fmbox-textstyle'] = 'font-style: italic' | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 312: | Line 358: | ||
-- 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 | -- or a /testcases subpage. | ||
cfg['display-strange-usage-category'] = true | cfg['display-strange-usage-category'] = true | ||
Line 320: | Line 366: | ||
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage' | cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage' | ||
--[[ | -- cfg['strange-usage-category-mainspace-sort'] | ||
-- Category sort key prefix to use for cfg['strange-usage-category'] in the main namespace. The prefix | |||
-- is followed by the full page name. | |||
cfg['strange-usage-category-mainspace-sort'] = 'Main:' | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- End configuration | -- End configuration | ||
Line 326: | Line 376: | ||
-- Don't edit anything below this line. | -- Don't edit anything below this line. | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
return cfg | return cfg |