Railway Operation Simulator Wiki

Changes

Module:Documentation/config (view source)

Revision as of 09:56, 20 November 2020

1,069 bytes added ,  09:56, 20 November 2020
m
replace deprecated "Image:" with "File:"
Line 7: Line 7:  
-- should be string values.
 
-- should be string values.
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
−
  −
local _format = require('Module:TNT').format
  −
local function format(id)
  −
return _format('I18n/Documentation', id)
  −
end
      
local cfg = {} -- Do not edit this line.
 
local cfg = {} -- Do not edit this line.
−
  −
cfg['templatestyles-scr'] = 'Module:Documentation/styles.css'
      
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
 
-- Protection template configuration
 
-- Protection template configuration
 
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
−
  −
-- cfg['protection-template']
  −
-- The name of the template that displays the protection icon (a padlock on enwiki).
  −
cfg['protection-template'] = 'pp-template'
      
-- cfg['protection-reason-edit']
 
-- cfg['protection-reason-edit']
Line 29: Line 18:  
-- [[Module:Protection banner]].
 
-- [[Module:Protection banner]].
 
cfg['protection-reason-edit'] = 'template'
 
cfg['protection-reason-edit'] = 'template'
−
  −
--[[
  −
-- cfg['protection-template-args']
  −
-- Any arguments to send to the protection template. This should be a Lua table.
  −
-- For example, if the protection template is "pp-template", and the wikitext template invocation
  −
-- looks like "{{pp-template|docusage=yes}}", then this table should look like "{docusage = 'yes'}".
  −
--]]
  −
cfg['protection-template-args'] = {docusage = 'yes'}
      
