? ? ? Pending

User tests: Successful: Unsuccessful:

avatar ceford
ceford
21 Sep 2020

Pull Request for Issue # .

Summary of Changes

All of the Joomla 4 Help files have been renamed (moved leaving redirects) so that their titles are the same as the pages they support, except for the Menu Item types where the type is included (being absent in the page might be considered an omission but that is a separate issue).

We have to change the Help file names in the ini files before any more translations are created (there is a full set of Dutch translations). Otherwise the translators will have to create redirect files too.

This pull request changes the file names and should have no visible effect.

The following Keys are omitted because they are not used in Joomla 4:

id,help_key
13,JHELP_COMPONENTS_CACHE_MANAGER_SETTINGS
14,JHELP_COMPONENTS_CHECK-IN_CONFIGURATION
57,JHELP_COMPONENTS_INSTALLER_CONFIGURATION
60,JHELP_COMPONENTS_JOOMLA_UPDATE_CONFIGURATION
61,JHELP_COMPONENTS_MENUS_CONFIGURATION
62,JHELP_COMPONENTS_MESSAGES_CONFIGURATION
80,JHELP_COMPONENTS_SEARCH
81,JHELP_COMPONENTS_SMART_SEARCH_CONFIGURATION
116,JHELP_EXTENSIONS_MODULE_MANAGER_ADMIN_ONLINE
120,JHELP_EXTENSIONS_MODULE_MANAGER_ADMIN_STATUS
124,JHELP_EXTENSIONS_MODULE_MANAGER_ADMIN_UNREAD
143,JHELP_EXTENSIONS_MODULE_MANAGER_SEARCH
185,JHELP_MENUS_MENU_ITEM_SEARCH_RESULTS
203,JHELP_SITE_MAINTENANCE_PURGE_EXPIRED_CACHE

The numbers refer to the sequence numbers in this reference table that shows old an new names:

https://docs.joomla.org/Help4.x:Help_Screens_by_Key

Testing Instructions

Visit any page and select the Help button

Actual result BEFORE applying this Pull Request

The Help screen will have the new Title because of the redirect. See the Help URL bar.

Expected result AFTER applying this Pull Request

No change but now bypassing the redirect. See the URL bar.

Documentation Changes Required

English documentation is ahead! Translators will need to be aware of this change.

avatar ceford ceford - open - 21 Sep 2020
avatar ceford ceford - change - 21 Sep 2020
Status New Pending
avatar joomla-cms-bot joomla-cms-bot - change - 21 Sep 2020
Category Administration Language & Strings
avatar ceford ceford - change - 21 Sep 2020
The description was changed
avatar ceford ceford - edited - 21 Sep 2020
avatar richard67
richard67 - comment - 21 Sep 2020

It seems there is something wrong with this PR. It shows conflicting files from the beginning on, see at the bottom of the PR here on GitHub. Maybe the 4.0-dev branch in your repository was out of date or contained already some changes compared to the 4.0-dev branch of the CMS when the branch for this PR was created based on your 4.0-dev branch?

avatar richard67 richard67 - change - 21 Sep 2020
Labels Added: ? ?
avatar richard67
richard67 - comment - 21 Sep 2020

@ceford I've allowed myself to solve the conflicting files. Please pull changes from remote to your local git clone if you are working locally on your computer. And please check if your pull request still shows only your changes.

avatar ceford
ceford - comment - 21 Sep 2020

@ceford I've allowed myself to solve the conflicting files. Please pull changes from remote to your local git clone if you are working locally on your computer. And please check if your pull request still shows only your changes.

Thanks for your help. I am using Eclipse. I pulled joomla-origin and pushed (my) origin. Is that what you meant? The pull request looks good. Only the two files I changed are showing.

avatar richard67
richard67 - comment - 21 Sep 2020

I pulled joomla-origin and pushed (my) origin. Is that what you meant?

Yes.

Update 2020-09-23: No, you should have pulled from your origin.

PR looks ok so far.

avatar richard67
richard67 - comment - 23 Sep 2020

@ceford Due to recently merged PR #30458 your PR got conflicts.

I've solved them here on GitHub and have added the language strings which were added by PR #30458 to your PR here. But it seems these strings still have the old page names as value.

Please pull changes from your origin to your local environment and check and if necessary make corrections.

Thanks in avdance.

avatar ceford
ceford - comment - 23 Sep 2020

I have been confused! Pulling but not merging. My remote now has the correct new Help strings to merge.

After this one I think it is time for me to update to a new version of Eclipse and start again. I guess that also asking for trouble!

avatar richard67
richard67 - comment - 23 Sep 2020

My remote now has the correct new Help strings to merge.

@ceford But the strings which came with the last update from 4.0-dev, i.e. added by Brian with his merged PR, still seem to use the old help site scheme, e.g. sting JHELP_EXTENSIONS_MODULE_MANAGER_ADMIN_FRONTEND. Is that ok?

