Nonbinary Wiki

Module:Documentation/config: Difference between revisions

Module Discussion

Module:Documentation/config (edit)

Revision as of 11:37, 21 May 2021

11 bytes removed ,  3 years ago
m
12 revisions imported from templatewiki:Module:Documentation/config: see Topic:Vtixlm0q28eo6jtf
m>Mr. Stradivarius
(add a config value for the protection reason to use with Module:Protection banner)
 
(30 intermediate revisions by 21 users not shown)
Line 13: Line 13:
-- Protection template configuration
-- 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']
-- cfg['protection-reason-edit']
Line 22: Line 18:
-- [[Module:Protection banner]].
-- [[Module:Protection banner]].
cfg['protection-reason-edit'] = 'template'
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 44: 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'] = '[[Image:Sandbox.svg|50px|alt=|link=]]'
cfg['sandbox-notice-image'] = '[[File:Sandbox.svg|50px|alt=|link=]]'


--[[
--[[
Line 103: Line 91:
-- 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:Test Template Info-Icon - Version (2).svg|50px|link=|alt=Documentation icon]]'
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'


-- cfg['template-namespace-heading']
-- cfg['template-namespace-heading']
Line 191: Line 179:
-- $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 244: Line 232:
-- The text to display for "mirror" links.
-- The text to display for "mirror" links.
cfg['mirror-link-display'] = 'mirror'
cfg['mirror-link-display'] = 'mirror'
-- cfg['mirror-link-preload']
-- The page to preload when a user clicks the "mirror" link.
cfg['mirror-link-preload'] = 'Template:Documentation/mirror'


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Line 268: Line 260:
-- 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 354: Line 350:


-- 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.'
Line 371: Line 368:
----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------


-- cfg['main-div-id']
-- cfg['templatestyles']
-- The "id" attribute of the main HTML "div" tag.
-- The name of the TemplateStyles page where CSS is kept.
cfg['main-div-id'] = 'template-documentation'
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed.
cfg['templatestyles'] = 'Module:Documentation/styles.css'
 
-- cfg['container']
-- Class which can be used to set flex or grid CSS on the
-- two child divs documentation and documentation-metadata
cfg['container'] = 'documentation-container'


-- cfg['main-div-classes']
-- cfg['main-div-classes']
-- The CSS classes added to the main HTML "div" tag.
-- Classes added to the main HTML "div" tag.
cfg['main-div-classes'] = 'template-documentation iezoomfix'
cfg['main-div-classes'] = 'documentation'


-- cfg['start-box-linkclasses']
-- cfg['main-div-heading-class']
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
-- Class for the main heading for templates and modules and assoc. talk spaces
cfg['start-box-linkclasses'] = 'mw-editsection-like plainlinks'
cfg['main-div-heading-class'] = 'documentation-heading'


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


----------------------------------------------------------------------------------------------------
-- cfg['start-box-link-classes']
-- {{fmbox}} template 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['end-box-class']
-- Class for the end box.
cfg['end-box-class'] = 'documentation-metadata'
 
-- cfg['end-box-plainlinks']
-- Plainlinks
cfg['end-box-plainlinks'] = 'plainlinks'


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


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


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


----------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------
Retrieved from "https://nonbinary.wiki/wiki/Special:MobileDiff/17366...17398"