Difference between revisions of "Guidelines on capitalization in Audacity dialogs and messages"

From Audacity Wiki
Jump to: navigation, search
(Use sentence caps for:: what we don't have)
(Sentence Caps: we don't observe this for out filenames used for releases either)
Line 58: Line 58:
 
*Group box labels
 
*Group box labels
 
*Alternate text (ALT text) used to describe images
 
*Alternate text (ALT text) used to describe images
 
+
{{note|'''Peter 11Jun16:''' In Audacity I don't think we have Group boxes or ALT text to describe images.  Note that we curruntly do not observe these Microsoft guidelines in regard to the filenames that we generate in Audacity for things like configuation files or AutoSave filenames - nor in our files for Audacity releases - so maybe we should omit the File names entry. }}
{note|'''Peter 11Jun16:''' In Audacity I don't think we have Group boxes or ALT text to describe images.  Note that we curruntly do not observe  
 
these Microsoft guidelins in regard to the filenames that we generate in Audacity for things like configuation files or AutoSave filenames - so maybe we should omit the File names entry. }}
 
  
 
===Examples===
 
===Examples===
Line 68: Line 66:
  
 
<div id="reference"></div>
 
<div id="reference"></div>
 +
 
==Quick Reference==
 
==Quick Reference==
 
This at-a-glance reference demonstrates when and where to capitalize in the UI.
 
This at-a-glance reference demonstrates when and where to capitalize in the UI.

Revision as of 13:28, 11 June 2016

Peter 10Jun16: This page is a set of draft guidelines for when and where to use capitalization in the Audacity GUI.

The initial guidelines are taken from the Microsoft guidelines - we can all comment here on what if anything we want to change.

I'm deliberately using note divs rather than ednote divs as some non-editors may well be reading and wanting to comment on the content of this page - and they should be able to see all the notes.
Work in Progress...


Correct capitalization helps readers identify important words and breaks in text. Two styles of capitalization appear in user interfaces:
  • title caps (also referred to as book title capitalization) and
  • sentence caps (also known as sentence-style capitalization).
There is a Quick Reference image to illustrate the guidelines.

Title Caps

Peter 10Jun16: Vaughan wrote in a related email thread: "Fwiw, I was schooled in Apple's HIG, where every dialog heading is considered more or less like a book chapter title, so all nouns and verbs capitalized."

Capitalize the first letter of the first and last words. Capitalize the first letter of all words in between, with the exception of articles (a, an, and the); coordinating conjunctions (and, but, for, nor, or, so, and yet); and prepositions of four letters or fewer (at, for, with, into, etc.).

Use title caps for:

  • Button names
  • Column headings
  • Command button labels
  • Floating toolbars
  • Icon labels
  • Menu names and menu commands
  • Palette titles
  • Tab titles
  • Title bar text
  • Toolbars and toolbar button labels
  • ToolTips
  • Web and Web-like page titles
  • Web and Web-like navigational elements (unless prohibited by the page design)
Peter 11Jun16: from this list I don't think that in Audacity we have: Palette titles, Tabs or Tab titles - we may get Palette stuff later if and when we reintroduce theming or color choices for track name display on the waveform. We do have a few web/web-like things in Audacity but these are links to our Manual and our Website.

Examples

  • Insert Object
  • Go To
  • Always on Top
  • By Name

Sentence Caps

Capitalize only the first letter of the first word, and capitalize only those other words that are normally capitalized in sentences, such as proper nouns.

Use sentence caps for:

  • Check box labels
  • Text box labels
  • Option (radio) button labels
  • InfoTips (hovertext tool-tips)
  • Status bar tips and messages
  • Messages
  • Dialog box introductory or explanatory text
  • List box entries
  • List box labels

  • File names
  • Group box labels
  • Alternate text (ALT text) used to describe images
Peter 11Jun16: In Audacity I don't think we have Group boxes or ALT text to describe images. Note that we curruntly do not observe these Microsoft guidelines in regard to the filenames that we generate in Audacity for things like configuation files or AutoSave filenames - nor in our files for Audacity releases - so maybe we should omit the File names entry.

Examples

  • Working folder
  • Print to
  • Use PostScript driver

Quick Reference

This at-a-glance reference demonstrates when and where to capitalize in the UI.

Capitalization guidelines.gif


See also

Graphical User Interface Design Notes by Carl Andersen