Module:Documentation/config: Difference between revisions
From Video Credit Archive
Content deleted Content added
wikpedia>Mr. Stradivarius add diff message back for sandbox notice - some wikis might want this to be separate from the one in the end box |
wikpedia>Mr. Stradivarius convert messages to use hyphens instead of camelCase, in line with MediaWiki |
||
Line 14: | Line 14: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg |
-- cfg['error-prefix'] |
||
-- The prefix before any error messages found by the script. |
-- The prefix before any error messages found by the script. |
||
cfg |
cfg['error-prefix'] = '[[Module:Documentation]] error:' |
||
-- cfg |
-- cfg['error-category'] |
||
-- The category pages are placed into if any errors are found. |
-- The category pages are placed into if any errors are found. |
||
cfg |
cfg['error-category'] = 'Documentation template invocations with errors' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 26: | Line 26: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg |
-- cfg['title-arg-error'] |
||
-- The error message to display if the "page" argument does not result in a |
-- The error message to display if the "page" argument does not result in a |
||
-- valid title. |
-- valid title. |
||
cfg |
cfg['title-arg-error'] = '$1 is not a valid title' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 35: | Line 35: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg |
-- 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 |
cfg['protection-template'] = 'pp-template' |
||
-- cfg['protection-template-args'] |
|||
-- cfg.protectionTemplateArgs |
|||
-- Any arguments to send to the protection template. |
-- Any arguments to send to the protection template. |
||
cfg |
cfg['protection-template-args'] = {docusage = 'yes'} |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 48: | Line 48: | ||
-- On sandbox pages the module can display a template notifying users that the current page is a |
-- 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, 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 or not based on the value of cfg['sandbox-subpage']. The following settings configure the |
||
-- messages that the notices contains. |
-- messages that the notices contains. |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg['sandbox-notice-image'] |
|||
-- cfg.sandboxNoticeImage |
|||
-- The image displayed in the sandbox notice. |
-- The image displayed in the sandbox notice. |
||
cfg |
cfg['sandbox-notice-image'] = '[[Image:Sandbox.png|50px|alt=|link=]]' |
||
-- cfg['sandbox-notice-blurb'] |
|||
-- cfg.sandboxNoticeBlurb |
|||
-- The opening sentence of the sandbox notice. $1 is a link to the main template page. |
-- The opening sentence of the sandbox notice. $1 is a link to the main template page. |
||
cfg |
cfg['sandbox-notice-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.' |
||
-- cfg['sandbox-notice-diff-blurb'] |
|||
-- cfg.sandboxNoticeDiffBlurb |
|||
-- cfg['sandbox-notice-diff-display'] |
|||
-- cfg.sandboxNoticeDiffDisplay |
|||
-- cfg |
-- cfg['sandbox-notice-diff-blurb'] is the opening sentence of the sandbox notice, with a diff link. $1 is a link |
||
-- to the main template page, and $2 is a diff link between the sandbox and the main template. The |
-- to the main template page, and $2 is a diff link between the sandbox and the main template. The |
||
-- display value of the diff link is set by cfg |
-- display value of the diff link is set by cfg['sandbox-notice-compare-link-display']. |
||
cfg |
cfg['sandbox-notice-diff-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).' |
||
cfg |
cfg['sandbox-notice-compare-link-display'] = 'diff' |
||
-- cfg['sandbox-notice-testcases-blurb'] |
|||
-- cfg.sandboxNoticeTestcasesBlurb |
|||
-- cfg['sandbox-notice-testcases-link-display'] |
|||
-- cfg.sandboxNoticeTestcasesLinkDisplay |
|||
-- cfg |
-- 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. |
-- corresponding to this sandbox that they can edit. $1 is a link to the test cases page. |
||
-- cfg |
-- cfg['sandbox-notice-testcases-link-display'] is the display value for that link. |
||
cfg |
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.' |
||
cfg |
cfg['sandbox-notice-testcases-link-display'] = 'test cases' |
||
-- cfg |
-- cfg['sandbox-category'] |
||
-- A category to add to all template sandboxes. |
-- A category to add to all template sandboxes. |
||
cfg |
cfg['sandbox-category'] = 'Template sandboxes' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 84: | Line 84: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg['documentation-icon-wikitext'] |
|||
-- cfg.documentationIconWikitext |
|||
-- 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 |
cfg['documentation-icon-wikitext'] = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]' |
||
-- cfg['template-namespace-heading'] |
|||
-- cfg.templateNamespaceHeading |
|||
-- The heading shown in the template namespace. |
-- The heading shown in the template namespace. |
||
cfg |
cfg['template-namespace-heading'] = 'Template documentation' |
||
-- cfg['module-namespace-heading'] |
|||
-- cfg.moduleNamespaceHeading |
|||
-- The heading shown in the module namespace. |
-- The heading shown in the module namespace. |
||
cfg |
cfg['module-namespace-heading'] = 'Module documentation' |
||
-- cfg['file-namespace-heading'] |
|||
-- cfg.fileNamespaceHeading |
|||
-- The heading shown in the file namespace. |
-- The heading shown in the file namespace. |
||
cfg |
cfg['file-namespace-heading'] = 'Summary' |
||
-- cfg['other-namespaces-heading'] |
|||
-- cfg.otherNamespacesHeading |
|||
-- The heading shown in other namespaces. |
-- The heading shown in other namespaces. |
||
cfg |
cfg['other-namespaces-heading'] = 'Documentation' |
||
-- cfg |
-- cfg['view-link-display'] |
||
-- The text to display for "view" links. |
-- The text to display for "view" links. |
||
cfg |
cfg['view-link-display'] = 'view' |
||
-- cfg |
-- cfg['edit-link-display'] |
||
-- The text to display for "edit" links. |
-- The text to display for "edit" links. |
||
cfg |
cfg['edit-link-display'] = 'edit' |
||
-- cfg['history-link-display'] |
|||
-- cfg.historyLinkDisplay |
|||
-- The text to display for "history" links. |
-- The text to display for "history" links. |
||
cfg |
cfg['history-link-display'] = 'history' |
||
-- cfg |
-- cfg['purge-link-display'] |
||
-- The text to display for "purge" links. |
-- The text to display for "purge" links. |
||
cfg |
cfg['purge-link-display'] = 'purge' |
||
-- cfg |
-- cfg['create-link-display'] |
||
-- The text to display for "create" links. |
-- The text to display for "create" links. |
||
cfg |
cfg['create-link-display'] = 'create' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 128: | Line 128: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg['transcluded-from-blurb'] |
|||
-- cfg.transcludedFromBlurb |
|||
-- 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 |
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.' |
||
-- cfg['create-module-doc-blurb'] |
|||
-- cfg.createModuleDocBlurb |
|||
-- Notice displayed in the module namespace when the documentation subpage does not exist. |
-- 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 |
-- $1 is a link to create the documentation page with the preload cfg['module-preload'] and the |
||
-- display cfg |
-- display cfg['create-link-display']. |
||
cfg |
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 142: | Line 142: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg['experiment-blurb-template'] |
|||
-- cfg.experimentBlurbTemplate |
|||
-- cfg['experiment-blurb-module'] |
|||
-- cfg.experimentBlurbModule |
|||
-- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages. |
-- 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 |
-- It is only shown in the template and module namespaces. With the default English settings, it |
||
Line 152: | Line 152: | ||
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links. |
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links. |
||
-- |
-- |
||
-- There are two versions, cfg |
-- There are two versions, cfg['experiment-blurb-template'] and cfg['experiment-blurb-module'], depending |
||
-- on what namespace we are in. |
-- on what namespace we are in. |
||
-- |
-- |
||
Line 159: | Line 159: | ||
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format: |
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format: |
||
-- |
-- |
||
-- cfg |
-- cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display']) |
||
-- |
-- |
||
-- If the sandbox doesn't exist, it is in the format: |
-- If the sandbox doesn't exist, it is in the format: |
||
-- |
-- |
||
-- cfg |
-- cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display']) |
||
-- |
-- |
||
-- The link for cfg |
-- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload'] |
||
-- or cfg |
-- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display'] |
||
-- loads a default edit summary of cfg |
-- loads a default edit summary of cfg['mirror-edit-summary']. |
||
-- |
-- |
||
-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format: |
-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format: |
||
-- |
-- |
||
-- cfg |
-- cfg['testcases-link-display'] (cfg['testcases-edit-link-display']) |
||
-- |
-- |
||
-- If the test cases page doesn't exist, it is in the format: |
-- If the test cases page doesn't exist, it is in the format: |
||
-- |
-- |
||
-- cfg |
-- cfg['testcases-link-display'] (cfg['testcases-create-link-display']) |
||
-- |
-- |
||
-- If the test cases page doesn't exist, the link for cfg |
-- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the |
||
-- page with cfg |
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current |
||
-- namespace. |
-- namespace. |
||
cfg |
cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages." |
||
cfg |
cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages." |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 187: | Line 187: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg |
-- cfg['sandbox-subpage'] |
||
-- The name of the template subpage typically used for sandboxes. |
-- The name of the template subpage typically used for sandboxes. |
||
cfg |
cfg['sandbox-subpage'] = 'sandbox' |
||
-- cfg['template-sandbox-preload'] |
|||
-- cfg.templateSandboxPreload |
|||
-- Preload file for template sandbox pages. |
-- Preload file for template sandbox pages. |
||
cfg |
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox' |
||
-- cfg['module-sandbox-preload'] |
|||
-- cfg.moduleSandboxPreload |
|||
-- Preload file for Lua module sandbox pages. |
-- Preload file for Lua module sandbox pages. |
||
cfg |
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox' |
||
-- cfg['sandbox-link-display'] |
|||
-- cfg.sandboxLinkDisplay |
|||
-- The text to display for "sandbox" links. |
-- The text to display for "sandbox" links. |
||
cfg |
cfg['sandbox-link-display'] = 'sandbox' |
||
-- cfg['sandbox-edit-link-display'] |
|||
-- cfg.sandboxEditLinkDisplay |
|||
-- The text to display for sandbox "edit" links. |
-- The text to display for sandbox "edit" links. |
||
cfg |
cfg['sandbox-edit-link-display'] = 'edit' |
||
-- cfg['sandbox-create-link-display'] |
|||
-- cfg.sandboxCreateLinkDisplay |
|||
-- The text to display for sandbox "create" links. |
-- The text to display for sandbox "create" links. |
||
cfg |
cfg['sandbox-create-link-display'] = 'create' |
||
-- cfg['compare-link-display'] |
|||
-- cfg.compareLinkDisplay |
|||
-- The text to display for "compare" links. |
-- The text to display for "compare" links. |
||
cfg |
cfg['compare-link-display'] = 'diff' |
||
-- cfg |
-- cfg['mirror-edit-summary'] |
||
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the |
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the |
||
-- template page. |
-- template page. |
||
cfg |
cfg['mirror-edit-summary'] = 'Create sandbox version of $1' |
||
-- cfg |
-- cfg['mirror-link-display'] |
||
-- The text to display for "mirror" links. |
-- The text to display for "mirror" links. |
||
cfg |
cfg['mirror-link-display'] = 'mirror' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 228: | Line 228: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg |
-- cfg['testcases-subpage'] |
||
-- The name of the template subpage typically used for test cases. |
-- The name of the template subpage typically used for test cases. |
||
cfg |
cfg['testcases-subpage'] = 'testcases' |
||
-- cfg['template-testcases-preload'] |
|||
-- cfg.templateTestcasesPreload |
|||
-- Preload file for template test cases pages. |
-- Preload file for template test cases pages. |
||
cfg |
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases' |
||
-- cfg['module-testcases-preload'] |
|||
-- cfg.moduleTestcasesPreload |
|||
-- Preload file for Lua module test cases pages. |
-- Preload file for Lua module test cases pages. |
||
cfg |
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases' |
||
-- cfg['testcases-link-display'] |
|||
-- cfg.testcasesLinkDisplay |
|||
-- The text to display for "testcases" links. |
-- The text to display for "testcases" links. |
||
cfg |
cfg['testcases-link-display'] = 'testcases' |
||
-- cfg['testcases-edit-link-display'] |
|||
-- cfg.testcasesEditLinkDisplay |
|||
-- The text to display for test cases "edit" links. |
-- The text to display for test cases "edit" links. |
||
cfg |
cfg['testcases-edit-link-display'] = 'edit' |
||
-- cfg['testcases-create-link-display'] |
|||
-- cfg.testcasesCreateLinkDisplay |
|||
-- The text to display for test cases "create" links. |
-- The text to display for test cases "create" links. |
||
cfg |
cfg['testcases-create-link-display'] = 'create' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 256: | Line 256: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg['add-categories-blurb'] |
|||
-- cfg.addCategoriesBlurb |
|||
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or |
-- 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 |
-- "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 |
-- link to the /doc subpage with a display value of cfg['doc-link-display']. |
||
cfg |
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.' |
||
-- cfg |
-- cfg['doc-link-display'] |
||
-- The text to display when linking to the /doc subpage. |
-- The text to display when linking to the /doc subpage. |
||
cfg |
cfg['doc-link-display'] = '/doc' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 270: | Line 270: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg['subpages-link-display'] |
|||
-- cfg.subpagesLinkDisplay |
|||
-- The text to display for the "subpages of this page" link. $1 is cfg |
-- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'], |
||
-- cfg |
-- 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 |
cfg['subpages-link-display'] = 'Subpages of this $1' |
||
-- cfg |
-- cfg['template-pagetype'] |
||
-- The pagetype to display for template pages. |
-- The pagetype to display for template pages. |
||
cfg |
cfg['template-pagetype'] = 'template' |
||
-- cfg |
-- cfg['module-pagetype'] |
||
-- The pagetype to display for Lua module pages. |
-- The pagetype to display for Lua module pages. |
||
cfg |
cfg['module-pagetype'] = 'module' |
||
-- cfg |
-- cfg['default-pagetype'] |
||
-- The pagetype to display for pages other than templates or Lua modules. |
-- The pagetype to display for pages other than templates or Lua modules. |
||
cfg |
cfg['default-pagetype'] = 'page' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 292: | Line 292: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg |
-- cfg['doc-subpage'] |
||
-- The name of the subpage typically used for documentation pages. |
-- The name of the subpage typically used for documentation pages. |
||
cfg |
cfg['doc-subpage'] = 'doc' |
||
-- cfg['file-docpage-preload'] |
|||
-- cfg.fileDocpagePreload |
|||
-- Preload file for documentation page in the file namespace. |
-- Preload file for documentation page in the file namespace. |
||
cfg |
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace' |
||
-- cfg |
-- cfg['docpage-preload'] |
||
-- Preload file for template documentation pages in all namespaces. |
-- Preload file for template documentation pages in all namespaces. |
||
cfg |
cfg['docpage-preload'] = 'Template:Documentation/preload' |
||
-- cfg |
-- cfg['module-preload'] |
||
-- Preload file for Lua module documentation pages. |
-- Preload file for Lua module documentation pages. |
||
cfg |
cfg['module-preload'] = 'Template:Documentation/preload-module-doc' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 312: | Line 312: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg |
-- cfg['print-subpage'] |
||
-- The name of the template subpage used for print versions. |
-- The name of the template subpage used for print versions. |
||
cfg |
cfg['print-subpage'] = 'Print' |
||
-- cfg |
-- cfg['print-link-display'] |
||
-- The text to display when linking to the /Print subpage. |
-- The text to display when linking to the /Print subpage. |
||
cfg |
cfg['print-link-display'] = '/Print' |
||
-- cfg |
-- cfg['print-blurb'] |
||
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg |
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display']. |
||
cfg |
cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.' |
||
.. ' If you make a change to this template, please update the print version as well.' |
.. ' If you make a change to this template, please update the print version as well.' |
||
-- cfg['display-print-category'] |
|||
-- cfg.displayPrintCategory |
|||
-- Set to true to enable output of cfg |
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists. |
||
cfg |
cfg['display-print-category'] = true |
||
-- cfg |
-- cfg['print-category'] |
||
-- Category to output if cfg |
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists. |
||
cfg |
cfg['print-category'] = 'Templates with print versions' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 337: | Line 337: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg |
-- cfg['main-div-id'] |
||
-- The "id" attribute of the main HTML "div" tag. |
-- The "id" attribute of the main HTML "div" tag. |
||
cfg |
cfg['main-div-id'] = 'template-documentation' |
||
-- cfg |
-- cfg['main-div-classes'] |
||
-- The CSS classes added to the main HTML "div" tag. |
-- The CSS classes added to the main HTML "div" tag. |
||
cfg |
cfg['main-div-classes'] = 'template-documentation iezoomfix' |
||
-- cfg['start-box-linkclasses'] |
|||
-- cfg.startBoxLinkclasses |
|||
-- The CSS classes used for the [view][edit][history] or [create] links in the start box. |
-- The CSS classes used for the [view][edit][history] or [create] links in the start box. |
||
cfg |
cfg['start-box-linkclasses'] = 'mw-editsection plainlinks' |
||
-- cfg |
-- cfg['start-box-link-id'] |
||
-- The HTML "id" attribute for the links in the start box. |
-- The HTML "id" attribute for the links in the start box. |
||
cfg |
cfg['start-box-link-id'] = 'doc_editlinks' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 357: | Line 357: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg |
-- cfg['fmbox-id'] |
||
-- The id sent to the "id" parameter of the {{fmbox}} template. |
-- The id sent to the "id" parameter of the {{fmbox}} template. |
||
cfg |
cfg['fmbox-id'] = 'documentation-meta-data' |
||
-- cfg |
-- cfg['fmbox-image-none'] |
||
-- The value to suppress image output from the "image" parameter of {{fmbox}}. |
-- The value to suppress image output from the "image" parameter of {{fmbox}}. |
||
cfg |
cfg['fmbox-image-none'] = 'none' |
||
-- cfg |
-- cfg['fmbox-style'] |
||
-- The value sent to the style parameter of {{fmbox}}. |
-- The value sent to the style parameter of {{fmbox}}. |
||
cfg |
cfg['fmbox-style'] = 'background-color: #ecfcf4' |
||
-- cfg |
-- cfg['fmbox-textstyle'] |
||
-- The value sent to the "textstyle parameter of {{fmbox}}. |
-- The value sent to the "textstyle parameter of {{fmbox}}. |
||
cfg |
cfg['fmbox-textstyle'] = 'font-style: italic' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 377: | Line 377: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg['display-strange-usage-category'] |
|||
-- cfg.displayStrangeUsageCategory |
|||
-- Set to true to enable output of cfg |
-- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage |
||
-- or a /testcases subpage. |
-- or a /testcases subpage. |
||
cfg |
cfg['display-strange-usage-category'] = true |
||
-- cfg['strange-usage-category'] |
|||
-- cfg.strangeUsageCategory |
|||
-- Category to output if cfg |
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a |
||
-- /doc subpage or a /testcases subpage. |
-- /doc subpage or a /testcases subpage. |
||
cfg |
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage' |
||
-- cfg['strange-usage-category-mainspace-sort'] |
|||
-- cfg.strangeUsageCategoryMainspaceSort |
|||
-- Category sort key prefix to use for cfg |
-- Category sort key prefix to use for cfg['strange-usage-category'] in the main namespace. The prefix |
||
-- is followed by the full page name. |
-- is followed by the full page name. |
||
cfg |
cfg['strange-usage-category-mainspace-sort'] = 'Main:' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
Revision as of 04:51, 20 January 2014
Documentation for this module may be created at Module:Documentation/config/doc
----------------------------------------------------------------------------------------------------
--
-- Configuration for Module:Documentation
--
-- Here you can set the values of the parameters and messages used in Module:Documentation to
-- localise it to your wiki and your language. Unless specified otherwise, values given here
-- should be string values.
----------------------------------------------------------------------------------------------------
local cfg = {} -- Do not edit this line.
----------------------------------------------------------------------------------------------------
-- Environment configuration
----------------------------------------------------------------------------------------------------
-- cfg['error-prefix']
-- The prefix before any error messages found by the script.
cfg['error-prefix'] = '[[Module:Documentation]] error:'
-- cfg['error-category']
-- The category pages are placed into if any errors are found.
cfg['error-category'] = 'Documentation template invocations with errors'
----------------------------------------------------------------------------------------------------
-- Environment configuration
----------------------------------------------------------------------------------------------------
-- cfg['title-arg-error']
-- The error message to display if the "page" argument does not result in a
-- valid title.
cfg['title-arg-error'] = '$1 is not a valid title'
----------------------------------------------------------------------------------------------------
-- Protection template configuration
----------------------------------------------------------------------------------------------------
-- cfg['protection-template']
-- The name of the template that displays the protection icon (a padlock on enwiki).
cfg['protection-template'] = 'pp-template'
-- cfg['protection-template-args']
-- Any arguments to send to the protection template.
cfg['protection-template-args'] = {docusage = 'yes'}
----------------------------------------------------------------------------------------------------
-- 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'] = '[[Image:Sandbox.png|50px|alt=|link=]]'
-- 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
-- to the main template page, and $2 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-diff-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).'
cfg['sandbox-notice-compare-link-display'] = 'diff'
-- cfg['sandbox-notice-testcases-blurb']
-- cfg['sandbox-notice-testcases-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-blurb'] = 'See also the companion subpage for $1.'
cfg['sandbox-notice-testcases-link-display'] = 'test cases'
-- cfg['sandbox-category']
-- A category to add to all template sandboxes.
cfg['sandbox-category'] = 'Template sandboxes'
----------------------------------------------------------------------------------------------------
-- Start box configuration
----------------------------------------------------------------------------------------------------
-- 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['template-namespace-heading']
-- The heading shown in the template namespace.
cfg['template-namespace-heading'] = 'Template documentation'
-- cfg['module-namespace-heading']
-- The heading shown in the module namespace.
cfg['module-namespace-heading'] = 'Module documentation'
-- cfg['file-namespace-heading']
-- The heading shown in the file namespace.
cfg['file-namespace-heading'] = 'Summary'
-- cfg['other-namespaces-heading']
-- The heading shown in other namespaces.
cfg['other-namespaces-heading'] = 'Documentation'
-- cfg['view-link-display']
-- The text to display for "view" links.
cfg['view-link-display'] = 'view'
-- cfg['edit-link-display']
-- The text to display for "edit" links.
cfg['edit-link-display'] = 'edit'
-- cfg['history-link-display']
-- The text to display for "history" links.
cfg['history-link-display'] = 'history'
-- cfg['purge-link-display']
-- The text to display for "purge" links.
cfg['purge-link-display'] = 'purge'
-- cfg['create-link-display']
-- The text to display for "create" links.
cfg['create-link-display'] = 'create'
----------------------------------------------------------------------------------------------------
-- Link box (end box) configuration
----------------------------------------------------------------------------------------------------
-- cfg['transcluded-from-blurb']
-- 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['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]].'
----------------------------------------------------------------------------------------------------
-- Experiment blurb configuration
----------------------------------------------------------------------------------------------------
-- 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
-- might look like this:
--
-- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
--
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
--
-- There are two versions, cfg['experiment-blurb-template'] and cfg['experiment-blurb-module'], depending
-- on what namespace we are in.
--
-- Parameters:
--
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:
--
-- cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display'])
--
-- If the sandbox doesn't exist, it is in the format:
--
-- cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display'])
--
-- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload']
-- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display']
-- loads a default edit summary of cfg['mirror-edit-summary'].
--
-- $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'])
--
-- If the test cases page doesn't exist, it is in the format:
--
-- cfg['testcases-link-display'] (cfg['testcases-create-link-display'])
--
-- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current
-- namespace.
cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages."
cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages."
----------------------------------------------------------------------------------------------------
-- Sandbox link configuration
----------------------------------------------------------------------------------------------------
-- cfg['sandbox-subpage']
-- The name of the template subpage typically used for sandboxes.
cfg['sandbox-subpage'] = 'sandbox'
-- cfg['template-sandbox-preload']
-- Preload file for template sandbox pages.
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'
-- cfg['module-sandbox-preload']
-- Preload file for Lua module sandbox pages.
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'
-- cfg['sandbox-link-display']
-- The text to display for "sandbox" links.
cfg['sandbox-link-display'] = 'sandbox'
-- cfg['sandbox-edit-link-display']
-- The text to display for sandbox "edit" links.
cfg['sandbox-edit-link-display'] = 'edit'
-- cfg['sandbox-create-link-display']
-- The text to display for sandbox "create" links.
cfg['sandbox-create-link-display'] = 'create'
-- cfg['compare-link-display']
-- The text to display for "compare" links.
cfg['compare-link-display'] = 'diff'
-- cfg['mirror-edit-summary']
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
-- template page.
cfg['mirror-edit-summary'] = 'Create sandbox version of $1'
-- cfg['mirror-link-display']
-- The text to display for "mirror" links.
cfg['mirror-link-display'] = 'mirror'
----------------------------------------------------------------------------------------------------
-- Test cases link configuration
----------------------------------------------------------------------------------------------------
-- cfg['testcases-subpage']
-- The name of the template subpage typically used for test cases.
cfg['testcases-subpage'] = 'testcases'
-- cfg['template-testcases-preload']
-- Preload file for template test cases pages.
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'
-- cfg['module-testcases-preload']
-- Preload file for Lua module test cases pages.
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'
-- cfg['testcases-link-display']
-- The text to display for "testcases" links.
cfg['testcases-link-display'] = 'testcases'
-- cfg['testcases-edit-link-display']
-- The text to display for test cases "edit" links.
cfg['testcases-edit-link-display'] = 'edit'
-- cfg['testcases-create-link-display']
-- The text to display for test cases "create" links.
cfg['testcases-create-link-display'] = 'create'
----------------------------------------------------------------------------------------------------
-- Add categories blurb configuration
----------------------------------------------------------------------------------------------------
-- 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['doc-link-display'].
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.'
-- cfg['doc-link-display']
-- The text to display when linking to the /doc subpage.
cfg['doc-link-display'] = '/doc'
----------------------------------------------------------------------------------------------------
-- Subpages link configuration
----------------------------------------------------------------------------------------------------
-- 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['template-pagetype'] = 'template'
-- cfg['module-pagetype']
-- The pagetype to display for Lua module pages.
cfg['module-pagetype'] = 'module'
-- cfg['default-pagetype']
-- The pagetype to display for pages other than templates or Lua modules.
cfg['default-pagetype'] = 'page'
----------------------------------------------------------------------------------------------------
-- Doc link configuration
----------------------------------------------------------------------------------------------------
-- cfg['doc-subpage']
-- The name of the subpage typically used for documentation pages.
cfg['doc-subpage'] = 'doc'
-- cfg['file-docpage-preload']
-- Preload file for documentation page in the file namespace.
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'
-- cfg['docpage-preload']
-- Preload file for template documentation pages in all namespaces.
cfg['docpage-preload'] = 'Template:Documentation/preload'
-- cfg['module-preload']
-- Preload file for Lua module documentation pages.
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'
----------------------------------------------------------------------------------------------------
-- Print version configuration
----------------------------------------------------------------------------------------------------
-- cfg['print-subpage']
-- The name of the template subpage used for print versions.
cfg['print-subpage'] = 'Print'
-- cfg['print-link-display']
-- The text to display when linking to the /Print subpage.
cfg['print-link-display'] = '/Print'
-- cfg['print-blurb']
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].
cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'
.. ' 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['print-category'] if a /Print subpage exists.
cfg['display-print-category'] = true
-- cfg['print-category']
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
cfg['print-category'] = 'Templates with print versions'
----------------------------------------------------------------------------------------------------
-- HTML and CSS configuration
----------------------------------------------------------------------------------------------------
-- cfg['main-div-id']
-- The "id" attribute of the main HTML "div" tag.
cfg['main-div-id'] = 'template-documentation'
-- cfg['main-div-classes']
-- The CSS classes added to the main HTML "div" tag.
cfg['main-div-classes'] = 'template-documentation iezoomfix'
-- cfg['start-box-linkclasses']
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
cfg['start-box-linkclasses'] = 'mw-editsection plainlinks'
-- cfg['start-box-link-id']
-- The HTML "id" attribute for the links in the start box.
cfg['start-box-link-id'] = 'doc_editlinks'
----------------------------------------------------------------------------------------------------
-- {{fmbox}} template configuration
----------------------------------------------------------------------------------------------------
-- cfg['fmbox-id']
-- The id sent to the "id" parameter of the {{fmbox}} template.
cfg['fmbox-id'] = 'documentation-meta-data'
-- cfg['fmbox-image-none']
-- The value to suppress image output from the "image" parameter of {{fmbox}}.
cfg['fmbox-image-none'] = 'none'
-- cfg['fmbox-style']
-- The value sent to the style parameter of {{fmbox}}.
cfg['fmbox-style'] = 'background-color: #ecfcf4'
-- cfg['fmbox-textstyle']
-- The value sent to the "textstyle parameter of {{fmbox}}.
cfg['fmbox-textstyle'] = 'font-style: italic'
----------------------------------------------------------------------------------------------------
-- Tracking category configuration
----------------------------------------------------------------------------------------------------
-- cfg['display-strange-usage-category']
-- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage
-- or a /testcases subpage.
cfg['display-strange-usage-category'] = true
-- cfg['strange-usage-category']
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a
-- /doc subpage or a /testcases subpage.
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'
-- cfg['strange-usage-category-mainspace-sort']
-- Category sort key prefix to use for cfg['strange-usage-category'] in the main namespace. The prefix
-- is followed by the full page name.
cfg['strange-usage-category-mainspace-sort'] = 'Main:'
----------------------------------------------------------------------------------------------------
-- End configuration
--
-- Don't edit anything below this line.
----------------------------------------------------------------------------------------------------
return cfg