--[[
 
--[[
Line 51: Line 32:  
-- cfg['sandbox-notice-image']
 
-- cfg['sandbox-notice-image']
 
-- The image displayed in the sandbox notice.
 
-- The image displayed in the sandbox notice.
−
cfg['sandbox-notice-image'] = '[[Image:Edit In Sandbox Icon - Color.svg|40px|alt=|link=]]'
+
cfg['sandbox-notice-image'] = '[[File:Sandbox.svg|50px|alt=|link=]]'
    
--[[
 
--[[
Line 61: Line 42:  
-- cfg['sandbox-notice-diff-blurb'].
 
-- cfg['sandbox-notice-diff-blurb'].
 
--]]
 
--]]
−
cfg['sandbox-notice-pagetype-template'] = format('sandbox-notice-pagetype-template')
+
cfg['sandbox-notice-pagetype-template'] = '[[Wikipedia:Template test cases|template sandbox]] page'
−
cfg['sandbox-notice-pagetype-module'] = format('sandbox-notice-pagetype-module')
+
cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page'
−
cfg['sandbox-notice-pagetype-other'] = format('sandbox-notice-pagetype-other')
+
cfg['sandbox-notice-pagetype-other'] = 'sandbox page'
    
--[[
 
--[[
Line 77: Line 58:  
-- cfg['sandbox-notice-compare-link-display'].
 
-- cfg['sandbox-notice-compare-link-display'].
 
--]]
 
--]]
−
cfg['sandbox-notice-blurb'] = format('sandbox-notice-blurb')
+
cfg['sandbox-notice-blurb'] = 'This is the $1 for $2.'
−
cfg['sandbox-notice-diff-blurb'] = format('sandbox-notice-diff-blurb')
+
cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).'
−
cfg['sandbox-notice-compare-link-display'] = format('sandbox-notice-compare-link-display')
+
cfg['sandbox-notice-compare-link-display'] = 'diff'
    
--[[
 
--[[
Line 95: Line 76:  
-- cases.
 
-- cases.
 
--]]
 
--]]
−
cfg['sandbox-notice-testcases-blurb'] = format('sandbox-notice-testcases-blurb')
+
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.'
−
cfg['sandbox-notice-testcases-link-display'] = format('sandbox-notice-testcases-link-display')
+
cfg['sandbox-notice-testcases-link-display'] = 'test cases'
−
cfg['sandbox-notice-testcases-run-blurb'] = format('sandbox-notice-testcases-run-blurb')
+
cfg['sandbox-notice-testcases-run-blurb'] = 'See also the companion subpage for $1 ($2).'
−
cfg['sandbox-notice-testcases-run-link-display'] = format('sandbox-notice-testcases-run-link-display')
+
cfg['sandbox-notice-testcases-run-link-display'] = 'run'
    
-- cfg['sandbox-category']
 
-- cfg['sandbox-category']
Line 110: Line 91:  
-- cfg['documentation-icon-wikitext']
 
-- cfg['documentation-icon-wikitext']
 
-- 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['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=Documentation icon]]'
+
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
 +
 
 +
-- cfg['template-namespace-heading']
 +
-- The heading shown in the template namespace.
 +
cfg['template-namespace-heading'] = 'Template documentation'
 +
 
 +
-- cfg['module-namespace-heading']
 +
-- The heading shown in the module namespace.
 +
cfg['module-namespace-heading'] = 'Module documentation'
 +
 
 +
-- cfg['file-namespace-heading']
 +
-- The heading shown in the file namespace.
 +
cfg['file-namespace-heading'] = 'Summary'
 +
 
 +
-- cfg['other-namespaces-heading']
 +
-- The heading shown in other namespaces.
 +
cfg['other-namespaces-heading'] = 'Documentation'
 +
 
 +
-- cfg['view-link-display']
 +
-- The text to display for "view" links.
 +
cfg['view-link-display'] = 'view'
 +
 
 +
-- cfg['edit-link-display']
 +
-- The text to display for "edit" links.
 +
cfg['edit-link-display'] = 'edit'
 +
 
 +
-- cfg['history-link-display']
 +
-- The text to display for "history" links.
 +
cfg['history-link-display'] = 'history'
 +
 
 +
-- cfg['purge-link-display']
 +
-- The text to display for "purge" links.
 +
cfg['purge-link-display'] = 'purge'
 +
 
 +
-- cfg['create-link-display']
 +
-- The text to display for "create" links.
 +
cfg['create-link-display'] = 'create'
    
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 118: Line 135:  
-- cfg['transcluded-from-blurb']
 
-- cfg['transcluded-from-blurb']
 
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
 
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
−
cfg['transcluded-from-blurb'] = format('transcluded-from-blurb')
+
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.'
    
--[[
 
--[[
Line 126: Line 143:  
-- display cfg['create-link-display'].
 
-- display cfg['create-link-display'].
 
--]]
 
--]]
−
cfg['create-module-doc-blurb'] = format('create-module-doc-blurb')
+
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
    
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 162: Line 179:  
-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format:
 
-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format:
 
--
 
--
−
--    cfg['testcases-link-display'] (cfg['testcases-edit-link-display'])
+
--    cfg['testcases-link-display'] (cfg['testcases-edit-link-display'] | cfg['testcases-run-link-display'])
 
--
 
--
 
-- If the test cases page doesn't exist, it is in the format:
 
-- If the test cases page doesn't exist, it is in the format:
Line 172: Line 189:  
-- namespace.
 
-- namespace.
 
--]]
 
--]]
−
cfg['experiment-blurb-template'] = format('experiment-blurb-template')
+
cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages."
−
cfg['experiment-blurb-module'] = format('experiment-blurb-module')
+
cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages."
    
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 193: Line 210:  
-- cfg['sandbox-link-display']
 
-- cfg['sandbox-link-display']
 
-- The text to display for "sandbox" links.
 
-- The text to display for "sandbox" links.
−
cfg['sandbox-link-display'] = format('sandbox-link-display')
+
cfg['sandbox-link-display'] = 'sandbox'
    
-- cfg['sandbox-edit-link-display']
 
-- cfg['sandbox-edit-link-display']
 
-- The text to display for sandbox "edit" links.
 
