Documentation Formatting Note

Text and Code Formatting Conventions

To highlight terms and concepts that have special relevance, this documentation implements several formatting conventions to make key words and terms more noticeable.

• Control Label: This format will identify the text labels or properties for Process Director objects, or the names of dialog boxes.
  Example: The Name text box.
• UI Element: This format will identify user interface elements such as buttons, tabs, or other UI objects used to perform interface operations.
  Example: The Submit button.
• Formal Control Name: This format will identify named Process Director controls.
  Example: A Section End control.
• Process Director Object: This format will identify named instances of Process Director Folders, Forms, Process Timelines, Knowledge Views, etc.
  Example: The Travel Expense Approval Process Timeline.
• Key Terms: This format will identify key terms and concepts introduced into the text of the document, and which are important to learn.
  Example: A Case is group of processes, transactions, or responses that define a complex activity.
• Code: This format will identify code samples, system variables, formulas, or other fixed programmatic syntax.
  Example: Type the following formula: AirFare + Lodging.
• Code Option: A section of a code sample to denote placeholder values that must be replaced by the user manually at design time.
  Example: {CURR_USER, format=FormatType}
• Code Comment: A section of a code sample that is used for text comments, rather than runnable code.
  Example: // This is a comment.
• Code Variable: A programming object whose value is usually determined from a command written in code.
  Example: var formControls = BaseCurrentForm.FormControls;

In addition to the above, extended samples of program code are presented in a special format to set them off from the rest of the text, as demonstrated below:

// Called after database initialized
public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // Before we make SDK calls that access the database,
    // ensure DB has been opened
    if (bp.DBOpenComplete)
    {
        // Place custom code here
    }
}

Important text or warnings are presented in a special callout box for special attention:

This is an Important item.

Notes of general interest are also presented in special callout boxes:

This is a note.

Hopefully, the use of these formatting conventions will make it easier for you to determine the various types of objects to which the text refers.

Icons

Some universal icons are used in the documentation. They are listed below:

ICON	NAME	DESCRIPTION
	Link	A hyperlink to the specific URL and named anchor of a topic, heading, or other item.
	Dropdown Closed	An icon that, when clicked, will expand dropdown text in a topic.
	Dropdown Open	An icon that, when clicked, will close the expanded dropdown text in a topic.

Finally, some topic headers within each online document may display a link symbol (#) when you mouse over the header. Clicking the link will navigate to that specific section of the document, which can then be bookmarked in your browser.

Other Conventions

URLs displayed in sample will, unless used for commands or URLs used on the local host machine, use the "HTTPS" prefix by default, as modern practice has evolved to use the encryption layer to access URLs, instead of the plain-text method (HTTP) of accessing URLs.