mahara-contributors team mailing list archive
-
mahara-contributors team
-
Mailing list archive
-
Message #66834
[Bug 1982294] Re: Accessibility: ability to write alt text that is different to file description text for images
** Description changed:
This feature idea arose from a discussion of this feature request,
regarding descriptions of embedded images in 'Text' blocks: Bug 1737995
It is related to images in 'Image' and 'Image Gallery' blocks only (not
embedded images in 'Text' blocks).
This is a summary of the discussion:
- In order to improve the accessibility of Mahara, we would ideally have alt text available for every image and the alt text would be appropriate for describing an image to someone visually impaired.
- Currently, this is not a requirement.
- Currently, the text provided for the image file description is used as alt text - these are always the same, i.e. when the description is updated, so is the alt text (for 'Image' and 'Image Gallery' blocks).
- Currently, people can choose to display the file description as a caption in Image and Image Gallery blocks.
However, at times, the text that someone wishes to display as a caption
is different to what would be considered appropriate alt text. The alt
text is to describe the image, e.g. 'Two women dressed in warm jackets
walk along a deserted beach', whereas the caption puts the image into
the context of the surrounding text, e.g. 'Sandy and Mel discuss their
latest project while out and about'.
Therefore, the proposed feature is to allow people to write different
text for alt text and for the file description text (that would be used
as a caption).
Where will this be implemented? The MVP of the proposed feature will be
included in the options for editing a file that has been uploaded to
Mahara. (The next phase of this feature would be to make this a
requirement, i.e. prevent people from uploading image files without
writing alt text. That aspect is not part of this feature proposal).
Attached to this bug report is a wireframe of the proposed feature, which illustrates the following user journey:
1. Precondition: user has uploaded an image file
2. User indicates via switchbox whether the image is decorative or not. This switchbox is set to 'No' by default. A tooltip is provided that explains what is considered to be a decorative image.
3. If the user chooses 'Yes', it is a decorative image, therefore no text needs to be provided. The user will not be able to enter alt text or a caption for this image file.
- 4. If the user does switch it to 'Yes', then the 'Alt text' field is available, along with a tooltip explaining what effective and appropriate alt text is. This is a required field and limited to 150 characters (?).
+ 4. If the user leaves this switch set to 'No', then the 'Alt text' field is available, along with a tooltip explaining what effective and appropriate alt text is. This is a required field and limited to 150 characters (?).
5. Below this input field is another switchbox: 'Use this alt text as a caption for this image?' - set to 'Yes' by default. By default, the alt text will be used as the caption.
6. If this switch remains set to 'Yes' and then the user chooses to display the image caption in the 'Image' or 'Image Gallery' blocks, we must ensure that we do not double up the alt text and the image caption. In this case, the image caption is sufficient for a screen reader, and the alt text should be set to an empty string to avoid confusion.
7. If the switchbox from (5) is set to 'No', then the user has the option to provide a separate line of text to be used as the image caption. In this case, when images and their captions are displayed in 'Image' and 'Image Gallery' blocks, there will be both alt text, and an image caption, giving slightly different information.
General:
- Whenever alt text or caption is updated, this update is applied to all instances of the image in 'Image' or 'Image Gallery' blocks. However, the update will not be applied to instances of the image that have been embedded in 'Text' blocks (this is beyond the current scope).
Further consideration needed: if an image is not decorative by default,
that makes the alt text a required field by default. How does this
affect uploading multiple files?
Please see the attached wireframe below which illustrates this feature.
--
You received this bug notification because you are a member of Mahara
Contributors, which is subscribed to Mahara.
Matching subscriptions: mahara-contributors
https://bugs.launchpad.net/bugs/1982294
Title:
Accessibility: ability to write alt text that is different to file
description text for images
Status in Mahara:
New
Bug description:
This feature idea arose from a discussion of this feature request,
regarding descriptions of embedded images in 'Text' blocks: Bug
1737995
It is related to images in 'Image' and 'Image Gallery' blocks only
(not embedded images in 'Text' blocks).
This is a summary of the discussion:
- In order to improve the accessibility of Mahara, we would ideally have alt text available for every image and the alt text would be appropriate for describing an image to someone visually impaired.
- Currently, this is not a requirement.
- Currently, the text provided for the image file description is used as alt text - these are always the same, i.e. when the description is updated, so is the alt text (for 'Image' and 'Image Gallery' blocks).
- Currently, people can choose to display the file description as a caption in Image and Image Gallery blocks.
However, at times, the text that someone wishes to display as a
caption is different to what would be considered appropriate alt text.
The alt text is to describe the image, e.g. 'Two women dressed in warm
jackets walk along a deserted beach', whereas the caption puts the
image into the context of the surrounding text, e.g. 'Sandy and Mel
discuss their latest project while out and about'.
Therefore, the proposed feature is to allow people to write different
text for alt text and for the file description text (that would be
used as a caption).
Where will this be implemented? The MVP of the proposed feature will
be included in the options for editing a file that has been uploaded
to Mahara. (The next phase of this feature would be to make this a
requirement, i.e. prevent people from uploading image files without
writing alt text. That aspect is not part of this feature proposal).
Attached to this bug report is a wireframe of the proposed feature, which illustrates the following user journey:
1. Precondition: user has uploaded an image file
2. User indicates via switchbox whether the image is decorative or not. This switchbox is set to 'No' by default. A tooltip is provided that explains what is considered to be a decorative image.
3. If the user chooses 'Yes', it is a decorative image, therefore no text needs to be provided. The user will not be able to enter alt text or a caption for this image file.
4. If the user leaves this switch set to 'No', then the 'Alt text' field is available, along with a tooltip explaining what effective and appropriate alt text is. This is a required field and limited to 150 characters (?).
5. Below this input field is another switchbox: 'Use this alt text as a caption for this image?' - set to 'Yes' by default. By default, the alt text will be used as the caption.
6. If this switch remains set to 'Yes' and then the user chooses to display the image caption in the 'Image' or 'Image Gallery' blocks, we must ensure that we do not double up the alt text and the image caption. In this case, the image caption is sufficient for a screen reader, and the alt text should be set to an empty string to avoid confusion.
7. If the switchbox from (5) is set to 'No', then the user has the option to provide a separate line of text to be used as the image caption. In this case, when images and their captions are displayed in 'Image' and 'Image Gallery' blocks, there will be both alt text, and an image caption, giving slightly different information.
General:
- Whenever alt text or caption is updated, this update is applied to all instances of the image in 'Image' or 'Image Gallery' blocks. However, the update will not be applied to instances of the image that have been embedded in 'Text' blocks (this is beyond the current scope).
Further consideration needed: if an image is not decorative by
default, that makes the alt text a required field by default. How does
this affect uploading multiple files?
Please see the attached wireframe below which illustrates this
feature.
To manage notifications about this bug go to:
https://bugs.launchpad.net/mahara/+bug/1982294/+subscriptions
References