home *** CD-ROM | disk | FTP | other *** search
/ ftp.pasteur.org/FAQ/ / ftp-pasteur-org-FAQ.zip / FAQ / literate-programming-faq < prev    next >
Encoding:
Internet Message Format  |  2004-05-25  |  65.4 KB
  1. Path: senator-bedfellow.mit.edu!dreaderd!not-for-mail
  2. Message-ID: <literate-programming-faq_1075625008@rtfm.mit.edu>
  3. Supersedes: <literate-programming-faq_1074244461@rtfm.mit.edu>
  4. Expires: 1 Mar 2004 08:43:28 GMT
  5. X-Last-Updated: 2000/03/16
  6. From: thompson@shelob.ce.ttu.edu
  7. Organization: Texas Tech University, Lubbock, Texas, USA
  8. Newsgroups: comp.programming.literate,comp.answers,news.answers
  9. Subject: comp.programming.literate FAQ
  10. Followup-To: comp.programming.literate
  11. Reply-To: thompson@shelob.ce.ttu.edu
  12. Approved: news-answers-request@MIT.Edu
  13. Summary: Literate Programming FAQ
  14. Distribution: world
  15. Originator: faqserv@penguin-lust.MIT.EDU
  16. Date: 01 Feb 2004 08:43:46 GMT
  17. Lines: 2618
  18. NNTP-Posting-Host: penguin-lust.mit.edu
  19. X-Trace: 1075625026 senator-bedfellow.mit.edu 574 18.181.0.29
  20. Xref: senator-bedfellow.mit.edu comp.programming.literate:5657 comp.answers:56121 news.answers:265541
  21.  
  22. Archive-name: literate-programming-faq
  23. Last-modified: 2000/03/15
  24. Version: 1.3.1
  25.  
  26. The Literate Programming FAQ
  27.   David B. Thompson <thompson@shelob.ce.ttu.edu>
  28.   Version: 1.3.1, Mar 15, 2000
  29.  
  30.   The purpose of this document is two-fold: First, there is a need to
  31.   present a basic description of literate programming and how applica-
  32.   tion of literate programming principles can improve the resulting
  33.   code.  Second, there is a need to present a list of tools available 
  34. to
  35.   iterate programmers.  Hopefully, this document will meet both needs.
  36.   ____________________________________________________________________
  37. __
  38.  
  39.   Table of Contents
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.   1. Welcome
  95.  
  96.      1.1 Disclaimer
  97.      1.2 Copyright
  98.      1.3 What's New?
  99.      1.4 What's Needed?
  100.  
  101.   2. Introduction
  102.  
  103.   3. How do I get the FAQ?
  104.  
  105.      3.1 Literate Programming FAQ
  106.  
  107.   4. Is there a newsgroup?
  108.  
  109.   5. What internet nodes are of interest to literate programmers?
  110.  
  111.      5.1 Web Ring
  112.      5.2 The Literate Programming Archive (LPA)
  113.      5.3 Comprehensive TeX Archive Network (CTAN)
  114.  
  115.   6. What is Literate Programming?
  116.  
  117.   7. How do I begin literate programming?
  118.  
  119.   8. Important and Actively-Supported Tools
  120.  
  121.      8.1 CWEB
  122.      8.2 CWEBx3.0
  123.      8.3 FWEB
  124.      8.4 noweb
  125.      8.5 nuweb
  126.      8.6 ProTeX
  127.  
  128.   9. Unsupported Tools
  129.  
  130.      9.1 AFTWEB (Almost Free Text WEB)
  131.      9.2 APLWEB
  132.      9.3 CLiP
  133.      9.4 mCWEB
  134.      9.5 FunnelWeb
  135.      9.6 FunnelWeb 3.0AC
  136.      9.7 LEO
  137.      9.8 Literate Programmer's Workshop (LPW)
  138.      9.9 MapleWEB
  139.      9.10 Matlabweb
  140.      9.11 RWEB
  141.      9.12 SchemeWEB
  142.      9.13 SpideryWEB
  143.      9.14 WEB
  144.      9.15 WinWordWEB
  145.  
  146.   10. Are there other tools I should know about?
  147.  
  148.      10.1 C2LaTeX
  149.      10.2 c2cweb
  150.      10.3 c2man
  151.      10.4 cnoweb
  152.      10.5 dpp
  153.      10.6 Fold2Web
  154.      10.7 Funnelweb Mode
  155.      10.8 noweb.el
  156.      10.9 noweb-outline.el
  157.      10.10 nuweb.el
  158.      10.11 Web mode
  159.  
  160.   11. What other resources are available?
  161.  
  162.      11.1 TeX Resources
  163.  
  164.   12. Are there any code examples?
  165.  
  166.   13. Bibliographies
  167.  
  168.   14. Other Opinions about Literate Programming
  169.  
  170.      14.1 van Ammers
  171.      14.2 Ramsey
  172.      14.3 My (Dave Thompson's) Experience
  173.      14.4 Others
  174.  
  175.   15. How to anonymously ftp
  176.  
  177.   16. Acknowledgements
  178.  
  179.   17. End notes
  180.  
  181.  
  182.  
  183.   ____________________________________________________________________
  184. __
  185.  
  186.   1.  Welcome
  187.  
  188.   Information contained in this document is the best available at
  189.   preparation.  The original file was dated October 15, 1993 (just for
  190.   historical purposes).
  191.  
  192.  
  193.   1.1.  Disclaimer
  194.  
  195.   This FAQ is presented with no warranties or guarantees of ANY KIND
  196.   including correctness or fitness for any particular purpose.  The
  197.   author of this document has attempted to verify correctness of the
  198.   data contained herein; however, slip-ups can and do happen.  If you
  199.   use this data, you do so at your own risk.
  200.  
  201.  
  202.   1.2.  Copyright
  203.  
  204.   Copyright 1993-2000 by David B. Thompson.  All rights reserved
  205.   worldwide. Permission is granted to copy this document for free
  206.   distribution so long as it remains intact and unmodified.  For other
  207.   arrangements, contact the author/maintainer via email:
  208.   <thompson@shelob.ce.ttu.edu>
  209.  
  210.  
  211.  
  212.   1.3.  What's New?
  213.  
  214.  
  215.   o  Updated dpp entry.  See Section ``dpp''
  216.  
  217.   o  Added noweb-outline.el entry.  See section ``noweb-outline.el''
  218.  
  219.  
  220.   1.4.  What's Needed?
  221.  
  222.  
  223.   o  I've checked some of the links to software.  If anyone finds the
  224.      FAQ useful, please let me know if the links are active or dead 
  225. when
  226.      you're surfing.
  227.  
  228.   o  Some authors have disappeared.  If you know one of them, or are 
  229. an
  230.      author (and wish to remain in contact ;), then please provide
  231.      current contact information.
  232.  
  233.   o  I could use some feedback on the state of the FAQ.  It's about as
  234.      complete as I know how to make it.
  235.  
  236.  
  237.  
  238.   2.  Introduction
  239.  
  240.   Literate programming is a phrase coined by Donald Knuth to describe
  241.   the approach of developing computer programs from the perspective 
  242. of a
  243.   report or prose.  The focus, then, is on description (and
  244.   documentation) of the approach in human-readable form. This is in
  245.   contrast to the normal approach of focusing on the code.
  246.  
  247.   This document is for new and experienced users of literate 
  248. programming
  249.   tools.  The purpose is to explain the concept of literate 
  250. programming
  251.   and to provide a resource for locating resources of interest to
  252.   literate programmers and those interested in literate programming.
  253.  
  254.   The Literate Programming (LitProg) Frequently Asked Questions (FAQ)
  255.   list is maintained by Dave Thompson <thompson@shelob.ce.ttu.edu>.
  256.  
  257.   Comments and constructive criticisms are welcome.  Direct flames to
  258.   /dev/null (or nul if you're a msdos user! ;-) If you find an error,
  259.   please report it.  I'm particularly interested in establishing the
  260.   locations of generally available literate programming tools.  If you
  261.   are the author of such a tool and wish to have it included in this
  262.   list, please send email.
  263.  
  264.   Please note this is a work-in-progress.  It is not complete, and
  265.   probably will never be complete.  Nevertheless, the information
  266.   contained herein may be useful to some.  Use it as it is intended.
  267.  
  268.  
  269.  
  270.   3.  How do I get the FAQ?
  271.  
  272.   3.1.  Literate Programming FAQ
  273.  
  274.   You have many ways to get a current copy of this FAQ.  One is to use
  275.   anonymous ftp (if you don't know how, see a later section in this 
  276. FAQ)
  277.   to connect to one of the ``Comprehensive TeX Arvchive Network'' 
  278. sites
  279.   or the Literate Programming Archive and retrieve a copy of the file.
  280.   Open an ftp connection to one of the CTAN sites and retrieve the 
  281. file
  282.   help/comp.programming.literate_FAQ.
  283.  
  284.   Cesar Bellardini cballard@santafe.com.ar prepared a translation of 
  285. the
  286.   FAQ into Spanish.  It's available at
  287.  
  288.   (For more information on CTAN and the literate programming archive,
  289.   see the section below entitled ``Internet Nodes of Interest to
  290.   Literate Programmers''.)
  291.  
  292.  
  293.  
  294.   4.  Is there a newsgroup?
  295.  
  296.   One of the most important resources is the literate programming
  297.   newsgroup, comp.programming.literate.  Because of the amount of
  298.   spamming and unrelated posts, the newsgroup is now moderated.  You 
  299. can
  300.   read this newsgroup using your standard reader.
  301.  
  302.  
  303.   5.  What internet nodes are of interest to literate programmers?
  304.  
  305.   The principal nodes of interest to literate programmers are the
  306.   Literate Programming Archive (LPA hereafter) and the CTAN
  307.   (Comprehensive TeX Archive Network).
  308.  
  309.  
  310.  
  311.   5.1.  Web Ring
  312.  
  313.  
  314.   There is a web ring for literate programming.  It is at the URL
  315.   www.webring.org/cgi-bin/webring?ring=litprog;list
  316.  
  317.  
  318.  
  319.   5.2.  The Literate Programming Archive (LPA)
  320.  
  321.   The Literate Programming Archive (LPA) is:
  322.  
  323.   o  Node: ftp.th-darmstadt.de [130.83.55.75]
  324.  
  325.   o  Directory: /pub/programming/literate-programming
  326.  
  327.   o  Notes: Fastest response during off-U.S.  [yep] business hours.
  328.  
  329.   However, the LPA seems to be defunct in that no files are available 
  330. in
  331.   the /pub directory.  If anyone knows anything about the status of 
  332. the
  333.   LPA, please send email.
  334.  
  335.  
  336.  
  337.   5.3.  Comprehensive TeX Archive Network (CTAN)
  338.  
  339.   Participating hosts in the Comprehensive TeX Archive Network are 
  340. (from
  341.   the file CTAN.sites):
  342.  
  343.   o  ftp.dante.de (Mainz, Germany)
  344.  
  345.   o  anonymous ftp /tex-archive (/pub/tex /pub/archive)
  346.  
  347.   o  Gopher: gopher.dante.de
  348.  
  349.   o  e-mail ftpmail@dante.de
  350.  
  351.   o  WWW www.tex.ac.uk
  352.  
  353.   o  Administrator: <ftpmaint@dante.de>
  354.  
  355.   o  ftp.tex.ac.uk (Cambridge, UK)
  356.  
  357.   o  anonymous ftp /tex-archive (/pub/tex /pub/archive)
  358.  
  359.   o  Gopher: gopher.tex.ac.uk
  360.  
  361.   o  NFS mountable from nfs.tex.ac.uk:/public/ctan/tex-archive
  362.  
  363.   o  WWW www.tex.ac.uk
  364.  
  365.   o  Administrator: <ctan-uk@tex.ac.uk>
  366.  
  367.   o  ctan.tug.org (Boston, Massachusetts, USA)
  368.  
  369.   o  anonymous ftp /tex-archive (/pub/archive)
  370.  
  371.  
  372.   o  WWW ctan.tug.org
  373.  
  374.   o  Administrator: <ctan@tug.org>
  375.  
  376.   The pointer, ftp://ftp.cdrom.com/pub/tex/ctan/CTAN.sites, is 
  377. directed
  378.   to the official list of CTAN archive sites and their mirrors.
  379.  
  380.  
  381.  
  382.   6.  What is Literate Programming?
  383.  
  384.   Literate programming is the combination of documentation and source
  385.   together in a fashion suited for reading by human beings.  In fact,
  386.   literate programs should be enjoyable reading, even inviting!  
  387. (Sorry
  388.   Bob, I couldn't resist!)  In general, literate programs combine 
  389. source
  390.   and documentation in a single file.  Literate programming tools then
  391.   parse the file to produce either readable documentation or 
  392. compilable
  393.   source.  The WEB style of literate programming was created by D.E.
  394.   Knuth during the development of his TeX typsetting software.
  395.  
  396.   All the original work revolves around a particular literate
  397.   programming tool called WEB.  Knuth says:
  398.  
  399.        The philosophy behind WEB is that an experienced system pro-
  400.        grammer, who wants to provide the best possible documenta-
  401.        tion of his or her software products, needs two things
  402.        simultaneously: a language like TeX for formatting, and a
  403.        language like C for programming.  Neither type of language
  404.        can provide the best documentation by itself; but when both
  405.        are appropriately combined, we obtain a system that is much
  406.        more useful than either language separately.
  407.  
  408.  
  409.  
  410.        The structure of a software program may be thought of as a
  411.        web that is made up of many interconnected pieces.  To docu-
  412.        ment such a program we want to explain each individual part
  413.        of the web and how it relates to its neighbours. The typo-
  414.        graphic tools provided by TeX give us an opportunity to
  415.        explain the local structure of each part by making that
  416.        structure visible, and the programming tools provided by
  417.        languages such as C or Fortran make it possible for us to
  418.        specify the algorithms formally and unambigously. By combin-
  419.        ing the two, we can develop a style of programming that max-
  420.        imizes our ability to perceive the structure of a complex
  421.        piece of software, and at the same time the documented pro-
  422.        grams can be mechanically translated into a working software
  423.        system that matches the documentation.
  424.  
  425.  
  426.   See Section ``Other Opinions'' for some additional thoughts on
  427.   literate programming.
  428.  
  429.  
  430.  
  431.   7.  How do I begin literate programming?
  432.  
  433.   I've given considerable thought as to what should be in this section
  434.   of the FAQ.  This is probably the most important section of this
  435.   document.  My suggestion is that you review Section ``Supported
  436.   Tools'' and Section ``Unsupported Tools'' to choose a system
  437.   appropriate for the kind of development you do.  Then, use the 
  438. manual
  439.   that accompanies the system to determine how it complements your
  440.   development style.
  441.  
  442.  
  443.   Both Eric van Ammers, Section ``van Ammers'', and Norman Ramsey,
  444.   Section ``Ramsey'', wrote some thoughts on literate programming.  
  445. I've
  446.   included these thoughts in Section ``Other Opinions'' below.
  447.  
  448.   I started with a pretty-printing tool, Section ``cnoweb'', as a test
  449.   of the utility of interweaving significant documentation with code.
  450.   My experience is detailed in Section ``Thompson''.
  451.  
  452.   Wayne Sewell's (1989) Weaving a Program: Literate Programming in 
  453. WEB.
  454.   Van Nostrand Reinhold, ISBN 0-442-31946-0 (pbk).   This book focuses
  455.   on using Knuth's web system.
  456.  
  457.   I've read D. E. Knuth's collection of articles (1992) entitled
  458.   Literate Programming. Center for the Study of Language and
  459.   Information, Stanford University, ISBN 0-937073-80-6 (pbk).  This 
  460. book
  461.   gives insight into Knuth's thoughts as he developed the web system 
  462. of
  463.   literate programming (and TeX for typesetting).  However, it does 
  464. not
  465.   document methods for literate programming.
  466.  
  467.   Some talk exists in the newsgroup/mailing list for a Usenet 
  468. University
  469.   course in literate programming.  I'm sure discussion of this topic
  470.   will be welcomed.  (1Feb2000: Note this thread has been dead for a
  471.   long, long time.  I wish someone would pick it up.)
  472.  
  473.  
  474.  
  475.   8.  Important and Actively-Supported Tools
  476.  
  477.   I have selected a few of the tools from my list that appear to be 
  478. most
  479.   actively supported.  Inclusion here does not imply endorsement;
  480.   exclusion does not imply lack of quality.
  481.  
  482.  
  483.   8.1.  CWEB
  484.  
  485.  
  486.      Developer:
  487.         Silvio Levy and D.E. Knuth
  488.  
  489.      Version:
  490.         3.5
  491.  
  492.      Hardware:
  493.         Unix systems (dos and amiga ports available)
  494.  
  495.      Languages:
  496.         C and C++
  497.  
  498.      Formatter:
  499.         Plain TeX and LaTeX.
  500.  
  501.      Availability:
  502.         Anonymous ftp from:
  503.  
  504.      o  ftp://labrea.stanford.edu:/pub/cweb
  505.  
  506.      o  LPA:/c.c++
  507.  
  508.      o  CTAN:/web/c_cpp/cweb
  509.  
  510.      o  DOS version is no longer available.
  511.  
  512.      o  Win32 version www.literateprogramming.com
  513.  
  514.      o  Amiga version from Aminet:dev/c.
  515.  
  516.      o  Mac port of CTANGLE in LPA:/machines/mac
  517.  
  518.      o  LaTeX support in LPA:/c.c++
  519.  
  520.      Readme:
  521.         Bundled with above
  522.  
  523.      Description:
  524.         No description provided.
  525.  
  526.      Support:
  527.         Bugs to <levy@math.berkeley.edu>
  528.  
  529.  
  530.   8.2.  CWEBx3.0
  531.  
  532.  
  533.      Developer:
  534.         Marc van Leeuwen
  535.  
  536.      Version:
  537.         3.04
  538.  
  539.      Hardware:
  540.         Any system using ASCII code
  541.  
  542.      Languages:
  543.         ANSI C
  544.  
  545.      Formatter:
  546.         Plain TeX
  547.  
  548.      Availability:
  549.         Anonymous ftp from:
  550.  
  551.      o  wwwmathlabo.univ-poitiers.fr/~maavl/CWEBx/
  552.  
  553.      Readme:
  554.         Bundled with above
  555.  
  556.      Brief description:
  557.         A modified implementation of CWEB, with some extensions.
  558.         Provides a mode for full compatibility with Levy/Knuth CWEB. 
  559. The
  560.         most significant extras are:
  561.  
  562.      o  Typedef declarations affect formatting througout source file
  563.  
  564.      o  Include files are scanned for typedef definitions
  565.  
  566.      o  Flexible selection of layout style
  567.  
  568.      o  Possibility to refer to sections using symbolic labels
  569.  
  570.      o  CTANGLE detects unbalanced braces and parentheses
  571.  
  572.      o  CWEAVE can be made to report syntax errors more easily
  573.  
  574.      o  Some additional mechanisms to avoid formatting problems
  575.  
  576.      o  New and modular set of grammar rules, based on ANSI C syntax
  577.  
  578.      o  Possibility to suppress #line directives
  579.  
  580.      o  A new manual
  581.  
  582.  
  583.      Support:
  584.         bugs and remarks to maavl@mathlabo.univ-poitiers.fr
  585.  
  586.  
  587.   8.3.  FWEB
  588.  
  589.  
  590.      Developer:
  591.         John A. Krommes
  592.  
  593.      Version:
  594.         1.62
  595.  
  596.      Hardware:
  597.         Unix, VMS, and DOS platforms (anything with ANSI C)
  598.  
  599.      Languages:
  600.         C, C++, Fortran-77, Fortran-90, Ratfor, TeX; also, a anguage-
  601.         independent mode.
  602.  
  603.      Formatter:
  604.         LaTeX.  Plain TeX may work, but is no longer supported.
  605.  
  606.      Availability:
  607.         Anonymous ftp from:
  608.  
  609.      o  ftp.pppl.gov/pub/fweb
  610.  
  611.      o  CTAN:/web/fweb
  612.  
  613.      o  msdos version on ftp.ppl.gov site
  614.  
  615.      Readme:
  616.         In bundle with above.
  617.  
  618.      Description:
  619.         It also has a well-developed user's manual and its own FAQ 
  620. (see
  621.         above).  Beginning with 1.40, documentation is maintained in 
  622. gnu
  623.         texinfo format.  It runs on most platforms: VMS, PC, UNIX, and
  624.         pretty much anything that the GNU C compiler (GCC) is 
  625. supported
  626.         for.
  627.  
  628.      Features:
  629.  
  630.      o  Processes multiple languages during a single run (so one can 
  631. mix
  632.         C and Fortran, for example).
  633.  
  634.      o  Language-independent mode (v1.40).
  635.  
  636.      o  Ability to turn off pretty-printing (v1.40).
  637.  
  638.      o  Built-in Ratfor translator.
  639.  
  640.      o  Built-in macro preprocessor (closely follows ANSI C, with
  641.         extensions).
  642.  
  643.      o  A style file that allows the user to adjust many parameters 
  644. and
  645.         behavior patterns of FWEB.
  646.  
  647.      o  Various operator-overloading features that provide additional
  648.         pretty-printing capabilities to languages such as C++ and
  649.         Fortran-90.
  650.  
  651.      o  Numerous miscellaneous features and command-line options.
  652.  
  653.  
  654.      Support:
  655.         Bug reports and suggestions to krommes@princeton.edu Online
  656.         documentation is available at
  657.         w3.pppl.gov/%7ekrommes/fweb_toc.html
  658.  
  659.  
  660.   8.4.  noweb
  661.  
  662.  
  663.      Developer:
  664.         Norman Ramsey <nr@eecs.harvard.edu>
  665.  
  666.      Version:
  667.         2.9a
  668.  
  669.      Hardware:
  670.         Unix and DOS platforms (DOS binaries available for v2.7).
  671.  
  672.      Languages:
  673.         All programming languages, singly or in combination.  
  674. Automatic
  675.         indexing for C, Icon, Pascal, Standard ML, TeX, Yacc
  676.  
  677.      Formatter:
  678.         Plain TeX, LaTeX, and HTML formatters.  Will convert LaTeX to
  679.         HTML automatically.
  680.  
  681.      Availability:
  682.         Anonymous ftp from:
  683.  
  684.      o  CTAN:/web/noweb
  685.  
  686.      o  LPA:/independent
  687.  
  688.      o  Last recourse, use ftp.cs.virginia.edu:pub/nr
  689.  
  690.      Readme:
  691.         With bundle above, or see the noweb home page:
  692.         www.eecs.harvard.edu/~nr/noweb Those without http access can
  693.         consult ``Literate Programming Simplified,'' IEEE Software,
  694.         September 1994, pp97-105, or ``Literate Programming Using
  695.         Noweb,'' Linux Journal, October 1997, pp64-69.
  696.  
  697.  
  698.      Description:
  699.         Noweb is designed to meet the needs of literate programmers
  700.         while retaining the simplest possible input format.  Its 
  701. primary
  702.         advantages are simplicity, extensibility, and language-
  703.         independence.  Noweb uses 5 control sequences to WEB's 27.  
  704. The
  705.         noweb manual is only 3 pages; an additional page explains how 
  706. to
  707.         customize its LaTeX output.  Noweb works ``out of the box'' 
  708. with
  709.         any programming language, and supports TeX, latex, and HTML 
  710. back
  711.         ends.  A back end to support full hypertext or indexing takes
  712.         about 250 lines; a simpler one can be written in 40 lines of
  713.         awk. Unlike WEB, Noweb does not have prettyprinting built in,
  714.         but there are several third-party extensions that provide
  715.         prettyprinting, includeing dpp, pretzel, and nwpp.
  716.  
  717.  
  718.         Noweb supports indexing and identifier cross-reference,
  719.         including hypertext ``hot links.'' noweb includes a simple,
  720.         efficient LaTeX-to-HTML converter, so you can use hypertext
  721.         browsers on your legacy documents.  Noweb can also process 
  722. nuweb
  723.         programs, so you can use noweb to convert a standard nuweb
  724.         program to HTML with one command.
  725.  
  726.  
  727.      Support:
  728.         email to the author
  729.  
  730.  
  731.   8.5.  nuweb
  732.  
  733.  
  734.      Developer:
  735.         Preston Briggs: <preston@cs.rice.edu>
  736.  
  737.      Version:
  738.         0.87
  739.  
  740.      Hardware:
  741.         Unix systems: Sparcs, RS/6000s, HPs; (!) MSDOS and Amiga.
  742.  
  743.      Languages:
  744.         Any programming language or combination of programming
  745.         languages.
  746.  
  747.      Formatter:
  748.         Latex
  749.  
  750.      Availability:
  751.         Anonymous ftp from:
  752.  
  753.      o  Unix: CTAN:/web/nuweb
  754.  
  755.      o  DOS:  CTAN:/web/nuweb-pc
  756.  
  757.      o  LPA:/independent
  758.  
  759.      o  Amiga: CTAN:/web/nuweb/nuweb_ami
  760.  
  761.      o  Amiga: wuarchive.wustl.edu/pub/aminet
  762.  
  763.      Readme:
  764.         Send mail to <preston@cs.rice.edu>
  765.  
  766.  
  767.      Description:
  768.         A single program that takes a web file written in a 
  769. combination
  770.         of latex and any programming language(s) and produces a latex
  771.         file that can be pretty printed and a set of files containing
  772.         code for compilation/interpretation by the appropriate 
  773. language
  774.         processors.
  775.  
  776.  
  777.         Strengths include speed, simplicity, multiple languages, nice
  778.         indices and cross-references, latex.  Doesn't require any
  779.         special macros or macro files.
  780.  
  781.  
  782.         Drawbacks: latex-dependent, no code pretty printing, harder to
  783.         make indices than cweb.
  784.  
  785.  
  786.         More good stuff: nice support for make, doesn't reformat 
  787. source
  788.         files, so they're easy to debug.  Lots of control without too
  789.         much effort.  That is, it doesn't do too much!
  790.  
  791.  
  792.         Future directions... Very little change planned, except 
  793. perhaps
  794.         refinements in the indexing software.
  795.  
  796.  
  797.      Support:
  798.         Hack it yourself or send e-mail to <preston@cs.rice.edu>
  799.  
  800.  
  801.   8.6.  ProTeX
  802.  
  803.  
  804.      Developer:
  805.         Eitan Gurari <gurari@cis.ohio-state.edu>
  806.  
  807.      Version:
  808.         ProTeX 1.5,  AlProTeX 2.3
  809.  
  810.      Hardware:
  811.         Any platform with (La)TeX
  812.  
  813.      Languages:
  814.         Any language
  815.  
  816.      Formatter:
  817.         TeX or LaTeX
  818.  
  819.      Availability:
  820.         Anonymous ftp from:
  821.  
  822.      o  www.cis.ohio-state.edu/~gurari/systems.html
  823.  
  824.      o  LPA:/independent
  825.  
  826.      Readme:
  827.         With bundle above
  828.  
  829.      Description:
  830.  
  831.      o  Easy to use
  832.  
  833.      o  Extensible
  834.  
  835.      o  Language independent
  836.  
  837.      o  Multiple output files
  838.  
  839.      o  Fast (single compilation provides output and dvi files)
  840.  
  841.      o  Option for XHTML and pdf files
  842.  
  843.      o  No installation is needed besides copying the files (written 
  844. in
  845.         TeX) Introduction of main features and examples on web site
  846.         above.  Complete manual in Eitan M. Gurari, "TeX and LaTeX:
  847.         Drawing and Literate Programming", McGraw-Hill, 1994
  848.  
  849.      Support:
  850.         <gurari@cis.ohio-state.edu>
  851.  
  852.  
  853.  
  854.   9.  Unsupported Tools
  855.  
  856.  
  857.  
  858.   9.1.  AFTWEB (Almost Free Text WEB)
  859.  
  860.  
  861.      Developer:
  862.         Todd A. Coram
  863.  
  864.      Version:
  865.         4.6
  866.  
  867.      Hardware:
  868.         Linux, Unix, MSDOS Any system with Perl, and a C++ compiler 
  869. with
  870.         STL (such as gcc 2.7.2).
  871.  
  872.      Languages:
  873.         Any (C/C++ support supplied)
  874.  
  875.      Formatter:
  876.         LaTeX or HTML by way of AFT.
  877.  
  878.      Availability:
  879.         www.mindspring.com/~coram/aft.html
  880.  
  881.      Readme:
  882.         Bundled with above.
  883.  
  884.  
  885.      Brief description:
  886.         AFTWEB uses a CWEB-like syntax. It uses AFT for documentation
  887.         markup (AFT is a minimalistic, yet powerful, markup language
  888.         with very few commands).  AFTWEB was written in AFTWEB (using
  889.         C++) and the weaved document is available online (as HTML) at
  890.         the URL listed above.
  891.  
  892.  
  893.         Support for C and C++ is supplied. You can easily support 
  894. other
  895.         languages (such as Java and Perl) by writing a new language
  896.         description file.
  897.  
  898.  
  899.         The markup language AFT is very easy to learn and is available
  900.         at the same URL as AFTWEB.
  901.  
  902.  
  903.      Support:
  904.         Bugs to tcoram@pobox.com
  905.  
  906.  
  907.   9.2.  APLWEB
  908.  
  909.  
  910.      Developer:
  911.         Christoph von Basum
  912.  
  913.      Version:
  914.         Unknown
  915.  
  916.      Hardware:
  917.         MSDOS
  918.  
  919.      Languages:
  920.         IBM APL2 and STSC APL
  921.  
  922.      Formatter:
  923.         Plain TeX
  924.  
  925.      Availability:
  926.         Anonymous ftp from: watserv1.uwaterloo.ca:/languages/apl/aplwe
  927. b
  928.  
  929.      Readme:
  930.         At above ftp location.
  931.  
  932.  
  933.      Description:
  934.         None available.
  935.  
  936.      Support:
  937.         Unknown
  938.  
  939.      Note:
  940.         The status of this particular package is unknown.  It's at the
  941.         ftp site, but other than that I can't say.  Last known email
  942.         address of developer is CvB@erasmus.hrz.uni-bielefeld.de.
  943.  
  944.  
  945.   9.3.  CLiP
  946.  
  947.  
  948.      Developer:
  949.         E.W. van Ammers and M.R. Kramer
  950.  
  951.      Versions:
  952.         2.0 and 2.4b (DOS only)
  953.  
  954.      Platform:
  955.         Vax/VMS, Unix, DOS
  956.  
  957.      Languages:
  958.         Any programming language
  959.  
  960.      Formatter:
  961.         Any formatter (TeX, LaTeX, Troff, Runoff, HTML, etc) or any
  962.         wordprocessor including WYSIWYG systems (Word Perfect, 
  963. WinWord,
  964.         Ami Pro, Word Pro, etc.)
  965.  
  966.      Availability:
  967.         Anonymous ftp from:
  968.  
  969.      o  ftp://sun01.info.wau.nl:/CLIP/ms_dos
  970.  
  971.      o  ftp://sun01.info.wau.nl:/CLIP/ms_dos_24b
  972.  
  973.      o  ftp://sun01.info.wau.nl:/CLIP/vax_vms
  974.  
  975.      o  ftp://sun01.info.wau.nl:/CLIP/unix
  976.  
  977.      o  CTAN:/web/clip
  978.  
  979.      o  LPA:/machines/ms-dos
  980.  
  981.      o  LPA:/machines/vax
  982.  
  983.      Readme:
  984.         With bundle above
  985.  
  986.      Description:
  987.         CLiP does not use explicit commands to perform the extraction
  988.         process. Rather it recognizes pseudostatements written as
  989.         comments in the programming language in question. CLiP
  990.         distinguishes pseudostatements from ordinary comments because
  991.         the former comply with a particular style. This style can be
  992.         adjusted to suit virtually any programming language. The CLiP
  993.         approach to LP makes the system extremely versatile. It is
  994.         independent of programming language and text processing
  995.         environment. We designed CLiP to be compatible with hypertext
  996.         systems as well. Some hypertext examples are at:
  997.  
  998.      o  ftp://sun01.info.wau.nl/clip/html/queens.htm
  999.  
  1000.      o  ftp://sun01.info.wau.nl/clip/html/pal1.htm
  1001.  
  1002.      Features:
  1003.  
  1004.      o  CLiP imposes virtually no limitations on the text-processing
  1005.         system used to produce the documentation. If the 
  1006. text-processor
  1007.         supports these items you can
  1008.  
  1009.      o  structure the documentation according to your own taste.
  1010.  
  1011.      o  include drawings, pictures, tables etc.
  1012.  
  1013.      o  disclose your documentation my means of X-ref tables, Indexes,
  1014.         Table of contents, Table of tables, Table of figures, etc.
  1015.  
  1016.      o  typeset the documented code.
  1017.  
  1018.      o  Extracts any number of modules from a maximum of 64 source
  1019.         files.
  1020.  
  1021.      o  No pretty-printing. Code from the source files is copied "as 
  1022. is"
  1023.         to the module.
  1024.  
  1025.      o  Appearance of code segments in the documentation matches those
  1026.         of the modules to ease the identification of code segments.
  1027.  
  1028.      o  Supports partially specified data types.
  1029.  
  1030.      o  Comprehensive user manual (preliminary version) and technical
  1031.         description.
  1032.  
  1033.      o  No automatic generation of a X-ref table for program
  1034.         identifiers.
  1035.  
  1036.      Support:
  1037.         Bugs, problems and assistance by e-mail to
  1038.         <Eric.vanAmmers@user.info.wau.nl>
  1039.  
  1040.  
  1041.   9.4.  mCWEB
  1042.  
  1043.  
  1044.      Developer:
  1045.         Markus Oellinger
  1046.  
  1047.      Version:
  1048.         1.0
  1049.  
  1050.      Hardware:
  1051.         Unix
  1052.  
  1053.      Languages:
  1054.         C/C++
  1055.  
  1056.      Formatter:
  1057.         plain TeX
  1058.  
  1059.      Availability:
  1060.         anonymous ftp from ist.tu-
  1061.         graz.ac.at:/pub/utils/litprog/mcweb/mcweb.tgz
  1062.  
  1063.      Readme:
  1064.         at same location
  1065.  
  1066.      Description:
  1067.         This is mCWEB 1.0, a descendant of the CWEB system of 
  1068. structured
  1069.         documentation by Donald E. Knuth and Silvio Levy.  It adds 
  1070. some
  1071.         features that are indispensable when working in a team. mCWEB
  1072.         regards a project of a book consisting of several chapter 
  1073. files.
  1074.         By means of import and export commands, it automatically 
  1075. manages
  1076.         all relationships between the chapters of a book and to other
  1077.         books.
  1078.  
  1079.  
  1080.         Interface documentation is now also part of mCWEB. It is
  1081.         extracted into a second TeX file. This makes it possible to
  1082.         define well known interfaces between the individual parts of a
  1083.         project that will be implemented by different persons.
  1084.  
  1085.  
  1086.         In addition, mCWEB parses C header files to find out about all
  1087.         the datatypes defined there.
  1088.  
  1089.  
  1090.         mCWEB comes with a full completely rewritten user manual and 
  1091. is
  1092.         compatible with CWEB.
  1093.  
  1094.  
  1095.      Support:
  1096.         Institute of Software Technology, moell@ist.tu-graz.ac.at
  1097.  
  1098.  
  1099.   9.5.  FunnelWeb
  1100.  
  1101.  
  1102.      Developer:
  1103.         Ross N. Williams ross@ross.net
  1104.  
  1105.      Version:
  1106.         V3.2  (May 1999).
  1107.  
  1108.      Hardware:
  1109.         MS-DOS, MacOS, Win32, OpenVMS, Solaris, Red Hat Linux, BSD/OS,
  1110.         FreeBSD, Digital Unix, IRIX.
  1111.  
  1112.      Status:
  1113.         Open Source GNU.
  1114.  
  1115.      Languages:
  1116.         No restrictions.
  1117.  
  1118.      Formatter:
  1119.         Generates TeX and/or HTML
  1120.  
  1121.      Web:
  1122.         www.ross.net/funnelweb/
  1123.  
  1124.      Availability:
  1125.         ftp.ross.net/clients/ross/funnelweb/
  1126.  
  1127.      Readme:
  1128.         With bundle above.
  1129.  
  1130.  
  1131.      Description:
  1132.         FunnelWeb is a production-quality literate-programming tool 
  1133. that
  1134.         emphasises simplicity and reliability. Everything about
  1135.         FunnelWeb, from the simplicity of its language to the
  1136.         comprehensive tutorial in the user's manual, has been designed
  1137.         to make this as simple, as practical, and as usable a tool as
  1138.         possible.
  1139.  
  1140.      Features:
  1141.  
  1142.      o  Provides a simple macro preprocessor facility.
  1143.  
  1144.      o  Generates typeset documentation in TeX and/or HTML formats.
  1145.  
  1146.      o  Runs on a wide range of platforms.
  1147.  
  1148.      o  Portable C source code distributed under GNU licence.
  1149.  
  1150.      o  Comprehensively documented online:
  1151.  
  1152.      o  www.ross.net/funnelweb/tutorial/
  1153.  
  1154.      o  www.ross.net/funnelweb/reference/
  1155.  
  1156.      o  www.ross.net/funnelweb/developer/
  1157.  
  1158.      o  Programming-language independent.
  1159.  
  1160.      o  Mature and essentially bug-free (released 1992).
  1161.  
  1162.      o  Can generate multiple output files.
  1163.  
  1164.      o  Allows complete control over the output text.
  1165.  
  1166.      o  Also useful for generating web sites!
  1167.  
  1168.  
  1169.      Support:
  1170.         No formal support available.  Mailing list maintained with 
  1171. about
  1172.         50 subscribers.  Informal assistance available from mailing
  1173.         list.
  1174.  
  1175.  
  1176.   9.6.  FunnelWeb 3.0AC
  1177.  
  1178.  
  1179.      Developer:
  1180.         Enhanced by A.B.Coates coates@physics.uq.edu.au from FunnelWeb
  1181.         v3.0 by Ross N. Williams ross@guest.adelaide.edu.au
  1182.  
  1183.      Version:
  1184.         3.0AC
  1185.  
  1186.      Hardware:
  1187.         MSDOS, Mac, VMS, Sun, OSF/1, Linux, Sys.V, OS/2.
  1188.  
  1189.      Languages:
  1190.         No restrictions.
  1191.  
  1192.      Formatter:
  1193.         Tex, LaTeX, or HTML.
  1194.  
  1195.      Availability:
  1196.         Anonymous ftp from
  1197.         ftp.physics.uq.oz.au:/pub/funnelwebAC30.tar.gz
  1198.  
  1199.      Readme:
  1200.         With bundle above; for FunnelWeb manual see WWW page
  1201.         www.physics.uq.oz.au:8001/people/coates/funnelweb.html
  1202.  
  1203.  
  1204.      Description:
  1205.         FunnelWeb 3.0AC is an enhanced version of FunnelWeb (see the
  1206.         entry for FunnelWeb).  FunnelWeb is designed to be typesetter
  1207.         independent, though FunnelWeb v3.0 only supports (La)TeX as 
  1208. the
  1209.         typesetter.  FunnelWeb 3.0AC also supports HTML, and creates
  1210.         appropriate hypertext links within the document among the code
  1211.         sections.  FunnelWeb 3.0AC also supports automatic and manual
  1212.         insertion of line directives, so that compiler errors can be
  1213.         flagged back to the original FunnelWeb source file.  FunnelWeb
  1214.         3.0AC is completely compatible with FunnelWeb v3.0 sources 
  1215. (with
  1216.         one minor exception; see the file README.ABC which comes with
  1217.         the FunnelWeb 3.0AC distribution).
  1218.  
  1219.  
  1220.      Support:
  1221.         Supported by A.B.Coates coates@physics.uq.edu.au, subject to 
  1222. the
  1223.         time constraints imposed by his thesis.
  1224.  
  1225.  
  1226.   9.7.  LEO
  1227.  
  1228.  
  1229.      Developer:
  1230.         Edward K. Ream edream@mailbag.com
  1231.  
  1232.      Version:
  1233.         1.0
  1234.  
  1235.      Hardware:
  1236.         Windows
  1237.  
  1238.      Languages:
  1239.         Unknown
  1240.  
  1241.      Formatter:
  1242.         Unknown
  1243.  
  1244.      Availability:
  1245.         Contact the author or see
  1246.         www.mailbag.com/users/edream/front.html
  1247.  
  1248.      Readme:
  1249.         Unknown
  1250.  
  1251.      Description:
  1252.         See web site.
  1253.  
  1254.      Support:
  1255.         Unknown.
  1256.  
  1257.  
  1258.   9.8.  Literate Programmer's Workshop (LPW)
  1259.  
  1260.  
  1261.      Developer:
  1262.         Norbert Lindenberg
  1263.  
  1264.      Version:
  1265.         1.1
  1266.  
  1267.      Hardware:
  1268.         Apple Macintosh
  1269.  
  1270.      Languages:
  1271.         C++, Object Pascal & others
  1272.  
  1273.      Formatter:
  1274.         self-contained WYSIWYG system
  1275.  
  1276.      Availability:
  1277.         Anonymous ftp from:
  1278.  
  1279.      o  CTAN:/web/lpw
  1280.  
  1281.      o  ftp.apple.com:/pub/literate.prog
  1282.  
  1283.      Readme:
  1284.         With bundle above.  Also comes with 38-page manual.
  1285.  
  1286.  
  1287.      Description:
  1288.         The Literate Programming Workshop is an environment for the
  1289.         integrated development of program source text and 
  1290. documentation
  1291.         in combined documents. It consists of a WYSIWYG word processor
  1292.         based on a style sheet approach, a mechanism to extract parts 
  1293. of
  1294.         the text in a document, and a project management system that
  1295.         handles multi-document projects. The system is designed to be
  1296.         used in conjunction with the Macintosh Programmer's Workshop: 
  1297. it
  1298.         prepares raw source text for the MPW compilers, accepts MPW
  1299.         error messages, and shows them in the context of the original
  1300.         documents. Automatic indexing and hypertext features allow for
  1301.         easy access to both source text and documentation.
  1302.  
  1303.  
  1304.         LPW is shareware.
  1305.  
  1306.  
  1307.      Support:
  1308.         Bugs, problems, and questions to lpw@aol.com
  1309.  
  1310.  
  1311.   9.9.  MapleWEB
  1312.  
  1313.  
  1314.      Developer:
  1315.         Unknown
  1316.  
  1317.      Version:
  1318.         Unknown
  1319.  
  1320.      Hardware:
  1321.         Unknown
  1322.  
  1323.      Languages:
  1324.         Maple
  1325.  
  1326.      Formatter:
  1327.         Unknown
  1328.  
  1329.      Availability:
  1330.         Anonymous ftp from CTAN/maple/mapleweb
  1331.  
  1332.      Readme:
  1333.         Unknown
  1334.  
  1335.      Description:
  1336.         None
  1337.  
  1338.      Support:
  1339.         Unknown
  1340.  
  1341.  
  1342.  
  1343.  
  1344.  
  1345.   9.10.  Matlabweb
  1346.  
  1347.  
  1348.      Developer:
  1349.         Mark Potse
  1350.  
  1351.      Version:
  1352.         2.09
  1353.  
  1354.      Hardware:
  1355.         any, but only Unix tested & supported
  1356.  
  1357.      Languages:
  1358.         Matlab
  1359.  
  1360.      Formatter:
  1361.         Plain TeX and LaTeX.
  1362.  
  1363.      Availability:
  1364.         Anonymous ftp from the CTAN archives,
  1365.  
  1366.      Readme:
  1367.         Bundled with above
  1368.  
  1369.  
  1370.      Description:
  1371.         CWEB-like literate programming system for the Matlab language.
  1372.         Created with a modified version of the Spider system. Several
  1373.         more or less language-specific features:
  1374.  
  1375.      o  macros with multiple arguments
  1376.  
  1377.      o  comments and verbatim comments
  1378.  
  1379.      o  strings can be formatted as code, with help for nested 
  1380. strings,
  1381.         e.g. for callbacks in user interface programming.
  1382.  
  1383.      o  string arguments for macros, that get inserted in strings in 
  1384. the
  1385.         replacement text
  1386.  
  1387.      o  "@f foo TeX"  works as in recent versions of CWEB
  1388.  
  1389.      Support:
  1390.         not guaranteed. Try M.Potse@amc.uva.nl, comments are welcome.
  1391.  
  1392.  
  1393.   9.11.  RWEB
  1394.  
  1395.  
  1396.      Developer:
  1397.         Unknown
  1398.  
  1399.      Version:
  1400.         Unknown
  1401.  
  1402.      Hardware:
  1403.         Unknown
  1404.  
  1405.      Languages:
  1406.         Unknown
  1407.  
  1408.      Formatter:
  1409.         Unknown
  1410.  
  1411.      Availability:
  1412.         Anonymous ftp from CTAN
  1413.      Readme:
  1414.         Unknown
  1415.  
  1416.      Description:
  1417.         Web generator in AWK.
  1418.  
  1419.      Support:
  1420.         Unknown
  1421.  
  1422.  
  1423.   9.12.  SchemeWEB
  1424.  
  1425.  
  1426.      Developer:
  1427.         John D. Ramsdell
  1428.  
  1429.      Version:
  1430.         2.1
  1431.  
  1432.      Hardware:
  1433.         Unix and DOS platforms
  1434.  
  1435.      Languages:
  1436.         Any dialect of Lisp.
  1437.  
  1438.      Formatter:
  1439.         LaTeX.
  1440.  
  1441.      Availability:
  1442.         The Unix version is in the Scheme Repository and it is 
  1443. available
  1444.         via anonymous ftp from:
  1445.  
  1446.      o  cs.indiana.edu:/pub/scheme-repository/utl/schemeweb.sh
  1447.  
  1448.      o  CTAN:/tex-archive/web/schemeweb
  1449.  
  1450.      o  The DOS version is part of the PCS/Geneva Scheme system which 
  1451. is
  1452.         available via anonymous ftp from: cui.unige.ch:/pub/pcs
  1453.  
  1454.      Readme:
  1455.         In bundle with above.
  1456.  
  1457.      Description:
  1458.         SchemeWEB is a Unix filter that allows you to generate both 
  1459. Lisp
  1460.         and LaTeX code from one source file.  The generated LaTeX code
  1461.         formats Lisp programs in typewriter font obeying the spacing 
  1462. in
  1463.         the source file. Comments can include arbitrary LaTeX 
  1464. commands.
  1465.         SchemeWEB was originally developed for the Scheme dialect of
  1466.         Lisp, but it can easily be used with most other dialects.
  1467.  
  1468.      Support:
  1469.         Bug reports to ramsdell@mitre.org.
  1470.  
  1471.  
  1472.   9.13.  SpideryWEB
  1473.  
  1474.  
  1475.      Developer:
  1476.         Norman Ramsey <nr@eecs.harvard.edu>
  1477.  
  1478.      Version:
  1479.         Unknown
  1480.  
  1481.      Hardware:
  1482.         Unix and DOS platforms
  1483.  
  1484.      Languages:
  1485.         Most Algol-like languages, including C, Ada, Pascal, Awk, and
  1486.         many others.
  1487.  
  1488.      Formatter:
  1489.         Plain TeX and latex for text formatters.
  1490.  
  1491.      Availability:
  1492.         Anonymous ftp from CTAN.
  1493.  
  1494.      Readme:
  1495.         In distribution.
  1496.  
  1497.  
  1498.      Description:
  1499.         A system for building language-dependent WEBs. Spider is 
  1500. frozen;
  1501.         no further development is planned.
  1502.  
  1503.  
  1504.      Support:
  1505.         Bug reports to spider-bugs@oracorp.com.
  1506.  
  1507.  
  1508.   9.14.  WEB
  1509.  
  1510.  
  1511.      Developer:
  1512.         Donald Knuth
  1513.  
  1514.      Version:
  1515.         4.4 (apparently)
  1516.  
  1517.      Hardware:
  1518.         Any TeX system should have it.
  1519.  
  1520.      Languages:
  1521.         Pascal
  1522.  
  1523.      Formatter:
  1524.         TeX (of course! ;-)
  1525.  
  1526.      Availability:
  1527.         Distributed with TeX systems.  Also avaliable in source form
  1528.         from labrea.stanford.edu/tex/web.
  1529.  
  1530.      Readme:
  1531.         Unknown
  1532.  
  1533.      Documentation:
  1534.         Available from labrea.stanford.edu/tex/web/webman.tex
  1535.  
  1536.      Description:
  1537.         This is the original software that started it all.  The 
  1538. original
  1539.         TeX processor was written in WEB.
  1540.  
  1541.      Support:
  1542.         None known.
  1543.  
  1544.  
  1545.   9.15.  WinWordWEB
  1546.  
  1547.  
  1548.      Developer:
  1549.         Lee Wittenberg leew@pilot.njin.net
  1550.  
  1551.  
  1552.      Version:
  1553.         Unknown
  1554.  
  1555.      Hardware:
  1556.         Needs Microsoft Word for Windows, v.2.x, and, of course, MS-
  1557.         Windows 3.x.
  1558.  
  1559.      Languages:
  1560.         Any programming language.
  1561.  
  1562.      Formatter:
  1563.         Word for Windows 2.x for text formatting and file maintenance.
  1564.  
  1565.      Availability:
  1566.         samson.kean.edu:pub/leew
  1567.  
  1568.      Readme:
  1569.         WORDWEB.DOC in the downloadable package describes the system.
  1570.  
  1571.      Description:
  1572.         WinWordWEB is a set of a Word for Windows macros (plus a
  1573.         paragraph style) that provide a crude literate programming
  1574.         environment.  The ``look and feel'' of the system is based on
  1575.         Norman Ramsey's noweb, but can easily be modified to suit
  1576.         individual tastes.
  1577.  
  1578.      Support:
  1579.         None.  WinWordWEB was written as a prototype to see if a 
  1580. WYSIWYG
  1581.         literate programming system was possible.  It is intended as a
  1582.         jumping off point for future work by others. However, the 
  1583. system
  1584.         is surprisingly usable as it stands, and the author is
  1585.         interested in hearing from users (satisfied and dissatisfied).
  1586.  
  1587.  
  1588.         Anyone interested in actively supporting (and improving) the
  1589.         product should contact the author via email.
  1590.  
  1591.  
  1592.  
  1593.   10.  Are there other tools I should know about?
  1594.  
  1595.   Follows is a list of some not-quite-literate-programming tools.  
  1596. Some
  1597.   term these pretty-printers.  Others may call them literate 
  1598. programming
  1599.   tools.  In any event, they don't seem to be quite in the same 
  1600. category
  1601.   as the tools listed above, so I'll include them here.
  1602.  
  1603.  
  1604.   10.1.  C2LaTeX
  1605.  
  1606.  
  1607.      Developer:
  1608.         John D. Ramsdell
  1609.  
  1610.      Version:
  1611.         Unknown
  1612.  
  1613.      Hardware:
  1614.         Unix
  1615.  
  1616.      Languages:
  1617.         C
  1618.  
  1619.      Formatter:
  1620.         LaTeX but it's easy to change the formatter.
  1621.  
  1622.  
  1623.      Availability:
  1624.         Anonymous ftp from omnigate.clarkson.edu:/pub/tex/tex-
  1625.         programs/c2latex.
  1626.  
  1627.      Readme:
  1628.         Absent.  Documentation is in the C source for c2latex.
  1629.  
  1630.      Description:
  1631.         C2latex provides simple support for literate programming in C.
  1632.         Given a C source file in which the comments have been written 
  1633. in
  1634.         LaTeX, c2latex converts the C source file into a LaTeX source
  1635.         file.  It can be used to produce typeset listings of C 
  1636. programs
  1637.         and/or documentation associated with the program.
  1638.  
  1639.         C2latex produces LaTeX source by implementing a small number 
  1640. of
  1641.         rules.  A C comment that starts at the beginning of a line is
  1642.         copied unmodified into the LaTeX source file.  Otherwise, non-
  1643.         blank lines are surrounded by a pair of formatting commands
  1644.         (\begin{flushleft} and \end{flushleft}), and the lines are
  1645.         separated by \\*. Each non-blank line is formatted using 
  1646. LaTeX's
  1647.         \verb command, except comments within the line are formatted 
  1648. in
  1649.         an \mbox.
  1650.  
  1651.      Support:
  1652.         Send bug reports to ramsdell@mitre.org.
  1653.  
  1654.  
  1655.   10.2.  c2cweb
  1656.  
  1657.  
  1658.      Developer:
  1659.         Werner Lemberg
  1660.  
  1661.      Version:
  1662.         1.5
  1663.  
  1664.      Hardware:
  1665.         DOS, OS/2, Unix (gcc) - CWEB source included
  1666.  
  1667.      Languages:
  1668.         C, C++
  1669.  
  1670.      Formatter:
  1671.         TeX
  1672.  
  1673.      Availability:
  1674.         Anonymous ftp from CTAN:/web/c_cpp/c2cweb
  1675.  
  1676.      Readme:
  1677.         In distribution.
  1678.  
  1679.      Description:
  1680.         c2cweb will transform plain C or C++ code into a CWEB file to
  1681.         get a pretty formatted output. A modified CWEAVE (which
  1682.         transforms the CWEB file into a TeX file, see below) is 
  1683. included
  1684.         also.
  1685.  
  1686.      Support:
  1687.         Werner Lemberg <a7971428@unet.univie.ac.at>
  1688.  
  1689.  
  1690.   10.3.  c2man
  1691.  
  1692.  
  1693.      author:
  1694.         Graham Stoney <greyham@research.canon.oz.au>
  1695.      language:
  1696.         C, nroff, texinfo, latex, html
  1697.  
  1698.      version:
  1699.         2.0 patchlevel 33
  1700.  
  1701.      parts:
  1702.         documentation generator (C -> nroff -man, -> texinfo, ->latex,
  1703.         -> html)
  1704.  
  1705.      location:
  1706.         ftp from
  1707.  
  1708.      o  any comp.sources.misc archive, in volume42 (the version in the
  1709.         comp.sources.reviewed archive is obsolete)
  1710.  
  1711.      o  dnpap.et.tudelft.nl/pub/Unix/Util/ c2man-2.0.*.tar.gz
  1712.  
  1713.      o  Australia archie.au/usenet/comp.sources.misc/volume42
  1714.         c2man-2.0/*
  1715.  
  1716.      o  N.America ftp://ftp.wustl.edu/usenet/comp.sources.misc/volume4
  1717. 2/
  1718.         c2man-2.0/*
  1719.  
  1720.      o  Europe: ftp://ftp.irisa.fr/News/comp.sources.misc/volume42/
  1721.         c2man-2.0/*
  1722.  
  1723.      o  Japan:
  1724.         ftp://ftp.iij.ad.jp/pub/NetNews/comp.sources.misc/volume42/
  1725.         c2man-2.0/*
  1726.  
  1727.      Patches:
  1728.         lth.se/pub/netnews/sources.bugs/volume93/sep/c2man*
  1729.  
  1730.      description:
  1731.         c2man is an automatic documentation tool that extracts 
  1732. comments
  1733.         from C source code to generate functional interface
  1734.         documentation in the same format as sections 2 & 3 of the Unix
  1735.         Programmer's Manual. It requires minimal effort from the
  1736.         programmer by looking for comments in the usual places near 
  1737. the
  1738.         objects they document, rather than imposing a rigid function-
  1739.         comment syntax or requiring that the programmer learn and use 
  1740. a
  1741.         typesetting language. Acceptable documentation can often be
  1742.         generated from existing code with no modifications.
  1743.  
  1744.      conformance:
  1745.         supports both K&R and ISO/ANSI C coding styles
  1746.  
  1747.      features:
  1748.  
  1749.      o  generates output in nroff -man, TeXinfo, LaTeX or HTML format
  1750.  
  1751.      o  handles comments as part of the language grammar
  1752.  
  1753.      o  automagically documents enum parameter & return values
  1754.  
  1755.      o  handles C (/* */) and C++ (//) style comments
  1756.  
  1757.      o  doesn't handle C++ grammar (yet)
  1758.  
  1759.      requires:
  1760.         yacc/byacc/bison, lex/flex, and nroff/groff/texinfo/LaTeX.
  1761.  
  1762.      ports:
  1763.         Unix, OS/2, MSDOS, VMS.
  1764.  
  1765.      portability:
  1766.         very high for unix, via Configure
  1767.  
  1768.      status:
  1769.         actively developed; contributions by users are encouraged.
  1770.  
  1771.      discussion:
  1772.         via a mailing list: send "subscribe c2man <Your Name>" (in the
  1773.         message body) to listserv@research.canon.oz.au
  1774.  
  1775.      help:
  1776.         from the author and other users on the mailing list:
  1777.         c2man@research.canon.oz.au
  1778.  
  1779.      announcements:
  1780.         patches appear first in comp.sources.bugs, and then in
  1781.         comp.sources.misc.
  1782.  
  1783.      updated:
  1784.         1994/10/07
  1785.  
  1786.  
  1787.   10.4.  cnoweb
  1788.  
  1789.  
  1790.      Developer:
  1791.         Jim Fox
  1792.  
  1793.      Version:
  1794.         1.4 (January 4, 1991)
  1795.  
  1796.      Hardware:
  1797.         Anything with C and TeX.
  1798.  
  1799.      Languages:
  1800.         C
  1801.  
  1802.      Formatter:
  1803.         Plain TeX.
  1804.  
  1805.      Availability:
  1806.         Anonymous ftp from:
  1807.  
  1808.      o  CTAN
  1809.  
  1810.      o  LPA:/c.c++
  1811.  
  1812.      Readme:
  1813.         Unknown, cnoweb.tex contains documentation.
  1814.  
  1815.      Description:
  1816.         cnoweb is as it's name describes: write C, not web.  No 
  1817. tangling
  1818.         or weaving is implemented.  Documentation (between standard /*
  1819.         */ delimiteres) is written in TeX.  cnoweb provides 
  1820. typesetting
  1821.         of documentation, an table of contents of routines, and 
  1822. pretty-
  1823.         printing of C source.
  1824.  
  1825.      Support:
  1826.         None known.
  1827.  
  1828.  
  1829.   10.5.  dpp
  1830.  
  1831.  
  1832.      Developer:
  1833.         Dan Schmidt <dfan@alum.mit.edu>
  1834.      Version:
  1835.         0.2.1
  1836.  
  1837.      Hardware:
  1838.         Any platform with Perl 5
  1839.  
  1840.      Languages:
  1841.         C/C++ (Java soon), under noweb
  1842.  
  1843.      Formatter:
  1844.         LaTeX
  1845.  
  1846.      Availability:
  1847.         www.dfan.org/real/dpp.nw
  1848.  
  1849.      Readme:
  1850.         www.dfan.org/real/dpp.html
  1851.  
  1852.      Support:
  1853.         email to the author <dfan@alum.mit.edu>
  1854.  
  1855.      Description:
  1856.         dpp is a C/C++ prettyprinter for noweb.  Its output is 
  1857. extremely
  1858.         similar to that of CWEB, but it respects the indentation and
  1859.         line breaks of the source file.
  1860.  
  1861.         Features include:
  1862.  
  1863.      o  user-defined keywords
  1864.  
  1865.      o  the ability to turn prettyprinting off for specified output
  1866.         files (e.g., makefiles)
  1867.  
  1868.      o  the option to typeset comments in TeX, or not
  1869.  
  1870.      o  prettyprinting of quoted code, in documentation or chunk names
  1871.  
  1872.      o  the ability to undo whitespace hand-formatting that looks good
  1873.         monospaced but awful in a proportional font
  1874.  
  1875.  
  1876.  
  1877.   10.6.  Fold2Web
  1878.  
  1879.  
  1880.      Developer:
  1881.         Bernhard Lang lang@tu-harburg.d400.de
  1882.  
  1883.      Version:
  1884.         V0.8
  1885.  
  1886.      Hardware:
  1887.         MSDOS
  1888.  
  1889.      Languages:
  1890.         All (must allow comment lines)
  1891.  
  1892.      Formatter:
  1893.         LaTeX
  1894.  
  1895.      Availability:
  1896.         Anonymous ftp from: kirk.ti1.tu-harburg.de (134.28.41.50)
  1897.         /pub/fold2web/readme /pub/fold2web/fold2web.zip
  1898.  
  1899.      Readme:
  1900.         In distribution
  1901.      Description:
  1902.         The idea behind the Fold2Web tool is the following: A 
  1903. programmer
  1904.         can write his program source with a folding editor and later 
  1905. map
  1906.         the folded source files automatically to WEB-files. The
  1907.         generated WEB-files can then be modified by inserting required
  1908.         documentations.
  1909.  
  1910.  
  1911.         The advantage by starting program developement with original
  1912.         sources is to get short design cycles during the compile/debug
  1913.         steps. By using a folding editor the global structuring
  1914.         information can be already captured in folds during this
  1915.         developement phase. Fold information is typically stored in
  1916.         comment lines and thus will not affect the efficiency of the
  1917.         compile/debug design cycle.
  1918.  
  1919.  
  1920.         Some folding editors and a folding mode for the emacs are
  1921.         available (e.g. see our FUE folding editor for MSDOS machines
  1922.         which is a modified micro emacs. Pick it at kirk in directory
  1923.         /pub/fold2web).
  1924.  
  1925.  
  1926.         After reaching a stable version of a program source its time 
  1927. to
  1928.         convert the source file to a WEB-file and do the program
  1929.         documentation.  Fold2Web is written to convert folded source
  1930.         text of any programming language to nuweb files. The folded
  1931.         structure is kept by mapping folds to scraps. Fold markers 
  1932. which
  1933.         differ between languages due to different ways of specifying
  1934.         comments can be configured for each language.
  1935.  
  1936.  
  1937.         Good results can also achived when given but poor documented
  1938.         program sources have to be modified. Such sources can be 
  1939. folded
  1940.         using a folding editor to extract the global structures. This
  1941.         offers a global view to the program structures and help to
  1942.         understand its functionality.  Furthermore the program code is
  1943.         not affected, only comment lines are inserted. Once folded the
  1944.         program source can be automatically translated to a WEB 
  1945. document
  1946.         using the above tool.
  1947.  
  1948.  
  1949.      Support:
  1950.         email to lang@tu-harburg.d400.de
  1951.  
  1952.  
  1953.   10.7.  Funnelweb Mode
  1954.  
  1955.  
  1956.      Developer:
  1957.         Daniel Simmons simmdan@kenya.isu.edu
  1958.  
  1959.      Version:
  1960.         Unknown
  1961.  
  1962.      Availability:
  1963.         www.miscrit.be/~ddw
  1964.  
  1965.  
  1966.      Description:
  1967.         The other day I did a quick hack to nuweb.el as included with
  1968.         the nuweb distribution so as to make a funnelweb-mode.el.  
  1969. I've
  1970.         only used it briefly, and I'm sure that it can be improved 
  1971. quite
  1972.         a bit.  I've been thinking about adding support for folding on
  1973.         sections, a pull-down menu to select macro definitions (like 
  1974. the
  1975.         recent functions posted to gnu.emacs.sources for a C function
  1976.         definition pull-down menu) and some kind of tags support for
  1977.         funnelweb.
  1978.  
  1979.  
  1980.      Support:
  1981.         Unknown
  1982.  
  1983.  
  1984.   10.8.  noweb.el
  1985.  
  1986.  
  1987.      Developer:
  1988.         Bruce Stephens (no email contact)
  1989.  
  1990.      Version:
  1991.         Unknown.
  1992.  
  1993.      Availability:
  1994.         Lost
  1995.  
  1996.      Description:
  1997.         This is a very simple mode I just hacked up.  There's a lot
  1998.         wrong with it, but I thought others may be interested, even as
  1999.         it stands.  It *requires* text properties, and assumes those
  2000.         used in GNU Emacs 19.22; it'll quite likely work with Lucid
  2001.         Emacs, but I haven't tried it.
  2002.  
  2003.  
  2004.         I use it with auctex8.1 and cc-mode 3.229, both of which are
  2005.         loaded separately (I think my emacs is dumped with them, in
  2006.         fact).
  2007.  
  2008.  
  2009.         The idea is to have one mode (which calls itself c-mode, but
  2010.         actually has LaTeX-mode keybindings) generally (this means 
  2011. that
  2012.         the code is hilighted nicely), and have the code chunks use a
  2013.         different keymap.
  2014.  
  2015.      Support:
  2016.         Unknown
  2017.  
  2018.  
  2019.   10.9.  noweb-outline.el
  2020.  
  2021.  
  2022.      Developer:
  2023.         Dan Schmidt dfan@alum.mit.edu
  2024.  
  2025.      Version:
  2026.         0.0.3
  2027.  
  2028.      Hardware:
  2029.         Any platform with Emacs
  2030.  
  2031.      Languages:
  2032.         noweb
  2033.  
  2034.      Availability:
  2035.         www.dfan.org/real/noweb-outline.el
  2036.  
  2037.      Readme:
  2038.         www.dfan.org/real/noweb-outline.html
  2039.  
  2040.      Support:
  2041.         email to the author, dfan@alum.mit.edu
  2042.  
  2043.      Description:
  2044.         noweb-outline.el is a mode for Emacs that allows you to easily
  2045.         navigate the chunk tree of a noweb program.
  2046.  
  2047.  
  2048.         One of the problems with literate programming is that it's 
  2049. easy
  2050.         to lose track of how your tangled source file (the one that 
  2051. the
  2052.         compiler actually sees) is structured. In noweb-outline-mode,
  2053.         you can interactively explore the tree of chunks you are
  2054.         creating, giving you the big picture as well as the small.
  2055.         Enough description; it would take more time for me to explain 
  2056. it
  2057.         than for you to just go ahead and try it out.
  2058.  
  2059.  
  2060.         noweb-outline.el is currently in an alpha state (I've worked 
  2061. on
  2062.         it for only a couple of days), but it is already very useful. 
  2063. A
  2064.         nice file to use to try it out is example/wc.nw in the noweb
  2065.         distribution.
  2066.  
  2067.  
  2068.   10.10.  nuweb.el
  2069.  
  2070.  
  2071.      Developer:
  2072.         Dominique de Waleffe ddw@acm.org
  2073.  
  2074.      Version:
  2075.         1.99
  2076.  
  2077.      Availability:
  2078.         Anonymous ftp from CTAN
  2079.  
  2080.  
  2081.      Description:
  2082.         Provides a major mode extending Auctex for editing nuweb 
  2083. files.
  2084.         Main features (in 2.0):
  2085.  
  2086.      o  Edit scrap bodies in a separate buffer in a different mode
  2087.         (selected using emacs defaults for files, specific indication
  2088.         -*-mode-*-, or a buffer-local variable)
  2089.  
  2090.      o  Extends Auctex commands so that nuweb is called before LaTeX,
  2091.  
  2092.      o  Easy navigation on scrap definition and use points.
  2093.  
  2094.      o  Now creates an imenu (C-M-mouse1) with user index entries, 
  2095. macro
  2096.         definition positions and file definition positions.
  2097.  
  2098.  
  2099.      Support:
  2100.         Email to ddw@acm.org
  2101.  
  2102.  
  2103.   10.11.  Web mode
  2104.  
  2105.  
  2106.      Developer:
  2107.         Bart Childs bart@cs.tamu.edu
  2108.  
  2109.      Version:
  2110.         Unknown
  2111.  
  2112.      Tools supported:
  2113.         web, fweb, cweb, funnelweb
  2114.  
  2115.  
  2116.      Availability:
  2117.         Anonymous ftp ftp.cs.tamu.edu:pub/tex-web/web/EMACS.web-mode
  2118.         thrain.anu.edu.au:pub/web/EMACS.web-mode
  2119.  
  2120.      Description:
  2121.         This version works with versions 18 and 19 of Emacs to be best
  2122.         of my knowledge.  I have cleaned up a number of documentation
  2123.         items ...  In the same directory is wm_refcard.tex which is an
  2124.         edited version of the famous one to include some web-mode
  2125.         commands.
  2126.  
  2127.  
  2128.         The files limbo* are related to its use and notice that half
  2129.         them have an uppercase L in them for LaTeX.  The setup is 
  2130. based
  2131.         upon the fact that we (I am not alone here) primarily use FWEB
  2132.         for C and Fortran programming.
  2133.  
  2134.  
  2135.         We are using version 1.40 of FWEB although John Krommes warns
  2136.         that it is not mature and the manual is not yet updated.  The
  2137.         info files are!  We are using LaTeX almost exclusively.  That
  2138.         will likely change and we will revert to version 1.30 if the
  2139.         final form of 1.40 cannot return to the simple section numbers
  2140.         and avoid the HORRIBLE LATEX 0.1.7.2.4.6 type section numbers.
  2141.  
  2142.      Support:
  2143.         Unknown
  2144.  
  2145.  
  2146.   11.  What other resources are available?
  2147.  
  2148.   11.1.  TeX Resources
  2149.  
  2150.   Another resource of interest to literate programmers is the
  2151.   comp.text.tex newsgroup.   If you're using (La)TeX as your 
  2152. typsetting
  2153.   system and have access to internet, then you should investigate this
  2154.   resource.
  2155.  
  2156.   Another reason the TeX resources should be important is that so many
  2157.   of the literate programming tools rely on either plain TeX or LaTeX 
  2158. as
  2159.   their text formatter.  (La)TeX software systems exist for most
  2160.   computing platforms.  These systems can be found on CTAN and other
  2161.   major archive sites.  Use archie to find them or simply ftp to one 
  2162. of
  2163.   the CTAN sites and browse.
  2164.  
  2165.  
  2166.  
  2167.   12.  Are there any code examples?
  2168.  
  2169.   Examples of web programs are included with the FWEB, CWEB, and noweb
  2170.   distributions.  nuweb is written in itself.
  2171.  
  2172.   Cameron Smith converted the K&R calculator program into a literate
  2173.   program.   It can be retrieved by anonymous ftp from:
  2174.  
  2175.     niord.shsu.edu [192.92.115.8] directory kr-cweb-sample as
  2176.       krcwsamp.zip
  2177.     or from
  2178.       LPA/Documentation
  2179.  
  2180.  
  2181.   Ross Williams has released a funnelweb example.  You can retrieve 
  2182. this
  2183.   file from node ftp.adelaide.edu.au [129.127.40.3] as
  2184.  
  2185.     /pub/funnelweb/examples/except.*
  2186.  
  2187.   This file should be on CTAN as well.
  2188.  
  2189.   Lee Wittenberg has posted a few litprog examples.  They are 
  2190. available
  2191.   via anonymous ftp from:
  2192.  
  2193.           ftp://samson.kean.edu/pub/leew/samples.LP
  2194.  
  2195.  
  2196.   The Stanford GraphBase is a large collection of programs by Don 
  2197. Knuth
  2198.   for doing all kinds of computations and games with graphs; it is 
  2199. writ-
  2200.   ten in (Levy/Knuth) CWEB. More details in the distribution.  It is
  2201.   available via anonymous ftp from:
  2202.  
  2203.     labrea.stanford.edu:/pub/sgb
  2204.  
  2205.  
  2206.  
  2207.  
  2208.  
  2209.   13.  Bibliographies
  2210.  
  2211.   Nelson Beebe has collected an extensive bibliography treating 
  2212. literate
  2213.   programming.  His work is available for anonymous ftp from
  2214.   ftp://ftp.math.utah.edu/pub/tex/bib/index.html#litprog.  Be sure to
  2215.   look around this site; there are many things of interest to user of
  2216.   TeX resources as well as literate programmers.
  2217.  
  2218.   Although I have not verified this, LPA is an alternate source for
  2219.   these files.  Note that they are updated frequently (Nelson says
  2220.   several times each week), so be sure to get a fresh copy before
  2221.   extensive use.  Joachim Schrod indicates that these files may be
  2222.   updated daily and can be retrieved via anonymous ftp at
  2223.   LPA/documentation.
  2224.  
  2225.  
  2226.  
  2227.   14.  Other Opinions about Literate Programming
  2228.  
  2229.  
  2230.  
  2231.   14.1.  van Ammers
  2232.  
  2233.   An author (Eric W. van Ammers) wrote me a short article treating his
  2234.   opinions on literate programming.
  2235.  
  2236.   First observation on LP
  2237.  
  2238.   About 90% of the disussion on this list is about problems with
  2239.   applying some WEB-family member to a particular programming language
  2240.   or a special documentation situation.  This is ridiculous, I think.
  2241.   Let me explain shortly why.
  2242.  
  2243.   Lemma 1:
  2244.  
  2245.   I have proposed for many years that programming has nothing to do 
  2246. with
  2247.   programming langauges, i.e. a good programmer makes good programs in
  2248.   any language (given some time to learn the syntax) and a bad
  2249.   programmer will never make a good program, no matter the language he
  2250.   uses (today many people share this view, fortunately).
  2251.  
  2252.   Lemma 2:
  2253.  
  2254.   Literate Programming has (in a certain way not yet completely
  2255.   understood) to do with essential aspects of programming.
  2256.  
  2257.  
  2258.   Conclusion 1:
  2259.  
  2260.   A LP-tool should be independent of programming language.
  2261.  
  2262.   Lemma 3:
  2263.  
  2264.   It seems likely that the so called BOOK FORMAT PARADIGM [ref. 1] 
  2265. plays
  2266.   an important role in making literate programs work.
  2267.  
  2268.   Lemma 4:
  2269.  
  2270.   There are very many documentation systems currently being used to
  2271.   produce documents in the BOOK FORMAT.
  2272.  
  2273.   Conclusion 2:
  2274.  
  2275.   A LP-tool should be independent of the documentation system that the
  2276.   program author whishes to use.
  2277.  
  2278.   My remark some time ago that we should discuss the generic 
  2279. properties
  2280.   of an LP-tool was based on the above observation.
  2281.  
  2282.   References:
  2283.  
  2284.   [1] Paul W. Oman and Curtus Cook. ``Typographical style is more than
  2285.   cosmetic.''  CACM 33, 5, 506-520 (May 1990)
  2286.  
  2287.   Second observation on LP
  2288.  
  2289.   The idea of a literate program as a text book should be extendend 
  2290. even
  2291.   further. I would like to see a literate program as an (in)formal
  2292.   argument of the correctness of the program.
  2293.  
  2294.   Thus a literate program should be like a textbook on mathematicics. 
  2295.  A
  2296.   mathematical textbook explains a theory in terms of lemma and
  2297.   theorems. But the proofs are never formal in the sense that they are
  2298.   obtaind by symbol manipulation of a proof checker. Rather the proofs
  2299.   are by so called ``informal rigour'', i.e. by very precise and
  2300.   unambiguous sentences in a natural language.
  2301.  
  2302.   Eric W. van Ammers <ammers@rcl.wau.nl>
  2303.  
  2304.  
  2305.  
  2306.   14.2.  Ramsey
  2307.  
  2308.   Another author (Norman Ramsey) wrote me and asked that his opinions 
  2309. be
  2310.   included in the FAQ.  What follows are Norman's comments verbatim.
  2311.  
  2312.   I see it's time for the ``how is literate programming different from
  2313.   verbose commenting'' question.  Perhaps David Thompson will get this
  2314.   into the FAQ.  Alert! What follows are my opinions.  In no way do I
  2315.   claim to speak for the (fractious) literate-programming community.
  2316.  
  2317.   How is literate programming different from verbose commenting?
  2318.  
  2319.   There are three distinguishing characteristics.  In order of
  2320.   importance, they are:
  2321.  
  2322.   1. flexible order of elaboration
  2323.  
  2324.   2. automatic support for browsing
  2325.  
  2326.   3. typeset documentation, especially diagrams and mathematics
  2327.  
  2328.  
  2329.   Flexible order of elaboration means being able to divide your source
  2330.   program into chunks and write the chunks in any order, independent 
  2331. of
  2332.   the order required by the compiler.  In principle, you can choose 
  2333. the
  2334.   order best suited to explaining what you are doing.  More subtly, 
  2335. this
  2336.   discipline encourages the author of a literate program to take the
  2337.   time to consider each fragment of the program in its proper sphere,
  2338.   e.g., not to rush past the error checking to get to the ``good
  2339.   parts.'' In its time and season, each part of the program is a good
  2340.   part. (This is the party line; your mileage may vary.)
  2341.  
  2342.   I find the reordering most useful for encapsulating tasks like input
  2343.   validation, error checking, and printing output fit for humans --- 
  2344. all
  2345.   tasks that tend to obscure ``real work'' when left inline.  
  2346. Reordering
  2347.   is less important when using languages like Modula-3, which has
  2348.   exceptions and permits declarations in any order, than when using
  2349.   languages like C, which has no exceptions and requires declaration
  2350.   before use.
  2351.  
  2352.   Automatic support for browsing means getting a table of contents,
  2353.   index, and cross-reference of your program.  Cross-reference might 
  2354. be
  2355.   printed, so that you could consult an index to look up the 
  2356. definition
  2357.   of an identifier `foo'.  With good tools, you might get a printed
  2358.   mini-index on every page if you wanted.  Or if you can use a 
  2359. hypertext
  2360.   technology, cross-reference might be as simple as clicking on an
  2361.   identifier to reach its definition.
  2362.  
  2363.   Indexing is typically done automatically or `semi-automatically', 
  2364. the
  2365.   latter meaning that identifier definitions are marked by hand.
  2366.   Diligently done semi-automatic indexes seem to be best, because the
  2367.   author can mark only the identifiers he or she considers important,
  2368.   but automatic indexing can be almost as good and requires no work.
  2369.   Some tools allow a mix of the two strategies.
  2370.  
  2371.   Some people have applied literate-programming tools to large batches
  2372.   of legacy code just to get the table of contents, index, and cross-
  2373.   reference.
  2374.  
  2375.   I don't use diagrams and mathematics very often, but I wouldn't want
  2376.   to have to live without them.  I have worked on one or two projects
  2377.   where the ability to use mathematical formulae to document the 
  2378. program
  2379.   was indispensible.  I also wouldn't like to explain some of my
  2380.   concurrent programs without diagrams.  Actually I write almost all 
  2381. of
  2382.   my literate programs using only sections headers, lists, and the
  2383.   occasional table.
  2384.  
  2385.  
  2386.       >Wouldn't it be easier to do one's literate programming using
  2387.       >a wysiwyg word processor (e.g. Word for Windows) and
  2388.       >indicate what is source code by putting it in a different
  2389.       >font?
  2390.  
  2391.  
  2392.  
  2393.   The data formats used in wysiwyg products are proprietary, and they
  2394.   tend to be documented badly if at all.  They are subject to change 
  2395. at
  2396.   the whim of the manufacturer. (I'll go out on a limb and say there 
  2397. are
  2398.   no significant wysiwyg tools in the public domain.  I hope the 
  2399. Andrew
  2400.   people will forgive me.) These conditions make it nearly impossible 
  2401. to
  2402.   write tools, especially tools that provide automatic indexing and
  2403.   cross-reference support.  The CLiP people have a partial solution 
  2404. that
  2405.   works for tools that can export text --- they plant tags and
  2406.   delimiters throughout the document that enable the reordering
  2407.   transformation (``tangling'').
  2408.  
  2409.   People use TeX, roff, and HTML because free implementations of these
  2410.   tools are widely available on a variety of platforms.  TeX and HTML
  2411.   are well documented, and TeX and roff are stable.  TeX is the most
  2412.   portable.  I think I have just answered the FAQ ``how come all these
  2413.   tools use TeX, anyway?'' :-)
  2414.  
  2415.   Norman Ramsey
  2416.  
  2417.  
  2418.  
  2419.   14.3.  My (Dave Thompson's) Experience
  2420.  
  2421.   In contrast to Eric's and Norman's comments, I'd like to interject
  2422.   from an anecdotal perspective.
  2423.  
  2424.   I first ran across the idea of literate programming in 1992 while
  2425.   poking around George Greenwade's TeX archive (at niord.shsu.edu) and
  2426.   stumbling on some of the tools.  My first experience was tinkering
  2427.   with cnoweb, see Section ``cnoweb''.  I used cnoweb to document a
  2428.   simple Bernoulli equation toy I built (in C) while working on a one-
  2429.   dimensional hydrodynamic model (in Fortran).  I was convinced that
  2430.   literate programming had promise (although cnoweb really qualifies 
  2431. as
  2432.   a pretty-printing tool).
  2433.  
  2434.   After reading Sewell's book, I kept hunting through the tools
  2435.   available until I found things that worked for me.  (More here as I
  2436.   have time to develop the story.)
  2437.  
  2438.  
  2439.  
  2440.   14.4.  Others
  2441.  
  2442.   I recently received email from Dave Johnson <scope@faroc.com.au> 
  2443. about
  2444.   his work developing language independent techniques.  The web site 
  2445. is
  2446.   www.dscope.com.au.
  2447.  
  2448.  
  2449.  
  2450.   15.  How to anonymously ftp
  2451.  
  2452.   Pretty much everything mentioned here is available by anonymous FTP.
  2453.   FAQ lists cross-posted to news.answers and rec.answers can be gotten
  2454.   from rtfm.mit.edu [18.181.0.24], under /pub/usenet/news.answers or
  2455.   under /pub/usenet/more.specific.group.name
  2456.  
  2457.   "anonymous FTP" is just a way for files to be stored where anyone 
  2458. can
  2459.   retrieve them over the Net.    For example, to retrieve the latest
  2460.   version of the literate programming FAQ, do the following:
  2461.  
  2462.   > ftp rtfm.mit.edu              /* connect to the site; message 
  2463. follows */
  2464.   > anonymous                     /* type this when it asks for your 
  2465. name */
  2466.   > <your email address>          /* type your address as the 
  2467. password    */
  2468.   > cd /pub/usenet                /* go to the directory you want to 
  2469. be   */
  2470.   > cd comp.programming.literate  /* one level down (no slash).       
  2471.     */
  2472.   > dir                           /* look at what's there             
  2473.     */
  2474.   > get literate-progamming-faq   /* get the file; case-sensitive     
  2475.     */
  2476.   > quit                          /* stop this mysterious thing       
  2477.     */
  2478.  
  2479.  
  2480.   If your FTP program complains that it doesn't know where the site 
  2481. you
  2482.   want to use is, type the numerical address instead of the sitename:
  2483.  
  2484.   > ftp 18.181.0.24               /* connect with numerical address */
  2485.  
  2486.  
  2487.   If you don't have ftp access, send e-mail to mail-server@rtfm.mit.ed
  2488. u
  2489.   with the single word "help" in the body of the message.
  2490.  
  2491.   Getting binary files (executables, or any compressed files) is only
  2492.   slightly more difficult.   You need to set binary mode inside FTP
  2493.   before you transfer the file.
  2494.  
  2495.   > binary            /* set binary transfer mode  */
  2496.   > ascii             /* set back to text transfer mode */
  2497.  
  2498.  
  2499.   FAQs and spoiler lists are generally ascii files; everything else is
  2500.   generally binary files.
  2501.  
  2502.   Some common extensions on binary files in archive sites are:
  2503.  
  2504.     .Z           Compressed; extract with uncompress
  2505.     .tar.Z       Compressed 'tape archive'; uncompress then untar or 
  2506. tar -xvf
  2507.     .gz or .z    Gnu gzip; use gunzip (available from 
  2508. prep.gnu.ai.mit.edu)
  2509.     .sit         (Mac) StufIt archive
  2510.     .zip         Extract with Zip or Unzip
  2511.     .zoo         Yet another archive/compress program
  2512.     .lhe         (Amiga) ?
  2513.     .lzh         Lha archive program.
  2514.     .arj         (PC) Arj archive program.
  2515.     .exe         (PC) Sometimes self-extracting archives-just execute 
  2516. them.
  2517.     .uue or .UUE Transfer as text file; use uudecode to convert to 
  2518. binary
  2519.     .hqx         (Mac) BinHex format; transfer in text mode
  2520.  
  2521.  
  2522.   Generic help can be found in the FAQs of comp.binaries.  <your_sys-
  2523.   tem_type> for how to transfer, extract, and virus-check binary 
  2524. files.
  2525.   (At rtfm.mit.edu)
  2526.  
  2527.   If you can't FTP from your site, use one of the following 
  2528. ftp-by-mail
  2529.   servers:
  2530.  
  2531.     ftpmail@decwrl.dec.com
  2532.     ftpmail@src.doc.ic.ac.uk
  2533.     ftpmail@cs.uow.edu.au
  2534.     ftpmail@grasp.insa-lyon.fr
  2535.  
  2536.  
  2537.   For complete instructions, send a message reading "help" to the
  2538.   server.
  2539.  
  2540.   If you don't know exactly what you're looking for, or exactly where 
  2541. it
  2542.   is, there are programs and servers that can help you.  For more 
  2543. info,
  2544.   send e-mail to mail-server@rtfm.mit.with with the body of the 
  2545. message
  2546.   reading send usenet/news.answers/finding-sources
  2547.  
  2548.  
  2549.   Thanks to Aliza R. Panitz (the "buglady") for this text.  I copied 
  2550. it
  2551.   verbatim from her post on faq-maintainers with only minor
  2552.   modifications.
  2553.  
  2554.  
  2555.  
  2556.   16.  Acknowledgements
  2557.  
  2558.   This document would not have happened without the help of many 
  2559. people.
  2560.   George Greenwade was instrumental in establishing the original 
  2561. mailing
  2562.   list way back in the early '90's (when I first became involved).
  2563.   Marcus Speh started one of the early ftp sites and was an active
  2564.   participant.  Among them are, Rob Beezer, Joachim Schrod, Piet van
  2565.   Oostrum, Ross N. Williams, Nelson H. F. Beebe, and Andrew Johnson.  
  2566. We
  2567.   wouldn't have literate programming if it wasn't for Donald Knuth and
  2568.   TeX.  Certainly, we wouldn't be where we are without the tool
  2569.   developers (all credited in their entries above).
  2570.   Cesar Bellardini cballard@santafe.com.ar deserves thanks for
  2571.   translating the FAQ into Spanish.
  2572.  
  2573.   A special thanks to Aliza R. Panitz for the text describing how to
  2574.   execute an anonymous ftp for files of interest.
  2575.  
  2576.   Any omissions from these acknowledgements should be considered an
  2577.   accident on my part.  Furthermore, participants in the
  2578.   comp.programming.literate newsgroup all contributed in various
  2579.   fashions.  Thank all of you.
  2580.  
  2581.  
  2582.  
  2583.   17.  End notes
  2584.  
  2585.   This document remains in a state of evolution (although I'm a strict
  2586.   creationist! <grin>).  I'm working on the SGML version to improve
  2587.   formatting of the resulting documents.  I'm also reorganizing the 
  2588. FAQ
  2589.   to improve its usability.  Comments are solicited for such
  2590.   improvements.  Omission of a particular tool should not be 
  2591. considered
  2592.   a snub in any sense--simply an error or oversight on my part.
  2593.  
  2594.  
  2595.  
  2596.  
  2597.  
  2598.  
  2599.  
  2600.  
  2601.  
  2602.  
  2603.  
  2604.  
  2605.  
  2606.  
  2607.  
  2608.  
  2609.  
  2610.  
  2611.  
  2612.  
  2613.  
  2614.  
  2615.  
  2616.  
  2617.  
  2618.  
  2619.  
  2620.  
  2621.  
  2622.  
  2623.  
  2624.  
  2625.  
  2626.  
  2627.  
  2628.  
  2629.  
  2630.  
  2631.  
  2632.  
  2633.  
  2634.  
  2635.  
  2636.  
  2637.  
  2638.  
  2639.  
  2640.