Reference Developer Tutorial 1 Introduction 2 Macros 3 Typesetting 4 Example 5 Hints 6 Examples 7 Webmaking SEARCH

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

THIS TUTORIAL MANUAL provides a friendly introduction to the FunnelWeb literate programming preprocessor

This Tutorial Manual does not provide a definitive description of FunnelWeb, so if you have a specific technical question, you should refer to the FunnelWeb Reference Manual, which is definitive. To perform a keyword search of the Reference Manual and/or this Tutorial manual, click on SEARCH in the margin.

1 Introduction

1.1 What Is Literate Programming?
1.2 What Is FunnelWeb?
1.3 The Name FunnelWeb
1.4 Using These Tutorials
1.5 A Hello World Document

2 Macro Facilities Tutorial

2.1 Simple Macros
2.2 Number of Times Called
2.3 Indentation
2.4 Additive Macros
2.5 Parameterized Macros
2.6 Library Macros
2.7 Macro Expansion
2.8 Include Files

3 Typesetting Facilities Tutorial

3.1 Overview
3.2 Typesetter Independence
3.3 Hierarchical Structure
3.4 Understanding the Printed Documentation
3.5 Literals and Emphasis
3.6 Adding A Header Page
3.7 Comments

4 A Complete Example

5 FunnelWeb Hints

5.1 Macro Names
5.2 Quick Names
5.3 FunnelWeb the Martinet
5.4 Fiddling With End of Lines
5.5 Fudging Conditionals
5.6 Changing the Strength of Headings
5.7 Efficiency Notes
5.8 Interactive Mode
5.9 Setting Up Default Options
5.10 FunnelWeb and Make
5.11 The Dangers Of FunnelWeb
5.12 Wholistic Debugging
5.13 TABs
5.14 HTML Style
5.15 A FunnelWeb Mode For Emacs

6 Examples of FunnelWeb Applications

6.1 Analyzing the Monster Postscript Header File
6.2 Making Ada ADTs More Abstract
6.3 Multiple Language Systems
6.4 The Case of the Small Function
6.5 When Comments are Bad
6.6 Documents That Share Text
6.7 Generics

7 Making Webs With FunnelWeb

7.1 Introduction
7.2 Getting Started
7.3 Replacing Messy HTML Constructs
7.4 Avoiding Errors And Inconsistencies
7.5 Defining A Consistent Style
7.6 Defining Macro Libraries
7.7 Parameterizing Entire Webs
7.8 Hints And Conventions

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