-- The text to display for sandbox "edit" links.
−
cfg['sandbox-edit-link-display'] = format('sandbox-edit-link-display')
+
cfg['sandbox-edit-link-display'] = 'edit'
    
-- cfg['sandbox-create-link-display']
 
-- cfg['sandbox-create-link-display']
 
-- The text to display for sandbox "create" links.
 
-- The text to display for sandbox "create" links.
−
cfg['sandbox-create-link-display'] = format('sandbox-create-link-display')
+
cfg['sandbox-create-link-display'] = 'create'
    
-- cfg['compare-link-display']
 
-- cfg['compare-link-display']
 
-- The text to display for "compare" links.
 
-- The text to display for "compare" links.
−
cfg['compare-link-display'] = format('compare-link-display')
+
cfg['compare-link-display'] = 'diff'
    
-- cfg['mirror-edit-summary']
 
-- cfg['mirror-edit-summary']
Line 214: Line 231:  
-- cfg['mirror-link-display']
 
-- cfg['mirror-link-display']
 
-- The text to display for "mirror" links.
 
-- The text to display for "mirror" links.
−
cfg['mirror-link-display'] = format('mirror-link-display')
+
cfg['mirror-link-display'] = 'mirror'
    
-- cfg['mirror-link-preload']
 
-- cfg['mirror-link-preload']
Line 238: Line 255:  
-- cfg['testcases-link-display']
 
-- cfg['testcases-link-display']
 
-- The text to display for "testcases" links.
 
-- The text to display for "testcases" links.
−
cfg['testcases-link-display'] = format('testcases-link-display')
+
cfg['testcases-link-display'] = 'testcases'
    
-- cfg['testcases-edit-link-display']
 
-- cfg['testcases-edit-link-display']
 
-- The text to display for test cases "edit" links.
 
-- The text to display for test cases "edit" links.
−
cfg['testcases-edit-link-display'] = format('testcases-edit-link-display')
+
cfg['testcases-edit-link-display'] = 'edit'
 +
 
 +
-- cfg['testcases-run-link-display']
 +
-- The text to display for test cases "run" links.
 +
cfg['testcases-run-link-display'] = 'run'
    
-- cfg['testcases-create-link-display']
 
-- cfg['testcases-create-link-display']
 
-- The text to display for test cases "create" links.
 
-- The text to display for test cases "create" links.
−
cfg['testcases-create-link-display'] = format('testcases-create-link-display')
+
cfg['testcases-create-link-display'] = 'create'
    
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 258: Line 279:  
-- link to the /doc subpage with a display value of cfg['doc-link-display'].
 
-- link to the /doc subpage with a display value of cfg['doc-link-display'].
 
--]]
 
--]]
−
cfg['add-categories-blurb'] = format('add-categories-blurb')
+
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.'
    
-- cfg['doc-link-display']
 
-- cfg['doc-link-display']
Line 274: Line 295:  
-- the link followed by a period, and the link display provides the actual text.
 
-- the link followed by a period, and the link display provides the actual text.
 
--]]
 
--]]
−
cfg['subpages-blurb'] = format('subpages-blurb')
+
cfg['subpages-blurb'] = '$1.'
    
--[[
 
--[[
Line 282: Line 303:  
-- the template namespace, the module namespace, or another namespace.
 
-- the template namespace, the module namespace, or another namespace.
 
--]]
 
--]]
−
cfg['subpages-link-display'] = format('subpages-link-display')
+
cfg['subpages-link-display'] = 'Subpages of this $1'
    
-- cfg['template-pagetype']
 
-- cfg['template-pagetype']
 
-- The pagetype to display for template pages.
 
-- The pagetype to display for template pages.
−
cfg['template-pagetype'] = format('template-pagetype')
+
cfg['template-pagetype'] = 'template'
    
-- cfg['module-pagetype']
 
-- cfg['module-pagetype']
 
-- The pagetype to display for Lua module pages.
 
-- The pagetype to display for Lua module pages.
−
cfg['module-pagetype'] = format('module-pagetype')
+
cfg['module-pagetype'] = 'module'
    
