Editing Module:Documentation/config
Jump to navigation
Jump to search
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 9: | Line 9: | ||
local cfg = {} -- Do not edit this line. | local cfg = {} -- Do not edit this line. | ||
---------------------------------------------------------------------------------------------------- | |||
-- Protection template configuration | |||
---------------------------------------------------------------------------------------------------- | |||
-- cfg['protection-reason-edit'] | |||
-- The protection reason for edit-protected templates to pass to | |||
-- [[Module:Protection banner]]. | |||
cfg['protection-reason-edit'] = 'template' | |||
--[[ | |||
---------------------------------------------------------------------------------------------------- | |||
-- Sandbox notice configuration | |||
-- | |||
-- On sandbox pages the module can display a template notifying users that the current page is a | |||
-- sandbox, and the location of test cases pages, etc. The module decides whether the page is a | |||
-- sandbox or not based on the value of cfg['sandbox-subpage']. The following settings configure the | |||
-- messages that the notices contains. | |||
---------------------------------------------------------------------------------------------------- | |||
--]] | |||
-- cfg['sandbox-notice-image'] | |||
-- The image displayed in the sandbox notice. | |||
cfg['sandbox-notice-image'] = '[[File:Sandbox.svg|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-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. 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-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-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'] | |||
-- A category to add to all template sandboxes. | |||
cfg['sandbox-category'] = 'Template sandboxes' | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
Line 60: | Line 135: | ||
-- 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 [[ | cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Help:Transclusion|transcluded]] from $1.' | ||
--[[ | --[[ | ||
Line 68: | Line 143: | ||
-- 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 [[ | cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |