1.1 Conventions Used in This Guide

The following conventions may appear in this documentation. In most cases, formatting conforms to the OASIS Darwin Information Typing Architecture (DITA) Version 1.3 Part 3: All-Inclusive Edition, 19 June 2018.

Table 1-1. Documentation Conventions
Description Implementation Examples
References DITA: cite MPLAB® X IDE User’s Guide.
Emphasized text Italics ...is the only compiler...
A window, window pane or dialog name. DITA: wintitle the Output window.

the New Watch dialog.
A field name in a window or dialog. DITA: uicontrol Select the Optimizations option category.
A menu name or item. DITA: uicontrol Select the File menu and then Save.
A menu path. DITA: menucascade, uicontrol File > Save
A tab DITA: uicontrol Click the Power tab.
A software button. DITA: uicontrol Click the OK button.
A key on the keyboard. DITA: uicontrol Press the F1 key.
File names and paths. DITA: filepath C:\Users\User1\Projects
Source code: inline. DITA: codeph Remember to #define START at the beginning of your code.
Source code: block. DITA: codeblock An example is:
#include <xc.h>
main(void) {
  while(1);
}
User-entered data. DITA: userinput Type in a device name, for example PIC18F47Q10.
Keywords DITA: codeph static, auto, extern
Command-line options. DITA: codeph -Opa+, -Opa-
Bit values DITA: codeph 0, 1
Constants DITA: codeph 0xFF, 'A'
A variable argument. DITA: codeph + option file.o, where file can be any valid file name.
Optional arguments Square brackets [ ] xc8 [options] files
Choice of mutually exclusive arguments; an OR selection. Curly brackets and pipe 
character: { | } errorlevel {0|1}
Replaces repeated text. Ellipses... var_name [, var_name...]
Represents code supplied by user. Ellipses... void main (void)

{ ...

}
A number in verilog format, where N is the total number of digits, R is the radix and n is a digit. N‘Rnnnn 4‘b0010, 2‘hF1
Device Dependent insignia. Specifies that a feature is not supported on all devices. Devices supported will be listed in the title or text. [DD] xmemory attribute