Module:Documentation/config: Difference between revisions

(44 intermediate revisions by 25 users not shown)

Line 14:

----------------------------------------------------------------------------------------------------

-- cfg['protection-~~template~~']

-- cfg['protection-reason-edit']

-- The ~~name of the template that displays the protection icon (a padlock on enwiki).~~

-- The protection reason for edit-protected templates to pass to

~~cfg['~~protection-~~template'] = 'pp-template'~~

-- [[Module:Protection banner]].

cfg['protection-reason-edit'] = 'template'

-- ~~cfg~~[~~'protection-template-args'~~]

~~-- Any arguments to send to the protection template~~.

cfg['protection-~~template~~-~~args~~'] ~~= {docusage~~ = '~~yes~~'}

--[[

----------------------------------------------------------------------------------------------------

-- Sandbox notice configuration

Line 30:

Line 28:

-- messages that the notices contains.

----------------------------------------------------------------------------------------------------

--]]

-- cfg['sandbox-notice-image']

-- The image displayed in the sandbox notice.

cfg['sandbox-notice-image'] = '[[~~Image~~:Sandbox.~~png~~|50px|alt=|link=]]'

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']

~~-- The opening sentence of the sandbox notice. $1 is a link to the main template page.~~

~~cfg['sandbox-notice-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.'~~

-- cfg['sandbox-notice-diff-blurb']

-- cfg['sandbox-notice-diff-display']

-- cfg['sandbox-notice-diff-blurb'] is the opening sentence of the sandbox notice~~, with~~ a diff link. $1 is ~~a link~~

-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence

-- to the main template page, and $2 is a diff link between the sandbox and the main template. The

-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page

-- display value of the diff link is set by cfg['sandbox-notice-compare-link-display'].

-- type, which is either cfg['sandbox-notice-pagetype-template'],

cfg['sandbox-notice~~-diff~~-blurb'] = 'This is the [~~[Wikipedia:Template test cases|template~~ sandbox]~~] page~~ for $1 ($2).'

-- 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']

Line 65:

Line 91:

-- cfg['documentation-icon-wikitext']

-- 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:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'

-- cfg['template-namespace-heading']

Line 111:

Line 137:

cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'

--[[

-- cfg['create-module-doc-blurb']

-- 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

-- display cfg['create-link-display'].

--]]

cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'

Line 121:

Line 149:

----------------------------------------------------------------------------------------------------

--[[

-- cfg['experiment-blurb-template']

-- cfg['experiment-blurb-module']

Line 150:

Line 179:

-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format:

--

-- cfg['testcases-link-display'] (cfg['testcases-edit-link-display'])

-- cfg['testcases-link-display'] (cfg['testcases-edit-link-display'] | cfg['testcases-r

@@ Line 14: / Line 14: @@
 ----------------------------------------------------------------------------------------------------
--- cfg['protection-template']
+-- cfg['protection-reason-edit']
--- The name of the template that displays the protection icon (a padlock on enwiki).
+-- The protection reason for edit-protected templates to pass to
-cfg['protection-template'] = 'pp-template'
+-- [[Module:Protection banner]].
+cfg['protection-reason-edit'] = 'template'
--- cfg['protection-template-args']
--- Any arguments to send to the protection template.
-cfg['protection-template-args'] = {docusage = 'yes'}
+--[[
 ----------------------------------------------------------------------------------------------------
 -- Sandbox notice configuration
@@ Line 30: / Line 28: @@
 -- messages that the notices contains.
 ----------------------------------------------------------------------------------------------------
+--]]
 -- cfg['sandbox-notice-image']
 -- The image displayed in the sandbox notice.
-cfg['sandbox-notice-image'] = '[[Image:Sandbox.png|50px|alt=|link=]]'
+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']
--- The opening sentence of the sandbox notice. $1 is a link to the main template page.
-cfg['sandbox-notice-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.'
 -- cfg['sandbox-notice-diff-blurb']
 -- cfg['sandbox-notice-diff-display']
--- cfg['sandbox-notice-diff-blurb'] is the opening sentence of the sandbox notice, with a diff link. $1 is a link
+-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence
--- to the main template page, and $2 is a diff link between the sandbox and the main template. The
+-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page
--- display value of the diff link is set by cfg['sandbox-notice-compare-link-display'].
+-- type, which is either cfg['sandbox-notice-pagetype-template'],
-cfg['sandbox-notice-diff-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).'
+-- 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']
@@ Line 65: / Line 91: @@
 -- cfg['documentation-icon-wikitext']
 -- 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:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
 -- cfg['template-namespace-heading']
@@ Line 111: / Line 137: @@
 cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'
+--[[
 -- cfg['create-module-doc-blurb']
 -- 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
 -- display cfg['create-link-display'].
+--]]
 cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
@@ Line 121: / Line 149: @@
 ----------------------------------------------------------------------------------------------------
+--[[
 -- cfg['experiment-blurb-template']
 -- cfg['experiment-blurb-module']
@@ Line 150: / Line 179: @@
 -- $2 is a link to the test cases page. If the test cases page exists, it is in the following format:
 --
---     cfg['testcases-link-display'] (cfg['testcases-edit-link-display'])
+--     cfg['testcases-link-display'] (cfg['testcases-edit-link-display'] | cfg['testcases-r