Skip to content
This repository is currently being migrated. It's locked while the migration is in progress.

Commit 5e06736

Browse files
humancompanion-usdsCopilotDanielleThierryUSDSVAdanbrady
authored
Capitalization: Adds all-caps exception guidance (#5719)
* docs: Capitalization: Adds all-caps exception guidance Adds a new 'Exceptions where we use all caps' section to the capitalization page with a restrictive allowlist (eyebrow text labels and Button - Icon labels only). Includes a brief accessibility note about legibility. Adds cross-references from the typography eyebrow section and button-icon page. Closes #4403 * Update src/_content-style-guide/capitalization.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update src/_content-style-guide/capitalization.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update src/_foundation/typography.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update src/_components/button/button-icon.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Refine language for button-icon component documentation Danielle edits * Revise capitalization guidelines for clarity Clarify capitalization rules and improve readability. * Refine eyebrow component description for clarity * Clarify instructions for icon and label requests Updated instructions for requesting new icons and labels. * Update src/_components/button/button-icon.md Co-authored-by: Dan Brady <danbrady@users.noreply.github.com> * Update src/_components/button/button-icon.md Co-authored-by: Dan Brady <danbrady@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Danielle Thierry <62957278+DanielleThierryUSDSVA@users.noreply.github.com> Co-authored-by: Dan Brady <danbrady@users.noreply.github.com>
1 parent f0ae1ff commit 5e06736

3 files changed

Lines changed: 19 additions & 7 deletions

File tree

src/_components/button/button-icon.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ anchors:
5151

5252
### How this component works
5353

54-
* **Icon plus uppercase label.** These buttons are composed of an icon and an uppercase label. The label is a verb that represents an action that the user is taking. Because the visual style of this button uses uppercase text, labels must be very concise actions and thus are limited to one or two words only. For example, "Change file", "Delete", and "Cancel".
54+
* **Icon plus action label.** These buttons are composed of an icon and a concise label. For the label, use a verb that describes the action the person is taking, and aim to limit the label text to 1 or 2 words. For example, "Change file", "Delete", or "Cancel". The component’s visual style renders labels in uppercase, but authors should always provide label text in sentence case. Refer to [Capitalization]({{ site.baseurl }}/content-style-guide/capitalization) for guidance on when we permit all caps in visual treatments.
5555

5656
## Requesting new instances
5757

@@ -61,7 +61,7 @@ The 3 examples above are the only currently approved instances of this component
6161

6262
## Content considerations
6363

64-
* **Delete is preferred to remove.** We prefer words that describe exactly what will happen when you tap or click. Note: Currently, icon and button labels are hard-coded into the component. New icons and labels must be requested following the instructions above.
64+
* **Use the verb that describes exactly what will happen when the person takes the action.** For example, use "Delete" instead of "Remove" for when the action will delete a file. Note: Currently, icon and button labels are hard-coded into the component. You must follow the [instructions to request any new icons or label](#requesting-new-instances).
6565

6666
### Button labels
6767

src/_content-style-guide/capitalization.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,25 @@ Use sentence case capitalization for most content, including page titles, headin
1313

1414
### Exceptions where we use title capitalization
1515

16-
- Proper nouns (example: branded terms like "VA.gov," official program names, state names, names of federal agencies, days of the week and months, compositions such as titles of books, etc.)
17-
- The word “Veterans”
18-
- Global navigation, top menu labels (VA Benefits and Health Care; About VA; Find a VA Location)
16+
- Proper nouns (such as branded terms like "VA.gov," official program names, state names, names of federal agencies, days of the week and months, and titles of books)
17+
- The word “Veteran” or "Veterans"
18+
- Global navigation and top menu labels (such as VA Benefits and Health Care, About VA, and Find a VA Location)
1919
- For mobile app native actions, use title case for iOS and all caps for Android
2020

21+
### Exceptions where we use all caps
22+
23+
On VA.gov web pages and components, avoid all caps for any purpose except the exceptions listed here. Longer uppercase text reduces legibility and can be harder to read for people with cognitive disabilities or low vision.
24+
25+
We permit all-caps text only for Android mobile app native actions and these specific web components:
26+
27+
- [Eyebrow]({{ site.baseurl }}/foundation/typography#eyebrow) text labels
28+
- [Button - Icon]({{ site.baseurl }}/components/button/button-icon) labels
29+
30+
Authors should still enter these labels in sentence case. The components will render them in all caps through styling.
31+
2132
### Exceptions where we use initial capitalization
22-
- SEO title tags (example: VA Prescription Refill And Tracking \| Veterans Affairs). See [Writing for SEO]({{ site.baseurl }}/content-style-guide/seo) for more information.
33+
34+
- SEO title tags (example: VA Prescription Refill And Tracking | Veterans Affairs). Refer to [Writing for SEO]({{ site.baseurl }}/content-style-guide/seo) for more information.
2335

2436
<div class="do-dont">
2537
<div class="do-dont__do">

src/_foundation/typography.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ Do not use monospace fonts for phone numbers, zip codes, dates, or other data th
238238

239239
{% include snippet.html content='html/eyebrow-card.html' %}
240240

241-
The eyebrow sits above a heading and provides a label for a sequence of pages in a process or for groups of related content, such as multiple cards.
241+
The eyebrow sits above a heading and provides a label for a sequence of pages in a process or for groups of related content, such as multiple cards. The eyebrow component renders its text in uppercase through styling. Authors should still always enter label text in sentence case, not in ALL CAPS. Refer to [Capitalization]({{ site.baseurl }}/content-style-guide/capitalization) for guidance on when we permit all caps.
242242

243243
### When to use
244244
- Use the eyebrow when you implement the [Help users to complete a sub task]({{ site.baseurl }}/patterns/help-users-to/complete-a-sub-task) pattern.

0 commit comments

Comments
 (0)