View source for Template talk: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
}}

== Update sandbox icon to match all other templates ==
{{fper|Template:Editnotices/Namespace/Template|Template:Editnotices/Namespace/Module|Template:Editnotices/Page/Template:Old moves/doc|ans=y}}

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...''

{{ombox
  |image = [[File:Sandbox.svg|50px|alt=|link=]]
  |text = 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]].
  }} 
 }}

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]]. 

{{ombox
  |image = [[File:Edit In Sandbox Icon - Color.svg|50px|alt=|link=]]
  |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}}
  }} 
 }}

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)

==Discussion at [[:Template talk:Documentation subpage#Fix per WP:SOB|Template talk:Documentation subpage §&nbsp;Fix per WP:SOB]]==
[[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)

== 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)

: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)
::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)
:::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:
:::* [[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}})
:::* [[w:vi:Bản mẫu:Brackets]] (with inline <code>|content=</code>)
:::* [[w:vi:Bản mẫu:Valve]] (with {{tl|Navbox documentation}} transcluded)
:::* [[w:vi:Bản mẫu:Sơ khai]] (with auto-generated doc from module).
:::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)
*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)
*: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)
*::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)
*:::So, who's gonna implement this in the sandbox? [[User:FaviFake|FaviFake]] ([[User talk: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. [[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)
*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)

== 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! [[Special:Contributions/&#126;2025-38484-04|&#126;2025-38484-04]] ([[User talk:&#126;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. [[User:Pppery|* Pppery *]] [[User talk:Pppery|<sub style="color:#800000">it has begun...</sub>]] 20:20, 6 December 2025 (UTC)