Navigation: Document Conventions >  Typographic

 

 

 

 

Document Conventions

 

Typographic

 

The typographic conventions used throughout the help documentation are explained here.

 

 

Convention

Description

External Hyperlink

External hyperlinks target URLs outside of Historion and outside of this Help Documentation

| First Name |

References to specific Historion data fields are denoted by straight brackets

[ Start Update ]

References to specific Historion buttons are denoted by square brackets

Edit Classification

References to hyperlinks appearing in the Historion software are not active links in this Help Documentation and are a different colour

Used to flag an important concept or tip. Associated text is displayed in a rectangular box, with navy font, for emphasis

A feature or setting under consideration or already being developed

Green arrows are frequently used to show the location of features, in the context of tasks at hand and Help Documentation instructions

Red boxes are used throughout the Help Documentation to emphasise a set of features or fields in the context of the help text

Green dashed rectangles are used to isolate and emphasise tabs, tab areas and groups of fields or data results listed in tables

Important

Sometimes words are shown in italics in the Help Documentation to provide emphasis relative to a key point in the help text

Data Connectors

Tabs in Historion are referred to with the tab's name (the title displayed on the tab) in Title Case

<Enter>

Specific keyboard keys to be pressed are denoted by angled brackets

Table n Name

Tables are named and numbered for clarity and to assist navigation in the PDF edition of the online help

Figure n Name

Diagrams and images of screens and features are given figure numbers and names in the PDF edition of the online help

Feature Name

Listed features of a tab in document sub sections are shown in colour (confirm this?) in the PDF edition of the online help

Wearer

References to other sections of the Help Documentation and data entities and features are made in Title Case throughout the Help Documentation. Examples include Wearer, Dose Report and Dose Reading. Words in Title Case with navy hyperlinks are further defined in the Glossary and hyperlink to their definitions.

 

 

 

Previous Next

 

 

 

Copyright© Cybermynd Information Systems Consulting Pty Ltd