Module:Documentation/config: Difference between revisions
Content added Content deleted
SecurityXP (talk | contribs) m (1 revision imported: Template) Tags: Mobile edit Mobile web edit |
SecurityXP (talk | contribs) No edit summary |
||
Line 42: | Line 42: | ||
-- cfg['sandbox-notice-diff-blurb']. |
-- cfg['sandbox-notice-diff-blurb']. |
||
--]] |
--]] |
||
cfg['sandbox-notice-pagetype-template'] = '[[Wikipedia: |
cfg['sandbox-notice-pagetype-template'] = '[[Wikipedia:Template test cases|template sandbox]] page' |
||
cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia: |
cfg['sandbox-notice-pagetype-module'] = '[[Wikipedia:Template test cases|module sandbox]] page' |
||
cfg['sandbox-notice-pagetype-other'] = ' |
cfg['sandbox-notice-pagetype-other'] = 'sandbox page' |
||
--[[ |
--[[ |
||
Line 58: | Line 58: | ||
-- cfg['sandbox-notice-compare-link-display']. |
-- cfg['sandbox-notice-compare-link-display']. |
||
--]] |
--]] |
||
cfg['sandbox-notice-blurb'] = ' |
cfg['sandbox-notice-blurb'] = 'This is the $1 for $2.' |
||
cfg['sandbox-notice-diff-blurb'] = ' |
cfg['sandbox-notice-diff-blurb'] = 'This is the $1 for $2 ($3).' |
||
cfg['sandbox-notice-compare-link-display'] = ' |
cfg['sandbox-notice-compare-link-display'] = 'diff' |
||
--[[ |
--[[ |
||
Line 76: | Line 76: | ||
-- cases. |
-- cases. |
||
--]] |
--]] |
||
cfg['sandbox-notice-testcases-blurb'] = ' |
cfg['sandbox-notice-testcases-blurb'] = 'See also the companion subpage for $1.' |
||
cfg['sandbox-notice-testcases-link-display'] = ' |
cfg['sandbox-notice-testcases-link-display'] = 'test cases' |
||
cfg['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'] = ' |
cfg['sandbox-notice-testcases-run-link-display'] = 'run' |
||
-- cfg['sandbox-category'] |
-- cfg['sandbox-category'] |
||
-- A category to add to all template sandboxes. |
-- A category to add to all template sandboxes. |
||
cfg['sandbox-category'] = ' |
cfg['sandbox-category'] = 'Template sandboxes' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 91: | 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= |
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]' |
||
-- cfg['template-namespace-heading'] |
-- cfg['template-namespace-heading'] |
||
-- The heading shown in the template namespace. |
-- The heading shown in the template namespace. |
||
cfg['template-namespace-heading'] = ' |
cfg['template-namespace-heading'] = 'Template documentation' |
||
-- cfg['module-namespace-heading'] |
-- cfg['module-namespace-heading'] |
||
-- The heading shown in the module namespace. |
-- The heading shown in the module namespace. |
||
cfg['module-namespace-heading'] = ' |
cfg['module-namespace-heading'] = 'Module documentation' |
||
-- cfg['file-namespace-heading'] |
-- cfg['file-namespace-heading'] |
||
Line 107: | Line 107: | ||
-- cfg['other-namespaces-heading'] |
-- cfg['other-namespaces-heading'] |
||
-- The heading shown in other namespaces. |
-- The heading shown in other namespaces. |
||
cfg['other-namespaces-heading'] = ' |
cfg['other-namespaces-heading'] = 'Documentation' |
||
-- cfg['view-link-display'] |
-- cfg['view-link-display'] |
||
-- The text to display for "view" links. |
-- The text to display for "view" links. |
||
cfg['view-link-display'] = ' |
cfg['view-link-display'] = 'view' |
||
-- cfg['edit-link-display'] |
-- cfg['edit-link-display'] |
||
-- The text to display for "edit" links. |
-- The text to display for "edit" links. |
||
cfg['edit-link-display'] = ' |
cfg['edit-link-display'] = 'edit' |
||
-- cfg['history-link-display'] |
-- cfg['history-link-display'] |
||
-- The text to display for "history" links. |
-- The text to display for "history" links. |
||
cfg['history-link-display'] = ' |
cfg['history-link-display'] = 'history' |
||
-- cfg['purge-link-display'] |
-- cfg['purge-link-display'] |
||
-- The text to display for "purge" links. |
-- The text to display for "purge" links. |
||
cfg['purge-link-display'] = ' |
cfg['purge-link-display'] = 'purge' |
||
-- cfg['create-link-display'] |
-- cfg['create-link-display'] |
||
-- The text to display for "create" links. |
-- The text to display for "create" links. |
||
cfg['create-link-display'] = ' |
cfg['create-link-display'] = 'create' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 135: | 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'] = ' |
cfg['transcluded-from-blurb'] = 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from $1.' |
||
--[[ |
--[[ |
||
Line 143: | Line 143: | ||
-- display cfg['create-link-display']. |
-- display cfg['create-link-display']. |
||
--]] |
--]] |
||
cfg['create-module-doc-blurb'] = ' |
cfg['create-module-doc-blurb'] = 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 167: | Line 167: | ||
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format: |
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format: |
||
-- |
-- |
||
-- cfg['sandbox-link-display'] |
-- cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display']) |
||
-- |
-- |
||
-- If the sandbox doesn't exist, it is in the format: |
-- If the sandbox doesn't exist, it is in the format: |
||
-- |
-- |
||
-- cfg['sandbox-link-display'] |
-- cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display']) |
||
-- |
-- |
||
-- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload'] |
-- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload'] |
||
Line 179: | 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-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: |
||
-- |
-- |
||
-- cfg['testcases-link-display'] |
-- cfg['testcases-link-display'] (cfg['testcases-create-link-display']) |
||
-- |
-- |
||
-- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the |
-- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the |
||
Line 189: | Line 189: | ||
-- namespace. |
-- namespace. |
||
--]] |
--]] |
||
cfg['experiment-blurb-template'] = " |
cfg['experiment-blurb-template'] = "Editors can experiment in this template's $1 and $2 pages." |
||
cfg['experiment-blurb-module'] = " |
cfg['experiment-blurb-module'] = "Editors can experiment in this module's $1 and $2 pages." |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 210: | 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'] = ' |
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'] = ' |
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'] = ' |
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'] = ' |
cfg['compare-link-display'] = 'diff' |
||
-- cfg['mirror-edit-summary'] |
-- cfg['mirror-edit-summary'] |
||
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the |
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the |
||
-- template page. |
-- template page. |
||
cfg['mirror-edit-summary'] = ' |
cfg['mirror-edit-summary'] = 'Create sandbox version of $1' |
||
-- 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'] = ' |
cfg['mirror-link-display'] = 'mirror' |
||
-- cfg['mirror-link-preload'] |
-- cfg['mirror-link-preload'] |
||
Line 255: | 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'] = ' |
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'] = ' |
cfg['testcases-edit-link-display'] = 'edit' |
||
-- cfg['testcases-run-link-display'] |
-- cfg['testcases-run-link-display'] |
||
-- The text to display for test cases "run" links. |
-- The text to display for test cases "run" links. |
||
cfg['testcases-run-link-display'] = ' |
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'] = ' |
cfg['testcases-create-link-display'] = 'create' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 279: | 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'] = ' |
cfg['add-categories-blurb'] = 'Please add categories to the $1 subpage.' |
||
-- cfg['doc-link-display'] |
-- cfg['doc-link-display'] |
||
Line 295: | 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'] = '$1 |
cfg['subpages-blurb'] = '$1.' |
||
--[[ |
--[[ |
||
Line 303: | Line 303: | ||
-- the template namespace, the module namespace, or another namespace. |
-- the template namespace, the module namespace, or another namespace. |
||
--]] |
--]] |
||
cfg['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'] = ' |
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'] = ' |
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'] = ' |
cfg['default-pagetype'] = 'page' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
Line 397: | Line 397: | ||
-- cfg['fmbox-textstyle'] |
-- cfg['fmbox-textstyle'] |
||
-- The value sent to the "textstyle parameter of {{fmbox}}. |
-- The value sent to the "textstyle parameter of {{fmbox}}. |
||
cfg['fmbox-textstyle'] = 'font- |
cfg['fmbox-textstyle'] = 'font-style: italic' |
||
---------------------------------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |