Template talk:Documentation
This is the talk page for discussing improvements to the Documentation template. |
|
Archives: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10Auto-archiving period: 3 months ![]() |
![]() | Template:Documentation is permanently protected from editing because it is a heavily used or highly visible template. Substantial changes should first be proposed and discussed here on this page. If the proposal is uncontroversial or has been discussed and is supported by consensus, editors may use {{edit template-protected}} to notify an administrator or template editor to make the requested edit. Usually, any contributor may edit the template's documentation to add usage notes or categories.
Any contributor may edit the template's sandbox. Functionality of the template can be checked using test cases. |
![]() | To help centralize discussions and keep related topics together, all talk pages of subtemplates, and Module talk:Documentation, redirect here |
![]() | This template does not require a rating on Wikipedia's content assessment scale. It is of interest to the following WikiProjects: | |||||||
|
![]() | Text has been copied to or from this page; see the list below. The source pages now serve to provide attribution for the content in the destination pages and must not be deleted as long as the copies exist. For attribution and to access older versions of the copied text, please see the history links below. |
Template-protected edit request on 10 March 2025
editThis edit request to Module:Documentation has been answered. Set the |answered= parameter to no to reactivate your request. |
On line 229, please change the function to this:
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
This will make the doc environment behave correctly, giving the actual template name on the doc page rather than the name of the "doc" subpage. Aasim (話す) 00:17, 10 March 2025 (UTC)
- Completed. P.I. Ellsworth , ed. put'er there 03:39, 12 March 2025 (UTC)
Heading displays wrongly in mobile view
editIn mobile but not desktop view, there is no space between Documentation and the first link: for example I see
- Documentation[view] [edit] [history] [purge]
instead of
- Documentation [view] [edit] [history] [purge]
This is true both on the mobile webpage and in the Android app, but the desktop view is fine. Using |heading=Documentation
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)
Template-protected edit request on 20 August 2025
editThis edit request to Module:Documentation has been answered. Set the |answered= parameter to no to reactivate your request. |
In the bottom part of the template, apply this change: (this also applies to {{Navbox documentation}}
− | The above documentation is transcluded from Template:Documentation/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and | + | The above documentation is transcluded from Template:Documentation/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and test cases (edit) pages.
Add categories to the /doc subpage. Subpages of this template. |
Reason for the change: "test cases" is used as two words everywhere else. See, for example:
These two templates both call it "test cases page" and it is spaced even outside of templates. This is not the case when it's styled as "/testcases", because that's how the subpages are named, just like how Documentation is also styled "/doc"; but this doesn't mean we call it "the doc page". FaviFake (talk) 17:09, 20 August 2025 (UTC)
- In my experience we actually do sometimes call documentation pages "doc pages". And this feels like another thing so trivial it wasn't worth bothering a template editor over. * Pppery * it has begun... 17:19, 20 August 2025 (UTC)
- Well, sure, but not outside of talk pages; or at least in my experience.
- There are a lot of edits of mine you consider "too trivial", but I don't understand why you generally oppose them. Some people like to take their time to do a big rewrite one at a time, while some like to go around and fix all the little broken things they find. Like an outdated sandbox icon, or a serial comma, or the spelling of a template that's used on an entire namespace.
- I've asked you twice already for better ways for me to suggest these edits; until you do, I'll have to keep using TPER. I don't think i'd qualify as a TE at the moment. FaviFake (talk) 19:58, 20 August 2025 (UTC)
- @FaviFake: Not done for now: please establish a consensus for this alteration before using the
{{Edit template-protected}}
template. Wikipedia:Template sandbox and test cases actually mentions "testcases" as a single word multiple times, by the way. Est. 2021 (talk · contribs) 01:48, 21 August 2025 (UTC)- Here are the word counts from the page Wikipedia:Template sandbox and test cases:
test cases
appears 20 times,/testcases
also appears 20 times,- However,
testcases
only appears 4 times, in one single paragraph.
- Plus, {{Template sandbox notice}} and {{Template test cases}}, which are used as much as {{doc}}, never mention
testcases
and always call themtest cases
. Additionally, the documentation for {{Testcases notice}} itself always calls ittestcases
and doesn't usetest cases
. - Est. 2021, is consensus for this change really needed here? It seems there's already consensus to only use either
test cases
or/testcases
; and {{Doc}} only uses the first version for the other pages it links to, such as th sandbox. FaviFake (talk) 11:22, 21 August 2025 (UTC)
- Here are the word counts from the page Wikipedia:Template sandbox and test cases:
- @FaviFake: Not done for now: please establish a consensus for this alteration before using the
Background Color Lint error "coming from inside the house"
editWhile 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:
- It simply invokes {{Navboxes}} which, in turn, simply invokes {{documentation}}.
- Drilling down into the Page Information for "Template:Documentation" § Lint Errors section's link to 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.
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: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!
- SirOlgen (talk) 04:10, 26 August 2025 (UTC)