Module:Documentation/config: Difference between revisions

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

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

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