|
|
| (75 intermediate revisions by 53 users not shown) |
| Line 9: |
Line 9: |
|
| |
|
| local cfg = {} -- Do not edit this line. | | local cfg = {} -- Do not edit this line. |
|
| |
| ----------------------------------------------------------------------------------------------------
| |
| -- 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. 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'}
| |
|
| |
| --[[
| |
| ----------------------------------------------------------------------------------------------------
| |
| -- 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.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']
| |
| -- 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 98: |
Line 16: |
| -- cfg['documentation-icon-wikitext'] | | -- cfg['documentation-icon-wikitext'] |
| -- 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['documentation-icon-wikitext'] = '[[File:Template-info.svg|50px|link=|alt=Documentation icon]]' | | cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]' |
|
| |
|
| -- cfg['template-namespace-heading'] | | -- cfg['template-namespace-heading'] |
| Line 142: |
Line 60: |
| -- cfg['transcluded-from-blurb'] | | -- cfg['transcluded-from-blurb'] |
| -- 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['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.' | | cfg['transcluded-from-blurb'] = 'The above [[w:Wikipedia:Template documentation|documentation]] is [[mw:Help:Transclusion|transcluded]] from $1.' |
|
| |
|
| --[[ | | --[[ |
| Line 150: |
Line 68: |
| -- display cfg['create-link-display']. | | -- display cfg['create-link-display']. |
| --]] | | --]] |
| cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].' | | cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[mw:Extension:Scribunto/Lua reference manual|Scribunto module]].' |
|
| |
|
| ---------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------- |
| Line 186: |
Line 104: |
| -- $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['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: | | -- If the test cases page doesn't exist, it is in the format: |
| Line 239: |
Line 157: |
| -- The text to display for "mirror" links. | | -- The text to display for "mirror" links. |
| cfg['mirror-link-display'] = 'mirror' | | 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 263: |
Line 185: |
| -- The text to display for test cases "edit" links. | | -- The text to display for test cases "edit" links. |
| cfg['testcases-edit-link-display'] = 'edit' | | 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' |
|
| |
|
| -- cfg['testcases-create-link-display'] | | -- cfg['testcases-create-link-display'] |
| Line 278: |
Line 204: |
| -- link to the /doc subpage with a display value of cfg['doc-link-display']. | | -- 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['add-categories-blurb'] = 'Add categories to the $1 subpage.' |
|
| |
|
| -- cfg['doc-link-display'] | | -- cfg['doc-link-display'] |
| Line 323: |
Line 249: |
| -- The name of the subpage typically used for documentation pages. | | -- The name of the subpage typically used for documentation pages. |
| cfg['doc-subpage'] = 'doc' | | 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'] | | -- cfg['docpage-preload'] |
| Line 337: |
Line 259: |
|
| |
|
| ---------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------- |
| -- Print version configuration | | -- HTML and CSS configuration |
| ---------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------- |
|
| |
|
| -- cfg['print-subpage'] | | -- cfg['templatestyles'] |
| -- The name of the template subpage used for print versions. | | -- The name of the TemplateStyles page where CSS is kept. |
| cfg['print-subpage'] = 'Print' | | -- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed. |
| | cfg['templatestyles'] = 'Module:Documentation/styles.css' |
|
| |
|
| -- cfg['print-link-display'] | | -- cfg['container'] |
| -- The text to display when linking to the /Print subpage. | | -- Class which can be used to set flex or grid CSS on the |
| cfg['print-link-display'] = '/Print' | | -- two child divs documentation and documentation-metadata |
| | cfg['container'] = 'documentation-container' |
|
| |
|
| -- cfg['print-blurb'] | | -- cfg['main-div-classes'] |
| -- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display']. | | -- Classes added to the main HTML "div" tag. |
| cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.' | | cfg['main-div-classes'] = 'documentation' |
| .. ' If you make a change to this template, please update the print version as well.'
| |
|
| |
|
| -- cfg['display-print-category'] | | -- cfg['main-div-heading-class'] |
| -- Set to true to enable output of cfg['print-category'] if a /Print subpage exists. | | -- Class for the main heading for templates and modules and assoc. talk spaces |
| -- This should be a boolean value (either true or false). | | cfg['main-div-heading-class'] = 'documentation-heading' |
| cfg['display-print-category'] = true | |
|
| |
|
| -- cfg['print-category'] | | -- cfg['start-box-class'] |
| -- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists. | | -- Class for the start box |
| cfg['print-category'] = 'Templates with print versions'
| | cfg['start-box-class'] = 'documentation-startbox' |
|
| |
|
| ---------------------------------------------------------------------------------------------------- | | -- cfg['start-box-link-classes'] |
| -- HTML and CSS configuration | | -- Classes used for the [view][edit][history] or [create] links in the start box. |
| ---------------------------------------------------------------------------------------------------- | | -- mw-editsection-like is per [[Wikipedia:Village pump (technical)/Archive 117]] |
| | cfg['start-box-link-classes'] = 'mw-editsection-like plainlinks' |
|
| |
|
| -- cfg['main-div-id'] | | -- cfg['end-box-class'] |
| -- The "id" attribute of the main HTML "div" tag. | | -- Class for the end box. |
| cfg['main-div-id'] = 'template-documentation' | | cfg['end-box-class'] = 'documentation-metadata' |
|
| |
|
| -- cfg['main-div-classes'] | | -- cfg['end-box-plainlinks'] |
| -- The CSS classes added to the main HTML "div" tag.
| | -- Plainlinks |
| cfg['main-div-classes'] = 'template-documentation iezoomfix'
| | cfg['end-box-plainlinks'] = 'plainlinks' |
| | |
| -- 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-like 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'] | | -- cfg['toolbar-class'] |
| -- The id sent to the "id" parameter of the {{fmbox}} template. | | -- Class added for toolbar links. |
| cfg['fmbox-id'] = 'documentation-meta-data' | | cfg['toolbar-class'] = 'documentation-toolbar' |
|
| |
|
| -- cfg['fmbox-style'] | | -- cfg['clear'] |
| -- The value sent to the style parameter of {{fmbox}}. | | -- Just used to clear things. |
| cfg['fmbox-style'] = 'background-color: #ecfcf4' | | cfg['clear'] = 'documentation-clear' |
|
| |
|
| -- cfg['fmbox-textstyle']
| |
| -- The value sent to the "textstyle parameter of {{fmbox}}.
| |
| cfg['fmbox-textstyle'] = 'font-style: italic'
| |
|
| |
|
| ---------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------- |