Roses, Tulips, & Liberty

Module:Documentation/config: Difference between revisions

Module Discussion

Module:Documentation/config (view source)

Revision as of 21:39, 28 November 2023

156 bytes removed ,  5 months ago
m
1 revision imported from wikipedia:Module:Documentation/config
(convert messages to use hyphens instead of camelCase, in line with MediaWiki)
m (1 revision imported from wikipedia:Module:Documentation/config)
 
(35 intermediate revisions by 16 users not shown)
Line 9:
 
local cfg = {} -- Do not edit this line.
 
----------------------------------------------------------------------------------------------------
-- Environment configuration
----------------------------------------------------------------------------------------------------
 
-- cfg['error-prefix']
-- The prefix before any error messages found by the script.
cfg['error-prefix'] = '[[Module:Documentation]] error:'
 
-- cfg['error-category']
-- The category pages are placed into if any errors are found.
cfg['error-category'] = 'Documentation template invocations with errors'
 
----------------------------------------------------------------------------------------------------
-- Environment configuration
----------------------------------------------------------------------------------------------------
 
-- cfg['title-arg-error']
-- The error message to display if the "page" argument does not result in a
-- valid title.
cfg['title-arg-error'] = '$1 is not a valid title'
 
----------------------------------------------------------------------------------------------------
Line 35 ⟶ 14:
----------------------------------------------------------------------------------------------------
 
-- cfg['protection-templatereason-edit']
-- The protection reason for edit-protected templates to pass to
-- The name of the template that displays the protection icon (a padlock on enwiki).
-- [[Module:Protection banner]].
cfg['protection-template'] = 'pp-template'
cfg['protection-reason-edit'] = 'template'
 
-- cfg['protection-template-args']
-- Any arguments to send to the protection template.
cfg['protection-template-args'] = {docusage = 'yes'}
 
--[[
----------------------------------------------------------------------------------------------------
-- Sandbox notice configuration
Line 51 ⟶ 28:
-- messages that the notices contains.
----------------------------------------------------------------------------------------------------
--]]
 
-- cfg['sandbox-notice-image']
-- The image displayed in the sandbox notice.
cfg['sandbox-notice-image'] = '[[ImageFile:Sandbox.pngsvg|50px|alt=|link=]]'
 
--[[
-- cfg['sandbox-notice-blurb']
-- The opening sentence of the cfg['sandbox -notice. $1 is a link to the main -pagetype-template page.']
-- cfg['sandbox-notice-pagetype-module']
cfg['sandbox-notice-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.'
-- cfg['sandbox-notice-pagetype-other']
-- The page type of the sandbox page. The message that is displayed depends on the current subject
-- namespace. This message is used in either cfg['sandbox-notice-blurb'] or
-- cfg['sandbox-notice-diff-blurb'].
--]]
cfg['sandbox-notice-pagetype-template'] = '[[Wikipedia:Template test cases|template sandbox]] page'
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']
-- cfg['sandbox-notice-diff-display']
-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence of the sandbox notice, with a diff link. $1 is a link
-- toof the mainsandbox templatenotice. page,The andlatter $2 ishas a diff link, betweenbut the sandboxformer anddoes thenot. main$1 template.is Thethe page
-- displaytype, value of the diff linkwhich is set byeither cfg['sandbox-notice-compare-linkpagetype-displaytemplate'].,
-- cfg['sandbox-notice-diffpagetype-blurbmodule'] =or cfg['This is the [[Wikipedia:Template test cases|template sandbox]-notice-pagetype-other'] pagedepending for $1 ($2).'what
-- namespace we are in. $2 is a link to the main template page, and $3 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-blurb'] = 'This is the $1 for $2.'
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-link-display']
-- cfg['sandbox-notice-testcases-run-blurb']
-- cfg['sandbox-notice-testcases-run-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-run-blurb'] is a sentence notifying the user that there is a test cases page
-- corresponding to this sandbox that they can edit, along with a link to run it. $1 is a link to the test
-- cases page, and $2 is a link to the page to run it.
-- cfg['sandbox-notice-testcases-run-link-display'] is the display value for the link to run the test
-- cases.
--]]
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'
cfg['sandbox-notice-testcases-link-display'] = 'test cases'
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['module-sandbox-category'] - A category to add to all templatemodule sandboxes.
-- cfg['module-sandbox-category'] - A category to add to all sandboxe not in templates or modules.
cfg['sandbox-category'] = 'Template sandboxes'
cfg['module-sandbox-category'] = 'Module sandboxes'
cfg['other-sandbox-category'] = 'Sandboxes outside of template or module namespace'
 
 
----------------------------------------------------------------------------------------------------
Line 86 ⟶ 95:
-- cfg['documentation-icon-wikitext']
-- The wikitext for the icon shown at the top of the template.
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-infoIcon - Version (2).pngsvg|50px|link=|alt=Documentation icon]]'
 
