User File Templates

The User File Editor uses special files called User File

Templates to store the keywords and parameters that define the User File Editor's menus and forms.

The system software includes a default User File Template, [Sys]<sys>UserFileTemplate.sys. Figure 2-15 shows the entries in the default template. The file also includes

comments that explain the template and its entries. You can use the Editor, the word processing program, or the TYPE command to display the file and read this information (refer to section 5).

Figure 2-15 Default User File Template :Description:Hail user name : Fleld : MailCenterNalre

:Descrlpt1on:Hail center name :FleICJ:Hailpassword

: ttlstFleld : Slgnon01 rectory : Oescrlpt1on:Dlrectory : Category : Word Processor

:F1elCJ: lPFormat5et

:Oescrlpt1on:Format set file :Oefault: [sys]<sys>Wp. fmt :Field: IfPPrinters

:Descrlptlon:Prlnters f11e : Oefeul t : [ sys ]<SYS>SY5. Printers : Fiela : WpPrintWleels

:Oescrlptlon:Prlnt Wheels file : Defaul t: [sys ]<sys>Wp. Whl : F leld: WpOictionary

: Descriptioo: Pflrases f 11e :Envlrcnnent:5elect Env1ronnent

: Ncm3 : Executive

:SignOnExitFile: [sys ] <sys>Exec . run :SlgnOnCna1nFile: [sys]<sys>Exec.run

The fo11o"ing are cormented out since these prOducts may not exist 00 the target system. They are here as eXCJTples Of otrer envlronments.

/* :Name:ttJlt1 Context

/* :COII'IIBlCI:lnstall Context Ma"lager /- :SignonExitFile: [5yS ]<sys>signon. IU'l /* :Name:lIRlTEDne

'*

'*

Adapting the System to Your Requirements 2-21 You can use the Editor or the word processing program to edit the default template, and also to create one or more additional User Template files. When you activate the User File Editor, you can accept the default file, or specify a file you have created (refer to the USER FILE EDITOR Command, in this section).

User File Template Entries

Each entry in a User File Template consists of a keyword enclosed in colons, followed by a parameter (refer to figure 2-15).

Note: The system requires the colons to read the file correctly.

The system ignores an entry if it does not begin with a keyword enclosed in colons.

Each section and subsection in a User File Template defines a menu, form, field, or default entry in the User File Editor interface.

Changes in User File Template parameters produce corresponding changes in the user interface. For example, you can change the titles of the menus and forms by changing the appropriate parameters.

The order in which the entries appear in the template determines the following features of the User File Editor interface:

o the order in which the menus appear

o the order in which the menus list the forms o the order in which the fields appear in the forms If a User File Template includes only one category in the Options section, or only one environment in the Environment section, the system displays the corresponding Option Category form (refer to figures 2-8 through 2-11) or

Environment form (refer to figures 2-12 and 2-13) instead of a menu.

The entries in a User File Template are divided into two sections (refer to figure 2-15):

o Options o Environments

The Options section defines the menus, forms, fields, and default entries that specify characteristics of the

environment(s). The Environments section defines the menus, forms, fields, and default entries that specify the initial environment and the exit environment.

Options

The Options section (refer to figure 2-15) is divided into subsections called Categories. Each Category defines an environment that appears as a choice in the Modify Options menu (refer to figure 2-6). The items within a Category specify the characteristics of the environment.

Note: If the template includes only one Category, the system displays the corresponding Option Category form (refer to figures 2-8 through 2-11) instead of the Options menu.

The Options section includes the following entries:

o :Options:

The system recognizes the keyword :Options: as the beginning of the Options section.

The parameter you enter appears as the text in one of the two fields of the Functions menu (refer to figure 2-5), and as the title of the Modify Options menu (refer to

figure 2-6).

The parameter in the default User File Template is Modify Options. You can accept the default, or enter a new parameter, up to a maximum of 18 characters.

o :Category:

The keyword :Category: indicates an application or other environment you want to include in the User file.

The parameter you enter appears as the text in a field of the Modify Options menu (refer to figure 2-6), and as the title of the corresponding Category Option form (refer to figures 2-8 through 2-11).

Adapting the System to Your Requirements

The default User File Template includes the following categories:

o Executive

o Mail

o SignOn

o VVord Processor

2-23

The SignOn category is required. The remaining categories are optional, and you can add others.

o :Field:

The keyword :Field: indicates a feature of the user configuration.

The parameter you enter appears as the text of a keyword in User files you create with this template (refer to User File Entries, in this section).

o :FileField:

The keyword :FileField: indicates that an entry is required and that it must be a file name.

The keyword :Default: and a parameter specifying a file name must follow.

o :MustField:

The keyword :MustField: indicates that an entry other than a file name is required (for example, a volume specification such as Sys).

The keyword :Default: and a parameter other than a file name must follow.

o : Description:

The parameter following the keyword :Description: appears as the text of a field in the Option Category form.

o :Default:

The keyword :Default: indicates a default entry in a Userfile.

The parameter you enter appears as the text of a default entry in the Category Option form.

Environments

Entries in the Environments section (refer to figure 2-15) specify the initial environment (the environment activated when you sign on) and the exit environment (the environment activated when you exit a program).

Each environment you specify in the Environments section appears as a choice in the Select Environment menu (refer to figure 2-7).

Note: If the template includes only one environment, the system displays the corresponding Environment form (refer to figures 2-12 and 2-13) instead of the Select Environment menu.

The Environments section includes the following entries:

o :Environments:

The system recognizes the keyword :Environments: as the beginning of the Environments section.

The parameter you enter appears as the text in one of the two fields of the Functions menu (refer to figure 2-5), and as the title of the Select Environment menu (refer to figure 2-7).

The parameter in the default User File Template is Select Environment. You can accept the default, or enter a new parameter, up to a maximum of 18 characters.

o :Name:

The keyword :Name: indicates the name of an environment, such as the Executive.

The parameter you enter appears as the text in a field of the Select Environment menu (refer to figure 2-7), and as the title of the corresponding Environment form (refer to figures 2-8 through 2-11).

The default User File Template includes the Executive as the only environment, but provides examples you can use to enter others.

o :Command:

The parameter following the :Command: keyword specifies the Executive command that activates the environment.

Based on this entry, the system supplies the

SignOnChainFile, the SignOnExitFile, and any parameters from the applicable command form.

Adapting the System to Your Requirements

If you include this entry, you omit entries specifying the SignOnChainFile and SignOnExitFile.

o :SignOnExitFile:

2-25

The parameter following the keyword :SignOnExitFile:

specifies the run file of the environment the system loads whenever you exit an application or enter ACTION-FINISH.

You include this entry only if you do not include the :Command: keyword and parameter.

o :SignOnChainFile:

The parameter following the keyword :SignOnChainFile:

specifies the run file of the initial environment.

You include this entry only if you do not include the :Command: keyword and parameter.

o :Default:

The :Default: keyword indicates the default environment when you include more than one environment in a template.

If you omit the :Default: keyword, the system defaults to the first environment in the template.

The :Default: keyword does not require a parameter.