Skip to content

Commit 2e10326

Browse files
authored
Refactor configuration to use format function
1 parent e9c3b12 commit 2e10326

1 file changed

Lines changed: 38 additions & 34 deletions

File tree

‎IMPORTANT/DocumentationConfig.lua‎

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
-- localise it to your wiki and your language. Unless specified otherwise, values given here
77
-- should be string values.
88
----------------------------------------------------------------------------------------------------
9+
local _format = require('Module:TNT').format
10+
local function format(id)
11+
return _format('I18n/Documentation', id)
12+
end
913

1014
local cfg = {} -- Do not edit this line.
1115

@@ -41,9 +45,9 @@ cfg['sandbox-notice-image'] = '[[File:Sandbox.svg|50px|alt=|link=]]'
4145
-- namespace. This message is used in either cfg['sandbox-notice-blurb'] or
4246
-- cfg['sandbox-notice-diff-blurb'].
4347
--]]
44-
cfg['sandbox-notice-pagetype-template'] = '[[Wikipedia:Template test cases|template sandbox]] page'
45-
cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'
46-
cfg['sandbox-notice-pagetype-other'] = 'sandbox page'
48+
cfg['sandbox-notice-pagetype-template'] = format('sandbox-notice-pagetype-template')
49+
cfg['sandbox-notice-pagetype-module'] = format('sandbox-notice-pagetype-module')
50+
cfg['sandbox-notice-pagetype-other'] = format('sandbox-notice-pagetype-other')
4751

4852
--[[
4953
-- cfg['sandbox-notice-blurb']
@@ -57,9 +61,9 @@ cfg['sandbox-notice-pagetype-other'] = 'sandbox page'
5761
-- the sandbox and the main template. The display value of the diff link is set by
5862
-- cfg['sandbox-notice-compare-link-display'].
5963
--]]
60-
cfg['sandbox-notice-blurb'] = 'This is the $1 for $2.'
61-
cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'
62-
cfg['sandbox-notice-compare-link-display'] = 'diff'
64+
cfg['sandbox-notice-blurb'] = format('sandbox-notice-blurb')
65+
cfg['sandbox-notice-diff-blurb'] = format('sandbox-notice-diff-blurb')
66+
cfg['sandbox-notice-compare-link-display'] = format('sandbox-notice-compare-link-display')
6367

6468
--[[
6569
-- cfg['sandbox-notice-testcases-blurb']
@@ -75,10 +79,10 @@ cfg['sandbox-notice-compare-link-display'] = 'diff'
7579
-- cfg['sandbox-notice-testcases-run-link-display'] is the display value for the link to run the test
7680
-- cases.
7781
--]]
78-
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'
79-
cfg['sandbox-notice-testcases-link-display'] = 'test cases'
80-
cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).'
81-
cfg['sandbox-notice-testcases-run-link-display'] = 'run'
82+
cfg['sandbox-notice-testcases-blurb'] = format('sandbox-notice-testcases-blurb')
83+
cfg['sandbox-notice-testcases-link-display'] = format('sandbox-notice-testcases-link-display')
84+
cfg['sandbox-notice-testcases-run-blurb'] = format('sandbox-notice-testcases-run-blurb')
85+
cfg['sandbox-notice-testcases-run-link-display'] = format('sandbox-notice-testcases-run-link-display')
8286

8387
-- cfg['sandbox-category'] - A category to add to all template sandboxes.
8488
-- cfg['module-sandbox-category'] - A category to add to all module sandboxes.
@@ -98,39 +102,39 @@ cfg['documentation-icon-wikitext'] = '[[File:Ledger open button.webp|50px|link=|
98102

99103
-- cfg['template-namespace-heading']
100104
-- The heading shown in the template namespace.
101-
cfg['template-namespace-heading'] = 'Template documentation'
105+
cfg['template-namespace-heading'] = format('template-namespace-heading')
102106

103107
-- cfg['module-namespace-heading']
104108
-- The heading shown in the module namespace.
105-
cfg['module-namespace-heading'] = 'Module documentation'
109+
cfg['module-namespace-heading'] = format('module-namespace-heading')
106110

107111
-- cfg['file-namespace-heading']
108112
-- The heading shown in the file namespace.
109-
cfg['file-namespace-heading'] = 'Summary'
113+
cfg['file-namespace-heading'] = format('file-namespace-heading')
110114

111115
-- cfg['other-namespaces-heading']
112116
-- The heading shown in other namespaces.
113-
cfg['other-namespaces-heading'] = 'Documentation'
117+
cfg['other-namespaces-heading'] = format('other-namespaces-heading')
114118

115119
-- cfg['view-link-display']
116120
-- The text to display for "view" links.
117-
cfg['view-link-display'] = 'view'
121+
cfg['view-link-display'] = format('view-link-display')
118122

119123
-- cfg['edit-link-display']
120124
-- The text to display for "edit" links.
121-
cfg['edit-link-display'] = 'edit'
125+
cfg['edit-link-display'] = format('edit-link-display')
122126

123127
-- cfg['history-link-display']
124128
-- The text to display for "history" links.
125-
cfg['history-link-display'] = 'history'
129+
cfg['history-link-display'] = format('history-link-display')
126130

