Module:Documentation/config: Difference between revisions
Jump to navigation
Jump to search
m>Mr. Stradivarius add notes for non-string values |
MeowyCats2 (talk | contribs) m 105 revisions imported |
||
(83 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 67: | Line 16: | ||
-- 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'] | ||
Line 111: | Line 60: | ||
-- 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'] | ||
-- 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 [[ | --]] | ||
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[mw:Extension:Scribunto/Lua reference manual|Scribunto module]].' | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 123: | Line 74: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
--[[ | |||
-- cfg['experiment-blurb-template'] | -- cfg['experiment-blurb-template'] | ||
-- cfg['experiment-blurb-module'] | -- cfg['experiment-blurb-module'] | ||
Line 152: | 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 161: | Line 113: | ||
-- 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 204: | Line 157: | ||
-- 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' | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 228: | Line 185: | ||
-- 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'] | ||
Line 237: | Line 198: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
--[[ | |||
-- 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'] = ' | --]] | ||
cfg['add-categories-blurb'] = 'Add categories to the $1 subpage.' | |||
-- cfg['doc-link-display'] | -- cfg['doc-link-display'] | ||
Line 251: | Line 214: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
--[[ | |||
-- 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'] | -- 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 276: | Line 249: | ||
-- 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'] | ||
Line 290: | Line 259: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- | -- HTML and CSS configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg[' | -- cfg['templatestyles'] | ||
-- The name of 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['main-div-classes'] = 'documentation' | |||
----- | -- cfg['main-div-heading-class'] | ||
-- | -- Class for the main heading for templates and modules and assoc. talk spaces | ||
---- | cfg['main-div-heading-class'] = 'documentation-heading' | ||
-- cfg[' | -- cfg['start-box-class'] | ||
-- | -- Class for the start box | ||
cfg[' | 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 365: | Line 320: | ||
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage' | cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage' | ||
--[[ | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- End configuration | -- End configuration | ||
Line 370: | Line 326: | ||
-- Don't edit anything below this line. | -- Don't edit anything below this line. | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
--]] | |||
return cfg | return cfg |