Dallwitz, M.J., Paine, T.A. and Zurcher, E.J. 1993 onwards. User’s guide to the DELTA System: a general system for processing taxonomic descriptions. 4th edition. http://delta-intkey.com DELTA Home

PDF Version (782KB)


User’s Guide to the DELTA System: a General System for Processing Taxonomic Descriptions

17 June 2007

M.J. Dallwitz, T.A. Paine and E.J. Zurcher

Abstract

The DELTA system is a flexible data-coding format for taxonomic descriptions, and an associated set of programs for producing and typesetting natural-language descriptions and keys, for interactive identification and information retrieval, and for conversion of the data to formats required for phylogenetic and phenetic analysis. This manual is a comprehensive guide to the data format and the program directives.

Contents

1. Introduction

2. Characters and Taxon Descriptions

    2.1 The character list

    2.2 The taxon descriptions

3. The Format-Conversion Program Confor

    3.1 Introduction

    3.2 Data organization and file names

    3.3 Error messages

        3.3.1 General

        3.3.2 Storage limitations

    3.4 Typesetting marks

    3.5 Directives (in alphabetical order)

4. The Data-Maintenance Program Delfor

    4.1 Introduction

    4.2 Directives (in alphabetical order)

5. The Key-Generation Program Key

    5.1 Introduction

    5.2 Data and directives files

    5.3 Examples

        5.3.1 Interpreting program output

        5.3.2 Controlling the effect of character reliabilities

        5.3.3 Controlling the effect of intra-taxon variability

        5.3.4 Presetting characters

        5.3.5 Confirmatory characters

    5.4 How the program selects characters

    5.5 Directives (in alphabetical order)

6. The Distance-Matrix Program Dist

    6.1 Introduction

    6.2 Directives (in alphabetical order)

7. The Interactive Identification Program Intkey

    7.1 Introduction

    7.2 Accessing data and images over the Internet

8. The Image-Annotation Program Intimate

    8.1 Introduction

    8.2 Program start-up

    8.3 The File menu

    8.4 The Illustrate menu

    8.5 The Image menu

    8.6 The Overlay menu

    8.7 The image window and manipulation of overlays

    8.8 Syntax of directives

Acknowledgements

References and Citation

1. Introduction

When taxonomic descriptions are prepared for input to computer programs, the form of the coding is usually dictated by the requirements of a particular program or set of programs. This restricts the type of data that can be represented, and the number of other programs that can use the data. Even when working with a particular program, it is frequently necessary to set up different versions of the same basic data — for example, when using restricted sets of taxa or characters to make special-purpose keys. The potential advantages of automation, especially in connection with large groups, cannot be realised if the data have to be restructured by hand for every operation. The DELTA (DEscription Language for TAxonomy) system was developed to overcome these problems. It was designed primarily for easy use by people rather than for convenience in computer programming, and is versatile enough to replace the written description as the primary means of recording data. Consequently, it can be used as a shorthand method of recording data, even if computer processing of the data is not envisaged.

Particular attention has been paid to the need to minimize coding errors. The data are written in free format — that is, there is no need to place data in particular columns. The characters may be assigned numbers in any order that suits the user (there is no need to group them by character types, as required by some programs). However, this order need not be adhered to when recording the attributes of a particular taxon. Thus, attributes that are unknown or considered unimportant can be omitted, and later added to the end of the list, if required. An incorrect attribute can be deleted, and the correct one inserted in the same place or at the end. Common character attributes may be made implicit — that is, only the corresponding unusual attributes need appear explicitly in the data.

The system is capable of encoding all of the types of character commonly used for identification and classification: unordered and ordered multistate (including two-state), counts, measurements, and text. Intermediates, ranges, and alternatives can be represented, and distinction is made between ‘variable’, ‘unknown’, and ‘not applicable’. There is provision for comments, which can be used to indicate such things as probability, rarity, uncertainty, qualification, amplification, or references.

There is some redundancy in the coding system, to aid the detection of errors. Most errors have only a local effect, so that a program can continue to scan the rest of the data for other errors.

A format-conversion program, Confor, converts DELTA-format data into natural language, or into formats required by several other programs, including Key (generation of keys), Dist (generation of distance matrices), Paup, MacClade (Nexus), and Hennig86 (cladistic analysis), and Intkey (interactive identification and information retrieval). A complete list of the available translations can be found under the TRANSLATE INTO directive in Section 3.5. R.J. Various other programs use DELTA format directly – see DELTA Programs and Documentation.

This Guide is intended as a reference manual for the DELTA format (Chapter 2), and for the programs Confor, Delfor, Key, and Dist. Intkey has built-in documentation, and there is some further information in Chapter 7 of this Guide.

Introductions to using the DELTA format and programs are available in User’s Guide to the DELTA Editor (Dallwitz, Paine and Zurcher 1999) and A Primer for the DELTA System (Partridge, Dallwitz and Watson 1993).

The programs run on IBM-compatible PC’s under MS-Windows 95/NT or later (see Installation Guide for details). The programs will also run on Macintosh computers, under Windows emulation programs. The programs are free for non-commercial use (see Conditions of Use for details).

The latest versions of the DELTA programs, and several data sets, are available via the Web from http://delta-intkey.com and via anonymous ftp from ftp://delta-intkey.com.

2. Characters and Taxon Descriptions

2.1 The character list

The taxa are described in terms of a list of characters, each of which consists of a feature and a set of states. Five main types of character are recognized: unordered multistate (UM), ordered multistate (OM), integer numeric (IN), real numeric (RN), and text (TE). A multistate character has a fixed number of states (one or more), whereas a numeric character has (in principle) an infinite number of states. (Note. One-state ‘characters’ are allowed mainly for convenience when using a hierarchy of ‘characters’ to represent a taxonomic or geographic hierarchy.) Table 1 shows an example of a character list. Characters 1, 2, and 3 are unordered multistate, 4 is ordered multistate, 5 is integer numeric, 6 is real numeric, and 7 is text. (For two-state characters, the distinction between unordered and ordered is arbitrary.)

Table 1. Example of a character list.

#1. striated area on maxillary palp <presence>/

1. present/

2. absent/

#2. pronotum <colour>/

1. red/

2. black/

3. yellow/

#3. eyes <size>/

1. of normal size <i.e. less than 0.5mm in diameter>/

2. very large <i.e. more than 0.5mm in diameter>/

#4. frons <setae>/

1. with setae on anterior middle and above eyes/

2. with setae above eyes only/

3. without setae/

#5. number of lamellae in antennal club/

#6. length/ mm/

#7. <comments>/

