Module:Documentation: Difference between revisions

From NvWiki
Jump to navigation Jump to search
Created page with "-- This module implements {{documentation}}. -- Get required modules. local getArgs = require('Module:Arguments').getArgs -- Get the config table. local cfg = mw.loadData('Module:Documentation/config') local p = {} -- Often-used functions. local ugsub = mw.ustring.gsub local format = mw.ustring.format ---------------------------------------------------------------------------- -- Helper functions -- -- These are defined as local functions, but are made available in..."
Line 1: Line 1:
-- This module implements {{documentation}}.
{{talk header}}
{{permprot}}
{{Centralized talk page|text=all talk pages of subtemplates, and Module talk:Documentation, redirect here}}
{{WikiProject banner shell|
{{WikiProject Templates|template_for_template_maintenance=y}}
}}
{{copied|from1=Template:Documentation|from_oldid1=948472454|to1=:incubator:Template:Wp/nod/Documentation|to_diff1=4237152
|from2=Template:Documentation|from_oldid2=948472454|to2=:incubator:Template:Wp/nod/documentation|to_diff2=4237211
|from3=Module:Documentation/config|from_oldid3=729280654|to3=:incubator:Module:Wp/nod/Documentation/config|to_diff3=4237079}}
{{User:MiszaBot/config
| algo                = old(90d)
| archive            = Template talk:Documentation/Archive %(counter)d
| counter            = 10
| maxarchivesize      = 150K
| archiveheader      = {{Automatic archive navigator}}
| minthreadstoarchive = 1
| minthreadsleft      = 4
}}


-- Get required modules.
== Heading displays wrongly in mobile view ==
local getArgs = require('Module:Arguments').getArgs


-- Get the config table.
In mobile but not desktop view, there is no space between ''Documentation'' and the first link: for example I see
local cfg = mw.loadData('Module:Documentation/config')
:'''Documentation'''{{bracket|view}} {{bracket|edit}} {{bracket|history}} {{bracket|purge}}
instead of
:'''Documentation''' {{bracket|view}} {{bracket|edit}} {{bracket|history}} {{bracket|purge}}
This is true both on the mobile webpage and in the Android app, but the desktop view is fine. Using <code>|heading=Documentation&amp;nbsp;</code> as a workaround produces the correct appearance on mobile, but the extra space is then visible in desktop view. [[User:Musiconeologist|Musiconeologist]] ([[User talk:Musiconeologist|talk]]) 12:35, 21 March 2025 (UTC)


