Repository navigation
[6.2] New backend Joomla! Help page - #46355
Conversation
|
Looks good |
|
It works but I am having second thoughts about how I have coded this feature. Perhaps it should be considered a draft for now. I will get on to the points raised by @brianteeman - thank you. Meanwhile, here is a screenshot:
|
|
@brianteeman Should I make the copyright 2026 on the assumption it will be next year before it appears? |
no - you wrote it in 2025 and it will hopefully be merged on github in 2025 |
|
You could remove the need for the |
|
@C-Lodder only just seen your suggestion - I will give it a try. |
|
@C-Lodder I implemented you suggestion. Next problem: In narrow screens the Help menu starts open and it takes two clicks to close it. I want it to start with the Help menu closed. Also, in narrow screen mode I want the Help menu to close after selecting an item. I am looking in to how to do this - do you have any suggestions? |
|
I am happy! This PR is ready for testing. |
|
@ceford What about these 2 unresolved review comments by @brianteeman ?
If they are resolved, please use the button below the comment on GitHub to mark it as resolved. With the other 2 about the copyright year I've just done that. Thanks in advance. |
Done that! As I am a rare contributor I did not realised that I needed to resolve comments. I also addressed the alignment problem mentioned by Brian |
|
@ceford Thanks. It is not necessarily the author of a PR who has to resolve review comments, it can also be done by the initial reviewer or by a maintainer. But at the end it is good to have them resolved, otherwise GitHub shows a message about unresolved comments which might discourage testers because they might think there will be more changes coming. |
|
There is a snag! The rebase to 6.1 has led to the proxy returning 404 not found pages. For test purposes you can edit configuration.php and set the minor version to 0 |
|
@richard67 as this pr removes the only file in the folder help/en-gb it will result in the packages being created without that folder at all. If the folder is needed for b/c etc then an index.html should be placed in the folder to ensure it is included in packages |
@brianteeman I have no idea if that folder is needed for b/c and if so, if it is needed in a new install of the core, too, or only should be kept on updates. @ceford Do you have an idea if that cold be needed e.g. for 3rd party extensions? |
|
if it is not needed then entire folder tree can be removed |
Looks like it is used in libraries/Src/Help/Help.php (line 71 ff) so I will create administrator/help/en-GB/index.html |
|
This pull request has been automatically rebased to 6.2-dev. |
|
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
|
@HLeithner I don't know what this conflicts message means or how to fix it. Can you help? |
@ceford I'm not Harald, but I can answer your question. The conflicts happen because after your PR has been successfully rebased to 6.2-dev, another PR #46879 has been merged into 6.2-dev which moves the Unfortunately this kind of conflict cannot be resolved on GitHub with a button in your PR. It needs to solve it in a development environment. I will try to do that here and solve it for you. Update: Just done. It was just a clean merge of the 6.2-dev branch into the branch of this PR, which did not have any conflicts. Just the GitHub UI here cannot do that due to the moved files, but a Git client can. So I don't think it will need new test. But that's on release managers to decide. @charvimehradu @MacJoom Do we need new tests here? The rebase to 6.2-dev was clean after the tests, and also my conflict resolution (see above). |
|
Thank you very much for the hard work! |
|
@ceford UI issue when collapsing menu.
|
|
On the desktop...click |
build/media_source has been moved to media_source in 6.2-dev. The subfolders below that are unchanged. |
|
Please see PR #47864 for the fix to the missing css file problem. |




Pull Request for Issue # .
No issue in the tracker but the problematic list of Help pages has been mentioned in discussions.
Summary of Changes
This PR is for a replacement of the backend list of Help files accessed via Help → Start Here. The current page presents a list of 198 items sorted into alphabet order of the language selected at login. It is very difficult to use! Each time the page is reloaded the displayed item is Start Here. Also, it is generated by a script that fetches all the pages from docs.joomla.org that are categorised as Help5 or Help6 or ... but only in selected languages.
The proposed replacement gives the list of Help pages a similar structure to the Atum side menu. The changes in brief:
There is a potential problem: initialisation of the Help menu requires a delay or it is left inoperative. That needs testing on different platforms.
Testing Instructions
Testing needs a development installation.
Edit: removed instruction to edit configuration.php - the Help proxy has been fixed.
Actual result BEFORE applying this Pull Request
The current long alphabetic list of Help pages is difficult to use.
Expected result AFTER applying this Pull Request
The list of help pages is structured with a Metismenu. Screenshot to follow.
Link to documentations
Please select:
Documentation link for docs.joomla.org:
[ x] No documentation changes for docs.joomla.org needed
Pull Request link for manual.joomla.org:
[x ] No documentation changes for manual.joomla.org needed