Module:Documentation/config: Difference between revisions
m>Mr. Stradivarius 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))) |
m>Mr. Stradivarius (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-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-blurb'] | ||
-- 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 of the sandbox notice | -- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence | ||
-- to the main template page, and $ | -- 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 docum | ||