Module:Documentation/config: Difference between revisions

    From Nonbinary Wiki
    m>Mr. Stradivarius
    (convert messages to use hyphens instead of camelCase, in line with MediaWiki)
     
    (45 intermediate revisions by 25 users not shown)
    Line 9: Line 9:


    local cfg = {} -- Do not edit this line.
    local cfg = {} -- Do not edit this line.
    ----------------------------------------------------------------------------------------------------
    -- Environment configuration
    ----------------------------------------------------------------------------------------------------
    -- cfg['error-prefix']
    -- The prefix before any error messages found by the script.
    cfg['error-prefix'] = '[[Module:Documentation]] error:'
    -- cfg['error-category']
    -- The category pages are placed into if any errors are found.
    cfg['error-category'] = 'Documentation template invocations with errors'
    ----------------------------------------------------------------------------------------------------
    -- Environment configuration
    ----------------------------------------------------------------------------------------------------
    -- cfg['title-arg-error']
    -- The error message to display if the "page" argument does not result in a
    -- valid title.
    cfg['title-arg-error'] = '$1 is not a valid title'


    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------
    Line 35: 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.
    cfg['protection-template-args'] = {docusage = 'yes'}


    --[[
    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------
    -- Sandbox notice configuration
    -- Sandbox notice configuration
    Line 51: Line 28:
    -- messages that the notices contains.
    -- messages that the notices contains.
    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------
    --]]


    -- 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=]]'
     
    --[[
    -- cfg['sandbox-notice-pagetype-template']
    -- cfg['sandbox-notice-pagetype-module']
    -- cfg['sandbox-notice-pagetype-other']
    -- The page type of the sandbox page. The message that is displayed depends on the current subject
    -- namespace. This message is used in either cfg['sandbox-notice-blurb'] or
    -- cfg['sandbox-notice-diff-blurb'].
    --]]
    cfg['sandbox-notice-pagetype-template'] = '[[Wikipedia:Template test cases|template sandbox]] page'
    cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'
    cfg['sandbox-notice-pagetype-other'] = 'sandbox page'


    --[[
    -- cfg['sandbox-notice-blurb']
    -- cfg['sandbox-notice-blurb']
    -- The opening sentence of the sandbox notice. $1 is a link to the main template page.
    cfg['sandbox-notice-blurb'] = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.'
    -- cfg['sandbox-notice-diff-blurb']
    -- cfg['sandbox-notice-diff-blurb']
    -- cfg['sandbox-notice-diff-display']
    -- cfg['sandbox-notice-diff-display']
    -- cfg['sandbox-notice-diff-blurb'] is the opening sentence of the sandbox notice, with a diff link. $1 is a link
    -- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence
    -- to the main template page, and $2 is a diff link between the sandbox and the main template. The
    -- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page
    -- display value of the diff link is set by cfg['sandbox-notice-compare-link-display'].
    -- type, which is either cfg['sandbox-notice-pagetype