Each character description starts with a feature description. The feature description starts with a numero (#), which must be at the start of a line or preceded by a blank. The numero is followed by the character number, a full stop (.), and a blank. A blank between the numero and the character number is optional. The feature description is terminated by a slash (/), which must be at the end of a line or followed by a blank. For multistate characters, the feature description is followed by the state descriptions. A state description starts with the state number, followed by a full stop and a blank. It is terminated by a slash, which must be at the end of a line or followed by a blank. For numeric characters, the feature description may optionally be followed by the units in which the character is measured. The units are terminated by a slash, which must be at the end of a line or followed by a blank. The character numbers must be consecutive integers starting at 1, and must be in ascending order in the character list. State numbers must be consecutive integers starting at 1, and must be in ascending order within each character description. A slash not followed by a blank or end of line (e.g. and/or) is allowed, and does not constitute a terminating slash.

The descriptions of the features, states, and units may contain comments delimited by angle brackets (<>). To be interpreted as a delimiting bracket, an opening bracket must be at the start of a line, or be preceded by a blank, a left bracket, or a right bracket; and a closing bracket must be at the end of a line, or be followed by a blank, a right bracket, a left bracket, or the slash which terminates that part of the character description. Nesting of comments is allowed, e.g. <aaa <bbb>>.

Confor omits character-list comments from much of its output: in particular, they do not appear in natural-language descriptions. They may contain any kind of subsidiary material, such as definitions of the terms being used, or references. In some contexts, such as interactive identification, a feature description may be displayed in isolation; comments should therefore be used, if necessary, to make the feature description convey the nature of the character (see examples in Table 1). Lengthy comments may be more appropriately placed in the Confor directive CHARACTER NOTES (see Section 3.5). Inner nested comments should be used for the author’s private notes; they can be omitted when the character list is printed or translated into other formats (see OMIT INNER COMMENTS in Section 3.5).

The feature and state descriptions should start with lower-case letters (except for proper nouns, etc.). If an initial letter must remain lower case even when at the start of a sentence, it should be preceded by a vertical bar, e.g. |mRNA. If output is to be automatically typeset, any necessary typesetting marks should be included (see Section 3.4).

For input to Confor, the character list must be preceded by the control phrase *CHARACTER LIST (see Chapter 3).

2.2 The taxon descriptions

A taxon description consists of one or more ‘item descriptions’, each of which describes one form or variant of the taxon. Usually one item per taxon is sufficient. However, it may be desirable, for example, to represent two or more subspecies as separate items within one species (taxon), or to represent one variable taxon by several items.

An item description consists of the item name followed by a set of attributes. The item name starts with a numero (#), which must be at the start of a line or preceded by a blank. A blank after the numero is optional. The item name is terminated by a slash (/), which must be at the end of a line or followed by a blank. A slash not followed by a blank or end of line is allowed, and does not constitute a terminating slash.

The item name may contain comments delimited by angle brackets (<>). To be interpreted as a delimiting bracket, an opening bracket must be at the start of a line, or be preceded by a blank, a left bracket, or a right bracket; and a closing bracket must be at the end of a line, or be followed by a blank, a right bracket, a left bracket, or the slash which terminates the item name. Nesting of comments is allowed. It is recommended that item-name comments be used for the authority, as in the example below. (The interpretation of inner nested comments is currently not defined; they may be used in future extensions of the DELTA format.)

Example

Item name and comment.

# Archaeoglenes nemoralis <Ford>/

An attribute consists of a character number, together with the character values (state numbers or numerical values) that apply to the taxon being described. The special symbols ‘V’, ‘U’, and ‘–’, represent ‘variable’, ‘unknown’, and ‘not applicable’, respectively. These are called pseudo-values. The simplest form of an attribute is

c,v

where c is a character number and v is a character value or pseudo-value. Attributes must be separated by at least one blank.

Example

With the characters defined in Table 1, the codes

1,V 4,3 5,- 6,8.5

represent

Striated area on maxillary palp present; or absent. Frons without setae. Number of lamellae in antennal club not applicable. Length 8.5mm.

The general form of an attribute is

c<e0>

or

c<e0>,r1<e1>/r2<e2>/...rn<en>

where c is a character number, ri is a value or combination of values (see below), ‘/’ is a separator denoting ‘or’, and ‘<ei>’ is optional extra information (a comment). Blanks or line endings are permitted within ei, but not elsewhere within the attribute. Nesting of comments is allowed. Note that, unlike the syntax in the character list and item names, any occurrence of ‘<’ or >’ is interpreted as a comment delimiter. Inner nested comments should be used for the author’s private notes; they can be omitted when the character list is printed or translated into other formats (see OMIT INNER COMMENTS in Section 3.5). ri takes one of the forms

v

v1&v2&...vm

v1-v2-...vm

where v is any character value or pseudo-value, vj is any character value (not a pseudo-value), ‘&’ is a separator denoting ‘and’, and ‘-’ is a separator denoting ‘to’.

Text characters are coded simply as c<e0>. If an initial letter of the value of a text character must remain lower case even when at the start of a sentence, it should be preceded by a vertical bar, e.g. |mRNA.

Example

The codes

1,1/2<rare> 2,2/2&3<striped> 3,1-2 6,7-8.5 7<possibly two species>

represent

Striated area on maxillary palp present; or absent <rare>. Pronotum black; or black and yellow <striped>. Eyes of normal size to very large. Length 7 to 8.5mm. Possibly two species.

When the separator ‘-’ is used with ordered multistate or numeric characters, the components of ri must be in ascending order, and ri denotes all values between v1 and vm. For unordered multistate characters, values between v1 and vm are not included in the range.

Examples

The attributes 4,1-3 and 4,1-2-3 are equivalent, and indicate that setae may be on the anterior middle and above the eyes, above the eyes only, or absent. However, the attributes 2,1-3 and 2,1-2-3 are not equivalent: the former denotes colours between red and yellow (red, orange, and yellow, but not black), while the latter denotes red, black, yellow, and their intermediates.

For numeric characters, ‘v1-’ and/or ‘-vm’ may be enclosed within parentheses, to denote extreme values, and there may be at most 3 normal values (those not enclosed in parentheses). The middle or only normal value is assumed to be a measure of central tendency (mean, median, or mode).

Examples

These attributes are valid:

5,1 (median or mode is 1)

5,1-2

5,1-2-3 (median or mode is 2)

5,1-1-2 (median or mode is 1)

5,(1-)2 (median or mode is 2)

5,(1-)2-3

5,(1-)2-3-4 (median or mode is 3)

5,(1-)2(-3) (median or mode is 2)

5,(1-)2-3(-4)

5,(1-)2-3-4(-5) (median or mode is 3)

These attributes are invalid:

5,(1-2-)3

5,(1-)2-3-4-5

Most current applications do not make use of the distinction between the separators ‘&’ and ‘/’. The only exception (apart from the Confor and Delfor options specifically for maintaining DELTA data) is the TRANSLATE INTO NATURAL LANGUAGE directive of Confor. If the distinction is essential for identification purposes, extra states can be defined for the required combinations. However, this may be less satisfactory for use in classification, as there is no way (within the DELTA system) to express the relationship between the composite states and their components.

Attributes may be recorded in any order within an item. A missing attribute is equivalent to an attribute with pseudo-value ‘U’ (except for variant items in a multi-item taxon, or if character dependencies or implicit values have been specified — see below).

Example

The item

# Species A/ 1,1 3,2 5,2 6,9 4,1

is equivalent to

# Species A/ 1,1 2,U 3,2 4,1 5,2 6,9

The items of a multi-item taxon must be grouped together. The items are identified as belonging to the same taxon by having a plus sign after the numero of the second and subsequent items (#+). The first item is called the main item, and the other items are called variant items. Missing attributes in the main item denote characters with unknown values (or dependent or implicit values), in the usual way. Missing attributes in the variant items denote attributes that are the same as in the main item.

Example

The 2-item taxon

# Species B (Australia)/ 1,1 2,1/2<rare> 3,1 5,3 6,5-6

#+ Species B (New Guinea)/ 3,2 5,U

is equivalent to

# Species B (Australia)/ 1,1 2,1/2<rare> 3,1 5,3 6,5-6

# Species B (New Guinea)/ 1,1 2,1/2<rare> 3,2 5,U 6,5-6

Confor can be used to produce DELTA-format data in which all the relevant information from the main items is explicit in the variant items (see INSERT REDUNDANT VARIANT ATTRIBUTES in Section 3.5). This process can also be reversed (see OMIT REDUNDANT VARIANT ATTRIBUTES in Section 3.5).

(It is proposed that future versions of the DELTA format will have provision for specifying a taxonomic hierarchy, and for passing attribute information up and down the hierarchy. The ‘variant items’ facility, in its present form, will be then be redundant, and will be removed.)

Some characters have a common or ‘usual’ state value, which describes the great majority of taxa, and a rare or ‘unusual’ state value, which describes only one or a few taxa. It is possible to specify that the common value is to be implicit unless otherwise indicated (see IMPLICIT VALUES in Section 3.5). Then only the rare values need be explicitly coded in the items. The main purpose of implicit values is to improve natural-language descriptions by omitting the common character values. Confor can be used to insert the implicit values in DELTA-format data or natural-language descriptions (see INSERT IMPLICIT VALUES in Section 3.5). However, if implicit values are inserted in DELTA-format data, the process cannot be reversed.

Sometimes certain attributes imply that other characters are inapplicable. A common example is a character that specifies the presence or absence of some structure: if the structure is absent, then all characters that further describe that structure are inapplicable. If this dependency of the characters is specified (see DEPENDENT CHARACTERS in Section 3.5), then the inapplicable characters can be omitted from items, instead of being explicitly coded as inapplicable.

For input to Confor, the items must be preceded by the control phrase *ITEM DESCRIPTIONS (see Chapter 3).

3. The Format-Conversion Program Confor

3.1 Introduction

Confor is a program for translating DELTA-format data into various other formats, including natural language. Execution of the program is controlled by means of ‘directives’, which are described in detail in Section 3.5. The output formats available are listed in that Section under the directive TRANSLATE INTO.

A directive consists of a star (*), a control phrase of up to four words, and data. The star must be at the start of a line, or be preceded by a blank. A blank following the star is optional. The control phrase must be in upper-case letters. Only the first two or three symbols of each word of the control phrase are examined by the program. However, it is recommended that the words be written in full, to make the directive as readable as possible. The data take different forms, depending on the control phrase, and in some directives are absent. A control phrase must be contained in one line, but its data may extend over several lines. A directive is terminated by the star at the start of the next directive.

Example

*TRANSLATE INTO NATURAL LANGUAGE  *PRINT WIDTH 132

*COMMENT. African species

*INCLUDE ITEMS 2 3 6-8 14-15 20 23 25

The execution of the program is controlled by the contents of the directives, and by the order in which they appear. Not all combinations and orders of directives are permitted. The restrictions are given in full in the individual descriptions of the directives (see Section 3.5).

The order in which the directives may appear are governed by their types. There are 6 types: 0, and 1-5. Type-0 directives have no restrictions on order. Directives of types 1-5 must appear in order of their types — that is, a directive must not precede any directive of lower type. The reason for this restriction is that higher-type directives may need to use information provided by lower-type directives. The directive types for individual directives are given in Section 3.5.

Except for type-0 directives, a directive must not appear more than once in a run. This restriction extends to sets of directives that specify the same or similar information, for example, the directives INCLUDE ITEMS and EXCLUDE ITEMS.

Many of the variables whose values may be set by directives are assigned default values by the program at the start of each run. Variables whose default values are what is required need not be explicitly set: the directives or parts of directives that set these variables may be omitted.

Sets of Confor directives are stored in files (see Section 3.2). To run the program, enter

confor directives-file

for example,

confor tokey

3.2 Data organization and file names

The Confor directives required for a particular purpose can all be stored in a single computer file. However, it is usually more convenient and flexible to divide the directives into four files, as follows.

  1. The directives file. This contains the directives required for a particular operation — for example, the TRANSLATE INTO, EXCLUDE CHARACTERS, and EXCLUDE ITEMS directives. It also contains INPUT FILE directives to direct Confor to read the other three files described below.
  2. The specifications file. This contains directives that describe the nature of the data, and are required for all (or almost all) operations. It always contains the directives NUMBER OF CHARACTERS, MAXIMUM NUMBER OF STATES, MAXIMUM NUMBER OF ITEMS, CHARACTER TYPES, and NUMBERS OF STATES. It should also contain directives such as DATA BUFFER SIZE, DEPENDENT CHARACTERS, and IMPLICIT VALUES, as necessary.
  3. The characters file. This file contains the CHARACTER LIST directive.
  4. The items file. This file contains the ITEM DESCRIPTIONS directive.

The adoption of conventions for naming files makes the names easier to remember. It is best to use a separate subdirectory for each set of data: then the names of corresponding files can always be the same, e.g. ‘specs’ for the specifications file. Some examples are given below.

Basic DELTA-format files.

              specs  

Specifications.

              chars  

Character list.

              items  

Items.

Special-purpose DELTA-format files. The purpose is indicated by a suffix to the file name.

              charsf  

French character list.

              charsk  

Character list with special wording appropriate for translation into Key format.

Key-format files produced by the TRANSLATE INTO KEY FORMAT option of Confor. The format of the files is indicated by a prefix to the file name.

              kchars  

Character list

              kitems  

Items.

Directives files.

              tokey  

Translate into Key format.

              topau  

Translate into PAUP format.

              checki  

Check the items.

              printc  

Print the characters.

3.3 Error messages

3.3.1 General

When Confor detects an error in the data, it prints: the current line of data, preceded by the file name and line number; an arrow pointing to the column where the error was detected; and an error message. This information is printed on the screen and on the listing file (see LISTING FILE in Section 3.5). If an essential part of the data, such as a delimiter, has been omitted, the omission cannot usually be detected until another delimiter has been found. The site of the omission will then be before the position of the arrow, in some cases on a previous line.

Error messages are often easier to interpret when viewed in full context in the listing file. By default, the CHARACTER LIST and ITEM DESCRIPTIONS directives are omitted from the listing file, but they can be included by means of the LIST CHARACTERS and LIST ITEMS directives. The latter directive was used to produce the listing file shown (in part) in the following example.

Example

items,211      # nigriventris Mercovich/

items,212      1,1.01-1.252,1 3,4 4,1-2 5,1 6,1 7,2 8,3 9,2 10,1 11,1

                           ^

****** Illegal delimiter. 1

                                                      ^

****** State number greater than specified maximum (2). 2

items,213      12,1 13,1 14,1 15, 1 17,2<difference slight> 18,3 19,2

                                 ^

****** Missing data. 3

                                  ^

****** Character 1 has already been specified. 4

items,214      20,2 21,2<usually a few on mesonotum> 23,2 24,4 25,7&8

items,215

items,216      # parvispinus Taylor

items,217      1,0.96-1.10 2,1 3,3 4,1 5.1 6,1 7,1 8,2 9,2 10,1 11,1

items,218      12,1 13,2 14,1 15,- 17,1 18,1 19,2 20,2 21,2 23,2 24,4

items,219

items,220      # phyllobates Brown/

              ^

****** Slash missing after previous item name. 5

items,221      1,0.96-1.12 2,1 3,4 4,2 5,1 6,1 7,3<fine to coarse>

1 There should be a blank separating the first two attributes. They should read: 1,1.01-1.25 2,1

2 The NUMBERS OF STATES directive specified 2 states for character 8.

3,4 Both of these messages are due to the same mistake: a blank in the middle of an attribute. It should read: 15,1

5 There should be a slash after the preceding item name (parvispinus Taylor). Note that the error in the fifth attribute (5.1 instead of 5,1) was not detected — because of the missing slash, the program treated all of the attributes as part of the item name.

After detecting errors, the program continues to process the data as long as it is possible and worthwhile to do so. When there is an error in a directive specifying a file name, the program stops immediately. After any other type of error, the program continues until a higher-type directive is encountered.

3.3.2 Storage limitations

None of the DELTA programs has fixed limits on the numbers of items or characters. All storage is allocated from a single pool, whose size depends on the amount of memory (RAM) available in the computer. All of the programs require some storage proportional to the number of characters, and some proportional to the number of items (taxa). Some of the programs also require additional storage. ‘Key’ requires storage proportional to the number of items multiplied by the number of characters.

Confor has a ‘data buffer’, which must be able to hold the longest item. The length of an item is increased by text material (text characters and comments), and decreased if some characters are not coded (for example, because they inapplicable to a particular item). The same storage is also used to hold individual characters from the character list and individual character notes, but these are rarely the limiting factors.

Confor has two error messages that indicate that it does not have enough storage available. The first is

Not enough space in data buffer. The length is n.

This means that the item (or character, or character note) currently being read will not fit in the data buffer. The default length of the data buffer is 20 times the number of characters. This can be increased or decreased by means of the DATA BUFFER SIZE directive, which should be placed in the ‘specs’ file immediately under the MAXIMUM NUMBER OF ITEMS directive.

The second message is

Not enough storage. n locations required, m available.

This means that the total amount of storage available is insufficient. A reduction in storage requirements is obtained by using a SPECIAL STORAGE directive in the ‘specs’ file, so that the character list is stored on disk instead of in memory. Reducing the size of the data buffer (see above) will also help, but the scope for this is usually limited. However, any reduction is multiplied threefold, because there are three data buffers.

3.4 Typesetting marks

Confor recognizes RTF (Rich Text Format) typesetting marks embedded in text such as the character list, taxon names, and comments in attributes. The marks are passed through into output files such as RTF natural-language descriptions and Intkey data files (unless suppressed by means of an OMIT TYPESETTING MARKS directive). An OUTPUT FORMAT HTML directive causes the marks to be translated into the corresponding HTML (HyperText Markup Language) marks. Further typesetting marks can be inserted in various contexts in natural-language descriptions and keys by means of the TYPSETTING MARKS directive.

Although they may contain RTF marks, DELTA data files are not RTF files (which require a special header). They must be edited as text files, or by means of the DELTA Editor which is included in the DELTA program package. In a text editor, the marks are edited as such, whereas in the DELTA Editor, the effects of the marks (for example, italics font) are edited as in a word processor.

RTF marks start with a backslash (\), and are terminated by the backslash of a following mark, a space, or braces ({}). However, a space should not be used as a terminator in DELTA files, as it may be removed by Confor when wrapping lines.

Some frequently used marks are given in the table below. N denotes a numeric parameter. Font size is specified in half-points, and other dimensions in twips. A twip is one-twentieth of a point. There are 1440 twips in an inch, and 567 twips in a centimetre (the conversion factor used is 1 inch = 2.5 cm).

RTF Marks

Meaning

Example

Marks

Effect

\i

Start italics

\i{}Agrostis\i0{}

Agrostis

\i0

Stop italics

\b

Start bold

\b{}Habit\b0{}

Habit

\b0

Stop bold

\sub

Start subscript

C\sub{}4\nosupersub{}

C4

\nosupersub

Stop super- or subscript

\fsN

Font size

\fs16{}eight point

eight point

\plain

Set default font attributes

 

 

\endash

En dash

4\endash{}10mm

4-10mm

\lquote

Left quote

\lquote{}normal\rquote{}

‘normal’

\rquote

Right quote

\par

New paragraph

\par\pard\sb567\sa283{}

Start a new paragraph with 1cm space before and 0.5cm space after

\pard

Default paragraph attributes

\sbN

Space before paragraph

\saN

Space after paragraph

\liN

Line indentation

\par\pard\li850\fi-567{}

Paragraph with the first line indented 0.5cm, and the others 1.5cm

\fiN

First line indentation (relative to line indentation)

A full description of RTF is available at http://support.microsoft.com/kb/q86999/.

3.5 Directives (in alphabetical order)

Definitions

A range of character numbers has the general form

c1-c2

where c1 and c2 are character numbers, and c1 is less than or equal to c2. It denotes all character numbers from c1 to c2, inclusive. For example, 6-9 denotes the characters 6, 7, 8, and 9.

A range of item numbers has the general form

t1-t2

where t1 and t2 are item numbers, and t1 is less than or equal to t2. It denotes all item numbers from t1 to t2, inclusive. For example, 6-9 denotes the items 6, 7, 8, and 9.

*ABSOLUTE ERROR   (Confor; Type 4)
Description

This directive specifies error limits to be applied to real numeric characters when converting to Key and Intkey formats. If an attribute in an item specifies only a single value, the errors specified in this directive are added to and subtracted from the value in the attribute to convert it to a range. See also PERCENT ERROR, OMIT LOWER FOR CHARACTERS.

General form

*ABSOLUTE ERROR c1,r1 c2,r2 ...ci,ri ...

where ci is a character number or range of numbers, and ri is a positive real number. An absolute error r applied to a value v produces a range v-r to v+r.

Default

The values are not altered.

Example

*ABSOLUTE ERROR 5,10 17,.005

With this directive in force, attributes 5,95 17,.12 would be equivalent to 5,85-105 17,.115-.125. Attributes 5,55-70 17,2.2-2.6 would be unchanged.

*ACCEPT DUPLICATE VALUES   (Confor, Delfor; Type 4)
Description

This directive allows the occurrence of two or more attributes with the same character number in an item. The last attribute with a given character number overrides the previous ones, and a warning message is displayed. This is to enable corrections to be made by appending the correct attribute, without the need to delete the incorrect attribute. This directive should be used with care, because repeated use of the same character number can arise unintentionally through mistyping of a character number.

General form

*ACCEPT DUPLICATE VALUES

Default

Duplicate values are fatal errors.

*ADD CHARACTERS   (Confor; Type 4)
Description

This directive specifies additional characters (that is, additional to those specified by means of an INCLUDE CHARACTERS or EXCLUDE CHARACTERS directive) to be included in the natural-language descriptions of specified taxa. Repeated use of the directive has a cumulative effect.

General form

*ADD CHARACTERS

#t1. c11 c12 ...c1j ...

#t2. c21 c22 ...c2j ...

...

#ti. ci1 ci2 ...cij ...

...

or

*ADD CHARACTERS

#n1/ c11 c12 ...c1j ...

#n2/. c21 c22 ...c2j ...

...

#ni/ ci1 ci2 ...cij ...

...

where ti is an item number, ni is an item name, and cij is a character number or range of numbers.

Default

No additional characters are output.

Example

*ADD CHARACTERS

#2. 4 9 11 13 16 20 28

#7. 4 9 11 13 16 19 27-28 34

#11. 4 9 11-13 16 19 27-28 34

#14. 4 9 11-13 77

*ADD CHARACTERS

# Andropogon <L.>/ 25

# Echinochloa <P. Beauv.>/ 18

# Zea <L.>/ 13 25

*ALTERNATE COMMA   (Confor; Type 4)
Description

This directive specifies that an alternate comma be used to separate elements in a list of states in natural-language descriptions. The form of the alternate comma is specified in the VOCABULARY directive. (In Chinese, the alternate comma should be used when the states are nouns, for example, for characters specifying geographical distribution or host range.)

General form

*ALTERNATE COMMA c1 c2 ...ci ...

where ci is a character number or range of numbers.

Default

The normal comma is used.

Example

*ALTERNATE COMMA 51 59

*APPLICABLE CHARACTERS   (Confor; Type 4)
Description

This directive specifies the values of ‘controlling’ characters which make other ‘dependent’ characters applicable. If, in a given item, a controlling character takes only values which make its dependent characters inapplicable, or if the controlling character itself is inapplicable, then the dependent characters must not be given any values (other than the pseudovalue ‘inapplicable’ (see Section 2.2), which is redundant and will be removed by translation into DELTA format (see TRANSLATE INTO)).

The directive must not appear with an INAPPLICABLE CHARACTERS or DEPENDENT CHARACTERS directive, to which it is an alternative.

General form

*APPLICABLE CHARACTERS c1,s1:d1 c2,s2:d2 ...ci,si:di ...

where ci is a character number (the controlling character), si is a set of state numbers, and di is a set of character numbers (the dependent characters). si takes the form

t1/t2/...tj/...

where tj is a state number. di takes the form

e1:e2:...ej:...

where ej is a character number or range of numbers. Characters declared applicable for a given value of a character are considered to be inapplicable for any other value of that character, unless explicitly declared otherwise. The controlling characters must be multistate, and any value of a controlling character may appear only once in the directive.

Default

None.

Example

*APPLICABLE CHARACTERS 10,1:11 16,1:17 20,1:21-24 32,1:33-38 39,2:40-43 47,3:48-51 55,1:56 57,1:58-59 68,1:69 78,1:79-80 78,2:79:81 78,3:82 78,4:83 78,5:79:84

This is equivalent to the example given for the DEPENDENT CHARACTERS directive.

*CHARACTER FOR OUTPUT FILES   (Confor; Type 4)
Description

This directive allows the specification, from information coded in the items, of the names of files for natural-language descriptions. It is an alternative to the ITEM OUTPUT FILES directive. See also INDEX OUTPUT FILE, SUBJECT FOR OUTPUT FILES.

General form

*CHARACTER FOR OUTPUT FILES c

where c is the number of a text character. The text recorded against this character for an item is used as the main part of the output-file name, from that item onwards. The appropriate file type (.rtf or .htm) is appended.

Default

Output files for natural-language descriptions are specified by the PRINT FILE and NEW FILES AT ITEMS directives

Example

*CHARACTER FOR OUTPUT FILES 226

*CHARACTERS FOR SYNONYMY   (Confor; Type 4)
Description

This directive specifies text characters which contain information on synonymy. These characters, as well as the taxon names, are searched by the ‘Find taxa’ option in Intkey (Version 4.04 and later).

General form

*CHARACTERS FOR SYNONYMY c1 c2 ...ci ...

where ci is a character number or range of numbers.

Default

None. Only the taxon names are searched by Intkey.

Example

*CHARACTERS FOR SYNONYMY 1-3

*CHARACTER FOR TAXON IMAGES   (Confor; Type 4)
Description

This directive specifies a dummy text character, which is used as a placeholder for taxon-image information in natural-language descriptions. The images and associated information are stored in a TAXON IMAGES directive.

General form

*CHARACTER FOR TAXON IMAGES c

where c is a character number.

Default

None.

Example

*CHARACTER FOR TAXON IMAGES 105

*CHARACTER FOR TAXON NAMES   (Confor; Type 4)
Description

This directive allows the specification of alternative taxon name for use in output files. It is mainly intended for specifying abbreviated names for output files destined for other programs, in which long names are impossible or inconvenient.

General form

*CHARACTER FOR TAXON NAMES c

where c is the number of a text character. The text recorded against this character for an item is used as the taxon name in output files.

Default

The normal taxon name is used.

Example

*CHARACTER FOR TAXON NAMES 226

*CHARACTER HEADINGS   (Confor; Type 4)
Description

This directive specifies headings to be placed in the character list produced by a PRINT CHARACTER LIST directive. (It should not be confused with the ITEM SUBHEADINGS directive.)

General form

*CHARACTER HEADINGS !

#c1. !t1!

#c2. !t2!

...

#ci. !ti!

...

where ! represents a delimiter symbol, which may be any symbol except the DELTA delimiters *, #, <, and >; ci is a character number; and ti is any text. The delimiter ! is optional; its purpose is to allow the use of the DELTA delimiters within the heading. The delimiter may be left undefined, by omitting its first occurrence (after the words CHARACTER HEADINGS). ti is output immediately before character ci on a separate line.

Default

None.

Example

*CHARACTER HEADINGS

#1. Habit and Leaf Form

#24. Inflorescence and Floral Morphology

#69. Fruit, Seed and Seedling

#87. Transverse Section of Lamina

#96. Leaf Epidermis

#119. Wood Anatomy

#124. Pollen Ultrastructure

#131. Miscellaneous

*CHARACTER IMAGES   (Confor; Type 4)
Description

This directive specifies information on character images and associated annotation for use with Intkey. The directive is normally created and edited by means of the program Intimate (see Chapter 8).

General form

See CHARACTER IMAGES in Section 8.8.

Default

None.

Example

See file ‘cimages’ in the sample data supplied with the programs.

*CHARACTER KEYWORD IMAGES   (Confor; Type 4)
Description

This directive specifies information on character keyword images and associated annotation for use with Intkey. It allows selection of character keywords from image screens (instead of from text screens).

The directive is normally created and edited by means of the program Intimate (see Chapter 8).

General form

See CHARACTER KEYWORD IMAGES in Section 8.8.

Default

None.

Example

See file ‘kimages’ in the sample data supplied with the programs.

*CHARACTER LIST   (Confor; Type 5)
Description

This directive specifies the character list. See also CHARACTER NOTES and CHARACTER IMAGES.

General form

*CHARACTER LIST c

where c is the character list (see Section 2.1).

Default

None.

Example

See file ‘chars’ in the sample data supplied with the programs.

*CHARACTER NOTES   (Confor; Type 4)
Description

This directive specifies text containing supplementary information about characters. This information is placed after the appropriate characters in the output produced by the PRINT CHARACTER LIST directive, and is also available through Intkey.

General form

*CHARACTER NOTES

#s1. t1

#s2. t2

...

#si. ti

...

where si is a set of character numbers and ti is any text. si takes the form

c1:c2:...cj:...

where cj is a character number or range of numbers.

Default

None.

Example

See file ‘cnotes’ in the sample data supplied with the programs.

*CHARACTER RELIABILITIES   (Confor; Type 4)
Description

This directive specifies the reliabilities or weights of the characters. The interpretation of the reliabilities or weights depends on the program for which they are intended. Generally, characters with high reliabilities or weights will be given emphasis in some way — for example, they will tend to be used early in keys.

This directive specifies the same information as the CHARACTER WEIGHTS directive. The relation between a reliability, r, and a weight, w, is given by

w = 2r-5 .

For example, reliabilities of 5 and 3 are equivalent to weights of 1 and 0.25, respectively.

General form

*CHARACTER RELIABILITIES c1,r1 c2,r2 ...ci,ri ...

where ci is a character number or range of character numbers, and ri is a real number in the range 0 to 10.

Default

5.

Example

*CHARACTER RELIABILITIES 2,6 3,10 8,7.5 10,0 12-14,2

The equivalent weights are 2,2 3,32 8,5.66 10,0.03125 12-14,0.125.

*CHARACTER TYPES   (Confor, Delfor; Type 2)
Description

This directive specifies the types of the characters.

General form

*CHARACTER TYPES c1,t1 c2,t2 ...ci,ti ...

where ci is a character number or range of numbers, and ti is one of the following character types.

       UM  

Unordered Multistate. Multistate (including 2-state) characters in which the states are not arranged in a natural order.

       OM  

Ordered Multistate. Multistate characters in which the states are arranged in a natural order.

       IN  

Integer Numeric. Numeric characters which take only integer (whole-number) values.

       RN  

Real Numeric. Numeric characters which may take fractional or integer values.

       TE  

Text.

Default

Characters not specified in this directive have type UM.

Example 1

*CHARACTER TYPES 1-2,UM 3,OM 4,IN 5,UM 6,IN 7-9,UM 10-11,RN 12,UM 13,TE

Example 2

*CHARACTER TYPES 3,OM 4,IN 6,IN 10-11,RN 13,TE

Equivalent to Example 1.

*CHARACTER WEIGHTS   (Confor; Type 4)
Description

This directive specifies the weights of the characters. The interpretation of the weights depends on the program for which they are intended. Generally, characters with high weights will be given emphasis in some way — for example, they will tend to be used early in keys.

The directive must not appear with a CHARACTER RELIABILITIES directive, to which it is an alternative.

General form

*CHARACTER WEIGHTS c1,w1 c2,w2 ...ci,wi ...

where ci is a character number or range of numbers, and wi is a real number in the range 0.03125 to 32 (corresponding to character reliabilities in the range 0 to 10).

Default

1.

Example

*CHARACTER WEIGHTS 1,5 2,10 3,1.5 6,0.5 8,.05

*CHINESE FORMAT   (Confor, Delfor; Type 4)
Description

This directive specifies formatting for Chinese and similar languages. Chinese symbols (characters) are assumed to be represented by pairs of bytes with the high-order bit set in the first byte. Capitalization is suppressed, line breaks may occur before or after any Chinese symbol, and spaces are not placed between features and states in natural-language descriptions.

General form

*CHINESE FORMAT

Default

Normal formatting for alphabetic languages.

*COMMENT   (Confor, Delfor; Type 0)
Description

This directive enables comments to be incorporated in directives files. It is intended for information that is not associated with a particular character, item, or attribute (for example, the date of the last revision of the data). It can also be used to deactivate a directive that is not currently required, but may be required again later. See also SHOW.

General form

*COMMENT text

where text is any text not containing blank-star. The text may extend over more than one line.

Default

None.

Example 1

*COMMENT Mask for Australian genera.

Example 2

Deactivate an EXCLUDE CHARACTERS directive.

*COMMENT EXCLUDE CHARACTERS 35-52

*DATA BUFFER SIZE   (Confor, Delfor; Type 1)
Description

This directive sets the size of arrays used for temporary storage of character and item descriptions. It need be used only if error messages on previous runs have indicated storage problems (see Section 3.3.2). The arrays must be large enough to hold (in the internal representation) the longest character or item description. However, if the arrays are larger than necessary, they occupy storage that could be used for other purposes.

General form

*DATA BUFFER SIZE n

where n is a positive integer.

Default

2000, or 20 times the number of characters, whichever is the greater.

Example

*DATA BUFFER SIZE 1200

*DATA COMPRESSION   (Confor; Type 4)
Description

This directive causes the items produced when translating into DELTA format to be coded more compactly. Successive attributes that have the same character types and the same state values are combined by using a range of character numbers. For example, the attributes 12,2 13,2 14,2 would become 12-14,2.

General form

*DATA COMPRESSION

Default

Each attribute is output separately.

*DATA LISTING   (Confor; Type 0)
Description

This directive causes the data read from the input file to be listed on the listing file (see LISTING FILE). In the listing, each line is preceded by the name of the file from which it was read, and by the line number. The directive is cancelled by the NO DATA LISTING directive.

This directive does not cause the characters and items files to be listed. This is done by means of the LIST CHARACTERS and LIST ITEMS directives.

General form

*DATA LISTING

Default

The input data are not listed. Note, however, that the listing is turned on by the LISTING FILE directive.

*DECIMAL PLACES   (Confor; Type 4)
Description

This directive specifies the number of decimal places to be used in outputting real character values, when translating into DELTA format or natural language.

General form

*DECIMAL PLACES c1,d1 c2,d2 ...ci,di ...

where ci is a character number or range of numbers, and di is an integer in the range 0 to 5. The characters must be real numeric (RN).

Default

5 significant figures, with suppression of non-significant zeros.

Example

Suppose that characters 1, 2, and 3 are real numeric.

*DECIMAL PLACES 2,0 3,2

The attributes 1,2.6 2,2.6 3,2.6 would be output in DELTA format as 1,2.6 2,3 3,2.60.

*DEPENDENT CHARACTERS   (Confor; Type 4)
Description

This directive specifies the values of ‘controlling’ characters that make other ‘dependent’ characters inapplicable. If, in a given item, a controlling character takes only values that make its dependent characters inapplicable, or if the controlling character itself is inapplicable, then the dependent characters must not be given any values (other than the pseudovalue ‘inapplicable’ (see Section 2.2), which is redundant and will be removed by translation into DELTA format (see TRANSLATE INTO)).

The directive must not appear with an APPLICABLE CHARACTERS or INAPPLICABLE CHARACTERS directive, to which it is an alternative.

General form

*DEPENDENT CHARACTERS c1,s1:d1 c2,s2:d2 ...ci,si:di ...

where ci is a character number (the controlling character), si is a set of state numbers, and di is a set of character numbers (the dependent characters). si takes the form

t1/t2/...tj/...

where tj is a state number. di takes the form

e1:e2:...ek:...

where ek is a character number or range of numbers. The controlling characters must be multistate, and any value of a controlling character may appear only once in the directive.

Default

None.

Example

*DEPENDENT CHARACTERS 4,2:16 10,1/3:12-13:20:30-35

Attribute 4,2 implies that character 16 is inapplicable. Attributes 10,1 and 10,3 imply that characters 12, 13, 20, and 30-35 are inapplicable.

*DISABLE DELTA OUTPUT   (Confor; Type 4)
Description

This directive, used with TRANSLATE INTO INTKEY FORMAT, disables the Intkey commands OUTPUT DESCRIBE and OUTPUT SUMMARY (which produce DELTA-format data). Note that this cannot prevent Intkey users from capturing data for processing by other programs — it only makes it more difficult.

General form

*DISABLE DELTA OUTPUT

Default

DELTA output from Intkey is permitted.

*DIST OUTPUT FILE   (Confor; Type 0)
Description

This directive specifies the file on which data destined for input to the Dist program will be written (see TRANSLATE INTO). The file must not have been used for any other type of input or output. It is a direct-access file, and cannot be viewed or changed with ordinary text editors.

General form

*DIST OUTPUT FILE f

where f is a file name.

Default

None.

Example

*DIST OUTPUT FILE ditems.grass

*EMPHASIZE CHARACTERS   (Confor; Type 4)
Description

This directive specifies characters to be emphasized in the typeset natural-language descriptions of specified taxa (see TYPESETTING MARKS). The specified characters will appear in the description regardless of whether they have been included by means of an INCLUDE CHARACTERS or EXCLUDE CHARACTERS directive. Repeated use of the directive has a cumulative effect.

General form

*EMPHASIZE CHARACTERS

#t1. c11 c12 ...c1j ...

#t2. c21 c22 ...c2j ...

...

#ti. ci1 ci2 ...cij ...

...

or

*EMPHASIZE CHARACTERS

#n1/ c11 c12 ...c1j ...

#n2/ c21 c22 ...c2j ...

...

#ni/ ci1 ci2 ...cij ...

...

where ti is an item number, ni is an item name, and cij is a character number or range of numbers.

Default

Character descriptions are not emphasized.

Example

*EMPHASIZE CHARACTERS

#1. 11 35 39

#2. 16

#3. 31 61

#4. 15 66

#5. 16 19 31

#6. 19 28 31 44

#7. 16 19 27

#8. 65

#9. 4 44 66

#10. 4 60

#11. 13 27 34

#12. 11 56

#13. 13 52 66

#14. 12

*EMPHASIZE CHARACTERS

# Andropogon <L.>/ 25

# Bambusa <Schreber>/ 13

# Echinochloa <P. Beauv.>/ 18

# Zea <L.>/ 13 25

*EMPHASIZE FEATURES   (Confor; Type 4)
Description

This directive causes the specified features to be emphasized in natural-language descriptions (see TYPESETTING MARKS). To emphasize the feature in a set of linked characters, all of the features in the set should normally be specified in the EMPHASIZE FEATURES directive, in case the attribute corresponding to the first character is missing.

General form

*EMPHASIZE FEATURES c1 c2 ...ci ...

where ci is a character number or range of numbers.

Default

None.

Example

*EMPHASIZE FEATURES 1 6-8 20

*END   (Confor, Delfor; Type 0)
Description

This directive terminates the program. It is supplied automatically by the program at the end of the main directives file.

General form

*END

Default

None.

*ERROR FILE   (Confor, Delfor; Type 0)
Description

This directive specifies the file on which error messages will be output. The file must not have been used for any other type of input or output, apart from listing and print output (see LISTING FILE and PRINT FILE).

General form

*ERROR FILE f

where f is a file name.

Default

Error messages are output on the default output device or file of the particular computer system. This is usually the screen. Also, error messages are always output on the listing file if one has been specified.

Example

*ERROR FILE check.err

*EXCLUDE CHARACTERS   (Confor, Delfor; Type 4)
Description

This directive specifies characters that are to be excluded from output files.

The directive must not appear with an INCLUDE CHARACTERS directive, to which it is an alternative.

General form

*EXCLUDE CHARACTERS c1 c2 ...ci ...

where ci is a character number or range of numbers.

Default

All characters are included.

Example

*EXCLUDE CHARACTERS 1 3-5

*EXCLUDE ITEMS   (Confor, Delfor; Type 4)
Description

This directive specifies items that are to be excluded from output files.

The directive must not appear with an INCLUDE ITEMS directive, to which it is an alternative.

General form

*EXCLUDE ITEMS t1 t2 ... ti ...

where ti is an item number or range of numbers.

Default

All items are included.

Example

*EXCLUDE ITEMS 3 5-6 20

*HEADING   (Confor; Type 0)
Description

This directive specifies a heading, which may subsequently used to label the output. The current time and date may be included in the heading.

The heading is printed on the error file when reading of the HEADING directive is complete; on the listing file (see LISTING FILE) when a new file is started, or after a LIST HEADING directive; and on the print file (see PRINT FILE) after a PRINT HEADING directive. On the ‘output’ file, the heading is written wherever #HEADING (or the equivalent) appears in the data of a OUTPUT PARAMETERS directive (except when translating into DELTA format).

General form

*HEADING t

where t is any text not containing blank-star. The words #TIME and #DATE are replaced by the current time and date, respectively. The total number of symbols in the heading, including the time and date, must not exceed 200.

Default

None.

Example

*HEADING: Genus Orectognathus (Hymenoptera: Formicidae). #DATE

*IMAGE DIRECTORY   (Confor; Type 4)

This directive specifies a directory name for images that have links from natural-language descriptions in HTML format. The names of the image files are obtained from a TAXON IMAGES directive, and the specified directory name is prefixed to the file names.

To facilitate moving the output files onto other computers (in particular, onto a WWW server), the image directory should be specified as a relative rather than an absolute path, as shown in the example.

General form

*IMAGE DIRECTORY d

where d is a directory name.

Default

None. Hence, the image files must be in the same directory as the HTML files which reference them.

Example

*IMAGE DIRECTORY ..\images

The ‘..’ refers to the parent of the current directory. Typically, the HTML descriptions are in a subdirectory ‘www’ and the images in a subdirectory ‘images’, both of which are subdirectories of a directory containing the HTML index file and the Intkey files.

*IMPLICIT VALUES   (Confor; Type 4)
Description

This directive permits certain attributes or state values to be omitted from items. The omitted attributes or values are assigned default values. The main purpose of the directive is to improve natural-language descriptions by omitting frequently occurring state values.

General form

*IMPLICIT VALUES c1,s1:t1 c2,s2:t2 ...ci,si:ti ...

where ci is a character number or range of numbers, and si and ti are state values. ‘:tiis optional. Numeric or text characters must not be specified.

If a character specified by ci does not appear in an item, then the character is assigned the value si (unless the item is a variant item, in which case missing characters have their normal interpretation). If a character specified by ci appears without a value or pseudovalue, it is assigned the value ti; if:tiis not present in the directive, then no value is assigned. Unknown values must be represented by ‘U’.

When translating into DELTA format, implicit values are not inserted unless an INSERT IMPLICIT VALUES directive is in force.

When translating into natural language, implicit values corresponding to si are not inserted unless an INSERT IMPLICIT VALUES directive is in force, or the item and character have been specified in an ADD CHARACTERS or EMPHASIZE CHARACTERS directive. Implicit values corresponding to ti are inserted as though they were explicitly coded in the item; that is, the attributes ci and ci,ti produce the same result.

If an attribute which has been specified as implicit is nevertheless explicitly coded in an item (that is, ci,si appears in the item), the attribute is output when translating into DELTA format or natural language. This explicit coding of otherwise implicit attributes can be used for emphasis, for example, when the attribute is important for distinguishing the taxon from a closely related one.

Default

None.

Example

*IMPLICIT VALUES 1-3,2:1 5,1

The attributes

1,3 3

are then equivalent to

1,3 2,2 3,1 5,1

(except in natural-language descriptions).

*INAPPLICABLE CHARACTERS   (Confor; Type 4)
Description

This directive is synonymous with the DEPENDENT CHARACTERS directive.

*INCLUDE CHARACTERS   (Confor, Delfor; Type 4)
Description

This directive specifies characters which are to be included in output files.

The directive must not appear with an EXCLUDE CHARACTERS directive, to which it is an alternative.

General form

*INCLUDE CHARACTERS c1 c2 ...ci ...

where ci is a character number or range of numbers.

Default

All characters are included.

Example

*INCLUDE CHARACTERS 2 6-20

*INCLUDE ITEMS   (Confor, Delfor; Type 4)
Description

This directive specifies items which are to be included in output files.

The directive must not appear with an EXCLUDE ITEMS directive, to which it is an alternative.

General form

*INCLUDE ITEMS t1 t2 ...ti ...

where ti is an item number or range of numbers.

Default

All items are included.

Example

*INCLUDE ITEMS 1-2 4 7-19

*INDEX HEADINGS   (Confor; Type 4)

This directive specifies headings to be used in the HTML index file (see INDEX OUTPUT FILE), interspersed with the taxon names.

General form

*INDEX HEADINGS !

#n1/ !h1!

#n2/ !h2!

...

#ni/ !hi!

...

where ! represents a delimiter symbol, which may be any symbol except the DELTA delimiters *, #, <, and >; ni is a taxon name; and hi is a heading. The delimiter ! is optional; its purpose is to allow the use of the DELTA delimiters within the heading. The delimiter may be left undefined, by omitting its first occurrence (after the words INDEX HEADINGS). In the output, the headings are positioned before corresponding taxon names.

Default

There are no headings interspersed with the taxon names in the index.

Example

*INDEX HEADINGS !

# F. arizonica/ !<p><b>Subg. <i>Festuca</i> L.</b><br>!

# F. altaica/ !<p><b>Subg. <i>Leucopoa</i> (Griseb.) Hack.</b><br>!

# F. arundinacea/ !<p><b>Subg. <i>Schedonorus</i> (Beauv.) Peterm.</b><br>!

# F. elmeri/ !<p><b>Subg. <i>Subulatae</i> Tzvelev, sect. <i>Subulatae</i> Tzvelev</b><br>!

#F. paradoxa/ !<p><b>Subg. <i>Subulatae</i> (Tzvelev) E. B. Alexeev, sect. <i>Obtusae</i> E. B. Alexeev</b><br>!

#F. amethystina/ !<p><b>Species of <i>Festuca</i> that have been excluded for various reasons, such as limited data or uncertainties related to the correct name, and two species of <i>Lolium</i>.</b><br>!

*INDEX OUTPUT FILE   (Confor; Type 0)

This directive specifies the name of an HTML index file, into which are put links to files containing natural-language descriptions in HTML format. It is used in conjunction with the directives CHARACTER FOR OUTPUT FILES or ITEM OUTPUT FILES, which specify files containing individual taxon descriptions. See also INDEX TEXT.

General form

*INDEX OUTPUT FILE f

where f is a file name.

Default

None.

Example

*INDEX OUTPUT FILE .\index.htm

The ‘.\’ (‘current directory’) overrides the directory specified in a previous OUTPUT DIRECTORY directive. (Usually, the index file is in the main data directory, whereas the HTML files are in a subdirectory ‘www’, which is specified as the ‘output directory’ when these files are being generated.)

*INDEX TEXT   (Confor; Type 0)
Description

This directive specifies text to be put in the HTML index file specified by the INDEX OUPUT FILE directive.

General form

*INDEX TEXT text

where text is any text not containing blank-star. The text may extend over more than one line.

Default

None.

Example

See file ‘tonath’ in the sample data supplied with the programs.

*INPUT DELTA FILE   (Confor, Delfor; Type 0)
Description

This directive specifies the file from which directives are next to be read. It differs from the INPUT FILE directive in that if the specified file is not found in the current default directory, the program looks for it in the DELTA directory.

General form

*INPUT DELTA FILE f

where f is a file name.

Default

None.

Example

*INPUT DELTA FILE vocabde

*INPUT FILE   (Confor, Delfor; Type 0)
Description

This directive specifies the file from which input lines will be read after the processing of the current input line is finished. The file must not have been used for any other type of input or output.

General form

*INPUT FILE f

where f is a file name.

Default

Input is from a file specified in the command line which started the program running, or a file specified in response to a prompt issued by the program.

Example

*INPUT FILE specs

*INSERT CHARACTER SEQUENCE NUMBERS   (Confor; Type 4)
Description

This directive specifies that sequence numbers are to be inserted in the new characters file, when translating into DELTA format. (It was used when data were saved on punched cards, so that the card deck could be correctly re-assembled if it was dropped.) See also SEQUENCE INCREMENT.

General form

*INSERT CHARACTER SEQUENCE NUMBERS

Default

Sequence numbers are omitted from the new characters file.

*INSERT IMAGE FILE NAME   (Confor; Type 4)
Description

This directive causes the image-file names to be included in the output generated by the CHARACTER FOR TAXON IMAGES and TAXON IMAGES directives. It is intended for constructing an HTML image catalog for use by the author of a data set.

General form

*INSERT IMAGE FILE NAME

Default

Image-file names are not output (unless no ‘subject’ has been specified for the image — see Chapter 8).

*INSERT IMPLICIT VALUES   (Confor; Type 4)
Description

This directive causes implicit values (see IMPLICIT VALUES) to be inserted in natural-language and DELTA-format output. (They are always inserted in all other output.)

General form

*INSERT IMPLICIT VALUES

Default

Implicit values are omitted from natural-language and DELTA-format output.

*INSERT ITEM SEQUENCE NUMBERS   (Confor; Type 4)
Description

This directive specifies that sequence numbers are to be inserted in the new items file, when translating into DELTA format. (It was used when data were saved on punched cards, so that the card deck could be correctly re-assembled if it was dropped.) See also SEQUENCE INCREMENT.

General form

*INSERT ITEM SEQUENCE NUMBERS

Default

Sequence numbers are omitted from the new items file.

*INSERT REDUNDANT VARIANT ATTRIBUTES   (Confor; Type 4)
Description

This directive specifies that, when translating a variant item into DELTA format or natural language, an attribute will be output if it is coded in either the master or variant item — that is, information missing from the variant item will be taken from the master item if possible. (Note that, for all other output formats, this is always done — it is not necessary to use this directive.) See also OMIT REDUNDANT VARIANT ATTRIBUTES.

General form

*INSERT REDUNDANT VARIANT ATTRIBUTES

Default

When translating a variant item into DELTA format or natural language, variant items are output as coded.

*INTKEY OUTPUT FILE   (Confor; Type 0)
Description

This directive specifies the file on which data destined for input to the Intkey program will be written (see TRANSLATE INTO). The file must not have been used for any other type of input or output. It is a direct-access file, and cannot be viewed or changed with ordinary text editors.

General form

*INTKEY OUTPUT FILE f

where f is a file name.

Default

None.

Example

*INTKEY OUTPUT FILE iitems

*ITEM ABUNDANCES   (Confor; Type 4)
Description

This directive specifies the abundances or weights of the items.

The interpretation of the abundances or weights depends on the program for which they are intended. Generally, items with high abundances or weights will be given emphasis in some way — for example, they tend to come out early in keys.

This directive specifies the same information as the ITEM WEIGHTS directive. The relation between an abundance, a, and a weight, w, is given by

w = 2a-5 .

For example, abundances of 9 and 5 are equivalent to weights of 16 and 1, respectively.

General form

*ITEM ABUNDANCES t1,a1 t2,a2 ...ti,ai ...

where ti is an item number or range of numbers. and ai is a real number in the range 0 to 10.

Default

5.

Example

*ITEM ABUNDANCES 2-4,3 6,8 10,9

*ITEM DESCRIPTIONS   (Confor; Type 5)
Description

This directive specifies the item descriptions. See also ACCEPT DUPLICATE VALUES, DEPENDENT CHARACTERS, IMPLICIT VALUES, MANDATORY CHARACTERS.

General form

*ITEM DESCRIPTIONS t

where t is the taxon descriptions (see Section 2.2).

Default

None.

Example

See file ‘items’ in the sample data supplied with the programs.

*ITEM HEADINGS   (Confor; Type 4)

This directive specifies headings to be used in natural-language output, interspersed with the taxon descriptions.

General form

*ITEM HEADINGS !

#n1/ !h1!

#n2/ !h2!

...

#ni/ !hi!

...

where ! represents a delimiter symbol, which may be any symbol except the DELTA delimiters *, #, <, and >; ni is a taxon name; and hi is a heading. The delimiter ! is optional; its purpose is to allow the use of the DELTA delimiters within the heading. The delimiter may be left undefined, by omitting its first occurrence (after the words ITEM HEADINGS). In the output, the headings are positioned before corresponding taxon descriptions.

Default

There are no headings interspersed with the taxon descriptions.

Example

*ITEM HEADINGS

# F. arizonica/ \page\b\fs24{}Subg. \i{}Festuca\i0{} L.\b0{}

# F. altaica/ \page\b\fs24{}Subg. \i{}Leucopoa\i0{} (Griseb.) Hack.\b0{}

# F. arundinacea/ \page\b\fs24{}Subg. \i{}Schedonorus\i0{} (Beauv.) Peterm.\b0{}

# F. elmeri/ \page\b\fs24{}Subg. \i{}Subulatae\i0{} Tzvelev, sect. \i{}Subulatae\i0{} Tzvelev\b0{}

#F. paradoxa/ \page\b\fs24{}Subg. \i{}Subulatae\i0{} (Tzvelev) E. B. Alexeev, sect. \i{}Obtusae\i0{} E. B. Alexeev\b0{}

#F. amethystina/ \page\b\fs24{}Species of \i{}Festuca\i0{} that have been excluded for various reasons, such as limited data or uncertainties related to the correct name, and two species of \i{}Lolium\i0{}.\b0{}

*ITEM OUTPUT FILES   (Confor; Type 4)
Description

This directive specifies the names of output files for natural-language descriptions. It is an alternative to the CHARACTER FOR OUTPUT FILES directive.

See also INDEX OUTPUT FILE, SUBJECT FOR OUTPUT FILES.

General form

*ITEM OUTPUT FILES

#n1/ f1

#n2/ f2

...

#ni/ fi

...

where ni is a taxon name, and fi is text specifying a file name. fi is used as the main part of the output-file name, from the corresponding item onwards. The appropriate file type (.rtf or .htm) is appended by the program.

Default

Output files for natural-language descriptions are specified by the PRINT FILE and NEW FILES AT ITEMS directives

Example

*ITEM OUTPUT FILES

# Agrostis <L.>/ agrostis

# Andropogon <L.>/ andropog

...

# Phragmites <Adans.>/ phragmit

# Poa <L.>/ poa

# Zea <L.>/ zea

*ITEM SUBHEADINGS   (Confor; Type 4)
Description

This directive specifies subheadings to be placed in natural-language descriptions (see TRANSLATE INTO). (It should not be confused with the CHARACTER HEADINGS directive.)

General form

*ITEM SUBHEADINGS !

#c1. !t1!

#c2. !t2!

...

#ci. !ti!

...

where ! represents a delimiter symbol, which may be any symbol except the DELTA delimiters *, #, <, and >; ci is a character number; and ti is any text. The delimiter ! is optional; its purpose is to allow the use of the DELTA delimiters within the heading. The delimiter may be left undefined, by omitting its first occurrence (after the words ITEM SUBHEADINGS). ti is output immediately before attribute ci.

Default

None.

Example

*ITEM SUBHEADINGS

#87. Transverse section of lamina.

#96. Leaf epidermis.

#124. Pollen ultrastructure.

*ITEM WEIGHTS   (Confor; Type 4)
Description

This directive specifies the weights of the items.

The interpretation of the weights depends on the program for which they are intended. Generally, items with high weights will be given emphasis in some way — for example, they tend to come out early in keys.

The directive must not appear with an ITEM ABUNDANCES directive, to which it is an alternative.

General form

*ITEM WEIGHTS t1,w1 t2,w2 ...ti,wi ...

where ti is an item number or range of numbers, and wi is a real number in the range 0.03125 to 32 (corresponding to item abundances in the range 0 to 10).

Default

1.

Example

*ITEM WEIGHTS 3,.5 5,7 6-7,.05 10,20

*KEY CHARACTER LIST   (Confor; Type 5)
Description

This directive specifies an alternative character list, in which the state descriptions conform to the states specified in the KEY STATES directive. It is intended for use when the wording of the new state descriptions generated by the program is unsatisfactory.

The directive must not appear with a CHARACTER LIST directive, to which it is an alternative.

General form

*KEY CHARACTER LIST c

where c is a character list (see Section 2.1).

Default

None.

Example

Suppose that the character list in Table 1 (Section 2.1) is used with the following KEY STATES directive.

*KEY STATES 4,1&2/3 5,7/8 6,~5/5~

The following wordings would be generated for the new states of characters 4 to 6.

#4. frons <setae>/

1. with setae on anterior middle and above eyes or with setae above eyes only/

2. without setae/

#5. number of lamellae in antennal club/

1. 7/

2. 8/

#6. length/

1. up to 5 mm/

2. 5 mm or more/

The following directive could be used to change the wordings of characters 4 and 6.

*KEY CHARACTER LIST

#1. striated area on maxillary palp <presence>/

1. present/

2. absent/

#2. pronotum <colour>/

1. red/

2. black/

3. yellow/

#3. eyes <size>/

1. of normal size <i.e. less than 0.5 mm in diameter>/

2. very large <i.e. more than 0.5 mm in diameter>/

#4. frons <setae>/

1. with setae/

2. without setae/

#5. number of lamellae in antennal club/

1. 7/

2. 8/