Module:Documentation/config: Difference between revisions

    m (1 revision imported)
    m (replace deprecated "Image:" with "File:")
    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'] = '[[Image:Sandbox.svg|50px|alt=|link=]]'
    cfg['sandbox-notice-image'] = '[[File:Sandbox.svg|50px|alt=|link=]]'


    --[[
    --[[
    Line 350: 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 367: 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://develop.consumerium.org/wiki/Module:Documentation/config"