<page xmlns="http://projectmallard.org/1.0/"
      xmlns:its="http://www.w3.org/2005/11/its"
      type="topic"
      id="writing-style">

  <info>
    <revision pkgversion="3.15" date="2015-01-14" status="review"/>

    <credit type="author">
      <name>Allan Day</name>
      <email its:translate="no">aday@gnome.org</email>
    </credit>
    <credit>
      <name>Calum Benson</name>
    </credit>
    <credit>
      <name>Adam Elman</name>
    </credit>
    <credit>
      <name>Seth Nickell</name>
    </credit>
    <credit>
      <name>Colin Robertson</name>
    </credit>
    <credit type="editor">
      <name>Ekaterina Gerasimova</name>
      <email its:translate="no">kittykat3756@gmail.com</email>
      <years>2015</years>
    </credit>

    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>

    <desc>Writing text for your user interface, including capitalization rules.</desc>    

  </info>

<title>Writing style</title>

<p>Text plays an important role in user interfaces. Take the time to ensure that any text you use is clearly written and easy to understand.</p>

<section id="guidelines">
<title>Guidelines</title>

<p>Your main goal should be to ensure that text is easy to understand and quick to read.</p>

<list>
<item><p>Keep text short and to the point. This improves speed of comprehension for the user. It also reduces the expansion of text when translated (remember that translated English text can expand up to 30% in some languages).</p></item>
<item><p>Do not shorten your text to the point of losing meaning. A three-word label that provides clear information is better than a one-word label that is ambiguous or vague. Try to find the fewest possible words to satisfactorily convey the meaning of your label.</p></item>
<item><p>Use words, phrases, and concepts that are familiar to the people who will be using your application, rather than terms from the underlying system. This may mean using terms that are associated with the tasks your application supports. For example, in medicine, the paper folder that contains patient information is called a “chart”. Hence, a medical application might refer to a patient record as a “chart” rather than as a “patient database record”.</p></item>
<item><p>Text should adopt a neutral tone and speak from the point of view of the product. Pronouns like “you” or "my” should therefore be avoided wherever possible. However, if they are unavoidable “your” is preferable to “my”.</p></item>
<item><p>Use the standard GNOME terms when referring to parts of the user interface, such as “pointer” and “window”. The HIG can be used as a reference in this regard.</p></item>
<item><p>Avoid repetition where possible.</p></item>
<item><p>Sentences should not be constructed from text in several controls, and each label should be treated as being self-contained. Sentences that run from one control to another will often not make sense when translated into other languages.</p></item>
<item><p>Latin abbreviations such as “ie” or “eg” should be avoided, since they can't always be easily translated and can be unintelligable when read by screen readers. Instead, use full words like “for example”.</p></item>
</list>

</section>

<section id="capitalization">
<title>Capitalization</title>

<p>Two styles of capitalization are used in GNOME user interfaces: header capitalization and sentence capitalization.</p>

<section id="header-capitalization">
<title>Header capitalization</title>

<p>Header capitalization should be used for any headings, including header bar headings and page, tab and menu titles. It should also be used for short control labels that do not normally form proper sentences, such as button labels, switch labels and menu items.</p>

<p>Capitalize the first letter of:</p>

<list>
<item><p>All words with four or more letters.</p></item>
<item><p>Verbs of any length, such as “Be”, “Are”, “Is”, “See” and “Add”.</p></item>
<item><p>The first and last word.</p></item>
<item><p>Hyphenated words; for example: “Self-Test” or “Post-Install”.</p></item>
</list>

<p>For example: “Create a Document”, “Find and Replace”, “Document Cannot Be Found”.</p>

</section>

<section id="sentence-capitalisation">
<title>Sentence capitalization</title>

<p>Sentence capitalization should be used for labels that form sentences or that run on to other text, including labels for check boxes, radio buttons, sliders, text entry boxes, field labels and combobox labels. It should also be used for explanatory or body text, such as in dialogs or notifications.</p>

<p>Capitalize the first letter of:</p>

<list>
<item><p>The first word.</p></item>
<item><p>Any words normally capitalized in sentences, such as proper nouns.</p></item>
</list>

<p>For example: “The document cannot be found in this location.” “Finding results for London.”</p>

</section>
</section>

<section id="ellipses">
<title>Ellipses (…)</title>

  <p>Use an ellipsis (…) at the end of a label if further input or confirmation
  is required from the user before the action can be carried out. For example,
  <gui>Save As…</gui>, <gui>Find…</gui> or <gui>Delete…</gui>.</p>

  <p>Do not add an ellipsis to labels such as <gui>Properties</gui> or
  <gui>Preferences</gui>. While these commands open windows that can
  incorporate further functionality, the label does not specify an action, and
  therefore does not need to communicate that further input or confirmation is
  required.</p>

</section>

</page>


