Module:Documentation/config: Difference between revisions

← Older edit

Module:Documentation/config (edit)

Revision as of 11:37, 21 May 2021

1,462 bytes added , 4 years ago

m

12 revisions imported from templatewiki:Module:Documentation/config: see Topic:Vtixlm0q28eo6jtf

@@ Line 9: / Line 9: @@
 local cfg = {} -- Do not edit this line.
-----------------------------------------------------------------------------------------------------
--- Environment configuration
-----------------------------------------------------------------------------------------------------
--- cfg.titleArg
--- An argument to specify what page to make links for. For testing purposes.
-cfg.titleArg = 'page'
--- cfg.titleArgError
--- The error message to display if the value of the cfg.titleArg argument does not result in a
--- valid title.
-cfg.titleArgError = '$1 is not a valid title'
 ----------------------------------------------------------------------------------------------------
@@ Line 27: / Line 14: @@
 ----------------------------------------------------------------------------------------------------
--- cfg.protectionTemplate
+-- cfg['protection-reason-edit']
--- The name of the template that displays the protection icon (a padlock on enwiki).
+-- The protection reason for edit-protected templates to pass to
-cfg.protectionTemplate = 'pp-template'
+-- [[Module:Protection banner]].
+cfg['protection-reason-edit'] = 'template'
--- cfg.protectionTemplateArgs
--- Any arguments to send to the protection template.
-cfg.protectionTemplateArgs = {docusage = 'yes'}
+--[[
 ----------------------------------------------------------------------------------------------------
--- 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['sandbox-subpage']. The following settings configure the
--- template is displayed and what the arguments passed to it are.
+-- messages that the notices contains.
 ----------------------------------------------------------------------------------------------------
+--]]
+-- cfg['sandbox-notice-image']
+-- The image displayed in the sandbox notice.
+cfg['sandbox-notice-image'] = '[[File:Sandbox.svg|50px|alt=|link=]]'
+--[[
+-- cfg['sandbox-notice-pagetype-template']
+-- cfg['sandbox-notice-pagetype-module']
+-- cfg['sandbox-notice-pagetype-other']
+-- The page type of the sandbox page. The message that is displayed depends on the current subject
+-- namespace. This message is used in either cfg['sandbox-notice-blurb'] or
+-- cfg['sandbox-notice-diff-blurb'].
+--]]
+cfg['sandbox-notice-pagetype-template'] = '[[Wikipedia:Template test cases|template sandbox]] page'
+cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'
+cfg['sandbox-notice-pagetype-other'] = 'sandbox page'
--- cfg.sandboxNoticeTemplate
+--[[
--- The name of the template to display at the top of sandbox pages.
+-- cfg['sandbox-notice-blurb']
-cfg.sandboxNoticeTemplate = 'template sandbox notice'
+-- cfg['sandbox-notice-diff-blurb']
+-- cfg['sandbox-notice-diff-display']
+-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence
+-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page
+-- type, which is either cfg['sandbox-notice-pagetype-template'],
+-- cfg['sandbox-notice-pagetype-module'] or cfg['sandbox-notice-pagetype-other'] depending what
+-- namespace we are in. $2 is a link to the main template page, and $3 is a diff link between
+-- the sandbox and the main template. The display value of the diff link is set by
+-- cfg['sandbox-notice-compare-link-display'].
+--]]
+cfg['sandbox-notice-blurb'] = 'This is the $1 for $2.'
+cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'
+cfg['sandbox-notice-compare-link-display'] = 'diff'
--- cfg.sandboxNoticeLivepageParam
+--[[
--- The parameter of the sandbox notice template to send the cfg.livepageArg to.
+-- cfg['sandbox-notice-testcases-blurb']
-cfg.sandboxNoticeLivepageParam = 1
+-- cfg['sandbox-notice-testcases-link-display']
+-- cfg['sandbox-notice-testcases-run-blurb']
+-- cfg['sandbox-notice-testcases-run-link-display']
+-- cfg['sandbox-notice-testcases-blurb'] 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['sandbox-notice-testcases-link-display'] is the display value for that link.
+-- cfg['sandbox-notice-testcases-run-blurb'] is a sentence notifying the user that there is a test cases page
+-- corresponding to this sandbox that they can edit, along with a link to run it. $1 is a link to the test
+-- cases page, and $2 is a link to the page to run it.
+-- cfg['sandbox-notice-testcases-run-link-display'] is the display value for the link to run the test
+-- cases.
+--]]
+cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'
+cfg['sandbox-notice-testcases-link-display'] = 'test cases'
+cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).'
+cfg['sandbox-notice-testcases-run-link-display'] = 'run'
--- cfg.livepageArg
+-- cfg['sandbox-category']
--- The name of one of the module arguments. The value of this argument should be the main template
+-- A category to add to all template sandboxes.
--- page (i.e. the "live" template). This is passed to the parameter cfg.sandboxNoticeLivepageParam of
+cfg['sandbox-category'] = 'Template sandboxes'
--- the template cfg.sandboxNoticeTemplate.
-cfg.livepageArg = 'livepage'