Document Conventions
This section explains the conventions used in HVR documentation.
| Convention | Description |
|---|---|
| bold | Indicates computer 'words' that are fixed like actions, action parameters, commands, command parameters, file names, directory paths, or SQL command in running paragraphs, such as 'grant execute permission'. |
| italics | Indicate computer words that are variable or placeholder text. For example, in a directory path such as $HVR_CONFIG/log/hubdb the word 'hubdb' is in italics indicating that it is a placeholder text and should be replaced by the actual word that is applicable to you. |
hvrsuspend -u hubdbchannel | Code examples, syntax, or commands recognized by the system are displayed in code block with mono spaced font. |
| [ ] | Square brackets indicate optional arguments/entries. There can be multiple arguments in square brackets. |
| | | The vertical line or pipe sign ( | ) separates a mutually exclusive set of options/arguments. |
Menu
Menu selection sequences are displayed in bold and each selection is divided by the '▶' sign. For example, select Tools ▶ Data ▶ Entity ▶ Organization. This means select the menu option Tools in the menu bar, then select menu option Data in the Tools menu, followed by selecting menu option Entity in the Data sub-menu and finally click on menu option Organization in the Entity sub-menu.
File or Directory Path
Many path-names are shown using Unix conventions, e.g. using a forward slash '/' as file or directory path delimiter.
For the Microsoft Windows platform this can be understood as a backward slash '\'.
Generally HVR converts between forward and backward slashes as appropriate, so the two can be used interchangeably.
Info
Indicates this is an informational text.
Note
Indicates this is a note.
Platform Specific Functionality
Oracle | Indicates functionality only supported on Oracle |
Ingres | Indicates functionality only supported on Ingres or Vectorwise |
SQL Server | Indicates functionality only supported on SQL Server |
DB2 | Indicates functionality only supported on DB2 |
Salesforce | Indicates functionality only supported on Salesforce.com |
Unix & Linux | Indicates functionality only supported on Unix and Linux |
Windows | Indicates functionality only supported on Microsoft Windows |
Available Since
Since vX.X.X | Indicates the version of HVR that the item/feature was introduced. |