Norman Ramsey, puis Lee Wittenberg et Carl Gregory
En début d'une ligne,
@
commence un bloc de documentation.
Le texte est en LATEX.
Pour incorporer des fragments de code, utilisez [[...]]
.
noweave encapsule automatiquement le fichier entre
\documentclass{article} \usepackage{noweb} \begin{document} (...)
et
(...) \end{document}
Pour éviter cette encapsulation,
\documentclass
et \usepackage
$ noweave -delay
En début d'une ligne,
<<...nom_du_bloc...>>=
commence un bloc de code en n'importe quel langage.
Utilisez <<...>>
pour inclure d'autres blocs de code par leur référence
Vous pouvez écrire plusieurs blocs de code avec le même nom, ils seront concaténés.
Nommez les blocs :
<<foo.c>>=
ou <<foo.h>>=
. notangle -L -Rfoo.c foo.nw > foo.c | Extrait le fichier foo.c, avec numéros de lignes |
---|---|
notangle -Rfoo.h foo.nw | cpif foo.h | Extrait le fichier foo.h s’il a changé (sans numéros de lignes). |
noweave -filter l2h -index -html foo.nw > foo.html | Crée du HTML en convertissant la documentation LATEX. |
noweave -x foo.nw > foo.tex | Crée un document LATEX avec références croisées, sans index. |
latex foo; latex foo | Traiter LATEX en un fichier dvi (« indépendant du périphérique ») |
latex ’\scrollmode \input foo’ | une autre commande LATEX à utiliser dans Makefile. |
dvips -o foo.ps foo | Convertit foo.dvi en PostScript. |
% \ { } $ & # ^ _ ~
Échappement pour les caractères spéciaux :
\% $\backslash$ \{ \} \$ \& \# \_
\title{...} \author{...} \maketitle
\section{...} \subsection{...} \subsubsection{...}
\emph{emphasis} \textbf{bold} \texttt{typewriter} \textit{italics} \textsf{sans serif} \textsc{small caps}
List of items \begin{itemize} \item one \item two \item three \end{itemize}
donne :
List of items
List of items \begin{enumerate} \item one \item two \item three \end{itemize}
donne :
List of items