Module:Documentation/config: Difference between revisions
m
4 revisions imported: import clickable buttons 2
(remove unused messages) |
m (4 revisions imported: import clickable buttons 2) |
||
(35 intermediate revisions by 11 users not shown) | |||
Line 9:
local cfg = {} -- Do not edit this line.
----------------------------------------------------------------------------------------------------
Line 39 ⟶ 14:
----------------------------------------------------------------------------------------------------
-- cfg['protection-reason-edit']
-- The protection reason for edit-protected templates to pass to
-- [[Module:Protection banner]].
cfg['protection-reason-edit'] = 'template'
--[[
----------------------------------------------------------------------------------------------------
-- Sandbox
--
-- 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
-- messages that the notices contains.
----------------------------------------------------------------------------------------------------
--]]
-- cfg['sandbox-notice-image']
-- The
cfg['sandbox-notice-image'] = '[[Image:Sandbox.svg|50px|alt=|link=]]'
--[[
--
-- 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 74 ⟶ 89:
----------------------------------------------------------------------------------------------------
-- cfg['documentation-icon-wikitext']
-- The wikitext for the icon shown at the top of the template.
cfg
-- cfg['template-namespace-heading']
-- The heading shown in the template namespace.
cfg
-- cfg['module-namespace-heading']
-- The heading shown in the module namespace.
cfg
-- cfg['file-namespace-heading']
-- The heading shown in the file namespace.
cfg
-- cfg['other-namespaces-heading']
-- The heading shown in other namespaces.
cfg
-- cfg
-- The text to display for "view" links.
cfg
-- cfg
-- The text to display for "edit" links.
cfg
-- cfg['history-link-display']
-- The text to display for "history" links.
cfg
-- cfg
-- The text to display for "purge" links.
cfg
-- cfg
-- The text to display for "create" links.
cfg
----------------------------------------------------------------------------------------------------
Line 142 ⟶ 133:
----------------------------------------------------------------------------------------------------
-- cfg['transcluded-from-blurb']
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
cfg
--[[
-- 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
-- display cfg
--]]
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
----------------------------------------------------------------------------------------------------
Line 164 ⟶ 149:
----------------------------------------------------------------------------------------------------
--[[
-- cfg['experiment-blurb-template']
-- cfg['experiment-blurb-module']
-- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages.
-- It is only shown in the template and module namespaces. With the default English settings, it
Line 174 ⟶ 160:
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
--
-- There are two versions, cfg
-- on what namespace we are in.
--
Line 181 ⟶ 167:
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:
--
-- cfg
--
-- If the sandbox doesn't exist, it is in the format:
--
-- cfg
--
-- The link for cfg
-- or cfg
-- loads a default edit summary of cfg
--
-- $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-run-link-display'])
--
-- If the test cases page doesn't exist, it is in the format:
--
-- cfg
--
-- If the test cases page doesn't exist, the link for cfg
-- page with cfg
-- namespace.
--]]
cfg
cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages."
----------------------------------------------------------------------------------------------------
Line 209 ⟶ 196:
----------------------------------------------------------------------------------------------------
-- cfg
-- The name of the template subpage typically used for sandboxes.
cfg
-- cfg['template-sandbox-preload']
-- Preload file for template sandbox pages.
cfg
-- cfg['module-sandbox-preload']
-- Preload file for Lua module sandbox pages.
cfg
-- cfg['sandbox-link-display']
-- The text to display for "sandbox" links.
cfg
-- cfg['sandbox-edit-link-display']
-- The text to display for sandbox "edit" links.
cfg
-- cfg['sandbox-create-link-display']
-- The text to display for sandbox "create" links.
cfg
-- cfg['compare-link-display']
-- The text to display for "compare" links.
cfg
-- cfg
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
-- template page.
cfg
-- cfg
-- The text to display for "mirror" links.
cfg
-- cfg['mirror-link-preload']
-- The page to preload when a user clicks the "mirror" link.
cfg['mirror-link-preload'] = 'Template:Documentation/mirror'
----------------------------------------------------------------------------------------------------
Line 250 ⟶ 241:
----------------------------------------------------------------------------------------------------
-- cfg
-- The name of the template subpage typically used for test cases.
cfg
-- cfg['template-testcases-preload']
-- Preload file for template test cases pages.
cfg
-- cfg['module-testcases-preload']
-- Preload file for Lua module test cases pages.
cfg
-- cfg['testcases-link-display']
-- The text to display for "testcases" links.
cfg
-- cfg['testcases-edit-link-display']
-- The text to display for test cases "edit" links.
cfg
-- cfg['testcases-run-link-display']
-- The text to display for test cases "run" links.
cfg['testcases-run-link-display'] = 'run'
-- cfg['testcases-create-link-display']
-- The text to display for test cases "create" links.
cfg
----------------------------------------------------------------------------------------------------
Line 278 ⟶ 273:
----------------------------------------------------------------------------------------------------
--[[
-- cfg['add-categories-blurb']
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a
-- link to the /doc subpage with a display value of cfg
--]]
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.'
-- cfg
-- The text to display when linking to the /doc subpage.
cfg
----------------------------------------------------------------------------------------------------
Line 292 ⟶ 289:
----------------------------------------------------------------------------------------------------
--[[
-- cfg['subpages-blurb']
-- The "Subpages of this template" blurb. $1 is a link to the main template's subpages with a
-- display value of cfg['subpages-link-display']. In the English version this blurb is simply
-- the link followed by a period, and the link display provides the actual text.
--]]
cfg['subpages-blurb'] = '$1.'
--[[
-- cfg['subpages-link-display']
-- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'],
-- cfg['module-pagetype'] or cfg['default-pagetype'], depending on whether the current page is in
-- the template namespace, the module namespace, or another namespace.
--]]
cfg['subpages-link-display'] = 'Subpages of this $1'
-- cfg['template-pagetype']
-- The pagetype to display for template pages.
cfg
-- cfg
-- The pagetype to display for Lua module pages.
cfg
-- cfg
-- The pagetype to display for pages other than templates or Lua modules.
cfg
----------------------------------------------------------------------------------------------------
Line 314 ⟶ 321:
----------------------------------------------------------------------------------------------------
-- cfg
-- The name of the subpage typically used for documentation pages.
cfg
-- cfg['file-docpage-preload']
-- Preload file for documentation page in the file namespace.
cfg
-- cfg
-- Preload file for template documentation pages in all namespaces.
cfg
-- cfg
-- Preload file for Lua module documentation pages.
cfg
----------------------------------------------------------------------------------------------------
Line 334 ⟶ 341:
----------------------------------------------------------------------------------------------------
-- cfg
-- The name of the template subpage used for print versions.
cfg
-- cfg
-- The text to display when linking to the /Print subpage.
cfg
-- cfg
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg
cfg
.. ' If you make a change to this template, please update the print version as well.'
-- cfg['display-print-category']
-- Set to true to enable output of cfg
-- This should be a boolean value (either true or false).
cfg['display-print-category'] = true
-- cfg
-- Category to output if cfg
cfg
----------------------------------------------------------------------------------------------------
Line 359 ⟶ 367:
----------------------------------------------------------------------------------------------------
-- cfg
-- The "id" attribute of the main HTML "div" tag.
cfg
-- cfg
-- The CSS classes added to the main HTML "div" tag.
cfg
-- cfg['start-box-linkclasses']
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
cfg
-- cfg
-- The HTML "id" attribute for the links in the start box.
cfg
----------------------------------------------------------------------------------------------------
Line 379 ⟶ 387:
----------------------------------------------------------------------------------------------------
-- cfg
-- The id sent to the "id" parameter of the {{fmbox}} template.
cfg
-- cfg
-- The value sent to the style parameter of {{fmbox}}.
cfg
-- cfg
-- The value sent to the "textstyle parameter of {{fmbox}}.
cfg
----------------------------------------------------------------------------------------------------
Line 399 ⟶ 403:
----------------------------------------------------------------------------------------------------
-- cfg['display-strange-usage-category']
-- Set to true to enable output of cfg
-- or a /testcases subpage. This should be a boolean value (either true or false).
cfg
-- cfg['strange-usage-category']
-- Category to output if cfg
-- /doc subpage or a /testcases subpage.
cfg
--[[
----------------------------------------------------------------------------------------------------
-- End configuration
Line 419:
-- Don't edit anything below this line.
----------------------------------------------------------------------------------------------------
--]]
return cfg
|