StandardTerminology

Revision 6 as of 2007-12-18 20:30:00

Clear message

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.

This list is not exhaustive; for terminology that is not listed here, refer to the [http://library.gnome.org/devel/gdp-style-guide/2.20/gnome-glossary-desktop.html.en Gnome Desktop Style Guide Term List].

TableOfContents(2)

General

How to refer to Ubuntu

  1. 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."
  2. 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.
  3. 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.
  4. Use "based on Debian GNU/Linux" when referring to Ubuntu's Debian roots.
  5. Use "Linux-based" when referring to Ubuntu's kernel roots.
  6. 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".
  7. 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.
  8. 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.

  • NOTE: the drop-down combination box is currently being discussed on the ubuntu-doc mailing list. The below information will likly be changed.
    • 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.

      Usage: Use "choose" to tell the user what to select rather than specifying whether to use the drop-down list or the text box, with the possible exception of documents where users might be unfamiliar with combo boxes, such as a document for those who have never used a computer before. Avoid the term "combo box", use "drop-down combination box" instead.

      DocBook Tags: Since a combo box usually has a label associated with it, use the guilabel tag for the combo box name.

      Example: Choose <userinput>Ubuntu</userinput> from the <guilabel>Operating System</guilabel> drop-down combination box.

command button

  • Description: The classic button. You press it to start an action.

    Usage: Many users may be more familiar with the term "button" than "command button." Additionally, you "click on" a button rather than "press" a button.

    DocBook Tags: Use the guibutton tag for the text on the button.

    Example: Click on the <guibutton>OK</guibutton> button.

control

  • Description: A control is any user interface element, such as a button, tab or drop-down box.

    DocBook Tags: none

    Example: This option affects the color of all controls.

  • Description: A list of possible selections. One clicks on the drop-down button to the right of the current selection to see all possible options.

    DocBook Tags: Use the guilabel tag for the label of the drop-down list.

    Example: Use the <guilabel>size</guilabel> drop-down list to specify the size of your image.

  • Description: A dialog element that, when you click on the associated text, displays more dialog elements.

    DocBook Tags: Use the guilabel tag for the text associated with this element.

    Example: Select the filetype from the <guilabel>filetype</guilabel> drop-down list or click on the <guilabel>Filetypes by extension</guilabel> to select a filetype based on its file extension.

ellipsis button

  • Description: A button with an ellipsis (...) on it, usually used to select a file.

    DocBook Tags: Use <guibutton>...</guibutton>.

    Example: Type the path to the file in the <guilabel>Icon</guilabel> text box, or click the <guibutton>...</guibutton> button to find a file.

group box

  • Description: A box that groups elements of a dialog together. Often used in configuration dialogs.

    Usage: In large dialogs with many options, are if the user might not know where to find an option, specify which group the option is in if the dialog is broken up into groups. Avoid "group box," simply use "group" instead.

    DocBook Tags: Use the guilabel tag for the label of the group box.

    Example: Choose "emacs" from the <guilabel>external text editor</guilabel> drop-down box in the <guilabel>text editing</guilabel> group.

launcher

  • Description: A GUI element that executes a command or starts a command when clicked. In the GNOME and KDE desktops, launchers appear as icons on the desktop and panels. They also appear as menu items on may menus, including the main menus.

    DocBook Tags: none

    Example: To add this launcher, click on the <guibutton>Add</guibutton> button.

list box

  • Description: A multi-line text box with static content from which a user can select one or more of several items. The selected item(s) are highlighted. A user can select multiple items with the shift key.

    Usage: Ask a user to select an item, not highlight an item.

    DocBook Tags: Use the guilabel tag for the name of the list box.

    Example: Select your screen resolution from the <guilabel>resolution</guilabel>

  • Description: The bar at the top of an application that has several menus with various commands.

    Usage: Use "menubar" (one word) rather than "menu bar".

    DocBook Tags: Use no tags for a menubar, but use the guimenu tag for the name of a menu.

    Example: Select <guimenuitem>Save As</guimenuitem> from the <guimenu>File</guimenu> menu of the menubar.

  • Description: An item of a menu.

    DocBook Tags: use the guimenuitem tag.

    Example: Select the <guimenuitem>About</guimenuitem> item from the <guimenu>Help</guimenu> menu.

option

  • Description: A parameter than can be on or off, usually represented by a check box.

    Usage: You "select" an option.

    DocBook Tags: Use the guilabel tag for the name of the option.

    Example: Select the <guilabel>Open in new window</guilabel> option if you want the image to open in a new window.

  • 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

  • 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.


CategoryDocteam