MetaMiner technical publications follow a number of conventions.
This documentation observes the following text formatting and typographic conventions:
• | The names of buttons, dialog windows, forms, and other GUI elements are written in bold, for example: CMS Explorer, |
• | The special terms are written in Italics, for example: BO landscape, |
• | Items selected on menus are written in bold and separated by a hyphen, for example: File - Preferences..., |
• | Bulleted (unordered) lists contain items that can be read or executed in any order, |
• | Numbered (ordered) lists contain steps that must be performed in the exact sequence, otherwise the results can be unpredictable, |
• | Code samples (written using SQL, script languages, and so on) are formatted like this: |
SELECT lastname, firstname
FROM my.customer
You will find the following types of notes throughout this documentation:
Tip
A tip provides additional information on a topic or asks for particular attention to it.
Warning
A warning describes a very important concept that, if not followed carefully, could result in unwanted or incomplete results.
Use Case
A scenario or use case used to describe a capability provided by the MetaMiner.
There are many illustrations inserted in MetaMiner documentation to help you understand how user interface (UI) looks and works. There are screen-shots of MetaMiner windows and diagrams that visualize business processes.
Important areas or UI controls are highlighted with red text, arrows, or boxes, for example:
To annotate different areas of complex UI elements and/or diagrams, red numbers of this circle design: are used, for example:
There is a corresponding circle that will be found in complementary text that further describes the item or concept.