StandardTerminology
|
Size: 8579
Comment: Import GUI section from DocBook version of Style Guide
|
Size: 8579
Comment: sue -> use (in check box usage)
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 27: | Line 27: |
| ''Usage:'' The phrase "check box" is seldom used in text. It is more common to use words like select, deselect, and choose, depending on the user action being described. If there is any ending punctuation (such as a period, colon, or ellipsis) on the label associated with the check box, do not sue the punctuation in your text. | ''Usage:'' The phrase "check box" is seldom used in text. It is more common to use words like select, deselect, and choose, depending on the user action being described. If there is any ending punctuation (such as a period, colon, or ellipsis) on the label associated with the check box, do not use the punctuation in your text. |
This section provides a list of terms which are commonly found in technical documentation. You should use the spellings of words which are set-out in this section whenever you use those words in Ubuntu documentation.
General
How to refer to Ubuntu
- Use "Ubuntu operating system" the first time you refer to Ubuntu, then use "Ubuntu" thereafter. You can use the terms "Ubuntu system" and "Ubuntu environment" when they are more appropriate than "Ubuntu operating system."
- You can use "Ubuntu Linux distribution" or "Ubuntu Linux distro," but try to reserve those terms for audiences who do not need to have "distribution" or "distro" explained to them.
- You can use Kubuntu, Kubuntu system, Kubuntu environment, and Kubuntu distribution when referring to Ubuntu with the KDE desktop, but remember that it is still the Ubuntu operating system, not the Kubuntu operating system.
- Use "based on Debian GNU/Linux" when referring to Ubuntu's Debian roots.
- Use "Linux-based" when referring to Ubuntu's kernel roots.
- You might find that you must use the term "Ubuntu Linux". If so, then try to work in the phrase "based on Debian GNU/Linux".
- If you use any of these terms, (Debian, GNU/Linux, Linux, distribution, distro) you must explain them in the text following their first use, as well as in the glossary (if there is a glossary). The only exception is when the audience of the document is already knowledgeable about the terms.
- If there is an About Ubuntu section in your document, then describe Ubuntu and its genealogy, including GNU/Linux, Debian, and the Linux kernel.
GUI Terms
check box
Description: An on/off element used for selecting and deselecting an option. Usually signified by a check mark, but sometimes by an "X"
Usage: The phrase "check box" is seldom used in text. It is more common to use words like select, deselect, and choose, depending on the user action being described. If there is any ending punctuation (such as a period, colon, or ellipsis) on the label associated with the check box, do not use the punctuation in your text.
DocBook Tags: Since a check box usually has a label associated with it, use the guilabel tag for the check box name.
Example: Select the <guilabel>Case sensitive</guilabel> option.
combo box
Description: The combo box is the combination of a text box and a drop-down list. The list is activated by clicking the arrow to the right of the text box. You can either type into the text box, or select an item from the list.
DocBook Tags: Since a combo box usually has a label associated with it, use the guilabel tag for the combo box name.
Usage: usage notes go here
Example: an example of the term in use
command button
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
control
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
drop-down list
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
drop-down section
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
ellipsis button
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
group box
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
group box
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
launcher
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
list box
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
menubar
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
menu item
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
option
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
popup menu
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
radio button
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
scrollbar
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
slider
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
spin box
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
statusbar
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
submenu
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
tab
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
tabbed section
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
terminal
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
text box
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
titlebar
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
toolbar button
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
username
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
wallpaper
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
workspace
Description: description text here.
DocBook Tags: the docbook tag to use for this item
Example: an example of the term in use
User Actions
Random notes: Select vs highlight vs choose. Select an item from a list, choose an item from a menu. To choose an menu item, click on it.
Do not use highlight as a verb; use as a noun or adjective. The selected text is highlighted.
DocumentationTeam/StyleGuide/StandardTerminology (last edited 2010-03-24 10:26:35 by c220-237-150-52)