lotus

previous page: 10.5. dpp (Other tools - Literate Programming)
  
page up: Literate Programming FAQ
  
next page: 10.7. Funnelweb Mode (Other tools - Literate Programming)

10.6. Fold2Web (Other tools - Literate Programming)




Description

This article is from the Literate Programming FAQ, by David B. Thompson thompson@shelob.ce.ttu.edu with numerous contributions by others.

10.6. Fold2Web (Other tools - Literate Programming)


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

 

Continue to:













TOP
previous page: 10.5. dpp (Other tools - Literate Programming)
  
page up: Literate Programming FAQ
  
next page: 10.7. Funnelweb Mode (Other tools - Literate Programming)