-- cfg['template-namespace-heading']
Line 130 ⟶ 139:
-- 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 [[WikipediaHelp:Transclusion|transcluded]] from $1.'
 
--[[
-- cfg['create-module-doc-blurb']
-- 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
-- display cfg['create-link-display'].
--]]
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
 
Line 142 ⟶ 153:
----------------------------------------------------------------------------------------------------
 
--[[
-- cfg['experiment-blurb-template']
-- cfg['experiment-blurb-module']
Line 171 ⟶ 183:
-- $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-run-link-display'])
--
-- If the test cases page doesn't exist, it is in the format:
Line 180 ⟶ 192:
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current
-- namespace.
--]]
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."
Line 223 ⟶ 236:
-- The text to display for "mirror" links.
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 247 ⟶ 264:
-- The text to display for test cases "edit" links.
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']
Line 256 ⟶ 277:
----------------------------------------------------------------------------------------------------
 
--[[
-- cfg['add-categories-blurb']
-- 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
-- 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'] = 'Add categories to the $1 subpage.'
 
-- cfg['doc-link-display']
Line 270 ⟶ 293:
----------------------------------------------------------------------------------------------------
 
--[[
-- cfg['subpages-blurb']
-- 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
-- the link followed by a period, and the link display provides the actual text.
--]]
cfg['subpages-blurb'] = '$1.'
 
--[[
-- 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'
 
Line 295 ⟶ 328:
-- 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']
Line 309 ⟶ 338:
 
----------------------------------------------------------------------------------------------------
-- PrintHTML versionand CSS configuration
----------------------------------------------------------------------------------------------------
 
-- cfg['print-subpagetemplatestyles']
-- The name of the templateTemplateStyles subpagepage usedwhere forCSS printis versionskept.
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed.
cfg['print-subpage'] = 'Print'
cfg['templatestyles'] = 'Module:Documentation/styles.css'
 
-- cfg['print-link-displaycontainer']
-- Class which can be used to set flex or grid CSS on the
-- The text to display when linking to the /Print subpage.
-- two child divs documentation and documentation-metadata
cfg['print-link-display'] = '/Print'
cfg['container'] = 'documentation-container'
 
-- cfg['printmain-blurbdiv-classes']
-- Classes added to the main HTML "div" tag.
-- 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['main-div-classes'] = 'documentation'
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['displaymain-printdiv-categoryheading-class']
-- Class for the main heading for templates and modules and assoc. talk spaces
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
cfg['main-div-heading-class'] = 'documentation-heading'
cfg['display-print-category'] = true
 
-- cfg['printstart-categorybox-class']
-- Class for the start box
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
cfg['printstart-categorybox-class'] = 'Templates with print versionsdocumentation-startbox'
 
-- cfg['start-box-link-classes']
----------------------------------------------------------------------------------------------------
-- Classes used for the [view][edit][history] or [create] links in the start box.
-- HTML and CSS configuration
-- mw-editsection-like is per [[Wikipedia:Village pump (technical)/Archive 117]]
----------------------------------------------------------------------------------------------------
cfg['start-box-link-classes'] = 'mw-editsection-like plainlinks'
 
-- cfg['mainend-divbox-idclass']
-- TheClass "id" attribute offor the main HTML "div"end tagbox.
cfg['mainend-divbox-idclass'] = 'template-documentation-metadata'
 
-- cfg['mainend-divbox-classesplainlinks']
-- Plainlinks
-- The CSS classes added to the main HTML "div" tag.
cfg['mainend-divbox-classesplainlinks'] = 'template-documentation iezoomfixplainlinks'
 
-- cfg['starttoolbar-box-linkclassesclass']
-- Class added for toolbar links.
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
cfg['toolbar-class'] = 'documentation-toolbar'
cfg['start-box-linkclasses'] = 'mw-editsection plainlinks'
 
-- cfg['start-box-link-idclear']
-- Just used to clear things.
-- The HTML "id" attribute for the links in the start box.
cfg['start-box-link-idclear'] = 'doc_editlinksdocumentation-clear'
 
----------------------------------------------------------------------------------------------------
-- {{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-image-none']
-- The value to suppress image output from the "image" parameter of {{fmbox}}.
cfg['fmbox-image-none'] = 'none'
 
-- 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'
 
----------------------------------------------------------------------------------------------------
Line 379 ⟶ 391:
-- 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
 
Line 387 ⟶ 399:
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
Line 397 ⟶ 405:
-- Don't edit anything below this line.
----------------------------------------------------------------------------------------------------
--]]
 
return cfg
Tomartino
rtl-contributors
1,630

edits

Retrieved from "https://wiki.rosestulipsandliberty.com/wiki/Special:MobileDiff/8404...15504"