4.5 Section Directive

4.5 Section Directive

The section directive provides a way for the user to structure the program

and documentation into a hierarchical tree structure, just as in most large

Tutorial

documents. A section construct consists of a case insensitive identifying

letter, which determines the absolute level of the section in the document,

Developer

and an optional section name, which has exactly the same syntax as a

macro name.

Reference

1 Introduction

section   = "@" levelchar [name]

2 Interface

levelchar = "A" | "B" | "C" | "D" | "E" |

            "a" | "b" | "c" | "d" | "e"

3 Scanner

4 Parser

The section construct is not quite "inline", as it must appear only at the

5 Analyser

start of a line. However, unlike the "

@i

", "

@p

", and "

@t

" constructs, it

6 Tangle

does not consume the remainder of the line (although it would be silly to

7 Weave

place anything on the same line anyway).

8 Shell

FunnelWeb provides five levels of sections, ranging from the highest level

9 Commands

of A (like a LaTeX chapter) to the lowest level of E (like a LaTeX

10 Glossary

subsubsubsection). FunnelWeb input files need not contain any sections at

11 References

all, but if they do, the first section must be at level A, and following

sections must not skip hierarchical levels (e.g. an @E cannot follow an

SEARCH

@C). FunnelWeb generates an error if a level is skipped.

All section 

must

  have names associated with them, but for convenience,

the section name is optional if the section contains one or more macro

definitions (i.e. at least one macro definition appears between the section

construct in question and the next section construct in the input file.). In

this case, the section 

inherits

  the name of the first macro defined in the

section. This feature streamlines the input file, avoiding duplicate name

inconsistencies.

Any sequence of printable characters can be used in the section name,

even the target typesetter s escape sequence (e.g. in TeX, "

\

").

The following example demonstrates the section construct.

@A@

This is the main simulation module for planet

earth, simulated down to the molecular level. This

is a REALLY big program. I mean really big. I

mean, if you thought the X Windows source code was

http://www.ross.net/funnelweb/reference/parser_type_section.html (1 of 2) [3/3/2000 10:46:35 PM]