Help Conventions

In this documentation, reader alert and style conventions are used to bring your attention to specific information or help you identify information.

Reader Alert Conventions

Reader alerts are used throughout this documentation to notify you of both supplementary and essential information. The following table explains the meaning of each alert.

Reader Alert Conventions
Image	Alert Name	Description
	Best Practices	Best Practices alerts instruct you on the best way to accomplish a task.
	Caution	Cautions indicate that this information is critical to the success of the desired feature or product functionality.
	Edition-Specific Note	Edition-specific notes indicate that the information applies to a specific edition of a product (such as Professional or Premier edition).
	Important Note	Important notes are used for information that is essential for users to read.
	Note	Notes are used to draw attention to pieces of information that should stand out.
	Project-Specific Note	Project-specific notes are used to highlight information that may vary depending on the project type used (such as a Basic MSI or Merge Module project).
	Security	Security alerts identify security issues.
	Task	The Task graphic indicates that procedural instructions follow.
	Tip	Tips are used to indicate helpful information that could assist you in better using the desired function or feature.
	Version-Specific Note	Version-specific notes indicate that the information applies to a specific version of a product (such as Version 9.0 or Version 11.0).
	Windows Logo Guideline	Windows Logo Guideline alerts accompany Microsoft logo compliance requirements and recommendations.

Style Conventions

Style Conventions
Style	Example	Description
User Interface Elements	On the File menu, click Open.	User interface elements appear in bold when referenced in tasks.
Variables	fileName	Variables appear in italics.
Code	#define HWND_BROADCAST 0xffff	Code snippets appear in a monospace typeface.
User Inputted Text	Type $D(install).	Text that is to be entered as a literal value is displayed in a monospace typeface, in bold, and in blue.
File Name and Directory Paths	My files are located in the C:\MyDocuments\SampleCode directory.	File names and directory paths are presented in a monospace typeface.
.INI File Text	Insert the line LimitedUI=Y into the file to display only the Welcome dialog box when the Windows Installer package is run.	Text in .INI files is presented in a monospace typeface.
Command-Line Statements	To run the installation silently, enter: Setup.exe /s /v/qn	Command-line statements and parameters are presented in a monospace typeface.
Environment Variables	Set the value of the windir environment variable to your	Environment variables are presented in a monospace typeface.
Examples	Create two groups, one called Admins and the other called General.	Examples are presented in bold.
Functions	FeatureAddItem adds a new feature to a script-created feature set.	Functions are presented in bold.
Properties	In the Name property, enter a name for this custom control that is unique among all of the controls in your project.	Properties are presented in bold.
Screen Output	If you type an incorrect parameter, the message The system cannot find the path specified. is displayed.	Screen output (from a log file or from the console) is displayed in a monospace typeface, and in blue.