Module:Documentation and Module:Documentation/config: Difference between pages
(Difference between pages)
m (1 revision imported) |
mediawiki>Tacsipacsi (Undo revision 4731975 by Tacsipacsi (talk): I wanted to do this in the sandbox) |
||
Line 1: | Line 1: | ||
---------------------------------------------------------------------------------------------------- |
|||
-- This module implements {{documentation}}. |
|||
-- |
|||
-- Configuration for Module:Documentation |
|||
-- |
|||
-- Here you can set the values of the parameters and messages used in Module:Documentation to |
|||
-- localise it to your wiki and your language. Unless specified otherwise, values given here |
|||
-- 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. |
|||
cfg['templatestyles-scr'] = 'Module:Documentation/styles.css' |
|||
---------------------------------------------------------------------------------------------------- |
|||
-- Get required modules. |
|||
-- Protection template configuration |
|||
local getArgs = require('Module:Arguments').getArgs |
|||
---------------------------------------------------------------------------------------------------- |
|||
-- cfg['protection-template'] |
|||
-- Get the config table. |
|||
-- The name of the template that displays the protection icon (a padlock on enwiki). |
|||
local cfg = mw.loadData('Module:Documentation/config') |
|||
cfg['protection-template'] = 'pp-template' |
|||
-- cfg['protection-reason-edit'] |
|||
local p = {} |
|||
-- The protection reason for edit-protected templates to pass to |
|||
-- [[Module:Protection banner]]. |
|||
cfg['protection-reason-edit'] = 'template' |
|||
--[[ |
|||
-- Often-used functions. |
|||
-- cfg['protection-template-args'] |
|||
local ugsub = mw.ustring.gsub |
|||
-- 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'} |
|||
--[[ |
|||
---------------------------------------------------------------------------- |
|||
---------------------------------------------------------------------------------------------------- |
|||
-- Helper functions |
|||
-- Sandbox notice configuration |
|||
-- |
-- |
||
-- On sandbox pages the module can display a template notifying users that the current page is a |
|||
-- These are defined as local functions, but are made available in the p |
|||
-- sandbox, and the location of test cases pages, etc. The module decides whether the page is a |
|||
-- table for testing purposes. |
|||
-- sandbox or not based on the value of cfg['sandbox-subpage']. The following settings configure the |
|||
---------------------------------------------------------------------------- |
|||
-- messages that the notices contains. |
|||
---------------------------------------------------------------------------------------------------- |
|||
--]] |
|||
-- cfg['sandbox-notice-image'] |
|||
local function message(cfgKey, valArray, expectType) |
|||
-- The image displayed in the sandbox notice. |
|||
--[[ |
|||
cfg['sandbox-notice-image'] = '[[Image:Edit In Sandbox Icon - Color.svg|40px|alt=|link=]]' |
|||
-- Gets a message from the cfg table and formats it if appropriate. |
|||
-- The function raises an error if the value from the cfg table is not |
|||
-- of the type expectType. The default type for expectType is 'string'. |
|||
-- If the table valArray is present, strings such as $1, $2 etc. in the |
|||
-- message are substituted with values from the table keys [1], [2] etc. |
|||
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.', |
|||
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz." |
|||
--]] |
|||
local msg = cfg[cfgKey] |
|||
expectType = expectType or 'string' |
|||
if type(msg) ~= expectType then |
|||
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2) |
|||
end |
|||
if not valArray then |
|||
return msg |
|||
end |
|||
--[[ |
|||
local function getMessageVal(match) |
|||
-- cfg['sandbox-notice-pagetype-template'] |
|||
match = tonumber(match) |
|||
-- cfg['sandbox-notice-pagetype-module'] |
|||
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4) |
|||
-- cfg['sandbox-notice-pagetype-other'] |
|||
end |
|||
-- 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'] = format('sandbox-notice-pagetype-template') |
|||
cfg['sandbox-notice-pagetype-module'] = format('sandbox-notice-pagetype-module') |
|||
cfg['sandbox-notice-pagetype-other'] = format('sandbox-notice-pagetype-other') |
|||
--[[ |
|||
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal) |
|||
-- cfg['sandbox-notice-blurb'] |
|||
end |
|||
-- 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'] = format('sandbox-notice-blurb') |
|||
cfg['sandbox-notice-diff-blurb'] = format('sandbox-notice-diff-blurb') |
|||
cfg['sandbox-notice-compare-link-display'] = format('sandbox-notice-compare-link-display') |
|||
--[[ |
|||
p.message = message |
|||
-- cfg['sandbox-notice-testcases-blurb'] |
|||
-- 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'] = format('sandbox-notice-testcases-blurb') |
|||
cfg['sandbox-notice-testcases-link-display'] = format('sandbox-notice-testcases-link-display') |
|||
cfg['sandbox-notice-testcases-run-blurb'] = format('sandbox-notice-testcases-run-blurb') |
|||
cfg['sandbox-notice-testcases-run-link-display'] = format('sandbox-notice-testcases-run-link-display') |
|||
-- cfg['sandbox-category'] |
|||
local function makeWikilink(page, display) |
|||
-- A category to add to all template sandboxes. |
|||
if display then |
|||
cfg['sandbox-category'] = 'Template sandboxes' |
|||
return mw.ustring.format('[[%s|%s]]', page, display) |
|||
else |
|||
return mw.ustring.format('[[%s]]', page) |
|||
end |
|||
end |
|||
---------------------------------------------------------------------------------------------------- |
|||
p.makeWikilink = makeWikilink |
|||
-- Start box configuration |
|||
---------------------------------------------------------------------------------------------------- |
|||
-- cfg['documentation-icon-wikitext'] |
|||
local function makeCategoryLink(cat, sort) |
|||
-- The wikitext for the icon shown at the top of the template. |
|||
local catns = mw.site.namespaces[14].name |
|||
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=Documentation icon]]' |
|||
return makeWikilink(catns .. ':' .. cat, sort) |
|||
end |
|||
---------------------------------------------------------------------------------------------------- |
|||
p.makeCategoryLink = makeCategoryLink |
|||
-- Link box (end box) configuration |
|||
---------------------------------------------------------------------------------------------------- |
|||
-- cfg['transcluded-from-blurb'] |
|||
local function makeUrlLink(url, display) |
|||
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page. |
|||
return mw.ustring.format('[%s %s]', url, display) |
|||
cfg['transcluded-from-blurb'] = format('transcluded-from-blurb') |
|||
end |
|||
--[[ |
|||
p.makeUrlLink = makeUrlLink |
|||
-- cfg['create-module-doc-blurb'] |
|||
-- Notice displayed in the module namespace when the documentation subpage does not exist. |
|||
-- $1 is a link to create the documentation page with the preload cfg['module-preload'] and the |
|||
-- display cfg['create-link-display']. |
|||
--]] |
|||
cfg['create-module-doc-blurb'] = format('create-module-doc-blurb') |
|||
---------------------------------------------------------------------------------------------------- |
|||
local function makeToolbar(...) |
|||
-- Experiment blurb configuration |
|||
local ret = {} |
|||
---------------------------------------------------------------------------------------------------- |
|||
local lim = select('#', ...) |
|||
if lim < 1 then |
|||
return nil |
|||
end |
|||
for i = 1, lim do |
|||
ret[#ret + 1] = select(i, ...) |
|||
end |
|||
-- 'documentation-toolbar' |
|||
return '<span class="' .. message('toolbar-class') .. '">(' |
|||
.. table.concat(ret, ' | ') .. ')</span>' |
|||
end |
|||
--[[ |
|||
p.makeToolbar = makeToolbar |
|||
-- cfg['experiment-blurb-template'] |
|||
-- cfg['experiment-blurb-module'] |
|||
-- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages. |
|||
-- It is only shown in the template and module namespaces. With the default English settings, it |
|||
-- might look like this: |
|||
-- |
|||
-- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages. |
|||
-- |
|||
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links. |
|||
-- |
|||
-- There are two versions, cfg['experiment-blurb-template'] and cfg['experiment-blurb-module'], depending |
|||
-- on what namespace we are in. |
|||
-- |
|||
-- Parameters: |
|||
-- |
|||
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format: |
|||
-- |
|||
-- cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display']) |
|||
-- |
|||
-- If the sandbox doesn't exist, it is in the format: |
|||
-- |
|||
-- 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'] |
|||
-- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display'] |
|||
-- loads a default edit summary of cfg['mirror-edit-summary']. |
|||
-- |
|||
-- $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']) |
|||
-- |
|||
-- If the test cases page doesn't exist, it is in the format: |
|||
-- |
|||
-- 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 |
|||
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current |
|||
-- namespace. |
|||
--]] |
|||
cfg['experiment-blurb-template'] = format('experiment-blurb-template') |
|||
cfg['experiment-blurb-module'] = format('experiment-blurb-module') |
|||
---------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- Sandbox link configuration |
|||
-- Argument processing |
|||
---------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg['sandbox-subpage'] |
|||
local function makeInvokeFunc(funcName) |
|||
-- The name of the template subpage typically used for sandboxes. |
|||
return function (frame) |
|||
cfg['sandbox-subpage'] = 'sandbox' |
|||
local args = getArgs(frame, { |
|||
valueFunc = function (key, value) |
|||
if type(value) == 'string' then |
|||
value = value:match('^%s*(.-)%s*$') -- Remove whitespace. |
|||
if key == 'heading' or value ~= '' then |
|||
return value |
|||
else |
|||
return nil |
|||
end |
|||
else |
|||
return value |
|||
end |
|||
end |
|||
}) |
|||
return p[funcName](args) |
|||
end |
|||
end |
|||
-- cfg['template-sandbox-preload'] |
|||
---------------------------------------------------------------------------- |
|||
-- Preload file for template sandbox pages. |
|||
-- Entry points |
|||
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox' |
|||
---------------------------------------------------------------------------- |
|||
-- cfg['module-sandbox-preload'] |
|||
function p.nonexistent(frame) |
|||
-- Preload file for Lua module sandbox pages. |
|||
if mw.title.getCurrentTitle().subpageText == 'testcases' then |
|||
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox' |
|||
return frame:expandTemplate{title = 'module test cases notice'} |
|||
else |
|||
return p.main(frame) |
|||
end |
|||
end |
|||
-- cfg['sandbox-link-display'] |
|||
p.main = makeInvokeFunc('_main') |
|||
-- The text to display for "sandbox" links. |
|||
cfg['sandbox-link-display'] = format('sandbox-link-display') |
|||
-- cfg['sandbox-edit-link-display'] |
|||
function p._main(args) |
|||
-- The text to display for sandbox "edit" links. |
|||
--[[ |
|||
cfg['sandbox-edit-link-display'] = format('sandbox-edit-link-display') |
|||
-- This function defines logic flow for the module. |
|||
-- @args - table of arguments passed by the user |
|||
--]] |
|||
local env = p.getEnvironment(args) |
|||
local root = mw.html.create() |
|||
root |
|||
:wikitext(p._getModuleWikitext(args, env)) |
|||
-- :wikitext(p.protectionTemplate(env)) |
|||
:wikitext(p.sandboxNotice(args, env)) |
|||
:tag('div') |
|||
-- 'documentation-container' |
|||
:addClass(message('container')) |
|||
:newline() |
|||
:tag('div') |
|||
-- 'documentation' |
|||
:addClass(message('main-div-classes')) |
|||
:newline() |
|||
:wikitext(p._startBox(args, env)) |
|||
:wikitext(p._content(args, env)) |
|||
:tag('div') |
|||
-- 'documentation-clear' |
|||
:addClass(message('clear')) |
|||
:done() |
|||
:newline() |
|||
:done() |
|||
:wikitext(p._endBox(args, env)) |
|||
:done() |
|||
:wikitext(p.addTrackingCategories(env)) |
|||
-- 'Module:Documentation/styles.css' |
|||
return mw.getCurrentFrame():extensionTag ( |
|||
'templatestyles', '', {src=cfg['templatestyles'] |
|||
}) .. tostring(root) |
|||
end |
|||
-- cfg['sandbox-create-link-display'] |
|||
---------------------------------------------------------------------------- |
|||
-- The text to display for sandbox "create" links. |
|||
-- Environment settings |
|||
cfg['sandbox-create-link-display'] = format('sandbox-create-link-display') |
|||
---------------------------------------------------------------------------- |
|||
-- cfg['compare-link-display'] |
|||
function p.getEnvironment(args) |
|||
-- The text to display for "compare" links. |
|||
--[[ |
|||
cfg['compare-link-display'] = format('compare-link-display') |
|||
-- Returns a table with information about the environment, including title |
|||
-- objects and other namespace- or path-related data. |
|||
-- @args - table of arguments passed by the user |
|||
-- |
|||
-- Title objects include: |
|||
-- env.title - the page we are making documentation for (usually the current title) |
|||
-- env.templateTitle - the template (or module, file, etc.) |
|||
-- env.docTitle - the /doc subpage. |
|||
-- env.sandboxTitle - the /sandbox subpage. |
|||
-- env.testcasesTitle - the /testcases subpage. |
|||
-- env.printTitle - the print version of the template, located at the /Print subpage. |
|||
-- |
|||
-- Data includes: |
|||
-- env.protectionLevels - the protection levels table of the title object. |
|||
-- env.subjectSpace - the number of the title's subject namespace. |
|||
-- env.docSpace - the number of the namespace the title puts its documentation in. |
|||
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace. |
|||
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template. |
|||
-- |
|||
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value |
|||
-- returned will be nil. |
|||
--]] |
|||
local env, envFuncs = {}, {} |
|||
-- cfg['mirror-edit-summary'] |
|||
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value |
|||
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the |
|||
-- returned by that function is memoized in the env table so that we don't call any of the functions |
|||
-- template page. |
|||
-- more than once. (Nils won't be memoized.) |
|||
cfg['mirror-edit-summary'] = 'Create sandbox version of $1' |
|||
setmetatable(env, { |
|||
__index = function (t, key) |
|||
local envFunc = envFuncs[key] |
|||
if envFunc then |
|||
local success, val = pcall(envFunc) |
|||
if success then |
|||
env[key] = val -- Memoise the value. |
|||
return val |
|||
end |
|||
end |
|||
return nil |
|||
end |
|||
}) |
|||
-- cfg['mirror-link-display'] |
|||
function envFuncs.title() |
|||
-- The text to display for "mirror" links. |
|||
-- The title object for the current page, or a test page passed with args.page. |
|||
cfg['mirror-link-display'] = format('mirror-link-display') |
|||
local title |
|||
local titleArg = args.page |
|||
if titleArg then |
|||
title = mw.title.new(titleArg) |
|||
else |
|||
title = mw.title.getCurrentTitle() |
|||
end |
|||
return title |
|||
end |
|||
-- cfg['mirror-link-preload'] |
|||
function envFuncs.templateTitle() |
|||
-- The page to preload when a user clicks the "mirror" link. |
|||
--[[ |
|||
cfg['mirror-link-preload'] = 'Template:Documentation/mirror' |
|||
-- The template (or module, etc.) title object. |
|||
-- Messages: |
|||
-- 'sandbox-subpage' --> 'sandbox' |
|||
-- 'testcases-subpage' --> 'testcases' |
|||
--]] |
|||
local subjectSpace = env.subjectSpace |
|||
local title = env.title |
|||
local subpage = title.subpageText |
|||
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then |
|||
return mw.title.makeTitle(subjectSpace, title.baseText) |
|||
else |
|||
return mw.title.makeTitle(subjectSpace, title.text) |
|||
end |
|||
end |
|||
---------------------------------------------------------------------------------------------------- |
|||
function envFuncs.docTitle() |
|||
-- Test cases link configuration |
|||
--[[ |
|||
---------------------------------------------------------------------------------------------------- |
|||
-- Title object of the /doc subpage. |
|||
-- Messages: |
|||
-- 'doc-subpage' --> 'doc' |
|||
--]] |
|||
local title = env.title |
|||
local docname = args[1] -- User-specified doc page. |
|||
local docpage |
|||
if docname then |
|||
docpage = docname |
|||
else |
|||
docpage = env.docpageBase .. '/' .. message('doc-subpage') |
|||
end |
|||
return mw.title.new(docpage) |
|||
end |
|||
function envFuncs.sandboxTitle() |
|||
--[[ |
|||
-- Title object for the /sandbox subpage. |
|||
-- Messages: |
|||
-- 'sandbox-subpage' --> 'sandbox' |
|||
--]] |
|||
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage')) |
|||
end |
|||
function envFuncs.testcasesTitle() |
|||
--[[ |
|||
-- Title object for the /testcases subpage. |
|||
-- Messages: |
|||
-- 'testcases-subpage' --> 'testcases' |
|||
--]] |
|||
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage')) |
|||
end |
|||
function envFuncs.printTitle() |
|||
--[[ |
|||
-- Title object for the /Print subpage. |
|||
-- Messages: |
|||
-- 'print-subpage' --> 'Print' |
|||
--]] |
|||
return env.templateTitle:subPageTitle(message('print-subpage')) |
|||
end |
|||
-- cfg['testcases-subpage'] |
|||
function envFuncs.protectionLevels() |
|||
-- The name of the template subpage typically used for test cases. |
|||
-- The protection levels table of the title object. |
|||
cfg['testcases-subpage'] = 'testcases' |
|||
return env.title.protectionLevels |
|||
end |
|||
-- cfg['template-testcases-preload'] |
|||
function envFuncs.subjectSpace() |
|||
-- Preload file for template test cases pages. |
|||
-- The subject namespace number. |
|||
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases' |
|||
return mw.site.namespaces[env.title.namespace].subject.id |
|||
end |
|||
-- cfg['module-testcases-preload'] |
|||
function envFuncs.docSpace() |
|||
-- Preload file for Lua module test cases pages. |
|||
-- The documentation namespace number. For most namespaces this is the |
|||
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases' |
|||
-- same as the subject namespace. However, pages in the Article, File, |
|||
-- MediaWiki or Category namespaces must have their /doc, /sandbox and |
|||
-- /testcases pages in talk space. |
|||
local subjectSpace = env.subjectSpace |
|||
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then |
|||
return subjectSpace + 1 |
|||
else |
|||
return subjectSpace |
|||
end |
|||
end |
|||
-- cfg['testcases-link-display'] |
|||
function envFuncs.docpageBase() |
|||
-- The text to display for "testcases" links. |
|||
cfg['testcases-link-display'] = format('testcases-link-display') |
|||
-- For some namespaces this is the talk page, rather than the template page. |
|||
local templateTitle = env.templateTitle |
|||
local docSpace = env.docSpace |
|||
local docSpaceText = mw.site.namespaces[docSpace].name |
|||
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon. |
|||
return docSpaceText .. ':' .. templateTitle.text |
|||
end |
|||
function envFuncs.compareUrl() |
|||
-- Diff link between the sandbox and the main template using [[Special:ComparePages]]. |
|||
local templateTitle = env.templateTitle |
|||
local sandboxTitle = env.sandboxTitle |
|||
if templateTitle.exists and sandboxTitle.exists then |
|||
local compareUrl = mw.uri.fullUrl( |
|||
'Special:ComparePages', |
|||
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText} |
|||
) |
|||
return tostring(compareUrl) |
|||
else |
|||
return nil |
|||
end |
|||
end |
|||
-- cfg['testcases-edit-link-display'] |
|||
return env |
|||
-- The text to display for test cases "edit" links. |
|||
end |
|||
cfg['testcases-edit-link-display'] = format('testcases-edit-link-display') |
|||
-- cfg['testcases-create-link-display'] |
|||
---------------------------------------------------------------------------- |
|||
-- The text to display for test cases "create" links. |
|||
-- Auxiliary templates |
|||
cfg['testcases-create-link-display'] = format('testcases-create-link-display') |
|||
---------------------------------------------------------------------------- |
|||
---------------------------------------------------------------------------------------------------- |
|||
p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext') |
|||
-- Add categories blurb configuration |
|||
---------------------------------------------------------------------------------------------------- |
|||
--[[ |
|||
function p._getModuleWikitext(args, env) |
|||
-- cfg['add-categories-blurb'] |
|||
local currentTitle = mw.title.getCurrentTitle() |
|||
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or |
|||
if currentTitle.contentModel ~= 'Scribunto' then return end |
|||
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a |
|||
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care |
|||
-- link to the /doc subpage with a display value of cfg['doc-link-display']. |
|||
local moduleWikitext = package.loaded["Module:Module wikitext"] |
|||
--]] |
|||
if moduleWikitext then |
|||
cfg['add-categories-blurb'] = format('add-categories-blurb') |
|||
return moduleWikitext.main() |
|||
end |
|||
end |
|||
-- cfg['doc-link-display'] |
|||
function p.sandboxNotice(args, env) |
|||
-- The text to display when linking to the /doc subpage. |
|||
--[=[ |
|||
cfg['doc-link-display'] = '/doc' |
|||
-- Generates a sandbox notice for display above sandbox pages. |
|||
-- @args - a table of arguments passed by the user |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- |
|||
-- Messages: |
|||
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]' |
|||
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.' |
|||
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).' |
|||
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page' |
|||
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page' |
|||
-- 'sandbox-notice-pagetype-other' --> 'sandbox page' |
|||
-- 'sandbox-notice-compare-link-display' --> 'diff' |
|||
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.' |
|||
-- 'sandbox-notice-testcases-link-display' --> 'test cases' |
|||
-- 'sandbox-category' --> 'Template sandboxes' |
|||
--]=] |
|||
local title = env.title |
|||
local sandboxTitle = env.sandboxTitle |
|||
local templateTitle = env.templateTitle |
|||
local subjectSpace = env.subjectSpace |
|||
if not (subjectSpace and title and sandboxTitle and templateTitle |
|||
and mw.title.equals(title, sandboxTitle)) then |
|||
return nil |
|||
end |
|||
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text". |
|||
local omargs = {} |
|||
omargs.image = message('sandbox-notice-image') |
|||
-- Get the text. We start with the opening blurb, which is something like |
|||
-- "This is the template sandbox for [[Template:Foo]] (diff)." |
|||
local text = '' |
|||
local pagetype |
|||
if subjectSpace == 10 then |
|||
pagetype = message('sandbox-notice-pagetype-template') |
|||
elseif subjectSpace == 828 then |
|||
pagetype = message('sandbox-notice-pagetype-module') |
|||
else |
|||
pagetype = message('sandbox-notice-pagetype-other') |
|||
end |
|||
local templateLink = makeWikilink(templateTitle.prefixedText) |
|||
local compareUrl = env.compareUrl |
|||
if compareUrl then |
|||
local compareDisplay = message('sandbox-notice-compare-link-display') |
|||
local compareLink = makeUrlLink(compareUrl, compareDisplay) |
|||
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink}) |
|||
else |
|||
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink}) |
|||
end |
|||
-- Get the test cases page blurb if the page exists. This is something like |
|||
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]." |
|||
local testcasesTitle = env.testcasesTitle |
|||
if testcasesTitle and testcasesTitle.exists then |
|||
if testcasesTitle.contentModel == "Scribunto" then |
|||
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display') |
|||
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display') |
|||
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay) |
|||
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay) |
|||
text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink}) |
|||
else |
|||
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display') |
|||
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay) |
|||
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink}) |
|||
end |
|||
end |
|||
-- Add the sandbox to the sandbox category. |
|||
omargs.text = text .. makeCategoryLink(message('sandbox-category')) |
|||
---------------------------------------------------------------------------------------------------- |
|||
-- 'documentation-clear' |
|||
-- Subpages link configuration |
|||
return '<div class="' .. message('clear') .. '"></div>' |
|||
---------------------------------------------------------------------------------------------------- |
|||
.. require('Module:Message box').main('ombox', omargs) |
|||
end |
|||
--[[ |
|||
function p.protectionTemplate(env) |
|||
-- cfg['subpages-blurb'] |
|||
-- Generates the padlock icon in the top right. |
|||
-- The "Subpages of this template" blurb. $1 is a link to the main template's subpages with a |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- display value of cfg['subpages-link-display']. In the English version this blurb is simply |
|||
-- Messages: |
|||
-- the link followed by a period, and the link display provides the actual text. |
|||
-- 'protection-template' --> 'pp-template' |
|||
--]] |
|||
-- 'protection-template-args' --> {docusage = 'yes'} |
|||
cfg['subpages-blurb'] = format('subpages-blurb') |
|||
local protectionLevels = env.protectionLevels |
|||
if not protectionLevels then |
|||
return nil |
|||
end |
|||
local editProt = protectionLevels.edit and protectionLevels.edit[1] |
|||
local moveProt = protectionLevels.move and protectionLevels.move[1] |
|||
if editProt then |
|||
-- The page is edit-protected. |
|||
return require('Module:Protection banner')._main{ |
|||
message('protection-reason-edit'), small = true |
|||
} |
|||
elseif moveProt and moveProt ~= 'autoconfirmed' then |
|||
-- The page is move-protected but not edit-protected. Exclude move |
|||
-- protection with the level "autoconfirmed", as this is equivalent to |
|||
-- no move protection at all. |
|||
return require('Module:Protection banner')._main{ |
|||
action = 'move', small = true |
|||
} |
|||
else |
|||
return nil |
|||
end |
|||
end |
|||
--[[ |
|||
---------------------------------------------------------------------------- |
|||
-- cfg['subpages-link-display'] |
|||
-- Start box |
|||
-- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'], |
|||
---------------------------------------------------------------------------- |
|||
-- cfg['module-pagetype'] or cfg['default-pagetype'], depending on whether the current page is in |
|||
-- the template namespace, the module namespace, or another namespace. |
|||
--]] |
|||
cfg['subpages-link-display'] = format('subpages-link-display') |
|||
-- cfg['template-pagetype'] |
|||
p.startBox = makeInvokeFunc('_startBox') |
|||
-- The pagetype to display for template pages. |
|||
cfg['template-pagetype'] = format('template-pagetype') |
|||
-- cfg['module-pagetype'] |
|||
function p._startBox(args, env) |
|||
-- The pagetype to display for Lua module pages. |
|||
--[[ |
|||
cfg['module-pagetype'] = format('module-pagetype') |
|||
-- This function generates the start box. |
|||
-- @args - a table of arguments passed by the user |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- |
|||
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make |
|||
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox |
|||
-- which generate the box HTML. |
|||
--]] |
|||
env = env or p.getEnvironment(args) |
|||
local links |
|||
local content = args.content |
|||
if not content or args[1] then |
|||
-- No need to include the links if the documentation is on the template page itself. |
|||
local linksData = p.makeStartBoxLinksData(args, env) |
|||
if linksData then |
|||
links = p.renderStartBoxLinks(linksData) |
|||
end |
|||
end |
|||
-- Generate the start box html. |
|||
local data = p.makeStartBoxData(args, env, links) |
|||
if data then |
|||
return p.renderStartBox(data) |
|||
else |
|||
-- User specified no heading. |
|||
return nil |
|||
end |
|||
end |
|||
-- cfg['default-pagetype'] |
|||
function p.makeStartBoxLinksData(args, env) |
|||
-- The pagetype to display for pages other than templates or Lua modules. |
|||
--[[ |
|||
cfg['default-pagetype'] = format('default-pagetype') |
|||
-- Does initial processing of data to make the [view] [edit] [history] [purge] links. |
|||
-- @args - a table of arguments passed by the user |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- |
|||
-- Messages: |
|||
-- 'view-link-display' --> 'view' |
|||
-- 'edit-link-display' --> 'edit' |
|||
-- 'history-link-display' --> 'history' |
|||
-- 'purge-link-display' --> 'purge' |
|||
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace' |
|||
-- 'module-preload' --> 'Template:Documentation/preload-module-doc' |
|||
-- 'docpage-preload' --> 'Template:Documentation/preload' |
|||
-- 'create-link-display' --> 'create' |
|||
--]] |
|||
local subjectSpace = env.subjectSpace |
|||
local title = env.title |
|||
local docTitle = env.docTitle |
|||
if not title or not docTitle then |
|||
return nil |
|||
end |
|||
if docTitle.isRedirect then |
|||
docTitle = docTitle.redirectTarget |
|||
end |
|||
---------------------------------------------------------------------------------------------------- |
|||
local data = {} |
|||
-- Doc link configuration |
|||
data.title = title |
|||
---------------------------------------------------------------------------------------------------- |
|||
data.docTitle = docTitle |
|||
-- View, display, edit, and purge links if /doc exists. |
|||
data.viewLinkDisplay = message('view-link-display') |
|||
data.editLinkDisplay = message('edit-link-display') |
|||
data.historyLinkDisplay = message('history-link-display') |
|||
data.purgeLinkDisplay = message('purge-link-display') |
|||
-- Create link if /doc doesn't exist. |
|||
local preload = args.preload |
|||
if not preload then |
|||
if subjectSpace == 6 then -- File namespace |
|||
preload = message('file-docpage-preload') |
|||
elseif subjectSpace == 828 then -- Module namespace |
|||
preload = message('module-preload') |
|||
else |
|||
preload = message('docpage-preload') |
|||
end |
|||
end |
|||
data.preload = preload |
|||
data.createLinkDisplay = message('create-link-display') |
|||
return data |
|||
end |
|||
-- cfg['doc-subpage'] |
|||
function p.renderStartBoxLinks(data) |
|||
-- The name of the subpage typically used for documentation pages. |
|||
--[[ |
|||
cfg['doc-subpage'] = 'doc' |
|||
-- Generates the [view][edit][history][purge] or [create] links from the data table. |
|||
-- @data - a table of data generated by p.makeStartBoxLinksData |
|||
--]] |
|||
local function escapeBrackets(s) |
|||
-- Escapes square brackets with HTML entities. |
|||
s = s:gsub('%[', '[') -- Replace square brackets with HTML entities. |
|||
s = s:gsub('%]', ']') |
|||
return s |
|||
end |
|||
-- cfg['file-docpage-preload'] |
|||
local ret |
|||
-- Preload file for documentation page in the file namespace. |
|||
local docTitle = data.docTitle |
|||
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace' |
|||
local title = data.title |
|||
if docTitle.exists then |
|||
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay) |
|||
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay) |
|||
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay) |
|||
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay) |
|||
ret = '[%s] [%s] [%s] [%s]' |
|||
ret = escapeBrackets(ret) |
|||
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink) |
|||
else |
|||
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay) |
|||
ret = '[%s]' |
|||
ret = escapeBrackets(ret) |
|||
ret = mw.ustring.format(ret, createLink) |
|||
end |
|||
return ret |
|||
end |
|||
-- cfg['docpage-preload'] |
|||
function p.makeStartBoxData(args, env, links) |
|||
-- Preload file for template documentation pages in all namespaces. |
|||
--[=[ |
|||
cfg['docpage-preload'] = 'Template:Documentation/preload' |
|||
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox. |
|||
-- @args - a table of arguments passed by the user |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error. |
|||
-- |
|||
-- Messages: |
|||
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]' |
|||
-- 'template-namespace-heading' --> 'Template documentation' |
|||
-- 'module-namespace-heading' --> 'Module documentation' |
|||
-- 'file-namespace-heading' --> 'Summary' |
|||
-- 'other-namespaces-heading' --> 'Documentation' |
|||
-- 'testcases-create-link-display' --> 'create' |
|||
--]=] |
|||
local subjectSpace = env.subjectSpace |
|||
if not subjectSpace then |
|||
-- Default to an "other namespaces" namespace, so that we get at least some output |
|||
-- if an error occurs. |
|||
subjectSpace = 2 |
|||
end |
|||
local data = {} |
|||
-- Heading |
|||
local heading = args.heading -- Blank values are not removed. |
|||
if heading == '' then |
|||
-- Don't display the start box if the heading arg is defined but blank. |
|||
return nil |
|||
end |
|||
if heading then |
|||
data.heading = heading |
|||
elseif subjectSpace == 10 then -- Template namespace |
|||
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading') |
|||
elseif subjectSpace == 828 then -- Module namespace |
|||
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading') |
|||
elseif subjectSpace == 6 then -- File namespace |
|||
data.heading = message('file-namespace-heading') |
|||
else |
|||
data.heading = message('other-namespaces-heading') |
|||
end |
|||
-- Heading CSS |
|||
local headingStyle = args['heading-style'] |
|||
if headingStyle then |
|||
data.headingStyleText = headingStyle |
|||
else |
|||
-- 'documentation-heading' |
|||
data.headingClass = message('main-div-heading-class') |
|||
end |
|||
-- Data for the [view][edit][history][purge] or [create] links. |
|||
if links then |
|||
-- 'mw-editsection-like plainlinks' |
|||
data.linksClass = message('start-box-link-classes') |
|||
data.links = links |
|||
end |
|||
return data |
|||
end |
|||
-- cfg['module-preload'] |
|||
function p.renderStartBox(data) |
|||
-- Preload file for Lua module documentation pages. |
|||
-- Renders the start box html. |
|||
cfg['module-preload'] = 'Template:Documentation/preload-module-doc' |
|||
-- @data - a table of data generated by p.makeStartBoxData. |
|||
local sbox = mw.html.create('div') |
|||
sbox |
|||
-- 'documentation-startbox' |
|||
:addClass(message('start-box-class')) |
|||
:newline() |
|||
:tag('span') |
|||
:addClass(data.headingClass) |
|||
:cssText(data.headingStyleText) |
|||
:wikitext(data.heading) |
|||
local links = data.links |
|||
if links then |
|||
sbox:tag('span') |
|||
:addClass(data.linksClass) |
|||
:attr('id', data.linksId) |
|||
:wikitext(links) |
|||
end |
|||
return tostring(sbox) |
|||
end |
|||
---------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- Print version configuration |
|||
-- Documentation content |
|||
---------------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------- |
||
-- cfg['print-subpage'] |
|||
p.content = makeInvokeFunc('_content') |
|||
-- The name of the template subpage used for print versions. |
|||
cfg['print-subpage'] = 'Print' |
|||
-- cfg['print-link-display'] |
|||
function p._content(args, env) |
|||
-- The text to display when linking to the /Print subpage. |
|||
-- Displays the documentation contents |
|||
cfg['print-link-display'] = '/Print' |
|||
-- @args - a table of arguments passed by the user |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
env = env or p.getEnvironment(args) |
|||
local docTitle = env.docTitle |
|||
local content = args.content |
|||
if not content and docTitle and docTitle.exists then |
|||
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText} |
|||
end |
|||
-- The line breaks below are necessary so that "=== Headings ===" at the start and end |
|||
-- of docs are interpreted correctly. |
|||
return '\n' .. (content or '') .. '\n' |
|||
end |
|||
-- cfg['print-blurb'] |
|||
p.contentTitle = makeInvokeFunc('_contentTitle') |
|||
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display']. |
|||
cfg['print-blurb'] = format('print-blurb') |
|||
-- cfg['display-print-category'] |
|||
function p._contentTitle(args, env) |
|||
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists. |
|||
env = env or p.getEnvironment(args) |
|||
-- This should be a boolean value (either true or false). |
|||
local docTitle = env.docTitle |
|||
cfg['display-print-category'] = true |
|||
if not args.content and docTitle and docTitle.exists then |
|||
return docTitle.prefixedText |
|||
else |
|||
return '' |
|||
end |
|||
end |
|||
-- cfg['print-category'] |
|||
---------------------------------------------------------------------------- |
|||
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists. |
|||
-- End box |
|||
cfg['print-category'] = 'Templates with print versions' |
|||
---------------------------------------------------------------------------- |
|||
---------------------------------------------------------------------------------------------------- |
|||
p.endBox = makeInvokeFunc('_endBox') |
|||
-- HTML and CSS configuration |
|||
---------------------------------------------------------------------------------------------------- |
|||
-- cfg['main-div-id'] |
|||
function p._endBox(args, env) |
|||
-- The "id" attribute of the main HTML "div" tag. |
|||
--[=[ |
|||
cfg['main-div-id'] = 'template-documentation' |
|||
-- This function generates the end box (also known as the link box). |
|||
-- @args - a table of arguments passed by the user |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- |
|||
--]=] |
|||
-- Get environment data. |
|||
env = env or p.getEnvironment(args) |
|||
local subjectSpace = env.subjectSpace |
|||
local docTitle = env.docTitle |
|||
if not subjectSpace or not docTitle then |
|||
return nil |
|||
end |
|||
-- Check whether we should output the end box at all. Add the end |
|||
-- box by default if the documentation exists or if we are in the |
|||
-- user, module or template namespaces. |
|||
local linkBox = args['link box'] |
|||
if linkBox == 'off' |
|||
or not ( |
|||
docTitle.exists |
|||
or subjectSpace == 2 |
|||
or subjectSpace == 828 |
|||
or subjectSpace == 10 |
|||
) |
|||
then |
|||
return nil |
|||
end |
|||
-- cfg['main-div-classes'] |
|||
-- Assemble the link box. |
|||
-- The CSS classes added to the main HTML "div" tag. |
|||
local text = '' |
|||
cfg['main-div-class'] = 'ts-doc-doc' |
|||
if linkBox then |
|||
cfg['header-div-class'] = 'ts-doc-header' |
|||
text = text .. linkBox |
|||
cfg['heading-div-class'] = 'ts-doc-heading' |
|||
else |
|||
cfg['content-div-class'] = 'ts-doc-content' |
|||
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." |
|||
cfg['footer-div-class'] = 'ts-doc-footer plainlinks' |
|||
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then |
|||
-- We are in the user, template or module namespaces. |
|||
-- Add sandbox and testcases links. |
|||
-- "Editors can experiment in this template's sandbox and testcases pages." |
|||
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />' |
|||
if not args.content and not args[1] then |
|||
-- "Please add categories to the /doc subpage." |
|||
-- Don't show this message with inline docs or with an explicitly specified doc page, |
|||
-- as then it is unclear where to add the categories. |
|||
text = text .. (p.makeCategoriesBlurb(args, env) or '') |
|||
end |
|||
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template" |
|||
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates. |
|||
if printBlurb then |
|||
text = text .. '<br />' .. printBlurb |
|||
end |
|||
end |
|||
end |
|||
local box = mw.html.create('div') |
|||
-- 'documentation-metadata' |
|||
box:attr('role', 'note') |
|||
:addClass(message('end-box-class')) |
|||
-- 'plainlinks' |
|||
:addClass(message('end-box-plainlinks')) |
|||
:wikitext(text) |
|||
:done() |
|||
cfg['sandbox-class'] = 'ts-doc-sandbox' |
|||
return '\n' .. tostring(box) |
|||
end |
|||
-- cfg['start-box-linkclasses'] |
|||
function p.makeDocPageBlurb(args, env) |
|||
-- The CSS classes used for the [view][edit][history] or [create] links in the start box. |
|||
--[=[ |
|||
cfg['start-box-linkclasses'] = 'ts-tlinks-tlinks mw-editsection-like plainlinks' |
|||
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)". |
|||
-- @args - a table of arguments passed by the user |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- |
|||
-- Messages: |
|||
-- 'edit-link-display' --> 'edit' |
|||
-- 'history-link-display' --> 'history' |
|||
-- 'transcluded-from-blurb' --> |
|||
-- 'The above [[Wikipedia:Template documentation|documentation]] |
|||
-- is [[Help:Transclusion|transcluded]] from $1.' |
|||
-- 'module-preload' --> 'Template:Documentation/preload-module-doc' |
|||
-- 'create-link-display' --> 'create' |
|||
-- 'create-module-doc-blurb' --> |
|||
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].' |
|||
--]=] |
|||
local docTitle = env.docTitle |
|||
if not docTitle then |
|||
return nil |
|||
end |
|||
local ret |
|||
if docTitle.exists then |
|||
-- /doc exists; link to it. |
|||
local docLink = makeWikilink(docTitle.prefixedText) |
|||
local editUrl = docTitle:fullUrl{action = 'edit'} |
|||
local editDisplay = message('edit-link-display') |
|||
local editLink = makeUrlLink(editUrl, editDisplay) |
|||
local historyUrl = docTitle:fullUrl{action = 'history'} |
|||
local historyDisplay = message('history-link-display') |
|||
local historyLink = makeUrlLink(historyUrl, historyDisplay) |
|||
ret = message('transcluded-from-blurb', {docLink}) |
|||
.. ' ' |
|||
.. makeToolbar(editLink, historyLink) |
|||
.. '<br />' |
|||
elseif env.subjectSpace == 828 then |
|||
-- /doc does not exist; ask to create it. |
|||
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')} |
|||
local createDisplay = message('create-link-display') |
|||
local createLink = makeUrlLink(createUrl, createDisplay) |
|||
ret = message('create-module-doc-blurb', {createLink}) |
|||
.. '<br />' |
|||
end |
|||
return ret |
|||
end |
|||
-- cfg['start-box-link-id'] |
|||
function p.makeExperimentBlurb(args, env) |
|||
-- The HTML "id" attribute for the links in the start box. |
|||
--[[ |
|||
cfg['start-box-link-id'] = 'doc_editlinks' |
|||
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages." |
|||
-- @args - a table of arguments passed by the user |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- |
|||
-- Messages: |
|||
-- 'sandbox-link-display' --> 'sandbox' |
|||
-- 'sandbox-edit-link-display' --> 'edit' |
|||
-- 'compare-link-display' --> 'diff' |
|||
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox' |
|||
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox' |
|||
-- 'sandbox-create-link-display' --> 'create' |
|||
-- 'mirror-edit-summary' --> 'Create sandbox version of $1' |
|||
-- 'mirror-link-display' --> 'mirror' |
|||
-- 'mirror-link-preload' --> 'Template:Documentation/mirror' |
|||
-- 'sandbox-link-display' --> 'sandbox' |
|||
-- 'testcases-link-display' --> 'testcases' |
|||
-- 'testcases-edit-link-display'--> 'edit' |
|||
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox' |
|||
-- 'testcases-create-link-display' --> 'create' |
|||
-- 'testcases-link-display' --> 'testcases' |
|||
-- 'testcases-edit-link-display' --> 'edit' |
|||
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases' |
|||
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases' |
|||
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.' |
|||
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.' |
|||
--]] |
|||
local subjectSpace = env.subjectSpace |
|||
local templateTitle = env.templateTitle |
|||
local sandboxTitle = env.sandboxTitle |
|||
local testcasesTitle = env.testcasesTitle |
|||
local templatePage = templateTitle.prefixedText |
|||
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then |
|||
return nil |
|||
end |
|||
-- Make links. |
|||
local sandboxLinks, testcasesLinks |
|||
if sandboxTitle.exists then |
|||
local sandboxPage = sandboxTitle.prefixedText |
|||
local sandboxDisplay = message('sandbox-link-display') |
|||
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay) |
|||
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'} |
|||
local sandboxEditDisplay = message('sandbox-edit-link-display') |
|||
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay) |
|||
local compareUrl = env.compareUrl |
|||
local compareLink |
|||
if compareUrl then |
|||
local compareDisplay = message('compare-link-display') |
|||
compareLink = makeUrlLink(compareUrl, compareDisplay) |
|||
end |
|||
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink) |
|||
else |
|||
local sandboxPreload |
|||
if subjectSpace == 828 then |
|||
sandboxPreload = message('module-sandbox-preload') |
|||
else |
|||
sandboxPreload = message('template-sandbox-preload') |
|||
end |
|||
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload} |
|||
local sandboxCreateDisplay = message('sandbox-create-link-display') |
|||
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay) |
|||
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)}) |
|||
local mirrorPreload = message('mirror-link-preload') |
|||
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary} |
|||
if subjectSpace == 828 then |
|||
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary} |
|||
end |
|||
local mirrorDisplay = message('mirror-link-display') |
|||
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay) |
|||
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink) |
|||
end |
|||
if testcasesTitle.exists then |
|||
local testcasesPage = testcasesTitle.prefixedText |
|||
local testcasesDisplay = message('testcases-link-display') |
|||
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay) |
|||
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'} |
|||
local testcasesEditDisplay = message('testcases-edit-link-display') |
|||
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay) |
|||
-- for Modules, add testcases run link if exists |
|||
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then |
|||
local testcasesRunLinkDisplay = message('testcases-run-link-display') |
|||
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay) |
|||
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink) |
|||
else |
|||
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink) |
|||
end |
|||
else |
|||
local testcasesPreload |
|||
if subjectSpace == 828 then |
|||
testcasesPreload = message('module-testcases-preload') |
|||
else |
|||
testcasesPreload = message('template-testcases-preload') |
|||
end |
|||
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload} |
|||
local testcasesCreateDisplay = message('testcases-create-link-display') |
|||
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay) |
|||
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink) |
|||
end |
|||
local messageName |
|||
if subjectSpace == 828 then |
|||
messageName = 'experiment-blurb-module' |
|||
else |
|||
messageName = 'experiment-blurb-template' |
|||
end |
|||
return message(messageName, {sandboxLinks, testcasesLinks}) |
|||
end |
|||
---------------------------------------------------------------------------------------------------- |
|||
function p.makeCategoriesBlurb(args, env) |
|||
-- Tracking category configuration |
|||
--[[ |
|||
---------------------------------------------------------------------------------------------------- |
|||
-- Generates the text "Please add categories to the /doc subpage." |
|||
-- @args - a table of arguments passed by the user |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- Messages: |
|||
-- 'doc-link-display' --> '/doc' |
|||
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.' |
|||
--]] |
|||
local docTitle = env.docTitle |
|||
if not docTitle then |
|||
return nil |
|||
end |
|||
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display')) |
|||
return message('add-categories-blurb', {docPathLink}) |
|||
end |
|||
-- cfg['display-strange-usage-category'] |
|||
function p.makeSubpagesBlurb(args, env) |
|||
-- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage |
|||
--[[ |
|||
-- or a /testcases subpage. This should be a boolean value (either true or false). |
|||
-- Generates the "Subpages of this template" link. |
|||
cfg['display-strange-usage-category'] = true |
|||
-- @args - a table of arguments passed by the user |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- Messages: |
|||
-- 'template-pagetype' --> 'template' |
|||
-- 'module-pagetype' --> 'module' |
|||
-- 'default-pagetype' --> 'page' |
|||
-- 'subpages-link-display' --> 'Subpages of this $1' |
|||
--]] |
|||
local subjectSpace = env.subjectSpace |
|||
local templateTitle = env.templateTitle |
|||
if not subjectSpace or not templateTitle then |
|||
return nil |
|||
end |
|||
local pagetype |
|||
if subjectSpace == 10 then |
|||
pagetype = message('template-pagetype') |
|||
elseif subjectSpace == 828 then |
|||
pagetype = message('module-pagetype') |
|||
else |
|||
pagetype = message('default-pagetype') |
|||
end |
|||
local subpagesLink = makeWikilink( |
|||
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/', |
|||
message('subpages-link-display', {pagetype}) |
|||
) |
|||
return message('subpages-blurb', {subpagesLink}) |
|||
end |
|||
-- cfg['strange-usage-category'] |
|||
function p.makePrintBlurb(args, env) |
|||
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a |
|||
--[=[ |
|||
-- /doc subpage or a /testcases subpage. |
|||
-- Generates the blurb displayed when there is a print version of the template available. |
|||
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage' |
|||
-- @args - a table of arguments passed by the user |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- |
|||
-- Messages: |
|||
-- 'print-link-display' --> '/Print' |
|||
-- '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.' |
|||
-- 'display-print-category' --> true |
|||
-- 'print-category' --> 'Templates with print versions' |
|||
--]=] |
|||
local printTitle = env.printTitle |
|||
if not printTitle then |
|||
return nil |
|||
end |
|||
local ret |
|||
if printTitle.exists then |
|||
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display')) |
|||
ret = message('print-blurb', {printLink}) |
|||
local displayPrintCategory = message('display-print-category', nil, 'boolean') |
|||
if displayPrintCategory then |
|||
ret = ret .. makeCategoryLink(message('print-category')) |
|||
end |
|||
end |
|||
return ret |
|||
end |
|||
--[[ |
|||
---------------------------------------------------------------------------- |
|||
---------------------------------------------------------------------------------------------------- |
|||
-- Tracking categories |
|||
-- End configuration |
|||
---------------------------------------------------------------------------- |
|||
-- |
|||
-- Don't edit anything below this line. |
|||
function p.addTrackingCategories(env) |
|||
---------------------------------------------------------------------------------------------------- |
|||
--[[ |
|||
--]] |
|||
-- Check if {{documentation}} is transcluded on a /doc or /testcases page. |
|||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment |
|||
-- Messages: |
|||
-- 'display-strange-usage-category' --> true |
|||
-- 'doc-subpage' --> 'doc' |
|||
-- 'testcases-subpage' --> 'testcases' |
|||
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage' |
|||
-- |
|||
-- /testcases pages in the module namespace are not categorised, as they may have |
|||
-- {{documentation}} transcluded automatically. |
|||
--]] |
|||
local title = env.title |
|||
local subjectSpace = env.subjectSpace |
|||
if not title or not subjectSpace then |
|||
return nil |
|||
end |
|||
local subpage = title.subpageText |
|||
local ret = '' |
|||
if message('display-strange-usage-category', nil, 'boolean') |
|||
and ( |
|||
subpage == message('doc-subpage') |
|||
or subjectSpace ~= 828 and subpage == message('testcases-subpage') |
|||
) |
|||
then |
|||
ret = ret .. makeCategoryLink(message('strange-usage-category')) |
|||
end |
|||
return ret |
|||
end |
|||
return |
return cfg |
Revision as of 22:15, 31 July 2021
Documentation for this module may be created at Module:Documentation/config/doc
----------------------------------------------------------------------------------------------------
--
-- Configuration for Module:Documentation
--
-- Here you can set the values of the parameters and messages used in Module:Documentation to
-- localise it to your wiki and your language. Unless specified otherwise, values given here
-- 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.
cfg['templatestyles-scr'] = 'Module:Documentation/styles.css'
----------------------------------------------------------------------------------------------------
-- 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']
-- The protection reason for edit-protected templates to pass to
-- [[Module:Protection banner]].
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'}
--[[
----------------------------------------------------------------------------------------------------
-- 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['sandbox-subpage']. The following settings configure the
-- messages that the notices contains.
----------------------------------------------------------------------------------------------------
--]]
-- cfg['sandbox-notice-image']
-- The image displayed in the sandbox notice.
cfg['sandbox-notice-image'] = '[[Image:Edit In Sandbox Icon - Color.svg|40px|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'] = format('sandbox-notice-pagetype-template')
cfg['sandbox-notice-pagetype-module'] = format('sandbox-notice-pagetype-module')
cfg['sandbox-notice-pagetype-other'] = format('sandbox-notice-pagetype-other')
--[[
-- cfg['sandbox-notice-blurb']
-- 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'] = format('sandbox-notice-blurb')
cfg['sandbox-notice-diff-blurb'] = format('sandbox-notice-diff-blurb')
cfg['sandbox-notice-compare-link-display'] = format('sandbox-notice-compare-link-display')
--[[
-- cfg['sandbox-notice-testcases-blurb']
-- 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'] = format('sandbox-notice-testcases-blurb')
cfg['sandbox-notice-testcases-link-display'] = format('sandbox-notice-testcases-link-display')
cfg['sandbox-notice-testcases-run-blurb'] = format('sandbox-notice-testcases-run-blurb')
cfg['sandbox-notice-testcases-run-link-display'] = format('sandbox-notice-testcases-run-link-display')
-- cfg['sandbox-category']
-- A category to add to all template sandboxes.
cfg['sandbox-category'] = 'Template sandboxes'
----------------------------------------------------------------------------------------------------
-- Start box configuration
----------------------------------------------------------------------------------------------------
-- cfg['documentation-icon-wikitext']
-- 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]]'
----------------------------------------------------------------------------------------------------
-- Link box (end box) configuration
----------------------------------------------------------------------------------------------------
-- cfg['transcluded-from-blurb']
-- 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['create-module-doc-blurb']
-- Notice displayed in the module namespace when the documentation subpage does not exist.
-- $1 is a link to create the documentation page with the preload cfg['module-preload'] and the
-- display cfg['create-link-display'].
--]]
cfg['create-module-doc-blurb'] = format('create-module-doc-blurb')
----------------------------------------------------------------------------------------------------
-- Experiment blurb configuration
----------------------------------------------------------------------------------------------------
--[[
-- cfg['experiment-blurb-template']
-- cfg['experiment-blurb-module']
-- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages.
-- It is only shown in the template and module namespaces. With the default English settings, it
-- might look like this:
--
-- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
--
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
--
-- There are two versions, cfg['experiment-blurb-template'] and cfg['experiment-blurb-module'], depending
-- on what namespace we are in.
--
-- Parameters:
--
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:
--
-- cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display'])
--
-- If the sandbox doesn't exist, it is in the format:
--
-- 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']
-- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display']
-- loads a default edit summary of cfg['mirror-edit-summary'].
--
-- $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'])
--
-- If the test cases page doesn't exist, it is in the format:
--
-- 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
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current
-- namespace.
--]]
cfg['experiment-blurb-template'] = format('experiment-blurb-template')
cfg['experiment-blurb-module'] = format('experiment-blurb-module')
----------------------------------------------------------------------------------------------------
-- Sandbox link configuration
----------------------------------------------------------------------------------------------------
-- cfg['sandbox-subpage']
-- The name of the template subpage typically used for sandboxes.
cfg['sandbox-subpage'] = 'sandbox'
-- cfg['template-sandbox-preload']
-- Preload file for template sandbox pages.
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'
-- cfg['module-sandbox-preload']
-- Preload file for Lua module sandbox pages.
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'
-- cfg['sandbox-link-display']
-- The text to display for "sandbox" links.
cfg['sandbox-link-display'] = format('sandbox-link-display')
-- cfg['sandbox-edit-link-display']
-- The text to display for sandbox "edit" links.
cfg['sandbox-edit-link-display'] = format('sandbox-edit-link-display')
-- cfg['sandbox-create-link-display']
-- The text to display for sandbox "create" links.
cfg['sandbox-create-link-display'] = format('sandbox-create-link-display')
-- cfg['compare-link-display']
-- The text to display for "compare" links.
cfg['compare-link-display'] = format('compare-link-display')
-- cfg['mirror-edit-summary']
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
-- template page.
cfg['mirror-edit-summary'] = 'Create sandbox version of $1'
-- cfg['mirror-link-display']
-- The text to display for "mirror" links.
cfg['mirror-link-display'] = format('mirror-link-display')
-- cfg['mirror-link-preload']
-- The page to preload when a user clicks the "mirror" link.
cfg['mirror-link-preload'] = 'Template:Documentation/mirror'
----------------------------------------------------------------------------------------------------
-- Test cases link configuration
----------------------------------------------------------------------------------------------------
-- cfg['testcases-subpage']
-- The name of the template subpage typically used for test cases.
cfg['testcases-subpage'] = 'testcases'
-- cfg['template-testcases-preload']
-- Preload file for template test cases pages.
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'
-- cfg['module-testcases-preload']
-- Preload file for Lua module test cases pages.
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'
-- cfg['testcases-link-display']
-- The text to display for "testcases" links.
cfg['testcases-link-display'] = format('testcases-link-display')
-- cfg['testcases-edit-link-display']
-- The text to display for test cases "edit" links.
cfg['testcases-edit-link-display'] = format('testcases-edit-link-display')
-- cfg['testcases-create-link-display']
-- The text to display for test cases "create" links.
cfg['testcases-create-link-display'] = format('testcases-create-link-display')
----------------------------------------------------------------------------------------------------
-- Add categories blurb configuration
----------------------------------------------------------------------------------------------------
--[[
-- cfg['add-categories-blurb']
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a
-- link to the /doc subpage with a display value of cfg['doc-link-display'].
--]]
cfg['add-categories-blurb'] = format('add-categories-blurb')
-- cfg['doc-link-display']
-- The text to display when linking to the /doc subpage.
cfg['doc-link-display'] = '/doc'
----------------------------------------------------------------------------------------------------
-- Subpages link configuration
----------------------------------------------------------------------------------------------------
--[[
-- cfg['subpages-blurb']
-- The "Subpages of this template" blurb. $1 is a link to the main template's subpages with a
-- display value of cfg['subpages-link-display']. In the English version this blurb is simply
-- the link followed by a period, and the link display provides the actual text.
--]]
cfg['subpages-blurb'] = format('subpages-blurb')
--[[
-- cfg['subpages-link-display']
-- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'],
-- cfg['module-pagetype'] or cfg['default-pagetype'], depending on whether the current page is in
-- the template namespace, the module namespace, or another namespace.
--]]
cfg['subpages-link-display'] = format('subpages-link-display')
-- cfg['template-pagetype']
-- The pagetype to display for template pages.
cfg['template-pagetype'] = format('template-pagetype')
-- cfg['module-pagetype']
-- The pagetype to display for Lua module pages.
cfg['module-pagetype'] = format('module-pagetype')
-- cfg['default-pagetype']
-- The pagetype to display for pages other than templates or Lua modules.
cfg['default-pagetype'] = format('default-pagetype')
----------------------------------------------------------------------------------------------------
-- Doc link configuration
----------------------------------------------------------------------------------------------------
-- cfg['doc-subpage']
-- The name of the subpage typically used for documentation pages.
cfg['doc-subpage'] = 'doc'
-- cfg['file-docpage-preload']
-- Preload file for documentation page in the file namespace.
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'
-- cfg['docpage-preload']
-- Preload file for template documentation pages in all namespaces.
cfg['docpage-preload'] = 'Template:Documentation/preload'
-- cfg['module-preload']
-- Preload file for Lua module documentation pages.
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'
----------------------------------------------------------------------------------------------------
-- Print version configuration
----------------------------------------------------------------------------------------------------
-- cfg['print-subpage']
-- The name of the template subpage used for print versions.
cfg['print-subpage'] = 'Print'
-- cfg['print-link-display']
-- The text to display when linking to the /Print subpage.
cfg['print-link-display'] = '/Print'
-- 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'].
cfg['print-blurb'] = format('print-blurb')
-- cfg['display-print-category']
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
-- This should be a boolean value (either true or false).
cfg['display-print-category'] = true
-- cfg['print-category']
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
cfg['print-category'] = 'Templates with print versions'
----------------------------------------------------------------------------------------------------
-- HTML and CSS configuration
----------------------------------------------------------------------------------------------------
-- cfg['main-div-id']
-- The "id" attribute of the main HTML "div" tag.
cfg['main-div-id'] = 'template-documentation'
-- cfg['main-div-classes']
-- The CSS classes added to the main HTML "div" tag.
cfg['main-div-class'] = 'ts-doc-doc'
cfg['header-div-class'] = 'ts-doc-header'
cfg['heading-div-class'] = 'ts-doc-heading'
cfg['content-div-class'] = 'ts-doc-content'
cfg['footer-div-class'] = 'ts-doc-footer plainlinks'
cfg['sandbox-class'] = 'ts-doc-sandbox'
-- cfg['start-box-linkclasses']
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
cfg['start-box-linkclasses'] = 'ts-tlinks-tlinks mw-editsection-like plainlinks'
-- cfg['start-box-link-id']
-- The HTML "id" attribute for the links in the start box.
cfg['start-box-link-id'] = 'doc_editlinks'
----------------------------------------------------------------------------------------------------
-- Tracking category configuration
----------------------------------------------------------------------------------------------------
-- cfg['display-strange-usage-category']
-- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage
-- or a /testcases subpage. This should be a boolean value (either true or false).
cfg['display-strange-usage-category'] = true
-- cfg['strange-usage-category']
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a
-- /doc subpage or a /testcases subpage.
cfg['strange-usage-category'] = 'Wikipedia pages with strange ((documentation)) usage'
--[[
----------------------------------------------------------------------------------------------------
-- End configuration
--
-- Don't edit anything below this line.
----------------------------------------------------------------------------------------------------
--]]
return cfg