Module:Documentation/config: Difference between revisions

Jump to navigation Jump to search
← Older edit
en>Paine Ellsworth
per edit request at Template talk:Documentation#Update sandbox icon to match all other templates - update sandbox notice image
m Rollback
 
(One intermediate revision by the same user not shown)
Line 32: Line 32:
-- 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'] = '[[File:Edit In Sandbox Icon - Color.svg|50px|alt=|link=]]'
cfg['sandbox-notice-image'] = '[[Image:Sandbox.svg|50px|alt=|link=]]'


--[[
--[[
Line 81: Line 81:
cfg['sandbox-notice-testcases-run-link-display'] = 'run'
cfg['sandbox-notice-testcases-run-link-display'] = 'run'


-- cfg['sandbox-category'] - A category to add to all template sandboxes.
-- cfg['sandbox-category']
-- cfg['module-sandbox-category'] - A category to add to all module sandboxes.
-- A category to add to all template sandboxes.
-- cfg['module-sandbox-category'] - A category to add to all sandboxe not in templates or modules.
cfg['sandbox-category'] = 'Template sandboxes'
cfg['sandbox-category'] = 'Template sandboxes'
cfg['module-sandbox-category'] = 'Module sandboxes'
cfg['other-sandbox-category'] = 'Sandboxes outside of template or module namespace'


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Line 139: Line 135:
-- 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 [[Help:Transclusion|transcluded]] from $1.'
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'


--[[
--[[
Line 283: Line 279:
-- 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'] = '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']
Line 328: Line 324:
-- 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 338: Line 338:


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
-- HTML and CSS configuration
-- Print version configuration
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------


-- cfg['templatestyles']
-- cfg['print-subpage']
-- The name of the TemplateStyles page where CSS is kept.
-- The name of the template subpage used for print versions.
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed.
cfg['print-subpage'] = 'Print'
cfg['templatestyles'] = 'Module:Documentation/styles.css'


-- cfg['container']
-- cfg['print-link-display']
-- 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['main-div-classes']
-- cfg['print-blurb']
-- 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['display-print-category']
-- 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).
cfg['display-print-category'] = true
 
-- cfg['print-category']
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
cfg['print-category'] = 'Templates with print versions'
 
----------------------------------------------------------------------------------------------------
-- HTML and CSS configuration
----------------------------------------------------------------------------------------------------


-- cfg['main-div-heading-class']
-- cfg['main-div-id']
-- Class for the main heading for templates and modules and assoc. talk spaces
-- The "id" attribute of the main HTML "div" tag.
cfg['main-div-heading-class'] = 'documentation-heading'
cfg['main-div-id'] = 'template-documentation'


-- cfg['start-box-class']
-- cfg['main-div-classes']
-- Class for the start box
-- The CSS classes added to the main HTML "div" tag.
cfg['start-box-class'] = 'documentation-startbox'
cfg['main-div-classes'] = 'template-documentation iezoomfix'


-- cfg['start-box-link-classes']
-- cfg['start-box-linkclasses']
-- 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.
-- mw-editsection-like is per [[Wikipedia:Village pump (technical)/Archive 117]]
cfg['start-box-linkclasses'] = 'mw-editsection-like plainlinks'
cfg['start-box-link-classes'] = 'mw-editsection-like plainlinks'


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


-- cfg['end-box-plainlinks']
----------------------------------------------------------------------------------------------------
-- Plainlinks
-- {{fmbox}} template configuration
cfg['end-box-plainlinks'] = 'plainlinks'
----------------------------------------------------------------------------------------------------


-- cfg['toolbar-class']
-- cfg['fmbox-id']
-- Class added for toolbar links.
-- The id sent to the "id" parameter of the {{fmbox}} template.
cfg['toolbar-class'] = 'documentation-toolbar'
cfg['fmbox-id'] = 'documentation-meta-data'


-- cfg['clear']
-- cfg['fmbox-style']
-- Just used to clear things.
-- The value sent to the style parameter of {{fmbox}}.
cfg['clear'] = 'documentation-clear'
cfg['fmbox-style'] = 'background-color: #ecfcf4'


-- cfg['fmbox-textstyle']
-- The value sent to the "textstyle parameter of {{fmbox}}.
cfg['fmbox-textstyle'] = 'font-style: italic'


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Retrieved from "https://tsgdoc.socsci.ru.nl/index.php/Module:Documentation/config"