summaryrefslogtreecommitdiff
path: root/web/fmweb/fmweb.README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /web/fmweb/fmweb.README
Initial commit
Diffstat (limited to 'web/fmweb/fmweb.README')
-rw-r--r--web/fmweb/fmweb.README32
1 files changed, 32 insertions, 0 deletions
diff --git a/web/fmweb/fmweb.README b/web/fmweb/fmweb.README
new file mode 100644
index 0000000000..746fe9dd8f
--- /dev/null
+++ b/web/fmweb/fmweb.README
@@ -0,0 +1,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)
+