| Both sides previous revision Previous revision Next revision | Previous revision |
| about:user_guide_conventions [2020/01/06 02:05] – [People] bottom border added to make page more readable lou | about:user_guide_conventions [2020/08/28 05:16] (current) – Style changes to the first general section rowena |
|---|
| ====== 1.05. Terms, definitions and conventions used in this user guide ====== | ====== 1.05. Terms, definitions and conventions used in this user guide ====== |
| |
| If you aren't familiar with using a computer, you should read this chapter, and also work through the [[tutorial:|tutorial]] in section 3. | If you aren't familiar with using a computer, you should read this chapter. We also recommend you work through the [[tutorial:|]] section of this user guide. |
| |
| ==== General terms ==== | ==== General terms ==== |
| **Menus: **Choose // New item...// from the // Item// menu (sometime also written as // Choose// // Items > New item...// means... Click on the word // Item// in the menu bar, then choose // New item...// from the menu that drops down. | **Menus:** choose //New item// from the //Item// menu (sometimes also written as choose //Item>New item//) means click on the word //Item// in the menu bar, then choose //New item// from the menu that drops down. |
| |
| **Keyboard keys: **A handful of keys on the keyboard are used extensively and are indicated in //italics// font. The most common are: //Tab//, //Shift//, //Ctrl//, //Alt//, //Enter// and //Backspace//. | **Keyboard keys:** a handful of keys on the keyboard are used extensively and are indicated in //italics//. The most common are: //Tab//, //Shift//, //Ctrl//, //Alt//, //Enter// and //Backspace//. |
| |
| **Field: **An area where you can make an entry, either text or numbers - usually a white coloured box. In many places a user can hover over an input field for a description of what is required. | **Field:** an area on the screen (usually a white box) where you can make an entry, either text or numbers. In many places, you can use your mouse to hover over a field for a description of what is required. |
| |
| **Typed data: **Anything that must be typed into a field is shown in ''monospace font''. For example: Type ''100'' and press //Enter//. | **Typed data:** anything that must be typed into a field is shown in ''monospace font''. For example: Type ''100'' and press //Enter//. |
| |
| **Checkbox: **Is a box that changes from having an "X" in it to being blank each time you click in it. To "check" a check box means to click it so that an "X" appears (if there is not one already present). Check boxes have text beside them explaining what the box is for. | **Checkbox:** a box that changes from having an "X" in it to being blank each time you click in it. To "check" a checkbox means to click it so that an "X" appears (if there is not one already present). Checkboxes have text beside them explaining what the box is for. |
| |
| **Tab & Shift: **You can generally move the "focus" (the active area) from field to field in a window by using the //Tab// key. Holding down the //Shift// key while pressing the //Tab// key will move the focus from field to field in the reverse order to normal. Note that on Windows, some buttons are "tabable"- that is, pressing the //Tab// key moves the "focus" to a button. Pressing the //Return// or //Enter// key then activates that button. | **Tab & Shift:** you can generally move from field to field in a window using the //Tab// key. Holding down the //Shift// key while pressing the //Tab// key will move from field to field in the reverse order to normal. Note that on Windows, some buttons are "tab-able". That is, pressing the //Tab// key moves the "focus" to a button. Pressing the //Return// or //Enter// key will then activate that button. |
| |
| **Highlight button: **Pressing the // Enter // key will operate the highlighted button in a window, which is usually the OK button. | **Highlight button:** pressing the //Enter// key will operate the highlighted button in a window. This is is usually the OK button. |
| |
| **Double-click: **In lists (e.g. of Names or Items), double click the left mouse button on a line to edit or view more details. | **Double-click:** in lists (e.g. of suppliers, customers or items), double-click using the left button of the mouse on a line to edit or view more details. |
| |
| **Insertion point: **Is the blinking line in a field that indicates which field is currently accepting typed input. | **Insertion point:** the blinking line in a field that indicates which field is currently accepting typed input. |
| |
| **OK button: **The OK button can be operated by pressing the //Enter// key. | **OK button:** can be operated by pressing the //Enter// key. |
| |
| **Cancel button: **The cancel button can be operated by holding down //Ctrl// key (//cmd// on Macs), and pressing the period key (full stop). | **Cancel button:** can be operated by holding down //Ctrl// key (//cmd// on Macs), and pressing the period key (full stop). |
| |
| **Path to a file (or document): ** Is a way of describing where a document is stored on your hard disk. It is written as "hard disk:folder 1: folder 2:document", which is the same as "C:\folder 1\folder 2\document". | **Path to a file (or document):** a way of describing where a document is stored on your hard disk. It is written as //hard disk:folder 1:folder 2:document//, which is the same as //C:\folder 1\folder 2\document//. |
| |
| **Modifier keys: **Windows and Macs have different// // modifier keys. We've tried to list both in the manual, but sometimes one might slip through, so | **Modifier keys:** are different for Windows and Macs. We've tried to list both in the manual, but sometimes one might slip through. |
| |
| * The Windows //Ctrl// key does the same as the //cmd// (command) key on Macs | * The Windows //Ctrl// (control) key does the same as the //cmd// (command) key on Macs |
| * The Windows //Alt// key does the same as the //opt// (option) key on Macs. | * The Windows //Alt// (alternate) key does the same as the //opt// (option) key on Macs. |
| |
| **Column headings: **Column headings can be clicked to sort the list by that column. | **Column headings:** can be clicked to sort the list by that column. |
| |
| **Negative values:** In general, there is no need to enter negative values in mSupply. Even when you are entering returned goods from customers, or returned goods to suppliers, you must enter positive values. mSupply automatically converts the invoice total to a negative amount when it is a credit to a supplier or from a customer. | **Negative values:** are generally not required in mSupply. Even when you are entering returned goods from customers, or returned goods to suppliers, you enter positive values. mSupply automatically converts the invoice total to a negative amount when it is a credit to a supplier or from a customer. |
| |
| ==== mSupply terms ==== | ==== mSupply terms ==== |
| |
| **Cash Register:** The Cash Register records incoming and outgoing cash transactions and displays a current balance. mSupply tracks all cash movements and records them here. | **Cash Register:** The Cash Register records incoming and outgoing cash transactions and displays a current balance. mSupply tracks all cash movements and records them here. |
| | ---- |
| ===Configuration=== | ===Configuration=== |
| **Visibility:** Visibility allows us to control what stores, customers, suppliers and items a user can see when logged into a specific store. | **Visibility:** Visibility allows us to control what stores, customers, suppliers and items a user can see when logged into a specific store. |
| | // Previous: **[[about:which_one_for_you|1.04. Which mSupply package best suits your organisation?]]** | | Next: **[[:setting_up_msupply|2. Setting Up mSupply: Technical Guide]]** // | | | // Previous: **[[about:which_one_for_you|1.04. Which mSupply package best suits your organisation?]]** | | Next: **[[:setting_up_msupply|2. Setting Up mSupply: Technical Guide]]** // | |
| ---- struct data ---- | ---- struct data ---- |
| | pagestatus.status : |
| ---- | ---- |
| |