Module:Documentation/config: Difference between revisions

-- cfg.documentationIconWikitext

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

 

 

cfg.headingStyleArg = 'heading-style'

-- 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.preloadArg = 'preload'

 

 

cfg.contentArg = 'content'

-- cfg.linkBoxArg

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

 

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

cfg.linkBoxOff = 'off'

 

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

-- 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:

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

-- $3 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.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.experimentBlurb = 'Editors can experiment in this $1 $2 and $3 pages.'

 

-- Possessive case for "template".

cfg.templatePossessive = "template's"

 

-- Possessive case for "module".

cfg.modulePossessive = "module's"

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

-- Preload file for documentation page in the file namespace.

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

 

cfg.docpagePreload = 'Template:Documentation/preload'

-- cfg.modulePreload

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

 

 

 

 

 

 

cfg.printCategory = 'Templates with print versions'

-- cfg.mainDivId

-- The "id" attribute of the main HTML "div" tag.

 

-- cfg.mainDivClasses

-- The CSS classes added to the main HTML "div" tag.

cfg.mainDivClasses = 'template-documentation iezoomfix'

 

-- The CSS classes used for the [view][edit][history] or [create] links in the start box.

cfg.startBoxLinkclasses = 'mw-editsection plainlinks'

-- cfg.startBoxLinkId

-- The HTML "id" attribute for the links in the start box.

cfg.startBoxLinkId = 'doc_editlinks'

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

-- {{fmbox}} template configuration

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

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

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

-- The value sent to the style parameter of {{fmbox}}.

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

-- cfg.fmboxTextstyleParam

-- The name of the "textstyle" parameter of {{fmbox}}.

cfg.fmboxTextstyleParam = 'textstyle'

-- cfg.displayStrangeUsageCategory

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

-- or a /testcases 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 = 'Main:'