Module:Documentation/config: Difference between revisions

-- cfg.errorPrefix

cfg.errorPrefix = '[[Module:Documentation]] error:'

-- cfg.errorCategory

cfg.errorCategory = 'Documentation template invocations with errors'

-- cfg.titleArgError

cfg.titleArgError = '$1 is not a valid title'

-- cfg.protectionTemplate

cfg.protectionTemplate = 'pp-template'

-- cfg.protectionTemplateArgs

cfg.protectionTemplateArgs = {docusage = 'yes'}

-- sandbox or not based on the value of cfg.sandboxSubpage. The following settings configure the

-- cfg.sandboxNoticeImage

cfg.sandboxNoticeImage = '[[Image:Sandbox.png|50px|alt=|link=]]'

-- cfg.sandboxNoticeBlurb

cfg.sandboxNoticeBlurb = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.'

-- cfg.sandboxNoticeDiffBlurb

-- cfg.sandboxNoticeDiffDisplay

-- cfg.sandboxNoticeDiffBlurb is the opening sentence of the sandbox notice, with a diff link. $1 is a link  

-- display value of the diff link is set by cfg.sandboxNoticeCompareLinkDisplay.

cfg.sandboxNoticeDiffBlurb = 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).'

cfg.sandboxNoticeCompareLinkDisplay = 'diff'

-- cfg.sandboxNoticeTestcasesBlurb

-- cfg.sandboxNoticeTestcasesLinkDisplay

-- cfg.sandboxNoticeTestcasesBlurb is a sentence notifying the user that there is a test cases page

-- cfg.sandboxNoticeTestcasesLinkDisplay is the display value for that link.

cfg.sandboxNoticeTestcasesBlurb = 'See also the companion subpage for $1.'

cfg.sandboxNoticeTestcasesLinkDisplay = 'test cases'

-- cfg.sandboxCategory

cfg.sandboxCategory = 'Template sandboxes'

-- cfg.documentationIconWikitext

cfg.documentationIconWikitext = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]'

-- cfg.templateNamespaceHeading

cfg.templateNamespaceHeading = 'Template documentation'

-- cfg.moduleNamespaceHeading

cfg.moduleNamespaceHeading = 'Module documentation'

-- cfg.fileNamespaceHeading

cfg.fileNamespaceHeading = 'Summary'

-- cfg.otherNamespacesHeading

cfg.otherNamespacesHeading = 'Documentation'

-- cfg.viewLinkDisplay

cfg.viewLinkDisplay = 'view'

-- cfg.editLinkDisplay

cfg.editLinkDisplay = 'edit'

-- cfg.historyLinkDisplay

cfg.historyLinkDisplay = 'history'

-- cfg.purgeLinkDisplay

cfg.purgeLinkDisplay = 'purge'

-- cfg.createLinkDisplay

cfg.createLinkDisplay = 'create'

-- cfg.transcludedFromBlurb

cfg.transcludedFromBlurb = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'

-- cfg.createModuleDocBlurb

-- $1 is a link to create the documentation page with the preload cfg.modulePreload and the

-- display cfg.createLinkDisplay.

cfg.createModuleDocBlurb = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'

-- cfg.experimentBlurbTemplate

-- cfg.experimentBlurbModule

-- There are two versions, cfg.experimentBlurbTemplate and cfg.experimentBlurbModule, depending

--    cfg.sandboxLinkDisplay (cfg.sandboxEditLinkDisplay | cfg.compareLinkDisplay)

--    cfg.sandboxLinkDisplay (cfg.sandboxCreateLinkDisplay | cfg.mirrorLinkDisplay)

-- The link for cfg.sandboxCreateLinkDisplay link preloads the page with cfg.templateSandboxPreload

-- or cfg.moduleSandboxPreload, depending on the current namespace. The link for cfg.mirrorLinkDisplay

-- loads a default edit summary of cfg.mirrorEditSummary.

--    cfg.testcasesLinkDisplay (cfg.testcasesEditLinkDisplay)

--    cfg.testcasesLinkDisplay (cfg.testcasesCreateLinkDisplay)

-- If the test cases page doesn't exist, the link for cfg.testcasesCreateLinkDisplay preloads the

