Documentation: ajout de l option nobreak

[bclogo.git] / dev / doc / bclogo-doc.tex

diff --git a/dev/doc/bclogo-doc.tex b/dev/doc/bclogo-doc.tex
index f09f0ec..686059f 100644 (file)
--- a/dev/doc/bclogo-doc.tex
+++ b/dev/doc/bclogo-doc.tex
@@ -113,7 +113,7 @@ plus particuli
 {\large Extension \LaTeX{} pour la réalisation de boîtes colorées
   avec logos}\\[1cm]
 \parbox{0.6\textwidth}{
-  \includegraphics[width=5cm]{../../tex/latex/bclogo/bc-crayon.mps}
+  \includegraphics[width=5cm]{bc-crayon.mps}
 }\hfill
 \parbox{0.4\textwidth}{\Large\raggedleft
   \textbf{Contributeurs}\\
@@ -132,10 +132,21 @@ plus particuli
 \newpage
 
 \begin{abstract}
-Ce paquet permet la création, via \texttt{Pstricks} ou \texttt{Tikz}, de boîtes
-colorées avec un logo, un titre et une couleur de fond\footnote{Il y a bien
-entendu d'autres options}.
+Cette extension pour le format \LaTeX\ permet la création, via \texttt{Pstricks} ou \texttt{Tikz}, de boîtes
+colorées avec un logo, un titre et une couleur de fond. Depuis la
+version 3.0, \texttt{bclogo} se base sur l'extension \texttt{mdframed}
+de Marco \bsc{Daniel} et Elke \bsc{Schubert} pour permettre aux boîtes
+de se couper lors de changement de page.
 \end{abstract}
+\vspace*{4cm}
+
+\begin{center}
+  Nous tenons à remercier Jean-Michel \bsc{Sarlat} pour la mise à
+  disposition des outils de développement sur le serveur Syracuse
+  \url{http://melusine.eu.org/syracuse/G/bclogo/}, en particulier les
+  dépots git, mais aussi pour tout le travail de \og mise en forme\fg{} qu'il
+  réalise.
+\end{center}
 
 \newpage
 
@@ -173,16 +184,7 @@ ou \texttt{tikz} et ses librairies \texttt{shadows} et
  \verb+ifpdf+ sont nécessaires dans les deux utilisations.
 \end{bclogo}
 
-Depuis la version 3.0, bclogo utilise le paquet \emph{mdframed} qui autorise les coupures de boîtes en fin de page (ce qui n'était pas le cas auparavant). Les macros de ce paquet liées à l'affichage des boîtes, ont été redéfinies pour ajouter le titre, le logo, la barre et l'ombre éventuelle. Ces modifications sont dans les fichiers \emph{bclogoMdframedTikz.tex} et \emph{bclogoMdframedPst.tex}, ceux-ci sont chargés juste après \emph{mdframed}.
-
-\begin{demo}
-\begin{bclogo}[logo=\bcplume,couleur=AliceBlue,blur,epBord=0.8,couleurOmbre=gray,barre=wave,%
-                couleurBarre=red]{Exemple de coupure}%
-\lipsum[1-13]
-\end{bclogo}
-\end{demo}
-
-\subsection{Le chargement du paquet}
+\subsection{Chargement du paquet et utilisation}
 
 Depuis la version 2.0 de \texttt{bclogo}, le chargement s'effectue avec deux
 options, soit on utilise \texttt{pstricks} (par défaut)\footnote{Sur un conseil
@@ -196,8 +198,6 @@ lui.} soit \texttt{tikz}. Ceci s'effectue dans le pr
 \medskip
 \noindent\textbf{Remarque}: La syntaxe {\cmd\verb|\usepackage{bclogo}|} est équivalente à {\cmd\verb|\usepackage[pstricks]{bclogo}|}.
 
-\subsection{Utilisation}
-
 Quelle que soit l'option de chargement choisie, la syntaxe pour la création de boîtes est la même. Voici l'environnement pour réaliser une boîte (tous les réglages se font dans l'argument optionnel):
 
 \begin{small}%
@@ -209,6 +209,23 @@ Quelle que soit l'option de chargement choisie, la syntaxe pour la cr
 \end{Verbatim}
 \end{small}%
 
+\subsection{Coupure ou pas coupure?}
+
+Depuis la version 3.0, bclogo utilise le paquet \emph{mdframed} qui autorise les coupures de boîtes en fin de page (ce qui n'était pas le cas auparavant). Les macros de ce paquet liées à l'affichage des boîtes, ont été redéfinies pour ajouter le titre, le logo, la barre et l'ombre éventuelle. Ces modifications sont dans les fichiers \emph{bclogoMdframedTikz.tex} et \emph{bclogoMdframedPst.tex}, ceux-ci sont chargés juste après \emph{mdframed}.
+
+\begin{demo}
+\begin{bclogo}[logo=\bcplume,couleur=AliceBlue,blur,epBord=0.8,couleurOmbre=gray,barre=wave,%
+                couleurBarre=red]{Exemple de coupure}%
+\lipsum[1-13]
+\end{bclogo}
+\end{demo}
+
+La version 0.9 de \emph{mdframed} propose une option empêchant la coupure de la boîte, cette option est valable avec l'environnement \emph{bclogo}, c'est l'option 
+{\cmd\verb|nobreak=true/false|}. Par défaut sa valeur est \texttt{false}, ce qui autorise les coupures, pour les empêcher, il suffit de taper 
+{\cmd\verb|nobreak|} ou bien {\cmd\verb|nobreak=true|}.
+
+Si votre version de \emph{mdframed} est antérieure à la 0.9, nous vous recommandons vivement de la mettre à jour en téléchargeant la dernière version (archive Zip) sur le CTAN\footnote{\url{http://www.ctan.org/tex-archive/macros/latex/contrib/mdframed}}.
+
 \section{Réglages des couleurs}
 
 \subsection{Le fond et le texte}
@@ -234,7 +251,7 @@ La couleur de la barre (noir par d
 
 \subsection{\'Epaisseur du bord}
 
-On peut (depuis la version 2.24) régler l'épaisseur du trait de bord (0.4pt par défaut) grâce à l'option 
+On peut (depuis la version 2.24) régler l'épaisseur du trait de bord (0.4pt par défaut) grâce à l'option
 {\cmd\verb|epBord=<valeur>|} (attention, ne pas mettre d'unité). Par
 exemple:
 
@@ -573,11 +590,9 @@ commande {\cmd\verb|ombre=true|}. Par exemple:
 
 \subsection{Paramètres de l'ombre}
 
-\noindent\textbf{Épaisseur}: on règle l'épaisseur de l'ombre avec la commande \texttt{epOmbre =
-<\textrm{valeur en cm}>}. La valeur par défaut est de 0.125 cm.
+\noindent\textbf{Épaisseur}: on règle l'épaisseur de l'ombre avec la commande {\cmd\verb|epOmbre=<valeur en cm>|}. La valeur par défaut est de 0.125 cm.
 
-\noindent\textbf{Couleur}: on règle la couleur avec la commande \texttt{couleurOmbre =
-<\textrm{couleur}>}. La valeur par défaut est \textit{black}.
+\noindent\textbf{Couleur}: on règle la couleur avec la commande {\cmd\verb|couleurOmbre=<couleur>|}. La valeur par défaut est \textit{black}.
 
 Voici un exemple illustrant les deux options:
 
@@ -693,7 +708,7 @@ et ce \textbf{couple} avec la commande {\cmd\verb|motifBarre=<motif>|}. Par exem
 Si je dispose d'une image personnelle, par exemple
 \texttt{spir.mps}\footnote{Ici, j'utilise un \texttt{.mps} mais un utilisateur
 de \texttt{latex} peut très bien utiliser un \texttt{eps} et un utilisateur de \texttt{pdflatex} peut très  bien utiliser un \texttt{jpg},
-\texttt{pdf}\dots} \includegraphics{spir}, il suffit de mettre: 
+\texttt{pdf}\dots} \includegraphics{spir}, il suffit de mettre:
 
 \hfil{\cmd\verb+motifBarre=\includegraphics{spir}+}.\hfil
 
@@ -882,7 +897,8 @@ Par exemple:
 
 %\begin{lstlisting}[style=numbers, breaklines=true,breakindent=30pt]
 \lstset{style=numbers, breaklines=true,breakindent=30pt}
-\lstinputlisting{../../tex/latex/bclogo/bclogo.sty}
+%\lstinputlisting{../latex/bclogo.sty}%%%chemin pour Maxime
+\lstinputlisting{../../tex/latex/bclogo/bclogo.sty}%%chemin pour Patrick
 %\end{lstlisting}
 
 \end{document}