Module:Documentation/config: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
m (Protected Module:Documentation/config: High-risk Lua module ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite))) |
(add new messages for the sandbox notice and add double brackets for some of the longer comments) |
||
Line 18: | Line 18: | ||
cfg['protection-template'] = 'pp-template' |
cfg['protection-template'] = 'pp-template' |
||
--[[ |
|||
-- cfg['protection-template-args'] |
-- cfg['protection-template-args'] |
||
-- Any arguments to send to the protection template. This should be a Lua table. |
-- 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 |
-- 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'}". |
-- looks like "{{pp-template|docusage=yes}}", then this table should look like "{docusage = 'yes'}". |
||
--]] |
|||
cfg['protection-template-args'] = {docusage = 'yes'} |
cfg['protection-template-args'] = {docusage = 'yes'} |
||
--[[ |
|||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- Sandbox notice configuration |
-- Sandbox notice configuration |
||
Line 32: | Line 35: | ||
-- messages that the notices contains. |
-- messages that the notices contains. |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
--]] |
|||
-- cfg['sandbox-notice-image'] |
-- cfg['sandbox-notice-image'] |
||
Line 37: | Line 41: | ||
cfg['sandbox-notice-image'] = '[[Image:Sandbox.png|50px|alt=|link=]]' |
cfg['sandbox-notice-image'] = '[[Image:Sandbox.png|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-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page' |
|||
cfg['sandbox-notice-pagetype-other'] = 'sandbox page' |
|||
--[[ |
|||
⚫ | |||
-- cfg['sandbox-notice-diff-blurb'] |
-- cfg['sandbox-notice-diff-blurb'] |
||
-- cfg['sandbox-notice-diff-display'] |
-- cfg['sandbox-notice-diff-display'] |
||
-- cfg['sandbox-notice-diff-blurb'] is the opening sentence |
-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence |
||
-- |
-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page |
||
-- |
-- type, which is either cfg['sandbox-notice-pagetype-template'], |
||
cfg['sandbox-notice- |
-- cfg['sandbox-notice-pagetype-module'] or cfg['sandbox-notice-pagetype-other'] depending 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-compare-link-display'] = 'diff' |
||
--[[ |
|||
-- cfg['sandbox-notice-testcases-blurb'] |
-- cfg['sandbox-notice-testcases-blurb'] |
||
-- cfg['sandbox-notice-testcases-link-display'] |
-- cfg['sandbox-notice-testcases-link-display'] |
||
Line 54: | Line 75: | ||
-- corresponding to this sandbox that they can edit. $1 is a link to the 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-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-blurb'] = 'See also the companion subpage for $1.' |
||
cfg['sandbox-notice-testcases-link-display'] = 'test cases' |
cfg['sandbox-notice-testcases-link-display'] = 'test cases' |
||
Line 113: | Line 135: | ||
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.' |
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 [[Wikipedia:Lua|Scribunto module]].' |
||
Line 123: | Line 147: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
--[[ |
|||
-- cfg['experiment-blurb-template'] |
-- cfg['experiment-blurb-template'] |
||
-- cfg['experiment-blurb-module'] |
-- cfg['experiment-blurb-module'] |
||
Line 161: | Line 186: | ||
-- 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 237: | Line 263: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
--[[ |
|||
-- 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'] = 'Please add categories to the $1 subpage.' |
||
Line 251: | Line 279: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
--[[ |
|||
-- cfg['subpages-blurb'] |
-- cfg['subpages-blurb'] |
||
-- The "Subpages of this template" blurb. $1 is a link to the main template's subpages with a |
-- 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 |
-- 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. |
-- the link followed by a period, and the link display provides the actual text. |
||
--]] |
|||
cfg['subpages-blurb'] = '$1.' |
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 371: | Line 403: | ||
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 376: | Line 409: | ||
-- Don't edit anything below this line. |
-- Don't edit anything below this line. |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
--]] |
|||
return cfg |
return cfg |