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.

Documentation

Package items

documentation.config['protection-reason-edit'] (member • string)

The protection reason for edit-protected templates to pass to Module:Protection banner.

documentation.config['template-tocright'] (member • string)

A name of the template for Table of Contents in right alignment.

documentation.config['sandbox-notice-show'] (member • boolean)

Whether to show the sandbox notice on /sandbox subpages

documentation.config['sandbox-notice-image'] (member • string)

The file displayed in the sandbox notice.

documentation.config['sandbox-notice-pagetype-template'] ()

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

documentation.config['sandbox-notice-blurb'] ()

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

documentation.config['sandbox-notice-testcases-show'] ()

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.

documentation.config['sandbox-category'] (member • string)

A category to add to all template sandboxes.

documentation.config['documentation-icon-wikitext'] (member • string)

The wikitext for the icon shown at the top of the template.

documentation.config['documentation-icon'] (member • string)

The file name for the icon shown at the top of the template.

documentation.config['documentation-icon-nodoc'] (member • string)

The file name for the icon shown at the top of the template when no /doc subpage exists.

documentation.config['documentation-icon-baddoc'] (member • string)

The file name for the icon shown at the top of the template when the documentation is marked as bad.

documentation.config['sandbox-subpage-show'] (member • boolean)

Whether to show a link to the sandbox subpage

documentation.config['sandbox-subpage'] (member • string)

The name of the template subpage typically used for sandboxes.

documentation.config['template-sandbox-preload'] (member • string)

Preload file for template sandbox pages.

documentation.config['module-sandbox-preload'] (member • string)

Preload file for Lua module sandbox pages.

documentation.config['mirror-link-preload'] (member • string)

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

documentation.config['testcases-subpage'] (member • string)

The name of the template subpage typically used for test cases.

documentation.config['template-testcases-preload'] (member • string)

Preload file for template test cases pages.

documentation.config['module-testcases-preload'] (member • string)

Preload file for Lua module test cases pages.

documentation.config['doc-link-display'] (member • string)

The text to display when linking to the /doc subpage.

documentation.config['doc-subpage'] (member • string)

The name of the subpage typically used for documentation pages.

documentation.config['file-docpage-preload'] (member • string)

Preload file for documentation page in the file namespace.

documentation.config['docpage-preload'] (member • string)

Preload file for template documentation pages in all namespaces.

documentation.config['module-preload'] (member • string)

Preload file for Lua module documentation pages.

documentation.config['print-show'] (member • boolean)

Disables or enabled /print content

documentation.config['print-subpage'] (member • string)

The name of the template subpage used for print versions.

documentation.config['print-link-display'] (member • string)

The text to display when linking to the /Print subpage.

documentation.config['display-print-category'] (member • boolean)

Set to true to enable output of cfg['print-category'] if a /Print subpage exists. This should be a boolean value (either true or false).

documentation.config['print-category'] (member • string)

Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.

documentation.config['main-div-id'] (member • string)

The "id" attribute of the main HTML "div" tag.

documentation.config['main-div-classes'] (member • string)

The CSS classes added to the main HTML "div" tag.

documentation.config['start-box-div-classes'] (member • string)

The CSS classes used for the start box "div" tag.

documentation.config['start-box-linkclasses'] (member • string)

The CSS classes used for the [view][edit][history] or [create] links in the start box.

documentation.config['start-box-link-id'] (member • string)

The HTML "id" attribute for the links in the start box.

documentation.config['languages-list-div-classes'] (member • string)

The CSS classes used for the languages list.

documentation.config['content-box-div-classes'] (member • string)

The CSS classes used for the content box "div" tag.

documentation.config['end-box-div-id'] (member • string)

The "id" attribute of the end box HTML "div" tag.

documentation.config['end-box-div-classes'] (member • string)

The CSS classes used for the end box "div" tag.

documentation.config['display-strange-usage-category'] (member • boolean)

Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage or a /testcases subpage. This should be a boolean value (either true or false).

documentation.config['strange-usage-category'] (member • string)

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.

documentation.config['nodoc-category-{template,module,file,other}'] (member • string)

Category to output if the /doc subpage is missing and the 'content' parameter is not specified

documentation.config['baddoc-category-{template,module,file,other}'] (member • string)

Category to output if the documentation is marked as bad