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
DescriptionImplementationExamples
ReferencesDITA: citeMPLAB® XC32 C/C++ Compiler User’s Guide for PIC32C/SAM MCUs.
Emphasized textItalics...is the only compiler...
A window, window pane or dialog name.DITA: wintitlethe Output window.

the New Watch dialog.

A field name in a window or dialog.DITA: uicontrolSelect the Optimizations option category.
A menu name or item.DITA: uicontrolSelect the File menu and then Save.
A menu path.DITA: menucascade, uicontrolFile > Save
A tabDITA: uicontrolClick the Power tab.
A software button.DITA: uicontrolClick the OK button.
A key on the keyboard.DITA: uicontrolPress the F1 key.
File names and paths.DITA: filepathC:/Users/User1/Projects
Source code: inline.DITA: codephRemember to #define START at the beginning of your code.
Source code: block.DITA: codeblockAn example is:
#include <xc.h>
main(void) {
  while(1);
}
User-entered data.DITA: userinputType in a device name, for example PIC18F47Q10.
KeywordsDITA: codephstatic, auto, extern
Command-line options.DITA: codeph-Opa+, -Opa-
Bit valuesDITA: codeph0, 1
ConstantsDITA: codeph0xFF, 'A'
A variable argument.DITA: codeph + optionfile.o, where file can be any valid file name.
Optional argumentsSquare 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‘Rnnnn4‘b0010, 2‘hF1
Device Dependent insignia. Specifies that a feature is not supported on all devices. Please see your device data sheet for details.[DD]Assembler Special Operators