#title Standard Terminology ||<>|| This section provides a list of terms that are commonly found in technical documentation. You should use the spellings of words as documented 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]]. <> == 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." 1. 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. 1. You can use "Kubuntu", "Kubuntu system", "Kubuntu environment", and "Kubuntu distribution" when referring to Ubuntu with the KDE desktop environment. Note that it is still the Ubuntu operating system, not the Kubuntu operating system. 1. Use "based on Debian GNU/Linux" when referring to Ubuntu's Debian roots. 1. Use "Linux-based" when referring to Ubuntu's kernel roots. 1. You might find that you must use the term "Ubuntu Linux". If so, consider using the phrase "based on Debian GNU/Linux". 1. If you use any of the following terms, you must explain them in the text following their first use, as well as in the glossary (if there is a glossary). 1. Debian 1. GNU/Linux 1. Linux 1. distribution 1. distro The only exception is when the audience of the document is already familiar about the terms. 1. If there is an About Ubuntu section in your document, 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 such as "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. * '''Doc''''''Book Tags:''' Since a check box usually has a label associated with it, use the {{{}}} tags for the check box name. * '''Example:''' Select the Case sensitive option. === drop-down combination box === '''NOTE:''' The drop-down combination box is currently being discussed on the ubuntu-doc mailing list. The information below will likely 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. A possible exception is in 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. * '''Doc''''''Book Tags:''' Since a combo box usually has a label associated with it, use the {{{}}} tags for the combo box name. * '''Example:''' Choose Ubuntu from the Operating System 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. * '''Doc''''''Book Tags:''' Use the {{{}}} tags for the text on the button. * '''Example:''' Click on the OK button. === control === * '''Description:''' A control is any user interface element, such as a button, tab, or drop-down box. * '''Doc''''''Book Tags:''' None. * '''Example:''' This option affects the color of all controls. === drop-down list === * '''Description:''' A list of possible selections. You click on the drop-down button to the right of the current selection to see all possible options. * '''Doc''''''Book Tags:''' Use the {{{}}} tags for the label of the drop-down list. * '''Example:''' Use the size drop-down list to specify the size of your image. === drop-down section === * '''Description:''' A dialog element that, when you click on the associated text, displays more dialog elements. * '''Doc''''''Book Tags:''' Use the {{{}}} tags for the text associated with this element. * '''Example:''' Select the filetype from the filetype drop-down list or click on the Filetypes by extension 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. * '''Doc''''''Book Tags:''' Use the {{{...}}} tags for the text associated with this element. * '''Example:''' Type the path to the file in the Icon text box or click the ... 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. 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" and instead use "group." * '''Doc''''''Book Tags:''' Use the {{{}}} tags for the label of the group box. * '''Example:''' Choose "emacs" from the external text editor drop-down box in the text editing 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 menus, including the main menus. * '''Doc''''''Book Tags:''' None. * '''Example:''' To add this launcher, click on the Add 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. * '''Doc''''''Book Tags:''' Use the {{{}}} tags for the name of the list box. * '''Example:''' Select your screen resolution from the resolution. === menubar === * '''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." * '''Doc''''''Book Tags:''' Use no tags for a menubar, but use the {{{}}} tags for the name of a menu. * '''Example:''' Select Save As from the File menu of the menubar. === menu item === * '''Description:''' An item of a menu. * '''Doc''''''Book Tags:''' Use the {{{}}} tags. * '''Example:''' Select the About item from the Help menu. === option === * '''Description:''' A parameter that can be on or off, usually represented by a check box. * '''Usage:''' You "select" an option. * '''Doc''''''Book Tags:''' Use the {{{}}} tags for the name of the option. * '''Example:''' Select the Open in new window option if you want the image to open in a new window. === popup menu === * '''Description:''' A menu that appears when you right-click or middle-click something. Also known as a context menu. * '''Usage:''' Use the term "popup menu", not "context menu" or "pop-up menu." * '''Doc''''''Book Tags:''' None. * '''Example:''' Right-click a word to display a popup menu. === radio button === * '''Description:''' A selectable control, usually round, that is linked to other radio buttons. Only one radio button of a connected set may be selected at a time. * '''Doc''''''Book Tags:''' Use the {{{}}} tag for the label of the radio button. * '''Example:''' Select the do not show option. === scrollbar === * '''Description:''' A bar, usually on the right side of a control, that, when dragged, scrolls through the content of the control. Widely used for controls that display a lot of content, such as a web browser, text editor, or email client. Buttons are usually present at the top and bottom of the scrollbar as an alternative to dragging the scrollbar. * '''Usage:''' Use "scrollbar," not "scroll-bar" or "scroll bar." * '''Doc''''''Book Tags:''' None. * '''Example:''' Use the scrollbar to scroll through available commands. === slider === * '''Description:''' A bar with an icon that can be dragged to select one of a range of things, such as text size. Almost exclusively used to select a volume. * '''Doc''''''Book Tags:''' Use the {{{}}} tags for the name of the scrollbar. * '''Example:''' If you do not hear any sound, use the volume slider to specify a louder volume. === spin box === * '''Description:''' A text box with arrow buttons on the right side that can be used to select one of a range of options. The user may type into the spin box or use the arrow buttons to scroll through available options. Often used for numeric inputs. * '''Doc''''''Book Tags:''' Use the {{{}}} tags for the name of the spin box. * '''Example:''' Use the font size spin box to specify the font size. === statusbar === * '''Description:''' description text here. * '''Doc''''''Book Tags:''' the docbook tag to use for this item * '''Example:''' an example of the term in use === submenu === * '''Description:''' description text here. * '''Doc''''''Book Tags:''' the docbook tag to use for this item * '''Example:''' an example of the term in use === tab === * '''Description:''' description text here. * '''Doc''''''Book Tags:''' the docbook tag to use for this item * '''Example:''' an example of the term in use === tabbed section === * '''Description:''' description text here. * '''Doc''''''Book Tags:''' the docbook tag to use for this item * '''Example:''' an example of the term in use === terminal === * '''Description:''' description text here. * '''Doc''''''Book Tags:''' the docbook tag to use for this item * '''Example:''' an example of the term in use === text box === * '''Description:''' description text here. * '''Doc''''''Book Tags:''' the docbook tag to use for this item * '''Example:''' an example of the term in use === titlebar === * '''Description:''' description text here. * '''Doc''''''Book Tags:''' the docbook tag to use for this item * '''Example:''' an example of the term in use === toolbar button === * '''Description:''' description text here. * '''Doc''''''Book Tags:''' the docbook tag to use for this item * '''Example:''' an example of the term in use === username === * '''Description:''' description text here. * '''Doc''''''Book Tags:''' the docbook tag to use for this item * '''Example:''' an example of the term in use === wallpaper === * '''Description:''' description text here. * '''Doc''''''Book Tags:''' the docbook tag to use for this item * '''Example:''' an example of the term in use === workspace === * '''Description:''' description text here. * '''Doc''''''Book Tags:''' the docbook tag to use for this item * '''Example:''' an example of the term in use == User Actions == === Select vs Highlight vs Choose === Select an item from a list. Choose an item from a menu. To choose a menu item, click on it. Do not use "highlight" as a verb. Use it as a noun or adjective. The selected text is highlighted. === Deselect vs Unselect === Deselect an option. An option that is not selected is unselected. === Back Up vs Backup === Back up a file. A file that can be used to restore a lost file is a backup. ---- CategoryDocteam