summaryrefslogtreecommitdiff
path: root/web/fmweb/fmweb.README
blob: 746fe9dd8fb5d28dcd7d0ba8baa80ba3f30cbd61 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
fmweb is an attempt to do literate programming  using FrameMaker.
(The term web does not indicate any connection to the World Wide Web -
please see the comp.programming.literate FAQ for details on "web" tools.)

The fundamental problem I have with traditional web tools is that
the web text looks like a mess, because  it has code as well as
documentation with formatting data all in the soup. I prefer WYSIWIG 
documentation systems over TeX, where formatting meta-information does 
not clutter up your thinking.

fmweb allows you to write your code in a way that it looks exactly like
the WEB system's output from the outset. It supports output to multiple files,
is language independent, and doesn't care how many  figures or fonts you
use. 

The three files in this distribution are -
    fmweb.mif - a FrameMaker 4 document containing everything - including
                a perl5 fmweb script.
    fmweb.ps  - a postscript print of this document for those who don't
                have Frame, but want to have a look at the approach.
    fmweb.README - this file.


Please send comments/ideas/flames to sriram@tcs.com. I am exploring usage
of such an approach for largish systems. I would like to know what
people who use the traditional WEB approach think of the workability of
this approach.

Sriram Srinivasan
July 9, 1995
(sriram@tcs.com)