Jump to content

Module:Documentation/config: Difference between revisions

Module:Documentation/config (edit)

Revision as of 13:34, 2 February 2014

77 bytes added ,  10 years ago
Created page with "---------------------------------------------------------------------------------------------------- -- -- Configuration for Module:Documentation..."
m>Mr. Stradivarius
(use class mw-editsection-like instead of mw-editsection in order to avoid VisualEditor showing "create" links as "edit source")
(Created page with "---------------------------------------------------------------------------------------------------- -- -- Configuration for Module:Documentation...")
Line 7: Line 7:
-- should be string values.
-- should be string values.
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
local cfg = {} -- Do not edit this line.
local cfg = {} -- Do not edit this line.
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Protection template configuration
-- Protection template configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
-- cfg['protection-template']
-- 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['protection-template'] = 'pp-template'
cfg['protection-template'] = 'pp-template'
 
--[[
--[[
-- cfg['protection-template-args']
-- cfg['protection-template-args']
Line 25: Line 25:
--]]
--]]
cfg['protection-template-args'] = {docusage = 'yes'}
cfg['protection-template-args'] = {docusage = 'yes'}
 
--[[
--[[
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Line 36: Line 36:
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
--]]
--]]
 
-- cfg['sandbox-notice-image']
-- cfg['sandbox-notice-image']
-- The image displayed in the sandbox notice.
-- The image displayed in the sandbox notice.
cfg['sandbox-notice-image'] = '[[Image:Sandbox.png|50px|alt=|link=]]'
cfg['sandbox-notice-image'] = '[[Image:Sandbox.png|50px|alt=|link=]]'
 
