The Lonsdale Battalion

Module:Documentation/config: Difference between revisions

Module Discussion

Module:Documentation/config (view source)

Revision as of 00:30, 28 March 2020

1,701 bytes added ,  4 years ago
m
4 revisions imported: import clickable buttons 2
(add notes for non-string values)
m (4 revisions imported: import clickable buttons 2)
 
(25 intermediate revisions by 11 users not shown)
Line 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-templatereason-edit'] = 'pp-template'
 
-- cfg['protection-template-args']
-- Any arguments to send to the protection template. This should be a Lua table.
-- For example, if the protection template is "pp-template", and the wikitext template invocation
-- looks like "{{pp-template|docusage=yes}}", then this table should look like "{docusage = 'yes'}".
cfg['protection-template-args'] = {docusage = 'yes'}
 
--[[
----------------------------------------------------------------------------------------------------
-- Sandbox notice configuration
Line 32 ⟶ 28:
-- messages that the notices contains.
----------------------------------------------------------------------------------------------------
--]]
 
-- cfg['sandbox-notice-image']
-- The image displayed in the sandbox notice.
cfg['sandbox-notice-image'] = '[[Image:Sandbox.pngsvg|50px|alt=|link=]]'
 
--[[
-- cfg['sandbox-notice-pagetype-template']
-- cfg['sandbox-notice-pagetype-module']
-- 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-blurbpagetype-template'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.'▼
cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'
cfg['sandbox-notice-pagetype-other'] = 'sandbox page'
 
--[[
-- 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']
-- 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']
Line 67 ⟶ 91:
-- 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 113 ⟶ 137:
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia: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 123 ⟶ 149:
----------------------------------------------------------------------------------------------------
 
--[[
-- cfg['experiment-blurb-template']
-- cfg['experiment-blurb-module']
Line 152 ⟶ 179:
-- $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 161 ⟶ 188:
-- 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 204 ⟶ 232:
-- 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 228 ⟶ 260:
-- 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 237 ⟶ 273:
----------------------------------------------------------------------------------------------------
 
--[[
-- 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.'
 
Line 251 ⟶ 289:
----------------------------------------------------------------------------------------------------
 
--[[
-- cfg['subpages-blurb']
▲-- The opening sentence"Subpages of thethis sandboxtemplate" noticeblurb. $1 is a link to the main template's page.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 329 ⟶ 377:
-- cfg['start-box-linkclasses']
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
cfg['start-box-linkclasses'] = 'mw-editsection-like plainlinks'
 
-- cfg['start-box-link-id']
Line 365 ⟶ 413:
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'
 
--[[
----------------------------------------------------------------------------------------------------
-- End configuration
Line 370 ⟶ 419:
-- Don't edit anything below this line.
----------------------------------------------------------------------------------------------------
--]]
 
return cfg
Retrieved from "https://thelonsdalebattalion.co.uk/wiki/Special:MobileDiff/29953...34875"