Module:Documentation/config: Difference between revisions
Content added Content deleted
(remove unused messages) |
(remove more unused argument messages) |
||
Line 25: | Line 25: | ||
-- Environment configuration |
-- Environment configuration |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg.titleArg |
|||
-- An argument to specify what page to make links for. For testing purposes. |
|||
cfg.titleArg = 'page' |
|||
-- cfg.titleArgError |
-- cfg.titleArgError |
||
-- The error message to display if the |
-- The error message to display if the "page" argument does not result in a |
||
-- valid title. |
-- valid title. |
||
cfg.titleArgError = '$1 is not a valid title' |
cfg.titleArgError = '$1 is not a valid title' |
||
Line 61: | Line 57: | ||
-- cfg.sandboxNoticeLivepageParam |
-- cfg.sandboxNoticeLivepageParam |
||
-- The parameter of the sandbox notice template to send the |
-- The parameter of the sandbox notice template to send the "livepage" argument to. |
||
cfg.sandboxNoticeLivepageParam = 1 |
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' |
|||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 77: | Line 67: | ||
-- 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.documentationIconWikitext = '[[File:Template-info.png|50px|link=|alt=Documentation icon]]' |
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 |
-- cfg.templateNamespaceHeading |
||
Line 121: | Line 103: | ||
-- The text to display for "create" links. |
-- The text to display for "create" links. |
||
cfg.createLinkDisplay = 'create' |
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 |
-- Link box (end box) configuration |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- 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 |
-- cfg.transcludedFromBlurb |