Author: tziade
Date: Sun Mar 12 01:53:35 2006
New Revision: 2600

Modified:
   cookbook/trunk/recipe48.fr.tex
Log:
added reST links quick explanation

Modified: cookbook/trunk/recipe48.fr.tex
==============================================================================
--- cookbook/trunk/recipe48.fr.tex      (original)
+++ cookbook/trunk/recipe48.fr.tex      Sun Mar 12 01:53:35 2006
@@ -16,15 +16,17 @@
 ce contenu pour le transformer en HTML, LaTeX, XML ou PDF.
 
 Cette recette est une \textit{cheatsheet} minimale, qui permet d'�crire des
-doctests destin�s � des paquets Zope.
+doctests destin�s � des paquets Zope, une documentation plus compl�te pouvant
+�tre trouv� � cette url:
+\url{http://docutils.sourceforge.net/rst.html}.
 \end{problem}
 
 \begin{solution}
 \section*{Structurer le fichier}
 Pour organiser un fichier en section, sous-section, sous-sous-section, etc.,
 il suffit de souligner le titre de la section avec un caract�re dans 
l'ensemble:
-\code{\/-=} ** a v�rifier **. A chaque section, si un nouveau caract�re est
-utilis�, reST l'associe au niveau donn� pour le reste du document.
+\code{``= - ` : ' " ~ ^ _ * + # < >``}. A chaque section, si un nouveau
+caract�re est utilis�, reST l'associe au niveau donn� pour le reste du 
document.
 
 \codetitle{Exemple de structure reST:}
 \begin{verbatim}
@@ -95,7 +97,45 @@
 ou tout �l�ment de code dans le texte. La notation grasse est r�serv�e � la
 mise en valeur de mots du texte.
 
-Pour les liens, AFINIR
+Pour les liens, les deux types les plus courants sont les liens complets
+vers des ressources web (URL), et les liens vers une autre partie du document.
+
+Les URL peuvent �tre associ�s � un texte mis entre simple quotes, et suivit
+d'un espace soulign�. Ce texte est ensuite r�p�t� en bas de document, pr�c�d�
+de la s�quence ".. _", puis de l'url pr�c�d� du symbole ":".
+
+\codetitle{Exemple d'url:}
+\begin{verbatim}
+Ordonnance
+==========
+
+Matin et soir : un tour sur `zope-cookbook`
+Midi: Ne pas oublier le suppositoire.
+
+.. _`zope-cookbook`: http://zope-cookbook.org
+\end{verbatim}
+\begin{codenotes}
+La r�f�rence en bas de page disparait bien s�r, lorsque le texte est par
+exemple g�n�r� en HTML ou PDF.
+\end{codenotes}
+
+Pour d�finir des liens dans le document m�me, le m�me type de marquage est
+employ�, sauf pour la section cible: la phrase r�p�t�e est suivi uniquemement
+de ":".
+
+\codetitle{Exemple de r�f�rences dans le document:}
+\begin{verbatim}
+Ordonnance
+==========
+
+Matin et soir : un tour sur `zope-cookbook`
+_`suppositoire`
+Midi: Ne pas oublier le suppositoire.
+
+_`zope-cookbook`:
+Zope-cookbook.org est un site tr�s sympa. Mais avant d'y aller,
+avez vous pens� � votre `suppositoire`_ ?
+\end{verbatim}
 
 \section*{Bonnes pratiques en vrac}
 
-- 
http://lists.nuxeo.com/mailman/listinfo/z3lab-checkins

Reply via email to