Difference between revisions of "Module:Documentation/config"

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

-- Configuration for Module:Documentation

-- Here you can set the values of the parameters and messages used in

-- Module:Documentation to localise it to your wiki and your language.

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

-- Argument names

-- The following are all names of arguments that affect the behaviour of {{documentation}}.

-- The comments next to the configuration values are the effects that the argument has

-- on the module. (Not the effects of the argument names themselves.)

cfg.livepageArg = 'livepage' -- Name of the live template; used in {{template sandbox notice}}.

cfg.headingArg = 'heading' -- Custom heading used in the start box.

cfg.preloadArg = 9 -- Custom preload page for creating documentation.

cfg.headingStyleArg = 'heading-style' -- Custom CSS style for the start box heading.

cfg.contentArg = 'content' -- Passes documentation content directly from the {{documentation}} invocation.

cfg.linkBoxArg = 'link box' -- Specifies a custom link box (end box) or prevents it from being generated.

-- Argument values

-- The following are argument values that are checked by the module.

cfg.linkBoxOff = 'off' -- The value to send to cfg.linkBoxArg to turn the link box off.

-- Software settings

-- The following are software settings that may change from wiki to wiki. For example, the classes

-- defined in commons.css or the names of templates.

cfg.docSubpage = 'doc' -- The name of the subpage typically used for documentation pages.

cfg.sandboxSubpage = 'sandbox' -- The name of the template subpage typically used for sandboxes.

cfg.testcasesSubpage = 'testcases' -- The name of the template subpage typically used for test cases.

cfg.mainDivClasses = 'template-documentation iezoomfix' -- The CSS classes added to the main HTML "div" tag.

cfg.sandboxNoticeTemplate = 'template sandbox notice' -- The name of the template to display at the top of sandbox pages.

cfg.startBoxLinkclasses = 'mw-editsection plainlinks' -- The CSS classes used for the [view][edit][history] or [create] links in the start box.

cfg.startBoxLinkId = 'doc_editlinks' -- The HTML "id" attribute for the links in the start box.

cfg.fileDocpagePreload = 'Template:Documentation/preload-filespace' -- Preload file for documentation page in the file namespace.

cfg.docpagePreload = 'Template:Documentation/preload-filespace' -- Preload file for template documentation pages in all namespaces.

cfg.modulePreload = 'Template:Documentation/preload-module-doc' -- Preload file for Lua module documentation pages.

-- Settings for the {{fmbox}} template.

cfg.fmboxIdParam = 'id' -- The name of the "id" parameter of {{fmbox}}.

cfg.fmboxId = 'documentation-meta-data' -- The id sent to the "id" parameter of the {{fmbox}} template.

cfg.fmboxImageNone = 'none' -- The value to suppress image output from the "image" parameter of {{fmbox}}.

cfg.fmboxStyleParam = 'style' -- The name of the "style" parameter of {{fmbox}}.

cfg.fmboxStyle = 'background-color: #ecfcf4' -- The value sent to the style parameter of {{fmbox}}.

cfg.fmboxTextstyleParam = 'textstyle' -- The name of the "textstyle" parameter of {{fmbox}}.

cfg.fmboxTextstyle = 'font-style: italic' -- The value sent to the "textstyle parameter of {{fmbox}}.

-- Display settings

-- The following settings configure the values displayed by the module.

-- Text displayed in wikilinks.

cfg.viewLinkDisplay = 'view' -- The text to display for "view" links.

cfg.editLinkDisplay = 'edit' -- The text to display for "edit" links.

cfg.historyLinkDisplay = 'history' -- The text to display for "history" links.

cfg.purgeLinkDisplay = 'purge' -- The text to display for "purge" links.

cfg.createLinkDisplay = 'create' -- The text to display for "create" links.

cfg.sandboxLinkDisplay = 'sandbox' -- The text to display for "sandbox" links.

cfg.sandboxEditLinkDisplay = 'edit' -- The text to display for sandbox "edit" links.

cfg.sandboxCreateLinkDisplay = 'create' -- The text to display for sandbox "create" links.

cfg.compareLinkDisplay = 'diff' -- The text to display for "compare" links.

cfg.mirrorLinkDisplay = 'mirror' -- The text to display for "mirror" links.

cfg.testcasesLinkDisplay = 'testcases' -- The text to display for "testcases" links.

