1.3 An Architectural Overview

1.3 An Architectural Overview

An understanding of the internals of FunnelWeb assists with

understanding its operation. During a single run, FunnelWeb reads

Tutorial

and processes a single input file called the 

input file

 (also called

the 

FunnelWeb file

). The file is processed by passing it through a

Developer

series of stages called 

phases

. The result is that some 

output files

are generated. A 

journal file

 is generated containing a copy of the

Reference

messages that appear on the console during the FunnelWeb run. A

listing file

 is created containing a summary of the run, including

1 Introduction

any error messages. A 

documentation

 file is generated containing

2 Interface

typesetter commands that when fed into a typesetter program will

3 Scanner

result in printed documentation. Finally, one or more 

product files

4 Parser

are generated containing the result of unscrambling the macro

5 Analyser

definitions of the input file.

6 Tangle

7 Weave

8 Shell

     .fw Input File

9 Commands

     (FunnelWeb file)

10 Glossary

            V

       +         +         \

11 References

       | Scanner |         |

       +         +         |

SEARCH

            V              |

        +        +         |

        | Parser |         |

        +        +         |

            V              |

       +          +        >    +        +

       | Analyser |        |    |        |

       +          +        |    |        |

            V              |    |        |

    +       +       +      |    V        V

    V               V      |    |        |

+        +      +       +  |    |        |

| Tangle |      | Weave |  |    |        |

+        +      +       +  /    |        |

    |               |           |        |

    V               V           V        V

 Product      Documentation  Listing  Journal

  Files           File         File    File

FunnelWeb s processing phases

http://www.ross.net/funnelweb/reference/intro_arch.html (1 of 2) [3/3/2000 10:49:26 PM]