Module:Documentation/config: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content deleted Content added
add css configuration, so that it can be removed from common.css - see Special:Permalink/906970618#Moving CSS |
m 3 revisions imported from loginwiki:Module:Documentation/config |
||
(45 intermediate revisions by 27 users 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'] = '[[ |
cfg['sandbox-notice-image'] = '[[File:Sandbox.svg|50px|alt=|link=]]' |
||
--[[ |
--[[ |
||
Line 135: | 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 [[ |
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Help:Transclusion|transcluded]] from $1.' |
||
--[[ |
--[[ |
||
Line 279: | 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'] = ' |
cfg['add-categories-blurb'] = 'Add categories to the $1 subpage.' |
||
-- cfg['doc-link-display'] |
-- cfg['doc-link-display'] |
||
Line 324: | 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 334: | ||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- |
-- HTML and CSS configuration |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg[' |
-- cfg['templatestyles'] |
||
-- The name of the |
-- The name of the TemplateStyles page where CSS is kept. |
||
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed. |
|||
cfg['print-subpage'] = 'Print' |
|||
cfg['templatestyles'] = 'Module:Documentation/styles.css' |
|||
-- cfg[' |
-- cfg['container'] |
||
-- 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[' |
-- 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']. |
|||
⚫ | |||
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[' |
-- cfg['main-div-heading-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[' |
-- cfg['start-box-class'] |
||
-- Class for the start box |
|||
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists. |
|||
cfg[' |
cfg['start-box-class'] = 'documentation-startbox' |
||
⚫ | |||
---------------------------------------------------------------------------------------------------- |
|||
⚫ | |||
-- HTML and CSS configuration |
|||
-- mw-editsection-like is per [[Wikipedia:Village pump (technical)/Archive 117]] |
|||
---------------------------------------------------------------------------------------------------- |
|||
⚫ | |||
-- cfg[' |
-- cfg['end-box-class'] |
||
-- |
-- Class for the end box. |
||
cfg[' |
cfg['end-box-class'] = 'documentation-metadata' |
||
-- cfg[' |
-- cfg['end-box-plainlinks'] |
||
-- Plainlinks |
|||
-- The CSS classes added to the main HTML "div" tag. |
|||
cfg[' |
cfg['end-box-plainlinks'] = 'plainlinks' |
||
-- cfg['main-div-css'] |
|||
⚫ | |||
⚫ | |||
['clear'] = 'both', |
|||
['margin'] = '1em 0 0 0', |
|||
['border'] = '1px solid #a2a9b1', |
|||
['background-color'] = '#ecfcf4', |
|||
['padding'] = '1em', |
|||
} |
|||
-- cfg['start-box-linkclasses'] |
|||
⚫ | |||
⚫ | |||
⚫ | |||
-- The HTML "id" attribute for the links in the start box. |
|||
cfg['start-box-link-id'] = 'doc_editlinks' |
|||
---------------------------------------------------------------------------------------------------- |
|||
-- {{fmbox}} template configuration |
|||
---------------------------------------------------------------------------------------------------- |
|||
-- cfg[' |
-- cfg['toolbar-class'] |
||
-- Class added for toolbar links. |
|||
-- The id sent to the "id" parameter of the {{fmbox}} template. |
|||
cfg[' |
cfg['toolbar-class'] = 'documentation-toolbar' |
||
-- cfg[' |
-- cfg['clear'] |
||
-- Just used to clear things. |
|||
-- The value sent to the style parameter of {{fmbox}}. |
|||
cfg[' |
cfg['clear'] = 'documentation-clear' |
||
-- cfg['fmbox-textstyle'] |
|||
-- The value sent to the "textstyle parameter of {{fmbox}}. |
|||
cfg['fmbox-textstyle'] = 'font-style: italic' |
|||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |