summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/logoetalab/doc/logoetalab-doc.tex
blob: b0de4f4c92a20c24abc6a2fdae56a63ba4ed337c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
% !TeX TXS-program:compile = txs:///arara
% arara: pdflatex: {shell: yes, synctex: no, interaction: batchmode}
% arara: pdflatex: {shell: yes, synctex: no, interaction: batchmode} if found('log', '(undefined references|Please rerun|Rerun to get)')

\documentclass[french,11pt,a4paper]{article}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
%\usepackage{DejaVuSerif}
%\usepackage[scale=1.125]{inconsolata}
\usepackage{amssymb}
\usepackage{logoetalab}
\usepackage{enumitem}
\usepackage{tikz}
\usepackage{soul}
\usepackage{codehigh}
\usepackage{multicol}
\usepackage{tabularray}
\usepackage{fontawesome5}
\usepackage{fancyvrb}
\usepackage{fancyhdr}
\fancyhf{}
\renewcommand{\headrulewidth}{0pt}
%\rhead{\sffamily\small\affloetalab[Legende]}
\lfoot{\sffamily\small [logoetalab]}
\cfoot{\sffamily\small - \thepage{} -}
\rfoot{\hyperlink{matoc}{\small\faArrowAltCircleUp[regular]}}
\usepackage{hologo}
\providecommand\tikzlogo{Ti\textit{k}Z}
\providecommand\TeXLive{\TeX{}Live\xspace}
\providecommand\PSTricks{\textsf{PSTricks}\xspace}
\let\pstricks\PSTricks
\let\TikZ\tikzlogo

\usepackage{hyperref}
\urlstyle{same}
\hypersetup{pdfborder=0 0 0}
\usepackage[margin=2cm]{geometry}
\setlength{\parindent}{0pt}

\def\TPversion{0.1.0}
\def\TPdate{17 août 2023}
\def\HtRet{0.45}\def\LgRect{1.5}
\usepackage{tcolorbox}

\def\ListeTailleTexte{tiny,scriptsize,footnotesize,small,normalsize,large,large,LARGE,huge,Huge}

