7 Weave

7 Weave

If the scanner, parser, and analyser have successfully (i.e. with

no errors, severe errors, or fatal errors) completed, and either or

Tutorial

both of the two Weave options (+T, U) is turned on (both are

off

  by default), then the Weave component of FunnelWeb is

Developer

invoked to generate one or two documentation files.

Reference

Target Typesetter

1 Introduction

2 Interface

All versions of FunnelWeb up to V3.1 could generate only TeX

3 Scanner

documentation. This used the +t option. FunnelWeb V3.2 can

4 Parser

now generate HTML documention using the +u option. You

5 Analyser

can generate both at once if you like.

6 Tangle

7 Weave

Cross Reference Numbering

8 Shell

9 Commands

When FunnelWeb produces its typeset documentation, it

10 Glossary

numbers

  each section and each macro definition and cross

11 References

references the macro definitions. The exact scheme used has

been carefully thought out. However, as it can be a little

SEARCH

confusing to the beginner, it is explained here in full.

The most important thing is that there is 

no relation

  between

the macro numbering and the section numbering. In Knuth s

Web there are only section numbers. In FunnelWeb, the

numbering of sections and macros is separated.

In FunnelWeb, 

sections

  are numbered hierarchically in

ascending order. For example, the second level C section of the

third level B section of the first level A section is numbered

"1.3.2". In contrast, 

macro definitions

  are numbered

sequentially in ascending order. For example, the first macro

definition is number 1, the second is number 2, and so on. Note

that it is 

macro definitions

  that are numbered, not 

macros

 .

This distinction is necessary because additive macros (i.e. the

ones with +=) can be defined by a collection of partial

definitions scattered throughout the input file. A single additive

macro may be defined in definitions 5, 67, 128, and 153.

http://www.ross.net/funnelweb/reference/weave.html (1 of 2) [3/3/2000 10:43:23 PM]