Module:Documentation/config: Difference between revisions

Line 44:

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

-- Sandbox ~~template~~ configuration

-- Sandbox notice 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~~

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

-- ~~template is displayed and what~~ the ~~arguments passed to it are~~.

-- messages that the notices contains.

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

-- cfg.~~sandboxNoticeTemplate~~

-- cfg.sandboxNoticeImage

-- The ~~name of~~ the ~~template to display at the top of~~ sandbox ~~pages~~.

-- The image displayed in the sandbox notice.

cfg.~~sandboxNoticeTemplate~~ = '~~template sandbox notice~~'

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

-- cfg.~~sandboxNoticeLivepageParam~~

-- cfg.sandboxNoticeBlurb

-- The ~~parameter~~ of the sandbox notice template to ~~send~~ the ~~"livepage" argument~~ to.

-- The opening sentence of the sandbox notice. $1 is a link to the main template page.

cfg.~~sandboxNoticeLivepageParam~~ = 1

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

-- to the main template page, and $2 is a diff link between the sandbox and the main template. The

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

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

cfg.sandboxNoticeDiffDisplay = 'diff'

-- cfg.sandboxNoticeTestcasesBlurb

-- cfg.sandboxNoticeTestcasesLinkDisplay

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

-- corresponding to this sandbox that they can edit. $1 is a link to the 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'

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