Aim ARINC 429 - Conventions Used; General Documentation Conventions

Software Library Reference Manual for VME 429 3
Section 1 - Introduction
1.3 Conventions Used
1.3.1 General Documentation Conventions
We use a number of different styles of text and layout in this document to help
differentiate between the different kinds of information. Here are some examples of
the styles we use and an explanation of what they mean:
Italics - used as a placeholder for the actual name, filename, or version of the
software in use
Bold text - a function, or parameter, or used to highlight important information
Bold italics - caution, warning or note
Font - font used to show paths, directories and filenames within the body of text will
be shown in blue, for example:
C:\Windows\System32\Drivers\Aim_mil.sys
A smaller version of this font will be used to list
software code.
In addition to text and layout convention, there are a couple of naming conventions
used to simplify the information herein. The AMC429 and AVI429 interface modules
utilize the same s/w library functions, also called the Application Program Interface
(API). Therefore, for ease of documentation flow, this s/w library will be referred to
from this point on as the API S/W Library. In addition, the software and firmware
contained on the AIM bus interface 429 device will be referred to as the Target S/W.
Several references will be made within the API S/W Library function description to
the Application Interface. The Application Interface is the software interface
between the API S/W Library function calls and the Target S/W.