Nouvelle version de la documentation
[bclogo.git] / dev / doc / bclogo-doc.tex
1 \documentclass[a4paper,10pt,frenchb]{article}
2 \usepackage[latin1]{inputenc}
3 \usepackage{lmodern}
4 \usepackage[charter]{mathdesign}
5 %\usepackage[scaled=0.875]{helvet}
6 \renewcommand{\ttdefault}{lmtt}
7 \usepackage{framed}
8 \usepackage[svgnames]{xcolor}
9 \usepackage[tikz]{bclogo}
10 \usepackage{fancyvrb}
11 \usepackage{fancyhdr}%style fancy
12 \usepackage[margin=2.5cm,headheight=15pt]{geometry}
13 \usepackage{amsmath}
14 \usepackage{multicol}
15 \usepackage{listings}
16 \usepackage{pifont}
17 \usepackage{lipsum}
18 \usepackage{mflogo}
19 \usepackage{longtable,microtype}
20 \usepackage{url,lastpage}
21 \definecolor{cPG}{RGB}{235, 227, 150}%
22 \definecolor{link}{RGB}{150, 81, 0}%
23 \definecolor{url}{rgb}{0, .3, .03}%
24 \definecolor{vert}{RGB}{0,105,29}%
25 \definecolor{bleu}{RGB}{78,88,169}%
26 \usepackage[colorlinks, linkcolor=link,urlcolor=url]{hyperref}
27 \usepackage{numprint,babel}
28 %
29 \pagestyle{fancyplain}
30 \renewcommand{\sectionmark}[1]{\markright{#1}}
31 %\lhead[\fancyplain{}{\slshape\thepage}]{\fancyplain{}{\slshape\rightmark}}
32 %\rhead[\fancyplain{}{\slshape\leftmark}]{\fancyplain{}{\slshape\thepage}}
33 %\lhead{\chaptername}
34 \lhead{\rightmark}%
35 \rhead{\textsl{bclogo v3.0}}%
36 \lfoot{\footnotesize Maxime \textsc{Chupin} \& Patrick \textsc{Fradin}}%
37 \cfoot{\footnotesize -- \url{http://melusine.eu.org/syracuse/G/bclogo/} -- }%
38 \rfoot{\thepage/\pageref{LastPage}}%
39
40 %\usetikzlibrary{decorations.pathmorphing}
41 \usetikzlibrary{shapes}
42 \definecolor{fbase}{gray}{0.95}%
43 \newenvironment{gbar}[1]{%
44 \def\FrameCommand{{\color{#1}\vrule width 3pt}\colorbox{fbase}}%
45 \MakeFramed{\advance\hsize-\width\FrameRestore}}%
46 {\endMakeFramed}%
47
48 \lstset{% general command to set parameter(s)
49 basicstyle=\small, % print whole listing small
50 keywordstyle=\color{bleu}\ttfamily,
51 % underlined bold black keywords
52 % identifierstyle=,
53 basicstyle=\ttfamily\footnotesize, % nothing happens
54 commentstyle=\itshape\color{vert}, % white comments
55 stringstyle=\ttfamily, % typewriter type for strings
56 showstringspaces=false,
57 language=[LaTeX]TeX,
58 defaultdialect=[LaTeX]TeX,
59 morekeywords={RequirePackage}
60 }
61 \lstdefinestyle{numbers}%
62 {numbers=left, stepnumber=1, numberstyle=\tiny, numbersep=10pt}%
63
64 \newenvironment{enum}{%
65 \begin{dingautolist}{202}}%
66 {\end{dingautolist}}%
67
68 \newenvironment*{Code}{%
69 \begin{bclogo}[margeG=1,logo=\bccrayon,couleurBarre=Gray,barre=wave,noborder]{Code}%
70 }%
71 {%
72 \end{bclogo}
73 }%
74
75 \newenvironment*{demo}{%
76 \VerbatimOut{toto.txt}%
77 }%
78 {%
79 \endVerbatimOut%
80 \begin{bclogo}[margeG=1,logo=\bccrayon,couleurBarre=Gray,barre=wave,noborder]{Code}%
81 \begin{footnotesize}%
82 \lstinputlisting{toto.txt}%
83 \end{footnotesize}%
84 \end{bclogo}%
85 \noindent\textbf{Résultat}:\par\smallskip
86 \input{toto.txt}%
87 }%
88
89 \newcommand*\cmd{\color{Maroon}}%
90
91 \definecolor{cPG}{RGB}{235, 227, 150}%
92
93 \title{\texttt{bclogo} version 3.0}
94 \author{ Maxime \textsc{Chupin} et Patrick \textsc{Fradin}
95 \footnote{Merci à tous ceux qui ont participé, entre autres, Jean-Côme \textsc{Charpentier},
96 Ulrike \textsc{Fischer} et Manuel \textsc{Pégourié-Gonnard}\dots et
97 plus particulièrement à François \textsc{Pétiard}}\\\url{notezik@gmail.com}}
98 \date{21 juillet 2012}
99
100 \begin{document}
101 %% === Page de garde ===================================================
102 \thispagestyle{empty}
103 \begin{tikzpicture}[remember picture, overlay]%
104 \node[below right, shift={(-4pt,4pt)}] at (current page.north west) {%
105 \includegraphics{fond.pdf}%
106 };
107 \end{tikzpicture}%
108
109 \noindent
110 \includegraphics{bclogo}\\
111 {\large Extension \LaTeX{} pour la réalisation de boîtes colorées
112 avec logos}\\[1cm]
113 \parbox{0.6\textwidth}{
114 \includegraphics[width=5cm]{bc-crayon.mps}
115 }\hfill
116 \parbox{0.4\textwidth}{\Large\raggedleft
117 \textbf{Contributeurs}\\
118 Patrick \bsc{Fradin}\\
119 Maxime \textsc{Chupin}\\
120 \textbf{Email}\\
121 \url{notezik@gmail.com}
122 }
123 \vfill
124 \begin{center}
125 Version 3.0 du 15 octobre 2011\\
126 \url{http://melusine.eu.org/syracuse/G/bclogo/}\\
127 \includegraphics[width=6cm]{syracuse-crop}
128 \end{center}
129 %% == Page de garde ====================================================
130 \newpage
131
132 \begin{abstract}
133 Cette extension pour le format \LaTeX\ permet la création, via \texttt{Pstricks} ou \texttt{Tikz}, de boîtes
134 colorées avec un logo, un titre et une couleur de fond. Depuis la
135 version 3.0, \texttt{bclogo} se base sur l'extension \texttt{mdframed} (version 1.5 ou ultérieure) de
136 Marco \bsc{Daniel} et Elke \bsc{Schubert} pour permettre aux boîtes
137 de se couper lors de changement de page.
138 \end{abstract}
139 \vspace*{4cm}
140
141 \begin{center}
142 Nous tenons à remercier Jean-Michel \bsc{Sarlat} pour la mise à
143 disposition des outils de développement sur le serveur Syracuse
144 \url{http://melusine.eu.org/syracuse/G/bclogo/}, en particulier les
145 dépots git, mais aussi pour tout le travail de \og mise en forme\fg{} qu'il
146 réalise.
147 \end{center}
148
149 \newpage
150
151 \tableofcontents
152 \newpage
153
154 \section{Introduction}
155
156 \subsection{Présentation}
157
158 Ce paquet a été créé pour faciliter la fabrication de boîtes colorées plus ou
159 moins complexes disposant d'un titre, d'un logo et d'une couleur de fond pour une mise en relief du contenu.
160 Depuis la version 2.0, \texttt{bclogo} s'appuie sur
161 \texttt{Pstricks} \textbf{ou} sur \texttt{tikz}. Ce paquet utilise \texttt{xkeyval} pour la gestion des
162 paramètres. Pour son bon fonctionnement, il est nécessaire d'avoir les extensions suivants
163 installées sur votre machine:
164
165 \begin{bclogo}[couleur=cPG, logo=\bcattention, cadreTitre=true, arrondi=0.1]{Les extensions \textit{indispensables}}%
166 \begin{multicols}{2}
167 \begin{enum}
168 \item \verb+mdframed+ (coupure des boîtes, version 1.5 ou plus)
169 \item \verb+graphicx+
170 \item \verb+xkeyval+
171 \item \verb+ifthen+
172 \item \verb+ifpdf+
173 \end{enum}
174 \end{multicols}
175 \noindent Si l'on utilise \texttt{Pstricks}
176 \begin{multicols}{2}
177 \begin{enum}
178 \item \verb+Pstricks+
179 \item \verb+pst-grad+
180 \item \verb+pst-coil+
181 \item \verb+pst-blur+ si l'on souhaite utiliser la fonction (voir section \ref{blur})
182 \end{enum}
183 \end{multicols}
184 \noindent ou si l'on utilise \texttt{tikz}
185 \begin{enum}
186 \item \verb+tikz+ et ses librairies \texttt{shadows} et
187 \texttt{decorations.pathmorphing}
188 \end{enum}
189 \end{bclogo}
190
191 \subsection{Chargement du paquet et utilisation}
192
193 Depuis la version 2.0 de \texttt{bclogo}, le chargement s'effectue avec deux
194 options, soit on utilise \texttt{pstricks} (par défaut)\footnote{Sur un conseil
195 d'Herbert \textsc{Voss} qui vérifie à chaque nouvelle version le code, merci à
196 lui.} soit \texttt{tikz}. Ceci s'effectue dans le préambule du document
197 \LaTeX{}:
198
199 \medskip
200 \hfil{\cmd\verb|\usepackage[tikz]{bclogo}|} ou {\cmd\verb|\usepackage[pstricks]{bclogo}|.}\hfil
201
202 \medskip
203 \noindent\textbf{Remarque}: La syntaxe {\cmd\verb|\usepackage{bclogo}|} est équivalente à {\cmd\verb|\usepackage[pstricks]{bclogo}|}.
204
205 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):
206 \begin{Code}
207 \begin{lstlisting}
208 \begin{bclogo}[<options>]{Titre}
209 Corps de la boite...
210 \end{bclogo}
211 \end{lstlisting}
212 \end{Code}
213
214 Voici ce que donne les paramètres par défaut
215 \begin{demo}
216 \begin{bclogo}{Mon Titre}
217 \lipsum[1]
218 \end{bclogo}
219 \end{demo}
220
221
222 \section{Réglages des couleurs}
223
224 \subsection{Le fond et le texte}
225
226 La couleur du fond (blanc par défaut) se définit avec l'option
227 {\cmd\verb|couleur=<macouleur>|}, et la couleur du texte (noir par
228 défaut) se définit avec l'option
229 {\cmd\verb|couleurTexte=<couleur>|}. Il est préférable de ne pas fixer
230 la couleur du texte dans l'environnement \emph{bclogo} car en cas de
231 coupure de boîte (voir section~\ref{sec:coupure}), seule la première
232 partie aura la bonne couleur.
233
234 \subsection{Le bord}
235
236 La couleur du cadre (noir par défaut) se définit avec l'option
237 {\cmd\verb|couleurBord=<couleur>|}\footnote{Cette nouvelle option a
238 été créée sur la demande de Philippe \bsc{Fortemps}.}
239
240 \subsection{La barre}
241
242 La couleur de la barre (noir par défaut) se définit avec l'option
243 {\cmd\verb|couleurBarre=<couleur>|}.
244
245 Voici un exemple récapitulatif de la gestion des couleurs :
246 \begin{demo}
247 \begin{bclogo}[couleur=blue!20,couleurTexte=DarkRed,couleurBord=DarkRed,couleurBarre=DarkRed]{Mon
248 Titre}
249 \lipsum[1]
250 \end{bclogo}
251 \end{demo}
252
253 \section{Le bord}
254
255 \subsection{\'Epaisseur du bord}
256
257 On peut (depuis la version 2.24) régler l'épaisseur du trait de bord
258 (\numprint[pt]{0.4} par défaut) grâce à l'option
259 {\cmd\verb|epBord=<valeur>|} (attention, ne pas mettre d'unité). Par
260 exemple:
261
262 \begin{demo}
263 \begin{bclogo}[epBord=2]{Mon titre}
264 \lipsum[1]
265 \end{bclogo}
266 \end{demo}
267
268 \subsection{L'arrondi des coins}
269
270 On règle la taille de l'arrondi avec l'option
271 {\cmd\verb|arrondi=<valeur>|}\footnote{Avant la version 2.22, les
272 arrondis
273 pstricks étaient relatifs, ils sont maintenant absolus.}. L'unité est
274 le cm et ne doit pas figurer. Par défaut l'arrondi vaut $0$. Exemple:
275
276 \begin{demo}
277 \begin{bclogo}[couleur=blue!30,arrondi=0.1]{Mon Titre}
278 \lipsum[1]
279 \end{bclogo}
280 \end{demo}
281
282 \subsection{Supprimer le bord}
283
284 Par défaut, il y a un trait pour délimiter le bord de la boîte, on
285 peut cependant choisir de ne pas en mettre avec l'option
286 {\cmd\verb|noborder=true|} (par défaut elle est à \texttt{false}). Par
287 exemple:
288
289 \begin{demo}
290 \begin{bclogo}[noborder=true,couleurBarre=DarkRed]{Mon
291 titre}
292 \lipsum[1]
293 \end{bclogo}
294 \end{demo}
295
296 \section{Les marges}
297
298 \subsection{Marge intérieure}
299
300 On peut régler les marges entre le texte de la boîte et le bord avec
301 l'option {\cmd\verb|marge=<entier>|}. Cette marge est définie en
302 nombre de points, sa valeur par défaut est $3$ (ne pas mettre
303 l'unité). Cette nouvelle option\footnote{Due à Patrick \textsc{Fradin}
304 sur une demande de Gaétan \textsc{Marris}} permet, entre autre, de
305 prolonger le texte jusqu'à la marge droite de la page lorsque
306 {\cmd\verb|noborder=true|} et que la marge extérieure droite est
307 nulle. Par exemple:
308
309 \begin{demo}
310 \begin{bclogo}[logo=\bccrayon,noborder=true,marge=0]{Mon titre}%
311 \lipsum[2]
312 \end{bclogo}
313 \begin{bclogo}[logo=\bccrayon,marge=8]{Mon titre}%
314 \lipsum[2]
315 \end{bclogo}
316 \end{demo}
317
318 \subsection{Marges extérieures}
319
320 Il est possible de laisser une marge à gauche de la boîte et une marge
321 à droite de la boîte. Ces marges sont nulles par défaut et peuvent
322 être mofiées par les options {\cmd\verb|margeG=<valeur>|} et
323 {\cmd\verb|margeD=<valeur>|}, l'unité est le centimètre et ne doit pas
324 être précisée. Ces valeurs peuvent être négatives. Exemple:
325
326 \begin{demo}
327 \begin{bclogo}[margeG=-1,margeD=1,couleur=blue!30]{Modification marges}%
328 \lipsum[2]
329 \end{bclogo}
330 \end{demo}
331
332 \section{Le titre}
333
334 \subsection{Styles de titre}
335
336 Il y a deux styles de titre. Celui par défaut (ou avec la commande
337 {\cmd\verb|cadreTitre=false|}) est celui utilisé pour les boîtes précédentes. On
338 peut cependant le modifier grâce à la commande:
339
340 \hfil{\cmd\verb|\renewcommand\bcStyleTitre[1]{\centering\large\textsl{#1}}|}\hfil
341
342 Ce qui produit:
343 \renewcommand\bcStyleTitre[1]{\centering\large\textsl{#1}}
344
345 \begin{bclogo}[couleur=blue!30, arrondi=0.1]{Mon Titre}
346 \lipsum[1]
347 \end{bclogo}
348
349 Par défaut, \verb+\bcStyleTitre+ est définie comme cela:
350
351 \hfil{\cmd\verb|\renewcommand\bcStyleTitre[1]{\large\textbf{#1}}|}\hfil
352
353 \renewcommand\bcStyleTitre[1]{\large\textbf{#1}}
354 On peut alors s'amuser à toutes sortes de choses. En voici un exemple:
355
356 \begin{demo}
357 \renewcommand\bcStyleTitre[1]{\centering\tikz\node[fill=blue!20,starburst,draw=black]{#1};}%
358 \begin{bclogo}[noborder]{Mon Titre}%
359 \lipsum[1]
360 \end{bclogo}
361 \end{demo}
362
363 \renewcommand\bcStyleTitre[1]{\large\textbf{#1}}
364
365 Le second style, plus élaboré mais non modifiable, est un cadre avec un
366 gradient de couleur \textit{gold}. Ceci s'obtient avec l'option
367 {\cmd\verb|cadreTitre=true|}.
368
369 \begin{demo}
370 \begin{bclogo}[couleur=blue!30,arrondi=0.1,cadreTitre]{Mon Titre}%
371 \lipsum[1]
372 \end{bclogo}
373 \end{demo}
374
375 \subsection{Sous-titre}
376
377 Si on utilise le style de titre sans cadre (\textit{i.e.} le style par
378 défaut) alors on peut définir un sous-titre grâce à la commande
379 {\cmd\verb|sousTitre=<Monsous-titre>|}
380 \footnote{Cette option a été mise en place sur la demande de Gaétan
381 \textsc{Marris}}. Par exemple:
382
383 \begin{demo}
384 \begin{bclogo}[couleur=blue!30,arrondi=0.1,sousTitre=Sous-titre]{Mon Titre}%
385 \lipsum[2]
386 \end{bclogo}
387 \end{demo}
388
389 \noindent\textbf{Le style du sous-titre}: on peut redéfinir le style
390 de sous-titre comme ceci:
391
392 \hfil{\cmd\verb|\renewcommand\bcStyleSousTitre[1]{\hfill\textsl{#1}}|}\hfil
393
394 \renewcommand\bcStyleSousTitre[1]{\hfill\textsl{#1}}
395
396 On obtient alors:
397
398 \begin{bclogo}[couleur=blue!30,arrondi=0.1,sousTitre=Sous-titre]{Mon Titre}
399 \lipsum[2]
400 \end{bclogo}
401
402 Dans \texttt{bclogo}, \verb+\bcStyleSousTitre+ est définie comme ceci:
403
404 \hfil{\cmd\verb|\newcommand\bcStyleSousTitre[1]{\normalsize\textit{#1}}|}\hfil
405
406 \renewcommand\bcStyleSousTitre[1]{\normalsize\textit{#1}}
407
408 Il faut juste se dire que l'on se trouve dans une case d'un tableau,
409 ainsi des constructions plus complexes sont envisageables.
410
411 Dans les versions antérieures à la
412 version 3.0 de \texttt{bclogo}, la commande était
413 \verb+\styleSousTitre+. Dans un soucis de rétrocompatibilité,
414 celle-ci a le même effet.
415
416 \section{Les logos}
417
418 \subsection{Création de logos}
419
420 C'est là que réside l'originalité de \texttt{bclogo}\dots{} Pour la
421 plupart des logos, je les ai dessinés avec \textit{Inkscape}.
422 Pour d'autres, Patrick \bsc{Fradin} et Alphonse \bsc{Capriani} ont
423 utilisé le
424 super \TeX{}graph.
425
426 Depuis la version 2.6\footnote{Dans les versions précédentes, deux
427 formats étaient utilisés, soit \texttt{eps}, soit
428 \texttt{pdf}. La conversion en masse a été réalisée grâce à
429 l'utilitaire \texttt{pstoedit}.}, on passe\footnote{Sur une
430 initiative de
431 François \bsc{Pétiard}.} par \MP{} pour générer des fichiers
432 \texttt{.mps} qui sont interprétés en eps ou en pdf selon le mode dans
433 lequel on se trouve (d'où la nécessité de l'extension \verb+ifpdf+).
434
435 La création de logo est un travail amusant, ceux qui veulent y
436 participer n'ont
437 qu'à me contacter par mail (les logos sont définis avec une largeur de
438 \numprint[pt]{17}, la
439 hauteur est plus ou moins libre dans la mesure du raisonnable).
440 Si vous souhaitez participer à l'élaboration de logos, fournissez moi
441 soit un fichier \MP{}, soit un fichier
442 \texttt{eps}.
443
444 Je remercie tout ceux qui participent à la création de logo et en particulier
445 Alphonse \bsc{Capriani} et François \bsc{Pétiard} qui ont bien
446 augmenté la collection.
447
448 \subsection{Liste des logos}
449
450 Le choix des drapeaux n'est pas délibéré, ce sont des contributions,
451 vous pouvez bien sûr augmenter la collection !
452
453 \begin{longtable}{cccc}
454 Nom & Commande & Image & Auteur \\\hline\endhead
455 \hline &&&\hfill suite\dots\\\endfoot
456 \hline&&&\endlastfoot
457 la fleur& \verb+\bcfleur+ & \bcfleur & Maxime \bsc{Chupin}\\
458 \og{}en chantier\fg{}&\verb+\bcpanchant+&\bcpanchant&Jean-Michel
459 \textsc{Sarlat}\\
460 la note&\verb+\bcnote+&\bcnote&Thomas \textsc{Labarussias}\\
461 l'étoile& \verb+\bcetoile+&\bcetoile& Maxime \bsc{Chupin}\\
462 l'ourson& \verb+\bcours+&\bcours&"\\
463 \og{}attention\fg{}&\verb+\bcattention+&\bcattention& "\\
464 le c\oe{}ur&\verb+\bccoeur+&\bccoeur&"\\
465 ornement&\verb+\bcorne+&\bcorne&"\\
466 danger&\verb+\bcdanger+&\bcdanger&François \textsc{Boerkmann}\\
467 smiley heureux&\verb+\bcsmbh+&\bcsmbh&"\\
468 smiley malheureux&\verb+\bcsmmh+&\bcsmmh&"\\
469 take care&\verb+\bctakecare+&\bctakecare&Patrick \textsc{Fradin}\\
470 la lampe& \verb+\bclampe+&\bclampe&"\\
471 le livre&\verb+\bcbook+&\bcbook&"\\
472 le trèfle&\verb+\bctrefle+&\bctrefle&Maxime \bsc{Chupin}\\
473 le point d'interrogation&\verb+\bcquestion+&\bcquestion&"\\
474 le crayon& \verb+\bccrayon+&\bccrayon&Anne-Sophie
475 \textsc{Philippe}\\
476 le pique de \LaTeX{}&\verb+\bcspadesuit+&\bcspadesuit&\LaTeX\\
477 logo info&\verb+\bcinfo+&\bcinfo&Thomas \textsc{Labarussias}\\
478 la plume& \verb+\bcplume+&\bcplume& Maxime \bsc{Chupin}\\
479 la bombe& \verb+\bcbombe+&\bcbombe&Alphonse \bsc{Capriani}\\
480 le cube&\verb+\bccube+&\bccube&"\\
481 le dodécaèdre&\verb+\bcdodecaedre+&\bcdodecaedre&"\\
482 l'icosaèdre&\verb+\bcicosaedre+&\bcicosaedre&"\\
483 l'octaèdre&\verb+\bcoctaedre+&\bcoctaedre&"\\
484 le tétraèdre&\verb+\bctetraedre+&\bctetraedre&"\\
485 l'Allemagne&\verb+\bcdallemagne+&\bcdallemagne&"\\
486 l'Autriche&\verb+\bcdautriche+&\bcdautriche&François \bsc{Pétiard}\\
487 la Belgique&\verb+\bcdbelgique+&\bcdbelgique&Alphonse
488 \bsc{Capriani}\\
489 la Bulgarie&\verb+\bcdbulgarie+&\bcdbulgarie&François
490 \bsc{Pétiard}\\
491 la France&\verb+\bcdfrance+&\bcdfrance&Alphonse
492 \bsc{Capriani}\\
493 l'Italie&\verb+\bcditalie+&\bcditalie&"\\
494 le Luxembourg&\verb+\bcdluxembourg+&\bcdluxembourg&François
495 \bsc{Pétiard}\\
496 les Pays-Bas&\verb+\bcdpaysbas+&\bcdpaysbas&Alphonse
497 \bsc{Capriani}\\
498 le soleil&\verb+\bcsoleil+&\bcsoleil&"\\
499 l'éclaircie&\verb+\bceclaircie+&\bceclaircie&"\\
500 la pluie&\verb+\bcpluie+&\bcpluie&"\\
501 la neige&\verb+\bcneige+&\bcneige&"\\
502 le sens interdit&\verb+\bcinterdit+&\bcinterdit&"\\
503 le poisson&\verb+\bcpoisson+&\bcpoisson&"\\
504 l'horloge&\verb+\bchorloge+&\bchorloge&"\\
505 le calendrier&\verb+\bccalendrier+&\bccalendrier&"\\
506 la rose des vents&\verb+\bcrosevents+&\bcrosevents&"\\
507 le yin et le yang&\verb+\bcyin+&\bcyin&"\\
508 danger glissant&\verb+\bcdz+&\bcdz&Vincent \bsc{Pantaloni}\\
509 le vélo&\verb+\bcvelo+&\bcvelo&François \bsc{Pétiard}\\
510 le \emph{peace and love}&\verb+\bcpeaceandlove+&\bcpeaceandlove&"\\
511 l'\oe il&\verb+\bcoeil+&\bcoeil&"\\
512 le nucléaire& \verb+\bcnucleaire+&\bcnucleaire&"\\
513 la femme&\verb+\bcfemme+&\bcfemme&"\\
514 l'homme&\verb+\bchomme+&\bchomme&"\\
515 la loupe&\verb+\bcloupe+&\bcloupe&"\\
516 le recyclage&\verb+\bcrecyclage+&\bcrecyclage&"\\
517 le valet de c\oe ur&\verb+\bcvaletcoeur+&\bcvaletcoeur&"\\
518 la clé&\verb+\bccle+&\bccle&"\\
519 la clé de fa&\verb+\bcclefa+& \bcclefa&"\\
520 la clé de sol&\verb+\bcclesol+&\bcclesol&"\\
521 le feu vert&\verb+\bcfeuvert+&\bcfeuvert&"\\
522 le feu jaune&\verb+\bcfeujaune+&\bcfeujaune&"\\
523 le feu rouge&\verb+\bcfeurouge+&\bcfeurouge&"\\
524 le feu tricolore&\verb+\bcfeutricolore+&\bcfeutricolore&"\\
525 l'outil&\verb+\bcoutil+&\bcoutil&"\\
526 le trombone&\verb+\bctrombone+&\bctrombone&"
527 \end{longtable}
528
529 Par exemple,
530
531 \begin{demo}
532 \begin{bclogo}[couleur=blue!30, arrondi=0.1, logo=\bctrefle]{Mon Titre}
533 \lipsum[2]
534 \end{bclogo}
535 \end{demo}
536
537 \noindent\textbf{Remarque}: on peut se définir soi-même de nouvelles
538 commandes de logo sans pour autant que
539 ces logos soient disponibles dans \verb+bclogo+. Par exemple, pour obtenir le
540 \emph{c\oe{}ur} de \LaTeX{} $\heartsuit$, il suffit de définir dans le
541 préambule de document la commande:
542
543 \hfil{\cmd\verb|\newcommand\bcheartsuit{\centering \huge $\heartsuit$}|}\hfil
544
545 Ceci donnera le même résultat que pour le pique \LaTeX{} (attention
546 \verb+\bcheartsuit+ n'est pas définie dans \verb+bclogo+).
547
548 On peut aussi faire ceci pour un code \verb+pstricks+, \verb+pgf+, une
549 image\dots{} Voici trois exemples illustrant respectivement les trois cas
550 mentionnés:
551
552 \begin{Code}
553 \begin{lstlisting}
554 % mon logo code pstricks
555 \newcommand\monlogopst{\begingroup \input{monlogo.pst}\endgroup}
556 % mon logo code pgf
557 \newcommand\monlogopgf{\begingroup \input{monlogo.pgf}\endgroup}
558 % mon image
559 \newcommand\monimage{\includegraphics[width=17pt]{monimage}}
560 \end{lstlisting}
561 \end{Code}
562
563 \subsection{Taille des logos}
564
565 On peut redéfinir la taille des logos en largeur. Par défaut celle-ci est de
566 \numprint[pt]{17}. Cette redéfinition s'effectue de la manière
567 suivante: {\cmd\verb|\setlength{\logowidth}{<valeur>pt}|}.
568
569 Par exemple, une redéfinition à \numprint[pt]{10} donnera:
570
571 \setlength{\logowidth}{10pt}
572 \begin{bclogo}[couleur=blue!30,arrondi=0.1]{Mon Titre}
573 \lipsum[2]
574 \end{bclogo}
575 \setlength{\logowidth}{17pt}
576
577 \section{L'ombre}
578
579 La gestion de l'ombre se règle comme les autres options. Par défaut, il n'y en
580 a pas (la valeur \texttt{ombre} vaut \texttt{false}). On active l'ombre avec la
581 commande {\cmd\verb|ombre=true|}. Par exemple:
582
583 \begin{demo}
584 \begin{bclogo}[couleur=blue!30,arrondi=0.1,ombre=true]{Mon Titre}
585 \lipsum[2]
586 \end{bclogo}
587 \end{demo}
588
589 \subsection{Paramètres de l'ombre}
590
591 \noindent\textbf{Épaisseur}: on règle l'épaisseur de l'ombre avec la
592 commande {\cmd\verb|epOmbre=<valeur en cm>|}. La valeur par défaut est
593 de \numprint[cm]{0.2}.
594
595 \noindent\textbf{Couleur}: on règle la couleur avec la commande
596 {\cmd\verb|couleurOmbre=<couleur>|}. La valeur par défaut est
597 \texttt{black!30}.
598
599 Voici un exemple illustrant les deux options:
600
601 \begin{demo}
602 \begin{bclogo}[couleur=blue!30,arrondi=0.1,ombre=true,epOmbre=0.25,
603 couleurOmbre=black!30]{Mon Titre}
604 \lipsum[3]
605 \end{bclogo}
606 \end{demo}
607
608 \subsection{\label{blur}Le paramètre \texttt{blur}}
609
610 Depuis la version 2.24, on a rajouté l'option proposée par le paquet
611 \texttt{pst-blur}. L'utilisation de celle-ci est légèrement plus compliquée que
612 celle des autres.
613
614 Si on utilise \texttt{pstricks}, alors, lors du chargement de \texttt{bclogo},
615 il faut mettre l'option \texttt{blur} qui permet de «charger»
616 \texttt{pst-blur}: {\cmd\verb|\usepackage[blur]{bclogo}|}.
617
618 Si on utilise \texttt{tikz}, alors il n'y a pas besoin de rajouter l'option
619 \texttt{blur} au chargement de \texttt{bclogo}.
620
621 L'utilisation de cette option ne diffère pas selon \texttt{tikz} ou
622 \texttt{pstricks}. On procède de la façon suivante:
623
624 \begin{demo}
625 \begin{bclogo}[couleur=blue!30,arrondi=0.1,ombre=true,
626 couleurOmbre=black!30,blur]{Mon Titre}
627 \lipsum[3]
628 \end{bclogo}
629 \end{demo}
630
631 \section{La barre}
632
633 La syntaxe générale de commande du style de barre est {\cmd\verb|barre=<style>|}.
634
635 \subsection{La barre droite}
636
637 Par défaut, on a une barre verticale droite comme dans tous les exemples
638 précédents (la commande est {\cmd\verb|barre=line|}).
639
640 \noindent\textbf{Épaisseur}: on peut régler l'épaisseur de la barre
641 grâce à la commande {\cmd\verb|epBarre=<valeur en pt>|}. Par exemple:
642
643 \begin{demo}
644 \begin{bclogo}[couleur=blue!30,arrondi=0.1,logo=\bcquestion,epBarre=3.5]{Mon
645 Titre}
646 \lipsum[3]
647 \end{bclogo}
648 \end{demo}
649
650 Par défaut cette valeur est de \numprint[pt]{1.5}.
651
652 \subsection{La barre «zigzag»}
653
654 Ce style de barre s'obtient avec la commande
655 {\cmd\verb|barre=<zigzag>|}. Par exemple:
656
657 \begin{demo}
658 \begin{bclogo}[couleur=blue!30,arrondi=0.1,logo=\bcquestion,barre=zigzag]{Mon
659 Titre}
660 \lipsum[1]
661 \end{bclogo}
662 \end{demo}
663
664 \subsection{La barre «snake»}
665 Ce style de barre s'obtient avec la commande
666 {\cmd\verb|barre=<snake>|}. Par exemple:
667
668 \begin{demo}
669 \begin{bclogo}[couleur=blue!30,arrondi=0.1,logo=\bcquestion,barre=snake]{Mon
670 Titre}
671 \lipsum[3]
672 \end{bclogo}
673 \end{demo}
674
675 \subsection{Réglages pour «snake» et «zigzag»}
676
677 Pour ces deux styles de barre, on règle la taille (ou amplitude) de
678 l'ondulation avec la commande {\cmd\verb|tailleOndu=<valeur en pt>|}.
679 C'est la
680 taille d'\textbf{une} ondulation. Par défaut la valeur est de
681 $2.5$. Par exemple:
682
683 \begin{demo}
684 \begin{bclogo}[couleur=blue!30,arrondi=0.1,logo=\bcquestion,barre=snake,
685 tailleOndu=1.5]{Mon Titre}
686 \lipsum[3]
687 \end{bclogo}
688 \end{demo}
689
690 \subsection{Répétition d'un «motif»}
691
692 Cette fonction permet de répéter verticalement un motif quelconque à
693 la place de la barre verticale. Ceci s'obtient avec la commande
694 {\cmd\verb|barre=motif|}
695 et se \textbf{couple} avec la commande
696 {\cmd\verb|motifBarre=<motif>|}. Par exemple:
697
698 \begin{demo}
699 \begin{bclogo}[couleur=blue!30,arrondi=0.1,logo=\bcquestion,barre=motif,
700 motifBarre=$\star$]{Mon Titre}
701 \lipsum[3]
702 \end{bclogo}
703 \end{demo}
704
705 Si je dispose d'une image personnelle, par exemple
706 \texttt{spir.mps}\footnote{Ici, j'utilise un \texttt{.mps} mais un
707 utilisateur de \texttt{latex} peut très bien utiliser un
708 \texttt{eps} et un utilisateur de \texttt{pdflatex} peut très bien
709 utiliser un \texttt{jpg},
710 \texttt{pdf}\dots} \includegraphics{spir}, il suffit de mettre:
711
712 \hfil{\cmd\verb+motifBarre=\includegraphics{spir}+}.\hfil
713
714 Ceci donne:
715
716 \begin{bclogo}[couleur=blue!30,arrondi=0.1,logo=\bcquestion,barre=motif,
717 motifBarre=\includegraphics{spir}]{Mon Titre}
718 \lipsum[3]
719 \end{bclogo}
720
721 Un autre exemple pour donner des idées\dots
722
723 \begin{demo}
724 \begin{bclogo}[couleur=blue!30,arrondi=0.1,logo=\bcquestion,
725 barre=motif,motifBarre={\includegraphics[width=8pt]{bc-inter}}]{Mon
726 Titre}
727 \lipsum[3]
728 \end{bclogo}
729 \end{demo}
730
731 \subsection{Image personnelle «étendue»}
732
733 Si je dispose d'une image, par exemple \texttt{brace.mps}\footnote{Comme
734 précédemment, les utilisateurs de \LaTeX{} peuvent utiliser une image
735 eps et ceux de pdf\LaTeX{} peuvent utiliser une image pdf.} (image
736 normalement verticale): \includegraphics[angle=90]{brace}
737 grâce à la commande {\cmd\verb|barre=imageExt|} couplée avec
738 {\cmd\verb|imageBarre=brace|}, je l'obtiens «étirée» à la place de la
739 barre verticale. Par exemple\footnote{On note l'utilisation de
740 l'option {\color{Maroon}\texttt{nobreak}} ce qui empêche la coupure
741 de la boîte et
742 par conséquence la répétition de l'image dans les différentes
743 parties. Pour plus de détails sur cette option, allez voir la
744 section~\ref{sec:coupure}}:
745
746 \begin{demo}
747 \begin{bclogo}[couleur=blue!30,arrondi=0.1,logo=\bcquestion,barre=imageExt,
748 imageBarre=brace,nobreak=true]{Mon Titre}
749 \lipsum[1]
750 \end{bclogo}
751 \end{demo}
752
753 \subsection{Image personnelle «clippée»}
754
755 Si on dispose d'une image (assez longue de préférence),
756 grâce à la commande {\cmd\verb|barre=imageClip|} couplée encore une
757 fois avec la commande {\cmd\verb|imageBarre=<monimage>|}, on obtient à
758 la place de la barre verticale, l'image «tronquée». Exemple avec
759 l'image \texttt{losanges.mps} ci-dessous (image normalement
760 verticale):
761
762 \noindent\includegraphics[angle=90,viewport=0 0 17 \linewidth,clip]{losanges}
763
764 \begin{demo}
765 \begin{bclogo}[couleur=blue!30,arrondi=0.1,logo=\bcquestion,barre=imageClip,
766 imageBarre=losanges]{Mon Titre}
767 \lipsum[1]
768 \end{bclogo}
769 \end{demo}
770
771 \subsection{Pour les utilisateurs de \emph{mathdesign}}
772
773 Si on utilise une police \textit{mathdesign}, alors on a accès à une barre
774 ondulée, faite avec un glyphe répété verticalement, grâce à la commande
775 {\cmd\verb|barre=wave|}. Voici un exemple:
776
777 \begin{demo}
778 \begin{bclogo}[couleur=blue!30,arrondi=0.1,logo=\bcquestion,barre=wave]{Mon
779 Titre}
780 \lipsum[2]
781 \end{bclogo}
782 \end{demo}
783
784 \subsection{Pas de barre}
785
786 Si on ne veut pas de barre verticale sur le côté, il suffit d'utiliser
787 la commande {\cmd\verb|barre=none|}. Par exemple:
788
789 \begin{demo}
790 \begin{bclogo}[couleur=blue!30,arrondi=0.1,logo=\bcquestion,barre=none]{Mon
791 Titre}
792 \lipsum[1]
793 \end{bclogo}
794 \end{demo}
795
796 \section{Coupure ou pas coupure?}\label{sec:coupure}
797
798 Depuis la version 3.0, bclogo utilise le paquet \emph{mdframed}
799 (version 1.5 ou ultérieure) qui autorise les coupures de boîtes en fin
800 de page (ce qui n'était pas le cas auparavant). Le paquet
801 \emph{mdframed} propose des macros permettant d'ajouter du code
802 personnel pour l'affichage des boîtes, c'est ainsi que sont ajoutés le
803 titre avec son logo, et la barre.
804
805 \begin{demo}
806 \begin{bclogo}[logo=\bcplume,couleur=PaleGoldenrod,ombre,epBord=0.8,barre=wave,%
807 couleurBarre=black]{Exemple de coupure}%
808 \lipsum[1-13]
809 \end{bclogo}
810 \end{demo}
811
812 Depuis la version 0.9, \emph{mdframed} propose une option empêchant la
813 coupure de la boîte, cette option est valable avec l'environnement
814 \emph{bclogo}, c'est l'option {\cmd\verb|nobreak=true/false|}. Par
815 défaut sa valeur est \texttt{false}, ce qui autorise les coupures,
816 pour les empêcher, il suffit de taper {\cmd\verb|nobreak|} ou bien
817 {\cmd\verb|nobreak=true|}\footnote{Cette option peut être utile
818 lorsque l'on utilise des images étendues à la place de la barre
819 verticale, en effet lors d'une coupure, celles-ci seraient alors
820 répétées.}.
821
822
823 Si votre version de \emph{mdframed} est antérieure à la 1.5, il vous
824 faudra la mettre à jour en téléchargeant la dernière version (archive
825 Zip) sur le
826 CTAN\footnote{\url{http://www.ctan.org/tex-archive/macros/latex/contrib/mdframed}}.
827
828 \section{Liste des boîtes}
829
830 On peut, comme avec \verb+\tableofcontents+, lister les boîtes
831 utilisées dans le document et ce grâce à la commande
832 {\cmd\verb|\listofbclogo|}.
833
834 Les noms affichés dans la liste sont les différents titres des boîtes
835 et, si on utilise le package \verb+hyperref+, cette liste est
836 «cliquable» et permet le transport dans le document\footnote{Ce
837 transport est maintenant mieux géré (version 2.21) grâce à François
838 \textsc{Pétiard}}. Par exemple dans ce document la liste donne (ici
839 j'utilise un \texttt{multicols} pour l'affichage sur deux colonnes):
840
841 \begin{multicols}{2}
842 \listofbclogo
843 \end{multicols}
844
845 Le titre de la liste peut alors être modifié par la commande:
846
847 \hfil{\cmd\verb|\renewcommand{\titrebclogo}{Liste des fiches}|}.\hfil
848
849 \section{Avec \texttt{framed.sty}}
850
851 Je présente ici une utilisation de \texttt{bclogo} \emph{couplée} avec
852 un environnement écrit par Jean-Michel \textsc{Sarlat} utilisant
853 \texttt{framed.sty}. Voici cet environnement:
854
855 \begin{Code}
856 \begin{lstlisting}
857 \newenvironment{gbar}[1]{%
858 \def\FrameCommand{{\color{#1}\vrule width 3pt}\colorbox{fbase}}%
859 \MakeFramed {\advance\hsize-\width \FrameRestore}}%
860 {\endMakeFramed}
861 \end{lstlisting}
862 \end{Code}
863
864 En disposant cet environnement, on s'amuser à mélanger les deux:
865
866 \begin{demo}
867 \begin{bclogo}[logo=\bcinfo,barre=none,noborder=true]{Test avec \texttt{framed.sty}}%
868 \begin{gbar}{yellow}
869 \lipsum[1]
870 \end{gbar}
871 \end{bclogo}
872 \end{demo}
873
874 \section{Réglage global des paramètres}
875
876 On peut régler les paramètres pour toutes les boîtes \texttt{bclogo}. Pour cela
877 on utilise la commande:
878
879 \hfil{\cmd\verb|\presetkeys{bclogo}{<liste des parametres>}{}|}.\hfil
880
881 Par exemple:
882
883 \hfil{\cmd\verb|\presetkeys{bclogo}{ombre=true,epBord=1pt}{}|}.\hfil
884
885
886 \section{Historique}
887
888 \begin{itemize}
889 \item bclogo v3.0 (été 2012) : Remaniement de l'utilisation de
890 mdframed
891 \item bclogo v3.0 (15 octobre 2011): utilisation du paquet mdframed
892 permettant les coupures de boîtes en fin de page. Ajout des
893 options \emph{couleurTexte} (couleur du texte), \emph{margeG}
894 (marge gauche, avant la boîte) et \emph{margeD} (marge droite,
895 après la boîte)
896 \item bclogo v2.26 (29 Juillet 2011) : Passage au format mps pour
897 les logos, ajouts de nouveaux logos (François \textsc{Pétiard}),
898 corrections du code pour éviter les overfull et underfull box
899 \item bclogo v2.25 (06 Juillet 2011) : correction du drapeau
900 allemand
901 \item bclogo v2.24 (09 septembre 2009) : plein de nouveauté, logos,
902 réglage de couleur de bord, d'épaisseur de bord, de marge à
903 l'intérieur, option blur pour l'ombre, nouvelle barre pour les
904 utilisateurs de mathdesign
905 \item bclogo v2.22 (18 janvier 2009) : toujours la même version,
906 j'avais oublié de documenter l'option noborder
907 \item bclogo v2.22 (15 janvier 2009) : Réglages arrondis absolu en
908 pstricks, les logos (fichiers) sont renommés bc-<logo>.<ext>
909 \item bclogo v2.21 (12 janvier 2009) : Nouveaux logos crayon et
910 pique, plus amélioration de la gestion des références,
911 amélioration de la documentation
912 \item bclogo v2.2 (11 janvier 2009) : Options sur la barre
913 verticale, nouveau logo question
914 \item bclogo v2.1 (04 janvier 2009) : Inversion de l'option par
915 défaut, maintenant c'est pstricks, nouveau logo livre
916 \item bclogo v2.0 (27 décembre 2008) : Options tikz ou pstricks
917 suivant le choix de compilation, ombre, 3 logos take care, lampe
918 et trêfle
919 \item bclogo v1.3 (20 août 2008) : Gestion des paramètres avec
920 « xkeyval » et ajout de 3 logos de François Boerkmann
921 \item bclogo v1.27 (14 juillet 2008) : Correction de l'oubli de
922 chargement du paquet « ifthen »
923 \item bclogo v1.26 (30 juin 2008) : création du logo ornement --
924 deux styles de titre -- fonction listofbclogo
925 \item bclogo v1.25 (5 avril 2008) : modification du logo attention
926 et création du coeur
927 \item bclogo v1.2 (2 avril 2008) : création des logo etoile, ours et
928 attention
929 \item bclogo v1.15 (19 mars 2008) : ajout de la fonction « arrondi »
930 en quatrième argument
931 \item bclogo v1.1 (19 mars 2008)
932 \end{itemize}
933
934 \section{Le code}
935
936 %\begin{lstlisting}[style=numbers, breaklines=true,breakindent=30pt]
937 \lstset{style=numbers, breaklines=true,breakindent=30pt}
938 \lstinputlisting{../latex/bclogo.sty}%%%chemin pour Maxime
939 %\lstinputlisting{../../tex/latex/bclogo/bclogo.sty}%%chemin pour Patrick
940 %\end{lstlisting}
941
942 \end{document}

Licence Creative Commons Les fichiers de Syracuse sont mis à disposition (sauf mention contraire) selon les termes de la
Licence Creative Commons Attribution - Pas d’Utilisation Commerciale - Partage dans les Mêmes Conditions 4.0 International.