allanswers.org - comp.programming.literate FAQ

 Home >  Programming >

comp.programming.literate FAQ

Section 2 of 3 - Prev - Next
All sections - 1 - 2 - 3


        documents. Automatic indexing and hypertext features allow for
        easy access to both source text and documentation.


        LPW is shareware.


     Support:
        Bugs, problems, and questions to lpw@aol.com


  9.9.  MapleWEB


     Developer:
        Unknown

     Version:
        Unknown

     Hardware:
        Unknown

     Languages:
        Maple

     Formatter:
        Unknown

     Availability:
        Anonymous ftp from CTAN/maple/mapleweb

     Readme:
        Unknown

     Description:
        None

     Support:
        Unknown





  9.10.  Matlabweb


     Developer:
        Mark Potse

     Version:
        2.09

     Hardware:
        any, but only Unix tested & supported

     Languages:
        Matlab

     Formatter:
        Plain TeX and LaTeX.

     Availability:
        Anonymous ftp from the CTAN archives,

     Readme:
        Bundled with above


     Description:
        CWEB-like literate programming system for the Matlab language.
        Created with a modified version of the Spider system. Several
        more or less language-specific features:

     o  macros with multiple arguments

     o  comments and verbatim comments

     o  strings can be formatted as code, with help for nested 
strings,
        e.g. for callbacks in user interface programming.

     o  string arguments for macros, that get inserted in strings in 
the
        replacement text

     o  "@f foo TeX"  works as in recent versions of CWEB

     Support:
        not guaranteed. Try M.Potse@amc.uva.nl, comments are welcome.


  9.11.  RWEB


     Developer:
        Unknown

     Version:
        Unknown

     Hardware:
        Unknown

     Languages:
        Unknown

     Formatter:
        Unknown

     Availability:
        Anonymous ftp from CTAN
     Readme:
        Unknown

     Description:
        Web generator in AWK.

     Support:
        Unknown


  9.12.  SchemeWEB


     Developer:
        John D. Ramsdell

     Version:
        2.1

     Hardware:
        Unix and DOS platforms

     Languages:
        Any dialect of Lisp.

     Formatter:
        LaTeX.

     Availability:
        The Unix version is in the Scheme Repository and it is 
available
        via anonymous ftp from:

     o  cs.indiana.edu:/pub/scheme-repository/utl/schemeweb.sh

     o  CTAN:/tex-archive/web/schemeweb

     o  The DOS version is part of the PCS/Geneva Scheme system which 
is
        available via anonymous ftp from: cui.unige.ch:/pub/pcs

     Readme:
        In bundle with above.

     Description:
        SchemeWEB is a Unix filter that allows you to generate both 
Lisp
        and LaTeX code from one source file.  The generated LaTeX code
        formats Lisp programs in typewriter font obeying the spacing 
in
        the source file. Comments can include arbitrary LaTeX 
commands.
        SchemeWEB was originally developed for the Scheme dialect of
        Lisp, but it can easily be used with most other dialects.

     Support:
        Bug reports to ramsdell@mitre.org.


  9.13.  SpideryWEB


     Developer:
        Norman Ramsey 

     Version:
        Unknown

     Hardware:
        Unix and DOS platforms

     Languages:
        Most Algol-like languages, including C, Ada, Pascal, Awk, and
        many others.

     Formatter:
        Plain TeX and latex for text formatters.

     Availability:
        Anonymous ftp from CTAN.

     Readme:
        In distribution.


     Description:
        A system for building language-dependent WEBs. Spider is 
frozen;
        no further development is planned.


     Support:
        Bug reports to spider-bugs@oracorp.com.


  9.14.  WEB


     Developer:
        Donald Knuth

     Version:
        4.4 (apparently)

     Hardware:
        Any TeX system should have it.

     Languages:
        Pascal

     Formatter:
        TeX (of course! ;-)

     Availability:
        Distributed with TeX systems.  Also avaliable in source form
        from labrea.stanford.edu/tex/web.

     Readme:
        Unknown

     Documentation:
        Available from labrea.stanford.edu/tex/web/webman.tex

     Description:
        This is the original software that started it all.  The 
