Debian Codegraph @

texmf-dist/doc/latex/vectorlogos/vectorlogos-doc.tex

raw
1 % !TeX TXS-program:compile = txs:///pdflatex
2
3 \documentclass[11pt,a4paper]{ltxdoc}
4 \usepackage{crimson}
5 \renewcommand*\ttdefault{cmvtt}
6 \usepackage[T1]{fontenc}
7 \usepackage[scale=0.875]{cabin}
8 \usepackage{vectorlogos}
9 \usepackage{fancyvrb}
10 \usepackage{fancyhdr}
11 \usepackage{tabularray}
12 \usepackage{fontawesome5}
13 \fancyhf{}
14 \renewcommand{\headrulewidth}{0pt}
15 \lfoot{\sffamily\small [vectorlogos]}
16 \cfoot{\sffamily\small - \thepage{} -}
17 \rfoot{\hyperlink{matoc}{\small\faArrowAltCircleUp[regular]}}
18 \usepackage{hologo}
19 \providecommand\tikzlogo{Ti\textit{k}Z}
20 \providecommand\TeXLive{\TeX{}Live\xspace}
21 \providecommand\PSTricks{\textsf{PSTricks}\xspace}
22 \let\pstricks\PSTricks
23 \let\TikZ\tikzlogo
24
25 \usepackage{hyperref}
26 \urlstyle{same}
27 \hypersetup{pdfborder=0 0 0}
28 \usepackage[margin=2cm]{geometry}
29 \setlength{\parindent}{0pt}
30 \def\TPversion{0.1.3}
31 \def\TPdate{30/03/2024}
32 \usepackage{tcolorbox}
33 \tcbuselibrary{skins,hooks,listingsutf8}
34 \usepackage{soul}
35 \sethlcolor{lightgray!25}
36 \NewDocumentCommand\MontreCode{ m }{%
37 \hl{\vphantom{\texttt{pf}}\texttt{#1}}%
38 }
39
40 \begin{document}
41
42 \pagestyle{fancy}
43
44 \thispagestyle{empty}
45
46 \begin{center}
47 \begin{minipage}{0.88\linewidth}
48 \begin{tcolorbox}[colframe=yellow,colback=yellow!15]
49 \begin{center}
50 \begin{tabular}{c}
51 {\Huge \texttt{vectorlogos}}\\
52 \\
53 {\LARGE Insert, 'inline', vectorial,} \\
54 {\LARGE logos of 'classic' softwares.} \\
55 \\
56 {\small \texttt{Version \TPversion{} -- \TPdate}}
57 \end{tabular}
58 \end{center}
59 \end{tcolorbox}
60 \end{minipage}
61 \end{center}
62
63 \begin{center}
64 \begin{tabular}{c}
65 \texttt{Cédric Pierquet}\\
66 {\ttfamily c pierquet -- at -- outlook . fr}\\
67 \texttt{\url{https://github.com/cpierquet/vectorlogos}} \\
68 \end{tabular}
69 \end{center}
70
71 \hrule
72
73 \vfill
74
75 \begin{tcolorbox}[colframe=lightgray,colback=lightgray!5]
76 \begin{center}
77 \scalebox{4}[4]{\logogeogebra}\hspace{1cm}\scalebox{4}[4]{\logogeogebra[icon]}
78
79 \medskip
80
81 \scalebox{4}[4]{\logoscratch}\hspace{1cm}\scalebox{4}[4]{\logoscratch[alt]}\hspace{1cm}\scalebox{4}[4]{\logoscratch[cat]}
82
83 \medskip
84
85 \scalebox{4}[4]{\logotexstudio}
86
87 \medskip
88
89 \scalebox{4}[4]{\logoemacs}\hspace{1cm}\scalebox{4}[4]{\logoemacs[alt]}
90
91 \medskip
92
93 \scalebox{4}[4]{\logotexmaker}\hspace{1cm}\scalebox{4}[4]{\logotexmaker[alt]}
94
95 \medskip
96
97 \scalebox{4}[4]{\logomiktex}\hspace{1cm}\scalebox{4}[4]{\logomiktex[icon]}\hspace{1cm}\scalebox{4}[4]{\logomiktex[icon-alt]}
98
99 \medskip
100
101 \scalebox{4}[4]{\logoctanlion}
102
103 \medskip
104
105 \scalebox{4}[4]{\logolatexproject}
106
107 \medskip
108
109 \scalebox{4}[4]{\logotexworks}\hspace{1cm}\scalebox{4}[4]{\logotexworks[alt]}
110 \end{center}
111 \end{tcolorbox}
112
113 \vfill~
114
115 \hrule
116
117 \medskip
118
119 \emph{%
120 Logos came with GNU GPL or CC BY-SA (3.0 or 4.0).\\
121 Some brand icons/logos are trademarks of their respective owners. Please do not use brand icons/logos for any purpose except to represent the company, product, or service to which they refer.\\
122 CTAN lion drawing by Duane Bibby.\\
123 LaTeX project logo, from Jonas Jacek (\url{https://www.j15k.com/}).
124 %"Python" and the Python Logo are trademarks of the Python Software Foundation (\url{https://www.python.org/psf/trademarks/}).%
125 }
126
127 \medskip
128
129 \hrule
130
131 \vspace*{5mm}
132
133 \pagebreak
134
135 \phantomsection
136
137 \hypertarget{matoc}{}
138
139 \tableofcontents
140
141 \vspace*{5mm}
142
143 %\hrule
144
145 \pagebreak
146
147 \section{Introduction}
148
149 \subsection{Description, loading}
150
151 With this package you can insert inline (vectorial) logos of 'classic' softwares.
152
153 The format of the logos is \textsf{pdf}, from \textsf{svg} files (given by \textsf{GNU GPL} or \textsf{CC-BY-3.0 / CC-BY-4.0} ot \textsf{MIT} licenses).
154
155 \medskip
156
157 Each logo can be integrated within a classic \MontreCode{\textbackslash includegraphics} command.
158
159 The package provides macros to insert them \textit{inline}, with automatic height and alignment.
160
161 \medskip
162
163 To load the package, simply use :
164
165 \begin{quote}
166 \begin{verbatim}
167 \usepackage{vectorlogos}
168 \end{verbatim}
169 \end{quote}
170
171 \subsection{Available logos, by name, for manual insertion}
172
173 Available logos are :
174
175 \medskip
176
177 \begin{tblr}{width=\linewidth,colspec={Q[m,l]Q[l,m]X[m,l]},cells={font=\LARGE\ttfamily,bg=teal!5},column{1}={font=\LARGE\bfseries\sffamily}}
178 \hline
179 emacs & vectorlogo-emacs.pdf & \logoemacs\ \\
180 & vectorlogo-emacs-alt.pdf & \logoemacs[alt] \\
181 \hline
182 geogebra & vectorlogo-geogebra.pdf & \logogeogebra\ \\
183 & vectorlogo-geogebra-icon.pdf & \logogeogebra[icon] \\
184 \hline
185 scratch & vectorlogo-scratch.pdf & \logoscratch\ \\
186 & vectorlogo-scratch-alt.pdf & \logoscratch[alt] \\
187 & vectorlogo-scratch-cat.pdf & \logoscratch[cat] \\
188 \hline
189 texmaker & vectorlogo-texmaker.pdf & \logotexmaker\ \\
190 & vectorlogo-texmaker-alt.pdf & \logotexmaker[alt] \\
191 \hline
192 texstudio & vectorlogo-texstudio.pdf & \logotexstudio\ \\
193 \hline
194 MiKTeX & vectorlogo-miktex.pdf & \logomiktex\ \\
195 & vectorlogo-miktex-icon.pdf & \logomiktex[icon]\ \\
196 & vectorlogo-miktex-icon-alt.pdf & \logomiktex[icon-alt]\ \\
197 \hline
198 CTAN lion & vectorlogo-ctanlion.pdf & \logoctanlion\ \\
199 \hline
200 LaTeX project & vectorlogo-latexproject.pdf & \logolatexproject\ \\
201 \hline
202 TeXworks & vectorlogo-texworks.pdf & \logotexworks\ \\
203 & vectorlogo-texworks-alt.pdf & \logotexworks[alt]\ \\
204 \end{tblr}
205
206 \pagebreak
207
208 \section{The macros}
209
210 \subsection{A simple generic macro}
211
212 In order to insert an \textit{existing} vectorial logo, simpy use :
213
214 \begin{quote}
215 \begin{verbatim}
216 \simplevectorlogo*[options includegraphics]{name}
217 \end{verbatim}
218 \end{quote}
219
220 There's no automatic height or raising, it's just an \textit{alias} of a classic \MontreCode{\textbackslash includegraphics} with the given names of the precedent tabular.
221
222 \begin{tcblisting}{}
223 \simplevectorlogo*[height=1.5cm]{scratch}\par
224 \simplevectorlogo*[height=4cm]{scratch-cat}\par
225 \simplevectorlogo*[scale=0.33]{texstudio}\par
226 \simplevectorlogo*{emacs}\par
227 \simplevectorlogo*[width=3cm]{geogebra-icon}\par
228 \simplevectorlogo*[height=1cm]{miktex}\par
229 \simplevectorlogo*[height=2cm]{ctanlion}
230 \end{tcblisting}
231
232 \pagebreak
233
234 \subsection{A generic inline macro}
235
236 In order to insert a vectorial logo inline, simpy use :
237
238 \begin{quote}
239 \begin{verbatim}
240 \vectorlogo[option]{name}
241 \end{verbatim}
242 \end{quote}
243
244 The height (automatically calculated) of the logo is given by :
245
246 \begin{itemize}
247 \item 90\,\% of the box \fbox{abcd...xyzABCD...XYZ} in the current font ;
248 \item raised 5\,\% bottom of the depth of \fbox{q} in the current font.
249 \end{itemize}
250
251 Available \textsf{names} are :
252
253 \begin{multicols}{3}
254 \begin{itemize}
255 \item \texttt{emacs}
256 \item \texttt{geogebra}
257 \item \texttt{scratch}
258 \item \texttt{texmaker}
259 \item \texttt{texstudio}
260 \item \texttt{miktex}
261 \item \texttt{ctanlion}
262 \item \texttt{texworks}
263 \item \texttt{latexproject}
264 \end{itemize}
265 \end{multicols}
266
267 Available \textsf{options} are given by the suffix of alt logos.
268
269 \begin{tcblisting}{}
270 %other font and other size
271 {\Large\sffamily For example, it's a vectorial logo \vectorlogo[icon]{geogebra} with inline insertion.}
272 \end{tcblisting}
273
274 \begin{tcblisting}{}
275 %other font and other size
276 \scalebox{3.25}[3.25]{\ttfamily The cat \vectorlogo[cat]{scratch} logo, inline !}
277 \end{tcblisting}
278
279 \subsection{Special commands}
280
281 There's an other (shortcut) way to insert logos, with a shortcut-name, like in \textsf{fontawesome5} :
282 %\logopython[option]
283
284 \begin{quote}
285 \begin{verbatim}
286 \logoscratch[option]
287 \logogeogebra[option]
288 \logotexstudio[option]
289 \logoemacs[option]
290 \logotexmaker[option]
291 \logomiktex[option]
292 \logoctanlion
293 \logotexworks
294 \logolatexproject
295 \end{verbatim}
296 \end{quote}
297
298 Available options are given by the suffix of alt logos.
299
300 \begin{tcblisting}{}
301 A sample logo, \logoemacs[alt], inline.
302 \end{tcblisting}
303
304 \pagebreak
305
306 \section{Samples and personal logos}
307
308 \subsection{Samples}
309
310 \begin{tcblisting}{listing only}
311 %useful macro
312 \newcommand\samplevectorlogo[1]{{\LARGE Inline {#1} logo}\par}
313 \end{tcblisting}
314
315 \newcommand\samplevectorlogo[1]{{\LARGE Inline {#1} logo}\par}
316
317 \begin{tcblisting}{listing side text}
318 \samplevectorlogo{\logogeogebra}
319 \end{tcblisting}
320
321 \begin{tcblisting}{listing side text}
322 \samplevectorlogo{\logogeogebra[icon]}
323 \end{tcblisting}
324
325 \begin{tcblisting}{listing side text}
326 \samplevectorlogo{\logoscratch}
327 \end{tcblisting}
328
329 \begin{tcblisting}{listing side text}
330 \samplevectorlogo{\logoscratch[alt]}
331 \end{tcblisting}
332
333 \begin{tcblisting}{listing side text}
334 \samplevectorlogo{\logoscratch[cat]}
335 \end{tcblisting}
336
337 \begin{tcblisting}{listing side text}
338 \samplevectorlogo{\logotexstudio}
339 \end{tcblisting}
340
341 \begin{tcblisting}{listing side text}
342 \samplevectorlogo{\logoemacs}
343 \end{tcblisting}
344
345 \begin{tcblisting}{listing side text}
346 \samplevectorlogo{\logoemacs[alt]}
347 \end{tcblisting}
348
349 \begin{tcblisting}{listing side text}
350 \samplevectorlogo{\logotexmaker}
351 \end{tcblisting}
352
353 \begin{tcblisting}{listing side text}
354 \samplevectorlogo{\logotexmaker[alt]}
355 \end{tcblisting}
356
357 \begin{tcblisting}{listing side text}
358 \samplevectorlogo{\logomiktex}
359 \end{tcblisting}
360
361 \begin{tcblisting}{listing side text}
362 \samplevectorlogo{\logomiktex[icon]}
363 \end{tcblisting}
364
365 \begin{tcblisting}{listing side text}
366 \samplevectorlogo{\logomiktex[icon-alt]}
367 \end{tcblisting}
368
369 \begin{tcblisting}{listing side text}
370 \samplevectorlogo{\logoctanlion}
371 \end{tcblisting}
372
373 \begin{tcblisting}{listing side text}
374 \samplevectorlogo{\logotexworks}
375 \end{tcblisting}
376
377 \begin{tcblisting}{listing side text}
378 \samplevectorlogo{\logolatexproject}
379 \end{tcblisting}
380
381 \subsection{Personal logos}
382
383 If you wan't to use, \textit{inline}, your personal logos (located in workdir or in a \textsf{texmf} folder), you can use the command :
384
385 \begin{quote}
386 \begin{verbatim}
387 \simplevectorlogo[scale]{filename}
388 \end{verbatim}
389 \end{quote}
390
391 \MontreCode{[scale]}, which is \MontreCode{0.9} by default, is the ratio between the height of the logo and the height of the current 'text'.
392
393 \MontreCode{filename} is the fullname of the logo.
394
395 \begin{tcblisting}{}
396 {\Huge A perfect test \simplevectorlogo{example-image-16x10.pdf} inline.}
397 \end{tcblisting}
398
399 \begin{tcblisting}{}
400 {\Huge A perfect test \simplevectorlogo[1]{example-image-16x10.pdf} inline.}
401 \end{tcblisting}
402
403 \begin{tcblisting}{}
404 {\LARGE Another perfect test \simplevectorlogo[0.5]{example-image-16x10.pdf} inline.}
405 \end{tcblisting}
406
407 \begin{tcblisting}{}
408 {\LARGE Another perfect test \simplevectorlogo[2]{example-image-16x10.pdf} inline.}
409 \end{tcblisting}
410
411 \subsection{Generate personal macro}
412
413 Other vectorial logos (which cannot be included in the package due to rights issues, but which are still usable) can be downloaded from \url{https://packages.cpierquet.fr/?dir=/vectorlogos/bonus/}.
414
415 \smallskip
416
417 By this way, and with logo named \MontreCode{vectorlogo-<basename>-...}, a specific command can be used to create special macro.
418
419 \begin{quote}
420 \begin{verbatim}
421 %macro to create the command
422 \GenMacroLogoVect{\namemacro}{basename}
423
424 %use of the command
425 \namemacro[option]
426 \end{verbatim}
427 \end{quote}
428
429 \begin{tcblisting}{}
430 %with file vectorlogo-xcas.pdf in workdir or texmf
431 \GenMacroLogoVect{\logoxcas}{xcas}
432 {\LARGE A personal logo, with a personal macro to include \logoxcas\ inline.}
433 \end{tcblisting}
434
435 \pagebreak
436
437 \section{History}
438
439 \begin{quote}
440 \begin{verbatim}
441 0.1.3 : Logos for MikTeX + CTAN lion + LateX project
442 0.1.2 : Alt command for manual insertion, with existing img
443 0.1.1 : Update licenses
444 0.1.0 : Initial version
445 \end{verbatim}
446 \end{quote}
447
448 \end{document}