Debian Codegraph @

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

raw
1 % !TeX TXS-program:compile = txs:///arara
2 % arara: pdflatex: {shell: no, synctex: no, interaction: batchmode}
3 % arara: pdflatex: {shell: no, synctex: no, interaction: batchmode} if found('log', '(undefined references|Please rerun|Rerun to get)')
4
5 \documentclass[french,11pt,a4paper]{article}
6 \usepackage[utf8]{inputenc}
7 \usepackage[T1]{fontenc}
8 \usepackage{DejaVuSerifCondensed}
9 \usepackage[scale=1.075]{inconsolata}
10 \usepackage{enumitem}
11 \usepackage{circularglyphs}
12 \usepackage{multicol}
13 \usepackage{soul}
14 \usepackage{multicol}
15 \usepackage{fontawesome5}
16 \usepackage{fancyvrb}
17 \usepackage{fancyhdr}
18 \usepackage{tabularx}
19 \usepackage{tabularray}
20 \fancyhf{}
21 \renewcommand{\headrulewidth}{0pt}
22 \lfoot{\sffamily\small [circularglyphs]}
23 \cfoot{\sffamily\small - \thepage{} -}
24 \rfoot{\hyperlink{matoc}{\small\faArrowAltCircleUp[regular]}}
25 \usepackage{hologo}
26 \providecommand\tikzlogo{Ti\textit{k}Z}
27 \providecommand\TeXLive{\TeX{}Live\xspace}
28 \providecommand\PSTricks{\textsf{PSTricks}\xspace}
29 \let\pstricks\PSTricks
30 \let\TikZ\tikzlogo
31
32 \usepackage{hyperref}
33 \urlstyle{same}
34 \hypersetup{pdfborder=0 0 0}
35 \usepackage[margin=1.5cm]{geometry}
36 \setlength{\parindent}{0pt}
37
38 \def\TPversion{0.1.1}
39 \def\TPdate{6 octobre 2023}
40
41 \usepackage{babel}
42
43 \usepackage[most]{tcolorbox}
44 \tcbuselibrary{listingsutf8}
45 \newtcblisting{DemoCode}[1][]{%
46 enhanced,width=0.95\linewidth,center,%
47 bicolor,size=title,%
48 colback=cyan!2!white,%
49 colbacklower=cyan!1!white,%
50 colframe=cyan!75!black,%
51 listing options={%
52 breaklines=true,%
53 breakatwhitespace=true,%
54 style=tcblatex,basicstyle=\small\ttfamily,%
55 tabsize=4,%
56 commentstyle={\itshape\color{gray}},
57 keywordstyle={\color{blue}},%
58 classoffset=0,%
59 keywords={},%
60 alsoletter={-},%
61 keywordstyle={\color{blue}},%
62 classoffset=1,%
63 alsoletter={-},%
64 morekeywords={center,justify},%
65 keywordstyle={\color{violet}},%
66 classoffset=2,%
67 alsoletter={-},%
68 morekeywords={\CircGlyph},%
69 keywordstyle={\color{green!50!black}},%
70 classoffset=3,%
71 morekeywords={Ext,Inline},%
72 keywordstyle={\color{orange}}
73 },%
74 #1
75 }
76
77 \sethlcolor{lightgray!25}
78 \NewDocumentCommand\MontreCode{ m }{%
79 \hl{\vphantom{\texttt{pf}}\texttt{#1}}%
80 }
81
82 \begin{document}
83
84 \pagestyle{fancy}
85
86 \thispagestyle{empty}
87
88 \begin{center}
89 \begin{minipage}{0.75\linewidth}
90 \begin{tcolorbox}[colframe=yellow,colback=yellow!15]
91 \begin{center}
92 \begin{tabular}{c}
93 {\Huge \texttt{circularglyphs}}\\
94 \\
95 {\LARGE Alphabet Circular Glyphs,} \\
96 \\
97 {\LARGE en \LaTeX, créé avec \TikZ.} \\
98 \end{tabular}
99
100 \medskip
101
102 {\small \texttt{Version \TPversion{} -- \TPdate}}
103 \end{center}
104 \end{tcolorbox}
105 \end{minipage}
106 \end{center}
107
108 \vspace*{1mm}
109
110 \begin{center}
111 \begin{tabular}{c}
112 \texttt{Cédric Pierquet}\\
113 {\ttfamily c pierquet -- at -- outlook . fr}\\
114 \texttt{\url{https://github.com/cpierquet/circularglyphs}}
115 \\
116 \texttt{\url{https://www.deviantart.com/irolan/art/Circular-Glyphs-479352599}}
117 \end{tabular}
118 \end{center}
119
120 \hrule
121
122 \phantomsection
123
124 \hypertarget{matoc}{}
125
126 \tableofcontents
127
128 \vspace*{5mm}
129
130 \hrule
131
132 \vspace*{5mm}
133
134 \vfill
135
136 \textbf{Article n°1 de la Déclaration des Droits de l'Homme et du Citoyen de 1789 : }
137
138 \medskip
139
140 \CircGlyph{Les hommes naissent et demeurent libres et égaux en droits. Les distinctions sociales ne peuvent être fondées que sur l'utilité commune.}
141
142 \bigskip
143
144 \textbf{Article n°2 de la Déclaration des Droits de l'Homme et du Citoyen de 1789 : }
145
146 \medskip
147
148 {\LARGE\CircGlyph{Le but de toute association politique est la conservation des droits naturels et imprescriptibles de l'homme. Ces droits sont la liberté, la propriété, la sûreté, et la résistance à l'oppression.}}
149
150 \bigskip
151
152 \textbf{Article n°3 de la Déclaration des Droits de l'Homme et du Citoyen de 1789 : }
153
154 \medskip
155
156 {\large\CircGlyph[Color=purple]{Le principe de toute souveraineté réside essentiellement dans la nation. Nul corps, nul individu ne peut exercer d'autorité qui n'en émane expressément.}}
157
158 \vfill~
159
160 \pagebreak
161
162 \section{Le package circularglyphs}
163
164 \subsection{Idée}
165
166 L'idée est de proposer de quoi écrire du texte grâce à l'alphabet \textsf{Circular Glyphs}.
167
168 \smallskip
169
170 \textsf{Circular Glyphs} est un alphabet graphique de substitution basé sur une construction géométrique à base de cercles et d'arc de cercles sur une grille.
171
172 Il a été mis à disposition -- en licence libre -- par \textsf{Irolan}, sur sa page \href{https://www.deviantart.com/irolan/art/Circular-Glyphs-479352599}{devianart}.
173
174 \subsection{Caractères disponibles}
175
176 Dans l'alphabet \textsf{Circular Glyphs}, on a les règles suivantes :
177
178 \begin{itemize}
179 \item les minuscules et majuscules sont identiques ;
180 \item les accents ne sont pas traités ;
181 \item les espaces, tirets et apostrophes sont traités comme un caractère \textsf{Null} ;
182 \item les autres caractères sont ignorés.
183 \end{itemize}
184
185 \bigskip
186
187 \begin{tblr}{width=\linewidth,stretch=1.5,colspec={*{13}{X[m,c]}},row{even}={font=\LARGE\ttfamily},row{odd}={font=\LARGE}}
188 \CircGlyph[Inline]{a}&\CircGlyph[Inline]{b}&\CircGlyph[Inline]{c}&\CircGlyph[Inline]{d}&\CircGlyph[Inline]{e}&\CircGlyph[Inline]{f}&\CircGlyph[Inline]{g}&\CircGlyph[Inline]{h}&\CircGlyph[Inline]{i}&\CircGlyph[Inline]{j}&\CircGlyph[Inline]{k}&\CircGlyph[Inline]{l}&\CircGlyph[Inline]{m}\\
189 A&B&C&D&E&F&G&H&I&J&K&L&M\\
190 \CircGlyph[Inline]{n}&\CircGlyph[Inline]{o}&\CircGlyph[Inline]{p}&\CircGlyph[Inline]{q}&\CircGlyph[Inline]{r}&\CircGlyph[Inline]{s}&\CircGlyph[Inline]{t}&\CircGlyph[Inline]{u}&\CircGlyph[Inline]{v}&\CircGlyph[Inline]{w}&\CircGlyph[Inline]{x}&\CircGlyph[Inline]{y}&\CircGlyph[Inline]{z}\\
191 N&O&P&Q&R&S&T&U&V&W&X&Y&Z\\
192 \CircGlyph[Inline]{0}&\CircGlyph[Inline]{1}&\CircGlyph[Inline]{2}&\CircGlyph[Inline]{3}&\CircGlyph[Inline]{4}&\CircGlyph[Inline]{5}&\CircGlyph[Inline]{6}&\CircGlyph[Inline]{7}&\CircGlyph[Inline]{8}&\CircGlyph[Inline]{9}\\
193 0&1&2&3&4&5&6&7&8&9\\
194 \CircGlyph[Inline]{ }&&&&&&&&&&&\\
195 Null&&&&&&&&&&&&&\\
196 \end{tblr}
197
198 \subsection{Chargement}
199
200 Le package se charge dans le préambule, via \MontreCode{\textbackslash usepackage\{circularglyphs\}}.
201
202 \begin{DemoCode}[listing only]
203 \usepackage{circularglyphs}
204 \end{DemoCode}
205
206 Les seuls packages utilisés sont :
207
208 \begin{itemize}
209 \item \MontreCode{tikz} ;
210 \item \MontreCode{xstring} ;
211 \item \MontreCode{calc} ;
212 \item \MontreCode{simplekv}.
213 \end{itemize}
214
215 \subsection{La police CircularGlyphs.ttf}
216
217 À noter, pour les utilisateurs de \hologo{LuaLaTeX} ou \hologo{XeLaTeX} qu'une police de caractères est disponible sur la page citée précédemment (\texttt{CircularGlyphs.ttf}), et que celle-ci sera sans doute plus pertinente que ce package pour des éventuelles transcriptions \textit{conséquentes} !!
218
219 \pagebreak
220
221 \section{Commande et fonctionnement}
222
223 \subsection{Compatibilité}
224
225 Le package est compatible (normalement) avec les compilateurs classiques (\hologo{LuaLaTeX}, \hologo{pdfLaTeX}, etc) et des tests ont été réalisés pour tester le bon fonctionnement avec des caractères spéciaux comme \MontreCode{;} ou \MontreCode{:}.
226
227 \smallskip
228
229 Attention toutefois si la commande est incluse dans un environnement ou dans une autre commande, surtout si des caractères actifs sont présents\ldots
230
231 \subsection{Commande basique}
232
233 La commande permettant de \textit{transcrire} du texte en \textsf{Circular Glyphs} est tout simplement :
234
235 \begin{DemoCode}[]
236 %mode paragraphe
237 \CircGlyph{Les hommes naissent et demeurent libres et égaux en droits. Les distinctions sociales ne peuvent être fondées que sur l'utilité commune.}
238 \end{DemoCode}
239
240 \begin{DemoCode}[]
241 %mode en ligne
242 \CircGlyph[Inline]{Les hommes naissent et demeurent libres et égaux en droits.}
243 \end{DemoCode}
244
245 La version avec la clé \MontreCode{[Inline]} (en mode \textit{en ligne}) ne permet pas d'obtenir une grille très \textit{satisfaisante}, alors que la version \textit{classique} le gère, grâce à \MontreCode{\textbackslash offinterlineskip} et \MontreCode{\textbackslash par}, donc la commande avec la clé \MontreCode{[Inline]} est à réserver pour insérer des caractères \textsf{Circular Glyphs} simples.
246
247 \medskip
248
249 Il existe également la clé \MontreCode{[Color=...]} pour permettre de colorer les glyphes de manière directe, car il n'est (pour le moment) pas possible d'utiliser la commande en parallèle de \MontreCode{\textbackslash textcolor}
250
251 \medskip
252
253 Concernant la création et disposition des glyphes :
254
255 \begin{itemize}
256 \item chaque caractère à une hauteur équivalente (il est un tout petit peu plus haut\ldots) à celle des lettres \MontreCode{ab...yzAB...YZ} dans la police courante ;
257 \item un caractère est \textit{aligné} sur les caractères \MontreCode{ab...yzAB...YZ} dans la police courante ;
258 \item le passage à la ligne est géré par le code, ce qui permet d'avoir une présentation sous forme de \textit{grille}.
259 \end{itemize}
260
261 \begin{DemoCode}[]
262 %positionnement des glyphes
263 y\CircGlyph[Inline]{ABCDEFG}S
264 \end{DemoCode}
265
266 \begin{DemoCode}[]
267 %influcence de la police
268 {\LARGE\sffamily q\CircGlyph[Inline]{ABCDEFG}S}
269 \end{DemoCode}
270
271 \pagebreak
272
273 \subsection{Caractères alternatifs}
274
275 Des caractères alternatif sont accessibles en activant la clé \MontreCode{[Ext]}, qui permet d'obtenir des glyphes complémentaires (on sort un peu du cadre \textsf{Circular} quand même !).
276
277 \begin{multicols}{4}
278 \begin{itemize}[label=\textbullet]
279 \item {\LARGE \MontreCode{,} : \CircGlyph[Inline,Ext]{,}}
280 \item {\LARGE \MontreCode{;} : \CircGlyph[Inline,Ext]{;}}
281 \item {\LARGE \MontreCode{.} : \CircGlyph[Inline,Ext]{.}}
282 \item {\LARGE \MontreCode{?} : \CircGlyph[Inline,Ext]{?}}
283 \item {\LARGE \MontreCode{!} : \CircGlyph[Inline,Ext]{!}}
284 \item {\LARGE \MontreCode{:} : \CircGlyph[Inline,Ext]{:}}
285 \item {\LARGE \MontreCode{-} : \CircGlyph[Inline,Ext]{-}}
286 \item {\LARGE \MontreCode{'} : \CircGlyph[Inline,Ext]{'}}
287 \item {\LARGE \MontreCode{+} : \CircGlyph[Inline,Ext]{+}}
288 \item {\LARGE \MontreCode{*} : \CircGlyph[Inline,Ext]{*}}
289 \item {\LARGE \MontreCode{(} : \CircGlyph[Inline,Ext]{(}}
290 \item {\LARGE \MontreCode{)} : \CircGlyph[Inline,Ext]{)}}
291 \item {\LARGE \MontreCode{=} : \CircGlyph[Inline,Ext]{=}}
292 \item {\LARGE \MontreCode{/} : \CircGlyph[Inline,Ext]{/}}
293 \item {\LARGE \MontreCode{<} : \CircGlyph[Inline,Ext]{<}}
294 \item {\LARGE \MontreCode{>} : \CircGlyph[Inline,Ext]{>}}
295 \end{itemize}
296 \end{multicols}
297 %{\renewcommand\arraystretch{1.5}\begin{tabularx}{\linewidth}{*{13}{c}}
298 % {\LARGE\CircGlyph[Inline,Ext]{,}}&{\LARGE\CircGlyph[Ext,Inline]{;}}&\CircGlyph[Ext,Inline]{.}&\CircGlyph[Ext,Inline]{?}&\CircGlyph[Ext,Inline]{!}&\CircGlyph[Ext,Inline]{:}&\CircGlyph[Ext,Inline]{-}&\CircGlyph[Ext,Inline]{'}&\CircGlyph[Ext,Inline]{+}&\CircGlyph[Ext,Inline]{+}&\CircGlyph[Ext,Inline]{(}&\CircGlyph[Ext,Inline]{)}&\CircGlyph[Ext,Inline]{=}\\
299 % ,&;&.&?&!&:&-&'&+&*&(&)&= \\
300 %\end{tabularx}}
301
302 %\begin{tblr}{width=\linewidth,stretch=1.5,colspec={*{13}{X[m,c]}}}
303 % {\LARGE\CircGlyph[Inline,Ext]{,}}&{\LARGE\CircGlyph[Ext,Inline]{;}}&\CircGlyph[Ext,Inline]{.}&\CircGlyph[Ext,Inline]{?}&\CircGlyph[Ext,Inline]{!}&\CircGlyph[Ext,Inline]{:}&\CircGlyph[Ext,Inline]{-}&\CircGlyph[Ext,Inline]{'}&\CircGlyph[Ext,Inline]{+}&\CircGlyph[Ext,Inline]{+}&\CircGlyph[Ext,Inline]{(}&\CircGlyph[Ext,Inline]{)}&\CircGlyph[Ext,Inline]{=}\\
304 %% ,&;&.&?&!&:&-&'&+&*&(&)&= \\
305 %% \CircGlyph[Ext,Inline]{/}&\CircGlyph[Ext,Inline]{<}&\CircGlyph[Ext,Inline]{>} \\
306 %% /&<&> \\
307 %\end{tblr}
308
309 \begin{DemoCode}[]
310 %texte sans glyphes etendus, mode en ligne
311 \CircGlyph[Inline]{Moi, auteur ; je : tu ! il ! nous ?}
312 \end{DemoCode}
313
314 \begin{DemoCode}[]
315 %texte sans glyphes etendus, mode hors ligne
316 \CircGlyph{Moi, auteur ; je : tu ! il ! nous ?}
317 \end{DemoCode}
318
319 \begin{DemoCode}[]
320 %texte avec glyphes etendus, mode en ligne
321 \CircGlyph[Ext,Inline]{Moi, auteur ; je : tu ! il ! nous ?}
322 \end{DemoCode}
323
324 \begin{DemoCode}[]
325 %texte avec glyphes etendus, mode hors ligne
326 \CircGlyph[Ext]{Moi, auteur ; je : tu ! il ! nous ?}
327 \end{DemoCode}
328
329 \begin{DemoCode}[]
330 %un peu de Maths ?
331 \CircGlyph[Ext,Inline]{2+3+5=10 et 1<9}
332 \end{DemoCode}
333
334 \subsection{Conseils et compléments}
335
336 Pour les caractères spéciaux et/ou accentués, il est conseillé d'utiliser les encodages \MontreCode{T1} et \MontreCode{utf8}, ainsi que le package \MontreCode{babel}.
337
338 \smallskip
339
340 Pour des problèmes de compatibilité avec les \texttt{catcodes}, il est conseillé de limiter l'utilisation de symboles de ponctuation comme \texttt{;} ou \texttt{:}, en utilisant par exemple un éditeur de texte pour les remplacer ou supprimer.
341
342 \smallskip
343
344 L'utilisation de \MontreCode{\textbackslash noindent} est recommandée en mode paragraphe pour que la \textit{grille} soit correctement affichée.
345
346 \smallskip
347
348 Pour de \textit{longs} paragraphes, le temps de compilation peut être relativement long, du fait de l'analyse caractère par caractère\ldots
349
350 \smallskip
351
352 Il est à noter que certains caractères peuvent poser des soucis en fonction du compilateur et/ou des environnements utilisés (ceci étant dû aux caractères actifs\ldots)
353
354 \pagebreak
355
356 \section{Historique}
357
358 \verb|v0.1.1|~:~~~~Compatibilité accrue avec \hologo{pdfLaTeX} et les caractères actifs + Clé \MontreCode{[Color]}
359
360 \verb|v0.1.0|~:~~~~Version initiale
361
362 \end{document}