original
        TeX processor was written in WEB.

     Support:
        None known.


  9.15.  WinWordWEB


     Developer:
        Lee Wittenberg leew@pilot.njin.net


     Version:
        Unknown

     Hardware:
        Needs Microsoft Word for Windows, v.2.x, and, of course, MS-
        Windows 3.x.

     Languages:
        Any programming language.

     Formatter:
        Word for Windows 2.x for text formatting and file maintenance.

     Availability:
        samson.kean.edu:pub/leew

     Readme:
        WORDWEB.DOC in the downloadable package describes the system.

     Description:
        WinWordWEB is a set of a Word for Windows macros (plus a
        paragraph style) that provide a crude literate programming
        environment.  The ``look and feel'' of the system is based on
        Norman Ramsey's noweb, but can easily be modified to suit
        individual tastes.

     Support:
        None.  WinWordWEB was written as a prototype to see if a 
WYSIWYG
        literate programming system was possible.  It is intended as a
        jumping off point for future work by others. However, the 
system
        is surprisingly usable as it stands, and the author is
        interested in hearing from users (satisfied and dissatisfied).


        Anyone interested in actively supporting (and improving) the
        product should contact the author via email.



  10.  Are there other tools I should know about?

  Follows is a list of some not-quite-literate-programming tools.  
Some
  term these pretty-printers.  Others may call them literate 
programming
  tools.  In any event, they don't seem to be quite in the same 
category
  as the tools listed above, so I'll include them here.


  10.1.  C2LaTeX


     Developer:
        John D. Ramsdell

     Version:
        Unknown

     Hardware:
        Unix

     Languages:
        C

     Formatter:
        LaTeX but it's easy to change the formatter.


     Availability:
        Anonymous ftp from omnigate.clarkson.edu:/pub/tex/tex-
        programs/c2latex.

     Readme:
        Absent.  Documentation is in the C source for c2latex.

     Description:
        C2latex provides simple support for literate programming in C.
        Given a C source file in which the comments have been written 
in
        LaTeX, c2latex converts the C source file into a LaTeX source
        file.  It can be used to produce typeset listings of C 
programs
        and/or documentation associated with the program.

        C2latex produces LaTeX source by implementing a small number 
of
        rules.  A C comment that starts at the beginning of a line is
        copied unmodified into the LaTeX source file.  Otherwise, non-
        blank lines are surrounded by a pair of formatting commands
        (\begin{flushleft} and \end{flushleft}), and the lines are
        separated by \\*. Each non-blank line is formatted using 
LaTeX's
        \verb command, except comments within the line are formatted 
in
        an \mbox.

     Support:
        Send bug reports to ramsdell@mitre.org.


  10.2.  c2cweb


     Developer:
        Werner Lemberg

     Version:
        1.5

     Hardware:
        DOS, OS/2, Unix (gcc) - CWEB source included

     Languages:
        C, C++

     Formatter:
        TeX

     Availability:
        Anonymous ftp from CTAN:/web/c_cpp/c2cweb

     Readme:
        In distribution.

     Description:
        c2cweb will transform plain C or C++ code into a CWEB file to
        get a pretty formatted output. A modified CWEAVE (which
        transforms the CWEB file into a TeX file, see below) is 