local p = {}
:Vector 2022 imports [https://gerrit.wikimedia.org/g/mediawiki/core/+/68091cb23efa8cc293ded9be041ef5bcfd160d59/resources/src/mediawiki.skinning/interface-edit-section-links.less#23 this rule]. Minerva does not. This is a bug/difference in Minerva. [[User:Izno|Izno]] ([[User talk:Izno|talk]]) 21:10, 26 September 2025 (UTC)
:[[phab:T405802]], but I couldn't say if it will be fixed/corrected. [[User:Izno|Izno]] ([[User talk:Izno|talk]]) 21:18, 26 September 2025 (UTC)


-- Often-used functions.
== Background Color Lint error "coming from inside the house" ==
local ugsub = mw.ustring.gsub
local format = mw.ustring.format


----------------------------------------------------------------------------
While resolving [[Special:LintErrors/night-mode-unaware-background-color|Lint background color]] error messages, I've noticed that the occasional article's error will trace all the way back to [[Template:Documentation]] and the ''invoke:documentation'' statement (i.e. the '''''<nowiki>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</nowiki>''''' statement).
-- 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)
A current example is the article for [[Colin Jackson]]:
--[[
* It simply invokes '''''<nowiki>{{Navboxes}}</nowiki>''''' which, in turn, simply invokes '''''<nowiki>{{documentation}}</nowiki>'''''.  
-- Gets a message from the cfg table and formats it if appropriate.
*Drilling down into the [https://w.wiki/F8Um Page Information for "Template:Documentation" § Lint Errors] section's link to [https://w.wiki/F8VB View detailed information on the lint errors] then brings us to the ''invoke:documentation'' statement, beyond which point I am unable to navigate further to determine the cause of the background color error.  
-- The function raises an error if the value from the cfg table is not
-- of the type expectType. The default type for expectType is 'string'.
-- If the table valArray is present, strings such as $1, $2 etc. in the
-- message are substituted with values from the table keys [1], [2] etc.
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."
--]]
local msg = cfg[cfgKey]
expectType = expectType or 'string'
if type(msg) ~= expectType then
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
end
if not valArray then
return msg
end


local function getMessageVal(match)
Typically the root issue behind this Lint error is the use of the 'background:' or 'background-color:' CSS properties without a corresponding 'color:' property (for specifying font color; preferably something that contrasts well with the specified background color).
match = tonumber(match)
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
end


return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
Is it possible for someone to determine what color-related hi-jinks might be going on behind the scenes (and either remove or complete any incomplete background:/color: property pairings)? Resolving this should presumably clear at least [https://linkcount.toolforge.org/?project=en.wikipedia.org&page=Template%3ANavboxes#transclusions 60K] lint errors (i.e. any pages using [[Template:Navboxes|Navboxes]]).
end


p.message = message
Many thanks in advance,<br />
[[User:SirOlgen|SirOlgen]] ([[User talk:SirOlgen|talk]]) 22:24, 25 August 2025 (UTC)
: This report is conflating two completely separate issues, which is why you're being led down a garden path.
: Issue 1: There's a lint error somewhere in the navboxes at the bottom of [[Colin Jackson]]. Probably one of the navboxes on that article sets a background-color without a color.
: Issue 2: There's a lint error somewhere on [[Template:Navboxes/doc]], presumably in one of the navboxes called at [[Template:Navboxes/doc#Examples]].
: These two lint errors are independent of each other, and fixing one will have nothing do do with the other. [[User:Pppery|* Pppery *]] [[User talk:Pppery|<sub style="color:#800000">it has begun...</sub>]] 22:34, 25 August 2025 (UTC)
::Thanks much for the clarification. I'll see what I can do to root it (them?) out.
::[[User:SirOlgen|SirOlgen]] ([[User talk:SirOlgen|talk]]) 22:40, 25 August 2025 (UTC)
::Culprits were...
::Issue 1: [[Template:Footer Australia NC 110m Hurdles Men]] and [[Template:Footer European Indoor Champions 60m Men]]
::Issue 2: [[Template:Navbox suite]], [[Template:S-aft/doc]], [[Template:S-bef/doc]], [[Template:S-ttl/doc]], {{slink|Template:Navboxes/doc#Examples}}, [[Template:Template-linking templates]], [[Template:Template link general/doc]], [[Template:Key top]], [[Template:Color/doc]], [[Template:Namespace and pagename-detecting templates]], [[Template:Test case/doc]], [[Template:Navboxes/testcases]], [[Template:Country data United States/doc]], [[Template:Country data Japan/doc]], [[Template:Country data Germany/doc]], [[Template:Hlist/doc]], and [[Template:Yesno/doc]] ('''''thus far'''... will have to come back to this as the significant other is feeling neglected'')
::It's quite the rabbit hole.
::In any case, thanks again for the tips!
::[[User:SirOlgen|SirOlgen]] ([[User talk:SirOlgen|talk]]) 04:10, 26 August 2025 (UTC)
{{Template edit request|Module:Documentation/styles.css|answered=yes}}
I've recently completed some edit requests for editor {{u|SirOlgen}}, who has been working on these lint errors. Template {{tl|Documentation}} is <span class="plainlinks">[https://en.wikipedia.org/w/index.php?title=Template:Documentation&action=info '''still throwing this error''']</span>. I'm not well-versed in Lua, tho' I found a background color setting at the top of the [[Module:Documentation/styles.css|styles.css]] module. I don't know how to add the text color, and that is what is needed to fix the lint error. Try to imagine how many templates there are with /doc pages that might benefit from fixing this. Can we hear from a Lua editor? '''''[[User:Paine Ellsworth|<span style="font-size:92%;color:darkblue;font-family:Segoe Script">P.I.&nbsp;Ellsworth</span>]]'''''&thinsp;,&nbsp;[[Editor|<span style="color:black">ed.</span>]]&nbsp;–&nbsp;[[User talk:Paine Ellsworth|''welcome!'']]&nbsp;–&nbsp;<small>04:39, 2 October 2025 (UTC)</small>
:'''PS.''' Later noted that there are other background color settings in that styles.css module. '''''[[User:Paine Ellsworth|<span style="font-size:92%;color:darkblue;font-family:Segoe Script">P.I.&nbsp;Ellsworth</span>]]'''''&thinsp;,&nbsp;[[Editor|<span style="color:black">ed.</span>]]&nbsp;–&nbsp;[[User talk:Paine Ellsworth|''welcome!'']]&nbsp;–&nbsp;<small>04:59, 2 October 2025 (UTC)</small>
::More garden paths, but I think I found both rabbits. I added color declarations to the .css page and to [[:Template:Documentation/doc]], which did not require an edit request. – [[User:Jonesey95|Jonesey95]] ([[User talk:Jonesey95|talk]]) 12:49, 2 October 2025 (UTC)
:::{{U|SirOlgen}}, of the pages you list in "Issue 2" above, only [[:Template:Navboxes/doc]] and [[:Template:Navboxes/testcases]] are showing errors, probably due to one or more of the example templates on each page. The pages are not protected, so have fun with them once your SO is tired of your attention. – [[User:Jonesey95|Jonesey95]] ([[User talk:Jonesey95|talk]]) 12:58, 2 October 2025 (UTC)
::::@[[User:Jonesey95|Jonesey95]]/@[[User:Paine Ellsworth|Paine Ellsworth]], thanks for the recent assists. The pages listed under ''"Culprits were..."'' above were all updated to clear the color errors as I was going down the garden path. I never did make it back to resume the hunt from where I'd left off.
::::Regarding the persistent {{tl|Navboxes}} color error, I have since noticed that it can be suppressed on pages using that template by explicitly declaring the '''color''' attribute in the ''titlestyle'' parameter ([https://en.wikipedia.org/w/index.php?title=Colin_Jackson&diff=prev&oldid=1311624612 example]). {{tl|Navboxes/doc}} mentions that the ''titlestyle'' background ''"defaults to #CCCCFF"'', so I figured passing a text color would ensure a complete attribute pair. Wherever it is that this background color defaulting occurs, would adding companion text color defaulting nip this particular issue in the bud? – [[User:SirOlgen|SirOlgen]] ([[User talk:SirOlgen|talk]]) 18:11, 2 October 2025 (UTC)
:::::I believe that I have made color:inherit the default in Template:navboxes as of a moment ago, so you should not have to add titlestyle colors to any articles. Let me know if you notice any problems. I checked the template in both dark and light modes. – [[User:Jonesey95|Jonesey95]] ([[User talk:Jonesey95|talk]]) 18:48, 2 October 2025 (UTC)
::::::Thanks for the module tweak. That does appear to have resolved the issue (with the subs as well), but I'll keep my eyes open going forward. – [[User:SirOlgen|SirOlgen]] ([[User talk:SirOlgen|talk]]) 19:28, 2 October 2025 (UTC)


local function makeWikilink(page, display)
== Update sandbox icon to match all other templates ==
if display then
{{fper|Template:Editnotices/Namespace/Template|Template:Editnotices/Namespace/Module|Template:Editnotices/Page/Template:Old moves/doc|ans=y}}
return format('[[%s|%s]]', page, display)
else
return format('[[%s]]', page)
end
end


p.makeWikilink = makeWikilink
I think [[:File:Sandbox.svg|the icon]] that currently appears when viewing the sandbox of a template (which seems to come from [[Module:Documentation/config#L-34]] and [[Template:Template sandbox notice]]) doesn't represent the concept well. (See an [[Template:Format/sandbox|example of how it looks]].) The sand is too brown, the lighting is off (all three objects seem to receive light from different light sources), and the colours are unusual. And it's not even a "sand box"! ''There is no box in the sandbox icon...''


local function makeCategoryLink(cat, sort)
{{ombox
local catns = mw.site.namespaces[14].name
  |image = [[File:Sandbox.svg|50px|alt=|link=]]
return makeWikilink(catns .. ':' .. cat, sort)
  |text = This is the [[Wikipedia:Template sandbox and test cases|template sandbox]] page for {{#if:|[[]]|[[:{{NAMESPACE}}:{{BASEPAGENAME}}]]__EXPECTUNUSEDTEMPLATE__}}{{#if:{{REVISIONID}}
end
  |&#32;([{{fullurl:Special:ComparePages | page1={{#if:|{{FULLPAGENAMEE:}}|{{NAMESPACEE}}:{{BASEPAGENAMEE}}}}&page2={{FULLPAGENAMEE}}}} diff])
  |<!-- hide when previewing -->
  }}.{{#ifexist:{{#rel2abs: ../testcases}}
  | &#32;See also the companion subpage for [[../testcases|test cases]].
  }}
}}


p.makeCategoryLink = makeCategoryLink
I think it should be updated to use [[:File:Edit In Sandbox Icon - Color.svg|the standard sandbox icon]], already used in all other sandbox templates, such as [[Template:Sandbox heading]], [[Template:Sandbox notice]], [[Template:Template sandbox]], [[Template:Template sandbox heading]], [[Template:Not a sandbox]], and [[Template:X20|more]].  


local function makeUrlLink(url, display)
{{ombox
return format('[%s %s]', url, display)
  |image = [[File:Edit In Sandbox Icon - Color.svg|50px|alt=|link=]]
end
  |text = {{pb}}This is the [[Wikipedia:Template sandbox and test cases|template sandbox]] page for {{#if:|[[]]|[[:{{NAMESPACE}}:{{BASEPAGENAME}}]]__EXPECTUNUSEDTEMPLATE__}}{{#if:{{REVISIONID}}
  |&#32;([{{fullurl:Special:ComparePages | page1={{#if:|{{FULLPAGENAMEE:}}|{{NAMESPACEE}}:{{BASEPAGENAMEE}}}}&page2={{FULLPAGENAMEE}}}} diff])
  |<!-- hide when previewing -->
  }}.{{#ifexist:{{#rel2abs: ../testcases}}
  | &#32;See also the companion subpage for [[../testcases|test cases]].{{pb}}
  }}
}}


p.makeUrlLink = makeUrlLink
This icon uses less daunting colours and is more detailed while also adding more items to the box, such as the pencil and the document being changed. [[User:FaviFake|FaviFake]] ([[User talk:FaviFake|talk]]) 16:32, 26 September 2025 (UTC)
:Since this page is whatchlisted by 165 editors and none have responded after 17 days, I'll assume there's [[WP:SILENT]] consensus and apply the tper template. [[User:FaviFake|FaviFake]] ([[User talk:FaviFake|talk]]) 17:18, 13 October 2025 (UTC)
::{{complete2}}. '''''[[User:Paine Ellsworth|<span style="font-size:92%;color:darkblue;font-family:Segoe Script">P.I.&nbsp;Ellsworth</span>]]'''''&thinsp;,&nbsp;[[Editor|<span style="color:black">ed.</span>]]&nbsp;–&nbsp;[[User talk:Paine Ellsworth|''welcome!'']]&nbsp;–&nbsp;<small>18:15, 13 October 2025 (UTC)</small>
:::Thanks @[[User:Paine Ellsworth|Paine Ellsworth]], but I noticed that the old icon is still present in the editnotice when editing a template, such as here: [https://en.wikipedia.org/w/index.php?title=Template:Village_pump_page_header&action=edit]. <s>I think this may be caused by [[Module:Documentation]] itself? Could you try making this change to [[Module:Documentation]]? [[Special:Diff/1280044025/1318783040]].</s><s>It's possible not even this will fix it, but </s> I can't manage to find the origin of that specific edit notice. [[User:FaviFake|FaviFake]] ([[User talk:FaviFake|talk]]) 00:04, 26 October 2025 (UTC)
:::: That edit can't possibly do anything because it's in a Lua comment. [[User:Pppery|* Pppery *]] [[User talk:Pppery|<sub style="color:#800000">it has begun...</sub>]] 00:05, 26 October 2025 (UTC)
:::::Yeah I thought it could be a comment, since it was gray and in italic. Does anyone know where that editnotice is coming from? [[User:FaviFake|FaviFake]] ([[User talk:FaviFake|talk]]) 00:07, 26 October 2025 (UTC)
:::::FOUND IT! It comes from [[Template:Editnotices/Namespace/Template]] and [[Template:Editnotices/Namespace/Module]]. The reason i couldn't find it is because it uses a .PNG file instead of the newer .SVG file. This is the change in [[Template:Editnotices/Namespace/Template]] that would fix the image:{{pb}}<!-- Generated using w:en:User:NguoiDungKhongDinhDanh/FormattedEditRequest -->
:::::{| class="diff diff-editfont-monospace" style="margin: auto; font-size: small; overflow-wrap: break-word;"
|-
| class="diff-lineno" | Line 28:
| class="diff-lineno" | Line 28:
|-
| class="diff-context diff-side-deleted" | <nowiki>  |testcases &lt;small style="font-style: normal"&gt;([{{fullurl:{{FULLPAGENAME}}/testcases|action=edit&amp;preload=Template:Documentation/preload-testcases}} create])&lt;/small&gt;</nowiki>
| class="diff-context diff-side-added" | <nowiki>  |testcases &lt;small style="font-style: normal"&gt;([{{fullurl:{{FULLPAGENAME}}/testcases|action=edit&amp;preload=Template:Documentation/preload-testcases}} create])&lt;/small&gt;</nowiki>
|-
| class="diff-context diff-side-deleted" | <nowiki>  }} pages.</nowiki>
| class="diff-context diff-side-added" | <nowiki>  }} pages.</nowiki>
|-
| class="diff-deletedline diff-side-deleted" | <nowiki>  | image = [[File:Sandbox.</nowiki><del class="diffchange diffchange-inline"><nowiki>png</nowiki></del><nowiki>|40px|alt=|link=]]</nowiki>
| class="diff-addedline diff-side-added" | <nowiki>  | image = [[File:</nowiki><ins class="diffchange diffchange-inline"><nowiki>Edit In </nowiki></ins><nowiki>Sandbox</nowiki><ins class="diffchange diffchange-inline"><nowiki> Icon - Color</nowiki></ins><nowiki>.</nowiki><ins class="diffchange diffchange-inline"><nowiki>svg</nowiki></ins><nowiki>|40px|alt=|link=]]</nowiki>
|-
| class="diff-context diff-side-deleted" | <nowiki>  | class = plainlinks</nowiki>
| class="diff-context diff-side-added" | <nowiki>  | class = plainlinks</nowiki>
|-
| class="diff-context diff-side-deleted" | <nowiki> }}</nowiki>
| class="diff-context diff-side-added" | <nowiki> }}</nowiki>
|}
:::::{{pb}}And change [[Template:Editnotices/Namespace/Module]] to:<br><!-- Generated using w:en:User:NguoiDungKhongDinhDanh/FormattedEditRequest -->
:::::{| class="diff diff-editfont-monospace" style="margin: auto; font-size: small; overflow-wrap: break-word;"
|-
| class="diff-lineno" | Line 23:
| class="diff-lineno" | Line 23:
|-
| class="diff-context diff-side-deleted" | <nowiki>  |testcases &lt;small style="font-style: normal"&gt;([{{fullurl:{{FULLPAGENAME}}/testcases|action=edit&amp;preload=Template:Documentation/preload-module-testcases}} create])&lt;/small&gt;</nowiki>
| class="diff-context diff-side-added" | <nowiki>  |testcases &lt;small style="font-style: normal"&gt;([{{fullurl:{{FULLPAGENAME}}/testcases|action=edit&amp;preload=Template:Documentation/preload-module-testcases}} create])&lt;/small&gt;</nowiki>
|-
| class="diff-context diff-side-deleted" | <nowiki>  }} pages.</nowiki>
| class="diff-context diff-side-added" | <nowiki>  }} pages.</nowiki>
|-
| class="diff-deletedline diff-side-deleted" | <nowiki>  | image = [[File:Sandbox.</nowiki><del class="diffchange diffchange-inline"><nowiki>png</nowiki></del><nowiki>|40px|alt=|link=]]</nowiki>
| class="diff-addedline diff-side-added" | <nowiki>  | image = [[File:</nowiki><ins class="diffchange diffchange-inline"><nowiki>Edit In </nowiki></ins><nowiki>Sandbox</nowiki><ins class="diffchange diffchange-inline"><nowiki> Icon - Color</nowiki></ins><nowiki>.</nowiki><ins class="diffchange diffchange-inline"><nowiki>svg</nowiki></ins><nowiki>|40px|alt=|link=]]</nowiki>
|-
| class="diff-context diff-side-deleted" | <nowiki> }}</nowiki>
| class="diff-context diff-side-added" | <nowiki> }}</nowiki>
|-
| class="diff-context diff-side-deleted" | <nowiki>}}&lt;!--</nowiki>
| class="diff-context diff-side-added" | <nowiki>}}&lt;!--</nowiki>
|}
:::::{{pb}}And this change to [[Template:Editnotices/Page/Template:Old moves/doc]]:<br><!-- Generated using w:en:User:NguoiDungKhongDinhDanh/FormattedEditRequest -->
:::::{| class="diff diff-editfont-monospace" style="margin: auto; font-size: small; overflow-wrap: break-word;"
|-
| class="diff-lineno" | Line 6:
| class="diff-lineno" | Line 6:
|-
| class="diff-context diff-side-deleted" | <nowiki>| text = Editors can experiment in this documentation page's [[Template:Old moves/doc/sandbox|sandbox]].</nowiki>
| class="diff-context diff-side-added" | <nowiki>| text = Editors can experiment in this documentation page's [[Template:Old moves/doc/sandbox|sandbox]].</nowiki>
|-
| class="diff-context diff-side-deleted" | <nowiki>| textstyle =</nowiki>
| class="diff-context diff-side-added" | <nowiki>| textstyle =</nowiki>
|-
| class="diff-deletedline diff-side-deleted" | <nowiki>| image = Sandbox.</nowiki><del class="diffchange diffchange-inline"><nowiki>png</nowiki></del>
| class="diff-addedline diff-side-added" | <nowiki>| image =</nowiki><ins class="diffchange diffchange-inline"><nowiki> Edit In</nowiki></ins><nowiki> Sandbox</nowiki><ins class="diffchange diffchange-inline"><nowiki> Icon - Color</nowiki></ins><nowiki>.</nowiki><ins class="diffchange diffchange-inline"><nowiki>svg</nowiki></ins>
|-
| class="diff-context diff-side-deleted" | <nowiki>| imagesize = 60px</nowiki>
| class="diff-context diff-side-added" | <nowiki>| imagesize = 60px</nowiki>
|-
| class="diff-context diff-side-deleted" | <nowiki>| style =</nowiki>
| class="diff-context diff-side-added" | <nowiki>| style =</nowiki>
|} [[User:FaviFake|FaviFake]] ([[User talk:FaviFake|talk]]) 00:15, 26 October 2025 (UTC)
::::::Have always found it weird we use a cat [[litter box]] over a practice icon. <span style="display:inline-flex;rotate:-15deg;color:darkblue">'''[[User:Moxy|Moxy]]'''</span><span style="display:inline-flex;rotate:15deg;color:darkblue">[[User talk:Moxy|🍁]]</span> 15:57, 26 October 2025 (UTC)
:::::::I believe the icon is actually just a [https://www.google.com/search?num=10&newwindow=1&sca_esv=50bc830c1331a679&sxsrf=AE3TifOruT08uE3j8E4hV6QT0o83FU8zaw:1761494349411&udm=2&fbs=AIIjpHxU7SXXniUZfeShr2fp4giZrjP_Cx0LI1Ytb_FGcOviEsFlSFI0ur0eAAE6ZS9wNBqSr4xirlKiL2AZV5emS7qFqGC1osJrpUTUiwImwUJXRYJI3DKSDSHJJUHzURou2Fm-BuU0fMTVsCA5plHkltGSIvQc0DBLGIcBTOuAqYDa5RG_npoh7IUZtZ7mZ2NnbCVXxBKe&q=sandbox&sa=X&ved=2ahUKEwikv-HnncKQAxXa97sIHSklNL8QtKgLegQIEhAB&biw=1830&bih=863&dpr=1.05 sandbox], like those used by kids on parks. It has the little blue toy shovel.{{pb}}I've instead always found it weird that in the old sandbox icon there is no "sand box". It's just a pile of sand on the ground. [[User:FaviFake|FaviFake]] ([[User talk:FaviFake|talk]]) 16:04, 26 October 2025 (UTC)
::::::::Looks like a blue [[Pooper-scooper]] to anyone in North America. <span style="display:inline-flex;rotate:-15deg;color:darkblue">'''[[User:Moxy|Moxy]]'''</span><span style="display:inline-flex;rotate:15deg;color:darkblue">[[User talk:Moxy|🍁]]</span> 16:07, 26 October 2025 (UTC)
:::::::::We should be using a sandbox'''ing''' symbol [https://www.shutterstock.com/image-vector/sandboxing-editable-stroke-vector-icon-2581493775] or [https://www.flaticon.com/free-icon/sandbox_6843458] vs a playground sandbox symbol [https://imgbin.com/png/AMamUZSY/playground-icon-sandbox-icon-png]. That said will implement the above request in 24 hours if there's no objections. <span style="display:inline-flex;rotate:-15deg;color:darkblue">'''[[User:Moxy|Moxy]]'''</span><span style="display:inline-flex;rotate:15deg;color:darkblue">[[User talk:Moxy|🍁]]</span> 16:15, 26 October 2025 (UTC)
::::::::::This is a fully-protected edit request. However, as a template editor, you should still be able to implement the third suggestion. [[User:FaviFake|FaviFake]] ([[User talk:FaviFake|talk]]) 16:22, 26 October 2025 (UTC)
:::::::::::Yeah let's just do it and see if people complain. <span style="display:inline-flex;rotate:-15deg;color:darkblue">'''[[User:Moxy|Moxy]]'''</span><span style="display:inline-flex;rotate:15deg;color:darkblue">[[User talk:Moxy|🍁]]</span> 16:25, 26 October 2025 (UTC)
I have updated [[Template:Editnotices/Namespace/Module]] and [[Template:Editnotices/Namespace/Template]]. Please note the third page has been deleted &mdash;&nbsp;Martin <small>([[User:MSGJ|MSGJ]]&nbsp;·&nbsp;[[User talk:MSGJ|talk]])</small> 15:55, 1 November 2025 (UTC)


local function makeToolbar(...)
==Discussion at [[:Template talk:Documentation subpage#Fix per WP:SOB|Template talk:Documentation subpage §&nbsp;Fix per WP:SOB]]==
local ret = {}
[[File:Symbol watching blue lashes high contrast.svg|25px|link=|alt=]]&nbsp;You are invited to join the discussion at [[:Template talk:Documentation subpage#Fix per WP:SOB|Template talk:Documentation subpage §&nbsp;Fix per WP:SOB]]. <!-- Template:Please see --> [[User:FaviFake|FaviFake]] ([[User talk:FaviFake|talk]]) 16:37, 17 November 2025 (UTC) [[User:FaviFake|FaviFake]] ([[User talk:FaviFake|talk]]) 16:37, 17 November 2025 (UTC)
local lim = select('#', ...)
if lim < 1 then
return nil
end
for i = 1, lim do
ret[#ret + 1] = select(i, ...)
end
-- 'documentation-toolbar'
return format(
'<span class="%s">(%s)</span>',
message('toolbar-class'),
table.concat(ret, ' &#124; ')
)
end


p.makeToolbar = makeToolbar
== Show improve documentation if doc doesn't exists? ==


----------------------------------------------------------------------------
Should this template be modified to show {{tl|improve documentation}} by default to templates/modules that doesn't have a documentation? This will auto list the template/modules to [[:Category:Templates with missing or incorrect documentation]], which is useful for tracking and fixing. [[User:Nvdtn19|Nvdtn19]] ([[User talk:Nvdtn19|talk]]) 05:39, 2 December 2025 (UTC)
-- Argument processing
----------------------------------------------------------------------------


local function makeInvokeFunc(funcName)
:I support this. All templates should have documentation, even if it's something basic like "see the parent template for detailed information". What seems obvious to the creator of the template, might not be to others who encounter it and might not be 10 years down the road to no one. [[User:Gonnym|Gonnym]] ([[User talk:Gonnym|talk]]) 13:56, 2 December 2025 (UTC)
return function (frame)
::That said, there are cases where the documentation is in the body of template and not a /doc page, such as navboxes that use {{tl|Navbox documentation}} or WikiProject banners that use the auto generated documentation. Those cases should be tested to make sure they don't fill up the category. [[User:Gonnym|Gonnym]] ([[User talk:Gonnym|talk]]) 13:59, 2 December 2025 (UTC)
local args = getArgs(frame, {
:::Of course, {{tl|improve documentation}} will only shows if the namespace is template/module, and if the template which is transcluding {{tl|documentation}}, does not have any documentation. The viwiki version of this template have already implemented this feature, you can see some demo:
valueFunc = function (key, value)
:::* [[w:vi:Bản mẫu:!w]] (with no /doc, no <code>|content=</code>, and no auto-generated doc. Thus it's showing {{tl|improve documentation}})
if type(value) == 'string' then
:::* [[w:vi:Bản mẫu:Brackets]] (with inline <code>|content=</code>)
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
:::* [[w:vi:Bản mẫu:Valve]] (with {{tl|Navbox documentation}} transcluded)
if key == 'heading' or value ~= '' then
:::* [[w:vi:Bản mẫu:Sơ khai]] (with auto-generated doc from module).
return value
:::If this change are also considered useful here then I'll suggest some changes, but I'll have to test first. [[User:Nvdtn19|Nvdtn19]] ([[User talk:Nvdtn19|talk]]) 14:45, 2 December 2025 (UTC)
else
*I'm wondering if it wouldn't be better setting this up as a bot task to allow for a gap between the template creation process and building documentation. I know I've created a number of templates by starting off with a basic functioning and the standard <code>&lt;noinclude&gt; {{((}}documentation{{))}} &lt;/noinclude&gt;</code> ending knowing that I won't be able to build documentation until I'm done working out all the kinks and details in the code, but having that blank documentation section reminds me to come back to instructions once I've finished programming. I would hate to have overzealous gnomes coming in to try to figure out my template while I'm still fixing bugs because it ended up in a tracking category prematurely. At least if a bot were coming in, I'd be able to remove {{tlx|improve documentation}} once it got added if things weren't ready for that step yet. [[User:Vanisaac|Van]][[User talk:Vanisaac|Isaac]], GHTV<sup> [[Special:Contributions/Vanisaac|contr]]</sup><sub style="margin-left:-4.2ex"><small>[[User:Vanisaac/about|about]]</small></sub> 17:32, 2 December 2025 (UTC)
return nil
*:Ideally, if your template still has kinks in it, start it in your userspace or draft space (or /sandbox if it is one). We shouldn't be placing a non-functioning template in the "live" template space. [[User:Gonnym|Gonnym]] ([[User talk:Gonnym|talk]]) 17:57, 2 December 2025 (UTC)
end
*::I agree with Gonnym. Don't expect unfinished things that is outside the sandbox can't be touched by others. I don't understand why it would be disruptive when {{tl|improve documentation}} is present on templates that lacks documentation, while it clearly reflects the actual situation? So if the project currently has 10,000 templates without documentation, we have to deploy a bot just to add {{tl|improve documentation}} to those 10,000 pages, while a better one-time methods exists? If you don't want your template be flagged, better start it in your sandbox, or not adding {{tl|documentation}} until there is one. [[User:Nvdtn19|Nvdtn19]] ([[User talk:Nvdtn19|talk]]) 05:35, 3 December 2025 (UTC)
else
*:::So, who's gonna implement this in the sandbox? [[User:FaviFake|FaviFake]] ([[User talk:FaviFake|talk]]) 15:54, 17 December 2025 (UTC)
return value
*:: Yes, well that's just the thing, isn't it? Almost nothing operates on a platonic ideal. While I am more than willing, and have frequently built templates in userspace, that's not something that everyone would even think to do, let alone a well-known operating procedure that people follow to any extent. While we do have the draft namespace for articles, there's really no policy for anything but new accounts to even build any content in their private userspace as a matter of course. The point is that when dealing with seemingly simple templates, drafting in userspace and moving into the template namespace is usually more hassle than is warranted, but that doesn't prevent the intricacies of template logic from biting us from time to time. So I reiterate that I would think a parameter for empty documentation that is supported by a maintenance bot would be a more robust option for accomplishing the task. [[User:Vanisaac|Van]][[User talk:Vanisaac|Isaac]], GHTV<sup> [[Special:Contributions/Vanisaac|contr]]</sup><sub style="margin-left:-4.2ex"><small>[[User:Vanisaac/about|about]]</small></sub> 18:23, 17 December 2025 (UTC)
end
*I support this. Checking if a page or template parameter is empty is a perfect task for a template/bot. [[User:FaviFake|FaviFake]] ([[User talk:FaviFake|talk]]) 17:41, 2 December 2025 (UTC)
end
})
return p[funcName](args)
end
end


----------------------------------------------------------------------------
== Documentation template source code ==
-- Entry points
----------------------------------------------------------------------------


function p.nonexistent(frame)
Can someone provide me with the source code for this template? I'd like to use it on my own wiki. Thanks! [[Special:Contributions/&#126;2025-38484-04|&#126;2025-38484-04]] ([[User talk:&#126;2025-38484-04|talk]]) 16:49, 6 December 2025 (UTC)
if mw.title.getCurrentTitle().subpageText == 'testcases' then
: You can click "view source" at the top of the page to see the source code. You also need to copy the source code of [[Module:Documentation]] and the other dependencies listed on the top right corner of that page. [[User:Pppery|* Pppery *]] [[User talk:Pppery|<sub style="color:#800000">it has begun...</sub>]] 20:20, 6 December 2025 (UTC)
return frame:expandTemplate{title = 'module test cases notice'}
else
return p.main(frame)
end
end
 
p.main = makeInvokeFunc('_main')
 
function p._main(args)
--[[
-- This function defines logic flow for the module.
-- @args - table of arguments passed by the user
--]]
local env = p.getEnvironment(args)
local root = mw.html.create()
root
:wikitext(p._getModuleWikitext(args, env))
:wikitext(p.protectionTemplate(env))
:wikitext(p.sandboxNotice(args, env))
:tag('div')
-- 'documentation-container'
:addClass(message('container'))
:attr('role', 'complementary')
:attr('aria-labelledby', args.heading ~= '' and 'documentation-heading' or nil)
:attr('aria-label', args.heading == '' and 'Documentation' or nil)
:newline()
:tag('div')
-- 'documentation'
:addClass(message('main-div-classes'))
:newline()
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:tag('div')
-- 'documentation-clear'
:addClass(message('clear'))
:done()
:newline()
:done()
:wikitext(p._endBox(args, env))
:done()
:wikitext(p.addTrackingCategories(env))
-- 'Module:Documentation/styles.css'
return mw.getCurrentFrame():extensionTag (
'templatestyles', '', {src=cfg['templatestyles']
}) .. tostring(root)
end
 
----------------------------------------------------------------------------
-- 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.
--
-- 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') or (subpage == message('doc-subpage') and mw.title.getCurrentTitle().namespace == env.docSpace) 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.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.canonicalUrl(
'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' --> '[[File:Sandbox.svg|50px|alt=|link=]]'
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page'
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page'
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'
-- 'sandbox-notice-compare-link-display' --> 'diff'
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'
-- 'sandbox-notice-testcases-link-display' --> 'test cases'
-- 'sandbox-category' --> 'Template sandboxes'
-- 'module-sandbox-category' --> 'Module sandboxes'
-- 'other-sandbox-category' --> 'Sandboxes outside of template or module namespace'
--]=]
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 = '__EXPECTUNUSEDTEMPLATE__'
local pagetype, sandboxCat
if subjectSpace == 10 then
pagetype = message('sandbox-notice-pagetype-template')
sandboxCat = message('sandbox-category')
elseif subjectSpace == 828 then
pagetype = message('sandbox-notice-pagetype-module')
sandboxCat = message('module-sandbox-category')
else
pagetype = message('sandbox-notice-pagetype-other')
sandboxCat = message('other-sandbox-category')
end
local templateLink = makeWikilink(templateTitle.prefixedText)
local compareUrl = env.compareUrl
if compareUrl then
local compareDisplay = message('sandbox-notice-compare-link-display')
local compareLink = makeUrlLink(compareUrl, compareDisplay)
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
else
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
end
-- Get the test cases page blurb if the page exists. This is something like
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."
local testcasesTitle = env.testcasesTitle
if testcasesTitle and testcasesTitle.exists then
if testcasesTitle.contentModel == "Scribunto" then
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})
else
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})
end
end
-- Add the sandbox to the sandbox category.
omargs.text = text .. makeCategoryLink(sandboxCat)
 
-- 'documentation-clear'
return '<div class="' .. message('clear') .. '"></div>'
.. require('Module:Message box').main('ombox', omargs)
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 protectionLevels = env.protectionLevels
if not protectionLevels then
return nil
end
local editProt = protectionLevels.edit and protectionLevels.edit[1]
local moveProt = protectionLevels.move and protectionLevels.move[1]
if editProt then
-- The page is edit-protected.
return require('Module:Protection banner')._main{
message('protection-reason-edit'), small = true
}
elseif moveProt and moveProt ~= 'autoconfirmed' then
-- The page is move-protected but not edit-protected. Exclude move
-- protection with the level "autoconfirmed", as this is equivalent to
-- no move protection at all.
return require('Module:Protection banner')._main{
action = 'move', small = true
}
else
return nil
end
end
 
----------------------------------------------------------------------------
-- 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 or args[1] then
-- No need to include the links if the documentation is on the template page itself.
local linksData = p.makeStartBoxLinksData(args, env)
if linksData then
links = p.renderStartBoxLinks(linksData)
end
end
-- Generate the start box html.
local data = p.makeStartBoxData(args, env, links)
if data then
return p.renderStartBox(data)
else
-- User specified no heading.
return nil
end
end
 
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'
-- '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
 
-- Create link if /doc doesn't exist.
local preload = args.preload
if not preload then
if subjectSpace == 828 then -- Module namespace
preload = message('module-preload')
else
preload = message('docpage-preload')
end
end
return {
title = title,
docTitle = docTitle,
-- View, display, edit, and purge links if /doc exists.
viewLinkDisplay = message('view-link-display'),
editLinkDisplay = message('edit-link-display'),
historyLinkDisplay = message('history-link-display'),
purgeLinkDisplay = message('purge-link-display'),
preload = preload,
createLinkDisplay = message('create-link-display')
}
end
 
function p.renderStartBoxLinks(data)
--[[
-- Generates the [view][edit][history][purge] or [create][purge] links from the data table.
-- @data - a table of data generated by p.makeStartBoxLinksData
--]]
local docTitle = data.docTitle
-- yes, we do intend to purge the template page on which the documentation appears
local purgeLink = makeWikilink("Special:Purge/" .. data.title.prefixedText, data.purgeLinkDisplay)
if docTitle.exists then
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)
local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, data.editLinkDisplay)
local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, data.historyLinkDisplay)
return "&#91;" .. viewLink .. "&#93; &#91;" .. editLink .. "&#93; &#91;" .. historyLink .. "&#93; &#91;" .. purgeLink .. "&#93;"
else
local createLink = makeUrlLink(docTitle:canonicalUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)
return  "&#91;" .. createLink .. "&#93; &#91;" .. purgeLink .. "&#93;"
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=]]'
-- 'template-namespace-heading' --> 'Template documentation'
-- 'module-namespace-heading' --> 'Module documentation'
-- 'file-namespace-heading' --> 'Summary'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'testcases-create-link-display' --> 'create'
--]=]
local subjectSpace = env.subjectSpace
if not subjectSpace then
-- Default to an "other namespaces" namespace, so that we get at least some output
-- if an error occurs.
subjectSpace = 2
end
local data = {}
-- Heading
local heading = args.heading -- Blank values are not removed.
if heading == '' then
-- Don't display the start box if the heading arg is defined but blank.
return nil
end
if heading then
data.heading = heading
elseif subjectSpace == 10 then -- Template namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')
elseif subjectSpace == 828 then -- Module namespace
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')
elseif subjectSpace == 6 then -- File namespace
data.heading = message('file-namespace-heading')
else
data.heading = message('other-namespaces-heading')
end
-- Heading CSS
local headingStyle = args['heading-style']
if headingStyle then
data.headingStyleText = headingStyle
else
-- 'documentation-heading'
data.headingClass = message('main-div-heading-class')
end
-- Data for the [view][edit][history][purge] or [create] links.
if links then
-- 'mw-editsection-like plainlinks'
data.linksClass = message('start-box-link-classes')
data.links = links
end
return data
end
 
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
-- 'documentation-startbox'
:addClass(message('start-box-class'))
:newline()
:tag('span')
:addClass(data.headingClass)
:attr('id', 'documentation-heading')
:cssText(data.headingStyleText)
:wikitext(data.heading)
local links = data.links
if links then
sbox:tag('span')
:addClass(data.linksClass)
:attr('id', data.linksId)
:wikitext(links)
end
return tostring(sbox)
end
 
----------------------------------------------------------------------------
-- 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.prefixedText}
end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- of docs are interpreted correctly.
return '\n' .. (content or '') .. '\n'
end
 
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 link box.
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 '') .. '<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"
end
end
local box = mw.html.create('div')
-- 'documentation-metadata'
box:attr('role', 'note')
:addClass(message('end-box-class'))
-- 'plainlinks'
:addClass(message('end-box-plainlinks'))
:wikitext(text)
:done()
 
return '\n' .. tostring(box)
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 [[Wikipedia:Template documentation|documentation]]  
-- is [[Help:Transclusion|transcluded]] from $1.'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'create-link-display' --> 'create'
-- 'create-module-doc-blurb' -->
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
--]=]
local docTitle = env.docTitle
if not docTitle then
return nil
end
if docTitle.exists then
-- /doc exists; link to it.
local docLink = makeWikilink(docTitle.prefixedText)
local editDisplay = message('edit-link-display')
local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, editDisplay)
local historyDisplay = message('history-link-display')
local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, historyDisplay)
return 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:canonicalUrl{action = 'edit', preload = message('module-preload')}
local createDisplay = message('create-link-display')
local createLink = makeUrlLink(createUrl, createDisplay)
return message('create-module-doc-blurb', {createLink})
.. '<br />'
end
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 sandboxEditDisplay = message('sandbox-edit-link-display')
local sandboxEditLink = makeWikilink("Special:EditPage/" .. sandboxPage, 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:canonicalUrl{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:canonicalUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
if subjectSpace == 828 then
mirrorUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}
end
local mirrorDisplay = message('mirror-link-display')
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
end
if testcasesTitle.exists then
local testcasesPage = testcasesTitle.prefixedText
local testcasesDisplay = message('testcases-link-display')
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
local testcasesEditUrl = testcasesTitle:canonicalUrl{action = 'edit'}
local testcasesEditDisplay = message('testcases-edit-link-display')
local testcasesEditLink = makeWikilink("Special:EditPage/" .. testcasesPage, testcasesEditDisplay)
-- for Modules, add testcases run link if exists
if testcasesTitle.contentModel == "Scribunto"  and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then
local testcasesRunLinkDisplay = message('testcases-run-link-display')
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)
else
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
end
else
local testcasesPreload
if subjectSpace == 828 then
testcasesPreload = message('module-testcases-preload')
else
testcasesPreload = message('template-testcases-preload')
end
local testcasesCreateUrl = testcasesTitle:canonicalUrl{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
 
----------------------------------------------------------------------------
-- 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
if message('display-strange-usage-category', nil, 'boolean')
and (
subpage == message('doc-subpage')
or subjectSpace ~= 828 and subpage == message('testcases-subpage')
)
then
return makeCategoryLink(message('strange-usage-category'))
end
return ''
end
 
return p

Revision as of 18:24, 17 December 2025

Template:Talk header Template:Permprot Template:Centralized talk page Template:WikiProject banner shell Template:Copied User:MiszaBot/config

Heading displays wrongly in mobile view

In mobile but not desktop view, there is no space between Documentation and the first link: for example I see

DocumentationTemplate:Bracket Template:Bracket Template:Bracket Template:Bracket

instead of

Documentation Template:Bracket Template:Bracket Template:Bracket Template:Bracket

This is true both on the mobile webpage and in the Android app, but the desktop view is fine. Using |heading=Documentation&nbsp; as a workaround produces the correct appearance on mobile, but the extra space is then visible in desktop view. Musiconeologist (talk) 12:35, 21 March 2025 (UTC)

Vector 2022 imports this rule. Minerva does not. This is a bug/difference in Minerva. Izno (talk) 21:10, 26 September 2025 (UTC)
phab:T405802, but I couldn't say if it will be fixed/corrected. Izno (talk) 21:18, 26 September 2025 (UTC)

Background Color Lint error "coming from inside the house"

While resolving Lint background color error messages, I've noticed that the occasional article's error will trace all the way back to Template:Documentation and the invoke:documentation statement (i.e. the {{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}} statement).

A current example is the article for Colin Jackson:

Typically the root issue behind this Lint error is the use of the 'background:' or 'background-color:' CSS properties without a corresponding 'color:' property (for specifying font color; preferably something that contrasts well with the specified background color).

Is it possible for someone to determine what color-related hi-jinks might be going on behind the scenes (and either remove or complete any incomplete background:/color: property pairings)? Resolving this should presumably clear at least 60K lint errors (i.e. any pages using Navboxes).

Many thanks in advance,
SirOlgen (talk) 22:24, 25 August 2025 (UTC)

This report is conflating two completely separate issues, which is why you're being led down a garden path.
Issue 1: There's a lint error somewhere in the navboxes at the bottom of Colin Jackson. Probably one of the navboxes on that article sets a background-color without a color.
Issue 2: There's a lint error somewhere on Template:Navboxes/doc, presumably in one of the navboxes called at Template:Navboxes/doc#Examples.
These two lint errors are independent of each other, and fixing one will have nothing do do with the other. * Pppery * it has begun... 22:34, 25 August 2025 (UTC)
Thanks much for the clarification. I'll see what I can do to root it (them?) out.
SirOlgen (talk) 22:40, 25 August 2025 (UTC)
Culprits were...
Issue 1: Template:Footer Australia NC 110m Hurdles Men and Template:Footer European Indoor Champions 60m Men
Issue 2: Template:Navbox suite, Template:S-aft/doc, Template:S-bef/doc, Template:S-ttl/doc, Template:Slink, Template:Template-linking templates, Template:Template link general/doc, Template:Key top, Template:Color/doc, Template:Namespace and pagename-detecting templates, Template:Test case/doc, Template:Navboxes/testcases, Template:Country data United States/doc, Template:Country data Japan/doc, Template:Country data Germany/doc, Template:Hlist/doc, and Template:Yesno/doc (thus far... will have to come back to this as the significant other is feeling neglected)
It's quite the rabbit hole.
In any case, thanks again for the tips!
SirOlgen (talk) 04:10, 26 August 2025 (UTC)

Template:Template edit request I've recently completed some edit requests for editor Template:U, who has been working on these lint errors. Template {{Documentation}} is still throwing this error. I'm not well-versed in Lua, tho' I found a background color setting at the top of the styles.css module. I don't know how to add the text color, and that is what is needed to fix the lint error. Try to imagine how many templates there are with /doc pages that might benefit from fixing this. Can we hear from a Lua editor? P.I. Ellsworth , ed. – welcome! – 04:39, 2 October 2025 (UTC)

PS. Later noted that there are other background color settings in that styles.css module. P.I. Ellsworth , ed. – welcome! – 04:59, 2 October 2025 (UTC)
More garden paths, but I think I found both rabbits. I added color declarations to the .css page and to Template:Documentation/doc, which did not require an edit request. – Jonesey95 (talk) 12:49, 2 October 2025 (UTC)
Template:U, of the pages you list in "Issue 2" above, only Template:Navboxes/doc and Template:Navboxes/testcases are showing errors, probably due to one or more of the example templates on each page. The pages are not protected, so have fun with them once your SO is tired of your attention. – Jonesey95 (talk) 12:58, 2 October 2025 (UTC)
@Jonesey95/@Paine Ellsworth, thanks for the recent assists. The pages listed under "Culprits were..." above were all updated to clear the color errors as I was going down the garden path. I never did make it back to resume the hunt from where I'd left off.
Regarding the persistent {{Navboxes}} color error, I have since noticed that it can be suppressed on pages using that template by explicitly declaring the color attribute in the titlestyle parameter (example). {{Navboxes/doc}} mentions that the titlestyle background "defaults to #CCCCFF", so I figured passing a text color would ensure a complete attribute pair. Wherever it is that this background color defaulting occurs, would adding companion text color defaulting nip this particular issue in the bud? – SirOlgen (talk) 18:11, 2 October 2025 (UTC)
I believe that I have made color:inherit the default in Template:navboxes as of a moment ago, so you should not have to add titlestyle colors to any articles. Let me know if you notice any problems. I checked the template in both dark and light modes. – Jonesey95 (talk) 18:48, 2 October 2025 (UTC)
Thanks for the module tweak. That does appear to have resolved the issue (with the subs as well), but I'll keep my eyes open going forward. – SirOlgen (talk) 19:28, 2 October 2025 (UTC)

Update sandbox icon to match all other templates

Template:Fper

I think the icon that currently appears when viewing the sandbox of a template (which seems to come from Module:Documentation/config#L-34 and Template:Template sandbox notice) doesn't represent the concept well. (See an example of how it looks.) The sand is too brown, the lighting is off (all three objects seem to receive light from different light sources), and the colours are unusual. And it's not even a "sand box"! There is no box in the sandbox icon...

Template:Ombox

I think it should be updated to use the standard sandbox icon, already used in all other sandbox templates, such as Template:Sandbox heading, Template:Sandbox notice, Template:Template sandbox, Template:Template sandbox heading, Template:Not a sandbox, and more.

Template:Ombox

This icon uses less daunting colours and is more detailed while also adding more items to the box, such as the pencil and the document being changed. FaviFake (talk) 16:32, 26 September 2025 (UTC)

Since this page is whatchlisted by 165 editors and none have responded after 17 days, I'll assume there's WP:SILENT consensus and apply the tper template. FaviFake (talk) 17:18, 13 October 2025 (UTC)
Template:Complete2. P.I. Ellsworth , ed. – welcome! – 18:15, 13 October 2025 (UTC)
Thanks @Paine Ellsworth, but I noticed that the old icon is still present in the editnotice when editing a template, such as here: [1]. I think this may be caused by Module:Documentation itself? Could you try making this change to Module:Documentation? Special:Diff/1280044025/1318783040.It's possible not even this will fix it, but I can't manage to find the origin of that specific edit notice. FaviFake (talk) 00:04, 26 October 2025 (UTC)
That edit can't possibly do anything because it's in a Lua comment. * Pppery * it has begun... 00:05, 26 October 2025 (UTC)
Yeah I thought it could be a comment, since it was gray and in italic. Does anyone know where that editnotice is coming from? FaviFake (talk) 00:07, 26 October 2025 (UTC)
FOUND IT! It comes from Template:Editnotices/Namespace/Template and Template:Editnotices/Namespace/Module. The reason i couldn't find it is because it uses a .PNG file instead of the newer .SVG file. This is the change in Template:Editnotices/Namespace/Template that would fix the image:Template:Pb
Line 28: Line 28:
|testcases <small style="font-style: normal">([{{fullurl:{{FULLPAGENAME}}/testcases|action=edit&preload=Template:Documentation/preload-testcases}} create])</small> |testcases <small style="font-style: normal">([{{fullurl:{{FULLPAGENAME}}/testcases|action=edit&preload=Template:Documentation/preload-testcases}} create])</small>
}} pages. }} pages.
| image = [[File:Sandbox.png|40px|alt=|link=]] | image = [[File:Edit In Sandbox Icon - Color.svg|40px|alt=|link=]]
| class = plainlinks | class = plainlinks
}} }}
Template:PbAnd change Template:Editnotices/Namespace/Module to:
Line 23: Line 23:
|testcases <small style="font-style: normal">([{{fullurl:{{FULLPAGENAME}}/testcases|action=edit&preload=Template:Documentation/preload-module-testcases}} create])</small> |testcases <small style="font-style: normal">([{{fullurl:{{FULLPAGENAME}}/testcases|action=edit&preload=Template:Documentation/preload-module-testcases}} create])</small>
}} pages. }} pages.
| image = [[File:Sandbox.png|40px|alt=|link=]] | image = [[File:Edit In Sandbox Icon - Color.svg|40px|alt=|link=]]
}} }}
}}<!-- }}<!--
Template:PbAnd this change to Template:Editnotices/Page/Template:Old moves/doc:
Line 6: Line 6:
| text = Editors can experiment in this documentation page's [[Template:Old moves/doc/sandbox|sandbox]]. | text = Editors can experiment in this documentation page's [[Template:Old moves/doc/sandbox|sandbox]].
| textstyle = | textstyle =
| image = Sandbox.png | image = Edit In Sandbox Icon - Color.svg
| imagesize = 60px | imagesize = 60px
| style = | style =
FaviFake (talk) 00:15, 26 October 2025 (UTC)
Have always found it weird we use a cat litter box over a practice icon. Moxy🍁 15:57, 26 October 2025 (UTC)
I believe the icon is actually just a sandbox, like those used by kids on parks. It has the little blue toy shovel.Template:PbI've instead always found it weird that in the old sandbox icon there is no "sand box". It's just a pile of sand on the ground. FaviFake (talk) 16:04, 26 October 2025 (UTC)
Looks like a blue Pooper-scooper to anyone in North America. Moxy🍁 16:07, 26 October 2025 (UTC)
We should be using a sandboxing symbol [2] or [3] vs a playground sandbox symbol [4]. That said will implement the above request in 24 hours if there's no objections. Moxy🍁 16:15, 26 October 2025 (UTC)
This is a fully-protected edit request. However, as a template editor, you should still be able to implement the third suggestion. FaviFake (talk) 16:22, 26 October 2025 (UTC)
Yeah let's just do it and see if people complain. Moxy🍁 16:25, 26 October 2025 (UTC)

I have updated Template:Editnotices/Namespace/Module and Template:Editnotices/Namespace/Template. Please note the third page has been deleted — Martin (MSGJ · talk) 15:55, 1 November 2025 (UTC)

Discussion at Template talk:Documentation subpage § Fix per WP:SOB

File:Symbol watching blue lashes high contrast.svg You are invited to join the discussion at Template talk:Documentation subpage § Fix per WP:SOB. FaviFake (talk) 16:37, 17 November 2025 (UTC) FaviFake (talk) 16:37, 17 November 2025 (UTC)

Show improve documentation if doc doesn't exists?

Should this template be modified to show {{improve documentation}} by default to templates/modules that doesn't have a documentation? This will auto list the template/modules to Category:Templates with missing or incorrect documentation, which is useful for tracking and fixing. Nvdtn19 (talk) 05:39, 2 December 2025 (UTC)

I support this. All templates should have documentation, even if it's something basic like "see the parent template for detailed information". What seems obvious to the creator of the template, might not be to others who encounter it and might not be 10 years down the road to no one. Gonnym (talk) 13:56, 2 December 2025 (UTC)
That said, there are cases where the documentation is in the body of template and not a /doc page, such as navboxes that use {{Navbox documentation}} or WikiProject banners that use the auto generated documentation. Those cases should be tested to make sure they don't fill up the category. Gonnym (talk) 13:59, 2 December 2025 (UTC)
Of course, {{improve documentation}} will only shows if the namespace is template/module, and if the template which is transcluding {{documentation}}, does not have any documentation. The viwiki version of this template have already implemented this feature, you can see some demo:
If this change are also considered useful here then I'll suggest some changes, but I'll have to test first. Nvdtn19 (talk) 14:45, 2 December 2025 (UTC)
  • I'm wondering if it wouldn't be better setting this up as a bot task to allow for a gap between the template creation process and building documentation. I know I've created a number of templates by starting off with a basic functioning and the standard <noinclude> Template:((documentationTemplate:)) </noinclude> ending knowing that I won't be able to build documentation until I'm done working out all the kinks and details in the code, but having that blank documentation section reminds me to come back to instructions once I've finished programming. I would hate to have overzealous gnomes coming in to try to figure out my template while I'm still fixing bugs because it ended up in a tracking category prematurely. At least if a bot were coming in, I'd be able to remove {{improve documentation}} once it got added if things weren't ready for that step yet. VanIsaac, GHTV contrabout 17:32, 2 December 2025 (UTC)
    Ideally, if your template still has kinks in it, start it in your userspace or draft space (or /sandbox if it is one). We shouldn't be placing a non-functioning template in the "live" template space. Gonnym (talk) 17:57, 2 December 2025 (UTC)
    I agree with Gonnym. Don't expect unfinished things that is outside the sandbox can't be touched by others. I don't understand why it would be disruptive when {{improve documentation}} is present on templates that lacks documentation, while it clearly reflects the actual situation? So if the project currently has 10,000 templates without documentation, we have to deploy a bot just to add {{improve documentation}} to those 10,000 pages, while a better one-time methods exists? If you don't want your template be flagged, better start it in your sandbox, or not adding {{documentation}} until there is one. Nvdtn19 (talk) 05:35, 3 December 2025 (UTC)
    So, who's gonna implement this in the sandbox? FaviFake (talk) 15:54, 17 December 2025 (UTC)
    Yes, well that's just the thing, isn't it? Almost nothing operates on a platonic ideal. While I am more than willing, and have frequently built templates in userspace, that's not something that everyone would even think to do, let alone a well-known operating procedure that people follow to any extent. While we do have the draft namespace for articles, there's really no policy for anything but new accounts to even build any content in their private userspace as a matter of course. The point is that when dealing with seemingly simple templates, drafting in userspace and moving into the template namespace is usually more hassle than is warranted, but that doesn't prevent the intricacies of template logic from biting us from time to time. So I reiterate that I would think a parameter for empty documentation that is supported by a maintenance bot would be a more robust option for accomplishing the task. VanIsaac, GHTV contrabout 18:23, 17 December 2025 (UTC)
  • I support this. Checking if a page or template parameter is empty is a perfect task for a template/bot. FaviFake (talk) 17:41, 2 December 2025 (UTC)

Documentation template source code

Can someone provide me with the source code for this template? I'd like to use it on my own wiki. Thanks! ~2025-38484-04 (talk) 16:49, 6 December 2025 (UTC)

You can click "view source" at the top of the page to see the source code. You also need to copy the source code of Module:Documentation and the other dependencies listed on the top right corner of that page. * Pppery * it has begun... 20:20, 6 December 2025 (UTC)