TestWiki

Module:Documentation/config: Difference between revisions

Module Discussion

Module:Documentation/config (view source)

Revision as of 15:41, 29 November 2023

138 bytes added ,  6 months ago
m
1 revision imported
m (1 revision imported)
Tags: Mobile edit Mobile web edit Advanced mobile edit
 
(53 intermediate revisions by 39 users not shown)
Line 9:
 
local cfg = {} -- Do not edit this line.
 
cfg['templatestyles-scr'] = 'Module:Documentation/styles.css'
 
----------------------------------------------------------------------------------------------------
-- 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-reason-edit']
Line 24 ⟶ 18:
-- [[Module:Protection banner]].
cfg['protection-reason-edit'] = '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'}
 
--[[
Line 46 ⟶ 32:
-- cfg['sandbox-notice-image']
-- The image displayed in the sandbox notice.
cfg['sandbox-notice-image'] = '[[ImageFile:Edit In Sandbox Icon - Color.svg|40px50px|alt=|link=]]'
 
--[[
Line 95 ⟶ 81:
cfg['sandbox-notice-testcases-run-link-display'] = 'run'
 
-- cfg['sandbox-category'] - A category to add to all template sandboxes.
-- cfg['module-sandbox-category'] - A category to add to all templatemodule sandboxes.
-- cfg['module-sandbox-category'] - A category to add to all sandboxe not in templates or modules.
cfg['sandbox-category'] = 'Template sandboxes'
cfg['module-sandbox-category'] = 'Module sandboxes'
cfg['other-sandbox-category'] = 'Sandboxes outside of template or module namespace'
 
 
----------------------------------------------------------------------------------------------------
Line 105 ⟶ 95:
-- cfg['documentation-icon-wikitext']
-- The wikitext for the icon shown at the top of the template.
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|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'
 
----------------------------------------------------------------------------------------------------
Line 113 ⟶ 139:
-- 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 [[WikipediaHelp:Transclusion|transcluded]] from $1.'
 
--[[
Line 157 ⟶ 183:
-- $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-run-link-display'])
--
-- If the test cases page doesn't exist, it is in the format:
Line 238 ⟶ 264:
-- The text to display for test cases "edit" links.
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']
Line 253 ⟶ 283:
-- link to the /doc subpage with a display value of cfg['doc-link-display'].
--]]
cfg['add-categories-blurb'] = 'Please addAdd categories to the $1 subpage.'
 
-- cfg['doc-link-display']
Line 298 ⟶ 328:
-- 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']
Line 312 ⟶ 338:
 
----------------------------------------------------------------------------------------------------
-- PrintHTML versionand CSS configuration
----------------------------------------------------------------------------------------------------
 
-- cfg['print-subpagetemplatestyles']
-- The name of the templateTemplateStyles subpagepage usedwhere forCSS printis versionskept.
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed.
cfg['print-subpage'] = 'Print'
cfg['templatestyles'] = 'Module:Documentation/styles.css'
 
-- cfg['print-link-displaycontainer']
-- Class which can be used to set flex or grid CSS on the
-- The text to display when linking to the /Print subpage.
-- two child divs documentation and documentation-metadata
cfg['print-link-display'] = '/Print'
cfg['container'] = 'documentation-container'
 
-- cfg['printmain-blurbdiv-classes']
-- Classes added to the main HTML "div" tag.
-- 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['main-div-classes'] = 'documentation'
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['displaymain-printdiv-categoryheading-class']
-- Class for the main heading for templates and modules and assoc. talk spaces
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
cfg['main-div-heading-class'] = 'documentation-heading'
-- This should be a boolean value (either true or false).
cfg['display-print-category'] = true
 
-- cfg['printstart-categorybox-class']
-- Class for the start box
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
cfg['printstart-categorybox-class'] = 'Templates with print versionsdocumentation-startbox'
 
-- cfg['start-box-link-classes']
----------------------------------------------------------------------------------------------------
-- Classes used for the [view][edit][history] or [create] links in the start box.
-- HTML and CSS configuration
-- mw-editsection-like is per [[Wikipedia:Village pump (technical)/Archive 117]]
----------------------------------------------------------------------------------------------------
cfg['start-box-link-classes'] = 'mw-editsection-like plainlinks'
 
-- cfg['mainend-divbox-idclass']
-- TheClass "id" attribute offor the main HTML "div"end tagbox.
cfg['mainend-divbox-idclass'] = 'template-documentation-metadata'
 
-- cfg['mainend-divbox-classesplainlinks']
-- Plainlinks
-- The CSS classes added to the main HTML "div" tag.
cfg['mainend-divbox-classplainlinks'] = 'ts-doc-docplainlinks'
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['sandboxtoolbar-class'] = 'ts-doc-sandbox'
-- Class added for toolbar links.
cfg['toolbar-class'] = 'documentation-toolbar'
 
-- cfg['start-box-linkclassesclear']
-- Just used to clear things.
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
cfg['clear'] = 'documentation-clear'
cfg['start-box-linkclasses'] = 'ts-tlinks-tlinks 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'
 
----------------------------------------------------------------------------------------------------
Retrieved from "https://publictestwiki.com/wiki/Special:MobileDiff/26557...54149"