[#43250] - [5.1] Fix build tool helpTOC.php
- Fixed in Code Base
- 11 May 2024
- Medium
- Build: 5.1-dev
- # 43250
- Diff
- LadySolveig:5.1/patch/helpTOC
User tests: Successful: Unsuccessful:
Pull Request for Issue #32419 .
Summary of Changes
Fix build tool for missing help documents in Help index.
- loop through all categories in all minor versions to get all media wiki categories for the major version
- grap missing language strings into array
- write missing strings to temporary file
/tmp/missing-helptoc.txtfor revision and manually add toadministrator/language/en-GB/com_admin.ini
Testing Instructions
composer i
php ./build/helpTOC.php
Actual result BEFORE applying this Pull Request
Expected result AFTER applying this Pull Request
Link to documentations
Please select:
-
Documentation link for docs.joomla.org:
-
No documentation changes for docs.joomla.org needed
-
Pull Request link for manual.joomla.org:
-
No documentation changes for manual.joomla.org needed
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Repository |
| Labels |
Added:
PR-5.1-dev
|
||
I have tested this item ✅ successfully on accd60d
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43250.
I have tested this item ✅ successfully on accd60d
I have been through the code and I am pleased we do not have to edit all of the MediaWiki files in the Category 5.0 to add Category 5.1.
I have reservations about adding 100+ missing strings to administrator/language/en-GB/com_admin.ini - that makes the list of Help pages more than twice as long and it is the only place where the missing strings are used.
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43250.
@ceford I agree with you about the language strings - I actually see this more as a partial fix to minimise rework in the wiki and still get the most up-to-date help index possible.
The Help Index hasn't received the attention it deserves since 4.3 and I'm afraid there's little point in continuing to rely on this workflow. In the long run, we really need a long-term solution for our wiki.
Also to optimise the workflow and reduce manual work for the Documentation Team and also for you as a very dedicated member, which I appreciate so much!
When I looked at the strings it made me realise that the toc would benefit from nesting.
There are over 20 admin modules which could be nested to one etc
| Status | Pending | ⇒ | Ready to Commit |
RTC
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43250.
| Labels |
Added:
RTC
bug
|
||
| Status | Ready to Commit | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2024-05-11 19:12:38 |
| Closed_By | ⇒ | bembelimen |
Thanks!
Definitely an improvement on the old script.
Tested with en-GB only. Not sure how the process will work for other languages
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43250.