# Conventions

This book is most effective when used in conjunction with the &appfull; &appversion;.

Throughout this book the Docbook XML document type will be used to explain and illustrate the functionality of the &appfull;.

Familiarity with the standard controls and Notations provided by the Window Manager and Linux File System is assumed.

The following admonitions will be found throughout the book:

A note presents interesting, sometimes technical, pieces of information related to the surrounding discussion.

A tip offers advice or an easier way of doing something.

A caution advises you of potential problems and helps you to steer clear thereof.

A warning advises you of a hazard condition that may be created in a given scenario.

Type conventions will be shown as follows:

- File names or paths to directories will be shown in `monospace` type.

- Commands that you type at a prompt will be shown in `bold` type.

- Options that you click, select or choose in the user interface will be shown in `monospace` type.

- When variables, parameters, sgmltags etc. are contained within a paragraph of text will be shown in `monospaced` type, otherwise they will use the normal type.

Menu selections, mouse actions, and keyboard short-cuts:

- A sequence of menu selections will be shown as follows: File Open

- Mouse actions shall assume a right-handed mouse configuration. The terms "click" and "double-click" refers to using the left-hand mouse button. The term "right-click" refers to using the right-hand button.

- Keyboard short-cut combinations will be shown as follows: Ctrl+N . Where the convention for "Control", "Shift", and "Alternate" keys will be Ctrl, Shift, Alt respectively and shall mean to hold down the first key while pressing the second key.

Cross reference conventions for pint will be shown as follows:

- Internal references will look like this: . The numeral contained by square braces is the [page number].

- External reference, say to a Web Site, will look like this.

PDF, HTML or XHTML versions of this document will use hyper-links to denote cross-references.

Code conventions:

- Code and mark-up samples will be formatted in a Grey block.

- Sometimes lines of code or mark-up examples will be longer than the page width. To avoid from them running off the page, the slash character "\" is used to denote a soft line break. This means that the line of code is in reality meant to be on one line, but for print formatting it has been broken into two lines. For the example below, the line starting with msgbox has been cut so that the comment will not run off the right-side of the page.

    Dim uid, Encore
    Set Encore = createobject("Encore.Utilities")
    uid = Encore.logon("ADMIN","" ,"0" ,"", "00", 0, 0,"")

    msgbox uid, , "The GUID created by login and  \
        used for all method calls"

    Set Encore = CreateObject("Encore.Query")

    Set Encore = createobject("Encore.Utilities")
    Encore.logoff(uid)
    Set Encore = Nothing