Language Change PR-4.3-dev PR-5.0-dev Pending

User tests: Successful: Unsuccessful:

avatar sdwjoomla
sdwjoomla
14 May 2023

Updated language for How to Create Articles guided tour.

Pull Request for Issue # .

Summary of Changes

Updated the step descriptions for How to Create Articles to provide more information for new users.

Testing Instructions

Using a Joomla 4.3.x instance, click Take a Tour > How to Create Articles?
image

Actual result BEFORE applying this Pull Request

Step 1: How to create articles?
image

Step 2:Select the 'New' Button
image

Step 3: Add a title for the article
image

Step 4: Enter an alias
image

Step 5: Add content
image

Step 6: Select the status
image

Step 7: Select a category
image

Step 8: Toggle featured
image

Step 9: Set the access level
image

Step 10: Add tags
image

Step 11: Add a note
image

Step 12: Add a version note
image

Step 13: Select 'Save and Close'
image

Step 14: Congratulations!
image

Expected result AFTER applying this Pull Request

Step 1: How to create articles?
image

Step 2: Create New Article
image

Step 3: Add a title for the article
image

Step 4: Generate or Add Article Alias
image

Step 5: Add Content
image

Step 6: Set Article Status
image

Step 7: Select Article Category
image

Step 8: Feature an Article
image

Step 9: Set Article Access Level
image

Step 10: Add One or More Tags
image

Step 11: Add a Note
image

Step 12: Add a Version Note
image

Step 13: Save and Close
image

Step 14: Congratulations!
image

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

avatar joomla-cms-bot joomla-cms-bot - change - 14 May 2023
Category Administration Language & Strings
avatar sdwjoomla sdwjoomla - open - 14 May 2023
avatar sdwjoomla sdwjoomla - change - 14 May 2023
Status New Pending
avatar sdwjoomla sdwjoomla - change - 14 May 2023
The description was changed
avatar sdwjoomla sdwjoomla - edited - 14 May 2023
avatar sdwjoomla sdwjoomla - change - 14 May 2023
The description was changed
avatar sdwjoomla sdwjoomla - edited - 14 May 2023
avatar brianteeman
brianteeman - comment - 15 May 2023

Sorry but all of the markup being used here fails basic accessibility and usability.

Whenever you have used a class of fw-bold or fst-italic you have done so to emphasise the text. Because this has been done with a VISUAL class the emphasis is completely ignored by a screen reader and other assistive technology.

That is why we have semantic markup and you must use <em> and <strong> as they convey the additional emphasis to assistive technology and visually.

Secondly for accessibility purposes some of the language changes are not good. Any time that you refer to a previous step this causes cognitive issues so please make sure that the text for each step makes complete sense without having to remember what was in a previous step. see COM_GUIDEDTOURS_TOUR_ARTICLES_STEP_VERSIONNOTE_DESCRIPTION as an example

When updating this pr to use semantic markup you will also see multiple grammar errors so could you please fix those as well.

Finally I am not sure that this can go in a patch release. Please see the policy on changing strings

6.1.6 Language keys
Changing or deleting a language key is considered a backwards compatibility break. Adding new ones is not. Substantially changing the meaning associated with a language key is a compatibility break. Rephrasing something for a more accurate description or proper en-GB grammar is not.

avatar sdwjoomla
sdwjoomla - comment - 15 May 2023

Thanks for your feedback Brian. This is not intended for 4.3.2 but for 5.0. Will review with Olivier and update.

avatar brianteeman
brianteeman - comment - 15 May 2023

This is not intended for 4.3.2 but for 5.0.

then you should make the PR against the correct branch and add [5.0] to the title to make it clearer and help reviewers

avatar obuisard obuisard - change - 15 May 2023
Title
Guided Tours: How to Create Articles Updated Language
[5.0] Guided Tours: How to Create Articles Updated Language
avatar obuisard obuisard - edited - 15 May 2023
avatar sdwjoomla sdwjoomla - change - 15 May 2023
Labels Added: Language Change PR-5.0-dev
avatar sdwjoomla sdwjoomla - change - 15 May 2023
Status Pending Closed
Closed_Date 0000-00-00 00:00:00 2023-05-15 21:41:20
Closed_By sdwjoomla
Labels Added: PR-4.3-dev
avatar sdwjoomla sdwjoomla - close - 15 May 2023

Add a Comment

Login with GitHub to post a comment