Module:Documentation/config: Difference between revisions

    From Nonbinary Wiki
    m>Jackmcbarn
    (add a message for running test cases)
     
    (35 intermediate revisions by 24 users not shown)
    Line 14: Line 14:
    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------


    -- cfg['protection-template']
    -- cfg['protection-reason-edit']
    -- The name of the template that displays the protection icon (a padlock on enwiki).
    -- The protection reason for edit-protected templates to pass to
    cfg['protection-template'] = 'pp-template'
    -- [[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 39: 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.png|50px|alt=|link=]]'
    cfg['sandbox-notice-image'] = '[[File:Sandbox.svg|50px|alt=|link=]]'


    --[[
    --[[
    Line 98: 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:Template-info.png|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 186: 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 239: 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 263: 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 349: 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 366: 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']
    --