Module:Documentation/config: Difference between revisions

Jump to navigation Jump to search
← Older edit
MeowyCats2 (talk | contribs)
Bureaucrats, Interface administrators, Stewards, Administrators
38 edits
m 105 revisions imported
 
(45 intermediate revisions by 32 users not shown)
Line 9: Line 9:


local cfg = {} -- Do not edit this line.
local cfg = {} -- Do not edit this line.
cfg['templatestyles-scr'] = 'Module:Documentation/styles.css'


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- Protection template configuration
-- Start box configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------


-- cfg['protection-template']
-- cfg['documentation-icon-wikitext']
-- The name of the template that displays the protection icon (a padlock on enwiki).
-- The wikitext for the icon shown at the top of the template.
cfg['protection-template'] = 'pp-template'
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'


-- cfg['protection-reason-edit']
-- cfg['template-namespace-heading']
-- The protection reason for edit-protected templates to pass to
-- The heading shown in the template namespace.
-- [[Module:Protection banner]].
cfg['template-namespace-heading'] = 'Template documentation'
cfg['protection-reason-edit'] = 'template'


--[[
-- cfg['module-namespace-heading']
-- cfg['protection-template-args']
-- The heading shown in the module namespace.
-- Any arguments to send to the protection template. This should be a Lua table.
cfg['module-namespace-heading'] = 'Module documentation'
-- 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'}


--[[
-- cfg['file-namespace-heading']
----------------------------------------------------------------------------------------------------
-- The heading shown in the file namespace.
-- Sandbox notice configuration
cfg['file-namespace-heading'] = 'Summary'
--
-- 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']
-- cfg['other-namespaces-heading']
-- The image displayed in the sandbox notice.
-- The heading shown in other namespaces.
cfg['sandbox-notice-image'] = '[[Image:Edit In Sandbox Icon - Color.svg|40px|alt=|link=]]'
cfg['other-namespaces-heading'] = 'Documentation'


--[[
-- cfg['view-link-display']
-- cfg['sandbox-notice-pagetype-template']
-- The text to display for "view" links.
-- cfg['sandbox-notice-pagetype-module']
cfg['view-link-display'] = 'view'
-- 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['edit-link-display']
-- cfg['sandbox-notice-testcases-blurb']
-- The text to display for "edit" links.
-- cfg['sandbox-notice-testcases-link-display']
cfg['edit-link-display'] = 'edit'
-- 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']
-- cfg['history-link-display']
-- A category to add to all template sandboxes.
-- The text to display for "history" links.
cfg['sandbox-category'] = 'Template sandboxes'
cfg['history-link-display'] = 'history'


----------------------------------------------------------------------------------------------------
-- cfg['purge-link-display']
-- Start box configuration
-- The text to display for "purge" links.
----------------------------------------------------------------------------------------------------
cfg['purge-link-display'] = 'purge'


-- cfg['documentation-icon-wikitext']
-- cfg['create-link-display']
-- The wikitext for the icon shown at the top of the template.
-- The text to display for "create" links.
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=Documentation icon]]'
cfg['create-link-display'] = 'create'


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Line 113: 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 121: 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 157: 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 238: 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 253: 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 298: 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 312: 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-class'] = 'ts-doc-doc'
cfg['end-box-plainlinks'] = 'plainlinks'
cfg['header-div-class'] = 'ts-doc-header'
cfg['heading-div-class'] = 'ts-doc-heading'
cfg['content-div-class'] = 'ts-doc-content'
cfg['footer-div-class'] = 'ts-doc-footer plainlinks'


cfg['sandbox-class'] = 'ts-doc-sandbox'
-- cfg['toolbar-class']
-- Class added for toolbar links.
cfg['toolbar-class'] = 'documentation-toolbar'


-- cfg['start-box-linkclasses']
-- cfg['clear']
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
-- Just used to clear things.
cfg['start-box-linkclasses'] = 'ts-tlinks-tlinks mw-editsection-like plainlinks'
cfg['clear'] = 'documentation-clear'


-- cfg['start-box-link-id']
-- The HTML "id" attribute for the links in the start box.
cfg['start-box-link-id'] = 'doc_editlinks'


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Retrieved from "https://meta.skywiki.org/wiki/Module:Documentation/config"