Bug 148941 - Make label of the field for an image's text alternative consistent
Summary: Make label of the field for an image's text alternative consistent
Status: VERIFIED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Writer (show other bugs)
Version:
(earliest affected)
unspecified
Hardware: All All
: medium normal
Assignee: sdc.blanco
URL: https://help.libreoffice.org/7.4/en-U...
Whiteboard: target:7.4.0 target:7.5.0 target:7.4....
Keywords: difficultyMedium, easyHack, skillDesign, topicUI
Depends on:
Blocks: a11y, Accessibility
  Show dependency treegraph
 
Reported: 2022-05-04 22:00 UTC by Christophe Strobbe
Modified: 2024-02-23 12:33 UTC (History)
5 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 Christophe Strobbe 2022-05-04 22:00:12 UTC
Steps to reproduced the issue
1. Insert an image into a Writer document.
3. Right-click on the image and choose "Properties" from the context menu; go to the Options tab: below the Name field, there is a field named "Alternative (Text only)". Fill in a string such as "test-title" and exit the dialog.
4. While the image is still selected, go to the Format menu and choose "Description". The string "test-title" now appears in a field named "Title".

The labels are inconsistent with each other.
A. "Title" is based on the fact that the field creates the content of the svg:title element in content.xml. This corresponds to the img element's alt attribute in HTML (see Appendix D in part 3 of the ODF 1.3 spec).
B. The label "Alternative (Text only)" seems to result from an attempt to better describe the field's purpose, but I suspect the string "Text alternative" (used in standards such as WCAG 2.1: https://www.w3.org/TR/WCAG21/#text-alternatives ) was misunderstood by someone who renamed the label. (In the French UI, we see the same issue: "Alternative (text seul)"; the German UI at least makes sense "Alternativtext".)

We need to make this consistent and replace both "Title" and "Alternative (Text only)" with a label that better conveys the field's purpose, i.e. providing a text alternative that serves the same purpose or conveys the same information as the image.

