User tests: Successful: Unsuccessful:
Pull Request for Issue #35416 can partly replace #35418.
This PR removes some of the JHELP_ language strings and instead directly uses the reference key in the call.
Since the language strings aren't supposed to be adjusted by translators, we can as well just hardcode them and thus reduce complexity and error possibilities.
Those language strings imho come from a time where our documentation server couldn't handle translations and some language packs would provide their own servers.
I haven't replaced all strings yet. Eg Banners, Contacts, Fields, Smart Search should work.
I saw that components like com_categories or com_config would need a different approach. I'm not even sure they currently work for 3rd party (help buttons show up for my component but I haven't defined one nor have I strings that would fit). So that part needs a refactor anyway. Ideas welcome.
For com_config, there is already a part which takes the key from the config, that could work well for core.
For com_categories, we likely would have to invent something new, currently it puts together a string in the hopes that the extension has it defined.
Make sure help screens still work.
Strings are translated. Help screens work.
Strings removed
No change in how help screens appear.
Not sure if that is documented.
In case it's not clear: I will expand this PR with the other strings, but run out of time for now.
@Bakual
This can't work as is as the strings are also used to get the urls in joomla40/administrator/index.php?option=com_admin&view=help
I tested the help for the strings you deleted and I get 404s as the link is of type https://help.joomla.org/proxy?keyref=Help40:JHELP_CONTENT_ARTICLE_MANAGER&lang=en
Hmm, I wasn't aware of that view.
It looks like everything is defined in a JSON file generated by https://github.com/joomla/joomla-cms/blob/4.0-dev/build/helpTOC.php which apparently creates that file.
The whole thing looks a bit hacky to me and likely also break if we just move the strings to a different file. So that needs to be taken care of anyway.
Labels |
Added:
?
|
Category | ⇒ | Administration com_admin com_associations com_banners com_contact com_content com_fields com_finder com_installer com_joomlaupdate com_messages com_newsfeeds |
Title |
|
I've adjusted the helpTOC.php file so it doesn't reverse lookup the JHELP_ strings, looking for the doc page titles to get the KEY for the COM_ADMIN_HELP_ strings which are used for the translated link texts.
That required to change the COM_ADMIN_HELP_ keys so they match the doc pages.
The GitHub diff view looks worse than it is for com_admin.ini, the translated values didn't change, only the keys. So in Crowdin Translation Memory should kick in and help the TTs.
This PR still needs some work, so I've added [WIP] to the title. But I wanted to let you see which direction I would go.
Category | Administration com_admin com_associations com_banners com_contact com_content com_fields com_finder com_installer com_joomlaupdate com_messages com_newsfeeds | ⇒ | Administration com_admin com_associations com_banners com_contact com_content com_fields com_finder com_installer |
Category | Administration com_admin com_associations com_banners com_contact com_content com_fields com_finder com_installer | ⇒ | Administration com_admin com_associations com_banners com_cache com_checkin com_config com_contact com_content com_fields com_finder com_installer |
Title |
|
It's now ready for tests. All JHELP_ strings are removed and instead replaced with direct ref_key within code.
The only ones left are the ones for com_categories and com_config. I can see ways to get rid of those as well, but I want to do that in a separate PR if this one gets accepted.
I have tested this item
I have clicked on as much links I could within the help screen as well within various other parts of the system by using the help button.
Before I did this I checked if various files on the server included the changes.
All seem to work.
I have tested this item
I did test and clicked several items. They work.
But: I started to go to "Help", "Joomla Help" Only the first three items ( Start here, License and Glossery) do work.
Als the others are wrong URLs examples:
https://help.joomla.org/proxy?keyref=Help40:COMPONENTS_BANNERS_CLIENTS_EDIT&lang=nl
https://help.joomla.org/proxy?keyref=Help40:Banners:_New_or_Edit_Client&lang=nl
https://help.joomla.org/proxy?keyref=Help40:COMPONENTS_BANNERS_CLIENTS&lang=nl
https://help.joomla.org/proxy?keyref=Help40:Banners:_Clients&lang=nl
Capital letters are the wrong new ones, the others are what they should be.
@MartijnMaandag Hmm, that is strange. Did you test in the english language or with nl-NL? I'll try to reproduce it then and see why this happens.
Please remove the unrelated files
templates/cassiopeia/js/template.min.js.gz
images/te-voi-inalta.mp3
images/fernando-1.mp3
images/03-sweet-fellowship.mp3
@brianteeman Oops, they sneaked in. Thanks for the sharp eyes!
looks like you missed one
@Bakual Yes I did also test the Admin in English. (as far as I remember if the language-helspscreen is not available, the English language helpscreen appears)
When i apply the patch the difference between the link to the helpscreen in the article edit and the list is (first is real screen, second is the list in Help - JoomlaHelp):
https://help.joomla.org/proxy?keyref=Help40:Articles:_Edit&lang=en
https://help.joomla.org/proxy?keyref=Help40:CONTENT_ARTICLE_MANAGER_EDIT&lang=en
When I revert the patch I do get:
https://help.joomla.org/proxy?keyref=Help40:Articles:_Edit&lang=en
https://help.joomla.org/proxy?keyref=Help40:Articles:_Edit&lang=en
I am testing on localhost Joomla 4.0.2 and Patchtester 4.1.0
I cannot replicate this. Maybe there is something missing in the instructions how to replicate?
I did even make a clean install of Joomla 4.0.2 and Patchtester.
No other extensions installed (even no languages).
I have tested this item
For the JHelp strings concerned, see below which are still in
@Bakual
Looks some are still present in joomla.ini. If deleted, it works fine in admin Joomla Help, it does not in the pages concerned.
JHELP_COMPONENTS_BANNERS_CATEGORIES="Banners:_Categories"
JHELP_COMPONENTS_BANNERS_CATEGORY_ADD="Banners:_New_or_Edit_Category"
JHELP_COMPONENTS_BANNERS_CATEGORY_EDIT="Banners:_New_or_Edit_Category"
JHELP_COMPONENTS_COM_ACTIONLOGS_OPTIONS="User_Actions_Log:_Options"
JHELP_COMPONENTS_COM_ASSOCIATIONS_OPTIONS="Multilingual_Associations:_Options"
JHELP_COMPONENTS_COM_BANNERS_OPTIONS="Banners:_Options"
JHELP_COMPONENTS_COM_CACHE_OPTIONS="Cache:_Options"
JHELP_COMPONENTS_COM_CHECKIN_OPTIONS="Check-in:_Options"
JHELP_COMPONENTS_COM_CONTACT_OPTIONS="Contacts:_Options"
JHELP_COMPONENTS_COM_CONTENT_OPTIONS="Articles:_Options"
JHELP_COMPONENTS_COM_FINDER_OPTIONS="Smart_Search:_Options"
JHELP_COMPONENTS_COM_INSTALLER_OPTIONS="Installer:_Options"
JHELP_COMPONENTS_COM_JOOMLAUPDATE_OPTIONS="Joomla_Update:_Options"
JHELP_COMPONENTS_COM_LANGUAGES_OPTIONS="Languages:_Options"
JHELP_COMPONENTS_COM_MAILS_OPTIONS="Mail_Templates:_Options"
JHELP_COMPONENTS_COM_MEDIA_OPTIONS="Media:_Options"
JHELP_COMPONENTS_COM_MENUS_OPTIONS="Menus:_Options"
JHELP_COMPONENTS_COM_MESSAGES_OPTIONS="Messages:_Options"
JHELP_COMPONENTS_COM_MODULES_OPTIONS="Module:_Options"
JHELP_COMPONENTS_COM_NEWSFEEDS_OPTIONS="News_Feed:_Options"
JHELP_COMPONENTS_COM_PLUGINS_OPTIONS="Plugin:_Options"
JHELP_COMPONENTS_COM_POSTINSTALL_OPTIONS="Post-installation_Messages:_Options"
JHELP_COMPONENTS_COM_PRIVACY_OPTIONS="Privacy:_Options"
JHELP_COMPONENTS_COM_REDIRECT_OPTIONS="Redirect:_Options"
JHELP_COMPONENTS_COM_TAGS_OPTIONS="Tags:_Options"
JHELP_COMPONENTS_COM_TEMPLATES_OPTIONS="Template:_Options"
JHELP_COMPONENTS_COM_USERS_OPTIONS="Users:_Options"
JHELP_COMPONENTS_CONTACT_CATEGORIES="Contacts:_Categories"
JHELP_COMPONENTS_CONTACT_CATEGORY_ADD="Contacts:_New_or_Edit_Category"
JHELP_COMPONENTS_CONTACT_CATEGORY_EDIT="Contacts:_New_or_Edit_Category"
JHELP_COMPONENTS_CONTENT_CATEGORIES="Articles:_Categories"
JHELP_COMPONENTS_CONTENT_CATEGORY_ADD="Articles:_New_or_Edit_Category"
JHELP_COMPONENTS_CONTENT_CATEGORY_EDIT="Articles:_New_or_Edit_Category"
JHELP_COMPONENTS_NEWSFEEDS_CATEGORIES="News_Feeds:_Categories"
JHELP_COMPONENTS_NEWSFEEDS_CATEGORY_ADD="News_Feeds:_New_or_Edit_Category"
JHELP_COMPONENTS_NEWSFEEDS_CATEGORY_EDIT="News_Feeds:_New_or_Edit_Category"
JHELP_COMPONENTS_USERS_CATEGORIES="User_Notes:_Categories"
JHELP_COMPONENTS_USERS_CATEGORY_ADD="User_Notes:_New_or_Edit_Category"
JHELP_COMPONENTS_USERS_CATEGORY_EDIT="User_Notes:_New_or_Edit_Category"
@MartijnMaandag
Install last dev including this PR
https://ci.joomla.org/artifacts/joomla/joomla-cms/4.0-dev/35429/downloads/47363/
@infograf768 This solves the problem with the link.
But.. The index is not translated anymore when you use a translation like Dutch in the image).
@infograf768 please read the original post by @Bakual before commenting.
@MartijnMaandag
The PR modifies the COM_ADMIN_HELP_XXX. strings constants, therefore your translations will not work and en-GB replaces them.
@infograf768 The _OPTIONS
strings are taken care of by #35479
For the _CATEGORIES
, _CATEGORY_ADD
and _CATEGORY_EDIT
, I have no solution yet. This ones need more thinking.
@MartijnMaandag Looks like the Patchtester doesn't replace the file administrator/help/en-GB/toc.json.
That would explain your issue.
Also the translations will have to be done new by the translators since the language string keys changed. Translation Memory likely will help.
Ah, yes. That could be the reason as well. 178 changed files may be a bit to much.
looks like you missed one
@brianteeman While figuring out how to fix this one, I found another bug. The help screens actually don't work for any system links menuitems
However I don't know which help URL (which ref_key) that specific menuitemtype should load. The string is missing in J3 as well.
Maybe someone knows the correct URL, then we can fix it in J3 and J4.
Maybe someone knows the correct URL, then we can fix it in J3 and J4.
I assume you resolved that question with the other PR?
I don't know the URL yet, but the other PR fixes the help screens for all other "System Links" menuitems. But I'm asking my way around to get the correct URL. Asked Mike Brandner now. If someone else has some knowledge, feel free to share
I am not sure what you mean. Does this help https://docs.joomla.org/Category:Menus_Help_Screens/en
Hmm, the "control page" seems to be good one.
But it looks like helppage is missing completely then for the admin menuitem "System Links" -> "Components Menu Container".
I have tested this item
@richard67 Aye, the missed string is a different issue that I can't solve here yet.
Btw: #35534 is the last missing piece, containing the JHELP Strings for com_categories.
Status | New | ⇒ | Ready to Commit |
RTC
Conflicts here too. Let's do categories first and then resolve this one once that one is merged.
Labels |
Added:
?
|
Conflicts solved here too. No worries, it's simple to fix if it breaks again again with the next merge
Categories merged. Conflicts again here
Status | Ready to Commit | ⇒ | Fixed in Code Base |
Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2021-09-23 21:41:55 |
Closed_By | ⇒ | wilsonge |
Thanks!
Please add the label LANGUAGE
Strange that it has not been added by our bot since the PR removes language strings.
It's the wrong way in my opinion, who knows that the next documentation system is and what it need for each language.