Module:Documentation/config: Difference between revisions

(38 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. This should be a Lua table~~.

~~-- 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'}".~~

~~--]]~~

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

--[[

Line 39:

Line 32:

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

--[[

Line 72:

Line 65:

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

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

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-run-link-display'])

--

-- If the test cases page doesn't exist, it is in the format:

Line 230:

Line 232:

-- The text to display for "mirror" links.

cfg['mirror-link-display'] = 'mirror'

-- cfg['mirror-link-preload']

-- The page to preload when a user clicks the "mirror" link.

cfg['mirror-link-preload'] = 'Template:Documentation/mirror'

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

Line 254:

Line 260:

-- The text to display for test cases "edit" links.

cfg['testcases-edit-link-display'] = 'edit'

-- cfg['testcases-run-link-display']

-- The text to display for test cases "run" links.

cfg['testcases-run-link-display'] = 'run'