127131
-- cfg['purge-link-display']
128132
-- The text to display for "purge" links.
129-
cfg['purge-link-display'] = 'purge'
133+
cfg['purge-link-display'] = format('purge-link-display')
130134

131135
-- cfg['create-link-display']
132136
-- The text to display for "create" links.
133-
cfg['create-link-display'] = 'create'
137+
cfg['create-link-display'] = format('create-link-display')
134138

135139
----------------------------------------------------------------------------------------------------
136140
-- Link box (end box) configuration
@@ -213,19 +217,19 @@ cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'
213217

214218
-- cfg['sandbox-link-display']
215219
-- The text to display for "sandbox" links.
216-
cfg['sandbox-link-display'] = 'sandbox'
220+
cfg['sandbox-link-display'] = format('sandbox-link-display')
217221

218222
-- cfg['sandbox-edit-link-display']
219223
-- The text to display for sandbox "edit" links.
220-
cfg['sandbox-edit-link-display'] = 'edit'
224+
cfg['sandbox-edit-link-display'] = format('sandbox-edit-link-display')
221225

222226
-- cfg['sandbox-create-link-display']
223227
-- The text to display for sandbox "create" links.
224-
cfg['sandbox-create-link-display'] = 'create'
228+
cfg['sandbox-create-link-display'] = format('sandbox-create-link-display')
225229

226230
-- cfg['compare-link-display']
227231
-- The text to display for "compare" links.
228-
cfg['compare-link-display'] = 'diff'
232+
cfg['compare-link-display'] = format('compare-link-display')
229233

230234
-- cfg['mirror-edit-summary']
231235
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
@@ -234,7 +238,7 @@ cfg['mirror-edit-summary'] = 'Create sandbox version of $1'
234238

235239
-- cfg['mirror-link-display']
236240
-- The text to display for "mirror" links.
237-
cfg['mirror-link-display'] = 'mirror'
241+
cfg['mirror-link-display'] = format('mirror-link-display')
238242

239243
-- cfg['mirror-link-preload']
240244
-- The page to preload when a user clicks the "mirror" link.
@@ -258,19 +262,19 @@ cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcas
258262

259263
-- cfg['testcases-link-display']
260264
-- The text to display for "testcases" links.
261-
cfg['testcases-link-display'] = 'testcases'
265+
cfg['testcases-link-display'] = format('testcases-link-display')
262266

263267
-- cfg['testcases-edit-link-display']
264268
-- The text to display for test cases "edit" links.
265-
cfg['testcases-edit-link-display'] = 'edit'
269+
cfg['testcases-edit-link-display'] = format('testcases-edit-link-display')
266270

267271
-- cfg['testcases-run-link-display']
268272
-- The text to display for test cases "run" links.
269-
cfg['testcases-run-link-display'] = 'run'
273+
cfg['testcases-run-link-display'] = format('testcases-run-link-display')
270274

271275
-- cfg['testcases-create-link-display']
272276
-- The text to display for test cases "create" links.
273-
cfg['testcases-create-link-display'] = 'create'
277+
cfg['testcases-create-link-display'] = format('testcases-create-link-display')
274278

275279
----------------------------------------------------------------------------------------------------
276280
-- Add categories blurb configuration
@@ -282,7 +286,7 @@ cfg['testcases-create-link-display'] = 'create'
282286
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a
283287
-- link to the /doc subpage with a display value of cfg['doc-link-display'].
284288
--]]
285-
cfg['add-categories-blurb'] = 'Add categories to the $1 subpage.'
289+
cfg['add-categories-blurb'] = format('add-categories-blurb')
286290

287291
-- cfg['doc-link-display']
288292
-- The text to display when linking to the /doc subpage.
@@ -298,27 +302,27 @@ cfg['doc-link-display'] = '/doc'
298302
-- display value of cfg['subpages-link-display']. In the English version this blurb is simply
299303
-- the link followed by a period, and the link display provides the actual text.
300304
--]]
301-
cfg['subpages-blurb'] = '$1.'
305+
cfg['subpages-blurb'] = format('subpages-blurb')
302306

303307
--[[
304308
-- cfg['subpages-link-display']
305309
-- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'],
306310
-- cfg['module-pagetype'] or cfg['default-pagetype'], depending on whether the current page is in
307311
-- the template namespace, the module namespace, or another namespace.
308312
--]]
309-
cfg['subpages-link-display'] = 'Subpages of this $1'
313+
cfg['subpages-link-display'] = format('subpages-link-display')
310314

311315
-- cfg['template-pagetype']
312316
-- The pagetype to display for template pages.
313-
cfg['template-pagetype'] = 'template'
317+
cfg['template-pagetype'] = format('template-pagetype')
314318

315319
-- cfg['module-pagetype']
316320
-- The pagetype to display for Lua module pages.
317-
cfg['module-pagetype'] = 'module'
321+
cfg['module-pagetype'] = format('module-pagetype')
318322

319323
-- cfg['default-pagetype']
320324
-- The pagetype to display for pages other than templates or Lua modules.
321-
cfg['default-pagetype'] = 'page'
325+
cfg['default-pagetype'] = format('default-pagetype')
322326

323327
----------------------------------------------------------------------------------------------------
324328
-- Doc link configuration

0 commit comments

Comments
 (0)