Skip to content
This repository has been archived by the owner on Jul 11, 2024. It is now read-only.

Minor changes to phrasing #145

Merged
merged 1 commit into from
Sep 26, 2014
Merged

Minor changes to phrasing #145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions source/forms/instructions.html.erb.md
View file
Open in desktop
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ In the example below, form instructions indicate how required input is highlight
## In-line instructions ## In-line instructions
{:.newex} {:.newex}


In addition to the overall instructions, it is also important to provide relevant instructions within the labels of the form controls. For example, indicating required input and data formats is generally needed as part of the labels. In addition to the overall instructions, it is also important to provide relevant instructions within the labels of the form controls. For example, it's generally best to indicate required input and data formats in the text of the labels.


### Providing instructions within labels ### Providing instructions within labels
{:.newex} {:.newex}
Expand Down Expand Up @@ -79,7 +79,7 @@ In the example below, the required format for the “Expiry Date” is indicated
### Providing instructions outside labels ### Providing instructions outside labels
{:.newex} {:.newex}


Providing instructions outside labels allows more flexible positioning and design but sometimes it can be missed. The two approaches outlined below can be combined to achieve most impact. Providing instructions outside labels allows more flexible positioning and design but sometimes it can be missed. The two approaches outlined below can be combined to achieve the most impact.


#### Informing users #### Informing users
{:.ap} {:.ap}
Expand Down Expand Up @@ -118,7 +118,7 @@ Content outside form elements may be missed by screen readers that are in “For
<%= notes_start %> <%= notes_start %>
{:/nomarkdown} {:/nomarkdown}


**Note:** A caveat of this approach is that users receive the instructions after the form element. This is often non-ideal, especially when the form controls are large, or when they are displayed on mobile devices and using screen magnification. In such cases these instructions may not always be easy to find. **Note:** A caveat of this approach is that users receive the instructions after the form element. This is usually not ideal, especially when the form controls are large, or when they are displayed on mobile devices and using screen magnification. In such cases these instructions may not be easy to find.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think if aria-describedby is used, there is no problem with placing simple instructions immediately below a field.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks David, the note is on an example that is not using ARIA. Also, aria-describedby solves the problem for screen reader users but may not solve it for zoom users or in other circumstances. (We have an aria-labelledby example just below that one, see http://w3c.github.io/wai-tutorials/forms/instructions/#using-wai-aria)


{::nomarkdown} {::nomarkdown}
<%= notes_end %> <%= notes_end %>
Expand Down Expand Up @@ -225,7 +225,7 @@ Refer to the techniques described in [Hidden labels](labels.html#hidden) in case
<%= notes_start %> <%= notes_start %>
{:/nomarkdown} {:/nomarkdown}


**Note:** To provide more clarity, ensure that the style of placeholder text is distinguishable from regular text. This is commonly done by reducing the color contrast of placeholder text. However, ensure that also placeholder text meets at least the [minimum color contrast requirement of WCAG 2.0](http://www.w3.org/WAI/WCAG20/quickref/#qr-visual-audio-contrast-contrast). **Note:** To provide more clarity, ensure that the style of placeholder text is distinguishable from regular text. This is commonly done by reducing the color contrast of placeholder text. However, if you do reduce the contrast, ensure that the placeholder text also meets the [minimum color contrast requirement of WCAG 2.0](http://www.w3.org/WAI/WCAG20/quickref/#qr-visual-audio-contrast-contrast).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to ensure there is enough contrast in the browser, if author chooses default contrast in the placeholder


{::nomarkdown} {::nomarkdown}
<%= notes_end %> <%= notes_end %>
Expand Down