included
        also.

     Support:
        Werner Lemberg 


  10.3.  c2man


     author:
        Graham Stoney 
     language:
        C, nroff, texinfo, latex, html

     version:
        2.0 patchlevel 33

     parts:
        documentation generator (C -> nroff -man, -> texinfo, ->latex,
        -> html)

     location:
        ftp from

     o  any comp.sources.misc archive, in volume42 (the version in the
        comp.sources.reviewed archive is obsolete)

     o  dnpap.et.tudelft.nl/pub/Unix/Util/ c2man-2.0.*.tar.gz

     o  Australia archie.au/usenet/comp.sources.misc/volume42
        c2man-2.0/*

     o  N.America ftp://ftp.wustl.edu/usenet/comp.sources.misc/volume4
2/
        c2man-2.0/*

     o  Europe: ftp://ftp.irisa.fr/News/comp.sources.misc/volume42/
        c2man-2.0/*

     o  Japan:
        ftp://ftp.iij.ad.jp/pub/NetNews/comp.sources.misc/volume42/
        c2man-2.0/*

     Patches:
        lth.se/pub/netnews/sources.bugs/volume93/sep/c2man*

     description:
        c2man is an automatic documentation tool that extracts 
comments
        from C source code to generate functional interface
        documentation in the same format as sections 2 & 3 of the Unix
        Programmer's Manual. It requires minimal effort from the
        programmer by looking for comments in the usual places near 
the
        objects they document, rather than imposing a rigid function-
        comment syntax or requiring that the programmer learn and use 
a
        typesetting language. Acceptable documentation can often be
        generated from existing code with no modifications.

     conformance:
        supports both K&R and ISO/ANSI C coding styles

     features:

     o  generates output in nroff -man, TeXinfo, LaTeX or HTML format

     o  handles comments as part of the language grammar

     o  automagically documents enum parameter & return values

     o  handles C (/* */) and C++ (//) style comments

     o  doesn't handle C++ grammar (yet)

     requires:
        yacc/byacc/bison, lex/flex, and nroff/groff/texinfo/LaTeX.

     ports:
        Unix, OS/2, MSDOS, VMS.

     portability:
        very high for unix, via Configure

     status:
        actively developed; contributions by users are encouraged.

     discussion:
        via a mailing list: send "subscribe c2man " (in the
        message body) to listserv@research.canon.oz.au

     help:
        from the author and other users on the mailing list:
        c2man@research.canon.oz.au

     announcements:
        patches appear first in comp.sources.bugs, and then in
        comp.sources.misc.

     updated:
        1994/10/07


  10.4.  cnoweb


     Developer:
        Jim Fox

     Version:
        1.4 (January 4, 1991)

     Hardware:
        Anything with C and TeX.

     Languages:
        C

     Formatter:
        Plain TeX.

     Availability:
        Anonymous ftp from:

     o  CTAN

     o  LPA:/c.c++

     Readme:
        Unknown, cnoweb.tex contains documentation.

     Description:
        cnoweb is as it's name describes: write C, not web.  No 
tangling
        or weaving is implemented.  Documentation (between standard /*
        */ delimiteres) is written in TeX.  cnoweb provides 
typesetting
        of documentation, an table of contents of routines, and 
pretty-
        printing of C source.

     Support:
        None known.


  10.5.  dpp


     Developer:
        Dan Schmidt 
     Version:
        0.2.1

     Hardware:
        Any platform with Perl 5

     Languages:
        C/C++ (Java soon), under noweb

     Formatter:
        LaTeX

     Availability:
        www.dfan.org/real/dpp.nw

     Readme:
        www.dfan.org/real/dpp.html

     Support:
        email to the author 

     Description:
        dpp is a C/C++ prettyprinter for noweb.  Its output is 
extremely
        similar to that of CWEB, but it respects the indentation and
        line breaks of the source file.

        Features include:

     o  user-defined keywords

     o  the ability to turn prettyprinting off for specified output
        files (e.g., makefiles)

     o  the option to typeset comments in TeX, or not

     o  prettyprinting of quoted code, in documentation or chunk names

     o  the ability to undo whitespace hand-formatting that looks good
        monospaced but awful in a proportional font



  10.6.  Fold2Web


     Developer:
        Bernhard Lang lang@tu-harburg.d400.de

     Version:
        V0.8

     Hardware:
        MSDOS

     Languages:
        All (must allow comment lines)

     Formatter:
        LaTeX

     Availability:
        Anonymous ftp from: kirk.ti1.tu-harburg.de (134.28.41.50)
        /pub/fold2web/readme /pub/fold2web/fold2web.zip

     Readme:
        In distribution
     Description:
        The idea behind the Fold2Web tool is the following: A 
programmer
        can write his program source with a folding editor and later 
map
        the folded source files automatically to WEB-files. The
        generated WEB-files can then be modified by inserting required
        documentations.


        The advantage by starting program developement with original
        sources is to get short design cycles during the compile/debug
        steps. By using a folding editor the global structuring
        information can be already captured in folds during this
        developement phase. Fold information is typically stored in
        comment lines and thus will not affect the efficiency of the
        compile/debug design cycle.


        Some folding editors and a folding mode for the emacs are
        available (e.g. see our FUE folding editor for MSDOS machines
        which is a modified micro emacs. Pick it at kirk in directory
        /pub/fold2web).


        After reaching a stable version of a program source its time 
to
        convert the source file to a WEB-file and do the program
        documentation.  Fold2Web is written to convert folded source
        text of any programming language to nuweb files. The folded
        structure is kept by mapping folds to scraps. Fold markers 
which
        differ between languages due to different ways of specifying
        comments can be configured for each language.


        Good results can also achived when given but poor documented
        program sources have to be modified. Such sources can be 
folded
        using a folding editor to extract the global structures. This
        offers a global view to the program structures and help to
        understand its functionality.  Furthermore the program code is
        not affected, only comment lines are inserted. Once folded the
        program source can be automatically translated to a WEB 
document
        using the above tool.


     Support:
        email to lang@tu-harburg.d400.de


  10.7.  Funnelweb Mode


     Developer:
        Daniel Simmons simmdan@kenya.isu.edu

     Version:
        Unknown

     Availability:
        www.miscrit.be/~ddw


     Description:
        The other day I did a quick hack to nuweb.el as included with
        the nuweb distribution so as to make a funnelweb-mode.el.  
I've
        only used it briefly, and I'm sure that it can be improved 
quite
        a bit.  I've been thinking about adding support for folding on
        sections, a pull-down menu to select macro definitions (like 
the
        recent functions posted to gnu.emacs.sources for a C function
        definition pull-down menu) and some kind of tags support for
        funnelweb.


     Support:
        Unknown


  10.8.  noweb.el


     Developer:
        Bruce Stephens (no email contact)

     Version:
        Unknown.

     Availability:
        Lost

     Description:
        This is a very simple mode I just hacked up.  There's a lot
        wrong with it, but I thought others may be interested, even as
        it stands.  It *requires* text properties, and assumes those
        used in GNU Emacs 19.22; it'll quite likely work with Lucid
        Emacs, but I haven't tried it.


        I use it with auctex8.1 and cc-mode 3.229, both of which are
        loaded separately (I think my emacs is dumped with them, in
        fact).


        The idea is to have one mode (which calls itself c-mode, but
        actually has LaTeX-mode keybindings) generally (this means 
that
        the code is hilighted nicely), and have the code chunks use a
        different keymap.

     Support:
        Unknown


  10.9.  noweb-outline.el


     Developer:
        Dan Schmidt dfan@alum.mit.edu

     Version:
        0.0.3

     Hardware:
        Any platform with Emacs

     Languages:
        noweb

     Availability:
        www.dfan.org/real/noweb-outline.el

     Readme:
        www.dfan.org/real/noweb-outline.html

     Support:
        email to the author, dfan@alum.mit.edu

     Description:
        noweb-outline.el is a mode for Emacs that allows you to easily
        navigate the chunk tree of a noweb program.


        One of the problems with literate programming is that it's 
easy
        to lose track of how your tangled source file (the one that 
the
        compiler actually sees) is structured. In noweb-outline-mode,
        you can interactively explore the tree of chunks you are
        creating, giving you the big picture as well as the small.
        Enough description; it would take more time for me to explain 
it
        than for you to just go ahead and try it out.


        noweb-outline.el is currently in an alpha state (I've worked 
on
        it for only a couple of days), but it is already very useful. 
A
        nice file to use to try it out is example/wc.nw in the noweb
        distribution.


  10.10.  nuweb.el


     Developer:
        Dominique de Waleffe ddw@acm.org

     Version:
        1.99

     Availability:
        Anonymous ftp from CTAN


     Description:
        Provides a major mode extending Auctex for editing nuweb 
files.
        Main features (in 2.0):

     o  Edit scrap bodies in a separate buffer in a different mode
        (selected using emacs defaults for files, specific indication
        -*-mode-*-, or a buffer-local variable)

     o  Extends Auctex commands so that nuweb is called before LaTeX,

     o  Easy navigation on scrap definition and use points.

     o  Now creates an imenu (C-M-mouse1) with user index entries, 
macro
        definition positions and file definition positions.


     Support:
        Email to ddw@acm.org


  10.11.  Web mode


     Developer:
        Bart Childs bart@cs.tamu.edu

     Version:
        Unknown

     Tools supported:
        web, fweb, cweb, funnelweb


     Availability:
        Anonymous ftp ftp.cs.tamu.edu:pub/tex-web/web/EMACS.web-mode
        thrain.anu.edu.au:pub/web/EMACS.web-mode

     Description:
        This version works with versions 18 and 19 of Emacs to be best
        of my knowledge.  I have cleaned up a number of documentation
        items ...  In the same directory is wm_refcard.tex which is an
        edited version of the famous one to include some web-mode
        commands.


        The files limbo* are related to its use and notice that half
        them have an uppercase L in them for LaTeX.  The setup is 
based
        upon the fact that we (I am not alone here) primarily use FWEB
        for C and Fortran programming.


        We are using version 1.40 of FWEB although John Krommes warns
        that it is not mature and the manual is not yet updated.  The
        info files are!  We are using LaTeX almost exclusively.  That
        will likely change and we will revert to version 1.30 if the
        final form of 1.40 cannot return to the simple section numbers
        and avoid the HORRIBLE LATEX 0.1.7.2.4.6 type section numbers.

     Support:
        Unknown


  11.  What other resources are available?

  11.1.  TeX Resources

  Another resource of interest to literate programmers is the
  comp.text.tex newsgroup.   If you're using (La)TeX as your 
typsetting
  system and have access to internet, then you should investigate this
  resource.

  Another reason the TeX resources should be important is that so many
  of the literate programming tools rely on either plain TeX or LaTeX 
as
  their text formatter.  (La)TeX software systems exist for most
  computing platforms.  These systems can be found on CTAN and other
  major archive sites.  Use archie to find them or simply ftp to one 
of
  the CTAN sites and browse.



  12.  Are there any code examples?

  Examples of web programs are included with the FWEB, CWEB, and noweb
  distributions.  nuweb is written in itself.

  Cameron Smith converted the K&R calculator program into a literate
  program.   It can be retrieved by anonymous ftp from:

    niord.shsu.edu [192.92.115.8] directory kr-cweb-sample as
      krcwsamp.zip
    or from
      LPA/Documentation


  Ross Williams has released a funnelweb example.  You can retrieve 
this
  file from node ftp.adelaide.edu.au [129.127.40.3] as

    /pub/funnelweb/examples/except.*

  This file should be on CTAN as well.

  Lee Wittenberg has posted a few litprog examples.  They are 
available
  via anonymous ftp from:

          ftp://samson.kean.edu/pub/leew/samples.LP


  The Stanford GraphBase is a large collection of programs by Don 
Knuth
  for doing all kinds of computations and games with graphs; it is 
writ-
  ten in (Levy/Knuth) CWEB. More details in the distribution.  It is
  available via anonymous ftp from:

    labrea.stanford.edu:/pub/sgb





  13.  Bibliographies

  Nelson Beebe has collected an extensive bibliography treating 
literate
  programming.  His work is available for anonymous ftp from
  ftp://ftp.math.utah.edu/pub/tex/bib/index.html#litprog.  Be sure to
  look around this site; there are many things of interest to user of
  TeX resources as well as literate programmers.

  Although I have not verified this, LPA is an alternate source for
  these files.  Note that they are updated frequently (Nelson says
  several times each week), so be sure to get a fresh copy before
  extensive use.  Joachim Schrod indicates that these files may be
  updated daily and can be retrieved via anonymous ftp at
  LPA/documentation.



  14.  Other Opinions about Literate Programming



  14.1.  van Ammers

  An author (Eric W. van Ammers) wrote me a short article treating his
  opinions on literate programming.

  First observation on LP

  About 90% of the disussion on this list is about problems with
  applying some WEB-family member to a particular programming language
  or a special documentation situation.  This is ridiculous, I think.
  Let me explain shortly why.

  Lemma 1:

  I have proposed for many years that programming has nothing to do 
with
  programming langauges, i.e. a good programmer makes good programs in
  any language (given some time to learn the syntax) and a bad
  programmer will never make a good program, no matter the language he
  uses (today many people share this view, fortunately).

  Lemma 2:

  Literate Programming has (in a certain way not yet completely
  understood) to do with essential aspects of programming.


  Conclusion 1:

  A LP-tool should be independent of programming language.

  Lemma 3:

  It seems likely that the so called BOOK FORMAT PARADIGM [ref. 1] 
plays
  an important role in making literate programs work.

  Lemma 4:

  There are very many documentation systems currently being used to
  produce documents in the BOOK FORMAT.

  Conclusion 2:

  A LP-tool should be independent of the documentation system that the
  program author whishes to use.

  My remark some time ago that we should discuss the generic 
properties
  of an LP-tool was based on the above observation.

  References:

  [1] Paul W. Oman and Curtus Cook. ``Typographical style is more than
  cosmetic.''  CACM 33, 5, 506-520 (May 1990)

  Second observation on LP

  The idea of a literate program as a text book should be extendend 
even
  further. I would like to see a literate program as an (in)formal
  argument of the correctness of the program.

  Thus a literate program should be like a textbook on mathematicics. 
 A
  mathematical textbook explains a theory in terms of lemma and
  theorems. But the proofs are never formal in the sense that they are
  obtaind by symbol manipulation of a proof checker. Rather the proofs
  are by so called ``informal rigour'', i.e. by very precise and
  unambiguous sentences in a natural language.

  Eric W. van Ammers 



  14.2.  Ramsey

  Another author (Norman Ramsey) wrote me and asked that his opinions 
be
  included in the FAQ.  What follows are Norman's comments verbatim.

  I see it's time for the ``how is literate programming different from
  verbose commenting'' question.  Perhaps David Thompson will get this
  into the FAQ.  Alert! What follows are my opinions.  In no way do I
  claim to speak for the (fractious) literate-programming community.

  How is literate programming different from verbose commenting?

  There are three distinguishing characteristics.  In order of
  importance, they are:

  1. flexible order of elaboration

  2. automatic support for browsing

  3. typeset documentation, especially diagrams and mathematics


  Flexible order of elaboration means being able to divide your source
  program into chunks and write the chunks in any order, independent 
of
  the order required by the compiler.  In principle, you can choose 
the
  order best suited to explaining what you are doing.  More subtly, 
this
  discipline encourages the author of a literate program to take the
  time to consider each fragment of the program in its proper sphere,
  e.g., not to rush past the error checking to get to the ``good
  parts.'' In its time and season, each part of the program is a good
  part. (This is the party line; your mileage may vary.)

  I find the reordering most useful for encapsulating tasks like input
  validation, error checking, and printing output fit for humans --- 
all
  tasks that tend to obscure ``real work'' when left inline.  
Reordering
  is less important when using languages like Modula-3, which has
  exceptions and permits declarations in any order, than when using
  languages like C, which has no exceptions and requires declaration
  before use.

  Automatic support for browsing means getting a table of contents,
  index, and cross-reference of your program.  Cross-reference might 
be
  printed, so that you could consult an index to look up the 
definition
  of an identifier `foo'.  With good tools, you might get a printed
  mini-index on every page if you wanted.  Or if you can use a 
hypertext
  technology, cross-reference might be as simple as clicking on an
  identifier to reach its definition.

  Indexing is typically done automatically or `semi-automatically', 
the
  latter meaning that identifier definitions are marked by hand.
  Diligently done semi-automatic indexes seem to be best, because the
  author can mark only the identifiers he or she considers important,
  but automatic indexing can be almost as good and requires no work.
  Some tools allow a mix of the two strategies.

  Some people have applied literate-programming tools to large batches
  of legacy code just to get the table of contents, index, and cross-
  reference.

  I don't use diagrams and mathematics very often, but I wouldn't want
  to have to live without them.  I have worked on one or two projects
  where the ability to use mathematical formulae to document the 
program
  was indispensible.  I also wouldn't like to explain some of my
  concurrent programs without diagrams.  Actually I write almost all 
of
  my literate programs using only sections headers, lists, and the
  occasional table.


      >Wouldn't it be easier to do one's literate programming using
      >a wysiwyg word processor (e.g. Word for Windows) and
      >indicate what is source code by putting it in a different
      >font?



  The data formats used in wysiwyg products are proprietary, and they
  tend to be documented badly if at all.  They are subject to change 
at
  the whim of the manufacturer. (I'll go out on a limb and say there 
are
  no significant wysiwyg tools in the public domain.  I hope the 
Andrew
  people will forgive me.) These conditions make it nearly impossible 
to
  write tools, especially tools that provide automatic indexing and
  cross-reference support.  The CLiP people have a partial solution 
that
  works for tools that can export text --- they plant tags and
  delimiters throughout the document that enable the reordering
  transformation (``tangling'').

  People use TeX, roff, and HTML because free implementations of these
  tools are widely available on a variety of platforms.  TeX and HTML
  are well documented, and TeX and roff are stable.  TeX is the most
  portable.  I think I have just answered the FAQ ``how come all these
  tools use TeX, anyway?'' :-)

  Norman Ramsey



  14.3.  My (Dave Thompson's) Experience

  In contrast to Eric's and Norman's comments, I'd like to interject
  from an anecdotal perspective.

  I first ran across the idea of literate programming in 1992 while
  poking around George Greenwade's TeX archive (at niord.shsu.edu) and
  stumbling on some of the tools.  My first experience was tinkering
  with cnoweb, see Section ``cnoweb''.  I used cnoweb to document a
  simple Bernoulli equation toy I built (in C) while working on a one-
  dimensional hydrodynamic model (in Fortran).  I was convinced that
  literate programming had promise (although cnoweb really qualifies 
as
  a pretty-printing tool).

  After reading Sewell's book, I kept hunting through the tools
  available until I found things that worked for me.  (More here as I
  have time to develop the story.)



  14.4.  Others

  I recently received email from Dave Johnson  
about
  his work developing language independent techniques.  The web site 
is
  www.dscope.com.au.



  15.  How to anonymously ftp

  Pretty much everything mentioned here is available by anonymous FTP.
  FAQ lists cross-posted to news.answers and rec.answers can be gotten
  from rtfm.mit.edu [18.181.0.24], under /pub/usenet/news.answers or
  under /pub/usenet/more.specific.group.name

  "anonymous FTP" is just a way for files to be stored where anyone 
can
  retrieve them over the Net.    For example, to retrieve the latest
  version of the literate programming FAQ, do the following:

  > ftp rtfm.mit.edu              /* connect to the site; message 
follows */
  > anonymous                     /* type this when it asks for your 
name */
  >           /* type your address as the 
password    */
  > cd /pub/usenet                /* go to the directory you want to 
be   */
  > cd comp.programming.literate  /* one level down (no slash).       
    */
  > dir                           /* look at what's there             
    */
  > get literate-progamming-faq   /* get the file; case-sensitive     
    */
  > quit                          /* stop this mysterious thing       
    */


  If your FTP program complains that it doesn't know where the site 
you
  want to use is, type the numerical address instead of the sitename:

  > ftp 18.181.0.24               /* connect with numerical address */


  If you don't have ftp access, send e-mail to mail-server@rtfm.mit.ed
u
  with the single word "help" in the body of the message.

  Getting binary files (executables, or any compressed files) is only
  slightly more difficult.   You need to set binary mode inside FTP
  before you transfer the file.

  > binary            /* set binary transfer mode  */
  > ascii             /* set back to text transfer mode */


  FAQs and spoiler lists are generally ascii files; everything else is
  generally binary files.

  Some common extensions on binary files in archive sites are:

    .Z           Compressed; extract with uncompress
    .tar.Z       Compressed 'tape archive'; uncompress then untar or 

Section 2 of 3 - Prev - Next
All sections - 1 - 2 - 3

Back to category Programming - Use Smart Search
Home - Smart Search - About the project - Feedback

© allanswers.org | Terms of use

LiveInternet