Template talk:Documentation
| This is the talk page for discussing improvements to the Documentation template. |
|
Template:Permprot Template:Centralized talk page Template:WikiProject banner shell Lua error in package.lua at line 80: module 'Module:Message box' not found. User:MiszaBot/config
Update sandbox icon to match all other templates
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...
Script error: No such module "Message box".
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.
Script error: No such module "Message box".
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, butI 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
- That edit can't possibly do anything because it's in a Lua comment. * Pppery * it has begun... 00:05, 26 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].
- Template:Complete2. P.I. Ellsworth , ed. – welcome! – 18:15, 13 October 2025 (UTC)
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:
- 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:
- Template:PbAnd this change to Template:Editnotices/Page/Template:Old moves/doc:
FaviFake (talk) 00:15, 26 October 2025 (UTC)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 =
- 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)
- Have always found it weird we use a cat litter box over a practice icon. Moxy🍁 15:57, 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:
- w:vi:Bản mẫu:!w (with no /doc, no
|content=, and no auto-generated doc. Thus it's showing {{improve documentation}}) - w:vi:Bản mẫu:Brackets (with inline
|content=) - w:vi:Bản mẫu:Valve (with {{Navbox documentation}} transcluded)
- w:vi:Bản mẫu:Sơ khai (with auto-generated doc from module).
- w:vi:Bản mẫu:!w (with no /doc, no
- 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)
- 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:
- 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)
- 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> {{documentation}} </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)
- 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)
- 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 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)