(I could not find such inconsistency for drawing objects, which have no context menu entry named "Properties", nor in Impress, where "Description" in an image's context menu opens a dialog wit just the fields "Title" and "Description". However, in these cases also, "Title" should be replaced with a better label.)
Comment 1 Heiko Tietze 2022-05-09 09:15:43 UTC
Yes, good catch. Would keep the term Description for the command (despite it allows also to modify the alt text) but change Title in the dialog to Alternative Text. The caption in the properties dialog with Alternative (Text Only) reads a bit rough and we should change this too.

Code pointers: sw/uiconfig/swriter/ui/frmaddpage.ui and cui/uiconfig/ui/objecttitledescdialog.ui (I suspect this dialog to be called from other places too, so some double-checking should be done).

Seth, one for you?
Comment 2 sdc.blanco 2022-05-10 02:15:53 UTC
https://gerrit.libreoffice.org/c/core/+/134066

1. Used "Text Alternative" because: (a) that is the formal term used by WCAG 2.1, and (b) therefore more likely to be recognized by users who are oriented to wanting to use this feature.

2. Also added tooltips to Description dialog (on the assumption that it would explain the purpose of "Text Alternative" and "Description"), and also added tooltips to the .unos for Name and Description (mostly for the Customize dialog and notebookbar users).

3. Afaict the "Description" field is not exported to HTML (bug 149013).
Comment 3 Christophe Strobbe 2022-05-10 10:29:13 UTC
@sdc.blanco Thanks for this quick response!

I wonder whether it is still possible to modify the tooltips in cui/uiconfig/ui/objecttitledescdialog.ui:
- instead of "Give short label for non-text content": "Give a short description for non-sighted users" (or "non-visual users");
- instead of "Give longer explanation of non-text content labeled by “Text Alternative”": "Give longer description of non-text content that is too complex to be described using only the “Text Alternative” field".

Accordingly, in officecfg/registry/data/org/openoffice/Office/UI/GenericCommands.xcu: 
- "Give a label to identify an object" -> "Give a short description for non-sighted users" (or "non-visual users"),
  or if this is supposed to be different from what we have inobjecttitledescdialog.ui: "Give a short description that provides the same information as the image";
- "Add information about non-text content (for accessibility)" -> "Give longer description of non-text content that is too complex to be described using only the “Text Alternative” field" ("information about" is a bit vague: we don't want, e.g. copyright information or other information that does not convey the same information as the object/image); 
  or if this is supposed to be different from what we have inobjecttitledescdialog.ui: "If the image is too complex to describe using only the “Text Alternative” field, provide all the essential information conveyed by the image here".
(I don't know what the length limitations for the prop elements in officecfg/registry/data/org/openoffice/Office/UI/GenericCommands.xcu are.)
Comment 4 sdc.blanco 2022-05-10 11:40:34 UTC
(In reply to Christophe Strobbe from comment #3)

Thanks for your useful feedback and suggestions.
> 
> - instead of "Give short label ... 
Now adjusted to:  

"Give a short description of non-text content for users who do not see this object."

Explanation: 

1.  instead of labeling "users", label the action  ("not seeing...")
2.  "this object" is meaningful in this context because the field in this dialog is only presented in relation to a selected object. 


> - instead of "Give longer explanation...
Now adjusted to: 

'Give longer explanation of non-text content that is too complex to be described briefly in “Text Alternative” '


And to clarify some special points about the tooltips in  officecfg/registry/data/org/openoffice/Office/UI/GenericCommands.xcu 

> - "Give a label to identify an object" -> "Give a short description for
> non-sighted users" (or "non-visual users"),
No adjustment here.

Explanation:
Tooltip is for "Name" command -- which is meant/used primarily by the author of the document.  Iow, a different issue here, not related to accessibility of visual content.

> - "Add information about non-text content (for accessibility)" 
Now adjusted to:

"Add descriptions of non-text content (for accessibility)"

Explanation:
This tooltip is for the *command* named "Description" which opens the "Description" popup box to enter descriptions for both "Title" (soon "Text Alternative") and "Description" for an object.  Therefore, it is necessary to make this command tooltip a little generic, because it is referring to two fields, while the previous tooltip for "Description" in objecttitledescdialog.ui is referring to and used only to describe the single field "Description".
Comment 5 Commit Notification 2022-05-12 10:50:17 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/8afd0dcbe23846c12c830b2637db7993a0aa5942

tdf#148941 consistency between popup box and option dialog for objects

It will be available in 7.4.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 6 Commit Notification 2022-05-29 07:23:40 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/2df65a1ff7072dc0ec866f5dfe11846c15208199

tdf#149010,tdf#148941,tdf#149012,tdf#149130 update to reflect changes
Comment 7 sdc.blanco 2022-05-30 22:58:18 UTC
There were no tooltips for "Text Alternative" and "Description" in the Options tab for the Frame, Image, and OLE Object Properties dialog. There was an inadequate extended tooltip for "Text Alternative" and no extended tooltip for "Description". The following patch adds or corrects these tooltips -- now with a focus more on their function in relation to accessibility.

https://gerrit.libreoffice.org/c/core/+/135073
Comment 8 sdc.blanco 2022-05-31 00:14:46 UTC
The Imagemap dialog (Tools > Imagemap) also has a "Text Alternative", which is described as "Text" in the dialog. Within that dialog is a context menu that opens a "Description" dialog that uses "Alternative text".  "Text" and "Alternative text" labels refer to the same field. Changing the entry in the Description dialog for "Alternative text" also changes the value of "Text" for the Imagemap dialog.

The following patch makes them both "Text Alternative" (to be consistent with the Format > Description dialog and the Options tab for objects). 

https://gerrit.libreoffice.org/c/core/+/135155

Also, the following tooltip for "Text Alternative" is added to both dialogs:

  Enter a short description of essential features of the image map for persons who do not see the image.

The extended tooltip for Text Alternative was:

Enter the text that you want to display when the mouse rests on the hotspot in a browser.

Have added:  This text can also be used by assistive technologies.

(but is that true?)

The text is exported as "alt", for example,
<area shape=rect coords="5,8,108,108" nohref name="ImageMap" alt="This is Text Alternative">

Added following tooltip for Description (though at present, this is not exported to HTML - bug 149013).

   Give a longer explanation of the image map if it is too complex to be described briefly in “Text Alternative.

Also added: "This text can also be used by assistive technologies." to the extended tooltips for "Description" in both dialogs - but otherwise did not change for now.

(The help page will also need to be updated).

Are there additional issues to be considered for image maps in relation to "Text Alternative" and "Description"?
Comment 9 Commit Notification 2022-06-04 13:58:33 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#148941 add tooltips for “Text Alternative” and “Description”

It will be available in 7.4.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 10 sdc.blanco 2022-06-04 20:21:07 UTC
https://gerrit.libreoffice.org/c/core/+/135155 was also pushed, but a mistake in its commit message resulted in its notification appearing in bug 148491, comment 5. The commit is: 3a78fb5d750ae462bf62d4568ad3a504a6db17a7
Comment 11 sdc.blanco 2022-06-04 20:34:58 UTC
No input received about the tooltips for the Options tab and the Imagemap dialog.
While I believe they are improved, especially in relation to explaining the purpose of "Text Alternative" and "Description", it is possible that the tooltips in relation to Imagemap can still be developed further -- in relation to how they might be used with Imagemap -- but that is outside the scope of this ticket.

I believe that all dialogs in the UI where it was possible to add svg:title and svg:desc have now been labeled with "Text Alternative" and appropriate tooltips added in each case., so closing this ticket as FIXED.
Comment 12 Commit Notification 2022-06-18 12:15:29 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/345a9ecdd1d744f97a7281a49ef6940824089fd4

(related)tdf#148941  update label
Comment 13 Commit Notification 2022-06-18 12:18:40 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "libreoffice-7-4":

https://git.libreoffice.org/help/commit/0495c0c08b099fa2384ee0bdc3d730b51bdf8ed5

(related)tdf#148941  update label
Comment 14 Commit Notification 2022-06-18 12:35:54 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

(related) tdf#148941 update label in Imagemap properties page
Comment 15 Commit Notification 2022-06-18 12:39:04 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "libreoffice-7-4":

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

(related) tdf#148941 update label in Imagemap properties page
Comment 16 BogdanB 2022-06-24 04:32:27 UTC
Based on the bug description, now everything is solved.

Tested on
Version: 7.4.0.0.beta1+ / LibreOffice Community
Build ID: 6ab56a4fc946f6294513f23a3ea47aa0aa154b7d
CPU threads: 16; OS: Linux 5.13; UI render: default; VCL: gtk3
Locale: ro-RO (ro_RO.UTF-8); UI: en-US
Calc: threaded