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