lotus

previous page: 9.2. APLWEB (Unsupported Tools - Literate Programming)
  
page up: Literate Programming FAQ
  
next page: 9.4. mCWEB (Unsupported Tools - Literate Programming)

9.3. CLiP (Unsupported 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.

9.3. CLiP (Unsupported Tools - Literate Programming)


Developer:
E.W. van Ammers and M.R. Kramer

Versions:
2.0 and 2.4b (DOS only)

Platform:
Vax/VMS, Unix, DOS

Languages:
Any programming language

Formatter:
Any formatter (TeX, LaTeX, Troff, Runoff, HTML, etc) or any
wordprocessor including WYSIWYG systems (Word Perfect, WinWord,
Ami Pro, Word Pro, etc.)

Availability:
Anonymous ftp from:

o ftp://sun01.info.wau.nl:/CLIP/

o ftp://sun01.info.wau.nl:/CLIP/

o ftp://sun01.info.wau.nl:/CLIP/

o ftp://sun01.info.wau.nl:/CLIP/

o CTAN:/web/clip

o LPA:/machines/ms-dos

o LPA:/machines/vax

Readme:
With bundle above

Description:
CLiP does not use explicit commands to perform the extraction
process. Rather it recognizes pseudostatements written as
comments in the programming language in question. CLiP
distinguishes pseudostatements from ordinary comments because
the former comply with a particular style. This style can be
adjusted to suit virtually any programming language. The CLiP
approach to LP makes the system extremely versatile. It is
independent of programming language and text processing
environment. We designed CLiP to be compatible with hypertext
systems as well. Some hypertext examples are at:

o ftp://sun01.info.wau.nl/clip/html/

o ftp://sun01.info.wau.nl/clip/html/

Features:

o CLiP imposes virtually no limitations on the text-processing
system used to produce the documentation. If the text-processor
supports these items you can

o structure the documentation according to your own taste.

o include drawings, pictures, tables etc.

o disclose your documentation my means of X-ref tables, Indexes,
Table of contents, Table of tables, Table of figures, etc.

o typeset the documented code.

o Extracts any number of modules from a maximum of 64 source
files.

o No pretty-printing. Code from the source files is copied "as is"
to the module.

o Appearance of code segments in the documentation matches those
of the modules to ease the identification of code segments.

o Supports partially specified data types.

o Comprehensive user manual (preliminary version) and technical
description.

o No automatic generation of a X-ref table for program
identifiers.

Support:
Bugs, problems and assistance by e-mail to
<Eric.vanAmmers@user.info.wau.nl>

 

Continue to:













TOP
previous page: 9.2. APLWEB (Unsupported Tools - Literate Programming)
  
page up: Literate Programming FAQ
  
next page: 9.4. mCWEB (Unsupported Tools - Literate Programming)