Module:Documentation/config: Difference between revisions
(Created page with "---------------------------------------------------------------------------------------------------- -- -- Configuration for Module:Documentation...") |
m>Jackmcbarn (add a message for running test cases) |
||
| Line 7: | Line 7: | ||
-- should be string values. | -- should be string values. | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
local cfg = {} -- Do not edit this line. | local cfg = {} -- Do not edit this line. | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- Protection template configuration | -- Protection template configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- cfg['protection-template'] | -- cfg['protection-template'] | ||
-- The name of the template that displays the protection icon (a padlock on enwiki). | -- The name of the template that displays the protection icon (a padlock on enwiki). | ||
cfg['protection-template'] = 'pp-template' | cfg['protection-template'] = 'pp-template' | ||
--[[ | --[[ | ||
-- cfg['protection-template-args'] | -- cfg['protection-template-args'] | ||
| Line 25: | Line 25: | ||
--]] | --]] | ||
cfg['protection-template-args'] = {docusage = 'yes'} | cfg['protection-template-args'] = {docusage = 'yes'} | ||
--[[ | --[[ | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 36: | Line 36: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
--]] | --]] | ||
-- cfg['sandbox-notice-image'] | -- cfg['sandbox-notice-image'] | ||
-- The image displayed in the sandbox notice. | -- The image displayed in the sandbox notice. | ||
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-template'] | ||
| Line 52: | Line 52: | ||
cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page' | cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page' | ||
cfg['sandbox-notice-pagetype-other'] = 'sandbox page' | cfg['sandbox-notice-pagetype-other'] = 'sandbox page' | ||
--[[ | --[[ | ||
-- cfg['sandbox-notice-blurb'] | -- cfg['sandbox-notice-blurb'] | ||
| Line 68: | Line 68: | ||
cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).' | 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'] | ||
-- 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 | -- 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. | -- 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-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-blurb'] = 'See also the companion subpage for $1.' | ||
cfg['sandbox-notice-testcases-link-display'] = 'test cases' | 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'] | -- cfg['sandbox-category'] | ||
-- A category to add to all template sandboxes. | -- A category to add to all template sandboxes. | ||
cfg['sandbox-category'] = 'Template sandboxes' | cfg['sandbox-category'] = 'Template sandboxes' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- Start box configuration | -- Start box configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- 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. | ||