View source for Wikipedia:Bots/Requests for approval/SdkbBot 4

<noinclude>[[Category:Approved Wikipedia bot requests for approval|SdkbBot 4]]</noinclude><div class="boilerplate metadata mw-archivedtalk" style="background-color:
#EAFFEA; margin:2em 0 0 0; padding:0 10px 0 10px; border:1px solid #AAAAAA;">
:''The following discussion is an archived debate. <span style="color:red">'''Please do not modify it.'''</span> To request review of this BRFA, please start a new section at [[Wikipedia:Bots/Noticeboard]].'' The result of the discussion was {{BotApproved}}<!-- from Template:Bot Top-->
==[[User:SdkbBot|SdkbBot 4]]==
{{BRFA help}}
{{Newbot|SdkbBot|4}}
<!-- ^^^ Ignore everything above this line ^^^ -->

<!-- Leave this alone -->
'''Operator:''' {{botop|Sdkb}}

<!-- And leave this alone -->
'''Time filed:''' 05:08, Wednesday, August 2, 2023 ([[UTC]])

<!-- A SHORT bot function overview (max 2–3 lines); place the in-depth explanation in the "function details" section below-->
'''Function overview:''' Replaces {{t|Collapsible option}} with {{t|Navbox documentation}} (a wrapper of <nowiki>{{Collapsible option}}</nowiki> that also includes TemplateData and other basic documentation elements) for navigation boxes that have no documentation except beyond <nowiki>{{Collapsible option}}</nowiki>.

<!-- Automatic: edits are not reviewed, except when issues arise -->
<!-- Supervised: all edits are reviewed soon after being made -->
<!-- Manual: all edits are reviewed before being made -->
'''Automatic, Supervised, or Manual:''' Automatic

<!-- Programming Language: The computer language that this bot will be written in. E.g. Python, Java, C, VB, AutoWikiBrowser. NOT English etc. -->
'''[[Programming language|Programming language(s)]]:''' AutoWikiBrowser

<!-- Source code available: e.g. a link to the source code, "Standard pywikipedia"/"AWB"/etc. Be sure the bot account's password is not given out! -->
'''[[Source code]] available:''' The bot will be operated by running through the list of template-space pages from the RegEx search query <code><nowiki>hastemplate:"collapsible option" -hastemplate:"documentation" insource:/\<noinclude\>.\{\{collapsible option}}.\[\[Category:.*navigational boxes\]\].*\<\/noinclude\>/</nowiki></code> with a find and replace for {{tnl|collapsible option}}{{right arrow}}{{tnl|navbox documentation}}. It will use the edit summary {{tq|Switch to more comprehensive documentation}}.

<!-- Bot tasks require consensus in order to be approved. Please list any relevant discussions here to indicate consensus for the task. If such input is not necessary (for instance, a task that is duplicating or closely matching an existing bot) leave this blank-->
'''Links to relevant discussions (where appropriate):''' I don't know of anyone who prefers less complete documentation, so I anticipate this will be an uncontroversial task. I'll drop notices of this BRFA at [[WT:Template documentation]], [[WT:Navigation template]], [[Help talk:Collapsing]], [[Template talk:Navbox documentation]], and [[Template talk:Collapsible option]] to ensure visibility.

<!-- e.g. Continuous, daily, one time run, etc. -->
'''Edit period(s):''' One-time run

<!-- Should be a reasonable guess as to how many distinct pages you'll be editing. For open-ended tasks, estimate pages per some reasonable time period.-->
'''Estimated number of pages affected:''' 39,000

<!-- Which namespace(s) will the bot edit? Mainspace/Articles, Categories, Files, ...-->
'''Namespace(s):''' Template

<!-- Whether the bot skips articles and other pages with the {{bots}} template. If "no", please provide a reason in the Function details or Discussion.-->
'''[[Template:bots|Exclusion compliant]]''' ''(Yes/No)''''':''' Yes
<!-- Bots with Administrative powers are rare and run by Users who are already Administrators -- >

'''Adminbot''' ''(Yes/No)''''':''' Yes <!-- close the comment above to enable -->

