noweb

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Noweb
Original author(s) Norman Ramsey
Initial release 1989, 24–25 years ago
Stable release 2.11b[date missing]
Written in C, Awk, and Icon
Operating system Cross-platform
Available in English
Type Literate programming
Website http://www.cs.tufts.edu/~nr/noweb/

noweb is a literate programming tool, created in 1989–1999 by Norman Ramsey,[1] and designed to be simple, easily extensible and language independent.

As in WEB and CWEB, the main components of noweb are two programs: "notangle", which extracts 'machine' source code from the source texts, and "noweave", which produces nicely-formatted printable documentation.

noweb supports TeX, LaTeX, HTML, and troff back ends and works with any programming language. Besides simplicity this is the main advantage over WEB, which needs different versions to support programming languages other than Pascal. (Thus the necessity of CWEB, which supports C and similar languages.)

Noweb's input[edit]

A noweb input text contains program source code interleaved with documentation. It consists of so-called chunks that are either documentation chunks or code chunks.

A documentation chunk begins with a line that starts with an at sign (@) followed by a space or newline. A documentation chunk has no name. Documentation chunks normally contain LaTeX, but noweb is also used with HTML, plain TeX, and with troff.

Code chunks are named. A code chunk begins with

<<chunk name>>=

on a line by itself. The double left angle bracket (<<) must be in the first column.

Each chunk is terminated by the beginning of another chunk. If the first line in the file does not mark the beginning of a chunk, it is assumed to be the first line of a documentation chunk.

Code chunks aren't treated specially by noweb's tools—they may be placed in any order and, when needed, they are just concatenated. Chunk references in code are dereferenced and the whole requested source code is extracted.

Example of a simple noweb program[edit]

This is an example of a "hello world" program with documentation:

\section{Hello world}
 
Today I awoke and decided to write
some code, so I started to write Hello World in \textsf C.
 
<<hello.c>>=
/*
  <<license>>
*/
#include <stdio.h>
 
int main(int argc, char *argv[]) {
  printf("Hello World!\n");
  return 0;
}
@
\noindent \ldots then I did the same in PHP.
 
<<hello.php>>=
<?php
  /*
  <<license>>
  */
  echo "Hello world!\n";
?>
@
\section{License}
Later the same day some lawyer reminded me about licenses.
So, here it is:
 
<<license>>=
This work is placed in the public domain.

Assuming that the above code is placed in a file named 'hello.nw', the command to extract the human-readable document in HTML format is:

noweave -filter l2h -index -html hello.nw | htmltoc > hello.html

... and in LaTeX format:

noweave -index -latex hello.nw > hello.tex

To extract machine source code:

notangle -Rhello.c hello.nw > hello.c
notangle -Rhello.php hello.nw > hello.php

Compatibility[edit]

noweb defines a specific file format and a file is likely to interleave three different formats (noweb, latex and the language used for the software). This is not recognised by other software development tools and consequently using noweb excludes the use of UML or code documentation tools.

See also[edit]

Notes[edit]

  1. ^ Author's site

External links[edit]