\sethlcolor{lightgray!25}
\NewDocumentCommand\MontreCode{ m }{%
	\hl{\vphantom{\texttt{pf}}\texttt{#1}}%
}

\usepackage{babel}

\begin{document}

\pagestyle{fancy}

\thispagestyle{empty}

\begin{center}
	\begin{minipage}{0.88\linewidth}
	\begin{tcolorbox}[colframe=yellow,colback=yellow!15]
		\begin{center}
			\begin{tabular}{c}
				{\Huge \texttt{logoetalab}}\\
				\\
				{\LARGE Logo de la licence \og Licence Ouverte Etalab 2.0 \fg} \\
				\\
				\url{https://www.etalab.gouv.fr/licence-ouverte-open-licence/} \\
				\\
				{\small \texttt{Version \TPversion{} -- \TPdate}}
		\end{tabular}
		\end{center}
	\end{tcolorbox}
\end{minipage}
\end{center}

\begin{center}
	\begin{tabular}{c}
	\texttt{Cédric Pierquet}\\
	{\ttfamily c pierquet -- at -- outlook . fr}\\
	\texttt{\url{https://github.com/cpierquet/logoetalab}}
\end{tabular}
\end{center}

\hrule

\phantomsection

\hypertarget{matoc}{}

\tableofcontents

\vspace*{5mm}

\hrule

\vspace*{5mm}

\vfill

\begin{tcolorbox}[colframe=lightgray,colback=lightgray!10]
\hfill
{\Huge\sffamily\affloetalab[Legende]}
\hfill~

\bigskip

\hfill
{\Huge\loetalab*[Couleur=Bleu,Legende,TexteLegende={Licence Ouverte}]}
\hfill~

\vspace*{1cm}

\hfill
{\LARGE\loetalab~\loetalab[Couleur=Bleu]~\loetalab[Couleur=Gris]~\loetalab[Couleur=Marron]~\loetalab[Couleur=Rouge]~\loetalab[Couleur=Vert]~\loetalab[Couleur=Violet]}
\hfill~

\vspace*{1cm}

\hfill
{\LARGE\loetalab*~\loetalab*[Couleur=Bleu]~\loetalab*[Couleur=Gris]~\loetalab*[Couleur=Marron]~\loetalab*[Couleur=Rouge]~\loetalab*[Couleur=Vert]~\loetalab*[Couleur=Violet]}
\hfill~

\vspace*{1cm}

{\scriptsize\sffamily\affloetalab[Legende]}\hfill{\tiny\sffamily\affloetalab*[Couleur=Violet,Legende,TexteLegende={Licence Ouverte}]}
\end{tcolorbox}

\vfill~

\pagebreak

\section{Le package logoetalab}

\subsection{Idées}

L'idée est de pouvoir intégrer, dans un document \LaTeX, un logo relatif à la licence \og Licence Ouverte Etalab 2.0 \fg{} (\url{https://www.etalab.gouv.fr/licence-ouverte-open-licence/}).

\medskip

\hfill
\begin{tblr}{width=15cm,colspec={|[1pt]X[j]},cells={font=\footnotesize}}
	La « Licence Ouverte / Open License » présente les caractéristiques suivantes :\\
	1. Une grande liberté de réutilisation des informations :\\
	-- Une licence ouverte, libre et gratuite, qui apporte la sécurité juridique nécessaire aux producteurs et aux réutilisateurs des données publiques ;\\
	-- Une licence qui promeut la réutilisation la plus large en autorisant la reproduction, la redistribution, l’adaptation et l’exploitation commerciale des données ;\\
	-- Une licence qui s’inscrit dans un contexte international en étant compatible avec les standards des licences Open Data développées à l’étranger et notamment celles du gouvernement britannique (Open Government Licence) ainsi que les autres standards internationaux (ODC-BY, CC-BY 2.0).\\
	2. Une exigence forte de transparence de la donnée et de qualité des sources en rendant obligatoire la mention de la paternité.\\
	3. Une opportunité de mutualisation pour les autres données publiques en mettant en place un standard réutilisable par les collectivités territoriales qui souhaiteraient se lancer dans l’ouverture des données publiques.\\
\end{tblr}
\hfill~

\medskip

Les logos sont au format (vectoriel) \MontreCode{pdf}, et ont été obtenus à partir d'un fichier fichier \MontreCode{svg} sous licence CC BY 2.0 FR (\href{https://fr.m.wikipedia.org/wiki/Fichier:Logo-licence-ouverte2.svg}{[lien]}).

\subsection{Chargement}

Le package se charge dans le préambule, via \MontreCode{\textbackslash usepackage\{logoetalab\}}.

Les seuls packages chargés sont \MontreCode{graphicx}, \MontreCode{calc} et \MontreCode{simplekv}.

\begin{codehigh}[language=latex/latex2,style/main=cyan!10,style/code=cyan!10]
\usepackage{logoetalab}
\end{codehigh}

\subsection{Masque de nommage des fichiers}

Chaque logo est nommé sous la forme \MontreCode{LogoLicenceOuverte-<Couleur>-<Orientation>.pdf}, de sorte que les logos peuvent être insérés directement via la commande \MontreCode{\textbackslash includegraphics} \textit{classique}.

\begin{demohigh}[language=latex/latex3,style/main=cyan!10,style/code=cyan!10,style/demo=cyan!10]
\includegraphics[height=5cm]{LogoLicenceOuverte-Gris-V.pdf}\par
\includegraphics[width=4cm]{LogoLicenceOuverte-Rouge-H.pdf}
\end{demohigh}

\subsection{Utilisation}

Le package propose deux commandes :

\medskip

\begin{itemize}
	\item \MontreCode{\textbackslash loetalab} pour un affichage du logo en mode \textit{en ligne} (raccourci de \textsc{\textbf{L}icence\textbf{O}uverte\textbf{Etalab}}) ;
	\item \MontreCode{\textbackslash affloetalab} pour un affichage \textit{autonome} (raccourci de \textsc{\textbf{Aff}iche\textbf{L}icence\textbf{O}uverte\textbf{Etalab}}).
\end{itemize}

\medskip

\begin{codehigh}[language=latex/latex2,style/main=cyan!10,style/code=cyan!10]
\loetalab(*)[Options]
\affloetalab(*)[Options]
\end{codehigh}

La différence entre les deux se situe au niveau de la taille et de l'alignement vertical du logo.

\begin{demohigh}[language=latex/latex3,style/main=cyan!10,style/code=cyan!10,style/demo=cyan!10]
\loetalab
\end{demohigh}

\begin{demohigh}[language=latex/latex3,style/main=cyan!10,style/code=cyan!10,style/demo=cyan!10]
\loetalab*
\end{demohigh}

\begin{demohigh}[language=latex/latex3,style/main=cyan!10,style/code=cyan!10,style/demo=cyan!10]
\affloetalab
\end{demohigh}

\begin{demohigh}[language=latex/latex3,style/main=cyan!10,style/code=cyan!10,style/demo=cyan!10]
\affloetalab*
\end{demohigh}

\begin{demohigh}[language=latex/latex3,style/main=cyan!10,style/code=cyan!10,style/demo=cyan!10]
\loetalab\loetalab*\affloetalab\affloetalab*
\end{demohigh}

\section{Les commandes}

\subsection{Affichage en mode \textit{en ligne}}

La commande dédiée à un affichage \textit{en ligne} est \MontreCode{\textbackslash loetalab}.

\medskip

\begin{itemize}[leftmargin=*]
	\item La version étoilée force l'affichage du logo en format paysage.
	\item L'argument optionnel, et entre \MontreCode{[...]} propose les clés suivantes :
	\begin{itemize}
		\item la clé \MontreCode{Couleur} pour choisir une couleur, parmi \MontreCode{Noir/Bleu/Gris/Marron/Rouge/Vert/Violet}, et vaut \MontreCode{Noir} par défaut ;
		
		\hfill{\footnotesize si une couleur non existante est choisie, c'est \MontreCode{Noir} qui sera utilisée}
		\item le booléen \MontreCode{Legende} pour afficher une légende à côté du logo, qui vaut \MontreCode{false} par défaut ;
		\item la clé \MontreCode{TexteLegende} pour paramétrer le texte de la légende et qui vaut \MontreCode{Publié sous licence Etalab 2.0} par défaut.
	\end{itemize}
\end{itemize}

\medskip

La hauteur du logo est calculée (et fixée) en fonction :

\begin{itemize}
	\item de 90\,\% de la hauteur globale, \underline{dans la police courante}, des lettres \fbox{qB} ;
	\item décalée vers le bas d'un peu moins que la profondeur, \underline{dans la police courante}, de la lettre \fbox{q}.
\end{itemize}

\medskip

\begin{tblr}{hlines,width=\linewidth,colspec={Q[l,m]X[l,m]},row{1}={magenta!10},row{2-Z}={cyan!10}}
	\SetCell[r=1,c=2]{c,m} \fakeverb{\loetalab} & \\
	{\tiny\fakeverb{\tiny}} & {\tiny Essai de logo \loetalab{} en ligne} \\
	{\scriptsize\fakeverb{\scriptsize}} & {\scriptsize Essai de logo \loetalab{} en ligne} \\
	{\footnotesize\fakeverb{\footnotesize}} & {\footnotesize Essai de logo \loetalab{} en ligne} \\
	{\small\fakeverb{\small}} & {\small Essai de logo \loetalab{} en ligne} \\
	{\normalsize\fakeverb{\normalsize}} & {\normalsize Essai de logo \loetalab{} en ligne} \\
	{\large\fakeverb{\large}} & {\large Essai de logo \loetalab{} en ligne} \\
	{\Large\fakeverb{\Large}} & {\Large Essai de logo \loetalab{} en ligne} \\
	{\LARGE\fakeverb{\LARGE}} & {\LARGE Essai de logo \loetalab{} en ligne} \\
	{\huge\fakeverb{\huge}} & {\huge Essai de logo \loetalab{} en ligne} \\
	{\Huge\fakeverb{\Huge}} & {\Huge Essai de logo \loetalab{} en ligne} \\
\end{tblr}

\medskip

\begin{tblr}{hlines,width=\linewidth,colspec={Q[l,m]X[l,m]},row{1}={magenta!10},row{2-Z}={cyan!10}}
	\SetCell[r=1,c=2]{c,m} \fakeverb{\loetalab*} & \\
	{\tiny\fakeverb{\tiny\sffamily}} & {\tiny\sffamily Essai de logo \loetalab*{} en ligne} \\
	{\scriptsize\fakeverb{\scriptsize\sffamily}} & {\scriptsize\sffamily Essai de logo \loetalab*{} en ligne} \\
	{\footnotesize\fakeverb{\footnotesize\sffamily}} & {\footnotesize\sffamily Essai de logo \loetalab*{} en ligne} \\
	{\small\fakeverb{\small\sffamily}} & {\small\sffamily Essai de logo \loetalab*{} en ligne} \\
	{\normalsize\fakeverb{\normalsize\sffamily}} & {\normalsize\sffamily Essai de logo \loetalab*{} en ligne} \\
	{\large\fakeverb{\large\sffamily}} & {\large\sffamily Essai de logo \loetalab*{} en ligne} \\
	{\Large\fakeverb{\Large\sffamily}} & {\Large\sffamily Essai de logo \loetalab*{} en ligne} \\
	{\LARGE\fakeverb{\LARGE\sffamily}} & {\LARGE\sffamily Essai de logo \loetalab*{} en ligne} \\
	{\huge\fakeverb{\huge\sffamily}} & {\huge\sffamily Essai de logo \loetalab*{} en ligne} \\
	{\Huge\fakeverb{\Huge\sffamily}} & {\Huge\sffamily Essai de logo \loetalab*{} en ligne} \\
\end{tblr}

\begin{demohigh}[language=latex/latex2,style/main=cyan!10,style/code=cyan!10,style/demo=cyan!10]
\small Publication sous \loetalab*[Couleur=Rouge,Legende, TexteLegende={Licence Etalab 2.0}]
\end{demohigh}

\begin{demohigh}[language=latex/latex2,style/main=cyan!10,style/code=cyan!10,style/demo=cyan!10]
\LARGE\sffamily Publication sous \loetalab[Couleur=Vert,Legende, TexteLegende={Licence Etalab 2.0}]
\end{demohigh}

\subsection{Affichage en mode \textit{autonome}}

La commande dédiée à un affichage \textit{autonome} est \MontreCode{\textbackslash affloetalab}.

\medskip

\begin{itemize}[leftmargin=*]
	\item La version étoilée force l'affichage du logo en format paysage.
	\item L'argument optionnel, et entre \MontreCode{[...]} propose les clés suivantes :
	\begin{itemize}
		\item la clé \MontreCode{Couleur} pour choisir une couleur, parmi \MontreCode{Noir/Bleu/Gris/Marron/Rouge/Vert/Violet}, et vaut \MontreCode{Noir} par défaut ;
		
		\hfill{\footnotesize si une couleur non existante est choisie, c'est \MontreCode{Noir} qui sera utilisée}
		\item le booléen \MontreCode{Legende} pour afficher une légende à côté du logo, qui vaut \MontreCode{false} par défaut ;
		\item la clé \MontreCode{TexteLegende} pour paramétrer le texte de la légende et qui vaut \MontreCode{Publié sous licence Etalab 2.0} par défaut.
	\end{itemize}
\end{itemize}

\medskip

La hauteur du logo est calculée (et fixée) en fonction :

\begin{itemize}
	\item du double de la hauteur globale, \underline{dans la police courante}, de la boîte formée de la lettre \fbox{B} ;
	\item décalée vers le bas de la moitié de la hauteur, \underline{dans la police courante}, de la boîte \fbox{B}.
\end{itemize}

\begin{tblr}{hlines,width=\linewidth,colspec={Q[l,m]X[l,m]},row{1}={magenta!10},row{2-Z}={cyan!10}}
	\SetCell[r=1,c=2]{c,m} \fakeverb{\affloetalab} & \\
	{\tiny\fakeverb{\tiny}} & {\tiny \affloetalab{} en mode autonome} \\
	{\scriptsize\fakeverb{\scriptsize}} & {\scriptsize \affloetalab{} en mode autonome} \\
	{\footnotesize\fakeverb{\footnotesize}} & {\footnotesize \affloetalab{} en mode autonome} \\
	{\small\fakeverb{\small}} & {\small \affloetalab{} en mode autonome} \\
	{\normalsize\fakeverb{\normalsize}} & {\normalsize \affloetalab{} en mode autonome} \\
	{\large\fakeverb{\large}} & {\large \affloetalab{} en mode autonome} \\
	{\Large\fakeverb{\Large}} & {\Large \affloetalab{} en mode autonome} \\
	{\LARGE\fakeverb{\LARGE}} & {\LARGE \affloetalab{} en mode autonome} \\
	{\huge\fakeverb{\huge}} & {\huge \affloetalab{} en mode autonome} \\
	{\Huge\fakeverb{\Huge}} & {\Huge \affloetalab{} en mode autonome} \\
\end{tblr}

\medskip

\begin{tblr}{hlines,width=\linewidth,colspec={Q[l,m]X[l,m]},row{1}={magenta!10},row{2-Z}={cyan!10}}
	\SetCell[r=1,c=2]{c,m} \fakeverb{\affloetalab*} & \\
	{\tiny\fakeverb{\tiny}} & {\tiny \affloetalab*{} en mode autonome} \\
	{\scriptsize\fakeverb{\scriptsize}} & {\scriptsize \affloetalab*{} en mode autonome} \\
	{\footnotesize\fakeverb{\footnotesize}} & {\footnotesize \affloetalab*{} en mode autonome} \\
	{\small\fakeverb{\small}} & {\small \affloetalab*{} en mode autonome} \\
	{\normalsize\fakeverb{\normalsize}} & {\normalsize \affloetalab*{} en mode autonome} \\
	{\large\fakeverb{\large}} & {\large \affloetalab*{} en mode autonome} \\
	{\Large\fakeverb{\Large}} & {\Large \affloetalab*{} en mode autonome} \\
	{\LARGE\fakeverb{\LARGE}} & {\LARGE \affloetalab*{} en mode autonome} \\
	{\huge\fakeverb{\huge}} & {\huge \affloetalab*{} en mode autonome} \\
	{\Huge\fakeverb{\Huge}} & {\Huge \affloetalab*{} en mode autonome} \\
\end{tblr}

\medskip

\begin{tblr}{hlines,width=\linewidth,colspec={Q[l,m]X[l,m]},row{1}={magenta!10},row{2-Z}={cyan!10}}
	\SetCell[r=1,c=2]{c,m} \fakeverb{\affloetalab*[Couleur=Violet]} & \\
	{\tiny\fakeverb{\tiny}} & {\tiny \affloetalab*[Couleur=Violet] en mode autonome} \\
	{\scriptsize\fakeverb{\scriptsize}} & {\scriptsize \affloetalab*[Couleur=Violet] en mode autonome} \\
	{\footnotesize\fakeverb{\footnotesize}} & {\footnotesize \affloetalab*[Couleur=Violet] en mode autonome} \\
	{\small\fakeverb{\small}} & {\small \affloetalab*[Couleur=Violet] en mode autonome} \\
	{\normalsize\fakeverb{\normalsize}} & {\normalsize \affloetalab*[Couleur=Violet] en mode autonome} \\
	{\large\fakeverb{\large}} & {\large \affloetalab*[Couleur=Violet] en mode autonome} \\
	{\Large\fakeverb{\Large}} & {\Large \affloetalab*[Couleur=Violet] en mode autonome} \\
	{\LARGE\fakeverb{\LARGE}} & {\LARGE \affloetalab*[Couleur=Violet] en mode autonome} \\
	{\huge\fakeverb{\huge}} & {\huge \affloetalab*[Couleur=Violet] en mode autonome} \\
	{\Huge\fakeverb{\Huge}} & {\Huge \affloetalab*[Couleur=Violet] en mode autonome} \\
\end{tblr}

\begin{demohigh}[language=latex/latex2,style/main=cyan!10,style/code=cyan!10,style/demo=cyan!10]
\small\affloetalab[Couleur=Rouge,Legende]
\end{demohigh}

\begin{demohigh}[language=latex/latex2,style/main=cyan!10,style/code=cyan!10,style/demo=cyan!10]
\LARGE\sffamily\affloetalab[Couleur=Vert,Legende,TexteLegende={Licence Etalab 2.0}]
\end{demohigh}

\vfill

\section{Historique}

\verb|v0.1.0|~:~~~~Version initiale

\vspace*{15mm}

\pagebreak

\end{document}