RAM 6.0 BUX II Series Guía de usuario descargar pdf (Pagina 171)

B Documentation Guidelines

B.5 Format and Style

163

Lists and Tables

Short Word Lists

A simple list of words or short phrases can be created simply by putting each word

on a line by itself and indenting it with space characters. Any line that begins with

a space causes a line breaks to be preserved for that line only. The line remains part

of the paragraph, and so no vertical space is added.

Example input:

The first three words in the international phonetic alphabet are:

alpha

bravo

charlie

Resulting output:

The first three words in the international phonetic alphabet are:

alpha

bravo

charlie

Do not use this mechanism for line items that contain more than three words.

Item Lists (Definition Lists or Terms Lists)

Item lists, also known a definition lists and terms lists, are lists of special elements—

parameters, constants, routines, commands, and so on—and their descriptions.

Introduce an item list with the \is tag. Tag each item name with the \i tag, and type

the description on the following line. End the list with \ie. To preserve the

readability of the input, separate each item with a blank line; the items are

separated by blank space in the output, regardless. Example input:

\is

\i ’FIODISKFORMAT’

Formats the entire disk with appropriate hardware track and

sector marks. No file system is initialized on the disk by

this request.

\i ’FIODISKINIT’

Initializes a DOS file system on the disk volume.

\ie

NOTE: Do not use the \cs and \ce tags to build lists or tables.

CAUTION: Nesting of lists is not supported.

1 2 ... 166 167 168 169 170 171 172 173 174 175 176 ... 188 189

Sin comentarios

RAM 6.0 BUX II Series Guía de usuario Pagina 171