Module:Documentation/config: Difference between revisions
no edit summary
m>Jackmcbarn (add a message for running test cases) |
No edit summary |
||
| 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'] | ||
| Line 87: | Line 87: | ||
cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).' | cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).' | ||
cfg['sandbox-notice-testcases-run-link-display'] = 'run' | 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. | ||
cfg['documentation-icon-wikitext'] = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]' | cfg['documentation-icon-wikitext'] = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]' | ||
-- cfg['template-namespace-heading'] | -- cfg['template-namespace-heading'] | ||
-- The heading shown in the template namespace. | -- The heading shown in the template namespace. | ||
cfg['template-namespace-heading'] = 'Template documentation' | cfg['template-namespace-heading'] = 'Template documentation' | ||
-- cfg['module-namespace-heading'] | -- cfg['module-namespace-heading'] | ||
-- The heading shown in the module namespace. | -- The heading shown in the module namespace. | ||
cfg['module-namespace-heading'] = 'Module documentation' | cfg['module-namespace-heading'] = 'Module documentation' | ||
-- cfg['file-namespace-heading'] | -- cfg['file-namespace-heading'] | ||
-- The heading shown in the file namespace. | -- The heading shown in the file namespace. | ||
cfg['file-namespace-heading'] = 'Summary' | cfg['file-namespace-heading'] = 'Summary' | ||
-- cfg['other-namespaces-heading'] | -- cfg['other-namespaces-heading'] | ||
-- The heading shown in other namespaces. | -- The heading shown in other namespaces. | ||
cfg['other-namespaces-heading'] = 'Documentation' | cfg['other-namespaces-heading'] = 'Documentation' | ||
-- cfg['view-link-display'] | -- cfg['view-link-display'] | ||
-- The text to display for "view" links. | -- The text to display for "view" links. | ||
cfg['view-link-display'] = 'view' | cfg['view-link-display'] = 'view' | ||
-- cfg['edit-link-display'] | -- cfg['edit-link-display'] | ||
-- The text to display for "edit" links. | -- The text to display for "edit" links. | ||
cfg['edit-link-display'] = 'edit' | cfg['edit-link-display'] = 'edit' | ||
-- cfg['history-link-display'] | -- cfg['history-link-display'] | ||
-- The text to display for "history" links. | -- The text to display for "history" links. | ||
cfg['history-link-display'] = 'history' | cfg['history-link-display'] = 'history' | ||
-- cfg['purge-link-display'] | -- cfg['purge-link-display'] | ||
-- The text to display for "purge" links. | -- The text to display for "purge" links. | ||
cfg['purge-link-display'] = 'purge' | cfg['purge-link-display'] = 'purge' | ||
-- cfg['create-link-display'] | -- cfg['create-link-display'] | ||
-- The text to display for "create" links. | -- The text to display for "create" links. | ||
cfg['create-link-display'] = 'create' | cfg['create-link-display'] = 'create' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- Link box (end box) configuration | -- Link box (end box) configuration | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- 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 [[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'] | ||
| Line 151: | Line 151: | ||