-- page with cfg.templateTestcasesPreload or cfg.moduleTestcasesPreload, depending on the current

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.sandboxSubpage

cfg.sandboxSubpage = 'sandbox'

-- cfg.templateSandboxPreload

cfg.templateSandboxPreload = 'Template:Documentation/preload-sandbox'

-- cfg.moduleSandboxPreload

cfg.moduleSandboxPreload = 'Template:Documentation/preload-module-sandbox'

-- cfg.sandboxLinkDisplay

cfg.sandboxLinkDisplay = 'sandbox'

-- cfg.sandboxEditLinkDisplay

cfg.sandboxEditLinkDisplay = 'edit'

-- cfg.sandboxCreateLinkDisplay

cfg.sandboxCreateLinkDisplay = 'create'

-- cfg.compareLinkDisplay

cfg.compareLinkDisplay = 'diff'

-- cfg.mirrorEditSummary

cfg.mirrorEditSummary = 'Create sandbox version of $1'

-- cfg.mirrorLinkDisplay

cfg.mirrorLinkDisplay = 'mirror'

-- cfg.testcasesSubpage

cfg.testcasesSubpage = 'testcases'

-- cfg.templateTestcasesPreload

cfg.templateTestcasesPreload = 'Template:Documentation/preload-testcases'

-- cfg.moduleTestcasesPreload

cfg.moduleTestcasesPreload = 'Template:Documentation/preload-module-testcases'

-- cfg.testcasesLinkDisplay

cfg.testcasesLinkDisplay = 'testcases'

-- cfg.testcasesEditLinkDisplay

cfg.testcasesEditLinkDisplay = 'edit'

-- cfg.testcasesCreateLinkDisplay

cfg.testcasesCreateLinkDisplay = 'create'

-- cfg.addCategoriesBlurb

-- link to the /doc subpage with a display value of cfg.docLinkDisplay.

cfg.addCategoriesBlurb = 'Please add categories to the $1 subpage.'

-- cfg.docLinkDisplay

cfg.docLinkDisplay = '/doc'

-- 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.templatePagetype

cfg.templatePagetype = 'template'

-- cfg.modulePagetype

cfg.modulePagetype = 'module'

-- cfg.defaultPagetype

cfg.defaultPagetype = 'page'

-- cfg.docSubpage

cfg.docSubpage = 'doc'

-- cfg.fileDocpagePreload

cfg.fileDocpagePreload = 'Template:Documentation/preload-filespace'

-- cfg.docpagePreload

cfg.docpagePreload = 'Template:Documentation/preload'

-- cfg.modulePreload

cfg.modulePreload = 'Template:Documentation/preload-module-doc'

-- cfg.printSubpage

cfg.printSubpage = 'Print'

-- cfg.printLinkDisplay

cfg.printLinkDisplay = '/Print'

-- cfg.printBlurb

-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg.printLinkDisplay.

cfg.printBlurb = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'

-- cfg.displayPrintCategory

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

cfg.displayPrintCategory = true

-- cfg.printCategory

-- Category to output if cfg.displayPrintCategory is set to true, and a /Print subpage exists.

cfg.printCategory = 'Templates with print versions'

-- cfg.mainDivId

cfg.mainDivId = 'template-documentation'

-- cfg.mainDivClasses

cfg.mainDivClasses = 'template-documentation iezoomfix'

-- cfg.startBoxLinkclasses

cfg.startBoxLinkclasses = 'mw-editsection plainlinks'

-- cfg.startBoxLinkId

cfg.startBoxLinkId = 'doc_editlinks'

-- cfg.fmboxId

cfg.fmboxId = 'documentation-meta-data'

-- cfg.fmboxImageNone

cfg.fmboxImageNone = 'none'

-- cfg.fmboxStyle

cfg.fmboxStyle = 'background-color: #ecfcf4'

-- cfg.fmboxTextstyle

cfg.fmboxTextstyle = 'font-style: italic'

-- cfg.displayStrangeUsageCategory

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

cfg.displayStrangeUsageCategory = true

-- cfg.strangeUsageCategory

-- Category to output if cfg.displayStrangeUsageCategory is set to true and the module is used on a

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

cfg.strangeUsageCategoryMainspaceSort = 'Main:'