Tutorial Developer Reference 1 Introduction 2 Interface 3 Scanner 4 Parser 5 Analyser 6 Tangle 7 Weave 8 Shell 9 Commands 10 Glossary 11 References SEARCH

Version 3.2d (9 Jan 2000) for FunnelWeb V3.2

THIS REFERENCE MANUAL provides a concise and precise definition of the functionality of the FunnelWeb literate programming preprocessor. You should refer to this manual when you have specific technical questions about FunnelWeb. The SEARCH facility in the margin provides a quick way to find what you need quickly. If you are not already familiar with FunnelWeb, you may wish to refer to the FunnelWeb Tutorial Manual which provides a structured introduction to FunnelWeb, along with lots of examples and application-specific information. If you want to compile FunnelWeb, refer to the FunnelWeb Developer Manual

1 Introduction

1.1 Notation
1.2 Terminology
1.3 An Architectural Overview
1.4 Diagnostics
1.5 Typesetter Independence

2 Command Line Interface

2.1 Invoking FunnelWeb
2.2 Command Line Arguments
2.3 Options
2.4 File Name Inheritance
2.5 FunnelWeb Startup

3 Scanner

3.1 Basic Input File Processing
3.2 Special Sequences
3.3 Setting the Special Character
3.4 Inserting the Special Character into the Text
3.5 Inserting Arbitrary Characters into the Text
3.6 Comments
3.7 Quick Names
3.8 Inserting End of Line Markers
3.9 Suppressing End of Line Markers
3.10 Include Files
3.11 Pragmas
3.12 Pragma: Indentation
3.13 Pragma: Maximum Input Line Length
3.14 Pragma: Maximum Output File Line Length
3.15 Pragma: Typesetter
3.16 Freestanding Typesetter Directives
3.17 New Page Directives
3.18 Table of Contents
3.19 Vertical Skip
3.20 Title
3.21 Scanner/Parser Interface

4 Parser

4.1 Introduction
4.2 High Level Structure
4.3 Free Text
4.4 Typesetter Directives
4.5 Section Directive
4.6 Literal Directive
4.7 Emphasis Directive
4.8 Macros
4.9 Macro Names
4.10 Formal Parameter Lists
4.11 Expressions
4.12 Macro Calls
4.13 Macro Formal Parameters
4.14 Macros Are Static

5 Analyser

6 Tangle

7 Weave

8 FunnelWeb Shell

8.1 Introduction
8.2 Return Statuses
8.3 Command Line Length
8.4 String Substitution
8.5 How a Command Line is Processed
8.6 Options

9 Shell Commands

9.1 Introduction
9.2 Absent
9.3 Codify
9.4 Compare
9.5 Define
9.6 Diff
9.7 Diffsummary
9.8 Diffzero
9.9 Eneo
9.10 Execute
9.11 Exists
9.12 Fixeols
9.13 Fw
9.14 Help
9.15 Here
9.16 Quit
9.17 Set
9.18 Show
9.19 Skipto
9.20 Status
9.21 Tolerate
9.22 Trace
9.23 Write
9.24 Writeu

10 Glossary

11 References

Webmaster Copyright © Ross N. Williams 1992,1999. All rights reserved.