Module:Documentation/config: Difference between revisions

Module:Documentation/config (edit)

Revision as of 11:54, 2 January 2014

6,366 bytes added , 12 years ago

make this more readable

@@ Line 1: / Line 1: @@
-----------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
--- Configuration for Module:Documentation
 --
--- Here you can set the values of the parameters and messages used in
+--                               Configuration for Module:Documentation
--- Module:Documentation to localise it to your wiki and your language.
+--
-----------------------------------------------------------------------------
+-- Here you can set the values of the parameters and messages used in Module:Documentation to
+-- localise it to your wiki and your language. Unless specified otherwise, values given here
+-- should be string values.
+----------------------------------------------------------------------------------------------------
+local cfg = {} -- Do not edit this line.
+----------------------------------------------------------------------------------------------------
+-- Protection template configuration
+----------------------------------------------------------------------------------------------------
+-- cfg.protectionTemplate
+-- 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 template configuration
+--
+-- 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 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
+-- The name of the template to display at the top of sandbox pages.
+cfg.sandboxNoticeTemplate = 'template sandbox notice'
+-- cfg.sandboxNoticeLivepageParam
+-- The parameter of the sandbox notice template to send the cfg.livepageArg to.
+cfg.sandboxNoticeLivepageParam = 1
+-- cfg.livepageArg
+-- The name of one of the module arguments. The value of this argument should be the main template
+-- page (i.e. the "live" template). This is passed to the parameter cfg.sandboxNoticeLivepageParam of
+-- the template cfg.sandboxNoticeTemplate.
+cfg.livepageArg = 'livepage'
+----------------------------------------------------------------------------------------------------
+-- Start box configuration
+----------------------------------------------------------------------------------------------------
+-- cfg.documentationIconWikitext
+-- The wikitext for the icon shown at the top of the template.
+cfg.documentationIconWikitext = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]'
+-- 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.
+cfg.templateNamespaceHeading = 'Template documentation'
+-- cfg.moduleNamespaceHeading
+-- The heading shown in the module namespace.
+cfg.moduleNamespaceHeading = 'Module documentation'
+-- cfg.fileNamespaceHeading
+-- The heading shown in the file namespace.
+cfg.fileNamespaceHeading = 'Summary'
+-- cfg.otherNamespacesHeading
+-- The heading shown in other namespaces.
+cfg.otherNamespacesHeading = 'Documentation'
+-- cfg.viewLinkDisplay
+-- The text to display for "view" links.
+cfg.viewLinkDisplay = 'view'
+-- cfg.editLinkDisplay
+-- The text to display for "edit" links.
+cfg.editLinkDisplay = 'edit'
+-- cfg.historyLinkDisplay
+-- The text to display for "history" links.
+cfg.historyLinkDisplay = 'history'
+-- cfg.purgeLinkDisplay
+-- The text to display for "purge" links.
+cfg.purgeLinkDisplay = 'purge'
+-- cfg.createLinkDisplay
+-- The text to display for "create" links.
+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'
+----------------------------------------------------------------------------------------------------
+-- Link box (end box) configuration
+----------------------------------------------------------------------------------------------------
+-- cfg.linkBoxArg
+-- Specifies a custom link box (end box) or prevents it from being generated.
+cfg.linkBoxArg = 'link box'