Module:Documentation/config: Difference between revisions

    m>Mr. Stradivarius
    (add cfg.titleArgError)
    m>Mr. Stradivarius
    (split experimentBlurb into two separate messages so that we can avoid guessing whether languages have possessive forms or not)
    Line 152: Line 152:
    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------


    -- cfg.experimentBlurb
    -- cfg.experimentBlurbTemplate
    -- This is the text inviting editors to experiment in sandbox and test cases pages. It is only
    -- cfg.experimentBlurbModule
    -- shown in the template and module namespaces. With the default English settings, it might look
    -- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages.
    -- like this:
    -- It is only shown in the template and module namespaces. With the default English settings, it
    -- might look like this:
    --
    --
    -- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
    -- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
    --
    --
    -- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
    -- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
    --
    -- There are two versions, cfg.experimentBlurbTemplate and cfg.experimentBlurbModule, depending
    -- on what namespace we are in.
    --  
    --  
    -- Parameters:
    -- Parameters:
    --
    --
    -- $1 is the possessive name for "module" or "template", set by cfg.templatePossessive or
    -- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:
    -- cfg.modulePossessive depending on what namespace we are in.
    --
    -- $2 is a link to the sandbox page. If the sandbox exists, it is in the following format:
    --
    --
    --    cfg.sandboxLinkDisplay (cfg.sandboxEditLinkDisplay | cfg.compareLinkDisplay)
    --    cfg.sandboxLinkDisplay (cfg.sandboxEditLinkDisplay | cfg.compareLinkDisplay)
    Line 178: Line 179:
    -- loads a default edit summary of cfg.mirrorEditSummary.
    -- loads a default edit summary of cfg.mirrorEditSummary.
    --
    --
    -- $3 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.testcasesLinkDisplay (cfg.testcasesEditLinkDisplay)
    --    cfg.testcasesLinkDisplay (cfg.testcasesEditLinkDisplay)
    Line 189: Line 190:
    -- page with cfg.templateTestcasesPreload or cfg.moduleTestcasesPreload, depending on the current
    -- page with cfg.templateTestcasesPreload or cfg.moduleTestcasesPreload, depending on the current
    -- namespace.
    -- namespace.
    cfg.experimentBlurb = 'Editors can experiment in this $1 $2 and $3 pages.'
    cfg.experimentBlurbTemplate = "Editors can experiment in this template's $1 and $2 pages."
     
    cfg.experimentBlurbModule = "Editors can experiment in this module's $1 and $2 pages."
    -- cfg.templatePossessive
    -- Possessive case for "template".
    cfg.templatePossessive = "template's"
     
    -- cfg.modulePossessive
    -- Possessive case for "module".
    cfg.modulePossessive = "module's"


    ----------------------------------------------------------------------------------------------------
    ----------------------------------------------------------------------------------------------------