Editing Documentation/config
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 9: | Line 9: | ||
local cfg = {} -- Do not edit this line. | local cfg = {} -- Do not edit this line. | ||
| + | |||
| + | ---------------------------------------------------------------------------------------------------- | ||
| + | -- Environment configuration | ||
| + | ---------------------------------------------------------------------------------------------------- | ||
| + | |||
| + | -- cfg.titleArg | ||
| + | -- An argument to specify what page to make links for. For testing purposes. | ||
| + | cfg.titleArg = 'page' | ||
| + | |||
| + | -- cfg.titleArgError | ||
| + | -- The error message to display if the value of the cfg.titleArg argument does not result in a | ||
| + | -- valid title. | ||
| + | cfg.titleArgError = '$1 is not a valid title' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 14: | Line 27: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | -- cfg | + | -- cfg.protectionTemplate |
| − | -- The protection | + | -- The name of the template that displays the protection icon (a padlock on enwiki). |
| − | -- | + | cfg.protectionTemplate = 'pp-template' |
| − | + | ||
| + | -- cfg.protectionTemplateArgs | ||
| + | -- Any arguments to send to the protection template. | ||
| + | cfg.protectionTemplateArgs = {docusage = 'yes'} | ||
| − | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | -- Sandbox | + | -- Sandbox template configuration |
-- | -- | ||
-- On sandbox pages the module can display a template notifying users that the current page is a | -- On sandbox pages the module can display a template notifying users that the current page is a | ||
-- sandbox, and the location of test cases pages, etc. The module decides whether the page is a | -- sandbox, and the location of test cases pages, etc. The module decides whether the page is a | ||
| − | -- sandbox or not based on the value of cfg | + | -- sandbox or not based on the value of cfg.sandboxSubpage. The following settings configure which |
| − | -- | + | -- template is displayed and what the arguments passed to it are. |
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | -- cfg.sandboxNoticeTemplate | |
| − | -- cfg | + | -- The name of the template to display at the top of sandbox pages. |
| − | + | cfg.sandboxNoticeTemplate = 'template sandbox notice' | |
| − | |||
| − | |||
| − | -- of the | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | cfg | ||
| − | |||
| − | |||
| − | + | -- cfg.sandboxNoticeLivepageParam | |
| − | + | -- The parameter of the sandbox notice template to send the cfg.livepageArg to. | |
| − | + | cfg.sandboxNoticeLivepageParam = 1 | |
| − | |||
| − | |||
| − | -- cfg | ||
| − | |||
| − | -- | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | cfg | ||
| − | |||
| − | |||
| − | |||
| − | -- cfg | + | -- cfg.livepageArg |
| − | -- | + | -- The name of one of the module arguments. The value of this argument should be the main template |
| − | cfg | + | -- page (i.e. the "live" template). This is passed to the parameter cfg.sandboxNoticeLivepageParam of |
| + | -- the template cfg.sandboxNoticeTemplate. | ||
| + | cfg.livepageArg = 'livepage' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 89: | Line 62: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | -- cfg | + | -- cfg.documentationIconWikitext |
-- 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 | + | cfg.documentationIconWikitext = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]' |
| − | -- cfg | + | -- cfg.headingArg |
| + | -- Custom heading used in the start box. | ||
| + | cfg.headingArg = 'heading' | ||
| + | |||
| + | -- cfg.headingStyleArg | ||
| + | -- Custom CSS style for the start box heading. | ||
| + | cfg.headingStyleArg = 'heading-style' | ||
| + | |||
| + | -- cfg.templateNamespaceHeading | ||
-- The heading shown in the template namespace. | -- The heading shown in the template namespace. | ||
| − | cfg | + | cfg.templateNamespaceHeading = 'Template documentation' |
| − | -- cfg | + | -- cfg.moduleNamespaceHeading |
-- The heading shown in the module namespace. | -- The heading shown in the module namespace. | ||
| − | cfg | + | cfg.moduleNamespaceHeading = 'Module documentation' |
| − | -- cfg | + | -- cfg.fileNamespaceHeading |
-- The heading shown in the file namespace. | -- The heading shown in the file namespace. | ||
| − | cfg | + | cfg.fileNamespaceHeading = 'Summary' |
| − | -- cfg | + | -- cfg.otherNamespacesHeading |
-- The heading shown in other namespaces. | -- The heading shown in other namespaces. | ||
| − | cfg | + | cfg.otherNamespacesHeading = 'Documentation' |
| − | -- cfg | + | -- cfg.viewLinkDisplay |
-- The text to display for "view" links. | -- The text to display for "view" links. | ||
| − | cfg | + | cfg.viewLinkDisplay = 'view' |
| − | -- cfg | + | -- cfg.editLinkDisplay |
-- The text to display for "edit" links. | -- The text to display for "edit" links. | ||
| − | cfg | + | cfg.editLinkDisplay = 'edit' |
| − | -- cfg | + | -- cfg.historyLinkDisplay |
-- The text to display for "history" links. | -- The text to display for "history" links. | ||
| − | cfg | + | cfg.historyLinkDisplay = 'history' |
| − | -- cfg | + | -- cfg.purgeLinkDisplay |
-- The text to display for "purge" links. | -- The text to display for "purge" links. | ||
| − | cfg | + | cfg.purgeLinkDisplay = 'purge' |
| − | -- cfg | + | -- cfg.createLinkDisplay |
-- The text to display for "create" links. | -- The text to display for "create" links. | ||
| − | cfg | + | cfg.createLinkDisplay = 'create' |
| + | |||
| + | ---------------------------------------------------------------------------------------------------- | ||
| + | -- Preload configuration | ||
| + | ---------------------------------------------------------------------------------------------------- | ||
| + | |||
| + | -- cfg.preloadArg | ||
| + | -- Custom preload page for creating documentation. | ||
| + | cfg.preloadArg = 'preload' | ||
| + | |||
| + | ---------------------------------------------------------------------------------------------------- | ||
| + | -- Documentation content configuration | ||
| + | ---------------------------------------------------------------------------------------------------- | ||
| + | |||
| + | -- cfg.contentArg | ||
| + | -- Passes documentation content directly from the {{documentation}} invocation. | ||
| + | cfg.contentArg = 'content' | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 133: | Line 130: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | -- cfg | + | -- cfg.linkBoxArg |
| + | -- Specifies a custom link box (end box) or prevents it from being generated. | ||
| + | cfg.linkBoxArg = 'link box' | ||
| + | |||
| + | -- cfg.linkBoxOff | ||
| + | -- The value to send to cfg.linkBoxArg to turn the link box off. | ||
| + | cfg.linkBoxOff = 'off' | ||
| + | |||
| + | -- cfg.transcludedFromBlurb | ||
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page. | -- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page. | ||
| − | cfg | + | cfg.transcludedFromBlurb = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.' |
| − | + | -- cfg.createModuleDocBlurb | |
| − | -- cfg | ||
-- Notice displayed in the module namespace when the documentation subpage does not exist. | -- 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 | + | -- $1 is a link to create the documentation page with the preload cfg.modulePreload and the |
| − | -- display cfg | + | -- display cfg.createLinkDisplay. |
| − | + | cfg.createModuleDocBlurb = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].' | |
| − | cfg | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 149: | Line 152: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | + | -- cfg.experimentBlurb | |
| − | -- cfg | + | -- This is the text inviting editors to experiment in sandbox and test cases pages. 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. | ||
| − | |||
| − | |||
| − | |||
-- | -- | ||
-- Parameters: | -- Parameters: | ||
-- | -- | ||
| − | -- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format: | + | -- $1 is the possessive name for "module" or "template", set by cfg.templatePossessive or |
| + | -- 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 | + | -- cfg.sandboxLinkDisplay (cfg.sandboxEditLinkDisplay | cfg.compareLinkDisplay) |
-- | -- | ||
-- If the sandbox doesn't exist, it is in the format: | -- If the sandbox doesn't exist, it is in the format: | ||
-- | -- | ||
| − | -- cfg | + | -- cfg.sandboxLinkDisplay (cfg.sandboxCreateLinkDisplay | cfg.mirrorLinkDisplay) |
-- | -- | ||
| − | -- The link for cfg | + | -- The link for cfg.sandboxCreateLinkDisplay link preloads the page with cfg.templateSandboxPreload |
| − | -- or cfg | + | -- or cfg.moduleSandboxPreload, depending on the current namespace. The link for cfg.mirrorLinkDisplay |
| − | -- loads a default edit summary of cfg | + | -- 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: |
-- | -- | ||
| − | -- cfg | + | -- cfg.testcasesLinkDisplay (cfg.testcasesEditLinkDisplay) |
-- | -- | ||
-- 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: | ||
-- | -- | ||
| − | -- cfg | + | -- cfg.testcasesLinkDisplay (cfg.testcasesCreateLinkDisplay) |
-- | -- | ||
| − | -- If the test cases page doesn't exist, the link for cfg | + | -- If the test cases page doesn't exist, the link for cfg.testcasesCreateLinkDisplay preloads the |
| − | -- page with cfg | + | -- 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 | + | |
| − | cfg | + | -- cfg.templatePossessive |
| + | -- Possessive case for "template". | ||
| + | cfg.templatePossessive = "template's" | ||
| + | |||
| + | -- cfg.modulePossessive | ||
| + | -- Possessive case for "module". | ||
| + | cfg.modulePossessive = "module's" | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 196: | Line 203: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | -- cfg | + | -- cfg.sandboxSubpage |
-- The name of the template subpage typically used for sandboxes. | -- The name of the template subpage typically used for sandboxes. | ||
| − | cfg | + | cfg.sandboxSubpage = 'sandbox' |
| − | -- cfg | + | -- cfg.templateSandboxPreload |
-- Preload file for template sandbox pages. | -- Preload file for template sandbox pages. | ||
| − | cfg | + | cfg.templateSandboxPreload = 'Template:Documentation/preload-sandbox' |
| − | -- cfg | + | -- cfg.moduleSandboxPreload |
-- Preload file for Lua module sandbox pages. | -- Preload file for Lua module sandbox pages. | ||
| − | cfg | + | cfg.moduleSandboxPreload = 'Template:Documentation/preload-module-sandbox' |
| − | -- cfg | + | -- cfg.sandboxLinkDisplay |
-- The text to display for "sandbox" links. | -- The text to display for "sandbox" links. | ||
| − | cfg | + | cfg.sandboxLinkDisplay = 'sandbox' |
| − | -- cfg | + | -- cfg.sandboxEditLinkDisplay |
-- The text to display for sandbox "edit" links. | -- The text to display for sandbox "edit" links. | ||
| − | cfg | + | cfg.sandboxEditLinkDisplay = 'edit' |
| − | -- cfg | + | -- cfg.sandboxCreateLinkDisplay |
-- The text to display for sandbox "create" links. | -- The text to display for sandbox "create" links. | ||
| − | cfg | + | cfg.sandboxCreateLinkDisplay = 'create' |
| − | -- cfg | + | -- cfg.compareLinkDisplay |
-- The text to display for "compare" links. | -- The text to display for "compare" links. | ||
| − | cfg | + | cfg.compareLinkDisplay = 'diff' |
| − | -- cfg | + | -- cfg.mirrorEditSummary |
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the | -- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the | ||
-- template page. | -- template page. | ||
| − | cfg | + | cfg.mirrorEditSummary = 'Create sandbox version of $1' |
| − | -- cfg | + | -- cfg.mirrorLinkDisplay |
-- The text to display for "mirror" links. | -- The text to display for "mirror" links. | ||
| − | cfg | + | cfg.mirrorLinkDisplay = 'mirror' |
| − | |||
| − | |||
| − | |||
| − | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 241: | Line 244: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | -- cfg | + | -- cfg.testcasesSubpage |
-- The name of the template subpage typically used for test cases. | -- The name of the template subpage typically used for test cases. | ||
| − | cfg | + | cfg.testcasesSubpage = 'testcases' |
| − | -- cfg | + | -- cfg.templateTestcasesPreload |
-- Preload file for template test cases pages. | -- Preload file for template test cases pages. | ||
| − | cfg | + | cfg.templateTestcasesPreload = 'Template:Documentation/preload-testcases' |
| − | -- cfg | + | -- cfg.moduleTestcasesPreload |
-- Preload file for Lua module test cases pages. | -- Preload file for Lua module test cases pages. | ||
| − | cfg | + | cfg.moduleTestcasesPreload = 'Template:Documentation/preload-module-testcases' |
| − | -- cfg | + | -- cfg.testcasesLinkDisplay |
-- The text to display for "testcases" links. | -- The text to display for "testcases" links. | ||
| − | cfg | + | cfg.testcasesLinkDisplay = 'testcases' |
| − | -- cfg | + | -- cfg.testcasesEditLinkDisplay |
-- The text to display for test cases "edit" links. | -- The text to display for test cases "edit" links. | ||
| − | cfg | + | cfg.testcasesEditLinkDisplay = 'edit' |
| − | |||
| − | |||
| − | |||
| − | |||
| − | -- cfg | + | -- cfg.testcasesCreateLinkDisplay |
-- The text to display for test cases "create" links. | -- The text to display for test cases "create" links. | ||
| − | cfg | + | cfg.testcasesCreateLinkDisplay = 'create' |
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 273: | Line 272: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | + | -- cfg.addCategoriesBlurb | |
| − | -- cfg | ||
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or | -- 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 | -- "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 | + | -- link to the /doc subpage with a display value of cfg.docLinkDisplay. |
| − | + | cfg.addCategoriesBlurb = 'Please add categories to the $1 subpage.' | |
| − | cfg | ||
| − | -- cfg | + | -- cfg.docLinkDisplay |
-- The text to display when linking to the /doc subpage. | -- The text to display when linking to the /doc subpage. | ||
| − | cfg | + | cfg.docLinkDisplay = '/doc' |
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 289: | Line 286: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | -- | + | -- cfg.subpagesLinkDisplay |
| − | + | -- 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 th | |
| − | + | -- e template namespace, the module namespace, or another namespace. | |
| − | + | cfg.subpagesLinkDisplay = 'Subpages of this $1' | |
| − | |||
| − | cfg | ||
| − | |||
| − | |||
| − | |||
| − | -- The text to display for the "subpages of this page" link. $1 is cfg | ||
| − | -- cfg | ||
| − | -- | ||
| − | |||
| − | cfg | ||
| − | -- cfg | + | -- cfg.templatePagetype |
-- The pagetype to display for template pages. | -- The pagetype to display for template pages. | ||
| − | cfg | + | cfg.templatePagetype = 'template' |
| − | -- cfg | + | -- cfg.modulePagetype |
-- The pagetype to display for Lua module pages. | -- The pagetype to display for Lua module pages. | ||
| − | cfg | + | cfg.modulePagetype = 'module' |
| − | -- cfg | + | -- cfg.defaultPagetype |
-- The pagetype to display for pages other than templates or Lua modules. | -- The pagetype to display for pages other than templates or Lua modules. | ||
| − | cfg | + | cfg.defaultPagetype = 'page' |
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 321: | Line 308: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | -- cfg | + | -- cfg.docSubpage |
-- The name of the subpage typically used for documentation pages. | -- The name of the subpage typically used for documentation pages. | ||
| − | cfg | + | cfg.docSubpage = 'doc' |
| − | -- cfg | + | -- cfg.fileDocpagePreload |
-- Preload file for documentation page in the file namespace. | -- Preload file for documentation page in the file namespace. | ||
| − | cfg | + | cfg.fileDocpagePreload = 'Template:Documentation/preload-filespace' |
| − | -- cfg | + | -- cfg.docpagePreload |
-- Preload file for template documentation pages in all namespaces. | -- Preload file for template documentation pages in all namespaces. | ||
| − | cfg | + | cfg.docpagePreload = 'Template:Documentation/preload' |
| − | -- cfg | + | -- cfg.modulePreload |
-- Preload file for Lua module documentation pages. | -- Preload file for Lua module documentation pages. | ||
| − | cfg | + | cfg.modulePreload = 'Template:Documentation/preload-module-doc' |
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 341: | Line 328: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | -- cfg | + | -- cfg.printSubpage |
-- The name of the template subpage used for print versions. | -- The name of the template subpage used for print versions. | ||
| − | cfg | + | cfg.printSubpage = 'Print' |
| − | -- cfg | + | -- cfg.printLinkDisplay |
-- The text to display when linking to the /Print subpage. | -- The text to display when linking to the /Print subpage. | ||
| − | cfg | + | cfg.printLinkDisplay = '/Print' |
| − | -- cfg | + | -- cfg.printBlurb |
| − | -- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg | + | -- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg.printLinkDisplay. |
| − | cfg | + | 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.' | .. ' If you make a change to this template, please update the print version as well.' | ||
| − | -- cfg | + | -- cfg.displayPrintCategory |
| − | -- Set to true to enable output of cfg | + | -- Set to true to enable output of cfg.printCategory if a /Print subpage exists. |
| − | + | cfg.displayPrintCategory = true | |
| − | |||
| − | -- cfg | + | -- cfg.printCategory |
| − | -- Category to output if cfg | + | -- Category to output if cfg.displayPrintCategory is set to true, and a /Print subpage exists. |
| − | cfg | + | cfg.printCategory = 'Templates with print versions' |
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 367: | Line 353: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | -- cfg | + | -- cfg.mainDivId |
-- The "id" attribute of the main HTML "div" tag. | -- The "id" attribute of the main HTML "div" tag. | ||
| − | cfg | + | cfg.mainDivId = 'template-documentation' |
| − | -- cfg | + | -- cfg.mainDivClasses |
-- The CSS classes added to the main HTML "div" tag. | -- The CSS classes added to the main HTML "div" tag. | ||
| − | cfg | + | cfg.mainDivClasses = 'template-documentation iezoomfix' |
| − | -- cfg | + | -- cfg.startBoxLinkclasses |
-- The CSS classes used for the [view][edit][history] or [create] links in the start box. | -- The CSS classes used for the [view][edit][history] or [create] links in the start box. | ||
| − | cfg | + | cfg.startBoxLinkclasses = 'mw-editsection plainlinks' |
| − | -- cfg | + | -- cfg.startBoxLinkId |
-- The HTML "id" attribute for the links in the start box. | -- The HTML "id" attribute for the links in the start box. | ||
| − | cfg | + | cfg.startBoxLinkId = 'doc_editlinks' |
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 387: | Line 373: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | -- cfg | + | -- cfg.fmboxIdParam |
| + | -- The name of the "id" parameter of {{fmbox}}. | ||
| + | cfg.fmboxIdParam = 'id' | ||
| + | |||
| + | -- cfg.fmboxId | ||
-- The id sent to the "id" parameter of the {{fmbox}} template. | -- The id sent to the "id" parameter of the {{fmbox}} template. | ||
| − | cfg | + | cfg.fmboxId = 'documentation-meta-data' |
| + | |||
| + | -- cfg.fmboxImageParam | ||
| + | -- The name of the "image" parameter of {{fmbox}}. | ||
| + | cfg.fmboxImageParam = 'image' | ||
| + | |||
| + | -- cfg.fmboxImageNone | ||
| + | -- The value to suppress image output from the "image" parameter of {{fmbox}}. | ||
| + | cfg.fmboxImageNone = 'none' | ||
| + | |||
| + | -- cfg.fmboxStyleParam | ||
| + | -- The name of the "style" parameter of {{fmbox}}. | ||
| + | cfg.fmboxStyleParam = 'style' | ||
| − | -- cfg | + | -- cfg.fmboxStyle |
-- The value sent to the style parameter of {{fmbox}}. | -- The value sent to the style parameter of {{fmbox}}. | ||
| − | cfg | + | cfg.fmboxStyle = 'background-color: #ecfcf4' |
| + | |||
| + | -- cfg.fmboxTextstyleParam | ||
| + | -- The name of the "textstyle" parameter of {{fmbox}}. | ||
| + | cfg.fmboxTextstyleParam = 'textstyle' | ||
| − | -- cfg | + | -- cfg.fmboxTextstyle |
-- The value sent to the "textstyle parameter of {{fmbox}}. | -- The value sent to the "textstyle parameter of {{fmbox}}. | ||
| − | cfg | + | cfg.fmboxTextstyle = 'font-style: italic' |
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| Line 403: | Line 409: | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | -- cfg | + | -- cfg.displayStrangeUsageCategory |
| − | -- Set to true to enable output of cfg | + | -- Set to true to enable output of cfg.strangeUsageCategory if the module is used on a /doc subpage |
| − | -- or a /testcases subpage | + | -- or a /testcases subpage. |
| − | cfg | + | cfg.displayStrangeUsageCategory = true |
| − | -- cfg | + | -- cfg.strangeUsageCategory |
| − | -- Category to output if cfg | + | -- Category to output if cfg.displayStrangeUsageCategory is set to true and the module is used on a |
-- /doc subpage or a /testcases subpage. | -- /doc subpage or a /testcases subpage. | ||
| − | cfg | + | cfg.strangeUsageCategory = 'Wikipedia pages with strange ((documentation)) usage' |
| + | |||
| + | -- cfg.strangeUsageCategoryMainspaceSort | ||
| + | -- Category sort key prefix to use for cfg.strangeUsageCategory in the main namespace. The prefix | ||
| + | -- is followed by the full page name. | ||
| + | cfg.strangeUsageCategoryMainspaceSort = 'Main:' | ||
| − | |||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
-- End configuration | -- End configuration | ||
| Line 419: | Line 429: | ||
-- Don't edit anything below this line. | -- Don't edit anything below this line. | ||
---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ||
| − | |||
return cfg | return cfg | ||