-- cfg['default-pagetype']
 
-- cfg['default-pagetype']
 
-- The pagetype to display for pages other than templates or Lua modules.
 
-- The pagetype to display for pages other than templates or Lua modules.
−
cfg['default-pagetype'] = format('default-pagetype')
+
cfg['default-pagetype'] = 'page'
    
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Line 329: Line 350:     
-- cfg['print-blurb']
 
-- cfg['print-blurb']
−
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].
+
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with
−
cfg['print-blurb'] = format('print-blurb')
+
-- a display value of cfg['print-link-display'].
 +
cfg['print-blurb'] = 'A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at $1.'
 +
.. ' If you make a change to this template, please update the print version as well.'
    
-- cfg['display-print-category']
 
-- cfg['display-print-category']
Line 345: Line 368:  
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
   −
-- cfg['main-div-id']
+
-- cfg['templatestyles']
−
-- The "id" attribute of the main HTML "div" tag.
+
-- The name of the TemplateStyles page where CSS is kept.
−
cfg['main-div-id'] = 'template-documentation'
+
-- Sandbox CSS will be at Module:Documentation/sandbox/styles.css when needed.
 +
cfg['templatestyles'] = 'Module:Documentation/styles.css'
 +
 
 +
-- cfg['container']
 +
-- Class which can be used to set flex or grid CSS on the
 +
-- two child divs documentation and documentation-metadata
 +
cfg['container'] = 'documentation-container'
    
-- cfg['main-div-classes']
 
-- cfg['main-div-classes']
−
-- The CSS classes added to the main HTML "div" tag.
+
-- Classes added to the main HTML "div" tag.
−
cfg['main-div-class'] = 'ts-doc-doc'
+
cfg['main-div-classes'] = 'documentation'
−
cfg['header-div-class'] = 'ts-doc-header'
+
 
−
cfg['heading-div-class'] = 'ts-doc-heading'
+
-- cfg['main-div-heading-class']
−
cfg['content-div-class'] = 'ts-doc-content'
+
-- Class for the main heading for templates and modules and assoc. talk spaces
−
cfg['footer-div-class'] = 'ts-doc-footer plainlinks'
+
cfg['main-div-heading-class'] = 'documentation-heading'
 +
 
 +
-- cfg['start-box-class']
 +
-- Class for the start box
 +
cfg['start-box-class'] = 'documentation-startbox'
 +
 
 +
-- cfg['start-box-link-classes']
 +
-- Classes used for the [view][edit][history] or [create] links in the start box.
 +
-- mw-editsection-like is per [[Wikipedia:Village pump (technical)/Archive 117]]
 +
cfg['start-box-link-classes'] = 'mw-editsection-like plainlinks'
 +
 
 +
-- cfg['end-box-class']
 +
-- Class for the end box.
 +
cfg['end-box-class'] = 'documentation-metadata'
 +
 
 +
-- cfg['end-box-plainlinks']
 +
-- Plainlinks
 +
cfg['end-box-plainlinks'] = 'plainlinks'
   −
cfg['sandbox-class'] = 'ts-doc-sandbox'
+
-- cfg['toolbar-class']
 +
-- Class added for toolbar links.
 +
cfg['toolbar-class'] = 'documentation-toolbar'
   −
-- cfg['start-box-linkclasses']
+
-- cfg['clear']
−
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
+
-- Just used to clear things.
−
cfg['start-box-linkclasses'] = 'ts-tlinks-tlinks mw-editsection-like plainlinks'
+
cfg['clear'] = 'documentation-clear'
   −
-- cfg['start-box-link-id']
  −
-- The HTML "id" attribute for the links in the start box.
  −
cfg['start-box-link-id'] = 'doc_editlinks'
      
----------------------------------------------------------------------------------------------------
 
----------------------------------------------------------------------------------------------------
Anonymous user
Retrieved from ‘https://wiki.railos.org/index.php/Special:MobileDiff/84’