Support > Using the Help > Typographic Conventions
MPLAB Harmony USB Stack
Typographic Conventions

The MPLAB Harmony Help uses the following typographic conventions:

Convention 
Represents 
Example 
TIP! 
Provides helpful information to assist the user. 
 
Note: 
Provides useful information to the user. 
 

Important! 
Provides important information to the user. 
 

Warning 
Warns the user of a potentially harmful issue. 
 
Followed by Green italicized text 
Indicates a process step that is automated by the MPLAB Harmony Configurator (MHC). 
 
Italic Characters 
Referenced documentation and emphasized text. 

  • MPLAB X IDE User's Guide
  • ...is the only option.

 

Initial Capitalization 

  • A window
  • A dialog
  • A menu selection

 

  • the Output window
  • the SaveAs dialog
  • the Enable Programmer menu

 

Quotation Marks 
A field name in a window or dialog. 
"Save project before build" 
Italic text with right angle bracket 
A menu path. 
File > Save 
Bold Characters 

  • Topic headings
  • A dialog button or user action, such as clicking an icon or selecting an option

 

  • Prerequisites
  • Click OK

 

Courier New text enclosed in angle brackets 
A key on the keyboard. 
Press <Ctrl><V>
Courier New text 

  • Sample source code
  • File names
  • File paths

 

  • #define START
  • system_config.h
  • <install-dir>/apps/examples

 

Square Brackets 
Optional arguments. 
command [options] file [options] 
Curly Braces and Pipe Character 
Choice of mutually exclusive arguments; an OR selection. 
errorlevel {0|1}