<!-- List full and complete function details here. Please be precise and explicit, describing all changes the bot would make, including those "bundled" with bot frameworks like AWB or pywikipedia genfixes. Bots cannot be approved for open-ended tasks, so ensure the details cover all cases. Consider making several BRFAs for tasks with large independent changes. Vague or incomplete details can delay the BRFA process. Straight-forward details and examples will speed up the approval. If you need to modify these details after a discussion starts, it is recommended that you use del tags – <del></del> – to remove text and ins tags – <ins></ins> – for additions (this preserves coherence of the discussion), or show/hide boxes as you see fit. -->
'''Function details:''' Many navboxes have only {{t|Collapsible option}} (which I recently [[Template_talk:Collapsible_option#Readability_overhaul|redesigned]]) as a kind of quasi-documentation. {{t|Navbox documentation}}, created by {{u|MJL}} in 2019, is a wrapper of <nowiki>{{Collapsible option}}</nowiki> that also includes other helpful elements, such as the standard green documentation background, information on correct placement, and TemplateData (which I added the other day, making it easier to add/configure navboxes with VisualEditor). These elements make it a direct improvement over <nowiki>{{Collapsible option}}</nowiki> alone. However, it has very limited usage: less than 250 transclusions, compared to 134,000 for <nowiki>{{Collapsible option}}</nowiki>. This task aims to convert a portion of those transclusions to the wrapper, specifically those that are easily identified as having no other documentation present. I may modify the search query over time to help find additional instances beyond the <s>25,000</s><u>39,000</u> identified so far.

===Discussion===
<!-- This is not a vote.  It is a discussion -->
Kudos to {{u|Certes}} for [[Wikipedia_talk:AutoWikiBrowser/Regular_expression#c-Certes-20230801232300-Sdkb-20230801205700|helping]] me figure out the search query. I conducted {{plainlink|1=https://en.wikipedia.org/w/index.php?title=Special:Contributions/Sdkb&target=Sdkb&dir=prev&offset=20230802005555&limit=117 a test}} with my non-bot account of a little over a hundred instances earlier and ran into no issues. <span style="color:#AAA"><small>&#123;{u&#124;</small><span style="border-radius:9em;padding:0 5px;background:#088">[[User:Sdkb|<span style="color:#FFF">'''Sdkb'''</span>]]</span><small>}&#125;</small></span> <sup>[[User talk:Sdkb|'''talk''']]</sup> 05:08, 2 August 2023 (UTC)
:So this is potentially a dumb question, but if all you are doing is making a wrapper for collapsible option that does little more than put a green box around it and (for some reason) add TemplateData, why not just do that to {{t|collapsible option}} itself and save the hassle of having to replace 25k templates? {{ppor|no}} [[User:Primefac|Primefac]] ([[User talk:Primefac|talk]]) 08:02, 2 August 2023 (UTC)
::Not a stupid question! Since {{t|Collapsible option}} is just a chunk of text, it's designed to go within a larger documentation, and is used that way in some other instances (as many as {{plainlink|1= https://en.wikipedia.org/w/index.php?search=hastemplate%3A%22collapsible+option%22+hastemplate%3A%22documentation%22+-hastemplate%3A%22navbox+documentation%22&title=Special:Search&profile=advanced&fulltext=1&ns10=1&searchToken=9ohnnc8e9qy4vgvjpk0vh6twp 15,000}}). Converting it directly would break those. <span style="color:#AAA"><small>&#123;{u&#124;</small><span style="border-radius:9em;padding:0 5px;background:#088">[[User:Sdkb|<span style="color:#FFF">'''Sdkb'''</span>]]</span><small>}&#125;</small></span> <sup>[[User talk:Sdkb|'''talk''']]</sup> 13:31, 2 August 2023 (UTC)
::: I'm not sure I understood your response, but am I correct that you want it to do one thing when it's transcluded on its own, and another thing when it's transcluded in another template? If so, you may not need a bot for that, just an adjustment of the templates using [[WP:NOINCLUDE|Inclusion control]] or [[WP:SELTRANS|selective transclusion]]. I did this at French Wikipedia for their [[:fr:Modèle:Palette Régime de Vichy|Régime de Vichy]] nav bar template (analogous to our {{tl|Vichy regime}} navbar). The template uses a subtemplate, [[:fr:Modèle:Palette Régime de Vichy/Participants|/Participants]], which is also a nav template in its own right which may be used on its own (that is, transcluded directly in the footer of an article as a nav bar), or may be transcluded in the main template, and appears differently in each case. Is this something like what you need to do? [[User:Mathglot|Mathglot]] ([[User talk:Mathglot|talk]]) 17:40, 2 August 2023 (UTC)
::: Rereading, I'm starting to get a better view, and could you not just further modify {{tl|collapsible option}} so it does what {{tl|navbox documentation}} does now, in those cases where you want it to do so? Still not sure I'm getting it. Maybe I should be asking a negative: in what cases do you not want to apply the bot? Is it just that the name of the new template is more transparent, so we could make {{tl|collapsible option}} a wrapper the other way around with a new param in the newer one, i.e., code of collapsible option gets moved into the newer one under conditional control of {{para|collapsible|yes}}, which would be set in {{tl|collapsible option}} when it transcludes the other one? [[User:Mathglot|Mathglot]] ([[User talk:Mathglot|talk]]) 18:18, 2 August 2023 (UTC)
::::@[[User:Mathglot|Mathglot]], sorry for the confusion. Some examples might help. [[Special:Permalink/1110494560|Here's a template]] that uses Collapsible option in a standalone way as a kind of proto-documentation; this is what I would be looking to convert to Navbox documentation, to make it look like [[Special:Permalink/1168439726|this]]. [[Template:Minor planets navigator|This]], on the other hand, is an example of template that uses Collapsible option as an element within a larger existing documentation. We don't want to change anything there (lest we end up with documentation-within-documentation).
::::I suppose it might theoretically be possible to change Collapsible option so that it tries to detect whether or not it's embedded within larger documentation, and only generates the green box etc. if it's standing alone (is that what you're suggesting?). I don't think that would be a wise approach, though. It would introduce a lot of complexity to Collapsible option. Generally speaking, we don't want a template that's trying to be both an element within documentation or a full documentation depending on the circumstances, unless we have no other option. Right now, Collapsible option is the element and Navbox documentation is the full doc, and keeping them both to maintain that distinction makes sense. This approach would also require us to worry about detection errors (e.g. navboxes that have additional documentation but lack the {{t|documentation}} template; this is plausible given that Collapsible option is an old template slightly predating <nowiki>{{documentation}}</nowiki> and that many navboxes are low-visibility templates that haven't been well-maintained). A one-time bot run would be a lot more edits, but I think it'd put us in a much cleaner situation at the end of it, which is what we want for the long term.
::::Does that help clarify? Cheers, <span style="color:#AAA"><small>&#123;{u&#124;</small><span style="border-radius:9em;padding:0 5px;background:#088">[[User:Sdkb|<span style="color:#FFF">'''Sdkb'''</span>]]</span><small>}&#125;</small></span> <sup>[[User talk:Sdkb|'''talk''']]</sup> 19:41, 2 August 2023 (UTC)
::::: Yes, thanks. More edits now vs. cleaner later is probably a good tradeoff. [[User:Mathglot|Mathglot]] ([[User talk:Mathglot|talk]]) 20:18, 2 August 2023 (UTC)
Updated the query, which brings the number of affected pages up to 39,000. <span style="color:#AAA"><small>&#123;{u&#124;</small><span style="border-radius:9em;padding:0 5px;background:#088">[[User:Sdkb|<span style="color:#FFF">'''Sdkb'''</span>]]</span><small>}&#125;</small></span> <sup>[[User talk:Sdkb|'''talk''']]</sup> 15:41, 2 August 2023 (UTC)
:{{BotTrial|edits=50}} Please do ''not'' mark these as minor so that there is a higher chance of feedback, especially since there has been little in the way of prior discussion over this matter. [[User:Primefac|Primefac]] ([[User talk:Primefac|talk]]) 16:06, 6 August 2023 (UTC)
::{{bottrialcomplete}} See {{plainlink|1=https://en.wikipedia.org/w/index.php?title=Special:Contributions/SdkbBot&target=SdkbBot&dir=prev&offset=20230801204948&limit=50 diff}} of edits. Cheers, <span style="color:#AAA"><small>&#123;{u&#124;</small><span style="border-radius:9em;padding:0 5px;background:#088">[[User:Sdkb|<span style="color:#FFF">'''Sdkb'''</span>]]</span><small>}&#125;</small></span> <sup>[[User talk:Sdkb|'''talk''']]</sup> 06:33, 7 August 2023 (UTC)
:::{{t|BAG assistance needed}} Bumping, given no comments for three weeks. The trial appears to have gone smoothly, so I'm ready to move forward once approval is granted. Cheers, <span style="color:#AAA"><small>&#123;{u&#124;</small><span style="border-radius:9em;padding:0 5px;background:#088">[[User:Sdkb|<span style="color:#FFF">'''Sdkb'''</span>]]</span><small>}&#125;</small></span> <sup>[[User talk:Sdkb|'''talk''']]</sup> 16:52, 28 August 2023 (UTC)
:::Looks good. Much better documentation. [[User:SWinxy|SWinxy]] ([[User talk:SWinxy|talk]]) 17:53, 28 August 2023 (UTC)
::::{{BotApproved}} [[User:Primefac|Primefac]] ([[User talk:Primefac|talk]]) 08:52, 30 August 2023 (UTC)
:''The above discussion is preserved as an archive of the debate.  <span style="color:red">'''Please do not modify it.'''</span> To request review of this BRFA, please start a new section at [[Wikipedia:Bots/Noticeboard]].''<!-- from Template:Bot Bottom --></div>