avatar ceford
ceford - comment - 23 Sep 2020

But the strings which came with the last update from 4.0-dev, i.e. added by Brian with his merged PR, still seem to use the old help site scheme, e.g. sting JHELP_EXTENSIONS_MODULE_MANAGER_ADMIN_FRONTEND. Is that ok?

Yes - that string is not used. Some others also added by Brian at my request are also unused - superceded by new strings, many changing CONFIGURATION to OPTIONS.

avatar richard67
richard67 - comment - 23 Sep 2020

Yes - that string is not used. Some others also added by Brian at my request are also unused - superceded by new strings, many changing CONFIGURATION to OPTIONS.

@ceford Would it make sense then to remove them?

avatar ceford
ceford - comment - 23 Sep 2020

My mistake: JHELP_EXTENSIONS_MODULE_MANAGER_ADMIN_FRONTEND is used and was using the old file name. I have changed it to the new file name. The file will actually get renamed later today. I think we are good to go.

avatar richard67
richard67 - comment - 23 Sep 2020

How about the others which were added with Brian's PR?

  • JHELP_EXTENSIONS_MODULE_MANAGER_ADMIN_LOGIN_SUPPORT
  • JHELP_EXTENSIONS_MODULE_MANAGER_ADMIN_MESSAGES
  • JHELP_EXTENSIONS_MODULE_MANAGER_ADMIN_POST_INSTALLATION_MESSAGES
  • JHELP_EXTENSIONS_MODULE_MANAGER_ADMIN_STATUS_USER
  • JHELP_EXTENSIONS_MODULE_MANAGER_ADMIN_VERSION

Are they all ok?

avatar ceford
ceford - comment - 23 Sep 2020

Thank you for being so vigilant. I have changed the strings to the new file names. They were missed because they are not in the master table of help screens used by the Docs team. I have noticed that these strings are not in the API joomla.ini file. I can't image anyone accessing help screens through the api - but should they be there for completeness?

avatar richard67
richard67 - comment - 23 Sep 2020

I have noticed that these strings are not in the API joomla.ini file. I can't image anyone accessing help screens through the api - but should they be there for completeness?

No idea. @brianteeman Do you know that?

avatar ceford
ceford - comment - 23 Sep 2020

Checked for differences - only those missing strings so made api joomla.ini JHELP strings same as joomla.ini JHELP strings.

avatar ceford
ceford - comment - 24 Sep 2020

I guess it is bad form to test my own pull request but I have done so with Patchtester and it works as expected.


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/30712.

avatar richard67
richard67 - comment - 24 Sep 2020

@ceford It is not bad form to test your own PR, it is even required to do so before proposing a PR. It only doesn't count for the 2 testers criterion, and so no need to and no use in marking the test result for an own PR in the issue tracker. So all ok here.

avatar MartijnMaandag MartijnMaandag - test_item - 29 Sep 2020 - Tested successfully
avatar MartijnMaandag
MartijnMaandag - comment - 29 Sep 2020

I have tested this item successfully on 47d99ad

I tested this and it took some time (not technical) to find out if it's ok.
It functions.

What I did is:
Dutch language files installed (from https://www.joomlacommunity.nl/downloads/joomla-4/90-nederlands-taalpakket-nl-nl-joomla-4-0-0-beta).
Changed default language into Dutch.
I have translated a screen into Dutch: Articles - Options.
The English version became visible before installing the patch.
After installing the patch nothing changed. I then discovered that the patch was related to the Joomla.ini language file.
After copying all JHELP_ language strings from the English version into the Dutch Joomla.ini file it worked.
My question is: why can these language strings be translated in Crowdin?
All language string with underscores are clear to me, but there are some (like JHELP_CONTENT_ARTICLE_MANAGER = "Articles") that I would translate.
I will create an issue that everything with JHELP_ in Joomla.ini should not be translated in Crowdin.


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/30712.
avatar particthistle particthistle - test_item - 6 Oct 2020 - Tested successfully
avatar particthistle
particthistle - comment - 6 Oct 2020

I have tested this item successfully on 47d99ad

Checked a random selection of help pages where the key has been changed.

All mapped correctly. Great work Cliff.


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/30712.

avatar richard67 richard67 - change - 6 Oct 2020
Status Pending Ready to Commit
avatar richard67
richard67 - comment - 6 Oct 2020

RTC


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/30712.

avatar HLeithner HLeithner - change - 6 Oct 2020
Status Ready to Commit Fixed in Code Base
Closed_Date 0000-00-00 00:00:00 2020-10-06 11:19:30
Closed_By HLeithner
Labels Added: ?
avatar HLeithner HLeithner - close - 6 Oct 2020
avatar HLeithner HLeithner - merge - 6 Oct 2020
avatar HLeithner
HLeithner - comment - 6 Oct 2020

Thanks

Add a Comment

Login with GitHub to post a comment