{{tag>tutoriel}}

====== Utiliser NoWeb avec LATEX : guide d'utilisation en une page ======

<WRAP centeralign>
Norman Ramsey, puis Lee Wittenberg et Carl Gregory
</WRAP>

===== Le fichier noweb foo.nw =====

==== Blocs de documentation ====

En début d'une ligne, <code - >@</code>commence un bloc de documentation.

<WRAP center round info 60%>
Le texte est en LATEX.

Pour incorporer des fragments de code, utilisez ''%%[[...]]%%''.

<WRAP center round tip 60%>
**noweave** encapsule automatiquement le fichier entre<code - >
\documentclass{article}
\usepackage{noweb}
\begin{document}
(...)
</code>
et
<code - >
(...)
\end{document}
</code>

Pour éviter cette encapsulation,
  * mettez dans votre source ''%%\documentclass%%'' et ''%%\usepackage%%''
  * et utilisez<cli>
$ noweave -delay
</cli>
</WRAP>

</WRAP>

==== Blocs de code ====

En début d'une ligne,<code - ><<...nom_du_bloc...>>=</code> commence un bloc de code en n'importe quel langage.

<WRAP center round info 60%>
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 :
  * dans les fonctions, avec des verbes, par exemple, (//copier toutes les lignes de l'intérieur vers l'extérieur, en ajoutant un balisage//).
  * blocs contenant des déclarations, avec des noms, par exemple, (//prototypes de fonctions privées) ou (définitions de fonctions exportées//).
  * fragments **racine** de niveau supérieur, d'après les fichiers qu'ils doivent représenter, par exemple, ''%%<<foo.c>>=%%'' ou ''%%<<foo.h>>=%%''.
</WRAP>

===== Commandes typiques =====

<WRAP center round box 60%>
^ <code>notangle -L -Rfoo.c foo.nw > foo.c</code>                  | Extrait le fichier foo.c, avec numéros de lignes                     |
^ <code>notangle -Rfoo.h foo.nw | cpif foo.h</code>                | Extrait le fichier foo.h s’il a changé (sans numéros de lignes).     |
^ <code>noweave -filter l2h -index -html foo.nw > foo.html</code>  | Crée du HTML en convertissant la documentation LATEX.                |
^ <code>noweave -x foo.nw > foo.tex</code>                         | 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.                                 |
</WRAP>

===== LATEX minimal =====

  * **Caractères spéciaux** (à ne pas taper dans du texte, utilisables dans le code) :<code>% \ { } $ & # ^ _ ~</code>**Échappement** pour les caractères spéciaux :<code>\% $\backslash$ \{ \} \$ \& \# \_</code>
  * **Une ligne vide** est un nouveau paragraphe.
  * **Écrivez %%‘‘quotes’’%%** pour obtenir %%“quotes”%% Jamais "quotes".
  * **Titres** :
<WRAP center round box 60%>
<code>\title{...}
\author{...}
\maketitle</code>
</WRAP>
  * **Sections** :
<WRAP center round box 60%>
<code>\section{...}
\subsection{...}
\subsubsection{...}</code>
</WRAP>
  * **Polices** :
<WRAP center round box 60%>
<code>\emph{emphasis}
\textbf{bold}
\texttt{typewriter}
\textit{italics}
\textsf{sans serif}
\textsc{small caps}</code>
</WRAP>
  * **Listes** :
<WRAP center round box 60%><code>List of items
\begin{itemize}
\item one
\item two
\item three
\end{itemize}</code>
donne :

List of items
  * one
  * two
  * three
</WRAP>
  * **Listes numérotées** :
<WRAP center round box 60%><code>List of items
\begin{enumerate}
\item one
\item two
\item three
\end{itemize}</code>
donne :

List of items
  - one
  - two
  - three
</WRAP>

===== Voir aussi =====

  * **(en)** [[https://www.cs.tufts.edu/~nr/noweb/onepage.ps]]

----
//Basé sur << [[https://www.cs.tufts.edu/~nr/noweb/onepage.ps|A One-Page Guide to Using noweb with L A TEX]] >> par Norman Ramsey.//