Open Mower Wiki - User contributions [en]

Template:Note/doc

2025-05-15T16:37:21Z

Clemens Elflein: 1 revision imported

{{Documentation subpage}}

{{TemplateData header|editlinks=1|docpage=Note/doc}}
<templatedata>
{
"format": "block",
"description": {
"en": "Show a note in a box (e.g. a top-of-the-page warning).",
"es": "Muestra una nota en un recuadro (p. ej. un aviso en la parte superior de la página).",
"cs": "Zobrazí poznámku v poli (např. upozornění v horní části stránky)",
"tr": "Bir kutuda bir not gösterin (ör. sayfanın üstü uyarısı).",
"fr": "Affiche une note dans une boîte (exemple : un avertissement en haut de la page).",
"pt-br": "Exibe uma nota em uma caixa (como um aviso no topo de uma página)."
},
"params": {
"inline": {
"label": {
"en": "Inline formatting",
"es": "Formato en una sola línea",
"fr": "format une ligne",
"cs": "Inline formátování",
"tr": "Satır içi biçimlendirme",
"pt-br": "Formatação em linha"
},
"description": {
"en": "Show the template without line breaks before and after it.",
"es": "Muestra la plantilla sin saltos de línea antes y después de ésta.",
"fr": "affiche le modèle sans les sauts de ligne, ni avant, ni après.",
"cs": "Zobrazí šablonu bez zalomení řádků před a za ní.",
"tr": "Şablonu, öncesinde ve sonrasında satır kesmeleri olmadan gösterin.",
"pt-br": "Exibe a predefinição sem quebras de linha antes ou após."
},
"default": {
"en": "0",
"pt-br": "0"
},
"autovalue": "1",
"type": "boolean"
},
"type": {
"aliases": [
"2"
],
"label": {
"en": "Type",
"es": "Tipo",
"fr": "type de boîte",
"cs": "Typ",
"tr": "Tür",
"pt-br": "Tipo"
},
"description": {
"en": "One of “info”, “reminder”, “warn”, or “error”. This setting affects the color and icon.",
"es": "Uno de los siguientes: “info”, “reminder”, “warn”, o “error”. Este ajuste afecta al color y al icono.",
"fr": "une des valeurs suggérées. Modifie la couleur de la boîte et l'icône associée.",
"cs": "Jedna z možností “info”, “reminder”, “warn”, or “error” (informace, připomenutí, upozornění nebo chyba). Toto nastavení má vliv na barvu a ikonu.",
"tr": "“info”, “reminder”, “warn” veya “error” değerlerden biri. Bu ayar, rengi ve simgeyi etkiler.",
"pt-br": "Disponíveis: “info” (informação), “reminder” (lembrete), “warn” (aviso) e “error” (erro). Essa configuração afeta a cor e o ícone."
},
"suggestedvalues": [
"info",
"reminder",
"warn",
"error"
],
"default": {
"en": "info",
"pt-br": "info"
},
"type": "string"
},
"text": {
"aliases": [
"1",
"content"
],
"label": {
"en": "Text",
"es": "Texto",
"fr": "texte affiché",
"cs": "Text",
"tr": "Metin",
"pt-br": "Texto"
},
"description": {
"en": "Informative note.",
"es": "Nota informativa.",
"fr": "note d'information",
"cs": "Informativní poznámka.",
"tr": "Bilgilendirecek not.",
"pt-br": "Nota informativa."
},
"type": "content",
"required": true,
"example": {
"es": "Texto de la nota.",
"fr": "Texte de la note."
}
}
},
"paramOrder": [
"inline",
"type",
"text"
]
}
</templatedata>
<includeonly>{{Sandbox other||

[[Category:Notice templates{{#translation:}}]]
}}</includeonly>

Module:Effective protection level

2025-05-15T16:37:21Z

Clemens Elflein: 1 revision imported

local p = {}

-- Returns the permission required to perform a given action on a given title.
-- If no title is specified, the title of the page being displayed is used.
function p._main(action, pagename)
local title
if type(pagename) == 'table' and pagename.prefixedText then
title = pagename
elseif pagename then
title = mw.title.new(pagename)
else
title = mw.title.getCurrentTitle()
end
pagename = title.prefixedText
if action ~= 'edit' and action ~= 'move' and action ~= 'create' and action ~= 'upload' then
error( 'First parameter must be one of edit, move, create, upload', 2 )
end
if title.namespace == 8 then -- MediaWiki namespace
if title.contentModel == 'javascript' or title.contentModel == 'css' then -- site JS or CSS page
return 'interfaceadmin'
else -- any non-JS/CSS MediaWiki page
return 'sysop'
end
elseif title.namespace == 2 and title.isSubpage then
if title.contentModel == 'javascript' or title.contentModel == 'css' then -- user JS or CSS page
return 'interfaceadmin'
elseif title.contentModel == 'json' then -- user JSON page
return 'sysop'
end
end
local level = title.protectionLevels[action] and title.protectionLevels[action][1]
if level == 'sysop' or level == 'editprotected' then
return 'sysop'
elseif title.cascadingProtection.restrictions[action] and title.cascadingProtection.restrictions[action][1] then -- used by a cascading-protected page
return 'sysop'
elseif action == 'move' then
local blacklistentry = mw.ext.TitleBlacklist.test('edit', pagename) -- Testing action edit is correct, since this is for the source page. The target page name gets tested with action move.
if blacklistentry and not blacklistentry.params.autoconfirmed then
return 'sysop'
elseif title.namespace == 6 then
return 'sysop'
else
return 'autoconfirmed'
end
end
local blacklistentry = mw.ext.TitleBlacklist.test(action, pagename)
if blacklistentry then
if not blacklistentry.params.autoconfirmed then
return 'sysop'
else
return 'autoconfirmed'
end
elseif level == 'editsemiprotected' then -- create-semiprotected pages return this for some reason
return 'autoconfirmed'
elseif level then
return level
elseif action == 'upload' then
return 'uploader'
else
return '*'
end
end

setmetatable(p, { __index = function(t, k)
return function(frame)
return t._main(k, frame.args[1])
end
end })

return p

Template:Module other

2025-05-15T16:37:21Z

Clemens Elflein: 1 revision imported

{{#switch:

{{#if:{{{demospace|}}}
| {{lc: {{{demospace}}} }} 
| {{#ifeq:{{NAMESPACE}}|{{ns:Module}}
| module
| other
}}
}}
| module = {{{1|}}}
| other
| #default = {{{2|}}}
}}<noinclude>

{{documentation}}

</noinclude>

Template:Pp-template

2025-05-15T16:37:20Z

Clemens Elflein: 1 revision imported

<includeonly>{{#switch:{{#invoke:Effective protection level|edit|{{FULLPAGENAME}}}}
|*=[[Category:Pages with incorrect protection templates]]
|autoconfirmed={{#tag:indicator|[[File:Semi-protection-shackle-keyhole.svg|20px|link=Project:Protected page|alt=Permanently protected {{module other|module|template}}|This high-risk {{module other|module|template}} is permanently semi-protected to prevent vandalism]]|name="pp-default"}}[[Category:{{module other|Modules subject to page protection|Semi-protected templates}}|{{PAGENAME}}]]
|sysop={{#tag:indicator|[[File:Full-protection-shackle-keyhole.svg|20px|link=Project:Protected page|alt=Permanently protected {{module other|module|template}}|This high-risk {{module other|module|template}} is permanently protected to prevent vandalism]]|name="pp-default"}}[[Category:{{module other|Modules subject to page protection|Fully protected templates}}|{{PAGENAME}}]]
}}</includeonly><noinclude>
{{Documentation}}
</noinclude>

Template:Tl

2025-05-15T16:37:20Z

Clemens Elflein: 1 revision imported

{{((}}{{ll|Template:{{{1}}}|nsp=0}}{{))}}<noinclude>
{{documentation}}

</noinclude>

Template:))

2025-05-15T16:37:20Z

Clemens Elflein: 1 revision imported

<onlyinclude>}}</onlyinclude>

{{documentation}}

Template:((

2025-05-15T16:37:20Z

Clemens Elflein: 1 revision imported

<onlyinclude>{{</onlyinclude>

{{documentation}}

Template:Note/styles.css

2025-05-15T16:37:20Z

Clemens Elflein: 1 revision imported

.note {
background-position: left 7px top 50%;
padding: 0.5em 0.5em 0.5em 40px;
margin: 0.5em 0;
overflow: hidden;
background-color: #f8f9fa;
color: #333;
background-repeat: no-repeat;
border: 1px solid #ddd;
}
.note-inline {
display: inline-block;
vertical-align: middle;
}
.note-info {
background-color: #eaf3ff;
color: #333;
/* [[File:OOjs_UI_icon_information-progressive.svg]] */
background-image: url(https://upload.wikimedia.org/wikipedia/commons/e/ec/OOjs_UI_icon_information-progressive.svg);
background-size: 25px;
border-color: #a3caff;
padding-left: 40px;
min-height: 25px;
}
.note-reminder {
background-color: #fff9ea;
color: #333;
/* [[File:OOjs_UI_icon_lightbulb-yellow.svg]] */
background-image: url(https://upload.wikimedia.org/wikipedia/commons/a/a8/OOjs_UI_icon_lightbulb-yellow.svg);
background-size: 25px;
border-color: #fc3;
min-height: 25px;
}
.note-warn {
background-color: #fff9ea;
color: #333;
/* [[File:OOjs_UI_icon_alert-warning.svg]] */
background-image: url(https://upload.wikimedia.org/wikipedia/commons/3/3b/OOjs_UI_icon_alert-warning.svg);
background-size: 25px;
border-color: #fc3;
min-height: 25px;
}

.note-error {
background-color: #fee7e6;
color: #333;
/* [[File:OOjs_UI_icon_notice-destructive.svg]] */
background-image: url(https://upload.wikimedia.org/wikipedia/commons/b/bf/OOjs_UI_icon_notice-destructive.svg);
background-size: 25px;
border-color: #c33;
min-height: 25px;
}

@media screen {
html.skin-theme-clientpref-night .note {
background-color: transparent;
color: inherit;
}
}

@media screen and (prefers-color-scheme: dark) {
/* automatic mode */
html.skin-theme-clientpref-os .note {
background-color: transparent;
color: inherit;
}
}

Template:Note/en

2025-05-15T16:37:20Z

Clemens Elflein: 1 revision imported

<languages/>
<onlyinclude>{{#if: {{{1|{{{content|{{{text|{{{demo|<noinclude>demo</noinclude>}}}}}}}}}}}} | <templatestyles src="Note/styles.css" /><div role="note" class="note note-{{#switch: {{{2|{{{type|}}}}}}
|gotcha=error
|warning=warn
|notice=info
|=info
|#default={{{2|{{{type|}}}}}}
}} {{#ifeq:{{{inline|}}}|1|note-inline}}">{{{1|{{{content|{{{text}}}}}}}}}</div>
| [[File:OOjs UI icon lightbulb-yellow.svg|18px|alt=Note|link=]] '''Note:''' }}</onlyinclude>
{{documentation|content=
== Usage ==
<pre>
{{Note|text=Foo}}
{{Note|type=info|text=Foo}}
{{Note|type=reminder|text=Foo}}
{{Note|type=reminder|text=Multiple<br>lines<br>of<br>text}}
{{Note|type=warn|text=Foo}}
{{Note|type=error|text=Foo}}
{{Note}} Loose test

* Text {{Note|inline=1|text=Foo}}
</pre>
{{Note|text=Foo}}
{{Note|type=info|text=Foo}}
{{Note|type=reminder|text=Foo}}
{{Note|type=reminder|text=Multiple<br>lines<br>of<br>text}}
{{Note|type=warn|text=Foo}}
{{Note|type=error|text=Foo}}
{{Note}} Loose test

* Text {{Note|inline=1|text=Foo}}

== Parameters ==

{{Note/doc}}

== See also ==
* {{tl|warn}}, shortcut for this template with <code>type=warning</code>.
* {{tl|mbox}}, and in particular the namespace-agnostic {{tl|ombox}}, which by default resembles a typical "info" template.

}}
[[Category:Templates{{#translation:}}|{{PAGENAME}}]]

Module:Documentation/styles.css

2025-05-15T16:37:20Z

Clemens Elflein: 1 revision imported

.ts-doc-sandbox .mbox-image {
padding:.75em 0 .75em .75em;
}

.ts-doc-doc {
clear: both;
background-color: #eaf3ff;
color: var(--color-base, #202122);
border: 1px solid #a3caff;
margin-top: 1em;
border-top-left-radius: 2px;
border-top-right-radius: 2px;
}

.ts-doc-header {
background-color: #cbd6f6;
color: var(--color-base, #202122);
padding: .642857em 1em .5em;
border-top-left-radius: 2px;
border-top-right-radius: 2px;
}

.ts-doc-heading {
display: inline-block;
padding-left: 30px;
background: center left / 24px 24px no-repeat;
/* @noflip */
background-image: url( //upload.wikimedia.org/wikipedia/commons/f/fb/OOjs_UI_icon_puzzle-ltr.svg );
height: 24px;
line-height: 24px;
font-size: 13px;
font-weight: 600;
letter-spacing: 1px;
text-transform: uppercase;
}

.ts-doc-header .ts-tlinks-tlinks {
line-height: 24px;
margin-left: 0;
}

.ts-doc-header .ts-tlinks-tlinks a {
color: var(--color-progressive, #36c);
}

.ts-doc-header .ts-tlinks-tlinks a:active {
color: var(--color-progressive--active, #233566);
}

.ts-doc-header .ts-tlinks-tlinks a:visited {
color: var(--color-visited, #6a60b0);
}

.ts-doc-header .ts-tlinks-tlinks a:visited:active {
color: var(--color-visited--active, #233566);
}

.ts-doc-content {
padding: .214286em 1em;
}

.ts-doc-content:after {
content: '';
clear: both;
display: block;
}

.ts-doc-content > :first-child {
margin-top: .5em;
}

.ts-doc-content > :last-child {
margin-bottom: .5em;
}

.ts-doc-footer {
background-color: #eaf3ff;
color: var(--color-base, #202122);
border: 1px solid #a3caff;
padding: .214286em 1em;
margin-top: .214286em;
font-style: italic;
border-bottom-left-radius: 2px;
border-bottom-right-radius: 2px;
}

@media all and (min-width: 720px) {
.ts-doc-header .ts-tlinks-tlinks {
float: right;
}
}

html.skin-theme-clientpref-night .ts-doc-header {
background-color: #3056a9;
}

html.skin-theme-clientpref-night .ts-doc-heading {
background-image: url( '//upload.wikimedia.org/wikipedia/commons/d/d3/OOjs_UI_icon_puzzle-ltr-invert.svg' );
}

html.skin-theme-clientpref-night .ts-doc-doc,
html.skin-theme-clientpref-night .ts-doc-footer {
background-color: #1b223d;
}

@media screen and (prefers-color-scheme: dark) {
html.skin-theme-clientpref-os .ts-doc-header {
background-color: #3056a9;
}

html.skin-theme-clientpref-os .ts-doc-heading {
background-image: url( '//upload.wikimedia.org/wikipedia/commons/d/d3/OOjs_UI_icon_puzzle-ltr-invert.svg' );
}

html.skin-theme-clientpref-os .ts-doc-doc,
html.skin-theme-clientpref-os .ts-doc-footer {
background-color: #1b223d;
}
}

Module:Navbar/styles.css

2025-05-15T16:37:19Z

Clemens Elflein: 1 revision imported

/** {{Shared Template Warning}}
* This TemplateStyles page is separately used for [[Template:Navbar]]
* because of course there are two versions of the same template.
* Be careful when adjusting styles accordingly.
*/
.navbar {
display: inline;
font-size: 88%;
font-weight: normal;
}

.navbar ul {
display: inline;
white-space: nowrap;
}

.navbar li {
word-spacing: -0.125em;
}

/* Navbar styling when nested in navbox */
.navbox .navbar {
display: block;
font-size: 100%;
}

.navbox-title .navbar {
/* @noflip */
float: left;
/* @noflip */
text-align: left;
/* @noflip */
margin-right: 0.5em;
width: 6em;
}

Module:Documentation/i18n

2025-05-15T16:37:18Z

Clemens Elflein: 1 revision imported

local format = require('Module:TNT').format
local i18n = {}

i18n['cfg-error-msg-type'] = format('I18n/Documentation', 'cfg-error-msg-type')
i18n['cfg-error-msg-empty'] = format('I18n/Documentation', 'cfg-error-msg-empty')

-- cfg['template-namespace-heading']
-- The heading shown in the template namespace.
i18n['template-namespace-heading'] = format('I18n/Documentation', 'template-namespace-heading')

-- cfg['module-namespace-heading']
-- The heading shown in the module namespace.
i18n['module-namespace-heading'] = format('I18n/Documentation', 'module-namespace-heading')

-- cfg['file-namespace-heading']
-- The heading shown in the file namespace.
i18n['file-namespace-heading'] = format('I18n/Documentation', 'file-namespace-heading')

-- cfg['other-namespaces-heading']
-- The heading shown in other namespaces.
i18n['other-namespaces-heading'] = format('I18n/Documentation', 'other-namespaces-heading')

-- cfg['view-link-display']
-- The text to display for "view" links.
i18n['view-link-display'] = format('I18n/Documentation', 'view-link-display')

-- cfg['edit-link-display']
-- The text to display for "edit" links.
i18n['edit-link-display'] = format('I18n/Documentation', 'edit-link-display')

-- cfg['history-link-display']
-- The text to display for "history" links.
i18n['history-link-display'] = format('I18n/Documentation', 'history-link-display')

-- cfg['purge-link-display']
-- The text to display for "purge" links.
i18n['purge-link-display'] = format('I18n/Documentation', 'purge-link-display')

-- cfg['create-link-display']
-- The text to display for "create" links.
i18n['create-link-display'] = format('I18n/Documentation', 'create-link-display')

return i18n

Module:TNT

2025-05-15T16:37:18Z

Clemens Elflein: 1 revision imported

--
-- INTRO: (!!! DO NOT RENAME THIS PAGE !!!)
-- This module allows any template or module to be copy/pasted between
-- wikis without any translation changes. All translation text is stored
-- in the global Data:*.tab pages on Commons, and used everywhere.
--
-- SEE: https://www.mediawiki.org/wiki/Multilingual_Templates_and_Modules
--
-- ATTENTION:
-- Please do NOT rename this module - it has to be identical on all wikis.
-- This code is maintained at https://www.mediawiki.org/wiki/Module:TNT
-- Please do not modify it anywhere else, as it may get copied and override your changes.
-- Suggestions can be made at https://www.mediawiki.org/wiki/Module_talk:TNT
--
-- DESCRIPTION:
-- The "msg" function uses a Commons dataset to translate a message
-- with a given key (e.g. source-table), plus optional arguments
-- to the wiki markup in the current content language.
-- Use lang=xx to set language. Example:
--
-- {{#invoke:TNT | msg
-- | I18n/Template:Graphs.tab 
-- | source-table 
-- | param1 }} 
--
--
-- The "doc" function will generate the <templatedata> parameter documentation for templates.
-- This way all template parameters can be stored and localized in a single Commons dataset.
-- NOTE: "doc" assumes that all documentation is located in Data:Templatedata/* on Commons.
--
-- {{#invoke:TNT | doc | Graph:Lines }}
-- uses https://commons.wikimedia.org/wiki/Data:Templatedata/Graph:Lines.tab
-- if the current page is Template:Graph:Lines/doc
--

local p = {}
local i18nDataset = 'I18n/Module:TNT.tab'

-- Forward declaration of the local functions
local sanitizeDataset, loadData, link, formatMessage

function p.msg(frame)
local dataset, id
local params = {}
local lang = nil
for k, v in pairs(frame.args) do
if k == 1 then
dataset = mw.text.trim(v)
elseif k == 2 then
id = mw.text.trim(v)
elseif type(k) == 'number' then
params[k - 2] = mw.text.trim(v)
elseif k == 'lang' and v ~= '_' then
lang = mw.text.trim(v)
end
end
return formatMessage(dataset, id, params, lang)
end

-- Identical to p.msg() above, but used from other lua modules
-- Parameters: name of dataset, message key, optional arguments
-- Example with 2 params: format('I18n/Module:TNT', 'error_bad_msgkey', 'my-key', 'my-dataset')
function p.format(dataset, key, ...)
local checkType = require('libraryUtil').checkType
checkType('format', 1, dataset, 'string')
checkType('format', 2, key, 'string')
return formatMessage(dataset, key, {...})
end

-- Identical to p.msg() above, but used from other lua modules with the language param
-- Parameters: language code, name of dataset, message key, optional arguments
-- Example with 2 params: formatInLanguage('es', I18n/Module:TNT', 'error_bad_msgkey', 'my-key', 'my-dataset')
function p.formatInLanguage(lang, dataset, key, ...)
local checkType = require('libraryUtil').checkType
checkType('formatInLanguage', 1, lang, 'string')
checkType('formatInLanguage', 2, dataset, 'string')
checkType('formatInLanguage', 3, key, 'string')
return formatMessage(dataset, key, {...}, lang)
end

-- Obsolete function that adds a 'c:' prefix to the first param.
-- "Sandbox/Sample.tab" -> 'c:Data:Sandbox/Sample.tab'
function p.link(frame)
return link(frame.args[1])
end

function p.doc(frame)
local dataset = 'Templatedata/' .. sanitizeDataset(frame.args[1])
return frame:extensionTag('templatedata', p.getTemplateData(dataset)) ..
formatMessage(i18nDataset, 'edit_doc', {link(dataset)})
end

function p.getTemplateData(dataset)
-- TODO: add '_' parameter once lua starts reindexing properly for "all" languages
local data = loadData(dataset)
local names = {}
for _, field in ipairs(data.schema.fields) do
table.insert(names, field.name)
end

local numOnly = true
local params = {}
local paramOrder = {}
for _, row in ipairs(data.data) do
local newVal = {}
local name = nil
for pos, columnName in ipairs(names) do
if columnName == 'name' then
name = row[pos]
else
newVal[columnName] = row[pos]
end
end
if name then
if (
(type(name) ~= "number")
and (
(type(name) ~= "string")
or not string.match(name, "^%d+$")
)
) then
numOnly = false
end
params[name] = newVal
table.insert(paramOrder, name)
end
end

-- Work around json encoding treating {"1":{...}} as an [{...}]
if numOnly then
params['zzz123']=''
end

local json = mw.text.jsonEncode({
params=params,
paramOrder=paramOrder,
description=data.description,
})

if numOnly then
json = string.gsub(json,'"zzz123":"",?', "")
end

return json
end

-- Local functions

sanitizeDataset = function(dataset)
if not dataset then
return nil
end
dataset = mw.text.trim(dataset)
if dataset == '' then
return nil
elseif string.sub(dataset,-4) ~= '.tab' then
return dataset .. '.tab'
else
return dataset
end
end

loadData = function(dataset, lang)
dataset = sanitizeDataset(dataset)
if not dataset then
error(formatMessage(i18nDataset, 'error_no_dataset', {}))
end

-- Give helpful error to thirdparties who try and copy this module.
if not mw.ext or not mw.ext.data or not mw.ext.data.get then
error(string.format([['''Missing JsonConfig extension, or not properly configured;
Cannot load https://commons.wikimedia.org/wiki/Data:%s.
See https://www.mediawiki.org/wiki/Extension:JsonConfig#Supporting_Wikimedia_templates''']], dataset))
end

local data = mw.ext.data.get(dataset, lang)

if data == false then
if dataset == i18nDataset then
-- Prevent cyclical calls
error('Missing Commons dataset ' .. i18nDataset)
else
error(formatMessage(i18nDataset, 'error_bad_dataset', {link(dataset)}))
end
end
return data
end

-- Given a dataset name, convert it to a title with the 'commons:data:' prefix
link = function(dataset)
return 'c:Data:' .. mw.text.trim(dataset or '')
end

formatMessage = function(dataset, key, params, lang)
for _, row in pairs(loadData(dataset, lang).data) do
local id, msg = unpack(row)
if id == key then
local result = mw.message.newRawMessage(msg, unpack(params or {}))
return result:plain()
end
end
if dataset == i18nDataset then
-- Prevent cyclical calls
error('Invalid message key "' .. key .. '"')
else
error(formatMessage(i18nDataset, 'error_bad_msgkey', {key, link(dataset)}))
end
end

return p

Module:Documentation/config

2025-05-15T16:37:17Z

Clemens Elflein: 1 revision imported

----------------------------------------------------------------------------------------------------
--
-- 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'] = '[[File: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'] = false

-- 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'] = 'Pages with strange ((documentation)) usage'

--[[
----------------------------------------------------------------------------------------------------
-- End configuration
--
-- Don't edit anything below this line.
----------------------------------------------------------------------------------------------------
--]]

return cfg

Module:Documentation

2025-05-15T16:37:17Z

Clemens Elflein: 1 revision imported

-- This module implements {{documentation}}.

-- Get required modules.
local getArgs = require('Module:Arguments').getArgs
local messageBox = require('Module:Message box')

-- Get the config table.
local cfg = mw.loadData('Module:Documentation/config')
local i18n = mw.loadData('Module:Documentation/i18n')
local p = {}

-- Often-used functions.
local ugsub = mw.ustring.gsub

----------------------------------------------------------------------------
-- Helper functions
--
-- These are defined as local functions, but are made available in the p
-- table for testing purposes.
----------------------------------------------------------------------------

local function message(cfgKey, valArray, expectType)
--[[
-- 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(require('Module:TNT').format('I18n/Documentation', 'cfg-error-msg-type', cfgKey, expectType, type(msg)), 2)
end
if not valArray then
return msg
end

local function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error(require('Module:TNT').format('I18n/Documentation', 'cfg-error-msg-empty', '$' .. match, cfgKey), 4)
end

local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
return ret
end

p.message = message

local function makeWikilink(page, display)
if display then
return mw.ustring.format('[[%s|%s]]', page, display)
else
return mw.ustring.format('[[%s]]', page)
end
end

p.makeWikilink = makeWikilink

local function makeCategoryLink(cat, sort)
local catns = mw.site.namespaces[14].name
return makeWikilink(catns .. ':' .. cat, sort)
end

p.makeCategoryLink = makeCategoryLink

local function makeUrlLink(url, display)
return mw.ustring.format('[%s %s]', url, display)
end

p.makeUrlLink = makeUrlLink

local function makeToolbar(...)
local ret = {}
local lim = select('#', ...)
if lim < 1 then
return nil
end
for i = 1, lim do
ret[#ret + 1] = select(i, ...)
end
return '<small style="font-style: normal;">(' .. table.concat(ret, ' | ') .. ')</small>'
end

p.makeToolbar = makeToolbar

----------------------------------------------------------------------------
-- Argument processing
----------------------------------------------------------------------------

local function makeInvokeFunc(funcName)
return function (frame)
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

----------------------------------------------------------------------------
-- Load TemplateStyles
----------------------------------------------------------------------------

p.main = function(frame)
local parent = frame.getParent(frame)
local output = p._main(parent.args)
return frame:extensionTag{ name='templatestyles', args = { src= message('templatestyles-scr') } } .. output
end

----------------------------------------------------------------------------
-- Main function
----------------------------------------------------------------------------

function p._main(args)
--[[
-- This function defines logic flow for the module.
-- @args - table of arguments passed by the user
--
-- Messages:
-- 'main-div-id' --> 'template-documentation'
-- 'main-div-classes' --> 'template-documentation iezoomfix'
--]]
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))
-- This div tag is from {{documentation/start box}}, but moving it here
-- so that we don't have to worry about unclosed tags.
:tag('div')
:attr('id', message('main-div-id'))
:addClass(message('main-div-class'))
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:done()
:wikitext(p._endBox(args, env))
:wikitext(p.addTrackingCategories(env))
return tostring(root)
end

----------------------------------------------------------------------------
-- Environment settings
----------------------------------------------------------------------------

function p.getEnvironment(args)
--[[
-- 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 = {}, {}

-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
-- returned by that function is memoized in the env table so that we don't call any of the functions
-- more than once. (Nils won't be memoized.)
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
})

function envFuncs.title()
-- The title object for the current page, or a test page passed with args.page.
local title
local titleArg = args.page
if titleArg then
title = mw.title.new(titleArg)
else
title = mw.title.getCurrentTitle()
end
return title
end

function envFuncs.templateTitle()
--[[
-- 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()
--[[
-- 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

function envFuncs.protectionLevels()
-- The protection levels table of the title object.
return env.title.protectionLevels
end

function envFuncs.subjectSpace()
-- The subject namespace number.
return mw.site.namespaces[env.title.namespace].subject.id
end

function envFuncs.docSpace()
-- The documentation namespace number. For most namespaces this is the 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

function envFuncs.docpageBase()
-- The base page of the /doc, /sandbox, and /testcases subpages.
-- 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

return env
end

----------------------------------------------------------------------------
-- Auxiliary templates
----------------------------------------------------------------------------

p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')

function p._getModuleWikitext(args, env)
local currentTitle = mw.title.getCurrentTitle()
if currentTitle.contentModel ~= 'Scribunto' then return end
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care
local moduleWikitext = package.loaded["Module:Module wikitext"]
if moduleWikitext then
return moduleWikitext.main()
end
end

function p.sandboxNotice(args, env)
--[=[
-- 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' --> '[[w:Wikipedia:Template test cases|template sandbox]] page'
-- 'sandbox-notice-pagetype-module' --> '[[w: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 frame = mw.getCurrentFrame()
local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed.
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 isPreviewing or not compareUrl then
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
else
local compareDisplay = message('sandbox-notice-compare-link-display')
local compareLink = makeUrlLink(compareUrl, compareDisplay)
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
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.
text = text .. makeCategoryLink(message('sandbox-category'))
omargs.text = text
omargs.class = message('sandbox-class')
local ret = '<div style="clear: both;"></div>'
ret = ret .. messageBox.main('ombox', omargs)
return ret
end

function p.protectionTemplate(env)
-- Generates the padlock icon in the top right.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
local title = env.title
local protectionLevels
local protectionTemplate = message('protection-template')
local namespace = title.namespace
if not (protectionTemplate and (namespace == 10 or namespace == 828)) then
-- Don't display the protection template if we are not in the template or module namespaces.
return nil
end
protectionLevels = env.protectionLevels
if not protectionLevels then
return nil
end
local editLevels = protectionLevels.edit
local moveLevels = protectionLevels.move
if moveLevels and moveLevels[1] == 'sysop' or editLevels and editLevels[1] then
-- The page is full-move protected, or full, template, or semi-protected.
local frame = mw.getCurrentFrame()
return frame:expandTemplate{title = protectionTemplate, args = message('protection-template-args', nil, 'table')}
else
return nil
end
end

----------------------------------------------------------------------------
-- Start box
----------------------------------------------------------------------------

p.startBox = makeInvokeFunc('_startBox')

function p._startBox(args, env)
--[[
-- 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 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

function p.makeStartBoxLinksData(args, env)
--[[
-- 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 = {}
data.title = title
data.docTitle = docTitle
-- View, display, edit, and purge links if /doc exists.
data.viewLinkDisplay = i18n['view-link-display']
data.editLinkDisplay = i18n['edit-link-display']
data.historyLinkDisplay = i18n['history-link-display']
data.purgeLinkDisplay = i18n['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 = i18n['create-link-display']
return data
end

function p.renderStartBoxLinks(data)
--[[
-- 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

local ret
local docTitle = data.docTitle
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

function p.makeStartBoxData(args, env, links)
--[=[
-- 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=Documentation icon]]'
-- 'template-namespace-heading' --> 'Template documentation'
-- 'module-namespace-heading' --> 'Module documentation'
-- 'file-namespace-heading' --> 'Summary'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
-- 'start-box-link-id' --> 'doc_editlinks'
-- '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 = i18n['template-namespace-heading']
elseif subjectSpace == 828 then -- Module namespace
data.heading = i18n['module-namespace-heading']
elseif subjectSpace == 6 then -- File namespace
data.heading = i18n['file-namespace-heading']
else
data.heading = i18n['other-namespaces-heading']
end

-- Data for the [view][edit][history][purge] or [create] links.
if links then
data.linksClass = message('start-box-linkclasses')
data.linksId = message('start-box-link-id')
data.links = links
end

return data
end

function p.renderStartBox(data)
-- Renders the start box html.
-- @data - a table of data generated by p.makeStartBoxData.
local sbox = mw.html.create('div')
sbox
:addClass(message('header-div-class'))
:tag('div')
:addClass(message('heading-div-class'))
:wikitext(data.heading)
local links = data.links
if links then
sbox
:tag('div')
:addClass(data.linksClass)
:attr('id', data.linksId)
:wikitext(links)
end
return tostring(sbox)
end

----------------------------------------------------------------------------
-- Documentation content
----------------------------------------------------------------------------

p.content = makeInvokeFunc('_content')

function p._content(args, env)
-- Displays the documentation contents
-- @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}
end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- of docs are interpreted correctly.
local cbox = mw.html.create('div')
cbox
:addClass(message('content-div-class'))
:wikitext('\n' .. (content or '') .. '\n')
return tostring(cbox)
end

p.contentTitle = makeInvokeFunc('_contentTitle')

function p._contentTitle(args, env)
env = env or p.getEnvironment(args)
local docTitle = env.docTitle
if not args.content and docTitle and docTitle.exists then
return docTitle.prefixedText
else
return ''
end
end

----------------------------------------------------------------------------
-- End box
----------------------------------------------------------------------------

p.endBox = makeInvokeFunc('_endBox')

function p._endBox(args, env)
--[=[
-- 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

-- Assemble the footer text field.
local text = ''
if linkBox then
text = text .. linkBox
else
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]."
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 '')
text = text .. '<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 ebox = mw.html.create('div')
ebox
:addClass(message('footer-div-class'))
:wikitext(text)
return tostring(ebox)
end

function p.makeDocPageBlurb(args, env)
--[=[
-- 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 [[w:Wikipedia:Template documentation|documentation]]
-- is [[w:Wikipedia: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 [[w:Wikipedia:Lua|Scribunto module]].'
--]=]
local docTitle = env.docTitle
if not docTitle or args.content 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 = i18n['edit-link-display']
local editLink = makeUrlLink(editUrl, editDisplay)
local historyUrl = docTitle:fullUrl{action = 'history'}
local historyDisplay = i18n['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 = i18n['create-link-display']
local createLink = makeUrlLink(createUrl, createDisplay)
ret = message('create-module-doc-blurb', {createLink})
.. '<br />'
end
return ret
end

function p.makeExperimentBlurb(args, env)
--[[
-- 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}
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)
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
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)
--[[
-- 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

function p.makeSubpagesBlurb(args, env)
--[[
-- Generates the "Subpages of this template" link.
-- @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

function p.makePrintBlurb(args, env)
--[=[
-- Generates the blurb displayed when there is a print version of the template available.
-- @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
----------------------------------------------------------------------------

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 p

Template:Sandbox other

2025-05-15T16:37:16Z

Clemens Elflein: 1 revision imported

{{#switch:{{SUBPAGENAME}}|sandbox|doc={{{1|}}}|#default={{{2|}}}}}<noinclude>
{{documentation}}
</noinclude>

Template:Transclude

2025-05-15T16:37:16Z

Clemens Elflein: 1 revision imported

<onlyinclude>{{#switch: {{NAMESPACE: {{{1}}} }}
|#default = {{FULLPAGENAME: {{{1}}} }} 
|{{ns:0}} =
{{#ifeq: {{NAMESPACE: {{{1}}} }} | {{NAMESPACE: Template{{{1}}} }}
| Template:{{{1}}} 
| {{PAGENAME: {{{1}}} }} 
}}
}}</onlyinclude>
{{Documentation}}

Template:Yesno

2025-05-15T16:37:16Z

Clemens Elflein: 1 revision imported

{{<includeonly>safesubst:</includeonly>#switch: {{<includeonly>safesubst:</includeonly>lc: {{{1|¬}}} }}
|no
|n
|false
|0 = {{{no|}}}
| = {{{blank|{{{no|}}}}}}
|¬ = {{{¬|}}}
|yes
|y
|true
|1 = {{{yes|yes}}}
|#default = {{{def|{{{yes|yes}}}}}}
}}<noinclude>
{{Documentation}}
</noinclude>

Template:TemplateData header/en

2025-05-15T16:37:16Z

Clemens Elflein: 1 revision imported

<noinclude>
<languages/>
<onlyinclude>{{#switch:
|=
<div class="templatedata-header">{{#if:{{yesno|{{{editlinks|}}}}}|{{#ifexpr:{{#if:{{{docpage|}}}|{{#ifeq:{{FULLPAGENAME}}|{{transclude|{{{docpage}}}}}|0|1}}|not{{IsDocSubpage|false=0}}}}|{{Navbar|{{{docpage|{{BASEPAGENAME}}/doc}}}|plain=1|brackets=1|style=float:{{dir|{{PAGELANGUAGE}}|left|right}};}}}}}}
{{#if:{{{noheader|}}}||This is the [[Special:MyLanguage/Help:TemplateData|TemplateData]] documentation for this template used by [[Special:MyLanguage/VisualEditor|VisualEditor]] and other tools.}}

'''{{{1|{{BASEPAGENAME}}}}}'''
</div><includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||{{#if:{{IsDocSubpage|false=}}|[[Category:TemplateData documentation{{#translation:}}]]|[[Category:Templates using TemplateData{{#translation:}}]]}}}}</includeonly>
| #default=
{{#invoke:Template translation|renderTranslatedTemplate|template=Template:TemplateData header|noshift=1|uselang={{#if:{{pagelang}}|{{pagelang}}|{{int:lang}}}}}}
}}</onlyinclude>
{{Documentation|content=

Inserts a brief header for the template data section.
Adds the /doc subpage to {{ll|Category:TemplateData documentation}} and the template page to {{ll|Category:Templates using TemplateData}}.

== Usage ==
{{#tag:syntaxhighlight|
==TemplateData== or ==Parameters== or ==Usage==
{{((}}TemplateData header{{))}}
{{^(}}templatedata{{)^}}{
...
}{{^(}}/templatedata{{)^}}
|lang=html
}}

Use {{tmpl|0=<code>{{((}}TemplateData header{{!}}$1{{))}}</code>|Template name}} to display a name for the template other than the default, which is {{ll|Help:Magic words#Variables|<nowiki>{{BASEPAGENAME}}</nowiki>}}.

<dl><dd>
{{TemplateData header|Template name}}
</dd></dl>

Use <code><nowiki>{{TemplateData header|noheader=1}}</nowiki></code> to omit the first sentence of the header text.

<dl><dd>
{{TemplateData header|noheader=1}}
</dd></dl>

==Parameters==
{{TemplateData header/doc}}

}}
</noinclude>

Template:TemplateData header

2025-05-15T16:37:15Z

Clemens Elflein: 1 revision imported

<noinclude>
<languages/>
<onlyinclude>{{#switch:<translate></translate>
|=
<div class="templatedata-header">{{#if:{{yesno|{{{editlinks|}}}}}|{{#ifexpr:{{#if:{{{docpage|}}}|{{#ifeq:{{FULLPAGENAME}}|{{transclude|{{{docpage}}}}}|0|1}}|not{{IsDocSubpage|false=0}}}}|{{Navbar|{{{docpage|{{BASEPAGENAME}}/doc}}}|plain=1|brackets=1|style=float:{{dir|{{PAGELANGUAGE}}|left|right}};}}}}}}
{{#if:{{{noheader|}}}||<translate> This is the [[<tvar name=1>Special:MyLanguage/Help:TemplateData</tvar>|TemplateData]] documentation for this template used by [[<tvar name=2>Special:MyLanguage/VisualEditor</tvar>|VisualEditor]] and other tools.</translate>}}

'''{{{1|{{BASEPAGENAME}}}}}'''
</div><includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||{{#if:{{IsDocSubpage|false=}}|[[Category:TemplateData documentation{{#translation:}}]]|[[Category:Templates using TemplateData{{#translation:}}]]}}}}</includeonly>
| #default=
{{#invoke:Template translation|renderTranslatedTemplate|template=Template:TemplateData header|noshift=1|uselang={{#if:{{pagelang}}|{{pagelang}}|{{int:lang}}}}}}
}}</onlyinclude>
{{Documentation|content=

<translate> Inserts a brief header for the template data section.</translate>
<translate> Adds the <tvar name=1>/doc</tvar> subpage to <tvar name=2>{{ll|Category:TemplateData documentation}}</tvar> and the template page to <tvar name=3>{{ll|Category:Templates using TemplateData}}</tvar>.</translate>

<translate>
== Usage == 
</translate>
{{#tag:syntaxhighlight|
==TemplateData== or ==Parameters== or ==Usage==
{{((}}TemplateData header{{))}}
{{^(}}templatedata{{)^}}{
...
}{{^(}}/templatedata{{)^}}
|lang=html
}}

<translate>

Use {{<tvar name=1>tmpl|0=<code>{{((}}TemplateData header{{!}}$1{{))}}</code></tvar>|Template name}} to display a name for the template other than the default, which is <tvar name="2">{{ll|Help:Magic words#Variables|<nowiki>{{BASEPAGENAME}}</nowiki>}}</tvar>.
</translate>

<dl><dd>
{{TemplateData header|Template name}}
</dd></dl>

<translate>

Use <tvar name="1"><code><nowiki>{{TemplateData header|noheader=1}}</nowiki></code></tvar> to omit the first sentence of the header text.
</translate>

<dl><dd>
{{TemplateData header|noheader=1}}
</dd></dl>

<translate>
==Parameters== 
</translate>
{{TemplateData header/doc}}

}}
</noinclude>

Template:IsDocSubpage

2025-05-15T16:37:14Z

Clemens Elflein: 1 revision imported

<onlyinclude><includeonly>{{#ifexpr: (
{{#ifeq:{{lc:{{SUBPAGENAME}}}}|{{lc:{{{override|doc}}}}}|1|0}} or (
{{#ifeq:{{lc:{{#titleparts:{{FULLPAGENAME}}|-1|-2}}}}|{{lc:{{{override|doc}}}}}|1|0}}
and {{#if:{{#translation:}}|1|0}}
)
)|{{{true|1}}}|{{{false|}}}}}</includeonly></onlyinclude>
{{Documentation}}

Template:Documentation subpage/en

2025-05-15T16:37:13Z

Clemens Elflein: 1 revision imported

<noinclude>
<languages/>
</noinclude>{{#switch:
| =
<includeonly>{{#if:{{IsDocSubpage|override={{{override|doc}}}|false=}}
| 
</includeonly>{{#ifeq:{{{doc-notice|show}}} |show
| {{Mbox
| type = notice
| style = margin-bottom:1.0em;
| image = [[File:OOjs UI icon book-ltr.svg|40px|alt=|class=skin-invert]]
| text =
'''This is a [[w:Wikipedia:Template documentation|documentation]] [[Special:MyLanguage/Help:Subpages|subpage]] for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}.'''<br />{{#if:{{{text2|}}}{{{text1|}}}
|It contains usage information, [[Special:MyLanguage/Help:Categories|categories]] and other content that is not part of the original {{{text2|{{{text1}}}}}}.
|It contains usage information, [[Special:MyLanguage/Help:Categories|categories]] and other content that is not part of the original {{SUBJECTSPACE}} page.
}}
}}
}}{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}{{#if:{{{inhibit|}}} |
| <includeonly>{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}}
| [[Category:{{#switch:{{SUBJECTSPACE}}
| Template | Project = Template
| Module = Module
| User = User
| #default = MediaWiki
}} documentation pages{{#translation:}}]]
| [[Category:Documentation subpages without corresponding pages{{#translation:}}]]
}}</includeonly>
}}<includeonly>
| 
}}</includeonly>
| #default=
{{#invoke:Template translation|renderTranslatedTemplate|template=Template:Documentation subpage|noshift=1|uselang={{int:lang}}}}
}}<noinclude>
{{Documentation|content=

== Usage ==

Use this template on Template Documentation subpage (/doc).

== See also ==
*{{tl|Documentation}}
*{{tl|tl}}

}}
</noinclude>

Template:Documentation subpage

2025-05-15T16:37:13Z

Clemens Elflein: 1 revision imported

<noinclude>
<languages/>
</noinclude>{{#switch:<translate></translate>
| =
<includeonly>{{#if:{{IsDocSubpage|override={{{override|doc}}}|false=}}
| 
</includeonly>{{#ifeq:{{{doc-notice|show}}} |show
| {{Mbox
| type = notice
| style = margin-bottom:1.0em;
| image = [[File:OOjs UI icon book-ltr.svg|40px|alt=|class=skin-invert]]
| text =
'''<translate> This is a [[w:Wikipedia:Template documentation|documentation]] [[<tvar name=2>Special:MyLanguage/Help:Subpages</tvar>|subpage]] for <tvar name=1>{{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}</tvar>.</translate>'''<br />{{#if:{{{text2|}}}{{{text1|}}}
|<translate> It contains usage information, [[<tvar name=7>Special:MyLanguage/Help:Categories</tvar>|categories]] and other content that is not part of the original <tvar name=1>{{{text2|{{{text1}}}}}}</tvar>.</translate>
|<translate> It contains usage information, [[<tvar name=7>Special:MyLanguage/Help:Categories</tvar>|categories]] and other content that is not part of the original <tvar name=1>{{SUBJECTSPACE}}</tvar> page.</translate>
}}
}}
}}{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}{{#if:{{{inhibit|}}} |
| <includeonly>{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}}
| [[Category:{{#switch:{{SUBJECTSPACE}}
| Template | Project = Template
| Module = Module
| User = User
| #default = MediaWiki
}} documentation pages{{#translation:}}]]
| [[Category:Documentation subpages without corresponding pages{{#translation:}}]]
}}</includeonly>
}}<includeonly>
| 
}}</includeonly>
| #default=
{{#invoke:Template translation|renderTranslatedTemplate|template=Template:Documentation subpage|noshift=1|uselang={{int:lang}}}}
}}<noinclude>
{{Documentation|content=

<translate>
== Usage == 


Use this template on Template Documentation subpage (/doc).

== See also == 
</translate>
*{{tl|Documentation}}
*{{tl|tl}}

}}
</noinclude>

Template:Translatable/en

2025-05-15T16:37:13Z

Clemens Elflein: 1 revision imported

<noinclude>
<languages />
</noinclude>{{#ifeq:{{pagelang|{{{1|{{FULLPAGENAME}}}}}}}|
|{{{1|{{FULLPAGENAME}}}}}
|{{#invoke:String|sub|{{{1|{{FULLPAGENAME}}}}}
|1
|{{#expr:{{#invoke:String|len|{{{1|{{FULLPAGENAME}}}}}}}-{{#invoke:String|len|{{pagelang|{{{1|{{FULLPAGENAME}}}}}}}}}-1}}
}}
}}<noinclude>
{{Documentation|content=
{{Lua|Module:String}}

== Examples ==
* {{tlx|translatable}}
{{translatable}}
* {{tlx|translatable|2=Page name}}
{{translatable|1=Page name}}
* {{tlx|translatable|2=Page name/{{PAGELANGUAGE}} }}
{{translatable|1=Page name/{{PAGELANGUAGE}} }}
}}

[[Category:Internationalization templates{{#translation:}}]]
</noinclude>

Template:Documentation/en

2025-05-15T16:37:13Z

Clemens Elflein: 1 revision imported

<noinclude>
<languages/>
</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
{{documentation|content=

{{Lua|Module:Documentation}}
This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.
It is intended for pages which are [[Special:MyLanguage/Help:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.

== Usage ==

=== Customising display ===

Overrides exist to customise the output in special cases:
* <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> - change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.

== Rationale ==
This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation and categories.
It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[:en:Special:Diff/69888944|developer's explanation]]).

== See also ==
* [[w:Template:Documentation subpage]]
* {{tim|Documentation}}
* [[w:Wikipedia:Template documentation]]

}}
[[Category:Formatting templates{{#translation:}}|Template documentation]]
[[Category:Template documentation{{#translation:}}| ]]
</noinclude><includeonly>{{#if:{{{content|}}}|
[[Category:Template documentation pages{{#translation:}}]]
}}</includeonly>

Template:Documentation

2025-05-15T16:37:13Z

Clemens Elflein: 1 revision imported

<noinclude>
<languages/>
</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
{{documentation|content=

{{Lua|Module:Documentation}}
<translate> This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.</translate>
<translate> It is intended for pages which are [[<tvar name=1>Special:MyLanguage/Help:Transclusion</tvar>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.</translate>

<translate>
== Usage == 

=== Customising display === 


Overrides exist to customise the output in special cases:
</translate>
* <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> - <translate> change the text of the "documentation" heading.</translate> <translate> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.</translate>

<translate>
== Rationale == 
</translate>
<translate> This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation and categories.</translate>
<translate> It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[<tvar name=1>:en:Special:Diff/69888944</tvar>|developer's explanation]]).</translate>

<translate>
== See also == 
</translate>
* <translate> [[w:Template:Documentation subpage]]</translate>
* {{tim|Documentation}}
* <translate> [[w:Wikipedia:Template documentation]]</translate>

}}
[[Category:Formatting templates{{#translation:}}|Template documentation]]
[[Category:Template documentation{{#translation:}}| ]]
</noinclude><includeonly>{{#if:{{{content|}}}|
[[Category:Template documentation pages{{#translation:}}]]
}}</includeonly>

Module:Arguments

2025-05-15T16:37:13Z

Clemens Elflein: 1 revision imported

-- This module provides easy processing of arguments passed to Scribunto from
-- #invoke. It is intended for use by other Lua modules, and should not be
-- called from #invoke directly.

local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType

local arguments = {}

-- Generate four different tidyVal functions, so that we don't have to check the
-- options every time we call it.

local function tidyValDefault(key, val)
if type(val) == 'string' then
val = val:match('^%s*(.-)%s*$')
if val == '' then
return nil
else
return val
end
else
return val
end
end

local function tidyValTrimOnly(key, val)
if type(val) == 'string' then
return val:match('^%s*(.-)%s*$')
else
return val
end
end

local function tidyValRemoveBlanksOnly(key, val)
if type(val) == 'string' then
if val:find('%S') then
return val
else
return nil
end
else
return val
end
end

local function tidyValNoChange(key, val)
return val
end

local function matchesTitle(given, title)
local tp = type( given )
return (tp == 'string' or tp == 'number') and mw.title.new( given ).prefixedText == title
end

local translate_mt = { __index = function(t, k) return k end }

function arguments.getArgs(frame, options)
checkType('getArgs', 1, frame, 'table', true)
checkType('getArgs', 2, options, 'table', true)
frame = frame or {}
options = options or {}

--[[
-- Set up argument translation.
--]]
options.translate = options.translate or {}
if getmetatable(options.translate) == nil then
setmetatable(options.translate, translate_mt)
end
if options.backtranslate == nil then
options.backtranslate = {}
for k,v in pairs(options.translate) do
options.backtranslate[v] = k
end
end
if options.backtranslate and getmetatable(options.backtranslate) == nil then
setmetatable(options.backtranslate, {
__index = function(t, k)
if options.translate[k] ~= k then
return nil
else
return k
end
end
})
end

--[[
-- Get the argument tables. If we were passed a valid frame object, get the
-- frame arguments (fargs) and the parent frame arguments (pargs), depending
-- on the options set and on the parent frame's availability. If we weren't
-- passed a valid frame object, we are being called from another Lua module
-- or from the debug console, so assume that we were passed a table of args
-- directly, and assign it to a new variable (luaArgs).
--]]
local fargs, pargs, luaArgs
if type(frame.args) == 'table' and type(frame.getParent) == 'function' then
if options.wrappers then
--[[
-- The wrappers option makes Module:Arguments look up arguments in
-- either the frame argument table or the parent argument table, but
-- not both. This means that users can use either the #invoke syntax
-- or a wrapper template without the loss of performance associated
-- with looking arguments up in both the frame and the parent frame.
-- Module:Arguments will look up arguments in the parent frame
-- if it finds the parent frame's title in options.wrapper;
-- otherwise it will look up arguments in the frame object passed
-- to getArgs.
--]]
local parent = frame:getParent()
if not parent then
fargs = frame.args
else
local title = parent:getTitle():gsub('/sandbox$', '')
local found = false
if matchesTitle(options.wrappers, title) then
found = true
elseif type(options.wrappers) == 'table' then
for _,v in pairs(options.wrappers) do
if matchesTitle(v, title) then
found = true
break
end
end
end

-- We test for false specifically here so that nil (the default) acts like true.
if found or options.frameOnly == false then
pargs = parent.args
end
if not found or options.parentOnly == false then
fargs = frame.args
end
end
else
-- options.wrapper isn't set, so check the other options.
if not options.parentOnly then
fargs = frame.args
end
if not options.frameOnly then
local parent = frame:getParent()
pargs = parent and parent.args or nil
end
end
if options.parentFirst then
fargs, pargs = pargs, fargs
end
else
luaArgs = frame
end

-- Set the order of precedence of the argument tables. If the variables are
-- nil, nothing will be added to the table, which is how we avoid clashes
-- between the frame/parent args and the Lua args.
local argTables = {fargs}
argTables[#argTables + 1] = pargs
argTables[#argTables + 1] = luaArgs

--[[
-- Generate the tidyVal function. If it has been specified by the user, we
-- use that; if not, we choose one of four functions depending on the
-- options chosen. This is so that we don't have to call the options table
-- every time the function is called.
--]]
local tidyVal = options.valueFunc
if tidyVal then
if type(tidyVal) ~= 'function' then
error(
"bad value assigned to option 'valueFunc'"
.. '(function expected, got '
.. type(tidyVal)
.. ')',
2
)
end
elseif options.trim ~= false then
if options.removeBlanks ~= false then
tidyVal = tidyValDefault
else
tidyVal = tidyValTrimOnly
end
else
if options.removeBlanks ~= false then
tidyVal = tidyValRemoveBlanksOnly
else
tidyVal = tidyValNoChange
end
end

--[[
-- Set up the args, metaArgs and nilArgs tables. args will be the one
-- accessed from functions, and metaArgs will hold the actual arguments. Nil
-- arguments are memoized in nilArgs, and the metatable connects all of them
-- together.
--]]
local args, metaArgs, nilArgs, metatable = {}, {}, {}, {}
setmetatable(args, metatable)

local function mergeArgs(tables)
--[[
-- Accepts multiple tables as input and merges their keys and values
-- into one table. If a value is already present it is not overwritten;
-- tables listed earlier have precedence. We are also memoizing nil
-- values, which can be overwritten if they are 's' (soft).
--]]
for _, t in ipairs(tables) do
for key, val in pairs(t) do
if metaArgs[key] == nil and nilArgs[key] ~= 'h' then
local tidiedVal = tidyVal(key, val)
if tidiedVal == nil then
nilArgs[key] = 's'
else
metaArgs[key] = tidiedVal
end
end
end
end
end

--[[
-- Define metatable behaviour. Arguments are memoized in the metaArgs table,
-- and are only fetched from the argument tables once. Fetching arguments
-- from the argument tables is the most resource-intensive step in this
-- module, so we try and avoid it where possible. For this reason, nil
-- arguments are also memoized, in the nilArgs table. Also, we keep a record
-- in the metatable of when pairs and ipairs have been called, so we do not
-- run pairs and ipairs on the argument tables more than once. We also do
-- not run ipairs on fargs and pargs if pairs has already been run, as all
-- the arguments will already have been copied over.
--]]

metatable.__index = function (t, key)
--[[
-- Fetches an argument when the args table is indexed. First we check
-- to see if the value is memoized, and if not we try and fetch it from
-- the argument tables. When we check memoization, we need to check
-- metaArgs before nilArgs, as both can be non-nil at the same time.
-- If the argument is not present in metaArgs, we also check whether
-- pairs has been run yet. If pairs has already been run, we return nil.
-- This is because all the arguments will have already been copied into
-- metaArgs by the mergeArgs function, meaning that any other arguments
-- must be nil.
--]]
if type(key) == 'string' then
key = options.translate[key]
end
local val = metaArgs[key]
if val ~= nil then
return val
elseif metatable.donePairs or nilArgs[key] then
return nil
end
for _, argTable in ipairs(argTables) do
local argTableVal = tidyVal(key, argTable[key])
if argTableVal ~= nil then
metaArgs[key] = argTableVal
return argTableVal
end
end
nilArgs[key] = 'h'
return nil
end

metatable.__newindex = function (t, key, val)
-- This function is called when a module tries to add a new value to the
-- args table, or tries to change an existing value.
if type(key) == 'string' then
key = options.translate[key]
end
if options.readOnly then
error(
'could not write to argument table key "'
.. tostring(key)
.. '"; the table is read-only',
2
)
elseif options.noOverwrite and args[key] ~= nil then
error(
'could not write to argument table key "'
.. tostring(key)
.. '"; overwriting existing arguments is not permitted',
2
)
elseif val == nil then
--[[
-- If the argument is to be overwritten with nil, we need to erase
-- the value in metaArgs, so that __index, __pairs and __ipairs do
-- not use a previous existing value, if present; and we also need
-- to memoize the nil in nilArgs, so that the value isn't looked
-- up in the argument tables if it is accessed again.
--]]
metaArgs[key] = nil
nilArgs[key] = 'h'
else
metaArgs[key] = val
end
end

local function translatenext(invariant)
local k, v = next(invariant.t, invariant.k)
invariant.k = k
if k == nil then
return nil
elseif type(k) ~= 'string' or not options.backtranslate then
return k, v
else
local backtranslate = options.backtranslate[k]
if backtranslate == nil then
-- Skip this one. This is a tail call, so this won't cause stack overflow
return translatenext(invariant)
else
return backtranslate, v
end
end
end

metatable.__pairs = function ()
-- Called when pairs is run on the args table.
if not metatable.donePairs then
mergeArgs(argTables)
metatable.donePairs = true
end
return translatenext, { t = metaArgs }
end

local function inext(t, i)
-- This uses our __index metamethod
local v = t[i + 1]
if v ~= nil then
return i + 1, v
end
end

metatable.__ipairs = function (t)
-- Called when ipairs is run on the args table.
return inext, t, 0
end

return args
end

return arguments

Module:Yesno

2025-05-15T16:37:12Z

Clemens Elflein: 1 revision imported

-- Function allowing for consistent treatment of boolean-like wikitext input.
-- It works similarly to the template {{yesno}}.

return function (val, default)
-- If your wiki uses non-ascii characters for any of "yes", "no", etc., you
-- should replace "val:lower()" with "mw.ustring.lower(val)" in the
-- following line.
val = type(val) == 'string' and val:lower() or val
if val == nil then
return nil
elseif val == true
or val == 'yes'
or val == 'y'
or val == 'true'
or val == 't'
or val == 'on'
or tonumber(val) == 1
then
return true
elseif val == false
or val == 'no'
or val == 'n'
or val == 'false'
or val == 'f'
or val == 'off'
or tonumber(val) == 0
then
return false
else
return default
end
end

Module:Message box

2025-05-15T16:37:12Z

Clemens Elflein: 1 revision imported

-- This is a meta-module for producing message box templates, including
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.

-- Load necessary modules.
require('strict')
local getArgs
local yesno = require('Module:Yesno')

-- Get a language object for formatDate and ucfirst.
local lang = mw.language.getContentLanguage()

-- Define constants
local CONFIG_MODULE = 'Module:Message box/configuration'
local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'}
local TEMPLATE_STYLES = 'Module:Message box/%s.css'

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function getTitleObject(...)
-- Get the title object, passing the function through pcall
-- in case we are over the expensive function count limit.
local success, title = pcall(mw.title.new, ...)
if success then
return title
end
end

local function union(t1, t2)
-- Returns the union of two arrays.
local vals = {}
for i, v in ipairs(t1) do
vals[v] = true
end
for i, v in ipairs(t2) do
vals[v] = true
end
local ret = {}
for k in pairs(vals) do
table.insert(ret, k)
end
table.sort(ret)
return ret
end

local function getArgNums(args, prefix)
local nums = {}
for k, v in pairs(args) do
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
if num then
table.insert(nums, tonumber(num))
end
end
table.sort(nums)
return nums
end

--------------------------------------------------------------------------------
-- Box class definition
--------------------------------------------------------------------------------

local MessageBox = {}
MessageBox.__index = MessageBox

function MessageBox.new(boxType, args, cfg)
args = args or {}
local obj = {}

obj.boxType = boxType

-- Set the title object and the namespace.
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()

-- Set the config for our box type.
obj.cfg = cfg[boxType]
if not obj.cfg then
local ns = obj.title.namespace
-- boxType is "mbox" or invalid input
if args.demospace and args.demospace ~= '' then
-- implement demospace parameter of mbox
local demospace = string.lower(args.demospace)
if DEMOSPACES[demospace] then
-- use template from DEMOSPACES
obj.cfg = cfg[DEMOSPACES[demospace]]
obj.boxType = DEMOSPACES[demospace]
elseif string.find( demospace, 'talk' ) then
-- demo as a talk page
obj.cfg = cfg.tmbox
obj.boxType = 'tmbox'
else
-- default to ombox
obj.cfg = cfg.ombox
obj.boxType = 'ombox'
end
elseif ns == 0 then
obj.cfg = cfg.ambox -- main namespace
obj.boxType = 'ambox'
elseif ns == 6 then
obj.cfg = cfg.imbox -- file namespace
obj.boxType = 'imbox'
elseif ns == 14 then
obj.cfg = cfg.cmbox -- category namespace
obj.boxType = 'cmbox'
else
local nsTable = mw.site.namespaces[ns]
if nsTable and nsTable.isTalk then
obj.cfg = cfg.tmbox -- any talk namespace
obj.boxType = 'tmbox'
else
obj.cfg = cfg.ombox -- other namespaces or invalid input
obj.boxType = 'ombox'
end
end
end

-- Set the arguments, and remove all blank arguments except for the ones
-- listed in cfg.allowBlankParams.
do
local newArgs = {}
for k, v in pairs(args) do
if v ~= '' then
newArgs[k] = v
end
end
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
newArgs[param] = args[param]
end
obj.args = newArgs
end

-- Define internal data structure.
obj.categories = {}
obj.classes = {}
-- For lazy loading of [[Module:Category handler]].
obj.hasCategories = false

return setmetatable(obj, MessageBox)
end

function MessageBox:addCat(ns, cat, sort)
if not cat then
return nil
end
if sort then
cat = string.format('[[Category:%s|%s]]', cat, sort)
else
cat = string.format('[[Category:%s]]', cat)
end
self.hasCategories = true
self.categories[ns] = self.categories[ns] or {}
table.insert(self.categories[ns], cat)
end

function MessageBox:addClass(class)
if not class then
return nil
end
self.classes[class] = 1
end

function MessageBox:removeClass(class)
if not class then
return nil
end
self.classes[class] = nil
end

function MessageBox:setParameters()
local args = self.args
local cfg = self.cfg

-- Get type data.
self.type = args.type
local typeData = cfg.types[self.type]
self.invalidTypeError = cfg.showInvalidTypeError
and self.type
and not typeData
typeData = typeData or cfg.types[cfg.default]
self.typeClass = typeData.class
self.typeImage = typeData.image

-- Find if the box has been wrongly substituted.
self.isSubstituted = cfg.substCheck and args.subst == 'SUBST'

-- Find whether we are using a small message box.
self.isSmall = cfg.allowSmall and (
cfg.smallParam and args.small == cfg.smallParam
or not cfg.smallParam and yesno(args.small)
)

-- Add attributes, classes and styles.
self.id = args.id
self.name = args.name
for _, class in ipairs(cfg.classes or {}) do
self:addClass(class)
end
if self.name then
self:addClass('box-' .. string.gsub(self.name,' ','_'))
end
local plainlinks = yesno(args.plainlinks)
if plainlinks == true then
self:addClass('plainlinks')
elseif plainlinks == false then
self:removeClass('plainlinks')
end
if self.isSmall then
self:addClass(cfg.smallClass or 'mbox-small')
end
self:addClass(self.typeClass)
self:addClass(args.class)
self.style = args.style
self.attrs = args.attrs

-- Set text style.
self.textstyle = args.textstyle

-- Find if we are on the template page or not. This functionality is only
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
-- and cfg.templateCategoryRequireName are set.
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
if self.useCollapsibleTextFields
or cfg.templateCategory
and cfg.templateCategoryRequireName
then
if self.name then
local templateName = mw.ustring.match(
self.name,
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
) or self.name
templateName = 'Template:' .. templateName
self.templateTitle = getTitleObject(templateName)
end
self.isTemplatePage = self.templateTitle
and mw.title.equals(self.title, self.templateTitle)
end

-- Process data for collapsible text fields. At the moment these are only
-- used in {{ambox}}.
if self.useCollapsibleTextFields then
-- Get the self.issue value.
if self.isSmall and args.smalltext then
self.issue = args.smalltext
else
local sect
if args.sect == '' then
sect = 'This ' .. (cfg.sectionDefault or 'page')
elseif type(args.sect) == 'string' then
sect = 'This ' .. args.sect
end
local issue = args.issue
issue = type(issue) == 'string' and issue ~= '' and issue or nil
local text = args.text
text = type(text) == 'string' and text or nil
local issues = {}
table.insert(issues, sect)
table.insert(issues, issue)
table.insert(issues, text)
self.issue = table.concat(issues, ' ')
end

-- Get the self.talk value.
local talk = args.talk
-- Show talk links on the template page or template subpages if the talk
-- parameter is blank.
if talk == ''
and self.templateTitle
and (
mw.title.equals(self.templateTitle, self.title)
or self.title:isSubpageOf(self.templateTitle)
)
then
talk = '#'
elseif talk == '' then
talk = nil
end
if talk then
-- If the talk value is a talk page, make a link to that page. Else
-- assume that it's a section heading, and make a link to the talk
-- page of the current page with that section heading.
local talkTitle = getTitleObject(talk)
local talkArgIsTalkPage = true
if not talkTitle or not talkTitle.isTalkPage then
talkArgIsTalkPage = false
talkTitle = getTitleObject(
self.title.text,
mw.site.namespaces[self.title.namespace].talk.id
)
end
if talkTitle and talkTitle.exists then
local talkText = 'Relevant discussion may be found on'
if talkArgIsTalkPage then
talkText = string.format(
'%s [[%s|%s]].',
talkText,
talk,
talkTitle.prefixedText
)
else
talkText = string.format(
'%s the [[%s#%s|talk page]].',
talkText,
talkTitle.prefixedText,
talk
)
end
self.talk = talkText
end
end

-- Get other values.
self.fix = args.fix ~= '' and args.fix or nil
local date
if args.date and args.date ~= '' then
date = args.date
elseif args.date == '' and self.isTemplatePage then
date = lang:formatDate('F Y')
end
if date then
self.date = string.format(" <small class='date-container'>''(<span class='date'>%s</span>)''</small>", date)
end
self.info = args.info
if yesno(args.removalnotice) then
self.removalNotice = cfg.removalNotice
end
end

-- Set the non-collapsible text field. At the moment this is used by all box
-- types other than ambox, and also by ambox when small=yes.
if self.isSmall then
self.text = args.smalltext or args.text
else
self.text = args.text
end

-- Set the below row.
self.below = cfg.below and args.below

-- General image settings.
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
self.imageEmptyCell = cfg.imageEmptyCell
if cfg.imageEmptyCellStyle then
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
end

-- Left image settings.
local imageLeft = self.isSmall and args.smallimage or args.image
if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
or not cfg.imageCheckBlank and imageLeft ~= 'none'
then
self.imageLeft = imageLeft
if not imageLeft then
local imageSize = self.isSmall
and (cfg.imageSmallSize or '30x30px')
or '40x40px'
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage
or 'Information icon4.svg', imageSize)
end
end

-- Right image settings.
local imageRight = self.isSmall and args.smallimageright or args.imageright
if not (cfg.imageRightNone and imageRight == 'none') then
self.imageRight = imageRight
end
end

function MessageBox:setMainspaceCategories()
local args = self.args
local cfg = self.cfg

if not cfg.allowMainspaceCategories then
return nil
end

local nums = {}
for _, prefix in ipairs{'cat', 'category', 'all'} do
args[prefix .. '1'] = args[prefix]
nums = union(nums, getArgNums(args, prefix))
end

-- The following is roughly equivalent to the old {{Ambox/category}}.
local date = args.date
date = type(date) == 'string' and date
local preposition = 'from'
for _, num in ipairs(nums) do
local mainCat = args['cat' .. tostring(num)]
or args['category' .. tostring(num)]
local allCat = args['all' .. tostring(num)]
mainCat = type(mainCat) == 'string' and mainCat
allCat = type(allCat) == 'string' and allCat
if mainCat and date and date ~= '' then
local catTitle = string.format('%s %s %s', mainCat, preposition, date)
self:addCat(0, catTitle)
catTitle = getTitleObject('Category:' .. catTitle)
if not catTitle or not catTitle.exists then
self:addCat(0, 'Articles with invalid date parameter in template')
end
elseif mainCat and (not date or date == '') then
self:addCat(0, mainCat)
end
if allCat then
self:addCat(0, allCat)
end
end
end

function MessageBox:setTemplateCategories()
local args = self.args
local cfg = self.cfg

-- Add template categories.
if cfg.templateCategory then
if cfg.templateCategoryRequireName then
if self.isTemplatePage then
self:addCat(10, cfg.templateCategory)
end
elseif not self.title.isSubpage then
self:addCat(10, cfg.templateCategory)
end
end

-- Add template error categories.
if cfg.templateErrorCategory then
local templateErrorCategory = cfg.templateErrorCategory
local templateCat, templateSort
if not self.name and not self.title.isSubpage then
templateCat = templateErrorCategory
elseif self.isTemplatePage then
local paramsToCheck = cfg.templateErrorParamsToCheck or {}
local count = 0
for i, param in ipairs(paramsToCheck) do
if not args[param] then
count = count + 1
end
end
if count > 0 then
templateCat = templateErrorCategory
templateSort = tostring(count)
end
if self.categoryNums and #self.categoryNums > 0 then
templateCat = templateErrorCategory
templateSort = 'C'
end
end
self:addCat(10, templateCat, templateSort)
end
end

function MessageBox:setAllNamespaceCategories()
-- Set categories for all namespaces.
if self.isSubstituted then
self:addCat('all', 'Pages with incorrectly substituted templates')
end
end

function MessageBox:setCategories()
if self.title.namespace == 0 then
self:setMainspaceCategories()
elseif self.title.namespace == 10 then
self:setTemplateCategories()
end
self:setAllNamespaceCategories()
end

function MessageBox:renderCategories()
if not self.hasCategories then
-- No categories added, no need to pass them to Category handler so,
-- if it was invoked, it would return the empty string.
-- So we shortcut and return the empty string.
return ""
end
-- Convert category tables to strings and pass them through
-- [[Module:Category handler]].
return require('Module:Category handler')._main{
main = table.concat(self.categories[0] or {}),
template = table.concat(self.categories[10] or {}),
all = table.concat(self.categories.all or {}),
nocat = self.args.nocat,
page = self.args.page
}
end

function MessageBox:export()
local root = mw.html.create()

-- Add the subst check error.
if self.isSubstituted and self.name then
root:tag('b')
:addClass('error')
:wikitext(string.format(
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
))
end

-- Add TemplateStyles
root:wikitext(mw.getCurrentFrame():extensionTag{
name = 'templatestyles',
args = { src = TEMPLATE_STYLES:format(self.boxType) },
})

-- Create the box table.
local boxTable
-- Check for fmbox because not all interface messages have mw-parser-output
-- which is necessary for TemplateStyles. Add the wrapper class if it is and
-- then start the actual mbox, else start the mbox.
if self.boxType == 'fmbox' then
boxTable = root:tag('div')
:addClass('mw-parser-output')
:tag('table')
else
boxTable = root:tag('table')
end

boxTable:attr('id', self.id or nil)
for class, _ in pairs(self.classes or {}) do
boxTable:addClass(class or nil)
end
boxTable
:cssText(self.style or nil)
:attr('role', 'presentation')

if self.attrs then
boxTable:attr(self.attrs)
end

-- Add the left-hand image.
local row = boxTable:tag('tr')
if self.imageLeft then
local imageLeftCell = row:tag('td'):addClass('mbox-image')
if self.imageCellDiv then
-- If we are using a div, redefine imageLeftCell so that the image
-- is inside it. Divs use style="width: 52px;", which limits the
-- image width to 52px. If any images in a div are wider than that,
-- they may overlap with the text or cause other display problems.
imageLeftCell = imageLeftCell:tag('div'):css('width', '52px')
end
imageLeftCell:wikitext(self.imageLeft or nil)
elseif self.imageEmptyCell then
-- Some message boxes define an empty cell if no image is specified, and
-- some don't. The old template code in templates where empty cells are
-- specified gives the following hint: "No image. Cell with some width
-- or padding necessary for text cell to have 100% width."
row:tag('td')
:addClass('mbox-empty-cell')
:cssText(self.imageEmptyCellStyle or nil)
end

-- Add the text.
local textCell = row:tag('td'):addClass('mbox-text')
if self.useCollapsibleTextFields then
-- The message box uses advanced text parameters that allow things to be
-- collapsible. At the moment, only ambox uses this.
textCell:cssText(self.textstyle or nil)
local textCellDiv = textCell:tag('div')
textCellDiv
:addClass('mbox-text-span')
:wikitext(self.issue or nil)
if (self.talk or self.fix) and not self.isSmall then
textCellDiv:tag('span')
:addClass('hide-when-compact')
:wikitext(self.talk and (' ' .. self.talk) or nil)
:wikitext(self.fix and (' ' .. self.fix) or nil)
end
textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
if self.info and not self.isSmall then
textCellDiv
:tag('span')
:addClass('hide-when-compact')
:wikitext(self.info and (' ' .. self.info) or nil)
end
if self.removalNotice then
textCellDiv:tag('small')
:addClass('hide-when-compact')
:tag('i')
:wikitext(string.format(" (%s)", self.removalNotice))
end
else
-- Default text formatting - anything goes.
textCell
:cssText(self.textstyle or nil)
:wikitext(self.text or nil)
end

-- Add the right-hand image.
if self.imageRight then
local imageRightCell = row:tag('td'):addClass('mbox-imageright')
if self.imageCellDiv then
-- If we are using a div, redefine imageRightCell so that the image
-- is inside it.
imageRightCell = imageRightCell:tag('div'):css('width', '52px')
end
imageRightCell
:wikitext(self.imageRight or nil)
end

-- Add the below row.
if self.below then
boxTable:tag('tr')
:tag('td')
:attr('colspan', self.imageRight and '3' or '2')
:addClass('mbox-text')
:cssText(self.textstyle or nil)
:wikitext(self.below or nil)
end

-- Add error message for invalid type parameters.
if self.invalidTypeError then
root:tag('div')
:css('text-align', 'center')
:wikitext(string.format(
'This message box is using an invalid "type=%s" parameter and needs fixing.',
self.type or ''
))
end

-- Add categories.
root:wikitext(self:renderCategories() or nil)

return tostring(root)
end

--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------

local p, mt = {}, {}

function p._exportClasses()
-- For testing.
return {
MessageBox = MessageBox
}
end

function p.main(boxType, args, cfgTables)
local box = MessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE))
box:setParameters()
box:setCategories()
return box:export()
end

function mt.__index(t, k)
return function (frame)
if not getArgs then
getArgs = require('Module:Arguments').getArgs
end
return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
end
end

return setmetatable(p, mt)

Module:Template translation

2025-05-15T16:37:11Z

Clemens Elflein: 1 revision imported

local this = {}

function this.checkLanguage(subpage, default)
--[[Check first if there's an any invalid character that would cause the
mw.language.isKnownLanguageTag function() to throw an exception:
- all ASCII controls in [\000-\031\127],
- double quote ("), sharp sign (#), ampersand (&), apostrophe ('),
- slash (/), colon (:), semicolon (;), lower than (<), greater than (>),
- brackets and braces ([, ], {, }), pipe (|), backslash (\\)
All other characters are accepted, including space and all non-ASCII
characters (including \192, which is invalid in UTF-8).
--]]
if mw.language.isValidCode(subpage) and mw.language.isKnownLanguageTag(subpage)
--[[However "SupportedLanguages" are too restrictive, as they discard many
valid BCP47 script variants (only because MediaWiki still does not
define automatic transliterators for them, e.g. "en-dsrt" or
"fr-brai" for French transliteration in Braille), and country variants,
(useful in localized data, even if they are no longer used for
translations, such as zh-cn, also useful for legacy codes).
We want to avoid matching subpagenames containing any uppercase letter,
(even if they are considered valid in BCP 47, in which they are
case-insensitive; they are not "SupportedLanguages" for MediaWiki, so
they are not "KnownLanguageTags" for MediaWiki).
To be more restrictive, we exclude tags
* for specific uses in template subpages and unusable as language tags;
* that is not ASCII and not a lowercase letter, minus-hyphen, or digit,
or does not start by a letter or does not finish by a letter or digit;
* or that has subtags with more than 8 characters between hyphens;
* or that has two hyphens.
--]]
or subpage ~= "doc"
and subpage ~= "layout"
and subpage ~= "button"
and subpage ~= "buttons"
and subpage ~= "sandbox"
and subpage ~= "testcase"
and subpage ~= "testcases"
and string.find(subpage, "^[%l][%-%d%l]*[%d%l]$") ~= nil
and string.find(subpage, "[%d%l][%d%l][%d%l][%d%l][%d%l][%d%l][%d%l][%d%l][%d%l]") == nil
and string.find(subpage, "%-%-") == nil then
return subpage
end
-- Otherwise there's currently no known language subpage
return default
end

--[[Get the last subpage of an arbitrary page if it is a translation.
To be used from templates.
]]
function this.getLanguageSubpage(frame)
local title = frame and frame.args[1]
if not title or title == '' then
title = mw.title.getCurrentTitle()
end
return this._getLanguageSubpage(title)
end

--[[Get the last subpage of an arbitrary page if it is a translation.
To be used from Lua.
]]
function this._getLanguageSubpage(title)
if type(title) == 'string' then
title = mw.title.new(title)
end
if not title then
-- invalid title
return nil
end
--[[This code does not work in all namespaces where the Translate tool works.
-- It works in the main namespace on Meta because it allows subpages there
-- It would not work in the main namespace of English Wikipedia (but the
-- articles are monolignual on that wiki).
-- On Meta-Wiki the main space uses subpages and its pages are translated.
-- The Translate tool allows translatng pages in all namespaces, even if
-- the namespace officially does not have subpages.
-- On Meta-Wiki the Category namespace still does not have subpages enabled,
-- even if they would be very useful for categorizing templates, that DO have
-- subpages (for documentatio and tstboxes pages). This is a misconfiguration
-- bug of Meta-Wiki. The work-around is to split the full title and then
-- get the last titlepart.
local subpage = title.subpageText
--]]
local titleparts = mw.text.split(title.fullText, '/')
local subpage = titleparts[#titleparts]
return this.checkLanguage(subpage, '')
end

--[[Get the last subpage of the current page if it is a translation.
]]
function this.getCurrentLanguageSubpage()
return this._getLanguageSubpage(mw.title.getCurrentTitle())
end

--[[Get the first part of the language code of the subpage, before the '-'.
--]]
function this.getMainLanguageSubpage()
parts = mw.text.split(this.getCurrentLanguageSubpage(), '-')
return parts[1]
end

--[[Get the last subpage of the current frame if it is a translation.
Not used locally.
--]]
function this.getFrameLanguageSubpage(frame)
return this._getLanguageSubpage(frame:getParent():getTitle())
end

--[[Get the language of the current page. Not used locally.
--]]
function this.getLanguage()
local subpage = mw.title.getCurrentTitle().subpageText
return this.checkLanguage(subpage, mw.language.getContentLanguage():getCode())
end

--[[Get the language of the current frame. Not used locally.
--]]
function this.getFrameLanguage(frame)
local titleparts = mw.text.split(frame:getParent():getTitle(), '/')
local subpage = titleparts[#titleparts]
return this.checkLanguage(subpage, mw.language.getContentLanguage():getCode())
end

function this.title(namespace, basepagename, subpage)
local message, title
local pagename = basepagename
if (subpage or '') ~= '' then
pagename = pagename .. '/' .. subpage
end
local valid, title = xpcall(function()
return mw.title.new(pagename, namespace) -- costly
end, function(msg) -- catch undocumented exception (!?)
-- thrown when namespace does not exist. The doc still
-- says it should return a title, even in that case...
message = msg
end)
if valid and title ~= nil and (title.id or 0) ~= 0 then
return title
end
return { -- "pseudo" mw.title object with id = nil in case of error
prefixedText = pagename, -- the only property we need below
message = message -- only for debugging
}
end

--[[If on a translation subpage (like Foobar/de), this function returns
a given template in the same language, if the translation is available.
Otherwise, the template is returned in its default language, without
modification.
This is aimed at replacing the current implementation of Template:TNTN.

This version does not expand the returned template name: this solves the
problem of self-recursion in TNT when translatable templates need themselves
to transclude other translable templates (such as Tnavbar).
--]]
function this.getTranslatedTemplate(frame, withStatus)
local args = frame.args
local pagename = args['template']
--[[Check whether the pagename is actually in the Template namespace, or
if we're transcluding a main-namespace page.
(added for backward compatibility of Template:TNT)
]]
local namespace, title = args['tntns'] or ''
if namespace ~= '' then -- Checks for tntns parameter for custom ns.
title = this.title(namespace, pagename) -- Costly
else -- Supposes that set page is in ns10.
namespace = 'Template'
title = this.title(namespace, pagename) -- Costly
if title.id == nil then -- not found in the Template namespace, assume the main namespace (for backward compatibility)
namespace = ''
title = this.title(namespace, pagename) -- Costly
end
end
-- Get the last subpage and check if it matches a known language code.
local subpage = args['uselang'] or ''
if subpage == '' then
subpage = this.getCurrentLanguageSubpage()
end
if subpage == '' then
-- Check if a translation of the pagename exists in English
local newtitle = this.title(namespace, pagename, 'en') -- Costly
-- Use the translation when it exists
if newtitle.id ~= nil then
title = newtitle
end
else
-- Check if a translation of the pagename exists in that language
local newtitle = this.title(namespace, pagename, subpage) -- Costly
if newtitle.id == nil then
-- Check if a translation of the pagename exists in English
newtitle = this.title(namespace, pagename, 'en') -- Costly
end
-- Use the translation when it exists
if newtitle.id ~= nil then
title = newtitle
end
end
-- At this point the title should exist
if withStatus then
-- status returned to Lua function below
return title.prefixedText, title.id ~= nil
else
-- returned directly to MediaWiki
return title.prefixedText
end
end

--[[If on a translation subpage (like Foobar/de), this function renders
a given template in the same language, if the translation is available.
Otherwise, the template is rendered in its default language, without
modification.
This is aimed at replacing the current implementation of Template:TNT.

Note that translatable templates cannot transclude themselves other
translatable templates, as it will recurse on TNT. Use TNTN instead
to return only the effective template name to expand externally, with
template parameters also provided externally.
--]]
function this.renderTranslatedTemplate(frame)
local title, found = this.getTranslatedTemplate(frame, true)
-- At this point the title should exist prior to performing the expansion
-- of the template, otherwise render a red link to the missing page
-- (resolved in its assumed namespace). If we don't tet this here, a
-- script error would be thrown. Returning a red link is consistant with
-- MediaWiki behavior when attempting to transclude inexistant templates.
if not found then
return '[[' .. title .. ']]'
end
-- Copy args pseudo-table to a proper table so we can feed it to expandTemplate.
-- Then render the pagename.
local args = frame.args
local pargs = (frame:getParent() or {}).args
local arguments = {}
if (args['noshift'] or '') == '' then
for k, v in pairs(pargs) do
local n = tonumber(k) or 0
if n <= 0 then -- unnumbered args
arguments[k] = v
elseif n >= 2 then -- numbered args >= 2 need to be shifted
arguments[n - 1] = v
end
end
else -- special case where TNT is used as autotranslate
-- (don't shift again what is shifted in the invokation)
for k, v in pairs(pargs) do
arguments[k] = v
end
end
arguments['template'] = title -- override the existing parameter of the base template name supplied with the full name of the actual template expanded
arguments['tntns'] = nil -- discard the specified namespace override
arguments['uselang'] = args['uselang'] -- argument forwarded into parent frame
arguments['noshift'] = args['noshift'] -- argument forwarded into parent frame
return frame:expandTemplate{title = ':' .. title, args = arguments}
end

--[[A helper for mocking TNT in Special:TemplateSandbox. TNT breaks
TemplateSandbox; mocking it with this method means templates won't be
localized but at least TemplateSandbox substitutions will work properly.
Won't work with complex uses.
--]]
function this.mockTNT(frame)
local pargs = (frame:getParent() or {}).args
local arguments = {}
for k, v in pairs(pargs) do
local n = tonumber(k) or 0
if n <= 0 then -- unnumbered args
arguments[k] = v
elseif n >= 2 then -- numbered args >= 2 need to be shifted
arguments[n - 1] = v
end
end
if not pargs[1] then
return ''
end
return frame:expandTemplate{title = 'Template:' .. pargs[1], args = arguments}
end

return this

Template:Dir

2025-05-15T16:35:29Z

Clemens Elflein: 1 revision imported

{{#ifeq:{{#dir:{{{lang|{{{1|{{int:lang}}}}}}}}}}|rtl|{{{2|{{{rtl|rtl}}}}}}|{{{3|{{{ltr|ltr}}}}}}}}<noinclude>

{{Documentation}}

</noinclude>

Template:Localized link

2025-05-15T16:35:29Z

Clemens Elflein: 1 revision imported

<noinclude>
<languages/>
</noinclude>{{#ifeq:{{FULLPAGENAME:{{{1}}}}}|{{FULLPAGENAME:{{translatable}}}}
|<b>
}}[[Special:MyLanguage/{{{1}}}|{{#if:{{{2|}}}
|{{{2}}}
|{{{2|{{#ifexist:Translations:{{#if:{{NAMESPACE:{{{1}}}}}|{{NAMESPACE:{{{1}}}}}:}}{{PAGENAME:{{{1}}}}}/Page display title/{{PAGELANGUAGE}}
|{{#ifexpr:{{#if:{{{nsp|}}}|1|0}} and {{NAMESPACENUMBER:{{{1}}}}}!=0
|{{#ifeq:{{PAGELANGUAGE}}|en
|{{PAGENAME:{{{1}}}}}
|{{#if:{{PAGENAME:{{ {{TNTN|Translations:{{#if:{{NAMESPACE:{{{1}}}}}|{{NAMESPACE:{{{1}}}}}:}}{{PAGENAME:{{{1}}}}}/Page_display_title}} }} }}
|{{#ifeq:{{#invoke:string|find|{{PAGENAME:{{ {{TNTN|Translations:{{#if:{{NAMESPACE:{{{1}}}}}|{{NAMESPACE:{{{1}}}}}:}}{{PAGENAME:{{{1}}}}}/Page_display_title}} }} }}|:}}|0
|{{PAGENAME:{{ {{TNTN|Translations:{{#if:{{NAMESPACE:{{{1}}}}}|{{NAMESPACE:{{{1}}}}}:}}{{PAGENAME:{{{1}}}}}/Page_display_title}} }} }}
| {{#invoke:string|match|{{PAGENAME:{{ {{TNTN|Translations:{{#if:{{NAMESPACE:{{{1}}}}}|{{NAMESPACE:{{{1}}}}}:}}{{PAGENAME:{{{1}}}}}/Page_display_title}} }} }}|:(.*)}}
}}
|{{#if:{{ {{TNTN|Translations:{{#if:{{NAMESPACE:{{{1}}}}}|{{NAMESPACE:{{{1}}}}}:}}{{PAGENAME:{{{1}}}}}/Page_display_title}} | nsp = 0 }}
|{{ {{TNTN|Translations:{{#if:{{NAMESPACE:{{{1}}}}}|{{NAMESPACE:{{{1}}}}}:}}{{PAGENAME:{{{1}}}}}/Page_display_title}} | nsp = 0 }}
|{{{1}}}
}}
}}
}}
|{{ {{TNTN|Translations:{{#if:{{NAMESPACE:{{{1}}}}}|{{NAMESPACE:{{{1}}}}}:}}{{PAGENAME:{{{1}}}}}/Page_display_title}} }}
}}

|{{#if:{{{nsp|}}}
|{{#if:{{PAGENAME:{{{1}}}}}
|{{PAGENAME:{{{1}}}}}
|{{{1}}}
}}
|{{{1}}}
}}
}}}}}}}]]{{#ifeq:{{FULLPAGENAME:{{{1}}}}}|{{FULLPAGENAME:{{translatable}}}}
|</b>
}}<span style="display:none">[[:{{{1}}}| ]]</span><noinclude>
{{documentation|content=

{{tsh|ll|LL}}
{{High-use|35000}}

<translate>
== Purpose == 
</translate>
<translate> This helper template can be used to link to [[<tvar name=1>Special:LanguageStats</tvar>|translatable pages]] in the user's language.</translate>
<translate> It uses the special page prefix <tvar name=1><code>Special:MyLanguage/</code></tvar>, which checks if there is a translated version of a page in the user's language, and links to it if there is one, and links to a fallback language where available, or the default wiki language version (English in MediaWiki) if there isn't.</translate>

<translate>

It should be used in translated pages, so that they link to the right page even if there is no translated page in that language.

== Usage == 
</translate>
{{Localized link/doc}}

<translate>

If the "<tvar name=1><code>nsp</code></tvar>" parameter is not defined, as link text this displays the full pagename (including the namespace); otherwise — if the "<tvar name=1><code>nsp</code></tvar>" parameter is defined to any value the link text displays the short pagename (without the namespace).

=== Examples of simple usage === 
</translate>
{{(}}{{!}} class="wikitable"
{{!}}-
! <translate> Use</translate>
! <translate> Becomes</translate>
{{!}}-
{{!}} {{Tlx|ll|Communication}}
{{!}} {{ll|Communication}}
{{!}}-
{{!}} {{Tlx|ll|Communication|コミュニケーション}}
{{!}} {{ll|Communication|コミュニケーション}}
{{!}}-
{{!}} {{Tlx|ll|Project:About}}
{{!}} {{ll|Project:About}}
{{!}}-
{{!}} {{Tlx|ll|Project:About|nsp{{=}}0}}
{{!}} {{ll|Project:About|nsp=0}}
{{!}}{{)}}

<translate>
== Usage in translatable pages == 


On pages prepared for translation with the <tvar name=1>{{ll|Extension:Translate|nsp=0}}</tvar> extension, this template may be used in three ways.
</translate>

# <translate> Substitute this template, then embed the wikilink target in a <tvar name=1>{{#tag:syntaxhighlight|{{^(}}tvar name=id{{)^}}...{{^(}}/tvar{{)^}}|lang=html|inline=1}}</tvar>, separate from the translatable text of the link.</translate>
#: <translate> For example, instead of <tvar name=1><code><nowiki>{{ll|Communication|About communication}}</nowiki></code></tvar>, the translation markup in the translatable page will be <tvar name=2>{{#tag:syntaxhighlight|[[{{^(}}tvar name=1{{)^}}Special:MyLanguage/Communication{{^(}}/tvar{{)^}}|About communication]]|lang=html|inline=1}}</tvar>.</translate>
# <translate> Alternatively, exclude this code from the translatable section.</translate>
#: <translate> For example, for <tvar name=1><code>some text <nowiki>{{ll|Communication|About communication}}</nowiki> some text</code></tvar>, the translation markup in the translatable page will be:</translate>
#: {{#tag:syntaxhighlight|{{^(}}translate{{)^}}some text{{^(}}/translate{{)^}} {{((}}ll{{!}}Communication{{!}}2={{^(}}translate{{)^}}About communication{{^(}}/translate{{)^}}{{))}} {{^(}}translate{{)^}}some text{{^(}}/translate{{)^}}|lang=html|inline=1}}
#: <translate> This is useful for bulleted lists of links, e.g. in the "See also:" sections.</translate>
# <translate> If link text is the same as the name of the target page, all of the code could also be embedded into <tvar name=1>{{tag|tvar|open}}</tvar>.</translate>
#: <translate> For example, instead of <tvar name=1>{{Tlx|ll|Communication}}</tvar>, the wikicode in the translatable page will be <tvar name=2>{{#tag:syntaxhighlight|{{^(}}tvar name=1{{)^}}{{((}}ll{{!}}Communication{{))}}{{^(}}/tvar{{)^}}|lang=html|inline=1}}</tvar>.</translate>

== Test cases ==
{{Localized link/testcases}}

<translate>
== See also == 
</translate>
* [[Template:Localized link/messagedoc]] — <translate> should be used for message documentation in translatable pages that use this template.</translate>
* {{tl|Translatable template}} - <translate> alias <tvar name=1>{{tl|TNT}}</tvar> or <tvar name=2>{{tl|tnt}}</tvar></translate>
* {{tl|Translatable template name}} - <translate> alias <tvar name=1>{{tl|TNTN}}</tvar> or <tvar name=2>{{tl|tntn}}</tvar></translate>
* {{tl|Page language link}} - <translate> alias <tvar name=1>{{tl|pll}}</tvar></translate> - <translate> add a link from a translatable page to another translatable page in the same language</translate>
}}
[[Category:Internationalization templates{{#translation:}}]]
</noinclude>

Template:Ll

2025-05-15T16:35:27Z

Clemens Elflein: 1 revision imported

#REDIRECT [[Template:Localized link]]

Template:Pagelang

2025-05-15T16:35:26Z

Clemens Elflein: 1 revision imported

{{#ifeq:{{#invoke:Template translation|getLanguageSubpage|{{{1|}}}}}|en
|{{#ifeq:{{#titleparts:{{{1|{{PAGENAME}}}}}||-1}}|en
|{{#invoke:Template translation|getLanguageSubpage|{{{1|}}}}}
}}
|{{#invoke:Template translation|getLanguageSubpage|{{{1|}}}}}
}}<noinclude>
{{Documentation}}
</noinclude>

Template:Translatable

2025-05-15T16:35:26Z

Clemens Elflein: 1 revision imported

<noinclude>
<languages />
</noinclude>{{#ifeq:{{pagelang|{{{1|{{FULLPAGENAME}}}}}}}|
|{{{1|{{FULLPAGENAME}}}}}
|{{#invoke:String|sub|{{{1|{{FULLPAGENAME}}}}}
|1
|{{#expr:{{#invoke:String|len|{{{1|{{FULLPAGENAME}}}}}}}-{{#invoke:String|len|{{pagelang|{{{1|{{FULLPAGENAME}}}}}}}}}-1}}
}}
}}<noinclude>
{{Documentation|content=
{{Lua|Module:String}}

<translate>
== Examples == 
</translate>
* {{tlx|translatable}}
{{translatable}}
* {{tlx|translatable|2=<translate> Page name</translate>}}
{{translatable|1=<translate> Page name</translate>}}
* {{tlx|translatable|2=<translate> Page name</translate>/{{PAGELANGUAGE}} }}
{{translatable|1=<translate> Page name</translate>/{{PAGELANGUAGE}} }}
}}

[[Category:Internationalization templates{{#translation:}}]]
</noinclude>

Template:Note

2025-05-15T16:35:26Z

Clemens Elflein: 1 revision imported

<languages/>
<onlyinclude>{{#if: {{{1|{{{content|{{{text|{{{demo|<noinclude>demo</noinclude>}}}}}}}}}}}} | <templatestyles src="Note/styles.css" /><div role="note" class="note note-{{#switch: {{{2|{{{type|}}}}}}
|gotcha=error
|warning=warn
|notice=info
|=info
|#default={{{2|{{{type|}}}}}}
}} {{#ifeq:{{{inline|}}}|1|note-inline}}">{{{1|{{{content|{{{text}}}}}}}}}</div>
| [[File:OOjs UI icon lightbulb-yellow.svg|18px|alt=<translate> Note</translate>|link=]] '''<translate> Note:</translate>''' }}</onlyinclude>
{{documentation|content=
<translate>
== Usage == 
</translate>
<pre>
{{Note|text=Foo}}
{{Note|type=info|text=Foo}}
{{Note|type=reminder|text=Foo}}
{{Note|type=reminder|text=Multiple<br>lines<br>of<br>text}}
{{Note|type=warn|text=Foo}}
{{Note|type=error|text=Foo}}
{{Note}} <translate nowrap> Loose test</translate>

* Text {{Note|inline=1|text=Foo}}
</pre>
{{Note|text=Foo}}
{{Note|type=info|text=Foo}}
{{Note|type=reminder|text=Foo}}
{{Note|type=reminder|text=Multiple<br>lines<br>of<br>text}}
{{Note|type=warn|text=Foo}}
{{Note|type=error|text=Foo}}
{{Note}} <translate> Loose test</translate>

* Text {{Note|inline=1|text=Foo}}

== Parameters ==

{{Note/doc}}

== See also ==
* {{tl|warn}}, shortcut for this template with <code>type=warning</code>.
* {{tl|mbox}}, and in particular the namespace-agnostic {{tl|ombox}}, which by default resembles a typical "info" template.

}}
[[Category:Templates{{#translation:}}|{{PAGENAME}}]]

Template:Note/style.css

2025-05-15T16:32:25Z

Clemens Elflein: Created page with ".note { background-position: left 7px top 50%; padding: 0.5em 0.5em 0.5em 40px; margin: 0.5em 0; overflow: hidden; background-color: #f8f9fa; color: #333; background-repeat: no-repeat; border: 1px solid #ddd; } .note-inline { display: inline-block; vertical-align: middle; } .note-info { background-color: #eaf3ff; color: #333; /* File:OOjs_UI_icon_information-progressive.svg */ background-image: url(https://uploa..."

Template:Note/styles.css

2025-05-15T14:49:16Z

Getting Started with V2

2025-03-03T13:43:18Z

Clemens Elflein: /* Step2: Flash the bootloader to your STM32 */

This page gathers information on how to get started with the Open Mower v2 software. Although things are getting stable, expect some changes and issues at the moment. If you have any questions, reach out on Discord, we try to help.

== Reflashing the Bootloader onto the STM32 ==
If you got one of the very first x-core boards, you will need to re-flash the bootloader (there have been breaking changes in the protocol).

Requirements:

- CM4 on the core board

- DHCP server on the ethernet where the STM32 is connected (I recommend installing isc-dhcp-server. Its easy and works well for met)

- OpenOCD installed on the CM4 (see here for how to do it: https://core.x-tech.online/docs/tutorials/flashing-stm32-from-cm4/)

- Docker or Podman installed on the CM4. I am using podman here, you can replace `podman` for `docker` and it should work the same.

=== Step1: Get the latest firmware ===
SSH into your CM4 and execute the following commands:<syntaxhighlight lang="bash">
mkdir ~/bootloader && cd ~/bootloader

wget https://github.com/xtech/fw-xcore-boot/releases/download/v1.1.3/xcore-boot-v1.1.3.zip

unzip xcore-boot-v1.1.3.zip
</syntaxhighlight>

You should now have a folder `artifacts` in your working directory. It contains the bootloader binaries.

=== Step2: Flash the bootloader to your STM32 ===
Run the following command to write the bootloader to your STM32.<syntaxhighlight lang="bash">
openocd -f interface/xcore.cfg -f target/stm32h7x.cfg -c "program artifacts/bootloader/xcore-boot.elf verify reset exit"
</syntaxhighlight>

When the command succeeded, the updated bootloader is stored in the STM32.

=== Step 3: Check, if it worked ===
Whenever the bootloader is running, the Heartbeat LED (heart icon on the PCB) should be flashing *BLUE*. Check, if this is the case.

If this is not the case, the STM32 is in user-program mode and not in the bootloader. In order to force the STM32 into the bootloader, you need to power cycle the STM32 (RESET button is not enough).

After power cycling, you should see the blue LED flashing. If not, ask on Discord - something has gone wrong.

=== Step 4: Use the bootloader host program to connect to the bootloader. ===
In this step we test that the host application can talk to the bootloader.

Run the following command to disable the developer mode on the bootloader:
podman run --rm -it --network=host ghcr.io/xtech/fw-xcore-boot --interface=eth0 set_dev_mode --disable

Information about the used flags:

* --rm: removes the temporary container after uploading the firmware
* -it: Allows terminal output to be instantly visible
* --network=host: Allows the container to access the hosts' network directly
* --interface=eth0: Forces the bootloader software to use eth0, change to whatever your ethernet interface name is
* set_dev_mode --disable: Disables the bootloader's developer mode. Developer mode will just jump into the user space program without any verification. You won't need it when using the bootloader.

A successful run should look like this:<syntaxhighlight lang="bash">
openmower@openmower:~/bootloader $ podman run --rm -it --network=host ghcr.io/xtech/fw-xcore-boot --interface=eth0 set_dev_mode --disable

Using interface eth0 with IP 172.16.78.1

Received advertisement from 172.16.78.150: BOARD_ADVERTISEMENT:xcore-boot;application-mode

Board in application mode, sending RESET to board

Timeout (1/25)

Received advertisement from 172.16.78.150: BOARD_ADVERTISEMENT:xcore-boot

Found board at 172.16.78.150

Connected to 172.16.78.150:8007

Variables received from board:

BOOTLOADER VERSION: xcore-boot v1.1

BOARD: xcore

HARDWARE VERSION: 1.1.7

CARRIER BOARD: hw-openmower-yardforce

CARRIER BOARD VERSION: 1.0.1

Sent SET_DEV_MODE to board

> Got command: SET_DEV_MODE

Received HASH OK

Sent new value to board

> Dev Mode: Disabled.

>Successfully updated EEPROM

Error reading line: Connection closed by remote host

Connection closed
</syntaxhighlight>

=== Step 5: Upload a user firmware ===
We can now use the bootloader to upload a firmware to the STM32.

In this example we flash the OpenMower v2 firmware for a YardForce robot.

<syntaxhighlight lang="bash">
# Download the firmware you want to upload (.bin file)
# Get it here: https://github.com/xtech/fw-openmower-v2/actions
# Select the latest successful run, login and download the artifact

# Extract the zip:
unzip openmower.zip

# Upload the firmware
podman run --rm -it -v $(pwd):/workdir --network=host ghcr.io/xtech/fw-xcore-boot --interface=eth0 upload /workdir/openmower-yardforce.bin
</syntaxhighlight>A successful run should look like this:<syntaxhighlight lang="bash">
openmower@openmower:~/firmware $ podman run --rm -it -v $(pwd):/workdir --network=host ghcr.io/xtech/fw-xcore-boot --interface=eth0 upload /workdir/openmower-yardforce.bin
Using interface eth0 with IP 172.16.78.1
Received advertisement from 172.16.78.150: BOARD_ADVERTISEMENT:xcore-boot;application-mode
Board in application mode, sending RESET to board
Timeout (1/25)
Received advertisement from 172.16.78.150: BOARD_ADVERTISEMENT:xcore-boot
Found board at 172.16.78.150
File SHA256: 92d8213153e4a757edaff8070c3c51b7de48da1383bb2c9ef1042c3469b89130
File Length: 191208
Connected to 172.16.78.150:8007
Variables received from board:
BOOTLOADER VERSION: xcore-boot v1.1
BOARD: xcore
HARDWARE VERSION: 1.1.7
CARRIER BOARD: hw-openmower-yardforce
CARRIER BOARD VERSION: 1.0.1
Sending UPLOAD command
> Got command: UPLOAD
Received SEND HASH
Sent SHA256 to board
Received HASH OK
Sent file length to board
>Image size: 191208
>Erasing 2 Flash Pages.
>Erasing Chip...
>Erasing Done
Uploading file...
100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 191k/191k [00:01<00:00, 182kB/s]
File content sent
Connection closed

</syntaxhighlight>

Getting Started with V2

2025-03-03T13:37:38Z

Clemens Elflein: Created page with "This page gathers information on how to get started with the Open Mower v2 software. Although things are getting stable, expect some changes and issues at the moment. If you have any questions, reach out on Discord, we try to help. == Reflashing the Bootloader onto the STM32 == If you got one of the very first x-core boards, you will need to re-flash the bootloader (there have been breaking changes in the protocol). Requirements: - CM4 on the core board - DHCP serve..."

This page gathers information on how to get started with the Open Mower v2 software. Although things are getting stable, expect some changes and issues at the moment. If you have any questions, reach out on Discord, we try to help.

== Reflashing the Bootloader onto the STM32 ==
If you got one of the very first x-core boards, you will need to re-flash the bootloader (there have been breaking changes in the protocol).

Requirements:

- CM4 on the core board

- DHCP server on the ethernet where the STM32 is connected (I recommend installing isc-dhcp-server. Its easy and works well for met)

- OpenOCD installed on the CM4 (see here for how to do it: https://core.x-tech.online/docs/tutorials/flashing-stm32-from-cm4/)

- Docker or Podman installed on the CM4. I am using podman here, you can replace `podman` for `docker` and it should work the same.

=== Step1: Get the latest firmware ===
SSH into your CM4 and execute the following commands:<syntaxhighlight lang="bash">
mkdir ~/bootloader && cd ~/bootloader

wget https://github.com/xtech/fw-xcore-boot/releases/download/v1.1.3/xcore-boot-v1.1.3.zip

unzip xcore-boot-v1.1.3.zip
</syntaxhighlight>

You should now have a folder `artifacts` in your working directory. It contains the bootloader binaries.

=== Step2: Flash the bootloader to your STM32 ===
Run the following command to write the bootloader to your STM32.

`openocd -f interface/xcore.cfg -f target/stm32h7x.cfg -c "program artifacts/bootloader/xcore-boot.elf verify reset exit"`

When the command succeeded, the updated bootloader is stored in the STM32.

=== Step 3: Check, if it worked ===
Whenever the bootloader is running, the Heartbeat LED (heart icon on the PCB) should be flashing *BLUE*. Check, if this is the case.

If this is not the case, the STM32 is in user-program mode and not in the bootloader. In order to force the STM32 into the bootloader, you need to power cycle the STM32 (RESET button is not enough).

After power cycling, you should see the blue LED flashing. If not, ask on Discord - something has gone wrong.

=== Step 4: Use the bootloader host program to connect to the bootloader. ===
In this step we test that the host application can talk to the bootloader.

Run the following command to disable the developer mode on the bootloader:
podman run --rm -it --network=host ghcr.io/xtech/fw-xcore-boot --interface=eth0 set_dev_mode --disable

Information about the used flags:

* --rm: removes the temporary container after uploading the firmware
* -it: Allows terminal output to be instantly visible
* --network=host: Allows the container to access the hosts' network directly
* --interface=eth0: Forces the bootloader software to use eth0, change to whatever your ethernet interface name is
* set_dev_mode --disable: Disables the bootloader's developer mode. Developer mode will just jump into the user space program without any verification. You won't need it when using the bootloader.

A successful run should look like this:<syntaxhighlight lang="bash">
openmower@openmower:~/bootloader $ podman run --rm -it --network=host ghcr.io/xtech/fw-xcore-boot --interface=eth0 set_dev_mode --disable

Using interface eth0 with IP 172.16.78.1

Received advertisement from 172.16.78.150: BOARD_ADVERTISEMENT:xcore-boot;application-mode

Board in application mode, sending RESET to board

Timeout (1/25)

Received advertisement from 172.16.78.150: BOARD_ADVERTISEMENT:xcore-boot

Found board at 172.16.78.150

Connected to 172.16.78.150:8007

Variables received from board:

BOOTLOADER VERSION: xcore-boot v1.1

BOARD: xcore

HARDWARE VERSION: 1.1.7

CARRIER BOARD: hw-openmower-yardforce

CARRIER BOARD VERSION: 1.0.1

Sent SET_DEV_MODE to board

> Got command: SET_DEV_MODE

Received HASH OK

Sent new value to board

> Dev Mode: Disabled.

>Successfully updated EEPROM

Error reading line: Connection closed by remote host

Connection closed
</syntaxhighlight>

=== Step 5: Upload a user firmware ===
We can now use the bootloader to upload a firmware to the STM32.

In this example we flash the OpenMower v2 firmware for a YardForce robot.

<syntaxhighlight lang="bash">
# Download the firmware you want to upload (.bin file)
# Get it here: https://github.com/xtech/fw-openmower-v2/actions
# Select the latest successful run, login and download the artifact

# Extract the zip:
unzip openmower.zip

# Upload the firmware
podman run --rm -it -v $(pwd):/workdir --network=host ghcr.io/xtech/fw-xcore-boot --interface=eth0 upload /workdir/openmower-yardforce.bin
</syntaxhighlight>A successful run should look like this:<syntaxhighlight lang="bash">
openmower@openmower:~/firmware $ podman run --rm -it -v $(pwd):/workdir --network=host ghcr.io/xtech/fw-xcore-boot --interface=eth0 upload /workdir/openmower-yardforce.bin
Using interface eth0 with IP 172.16.78.1
Received advertisement from 172.16.78.150: BOARD_ADVERTISEMENT:xcore-boot;application-mode
Board in application mode, sending RESET to board
Timeout (1/25)
Received advertisement from 172.16.78.150: BOARD_ADVERTISEMENT:xcore-boot
Found board at 172.16.78.150
File SHA256: 92d8213153e4a757edaff8070c3c51b7de48da1383bb2c9ef1042c3469b89130
File Length: 191208
Connected to 172.16.78.150:8007
Variables received from board:
BOOTLOADER VERSION: xcore-boot v1.1
BOARD: xcore
HARDWARE VERSION: 1.1.7
CARRIER BOARD: hw-openmower-yardforce
CARRIER BOARD VERSION: 1.0.1
Sending UPLOAD command
> Got command: UPLOAD
Received SEND HASH
Sent SHA256 to board
Received HASH OK
Sent file length to board
>Image size: 191208
>Erasing 2 Flash Pages.
>Erasing Chip...
>Erasing Done
Uploading file...
100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 191k/191k [00:01<00:00, 182kB/s]
File content sent
Connection closed

</syntaxhighlight>

Main Page

2025-03-03T13:08:09Z

Clemens Elflein:

== The OpenMower Community Wiki ==

Welcome to the OpenMower Community Wiki!

This WIKI was only just started on 2022-04-22, but we'll collaborate on getting good information on the OpenMower project collected here.

If you want to contribute to the Wiki: [https://discord.gg/jE7QNaSxW7 join the Discord], ask at the [https://discord.com/channels/958476543846412329/967345181013725194 #wiki-authors channel] for a wiki account and a wiki admin will create one.

Also head over to the [https://discord.com/channels/958476543846412329/967345181013725194 #wiki-authors channel] if you want talk about wiki related stuff.

== How to Get Started ==

One of the first steps currently is to browse around the discord and understand what the project is about. You can also have a look at Clemens' second video ([https://www.youtube.com/watch?v=_bImqD-pQSA here]) of the project that details how to assemble the bot.

First: Check the '''[[FAQ]]'''

When you're ready, you can have a look at the '''[[Building the Mower]]''' section to see the Bill of Materials and steps required and check out '''[[Builder Road Map]]''' for a practical take on what to do.

<big>(Note this wiki is in progress and not complete yet, but we're working on it!)</big>

<big>'''⚡ Before checking out the community wiki head over to the Official Documentation at [https://openmower.de/ openmower.de] ⚡'''</big>

==Resources==

===[[FAQ]]===

<big>There is a continually evolving [[FAQ]] that is a good starting point for understanding the project and getting answers to some key questions.</big>

===[[Project overview|Project overview and timeline]]===

Current status and future goals - [[Project overview|See it here]]

===Hardware Revisions===

Open Mower hardware revisions, changelog, info: [https://openmower.de/docs/versions/ Moved to the official docs]

===[[System Image|Software Installation]] ''Old bare metal installation - not for users''===

On this page, you can find steps how to install a basic OpenMower system image.

===[[Running OpenMower]]===

On this page, you can find steps how to run the OpenMower software.
We're doing:
- Starting the Software
- Magnetometer Calibration
- Recording a Map
- Starting the Mowing Process

===[[Mini HOWTOs]]===

On this page, you can find small HOWTOs for various things. Set [[Mini HOWTOs|here]]

===Where to find more information===

The entry points for more information are:

*[https://discord.com/channels/958476543846412329/958476543846412331 The Discord for the project]
*[https://discord.com/channels/958476543846412329/958476543846412332 Annoncements in the Discord]
*[https://youtube.com/c/ClemensElflein/videos YouTube]
*[https://github.com/ClemensElflein/OpenMower Open Mower Main GitHub Repo - Overall and hardware]
*[https://github.com/ClemensElflein/open_mower_ros Open Mower GitHub Repo for the ROS logic in the OpenMower]
*[https://github.com/ClemensElflein/xESC xESC Motor Controller Repo (custom part for main board)]
*[[Getting Started with V2]]

==How to contribute==

At the moment, there are different ways to contribute:

*Building your own mower, testing the software and reporting bugs / committing fixes on the github repository

*If you're not scared to see the inside of some mowers, please help us understand more about how they are built following instructions in the '''[[Mower Dissection]]''' page.

*And finally, [https://www.patreon.com/ClemensElflein Patreon to support Clemens' amazing work]

==Disclaimer==

''This Wiki is provided as-is and free of charge. No guarantees of any kind are made that the information contained herein is exact or correct or does not violate any local regulations or cause any security risk. Any use you make of any information given here is at your own discretion and risk.''

Flashing Xesc firmware

2022-12-13T09:22:23Z

Clemens Elflein: /* Connecting everything */

== Introduction ==
''This page will guide you through the steps needed to flash and configure the XESCs for use with the OpenMower Project

This mini-HOWTO is meant to guide you through the different steps.''

'''THIS PAGE IS CONSIDERED A WORK IN PROGRESS AND WILL BE UPDATED REGULARLY'''

== Disclaimer ==
''This Wiki is provided as-is and free of charge. No guarantees of any kind are made that the information contained herein is exact or correct or does not violate any local regulations or cause any security risk. Any use you make of any information given here is at your own discretion and risk.
Please note that motors can be dangerous, especially the mowing one. Always take the blade apart when building / testing around the bot, and make sure nothing contacts any of the moving parts.

We cannot be held responsible for your actions.''

== STM32 Version ==
''In this section, we will guide you through the first flashing and configuration of your STM32 based XESC''

Only linux have been tested for now, but other OS will come.

=== Prerequisites ===
For this how-to, you will need:
- A Linux Computer with internet connection
- The XESC you want to flash
- A micro USB cable
- A ST programmer (STlink v2 or blue pill for exemple)
- Some wires to connect the XESC and the STLINK

=== Setting Up Your Machine ===

We created a script to make sure everything on your machine is setup correctly. To use it:

- Run a terminal on your computer
- run <code>wget https://github.com/vamatis/Random/blob/main/xesc-computer-setup-script.sh </code>
- then <code>chmod u+x xesc-computer-setup-script.sh</code>
- and finally <code>sudo ./xesc-computer-setup-script.sh</code>

The script will create a XESC-Setup folder with the following architecture:

- XESC-Setup
- bldc-bootloader
- xesc_firmware
- configs

The bldc-bootloader folder contains the VESC bootloader for the STM32
The xesc_firmware contains the custom firmware for the XESC
The config folder contains configurations for the drive and mower motors

Once you have that done, you're ready to proceed!

=== Connecting everything ===
Depending on the Programmer you use, you will need to connect either 3 or 4 wires between the programmer and XESC.
These wires are:
- 3V3V (not mandatory, depends on the programmer used)
- SWDIO -> the dataline
- SWDCLK -> the clockline
- GND

Looking at the XESC from the top (USB on top) and with the usb port facing towards you, the pinout is as follows:
3V3
SWCLK
GND
SWDIO
RESET

Note that we won't use the reset line.

=== Flashing the Bootloader ===

=== Flashing the Firmware ===

=== Connection to VESC TOOL and configuration ===

== RP2040 Version ==
''In this section, we will guide you through the first flashing and configuration of your RP2040 based XESC''

Compared to the STM32 version, flashing the RP2040 XESC is pretty simple:

- Connect your XESC to your computer using the micro USB port
XESC will then appear as a mass storage device.
- Copy/Paste the firmware file to that new storage

On the RP2040 version, ROS automatically loads the necessary config for the OPENMOWER motors, so you don't need to do anything else.

Enjoy your flashed XESCs!

Running OpenMower

2022-08-23T11:19:05Z

Clemens Elflein:

Now that you have your hardware assembled and the basic software installed on your mower, we can calibrate the magnetometer and start recordings maps and mowing the lawn.

==Prerequisites==
In order to follow this guide, you will need the following:

#A mower modified to run the OpenMower software
#A working system image, where you can run the OpenMower software
#An ssh connection to your mower
#An Xbox GamePad
#Some source for RTK corrections, I'm using a local base station for this.
#Optional, but very useful: A Linux PC where you can run RVIZ to visualize what your mower is doing

==Test Setup for this Guide==
[[File:OpenMower-GPS-Test-Setup1.jpg|thumb|My GPS Test Setup]]
[[File:OpenMower-GPS-Test-Setup2.jpg|thumb|Open Mower GPS Test Setup Detail]]

===Hardware Used===
For this guide, I'm using the following setup:
* YardForce Classic 500 mower with OpenMower Mainboard and system image as described [[System Image|here]] which is connected to a router via WiFi
* A local RTK base station connected to a router via ethernet
* A GPS antenna on a large tripod (~3 m height) connected to the RTK base station
* A PC connected to the same network for testing
* I am using a relative coordinate system for positioning (check mower_config.sh, if you are not sure about that)

===Network Configuration===
I have used a static IP configuration with the following settings:
'''RTK base station:'''
* Hostname: rtkbase.local
* IP-Address: 192.168.0.100

'''Robot:'''
* Hostname: openmower.local
* IP-Address: 192.168.0.101

===Connect the Components===
First connect the components like it is shown in the pictures on the right. The GPS antenna is connected to the Raspberry Pi base station. The RaspberryPi GPS base station is powered via USB-C power supply and is connected to the router via ethernet. The router needs to be powered as well using the included power supply. My laptop and the mower are both connected to the router via WiFi.

===Testing the Connection===
After connecting the components as described and powering everything, make sure that the network connection works as expected. To do this ping the base station and the mower from your PC using both the IP address and their hostname. If both works, the network setup is successful.

==Testing RTK GPS==
Once you have confirmed, that the network is working correctly, test the RTK GPS. Do this by connecting to your mower using '''two separate ssh sessions''': one for starting the OpenMower software and the other one for looking at the GPS data.

In the first terminal, start the GPS communication part of the OpenMower software by typing <code>roslaunch open_mower _gps.launch</code>. You should see some console output.

In the second terminal, run <code>rostopic echo /ublox/navrelposned</code>. There should be messages shown in the terminal. We are interested in the following fields of the message: '''TODO'''

Wait for the accuracy to reach the value of 100. '''Depending on your configuration, this might take some time. Wait at least 30 minutes before starting to debug anything. First time fix will take some time!''' If your accuracy number drops to 100 and is stable at this value, your RTK GPS is working as intended. If the values does not drop, there is an issue with the RTK setup.

If you are happy with your accuracy, stop the OpenMower software by pressing <code>CRTL+C</code> in your first terminal.

==Magnetometer Calibration==
[[File:Mag Calibration.png|thumb|Example output of the mag_calibration node.]]
After verifying, that the RTK GPS is working as intended, you will need to calibrate your magnetometer. This is important, because the magnets and metal parts embedded in the mower will interfere with the magnetic sensor. That's why it's important to '''do this after finishing the assembly!'''

In order to start magnetometer calibration, start the OpenMower software on the mower using ssh:

<code>roslaunch open_mower _comms.launch</code>

This will start the communication layer between ROS and the mower's hardware.

Now start a second terminal and ssh into your mower.

You can test, that the communication works by using the following command:

<code>rostopic echo /mower/imu</code>

You should now see the raw IMU data printed to the terminal. If this is not the case, you have an error in your setup.

Press <code>CTRL+C</code> to cancel the data display.

Now you can start the calibration process by entering:

<code>rosrun mower_logic mag_calibration</code>

Now rotate the mower '''slowly''' around all three axes.

'''DON'T''' push the emergency stop button during the calibration. It has magnets embedded and will lead to '''wrong calibration.'''

As soon as you're finished, press the enter button. The final values are printed to the terminal.

Stop the first ROS process by pressing <code>CTRL+C</code>.

You can copy and paste the values into your <code>mower_config.sh</code>.

Now '''reload the <code>mower_config.sh</code>''' by entering:

<code>source ~/mower_config.sh</code>

== Area Recording ==
Finally, you can record your mowing areas and the docking station position.

<big>'''There is also a YouTube animation available, watch that first and then read the following text: https://www.youtube.com/watch?v=j7qkwuoHJpI'''</big>

I recommend that you start with a simple area with lots of space around first. This way if something goes wrong, your mower won't instantly crash. You will need to record at least one area and your docking station in order to start mowing.

=== Overview ===
Basically, there are three things to record: The '''Navigation Area, Mowing Areas''' and the '''Docking Station position.'''

* The '''mowing areas''' are the areas which will be mowed by the mower. Each mowing area consists of '''an outline''' and optionally '''areas to avoid'''.
* The '''navigation area''' is the area which the robot may enter during navigation. This is needed to roam between mowing areas and also to find a way to the docking station, if it's not inside a mowing area.
* The '''docking station''' is defined by a position and an orientation. Since the orientation of the mower is not 100% perfect due to magnetometer noise, we'll record two points which are then connected by a line. The direction of this line determines the docking orientation. More on that later
[[File:OpenMower Gamepad.png|thumb|OpenMower Gamepad Controls <small>(image licensed from shutterstock.com)</small>]]

=== Controls ===
During recording mode, you can move the mower and control the recording process using the Xbox game pad:

* '''Hold A''' to move the mower using the '''left analog stick.''' Press '''RB for turbo mode.'''
* '''Press B''' to start / stop recording of the current polygon.
* '''Press Y + D-PAD UP''' to finish your current area and add it to the map as a '''navigation area'''. The robot is allowed to enter the area for navigation (e.g. driving to another area or to the docking station), but the are will not be mowed by the mower.
* '''Press Y + D-PAD DOWN''' to finish your current area and add it to the map as a '''mowing area'''. The robot will mow this area. You will need '''at least one''' mowing area, for the robot to work.
* '''Press X''' to record the first point of the docking position, '''Press X''' again to record the second position of the docking station and save it to the map.

You start and stop the recording mode using buttons on the mower:

* '''Press S1''' to start the recording mode
* '''Press Home''' to stop the recording mode

=== Recording the Mowing Areas ===
At first I like to record the mowing areas. Start with '''one area which is obstacle free.''' As soon as you are more confident in the mower's positioning, you can add more areas complex areas which may also be close to obstacles.

In order to start recording an area, start the OpenMower software using:

<code>roslaunch open_mower open_mower.launch</code>

Before starting the recording, make sure that you have a good GPS fix. You can do that by using the following command '''in a second terminal:'''

<code>rostopic echo /ublox/navrelposned/accLength</code>

This will print the current GPS accuracy in '''0.1 mm''' steps. At full accuracy, you should get a value of 100. '''If it is larger, check your GPS config!'''

Now, with the OpenMower software running and with a good GPS fix, you can start the area recording process. '''For this you will need a gamepad connected to your mower.'''

Start the recording process by either pushing the S1 button on your mower or by executing the following command in a terminal to simulate the button press:

<code>~/open_mower_ros/utils/mower_buttons/press_s1.sh</code>

You should now be able to move your mower using the GamePad (see controls section above).

Running OpenMower

2022-08-23T11:18:13Z

Clemens Elflein: /* Controls */

Now that you have your hardware assembled and the basic software installed on your mower, we can calibrate the magnetometer and start recordings maps and mowing the lawn.

==Prerequisites==
In order to follow this guide, you will need the following:

#A mower modified to run the OpenMower software
#A working system image, where you can run the OpenMower software
#An ssh connection to your mower
#An Xbox GamePad
#Some source for RTK corrections, I'm using a local base station for this.
#Optional, but very useful: A Linux PC where you can run RVIZ to visualize what your mower is doing

==Test Setup for this Guide==
[[File:OpenMower-GPS-Test-Setup1.jpg|thumb|My GPS Test Setup]]
[[File:OpenMower-GPS-Test-Setup2.jpg|thumb|Open Mower GPS Test Setup Detail]]

===Hardware Used===
For this guide, I'm using the following setup:
* YardForce Classic 500 mower with OpenMower Mainboard and system image as described [[System Image|here]] which is connected to a router via WiFi
* A local RTK base station connected to a router via ethernet
* A GPS antenna on a large tripod (~3 m height) connected to the RTK base station
* A PC connected to the same network for testing
* I am using a relative coordinate system for positioning (check mower_config.sh, if you are not sure about that)

===Network Configuration===
I have used a static IP configuration with the following settings:
'''RTK base station:'''
* Hostname: rtkbase.local
* IP-Address: 192.168.0.100

'''Robot:'''
* Hostname: openmower.local
* IP-Address: 192.168.0.101

===Connect the Components===
First connect the components like it is shown in the pictures on the right. The GPS antenna is connected to the Raspberry Pi base station. The RaspberryPi GPS base station is powered via USB-C power supply and is connected to the router via ethernet. The router needs to be powered as well using the included power supply. My laptop and the mower are both connected to the router via WiFi.

===Testing the Connection===
After connecting the components as described and powering everything, make sure that the network connection works as expected. To do this ping the base station and the mower from your PC using both the IP address and their hostname. If both works, the network setup is successful.

==Testing RTK GPS==
Once you have confirmed, that the network is working correctly, test the RTK GPS. Do this by connecting to your mower using '''two separate ssh sessions''': one for starting the OpenMower software and the other one for looking at the GPS data.

In the first terminal, start the GPS communication part of the OpenMower software by typing <code>roslaunch open_mower _gps.launch</code>. You should see some console output.

In the second terminal, run <code>rostopic echo /ublox/navrelposned</code>. There should be messages shown in the terminal. We are interested in the following fields of the message: '''TODO'''

Wait for the accuracy to reach the value of 100. '''Depending on your configuration, this might take some time. Wait at least 30 minutes before starting to debug anything. First time fix will take some time!''' If your accuracy number drops to 100 and is stable at this value, your RTK GPS is working as intended. If the values does not drop, there is an issue with the RTK setup.

If you are happy with your accuracy, stop the OpenMower software by pressing <code>CRTL+C</code> in your first terminal.

==Magnetometer Calibration==
[[File:Mag Calibration.png|thumb|Example output of the mag_calibration node.]]
After verifying, that the RTK GPS is working as intended, you will need to calibrate your magnetometer. This is important, because the magnets and metal parts embedded in the mower will interfere with the magnetic sensor. That's why it's important to '''do this after finishing the assembly!'''

In order to start magnetometer calibration, start the OpenMower software on the mower using ssh:

<code>roslaunch open_mower _comms.launch</code>

This will start the communication layer between ROS and the mower's hardware.

Now start a second terminal and ssh into your mower.

You can test, that the communication works by using the following command:

<code>rostopic echo /mower/imu</code>

You should now see the raw IMU data printed to the terminal. If this is not the case, you have an error in your setup.

Press <code>CTRL+C</code> to cancel the data display.

Now you can start the calibration process by entering:

<code>rosrun mower_logic mag_calibration</code>

Now rotate the mower '''slowly''' around all three axes.

'''DON'T''' push the emergency stop button during the calibration. It has magnets embedded and will lead to '''wrong calibration.'''

As soon as you're finished, press the enter button. The final values are printed to the terminal.

Stop the first ROS process by pressing <code>CTRL+C</code>.

You can copy and paste the values into your <code>mower_config.sh</code>.

Now '''reload the <code>mower_config.sh</code>''' by entering:

<code>source ~/mower_config.sh</code>

== Area Recording ==
Finally, you can record your mowing areas and the docking station position.

<big>'''There is also a YouTube animation available, watch that first and then read the following text:'''</big> https://www.youtube.com/watch?v=j7qkwuoHJpI

I recommend that you start with a simple area with lots of space around first. This way if something goes wrong, your mower won't instantly crash. You will need to record at least one area and your docking station in order to start mowing.

=== Overview ===
Basically, there are three things to record: The '''Navigation Area, Mowing Areas''' and the '''Docking Station position.'''

* The '''mowing areas''' are the areas which will be mowed by the mower. Each mowing area consists of '''an outline''' and optionally '''areas to avoid'''.
* The '''navigation area''' is the area which the robot may enter during navigation. This is needed to roam between mowing areas and also to find a way to the docking station, if it's not inside a mowing area.
* The '''docking station''' is defined by a position and an orientation. Since the orientation of the mower is not 100% perfect due to magnetometer noise, we'll record two points which are then connected by a line. The direction of this line determines the docking orientation. More on that later
[[File:OpenMower Gamepad.png|thumb|OpenMower Gamepad Controls <small>(image licensed from shutterstock.com)</small>]]

=== Controls ===
During recording mode, you can move the mower and control the recording process using the Xbox game pad:

* '''Hold A''' to move the mower using the '''left analog stick.''' Press '''RB for turbo mode.'''
* '''Press B''' to start / stop recording of the current polygon.
* '''Press Y + D-PAD UP''' to finish your current area and add it to the map as a '''navigation area'''. The robot is allowed to enter the area for navigation (e.g. driving to another area or to the docking station), but the are will not be mowed by the mower.
* '''Press Y + D-PAD DOWN''' to finish your current area and add it to the map as a '''mowing area'''. The robot will mow this area. You will need '''at least one''' mowing area, for the robot to work.
* '''Press X''' to record the first point of the docking position, '''Press X''' again to record the second position of the docking station and save it to the map.

You start and stop the recording mode using buttons on the mower:

* '''Press S1''' to start the recording mode
* '''Press Home''' to stop the recording mode

=== Recording the Mowing Areas ===
At first I like to record the mowing areas. Start with '''one area which is obstacle free.''' As soon as you are more confident in the mower's positioning, you can add more areas complex areas which may also be close to obstacles.

In order to start recording an area, start the OpenMower software using:

<code>roslaunch open_mower open_mower.launch</code>

Before starting the recording, make sure that you have a good GPS fix. You can do that by using the following command '''in a second terminal:'''

<code>rostopic echo /ublox/navrelposned/accLength</code>

This will print the current GPS accuracy in '''0.1 mm''' steps. At full accuracy, you should get a value of 100. '''If it is larger, check your GPS config!'''

Now, with the OpenMower software running and with a good GPS fix, you can start the area recording process. '''For this you will need a gamepad connected to your mower.'''

Start the recording process by either pushing the S1 button on your mower or by executing the following command in a terminal to simulate the button press:

<code>~/open_mower_ros/utils/mower_buttons/press_s1.sh</code>

You should now be able to move your mower using the GamePad (see controls section above).

Running OpenMower

2022-08-23T11:16:31Z

Clemens Elflein:

Now that you have your hardware assembled and the basic software installed on your mower, we can calibrate the magnetometer and start recordings maps and mowing the lawn.

==Prerequisites==
In order to follow this guide, you will need the following:

#A mower modified to run the OpenMower software
#A working system image, where you can run the OpenMower software
#An ssh connection to your mower
#An Xbox GamePad
#Some source for RTK corrections, I'm using a local base station for this.
#Optional, but very useful: A Linux PC where you can run RVIZ to visualize what your mower is doing

==Test Setup for this Guide==
[[File:OpenMower-GPS-Test-Setup1.jpg|thumb|My GPS Test Setup]]
[[File:OpenMower-GPS-Test-Setup2.jpg|thumb|Open Mower GPS Test Setup Detail]]

===Hardware Used===
For this guide, I'm using the following setup:
* YardForce Classic 500 mower with OpenMower Mainboard and system image as described [[System Image|here]] which is connected to a router via WiFi
* A local RTK base station connected to a router via ethernet
* A GPS antenna on a large tripod (~3 m height) connected to the RTK base station
* A PC connected to the same network for testing
* I am using a relative coordinate system for positioning (check mower_config.sh, if you are not sure about that)

===Network Configuration===
I have used a static IP configuration with the following settings:
'''RTK base station:'''
* Hostname: rtkbase.local
* IP-Address: 192.168.0.100

'''Robot:'''
* Hostname: openmower.local
* IP-Address: 192.168.0.101

===Connect the Components===
First connect the components like it is shown in the pictures on the right. The GPS antenna is connected to the Raspberry Pi base station. The RaspberryPi GPS base station is powered via USB-C power supply and is connected to the router via ethernet. The router needs to be powered as well using the included power supply. My laptop and the mower are both connected to the router via WiFi.

===Testing the Connection===
After connecting the components as described and powering everything, make sure that the network connection works as expected. To do this ping the base station and the mower from your PC using both the IP address and their hostname. If both works, the network setup is successful.

==Testing RTK GPS==
Once you have confirmed, that the network is working correctly, test the RTK GPS. Do this by connecting to your mower using '''two separate ssh sessions''': one for starting the OpenMower software and the other one for looking at the GPS data.

In the first terminal, start the GPS communication part of the OpenMower software by typing <code>roslaunch open_mower _gps.launch</code>. You should see some console output.

In the second terminal, run <code>rostopic echo /ublox/navrelposned</code>. There should be messages shown in the terminal. We are interested in the following fields of the message: '''TODO'''

Wait for the accuracy to reach the value of 100. '''Depending on your configuration, this might take some time. Wait at least 30 minutes before starting to debug anything. First time fix will take some time!''' If your accuracy number drops to 100 and is stable at this value, your RTK GPS is working as intended. If the values does not drop, there is an issue with the RTK setup.

If you are happy with your accuracy, stop the OpenMower software by pressing <code>CRTL+C</code> in your first terminal.

==Magnetometer Calibration==
[[File:Mag Calibration.png|thumb|Example output of the mag_calibration node.]]
After verifying, that the RTK GPS is working as intended, you will need to calibrate your magnetometer. This is important, because the magnets and metal parts embedded in the mower will interfere with the magnetic sensor. That's why it's important to '''do this after finishing the assembly!'''

In order to start magnetometer calibration, start the OpenMower software on the mower using ssh:

<code>roslaunch open_mower _comms.launch</code>

This will start the communication layer between ROS and the mower's hardware.

Now start a second terminal and ssh into your mower.

You can test, that the communication works by using the following command:

<code>rostopic echo /mower/imu</code>

You should now see the raw IMU data printed to the terminal. If this is not the case, you have an error in your setup.

Press <code>CTRL+C</code> to cancel the data display.

Now you can start the calibration process by entering:

<code>rosrun mower_logic mag_calibration</code>

Now rotate the mower '''slowly''' around all three axes.

'''DON'T''' push the emergency stop button during the calibration. It has magnets embedded and will lead to '''wrong calibration.'''

As soon as you're finished, press the enter button. The final values are printed to the terminal.

Stop the first ROS process by pressing <code>CTRL+C</code>.

You can copy and paste the values into your <code>mower_config.sh</code>.

Now '''reload the <code>mower_config.sh</code>''' by entering:

<code>source ~/mower_config.sh</code>

== Area Recording ==
Finally, you can record your mowing areas and the docking station position.

I recommend that you start with a simple area with lots of space around first. This way if something goes wrong, your mower won't instantly crash. You will need to record at least one area and your docking station in order to start mowing.

=== Overview ===
Basically, there are three things to record: The '''Navigation Area, Mowing Areas''' and the '''Docking Station position.'''

* The '''mowing areas''' are the areas which will be mowed by the mower. Each mowing area consists of '''an outline''' and optionally '''areas to avoid'''.
* The '''navigation area''' is the area which the robot may enter during navigation. This is needed to roam between mowing areas and also to find a way to the docking station, if it's not inside a mowing area.
* The '''docking station''' is defined by a position and an orientation. Since the orientation of the mower is not 100% perfect due to magnetometer noise, we'll record two points which are then connected by a line. The direction of this line determines the docking orientation. More on that later
[[File:OpenMower Gamepad.png|thumb|OpenMower Gamepad Controls <small>(image licensed from shutterstock.com)</small>]]

=== Controls ===
During recording mode, you can move the mower and control the recording process using the Xbox game pad:

* '''Hold A''' to move the mower using the '''left analog stick.''' Press '''RB for turbo mode.'''
* '''Press B''' to start / stop recording of the current polygon.
* '''Press Y + UP''' to finish your current area and add it to the map as a '''navigation area'''. The robot is allowed to enter the area for navigation (e.g. driving to another area or to the docking station), but the are will not be mowed by the mower.
* '''Press Y + DOWN''' to finish your current area and add it to the map as a '''mowing area'''. The robot will mow this area. You will need '''at least one''' mowing area, for the robot to work.
* '''Press X''' to record the first point of the docking position, '''Press X''' again to record the second position of the docking station and save it to the map.

You start and stop the recording mode using buttons on the mower:

* '''Press S1''' to start the recording mode
* '''Press Home''' to stop the recording mode

=== Recording the Mowing Areas ===
At first I like to record the mowing areas. Start with '''one area which is obstacle free.''' As soon as you are more confident in the mower's positioning, you can add more areas complex areas which may also be close to obstacles.

In order to start recording an area, start the OpenMower software using:

<code>roslaunch open_mower open_mower.launch</code>

Before starting the recording, make sure that you have a good GPS fix. You can do that by using the following command '''in a second terminal:'''

<code>rostopic echo /ublox/navrelposned/accLength</code>

This will print the current GPS accuracy in '''0.1 mm''' steps. At full accuracy, you should get a value of 100. '''If it is larger, check your GPS config!'''

Now, with the OpenMower software running and with a good GPS fix, you can start the area recording process. '''For this you will need a gamepad connected to your mower.'''

Start the recording process by either pushing the S1 button on your mower or by executing the following command in a terminal to simulate the button press:

<code>~/open_mower_ros/utils/mower_buttons/press_s1.sh</code>

You should now be able to move your mower using the GamePad (see controls section above).

<big>'''There is also a YouTube animation available:'''</big> https://www.youtube.com/watch?v=j7qkwuoHJpI

File:OpenMower-GPS-Test-Setup2.jpg

2022-08-23T10:47:57Z

Clemens Elflein:

Open Mower GPS Test Setup Detail

File:OpenMower-GPS-Test-Setup1.jpg

2022-08-23T10:40:40Z

Clemens Elflein:

Open Mower GPS Test Setup showing the GPS antenna, RTK base and router.

Flashing firmware on the Pi Pico

2022-07-22T21:23:45Z

Clemens Elflein:

Very rudimentary for now - check https://www.youtube.com/watch?v=_bImqD-pQSA

== How to flash the pi pico from the raspberry pi using openocd ==
'''''Directly copied from a discord conversation'''''

use the .bin file if flashing via openocd or the uf2 file for flashing via usb mass storage

bridge the jumpers like on the right picture (you can leave them like this during normal operation, the idea is that instead of the jumpers you can use an external debugger on those pins as well)
[[File:Bridge-these-Jumpers-for-flashing-Pico-via-SWD and OCD.jpg|thumb]]

on your raspi do<syntaxhighlight lang="shell">
cd open_mower_ros/utils/scripts/
sudo ./upload_firmware.sh /path/to/your/firmware.bin</syntaxhighlight>
{| class="wikitable"
|+Neopixel color
|red
|during boot
|-
|orange - red flashing
|emergency mode and ros is disconnected
|-
|green - red flashing
|emergency mode and ros is connected
|-
|steady green
|ros is connected and no emergency mode is detected
(all voltages are OK, wheels aren't lifted, emergency button is not pressed)
|}

Flashing firmware on the Pi Pico

2022-07-22T21:23:11Z

Clemens Elflein:

Very rudimentary for now - check https://www.youtube.com/watch?v=_bImqD-pQSA

== How to flash the pi pico from the raspberry pi using openocd ==
'''''Directly copied from a discord conversation'''''

use the .bin file if flashing via openocd or the uf2 file for flashing via usb mass storage

bridge the jumpers like on the right picture (you can leave them like this during normal operation, the idea is that instead of the jumpers you can use an external debugger on those pins as well)
[[File:Bridge-these-Jumpers-for-flashing-Pico-via-SWD and OCD.jpg|thumb]]

on your raspi do<syntaxhighlight lang="shell">
cd open_mower_ros/utils/scripts/
sudo ./upload_firmware.sh /path/to/your/firmware.elf</syntaxhighlight>
{| class="wikitable"
|+Neopixel color
|red
|during boot
|-
|orange - red flashing
|emergency mode and ros is disconnected
|-
|green - red flashing
|emergency mode and ros is connected
|-
|steady green
|ros is connected and no emergency mode is detected
(all voltages are OK, wheels aren't lifted, emergency button is not pressed)
|}

Building the Mower

2022-07-22T20:53:20Z

Clemens Elflein: /* Bill OF Materials */

Welcome to the OpenMower Building guide!

Note: This WIKI was only just started on 2022-04-22, but are actively working on filling it up and making a good documentation for the new builders out there!

== Warning ==
Please note that this project currently is in a very early stage! So don't go buying stuff right away! You will need to order and solder your own boards, since there are no assembled boards for sale yet.

Please make sure that you're actually allowed to build this device in your area. There may be laws / patents prohibiting you of doing so!

Please just be responsible and if you're not sure what you're doing, please don't do anything.

BTW the warranty of your brand new mower will obviously be void as soon as you modify it in any way, so be aware.

== Intro ==
Below you can find an overview of the major parts and components in the OpenMower.

There is a also another page with a [[Builder Road Map|'''Builder Road Map''']] that gives guide to how to go about building your own OpenMower project.

== Bill OF Materials ==

{| class="wikitable" style="margin:auto"
|+ Open Mower Bill of Materials
|-
! Name !! Description
!Optional!! Availability !! Quantity Required !! Source Link 1 !! Alternate Source
|-
| Mower (Yardforce Classic 500) || Base building block
| || Off the shelf || 1 ||https://amzn.to/3NWgIxk
| '''Note:''' Earlier, we had a reference to myrobotcenter. However, they have gone into reconstruction, so be aware of that vendor!
|-
| OpenMower Mainboard || The core of the new electronics.
| || Custom || 1 || [https://octopart.com/bom-tool/ODFKeG8J Components Octopart BOM]
| WIP
|-
| xESC || Motor drivers
| || Custom || 3 || Components Octoparts BOM:
- [https://octopart.com/bom-tool/p1aqUopq RP2040 ''without'' CAN]

- [https://octopart.com/bom-tool/tZ27Fd1N RP2040 ''with'' CAN]

- [https://octopart.com/bom-tool/hUY6qiSp STM32]
| WIP
|-
| Raspebrry Pi 4 || The brain of the robot. Also used to send RTK correction data from the base station.

For the base station the Raspberry Pi can be any model with Ethernet and USB, for the robot we need the Raspberry Pi 4 with at least 4 GB of RAM.
| || Off the shelf || 2 || https://rpilocator.com/?cat=PI4&instock<nowiki/>|| WIP
|-
| Ardusimple RTK2B GPS || Positioning system for the bot
| || Off the shelf || 2 || https://www.ardusimple.com/product/simplertk2b-basic-starter-kit-ip65/ || https://www.ardusimple.com/product/simplertk2b-basic-starter-kit-ip65/
|-
| Raspberry Pi Pico|| Microcontroller talking to peripherals, soldered to the OpenMower mainboard
| ||Off the shelf||1||Widely available||
|-
|MPU 9250 (hard to get, end of life) or WT901
|9-axis accelerometer sitting on Mainboard allowing for direction through compass and dead reckoning of movement between GPS updates.
|
|Off the shelf
|1
|NO LINKS ANYMORE, since most of the delivered modules are fakes.
Alternative would be the WT901:

https://amzn.to/3PQsV6O
|
|-
|3D printed brackets||To hold the GPS inside the bot
| ||Custom||1||https://www.printables.com/fr/model/175826-openmower-gps-mount-for-yardforce-classic-500<nowiki/>||WIP
|-
|SMA Angle Adapter
|Needed to connect the GPS without bending the wire too much
|
|Off the shelf
|1
|https://amzn.to/3K913b1
|WIP
|-
|CC/CV Step Down module
| As charger for the docking station
|
|Off the shelf
|1
|https://amzn.to/3NUdRVL
|WIP
|-
|Docking Station Adapter PCB
|A PCB to hold the module in place.
|
|Custom
|1
| WIP
|WIP
|-
|GPS PCB
| A ground plane PCB to improve GPS reception
|
|Custom
|1
|WIP
|WIP
|-
|USB Angle Adapter
|If you want to use the Classic 500's USB port
|YES
|Off the shelf
|1
|https://amzn.to/3ukNAIj
|WIP
|}

==Building the bot==

Once you have gathered up all of the parts, components, tools, and have a set of PCB's, it's time to start building the OpenMower Robot.

First thing first, watch all of Clemen's Youtube video's, and then watch them again. They contain a Treasure Trove of information and should be used as a reference. https://youtu.be/_bImqD-pQSA

Get Organized: Before you start assembling and soldering the PCB's, it's recommended to organize all of your parts. One method is to print off the iBOM.html file, tape it to a piece of cardboard, and then put double sided tape next to each line item. Only take out the parts/components you need for (1) xESC at a time, or the parts for the Mainboard, then place them on the double sided tape. Here are a couple of examples:<gallery>
File:MainBoard-Parts-on-iBOM-wiki.jpg
File:XESC-Parts-on-iBOM-wiki.jpg
</gallery>
Now you want to apply solder paste to your PCB, BUT, before you apply solder paste to your PCB's with a stencil, make sure to wipe down both the PCB and the stencil with isopropanol alcohol to clean the surface, this helps more than you would think. Once the IPA has evaporated, align your stencil on top of the PCB, and use masking tape or painters tape on one side to act as a hinge, so after you apply the solder paste, you can carefully remove the stencil. Please reference Clemen's Youtube video for soldering: https://youtu.be/Y16kbAK3vaU

Here is an example photo of a PCB after applying the solder paste:<gallery>
File:SolderPaste-Example.jpg
</gallery>
Make sure to inspect your entire PCB and the alignment of all components before soldering with a hot-plate / oven / hot-air. See the photo below for an example of all xESC (STM32 version) components placed on the top side of the PCB, being inspected before soldering.<gallery>
File:Solder Paste Inspection.jpg
</gallery>Here is a photo showing top and bottom of (3) completed xESC boards. (STM32 version)<gallery>
File:3-xESCs-complete STM32-Version.jpg
</gallery>
Here is a collection of photos of the OpenMower MainBoard from various Discord Users: (c.ez, vamatis, bhammy187)<gallery>
File:Test-5V-on-MainBoard.jpg
File:Vamatis-mainboard-diode-direction-wiki.jpg
File:Full-power-to-MainBoard.jpg
File:MB-R11 R12-wiki.jpg
</gallery>

== Setup and test==