Module:Documentation/config < Module:Documentation

    Documentation for this module may be created at Module:Documentation/config/doc 

    1. ----------------------------------------------------------------------------------------------------
    2. --
    3. --                               Configuration for Module:Documentation
    4. --
    5. -- Here you can set the values of the parameters and messages used in Module:Documentation to
    6. -- localise it to your wiki and your language. Unless specified otherwise, values given here
    7. -- should be string values.
    8. ----------------------------------------------------------------------------------------------------
    9.  
    10. local cfg = {} -- Do not edit this line.
    11.  
    12. ----------------------------------------------------------------------------------------------------
    13. -- Protection template configuration
    14. ----------------------------------------------------------------------------------------------------
    15.  
    16. -- cfg['protection-reason-edit']
    17. -- The protection reason for edit-protected templates to pass to
    18. -- [[Module:Protection banner]].
    19. cfg['protection-reason-edit'] = 'template'
    20.  
    21. --[[
    22. ----------------------------------------------------------------------------------------------------
    23. -- Sandbox notice configuration
    24. --
    25. -- On sandbox pages the module can display a template notifying users that the current page is a
    26. -- sandbox, and the location of test cases pages, etc. The module decides whether the page is a
    27. -- sandbox or not based on the value of cfg['sandbox-subpage']. The following settings configure the
    28. -- messages that the notices contains.
    29. ----------------------------------------------------------------------------------------------------
    30. --]]
    31.  
    32. -- cfg['sandbox-notice-image']
    33. -- The image displayed in the sandbox notice.
    34. cfg['sandbox-notice-image'] = '[[Image:Sandbox.svg|50px|alt=|link=]]'
    35.  
    36. --[[
    37. -- cfg['sandbox-notice-pagetype-template']
    38. -- cfg['sandbox-notice-pagetype-module']
    39. -- cfg['sandbox-notice-pagetype-other']
    40. -- The page type of the sandbox page. The message that is displayed depends on the current subject
    41. -- namespace. This message is used in either cfg['sandbox-notice-blurb'] or
    42. -- cfg['sandbox-notice-diff-blurb'].
    43. --]]
    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'
    47.  
    48. --[[
    49. -- cfg['sandbox-notice-blurb']
    50. -- cfg['sandbox-notice-diff-blurb']
    51. -- cfg['sandbox-notice-diff-display']
    52. -- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence
    53. -- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page
    54. -- type, which is either cfg['sandbox-notice-pagetype-template'],
    55. -- cfg['sandbox-notice-pagetype-module'] or cfg['sandbox-notice-pagetype-other'] depending what
    56. -- namespace we are in. $2 is a link to the main template page, and $3 is a diff link between
    57. -- the sandbox and the main template. The display value of the diff link is set by 
    58. -- cfg['sandbox-notice-compare-link-display'].
    59. --]]
    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'
    63.  
    64. --[[
    65. -- cfg['sandbox-notice-testcases-blurb']
    66. -- cfg['sandbox-notice-testcases-link-display']
    67. -- cfg['sandbox-notice-testcases-run-blurb']
    68. -- cfg['sandbox-notice-testcases-run-link-display']
    69. -- cfg['sandbox-notice-testcases-blurb'] is a sentence notifying the user that there is a test cases page
    70. -- corresponding to this sandbox that they can edit. $1 is a link to the test cases page.
    71. -- cfg['sandbox-notice-testcases-link-display'] is the display value for that link.
    72. -- cfg['sandbox-notice-testcases-run-blurb'] is a sentence notifying the user that there is a test cases page
    73. -- corresponding to this sandbox that they can edit, along with a link to run it. $1 is a link to the test
    74. -- cases page, and $2 is a link to the page to run it.
    75. -- cfg['sandbox-notice-testcases-run-link-display'] is the display value for the link to run the test
    76. -- cases.
    77. --]]
    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.  
    83. -- cfg['sandbox-category']
    84. -- A category to add to all template sandboxes.
    85. cfg['sandbox-category'] = 'Template sandboxes'
    86.  
    87. ----------------------------------------------------------------------------------------------------
    88. -- Start box configuration
    89. ----------------------------------------------------------------------------------------------------
    90.  
    91. -- cfg['documentation-icon-wikitext']
    92. -- The wikitext for the icon shown at the top of the template.
    93. cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=Documentation icon]]'
    94.  
    95. -- cfg['template-namespace-heading']
    96. -- The heading shown in the template namespace.
    97. cfg['template-namespace-heading'] = 'Template documentation'
    98.  
    99. -- cfg['module-namespace-heading']
    100. -- The heading shown in the module namespace.
    101. cfg['module-namespace-heading'] = 'Module documentation'
    102.  
    103. -- cfg['file-namespace-heading']
    104. -- The heading shown in the file namespace.
    105. cfg['file-namespace-heading'] = 'Summary'
    106.  
    107. -- cfg['other-namespaces-heading']
    108. -- The heading shown in other namespaces.
    109. cfg['other-namespaces-heading'] = 'Documentation'
    110.  
    111. -- cfg['view-link-display']
    112. -- The text to display for "view" links.
    113. cfg['view-link-display'] = 'view'
    114.  
    115. -- cfg['edit-link-display']
    116. -- The text to display for "edit" links.
    117. cfg['edit-link-display'] = 'edit'
    118.  
    119. -- cfg['history-link-display']
    120. -- The text to display for "history" links.
    121. cfg['history-link-display'] = 'history'
    122.  
    123. -- cfg['purge-link-display']
    124. -- The text to display for "purge" links.
    125. cfg['purge-link-display'] = 'purge'
    126.  
    127. -- cfg['create-link-display']
    128. -- The text to display for "create" links.
    129. cfg['create-link-display'] = 'create'
    130.  
    131. ----------------------------------------------------------------------------------------------------
    132. -- Link box (end box) configuration
    133. ----------------------------------------------------------------------------------------------------
    134.  
    135. -- cfg['transcluded-from-blurb']
    136. -- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
    137. cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'
    138.  
    139. --[[
    140. -- cfg['create-module-doc-blurb']
    141. -- Notice displayed in the module namespace when the documentation subpage does not exist.
    142. -- $1 is a link to create the documentation page with the preload cfg['module-preload'] and the
    143. -- display cfg['create-link-display'].
    144. --]]
    145. cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
    146.  
    147. ----------------------------------------------------------------------------------------------------
    148. -- Experiment blurb configuration
    149. ----------------------------------------------------------------------------------------------------
    150.  
    151. --[[
    152. -- cfg['experiment-blurb-template']
    153. -- cfg['experiment-blurb-module']
    154. -- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages.
    155. -- It is only shown in the template and module namespaces. With the default English settings, it
    156. -- might look like this:
    157. --
    158. -- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
    159. --
    160. -- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
    161. --
    162. -- There are two versions, cfg['experiment-blurb-template'] and cfg['experiment-blurb-module'], depending
    163. -- on what namespace we are in.
    164. -- 
    165. -- Parameters:
    166. --
    167. -- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:
    168. --
    169. --     cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display'])
    170. -- 
    171. -- If the sandbox doesn't exist, it is in the format:
    172. --
    173. --     cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display'])
    174. -- 
    175. -- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload']
    176. -- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display']
    177. -- loads a default edit summary of cfg['mirror-edit-summary'].
    178. --
    179. -- $2 is a link to the test cases page. If the test cases page exists, it is in the following format:
    180. --
    181. --     cfg['testcases-link-display'] (cfg['testcases-edit-link-display'])
    182. --
    183. -- If the test cases page doesn't exist, it is in the format:
    184. -- 
    185. --     cfg['testcases-link-display'] (cfg['testcases-create-link-display'])
    186. --
    187. -- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the
    188. -- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current
    189. -- namespace.
    190. --]]
    191. cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages."
    192. cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages."
    193.  
    194. ----------------------------------------------------------------------------------------------------
    195. -- Sandbox link configuration
    196. ----------------------------------------------------------------------------------------------------
    197.  
    198. -- cfg['sandbox-subpage']
    199. -- The name of the template subpage typically used for sandboxes.
    200. cfg['sandbox-subpage'] = 'sandbox'
    201.  
    202. -- cfg['template-sandbox-preload']
    203. -- Preload file for template sandbox pages.
    204. cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'
    205.  
    206. -- cfg['module-sandbox-preload']
    207. -- Preload file for Lua module sandbox pages.
    208. cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'
    209.  
    210. -- cfg['sandbox-link-display']
    211. -- The text to display for "sandbox" links.
    212. cfg['sandbox-link-display'] = 'sandbox'
    213.  
    214. -- cfg['sandbox-edit-link-display']
    215. -- The text to display for sandbox "edit" links.
    216. cfg['sandbox-edit-link-display'] = 'edit'
    217.  
    218. -- cfg['sandbox-create-link-display']
    219. -- The text to display for sandbox "create" links.
    220. cfg['sandbox-create-link-display'] = 'create'
    221.  
    222. -- cfg['compare-link-display']
    223. -- The text to display for "compare" links.
    224. cfg['compare-link-display'] = 'diff'
    225.  
    226. -- cfg['mirror-edit-summary']
    227. -- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
    228. -- template page.
    229. cfg['mirror-edit-summary'] = 'Create sandbox version of $1'
    230.  
    231. -- cfg['mirror-link-display']
    232. -- The text to display for "mirror" links.
    233. cfg['mirror-link-display'] = 'mirror'
    234.  
    235. -- cfg['mirror-link-preload']
    236. -- The page to preload when a user clicks the "mirror" link.
    237. cfg['mirror-link-preload'] = 'Template:Documentation/mirror'
    238.  
    239. ----------------------------------------------------------------------------------------------------
    240. -- Test cases link configuration
    241. ----------------------------------------------------------------------------------------------------
    242.  
    243. -- cfg['testcases-subpage']
    244. -- The name of the template subpage typically used for test cases.
    245. cfg['testcases-subpage'] = 'testcases'
    246.  
    247. -- cfg['template-testcases-preload']
    248. -- Preload file for template test cases pages.
    249. cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'
    250.  
    251. -- cfg['module-testcases-preload']
    252. -- Preload file for Lua module test cases pages.
    253. cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'
    254.  
    255. -- cfg['testcases-link-display']
    256. -- The text to display for "testcases" links.
    257. cfg['testcases-link-display'] = 'testcases'
    258.  
    259. -- cfg['testcases-edit-link-display']
    260. -- The text to display for test cases "edit" links.
    261. cfg['testcases-edit-link-display'] = 'edit'
    262.  
    263. -- cfg['testcases-create-link-display']
    264. -- The text to display for test cases "create" links.
    265. cfg['testcases-create-link-display'] = 'create'
    266.  
    267. ----------------------------------------------------------------------------------------------------
    268. -- Add categories blurb configuration
    269. ----------------------------------------------------------------------------------------------------
    270.  
    271. --[[
    272. -- cfg['add-categories-blurb']
    273. -- Text to direct users to add categories to the /doc subpage. Not used if the "content" or
    274. -- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a
    275. -- link to the /doc subpage with a display value of cfg['doc-link-display'].
    276. --]]
    277. cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.'
    278.  
    279. -- cfg['doc-link-display']
    280. -- The text to display when linking to the /doc subpage.
    281. cfg['doc-link-display'] = '/doc'
    282.  
    283. ----------------------------------------------------------------------------------------------------
    284. -- Subpages link configuration
    285. ----------------------------------------------------------------------------------------------------
    286.  
    287. --[[
    288. -- cfg['subpages-blurb']
    289. -- The "Subpages of this template" blurb. $1 is a link to the main template's subpages with a
    290. -- display value of cfg['subpages-link-display']. In the English version this blurb is simply
    291. -- the link followed by a period, and the link display provides the actual text.
    292. --]]
    293. cfg['subpages-blurb'] = '$1.'
    294.  
    295. --[[
    296. -- cfg['subpages-link-display']
    297. -- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'],
    298. -- cfg['module-pagetype'] or cfg['default-pagetype'], depending on whether the current page is in
    299. -- the template namespace, the module namespace, or another namespace.
    300. --]]
    301. cfg['subpages-link-display'] = 'Subpages of this $1'
    302.  
    303. -- cfg['template-pagetype']
    304. -- The pagetype to display for template pages.
    305. cfg['template-pagetype'] = 'template'
    306.  
    307. -- cfg['module-pagetype']
    308. -- The pagetype to display for Lua module pages.
    309. cfg['module-pagetype'] = 'module'
    310.  
    311. -- cfg['default-pagetype']
    312. -- The pagetype to display for pages other than templates or Lua modules.
    313. cfg['default-pagetype'] = 'page'
    314.  
    315. ----------------------------------------------------------------------------------------------------
    316. -- Doc link configuration
    317. ----------------------------------------------------------------------------------------------------
    318.  
    319. -- cfg['doc-subpage']
    320. -- The name of the subpage typically used for documentation pages.
    321. cfg['doc-subpage'] = 'doc'
    322.  
    323. -- cfg['file-docpage-preload']
    324. -- Preload file for documentation page in the file namespace.
    325. cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'
    326.  
    327. -- cfg['docpage-preload']
    328. -- Preload file for template documentation pages in all namespaces.
    329. cfg['docpage-preload'] = 'Template:Documentation/preload'
    330.  
    331. -- cfg['module-preload']
    332. -- Preload file for Lua module documentation pages.
    333. cfg['module-preload'] = 'Template:Documentation/preload-module-doc'
    334.  
    335. ----------------------------------------------------------------------------------------------------
    336. -- Print version configuration
    337. ----------------------------------------------------------------------------------------------------
    338.  
    339. -- cfg['print-subpage']
    340. -- The name of the template subpage used for print versions.
    341. cfg['print-subpage'] = 'Print'
    342.  
    343. -- cfg['print-link-display']
    344. -- The text to display when linking to the /Print subpage.
    345. cfg['print-link-display'] = '/Print'
    346.  
    347. -- cfg['print-blurb']
    348. -- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].
    349. cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'
    350. 	.. ' If you make a change to this template, please update the print version as well.'
    351.  
    352. -- cfg['display-print-category']
    353. -- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
    354. -- This should be a boolean value (either true or false).
    355. cfg['display-print-category'] = true
    356.  
    357. -- cfg['print-category']
    358. -- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
    359. cfg['print-category'] = 'Templates with print versions'
    360.  
    361. ----------------------------------------------------------------------------------------------------
    362. -- HTML and CSS configuration
    363. ----------------------------------------------------------------------------------------------------
    364.  
    365. -- cfg['main-div-id']
    366. -- The "id" attribute of the main HTML "div" tag.
    367. cfg['main-div-id'] = 'template-documentation'
    368.  
    369. -- cfg['main-div-classes']
    370. -- The CSS classes added to the main HTML "div" tag.
    371. cfg['main-div-classes'] = 'template-documentation iezoomfix'
    372.  
    373. -- cfg['start-box-linkclasses']
    374. -- The CSS classes used for the [view][edit][history] or [create] links in the start box.
    375. cfg['start-box-linkclasses'] = 'mw-editsection-like plainlinks'
    376.  
    377. -- cfg['start-box-link-id']
    378. -- The HTML "id" attribute for the links in the start box.
    379. cfg['start-box-link-id'] = 'doc_editlinks'
    380.  
    381. ----------------------------------------------------------------------------------------------------
    382. -- {{fmbox}} template configuration
    383. ----------------------------------------------------------------------------------------------------
    384.  
    385. -- cfg['fmbox-id']
    386. -- The id sent to the "id" parameter of the {{fmbox}} template.
    387. cfg['fmbox-id'] = 'documentation-meta-data'
    388.  
    389. -- cfg['fmbox-style']
    390. -- The value sent to the style parameter of {{fmbox}}.
    391. cfg['fmbox-style'] = 'background-color: #ecfcf4'
    392.  
    393. -- cfg['fmbox-textstyle']
    394. -- The value sent to the "textstyle parameter of {{fmbox}}.
    395. cfg['fmbox-textstyle'] = 'font-style: italic'
    396.  
    397. ----------------------------------------------------------------------------------------------------
    398. -- Tracking category configuration
    399. ----------------------------------------------------------------------------------------------------
    400.  
    401. -- cfg['display-strange-usage-category']
    402. -- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage
    403. -- or a /testcases subpage. This should be a boolean value (either true or false).
    404. cfg['display-strange-usage-category'] = true
    405.  
    406. -- cfg['strange-usage-category']
    407. -- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a
    408. -- /doc subpage or a /testcases subpage.
    409. cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'
    410.  
    411. --[[
    412. ----------------------------------------------------------------------------------------------------
    413. -- End configuration
    414. --
    415. -- Don't edit anything below this line.
    416. ----------------------------------------------------------------------------------------------------
    417. --]]
    418.  
    419. return cfg
    Retrieved from "https://wiki.brandmeister.network/index.php?title=Module:Documentation/config&oldid=100"
    with by the BrandMeister Dev Team