--[[
--[[
-- cfg['sandbox-notice-pagetype-template']
-- cfg['sandbox-notice-pagetype-template']
Line 52: Line 52:
cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'
cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'
cfg['sandbox-notice-pagetype-other'] = 'sandbox page'
cfg['sandbox-notice-pagetype-other'] = 'sandbox page'
 
--[[
--[[
-- cfg['sandbox-notice-blurb']
-- cfg['sandbox-notice-blurb']
Line 68: Line 68:
cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'
cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'
cfg['sandbox-notice-compare-link-display'] = 'diff'
cfg['sandbox-notice-compare-link-display'] = 'diff'
 
--[[
--[[
-- cfg['sandbox-notice-testcases-blurb']
-- cfg['sandbox-notice-testcases-blurb']
Line 78: Line 78:
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'
cfg['sandbox-notice-testcases-link-display'] = 'test cases'
cfg['sandbox-notice-testcases-link-display'] = 'test cases'
 
-- cfg['sandbox-category']
-- cfg['sandbox-category']
-- A category to add to all template sandboxes.
-- A category to add to all template sandboxes.
cfg['sandbox-category'] = 'Template sandboxes'
cfg['sandbox-category'] = 'Template sandboxes'
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Start box configuration
-- Start box configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
-- 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.png|50px|link=|alt=Documentation icon]]'
cfg['documentation-icon-wikitext'] = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]'
 
-- cfg['template-namespace-heading']
-- cfg['template-namespace-heading']
-- The heading shown in the template namespace.
-- The heading shown in the template namespace.
cfg['template-namespace-heading'] = 'Template documentation'
cfg['template-namespace-heading'] = 'Template documentation'
 
-- cfg['module-namespace-heading']
-- cfg['module-namespace-heading']
-- The heading shown in the module namespace.
-- The heading shown in the module namespace.
cfg['module-namespace-heading'] = 'Module documentation'
cfg['module-namespace-heading'] = 'Module documentation'
 
-- cfg['file-namespace-heading']
-- cfg['file-namespace-heading']
-- The heading shown in the file namespace.
-- The heading shown in the file namespace.
cfg['file-namespace-heading'] = 'Summary'
cfg['file-namespace-heading'] = 'Summary'
 
-- cfg['other-namespaces-heading']
-- cfg['other-namespaces-heading']
-- The heading shown in other namespaces.
-- The heading shown in other namespaces.
cfg['other-namespaces-heading'] = 'Documentation'
cfg['other-namespaces-heading'] = 'Documentation'
 
-- cfg['view-link-display']
-- cfg['view-link-display']
-- The text to display for "view" links.
-- The text to display for "view" links.
cfg['view-link-display'] = 'view'
cfg['view-link-display'] = 'view'
 
-- cfg['edit-link-display']
-- cfg['edit-link-display']
-- The text to display for "edit" links.
-- The text to display for "edit" links.
cfg['edit-link-display'] = 'edit'
cfg['edit-link-display'] = 'edit'
 
-- cfg['history-link-display']
-- cfg['history-link-display']
-- The text to display for "history" links.
-- The text to display for "history" links.
cfg['history-link-display'] = 'history'
cfg['history-link-display'] = 'history'
 
-- cfg['purge-link-display']
-- cfg['purge-link-display']
-- The text to display for "purge" links.
-- The text to display for "purge" links.
cfg['purge-link-display'] = 'purge'
cfg['purge-link-display'] = 'purge'
 
-- cfg['create-link-display']
-- cfg['create-link-display']
-- The text to display for "create" links.
-- The text to display for "create" links.
cfg['create-link-display'] = 'create'
cfg['create-link-display'] = 'create'
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Link box (end box) configuration
-- Link box (end box) configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
-- 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 [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'
 
--[[
--[[
-- cfg['create-module-doc-blurb']
-- cfg['create-module-doc-blurb']
Line 142: Line 142:
--]]
--]]
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 [[Wikipedia:Lua|Scribunto module]].'
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Experiment blurb configuration
-- Experiment blurb configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
--[[
--[[
-- cfg['experiment-blurb-template']
-- cfg['experiment-blurb-template']
Line 189: Line 189:
cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages."
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."
cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages."
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Sandbox link configuration
-- Sandbox link configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
-- cfg['sandbox-subpage']
-- cfg['sandbox-subpage']
-- The name of the template subpage typically used for sandboxes.
-- The name of the template subpage typically used for sandboxes.
cfg['sandbox-subpage'] = 'sandbox'
cfg['sandbox-subpage'] = 'sandbox'
 
-- cfg['template-sandbox-preload']
-- cfg['template-sandbox-preload']
-- Preload file for template sandbox pages.
-- Preload file for template sandbox pages.
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'
 
-- cfg['module-sandbox-preload']
-- cfg['module-sandbox-preload']
-- Preload file for Lua module sandbox pages.
-- Preload file for Lua module sandbox pages.
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'
 
-- cfg['sandbox-link-display']
-- cfg['sandbox-link-display']
-- The text to display for "sandbox" links.
-- The text to display for "sandbox" links.
cfg['sandbox-link-display'] = 'sandbox'
cfg['sandbox-link-display'] = 'sandbox'
 
-- cfg['sandbox-edit-link-display']
-- cfg['sandbox-edit-link-display']
-- The text to display for sandbox "edit" links.
-- The text to display for sandbox "edit" links.
cfg['sandbox-edit-link-display'] = 'edit'
cfg['sandbox-edit-link-display'] = 'edit'
 
-- cfg['sandbox-create-link-display']
-- cfg['sandbox-create-link-display']
-- The text to display for sandbox "create" links.
-- The text to display for sandbox "create" links.
cfg['sandbox-create-link-display'] = 'create'
cfg['sandbox-create-link-display'] = 'create'
 
-- cfg['compare-link-display']
-- cfg['compare-link-display']
-- The text to display for "compare" links.
-- The text to display for "compare" links.
cfg['compare-link-display'] = 'diff'
cfg['compare-link-display'] = 'diff'
 
-- cfg['mirror-edit-summary']
-- 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['mirror-edit-summary'] = 'Create sandbox version of $1'
cfg['mirror-edit-summary'] = 'Create sandbox version of $1'
 
-- cfg['mirror-link-display']
-- cfg['mirror-link-display']
-- The text to display for "mirror" links.
-- The text to display for "mirror" links.
cfg['mirror-link-display'] = 'mirror'
cfg['mirror-link-display'] = 'mirror'
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Test cases link configuration
-- Test cases link configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
-- cfg['testcases-subpage']
-- 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['testcases-subpage'] = 'testcases'
cfg['testcases-subpage'] = 'testcases'
 
-- cfg['template-testcases-preload']
-- cfg['template-testcases-preload']
-- Preload file for template test cases pages.
-- Preload file for template test cases pages.
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'
 
-- cfg['module-testcases-preload']
-- cfg['module-testcases-preload']
-- Preload file for Lua module test cases pages.
-- Preload file for Lua module test cases pages.
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'
 
-- cfg['testcases-link-display']
-- cfg['testcases-link-display']
-- The text to display for "testcases" links.
-- The text to display for "testcases" links.
cfg['testcases-link-display'] = 'testcases'
cfg['testcases-link-display'] = 'testcases'
 
-- cfg['testcases-edit-link-display']
-- cfg['testcases-edit-link-display']
-- 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-create-link-display']
-- cfg['testcases-create-link-display']
-- The text to display for test cases "create" links.
-- The text to display for test cases "create" links.
cfg['testcases-create-link-display'] = 'create'
cfg['testcases-create-link-display'] = 'create'
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Add categories blurb configuration
-- Add categories blurb configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
--[[
--[[
-- cfg['add-categories-blurb']
-- cfg['add-categories-blurb']
Line 270: Line 270:
--]]
--]]
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.'
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.'
 
-- cfg['doc-link-display']
-- 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['doc-link-display'] = '/doc'
cfg['doc-link-display'] = '/doc'
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Subpages link configuration
-- Subpages link configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
--[[
--[[
-- cfg['subpages-blurb']
-- cfg['subpages-blurb']
Line 286: Line 286:
--]]
--]]
cfg['subpages-blurb'] = '$1.'
cfg['subpages-blurb'] = '$1.'
 
--[[
--[[
-- cfg['subpages-link-display']
-- cfg['subpages-link-display']
Line 294: Line 294:
--]]
--]]
cfg['subpages-link-display'] = 'Subpages of this $1'
cfg['subpages-link-display'] = 'Subpages of this $1'
 
-- cfg['template-pagetype']
-- cfg['template-pagetype']
-- The pagetype to display for template pages.
-- The pagetype to display for template pages.
cfg['template-pagetype'] = 'template'
cfg['template-pagetype'] = 'template'
 
-- cfg['module-pagetype']
-- cfg['module-pagetype']
-- The pagetype to display for Lua module pages.
-- The pagetype to display for Lua module pages.
cfg['module-pagetype'] = 'module'
cfg['module-pagetype'] = 'module'
 
-- cfg['default-pagetype']
-- 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['default-pagetype'] = 'page'
cfg['default-pagetype'] = 'page'
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Doc link configuration
-- Doc link configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
-- cfg['doc-subpage']
-- cfg['doc-subpage']
-- 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']
-- cfg['file-docpage-preload']
-- Preload file for documentation page in the file namespace.
-- Preload file for documentation page in the file namespace.
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'
 
-- cfg['docpage-preload']
-- cfg['docpage-preload']
-- Preload file for template documentation pages in all namespaces.
-- Preload file for template documentation pages in all namespaces.
cfg['docpage-preload'] = 'Template:Documentation/preload'
cfg['docpage-preload'] = 'Template:Documentation/preload'
 
-- cfg['module-preload']
-- cfg['module-preload']
-- Preload file for Lua module documentation pages.
-- Preload file for Lua module documentation pages.
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Print version configuration
-- Print version configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
-- cfg['print-subpage']
-- cfg['print-subpage']
-- The name of the template subpage used for print versions.
-- The name of the template subpage used for print versions.
cfg['print-subpage'] = 'Print'
cfg['print-subpage'] = 'Print'
 
-- cfg['print-link-display']
-- 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['print-link-display'] = '/Print'
cfg['print-link-display'] = '/Print'
 
-- cfg['print-blurb']
-- 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'].
-- 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.'
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['display-print-category']
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
-- 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).
-- This should be a boolean value (either true or false).
cfg['display-print-category'] = true
cfg['display-print-category'] = true
 
-- cfg['print-category']
-- cfg['print-category']
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
cfg['print-category'] = 'Templates with print versions'
cfg['print-category'] = 'Templates with print versions'
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- HTML and CSS configuration
-- HTML and CSS configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
-- cfg['main-div-id']
-- cfg['main-div-id']
-- The "id" attribute of the main HTML "div" tag.
-- The "id" attribute of the main HTML "div" tag.
cfg['main-div-id'] = 'template-documentation'
cfg['main-div-id'] = 'template-documentation'
 
-- cfg['main-div-classes']
-- 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['main-div-classes'] = 'template-documentation iezoomfix'
cfg['main-div-classes'] = 'template-documentation iezoomfix'
 
-- cfg['start-box-linkclasses']
-- cfg['start-box-linkclasses']
-- 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['start-box-linkclasses'] = 'mw-editsection-like plainlinks'
cfg['start-box-linkclasses'] = 'mw-editsection-like plainlinks'
 
-- cfg['start-box-link-id']
-- 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['start-box-link-id'] = 'doc_editlinks'
cfg['start-box-link-id'] = 'doc_editlinks'
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- {{fmbox}} template configuration
-- {{fmbox}} template configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
-- cfg['fmbox-id']
-- 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['fmbox-id'] = 'documentation-meta-data'
cfg['fmbox-id'] = 'documentation-meta-data'
 
-- cfg['fmbox-style']
-- cfg['fmbox-style']
-- The value sent to the style parameter of {{fmbox}}.
-- The value sent to the style parameter of {{fmbox}}.
cfg['fmbox-style'] = 'background-color: #ecfcf4'
cfg['fmbox-style'] = 'background-color: #ecfcf4'
 
-- cfg['fmbox-textstyle']
-- cfg['fmbox-textstyle']
-- The value sent to the "textstyle parameter of {{fmbox}}.
-- The value sent to the "textstyle parameter of {{fmbox}}.
cfg['fmbox-textstyle'] = 'font-style: italic'
cfg['fmbox-textstyle'] = 'font-style: italic'
 
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Tracking category configuration
-- Tracking category configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
 
-- cfg['display-strange-usage-category']
-- 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
-- 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).
-- or a /testcases subpage. This should be a boolean value (either true or false).
cfg['display-strange-usage-category'] = true
cfg['display-strange-usage-category'] = true
 
-- cfg['strange-usage-category']
-- cfg['strange-usage-category']
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a
-- 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['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'
 
--[[
--[[
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Line 410: Line 410:
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
--]]
--]]
 
return cfg
return cfg
Anonymous user
Retrieved from "https://nonbinary.wiki/wiki/Special:MobileDiff/17372"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information