Bug 155044 - Rename Format - Description menu item
Summary: Rename Format - Description menu item
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: UI (show other bugs)
Version:
(earliest affected)
7.6.0.0 alpha0+
Hardware: All All
: medium enhancement
Assignee: Heiko Tietze
URL:
Whiteboard: target:24.2.0
Keywords: accessibility, easyHack, skillDesign, topicUI
Depends on:
Blocks: a11y, Accessibility
  Show dependency treegraph
 
Reported: 2023-04-27 09:06 UTC by Gabor Kelemen (allotropia)
Modified: 2024-03-26 09:10 UTC (History)
9 users (show)

See Also:
Crash report or crash signature:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Gabor Kelemen (allotropia) 2023-04-27 09:06:58 UTC
The Format - Description menu item and the dialog (see attachment 186954 [details]) it opens is used to enter accessible descriptions for various non-text objects. These descriptions are then used by screen readers and in the HTML and PDF/UA export as well.

I think it is not obvious what the menu item and the dialog are for (although the dialogs tooltips explain the fields functions pretty well).

Suggestion: rename both to "Accessible Description" which would be more intuitive.

For comparison MS Word calls the same thing "Alt text" which is semi-techspeak.
Comment 1 Heiko Tietze 2023-04-27 10:00:34 UTC
(In reply to Gabor Kelemen (allotropia) from comment #0)
> "Accessible Description"

Basically yes but is this form correct? Thinking of "Accessibility Description"...
Comment 2 BogdanB 2023-04-27 13:33:26 UTC
(In reply to Heiko Tietze from comment #1)
> (In reply to Gabor Kelemen (allotropia) from comment #0)
> > "Accessible Description"
> 
> Basically yes but is this form correct? Thinking of "Accessibility
> Description"...

Agree on "Accessibility Description".
Comment 3 sdc.blanco 2023-04-27 14:58:08 UTC
no objection to "Accessibility Description", but the command opens a dialog that gives the possibility to associate two kinds of information with objects, where from accessibility pov, "Text Alternative" may be the more important/relevant label [1].  Maybe the following would be sufficient (while keeping the label short):

Format -> Accessibility...

[1] https://www.w3.org/WAI/test-evaluate/preliminary/#images
Comment 4 V Stuart Foote 2023-04-27 15:40:12 UTC
I would agree with Gabor, in standard technical English it should be "Accessible Description..."--but in reality the "alt text..." is well known from W3C "alt attribute" and "longdesc attribute"  alternative text practices and would be equally acceptable.

Also I'm sure the "alt text" label/menu entry would be an easier string for l18n to handle as its concept is ubiquitous, it certainly would be more concise for use on a menu (main or context).

Also, consider that .uno:ObjectTitleDescription (also found as "Description" for Tools -> Customize dialog use) is already used in many places in addition to menus.

For example, the same UNO controls are contained on the Properties... dialog "Options" tab-- "Name", "Text Alternative", and "Description"-- are included within an 'Accessibility' grouping, along with a checkbox to set them as "Decorative"

Either leave the menu entry as is with 'Description...' (its not that bad) or use 'Alt Text...' but avoid the i18n thrash and potential for width issues that "Accessible Description..." would invoke.  A flat no for "Accessibility Description..."
Comment 5 V Stuart Foote 2023-04-27 15:43:15 UTC
(In reply to V Stuart Foote from comment #4)
s/l18n/l10n/g
s/i18n/l10n/g
Comment 6 Gabor Kelemen (allotropia) 2023-04-28 12:11:41 UTC
(In reply to V Stuart Foote from comment #4)
> I would agree with Gabor, in standard technical English it should be
> "Accessible Description..."--but in reality the "alt text..." is well known
> from W3C "alt attribute" and "longdesc attribute"  alternative text
> practices and would be equally acceptable.

I can not imagine that most of non-IT educated users (lawyer, public administration clerk, teacher, economist) know "alt text" from W3C or about the existence of W3C at all.

In the Hungarian localization of Word they translated "Alt text" as "Replacement text".
But that's just my bias.
Comment 7 V Stuart Foote 2023-04-28 15:14:00 UTC
(In reply to Gabor Kelemen (allotropia) from comment #6)
> 
> I can not imagine that most of non-IT educated users (lawyer, public
> administration clerk, teacher, economist) know "alt text" from W3C or about
> the existence of W3C at all.
> 

And equally we could question why the Name..., and Description... widgets have even made it onto the Format menu--and are not present by default on the context menu for the objects supporting them. [1] The casual user has no interest in preparing accessible documents and doesn't.  

But as a document authoring tool (providing ODF svg:title and svg:desc) we need to encourage and facilitate accessible documents--hence the presence on the Format menu and context menus active for objects.

And suggestions like bug 39558 (to prompt to add title and alt/longdesc attributes) and bug 96355 (for a consistent Properties... dialog).

=-ref-=
[1] context menu cleanup of bug 81132 that resulted in bug 101193
Comment 8 Cor Nouws 2023-05-10 18:53:38 UTC
"Alternative text" is found often to describe this..
Comment 9 Heiko Tietze 2023-05-11 07:20:06 UTC
We discussed the topic in the design meeting.

"Alt Text" might be tech-talk but is used in MSO at the a11y sidebar. "Alternative Text" can be found on various U.S. university web sites, and Wikipedia discusses the term "Alt Attribute" in https://en.wikipedia.org/wiki/Alt_attribute.

We recommend to use "Alt Text" (but the other labels would be an improvement too). Adding a hint for translators might be helpful.

Code pointer: 

.uno:ObjectTitleDescription in officecfg/registry/data/org/openoffice/Office/UI/GenericCommands.xcu (we probably can remove the same command from ChartCommands.xcu)
Comment 10 Buovjaga 2023-09-24 11:12:43 UTC
Remember to also update help
Comment 11 Commit Notification 2023-09-24 16:51:54 UTC
Heiko Tietze committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/a5ece3a525466198c91633af3b9e0d6edfe9802f

Resolves tdf#155044 - Rename "Description" to "Alt Text"

It will be available in 24.2.0.

The patch should be included in the daily builds available at
https://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
https://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
Comment 12 Heiko Tietze 2023-09-24 16:53:53 UTC
Not only the Description dialog (objecttitledescdialog.ui) but some IMAP-related UI also had this text in the ui (cuiimapdlg.ui)
Comment 13 Heiko Tietze 2023-09-24 16:58:14 UTC
(In reply to Buovjaga from comment #10)
> Remember to also update help

Prefer to leave this for the experts.
Comment 14 Commit Notification 2023-10-11 17:24:37 UTC
Ilmari Lauhakangas committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/20f11111da9c698023cdf76d35bb4a34b2fee094

tdf#155044 Missed one Description to Alt Text spot

It will be available in 24.2.0.

The patch should be included in the daily builds available at
https://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
https://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
Comment 15 Commit Notification 2023-10-11 17:24:39 UTC
Ilmari Lauhakangas committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/e7ec227d83792bdaf88cb53be5a5a8849f7f576a

tdf#155044 Help: Description -> Alt Text and Text Alternative -> Text