Developer Documentation Conventions

This manual uses specific text conventions and terminology.

Text Conventions

Lawson manuals use the following standard text conventions.

This Represents
bold

A key name or a function key name. For example, Shift is a key name and Help (F1) is a function key name.

A value or command that you must type exactly as it appears.

A program name or a file name.

italics

A manual title or form name.

An emphasized word or phrase.

A placeholder for a user-defined value or variable. Follow the capitalization pattern of the placeholder. For example, "Type $LAWDIR/print/username/jobname/stepnumber/formID.prt instructs you to type the user name, job name, step number, and form ID as follows: $LAWDIR/print/jane/emplist/1/GL100.prt

(F1)–(F24) A function key number. "Press Help (F1)" " the key mapped for the (F1) function.
Key1+Key2 A key combination. "Press Shift+FndNxt (F3)" " and hold down the Shift key and then press the FndNxt (F3) function key. Release both keys to complete the action.
[ ]

Optional parameters. You can type none, one, or more of the parameters within the brackets. For example, the command

qsubmit [-Un] [-j JobQueue -d Date - t Time] username jobname

means that you can type a specific job queue, date, or time, or you can omit these parameters.

[ | ]

Optional parameters. You can type only one of the parameters separated by a vertical line. For example, the command

phraserpt[-n|t] BaseLanguage [Translation]

means that you can type either the n or t parameter; you cannot type both.

...

A parameter that can be repeated. For example, the command

scrgen [-scxvV] productline [systemcode [programcode...]]

means that you can type any number of program codes.

Terminology

The following terms have precise meanings in Lawson documentation.

Term Meaning
access Open a Lawson application form or subform.
choose

Start a process.

"Choose Add" instructs you to click a button or a link on a form to add a record to the Lawson system.

click

Place the cursor over an object (such as a button, link, or tab) and press the left mouse button.

Note: This description applies to a standard PC mouse with standard settings. You must translate the meaning of "click" to what is appropriate for your equipment.
define

Use a Lawson form to create a new record for a company, a vendor, a class, a code, or another entity used throughout the Lawson system.

- or -

Specify configuration parameters, printers, security roles, data areas, and so on.

run Send data for processing. For example, run a report or batch job.
select

Identify an item to process. Selecting an item does not start a process.

To select an item, place the cursor over an item and then click.

If you use character-based mode, highlight an item to select it. Sometimes, you must also press Mark or Next or choose OK.

type

Press keyboard keys to enter information in a field, then move the cursor to the next field.

At a command line, type the letters exactly as written in the procedure, then choose OK.

OK

Choose OK to save or process the data that you entered on the current form.

  • "Choose OK" instructs you to click a button or a link on a form. An "OK" button might be labeled "Update" or show a check mark. An "OK" link might be labeled "OK.""Choose OK" " the keyboard key mapped as Enter .