cfg.testcasesEditLinkDisplay = 'edit' -- The text to display for test cases "edit" links.

cfg.testcasesCreateLinkDisplay = 'create' -- The text to display for test cases "create" links.

cfg.docLinkDisplay = '/' .. cfg.docSubpage -- The text to display when linking to the /doc subpage.

cfg.subpagesLinkDisplay = 'Subpages of this $1' -- The text to display for the "subpages of this page" link. $1 is cfg.templatePagetype, cfg.modulePagetype or cfg.defaultPagetype, depending on whether the current page is in the template namespace, the module namespace, or another namespace.

cfg.printLinkDisplay = '/' .. cfg.printSubpage -- The text to display when linking to the /doc subpage.

-- Sentences used in the end box.

cfg.transcludedFromBlurb = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.' -- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.

cfg.createModuleDocBlurb = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].' -- Notice displayed in the module namespace when the documentation subpage does not exist. $1 is a link to create the documentation page with the preload cfg.modulePreload and the display cfg.createLinkDisplay.

cfg.templatePossessive = "template's" -- Possessive case for "template".

cfg.mirrorEditSummary = 'Create sandbox version of $1' -- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the template page.

cfg.experimentBlurb = 'Editors can experiment in this $1 $2 and $3 pages.' -- Text inviting editors to experiment in sandbox and test cases pages. It is only shown in the template and module namespaces. $1 is cfg.templatePossessive or cfg.modulePossessive depending on what namespace we are in. $2 is a link to the sandbox in the format "cfg.sandboxLinkDisplay (cfg.sandboxEditLinkDisplay | cfg.compareLinkDisplay)" if the sandbox exists, and the format "cfg.sandboxLinkDisplay (cfg.sandboxCreateLinkDisplay | cfg.mirrorLinkDisplay)" if the sandbox doesn't exist. If the sandbox link doesn't exist, the create link preloads the page with cfg.templateSandboxPreload or cfg.moduleSandboxPreload depending on the current namespace. If the page doesn't exist, the mirror link uses the edit summar cfg.mirrorEditSummary. $3 is a link to the test cases page in the format "cfg.testcasesLinkDisplay (cfg.testcasesEditLinkDisplay)" if the test cases page exists, and in the format "cfg.testcasesLinkDisplay (cfg.testcasesCreateLinkDisplay)" if the test cases page doesn't exist. If the test cases page doesn't exist, the create link preloads the page with cfg.templateTestcasesPreload or cfg.moduleTestcasesPreload depending on the current namespace.

cfg.addCategoriesBlurb = 'Please add categories to the $1 subpage.' -- Text to direct users to add categories to the /doc subpage. Not used if the "content" or "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a link to the /doc subpage with a display value of cfg.docLinkDisplay.

cfg.printBlurb = '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.' -- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg.printLinkDisplay.

-- Other display settings

cfg.documentationIconWikitext = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]' -- The wikitext for the icon shown at the top of the template.

cfg.templateNamespaceHeading = 'Template documentation' -- The heading shown in the template namespace.

cfg.moduleNamespaceHeading = 'Module documentation' -- The heading shown in the module namespace.

cfg.fileNamespaceHeading = 'Summary' -- The heading shown in the file namespace.

cfg.templatePagetype = 'template' -- The pagetype to display for template pages.

cfg.modulePagetype = 'module' -- The pagetype to display for Lua module pages.

cfg.defaultPagetype = 'page' -- The pagetype to display for pages other than templates or Lua modules.

-- Category settings

cfg.displayPrintCategory = true -- Set to true to enable output of cfg.printCategory if a /Print subpage exists.

cfg.printCategory = 'Templates with print versions' -- Category to output if cfg.displayPrintCategory is set to true, and a /Print subpage exists.

cfg.displayStrangeUsageCategory = true -- Set to true to enable output of cfg.strangeUsageCategory if the module is used on a /doc subpage or a /testcases subpage.

cfg.strangeUsageCategory = 'Wikipedia pages with strange ((documentation)) usage' -- Category to output if cfg.displayStrangeUsageCategory is set to true and the module is used on a /doc subpage or a /testcases subpage.

cfg.strangeUsageCategoryMainspaceSort = 'Main:' -- Category sort key prefix to use for cfg.strangeUsageCategory in the main namespace. The prefix is followed by the full page name.