Module:Documentation/config: Difference between revisions

    From Nonbinary Wiki
    No edit summary
    m>Mr. Stradivarius
    (add a config value for the protection reason to use with Module:Protection banner)
    Line 7: Line 7:
    -- should be string values.
    -- should be string values.
    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------
     
    local cfg = {} -- Do not edit this line.
    local cfg = {} -- Do not edit this line.
     
    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------
    -- Protection template configuration
    -- Protection template configuration
    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------
     
    -- cfg['protection-template']
    -- cfg['protection-template']
    -- The name of the template that displays the protection icon (a padlock on enwiki).
    -- The name of the template that displays the protection icon (a padlock on enwiki).
    cfg['protection-template'] = 'pp-template'
    cfg['protection-template'] = 'pp-template'
     
    -- cfg['protection-reason-edit']
    -- The protection reason for edit-protected templates to pass to
    -- [[Module:Protection banner]].
    cfg['protection-reason-edit'] = 'template'
     
    --[[
    --[[
    -- cfg['protection-template-args']
    -- cfg['protection-template-args']
    Line 25: Line 30:
    --]]
    --]]
    cfg['protection-template-args'] = {docusage = 'yes'}
    cfg['protection-template-args'] = {docusage = 'yes'}
     
    --[[
    --[[
    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------
    Line 36: Line 41:
    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------
    --]]
    --]]
     
    -- 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'] = '[[Image:Sandbox.svg|50px|alt=|link=]]'
     
    --[[
    --[[
    -- cfg['sandbox-notice-pagetype-template']
    -- cfg['sandbox-notice-pagetype-template']
    Line 52: Line 57:
    cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'
    cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'
    cfg['sandbox-notice-pagetype-other'] = 'sandbox page'
    cfg['sandbox-notice-pagetype-other'] = 'sandbox page'
     
    --[[
    --[[
    -- cfg['sandbox-notice-blurb']
    -- cfg['sandbox-notice-blurb']
    Line 68: Line 73:
    cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'
    cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'
    cfg['sandbox-notice-compare-link-display'] = 'diff'
    cfg['sandbox-notice-compare-link-display'] = 'diff'
     
    --[[
    --[[
    -- cfg['sandbox-notice-testcases-blurb']
    -- cfg['sandbox-notice-testcases-blurb']
    Line 87: Line 92:
    cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).'
    cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).'
    cfg['sandbox-notice-testcases-run-link-display'] = 'run'
    cfg['sandbox-notice-testcases-run-link-display'] = 'run'
     
    -- cfg['sandbox-category']
    -- cfg['sandbox-category']
    -- A category to add to all template sandboxes.
    -- A category to add to all template sandboxes.
    cfg['sandbox-category'] = 'Template sandboxes'
    cfg['sandbox-category'] = 'Template sandboxes'
     
    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------
    -- Start box configuration
    -- Start box configuration
    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------
     
    -- 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=Documentation icon]]'
     
    -- cfg['template-namespace-heading']
    -- cfg['template-namespace-heading']
    -- The heading shown in the template namespace.
    -- The heading shown in the template namespace.
    cfg['template-namespace-heading'] = 'Template documentation'
    cfg['template-namespace-heading'] = 'Template documentation'
     
    -- cfg['module-namespace-heading']
    -- cfg['module-namespace-heading']
    -- The heading shown in the module namespace.
    -- The heading shown in the module namespace.
    cfg['module-namespace-heading'] =