summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/bearwear/bearwear.dtx
blob: a635c727756157fc39c6b13548f015d305d3aaed (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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
% \iffalse meta-comment
%
%% File: bearwear.dtx
%
% Copyright (C) 2020 Ulrike Fischer / Bär
%
% It may be distributed and/or modified under the conditions of the
% LaTeX Project Public License (LPPL), either version 1.3c of this
% license or (at your option) any later version.  The latest version
% of this license is in the file
%
%    https://www.latex-project.org/lppl.txt
%
% This file is part of the "bearwear bundle" (The Work in LPPL)
% and all files in that bundle must be distributed together.
%
% -----------------------------------------------------------------------
%
% The development version of the bundle can be found at
%
%    https://github.com/u-fischer/bearwear
%
% for those people who are interested.
%
%<*driver>
\documentclass{l3doc}
\OnlyDescription
\PassOptionsToPackage{svgnames}{xcolor}
\usepackage{tikzlings,tikzducks,bearwear}
\usetikzlibrary{patterns,patterns.meta}
\usepackage{csquotes,graphicx}
\usepackage{needspace}
\usepackage{AlegreyaSans}
\setmainfont{Heuristica}
\usepackage[most]{tcolorbox}

\lstdefinestyle{bearwarestyle}{% stolen and adapted from tikzlings
	language={[latex]TeX},
	tabsize=2,
	breaklines,
	basicstyle=\ttfamily,
	commentstyle={\color{green!50!black}\slshape},
	columns=fullflexible,
	alsodigit={-},
	alsoletter={3},
	emphstyle=\color{red!60!black},
	emph=[1]{
		v-neckline,muscle, shirt, t-shirt, long, sleeves, round, neckline,
        leftarm, rightarm,arms,deco,body, pattern,beartummy,
        bearheart,color},
	texcsstyle=*\color{SteelBlue!50!black}\bfseries,
	keywordstyle=\color{red!60!black}\bfseries,
	morekeywords={tikzpicture},
	moretexcs={bearwear, bearwearsetup},
	delim ={[s][\ttfamily\color{green!50!black}]{$}{$}},
	moredelim=[is][\footnotesize\ttfamily\color{orange!70!black}]{|}{|},
	index=[1][emph]
}
\tcbset{%
	colframe=SteelBlue!50!black,
	arc=0mm,
	fonttitle=\bfseries,
	sidebyside,
	listing options={style=bearwarestyle},
	center lower,
	righthand width=4cm,
	bottom=0pt,
	top=0pt,
	%tikz lower,
	height plus=3cm,
	colback=SteelBlue!30!white,
    enlarge top initially by=10pt
}
\lstset{style=bearwarestyle}
\tikzset{
  hippo/.pic = {
   \begin{scope}[scale=0.2,transform shape]
     \hippo;
      \begin{scope}[yshift=0.15cm,xshift=-0.5cm,rotate=8]
        \duck[invisible,bowtie]
      \end{scope}
  \end{scope}},}
\raggedbottom
\newcommand\bearwearkey{\lstinline[style=bearwarestyle,breaklines=false]}
\newcommand{\TikZ}{Ti\emph{k}Z}

\GetFileInfo{bearwear.sty}
\title{The \bearwearlogo{} Package%
       \thanks{This file describes \fileversion,
        last revised \filedate.}}
\author{Idea: Bär~~\includegraphics[trim=0pt 15pt 0pt 0pt,height=13pt]{baer}
        \and Implementation: Ulrike Fischer%
        \thanks{Issues should be reported at https://github.com/u-fischer/bearwear}
        ~\includegraphics[trim=0pt 15pt 0pt 0pt,height=15pt]{ulrike}}
\date{\filedate}
\begin{document}
  \DocInput{\jobname.dtx}
\end{document}
%</driver>
% \fi
% \maketitle
% {\catcode`\%=14 \input{bearwear-doc}}
%
% \StopEventually{}
%    \begin{macrocode}
%<@@=bearwear>
%<*package>
\RequirePackage{xparse}
\RequirePackage{tikzlings-bears}
\ProvidesExplPackage {bearwear} {2020-04-21} {0.2}
  {A package for tikz bear fashion}
\ProcessOptions\relax
% a tikzset style to reverse the clip:
\tikzset
  {@@reverseclip/.style=
    {insert~path=
      {
       (current~bounding~box.south~west) --  (current~bounding~box.north~west)
       --
       (current~bounding~box.north~east) --  (current~bounding~box.south~east)
       -- cycle
      }
   }
 }

\definecolor{@@europablue}{RGB}{00,33,99}

\cs_new_protected:Npn \@@_rightarm_path:nn #1 #2 %#1 fill, clip, #2 user
 {
  \path[#1,#2,rotate~around={-50\char_generate:nn{58}{12}(0.525,0.9)}]
    (0.525,0.9) ellipse (0.35~and~0.15);
 }

\cs_new_protected:Npn \@@_leftarm_path:nn #1 #2 %#1 fill, clip, #2 user
 {
   \path[#1,#2,rotate~around={50\char_generate:nn{58}{12}(-0.525,0.9)}]
     (-0.525,0.9) ellipse (0.35~and~0.15);
 }

\cs_new_protected:Npn \@@_body_path:nn #1 #2 %#1 fill, clip, #2 user
 {
   \path[#1,#2] (0,0.75) ellipse (0.55~and~0.65);
 }

\cs_new_protected:Npn \@@_init_path:
  {
    \@@_rightarm_path:nn {}{}
    \@@_leftarm_path:nn  {}{}
    \@@_body_path:nn     {}{}
  }

\cs_new_protected:Npn \@@_set_coordinates:
  {
    \coordinate (beartummy) at (0,0.75);
    \coordinate (bearheart)  at (0.25,0.9);
  }

\cs_new_protected:Npn \@@_clipping_path:
  {
    \bool_if:NTF  \l__bearwear_v_neckline_bool
     {
       \clip  (0, 1.55)     circle (0.5)    [__bearwearreverseclip]; %head
       \clip  (-0.4, 1.55) -- (0.4, 1.55) -- (0,0.8) --cycle[__bearwearreverseclip];
        %v-neck
     }
      {
       \clip  (0, 1.55)     circle (0.53)    [__bearwearreverseclip]; %head
     }
    \clip  (0.425, 0.3)  circle (0.28)   [@@reverseclip];
    \clip  (-0.425, 0.3) circle (0.28)   [@@reverseclip];
    \bool_if:NTF \l_@@_t_shirt_bool
     {
       \clip (-1,0.6) --++ (0.45,0)--++(-0.5,5) --cycle[@@reverseclip] ;
       \clip ( 1,0.6) --++ (-0.45,0)--++(0.5,5) --cycle[@@reverseclip] ;
     }
     {
       \clip (-1,0.6) --++ (0.45,0)--++(-0.5,1) --cycle[@@reverseclip] ;
       \clip ( 1,0.6) --++ (-0.45,0)--++(0.5,1) --cycle[@@reverseclip] ;
     }
    \clip(-1,0.5) rectangle (1,1.2);
  }

\cs_new_protected:Npn \@@_shirt_color:
  {
    \bool_if:NF \l_@@_muscle_shirt_bool
      {
        \exp_args:Nno \@@_leftarm_path:nn  {fill}{\l_@@_leftarm_color_tl}
        \exp_args:Nno \@@_rightarm_path:nn {fill}{\l_@@_rightarm_color_tl}
      }
    \exp_args:Nno \@@_body_path:nn     {fill}{\l_@@_body_color_tl}
  }

\cs_new_protected:Npn \@@_shirt_pattern:
  {
    \bool_if:NF \l_@@_muscle_shirt_bool
      {
        \exp_args:Nno \@@_leftarm_path:nn  {}{\l_@@_leftarm_pattern_tl}
        \exp_args:Nno \@@_rightarm_path:nn {}{\l_@@_rightarm_pattern_tl}
      }
    \exp_args:Nno \@@_body_path:nn         {}{\l_@@_body_pattern_tl}
  }

\cs_new_protected:Npn \@@_shirt_deco:
  {
    \bool_if:NF \l_@@_muscle_shirt_bool
      {
        \exp_args:Nno \@@_leftarm_path:nn  {}{\l_@@_leftarm_deco_tl}
        \exp_args:Nno \@@_rightarm_path:nn {}{\l_@@_rightarm_deco_tl}
      }
    \exp_args:Nno \@@_body_path:nn         {}{\l_@@_body_deco_tl}
  }

\bool_new:N \l_@@_t_shirt_bool
\bool_new:N \l_@@_muscle_shirt_bool
\bool_new:N \l__bearwear_round_neckline_bool

\tl_new:N \l_@@_leftarm_color_tl
\tl_new:N \l_@@_rightarm_color_tl
\tl_new:N \l_@@_body_color_tl

\tl_new:N \l_@@_leftarm_pattern_tl
\tl_new:N \l_@@_rightarm_pattern_tl
\tl_new:N \l_@@_body_pattern_tl
\tl_new:N \l_@@_leftarm_deco_tl
\tl_new:N \l_@@_rightarm_deco_tl
\tl_new:N \l_@@_body_deco_tl
\tl_new:N \l_@@_tikzkeys_tl

\keys_define:nn {@@}
 {
   ,leftarm  .tl_set:N = \l_@@_leftarm_color_tl
   ,leftarm  .initial:n = {@@europablue}
   ,leftarm~pattern   .tl_set:N = \l_@@_leftarm_pattern_tl
   ,leftarm~deco         .code:n =
      {\tl_set:Nn \l_@@_leftarm_deco_tl {path~picture = {#1}}}
   ,rightarm .tl_set:N = \l_@@_rightarm_color_tl
   ,rightarm .initial:n = {@@europablue}
   ,rightarm~pattern   .tl_set:N = \l_@@_rightarm_pattern_tl
   ,rightarm~deco         .code:n =
      {\tl_set:Nn \l_@@_rightarm_deco_tl {path~picture = {#1}}}
   ,body     .tl_set:N = \l_@@_body_color_tl
   ,body     .initial:n = {@@europablue}
   ,body~pattern   .tl_set:N = \l_@@_body_pattern_tl
   ,arms     .meta:n   =  {leftarm={#1},rightarm={#1}}
   ,arms~pattern .meta:n   =  {leftarm~pattern={#1},rightarm~pattern={#1}}
   ,arms~deco .meta:n   =  {leftarm~deco={#1},rightarm~deco={#1}}
   ,shirt    .meta:n   =  {body={#1},leftarm={#1},rightarm={#1}}
   ,shirt~pattern    .meta:n   =
      {body~pattern={#1},leftarm~pattern={#1},rightarm~pattern={#1}}
   ,shirt~deco .meta:n   =
      {body~deco={#1},leftarm~deco={#1},rightarm~deco={#1}}
   ,long~sleeves .bool_set_inverse:N = \l_@@_t_shirt_bool
   ,t-shirt    .bool_set:N         = \l_@@_t_shirt_bool
   ,muscle~shirt .bool_set:N       = \l_@@_muscle_shirt_bool
   ,body~deco         .code:n =
      {\tl_set:Nn \l_@@_body_deco_tl {path~picture = {#1}}}
   ,round~neckline .bool_set_inverse:N       = \l__bearwear_v_neckline_bool
   ,v-neckline .bool_set:N   = \l__bearwear_v_neckline_bool
 }

\NewDocumentCommand\bearwearsetup { m }
 {
    \keys_set:nn { @@ } {#1}
 }
\NewDocumentCommand\bearwear { O {} }
  {
    \begin{scope}[even~odd~rule]
     % handle keys
     \keys_set_known:nnN { @@ } {#1}\l_@@_tikzkeys_tl
     \exp_args:No\tikzset{\l_@@_tikzkeys_tl}
     \@@_init_path:
     \@@_set_coordinates:
     \@@_clipping_path:
     \@@_shirt_color:
     \@@_shirt_pattern:
     \@@_shirt_deco:
    \end{scope}
  }

\NewDocumentCommand\bearwearlogo {} {{
  \normalfont\fontencoding{T1}\fontfamily{AlegreyaSans-LF}\selectfont
   BearWear
   \raisebox{0.8ex}[0pt][0pt]{
     %\textcircled{
       \begin{tikzpicture}[baseline={(0,0.03)},scale=\fp_eval:n{\f@size/100}]
           \bear;
           \bearwear[body~deco={\node[text=white] at (beartummy)
              {\fontsize{\fp_eval:n{\f@size/20}pt}{\fp_eval:n{\f@size/20}pt}
                \sffamily
                BearWear};}]
       \end{tikzpicture}}}}%}
%</package>
%    \end{macrocode}
%<*docu>
\section{Basic Usage}

 The package is based on \TikZ{} and the main command should be used in a \texttt{tikzpicture} or -- as shown in some of the examples -- with \verb+\tikz+.

 \subsection{The shirts}
 The package provides a number of shirts for the bear, \bearwearkey{long sleeves} and \bearwearkey{round neckline} are the defaults:
 \begin{tcblisting}{righthand width=6cm}
 \tikz\bearwear % default
    [long sleeves,
     round neckline];
 \tikz\bearwear
   [t-shirt];
 \tikz\bearwear
   [muscle shirt];

 \tikz\bearwear
   [v-neckline];
 \tikz\bearwear
   [t-shirt,v-neckline];
 \tikz\bearwear
   [muscle shirt,v-neckline];
  \end{tcblisting}

 \subsection{Dressing the bear}

 To dress the bear with the shirt, simply add the \verb+\bear+ command from the \bearwearkey{tikzlings-bears} package.

 \begin{tcblisting}{before=\parindent0pt\nopagebreak}
 \tikz{\bear\bearwear[v-neckline];}
 \tikz{\bear\bearwear[muscle shirt];}
  \end{tcblisting}

 \subsection{Coloring the shirts}

 The body and the arms of the shirts can be colored. They are three basic keys: \bearwearkey{leftarm}, \bearwearkey{rightarm} and \bearwearkey{body}, and two meta keys: \bearwearkey{arms} and \bearwearkey{shirt}.
 Basically every option that would make sense in a \lstinline|\fill|  is allowed here.
 Patterns e.g. would work too.
 \begin{tcblisting}{tikz lower}
  \bear
  \bearwear
    [v-neckline,
     leftarm=red,
     rightarm=green,
     body=blue]
 \end{tcblisting}
 \begin{tcblisting}{tikz lower}
  \bear
  \bearwear[arms=green]
 \end{tcblisting}
 \begin{tcblisting}{tikz lower}
  \bear
  \bearwear
    [shirt=
      {shade,
       top color=blue,
       bottom color=red}]
 \end{tcblisting}



 \begin{tcblisting}{tikz lower,before=\parindent0pt\nopagebreak}
   \bear
   \bearwear
     [v-neckline,
      shirt  =
        {pattern=
          horizontal lines light blue}]
 \end{tcblisting}

 \subsection{Additional patterns}

 As seen in the last example patterns can be added instead of colors, but sometimes it makes sense to
 add them on top to preserve a background color. For this the package provides special \texttt{pattern} keys:\\
 \bearwearkey{leftarm pattern}, \bearwearkey{rightarm pattern}, \bearwearkey{arms pattern},
 \bearwearkey{body pattern}, \bearwearkey{shirt pattern},

 \begin{tcblisting}{tikz lower}
  \bear
  \bearwear
     [v-neckline,
      shirt=red,
      body pattern =
       {pattern=
         {Stars[points=6,
          radius=0.5mm,distance=1.5mm]},
        pattern color=yellow}]
 \end{tcblisting}

 \subsection{Decorations}

 The \lstinline|deco| keys add their value to a \texttt{path picture} key. This can be used to place emblems or use graphics as pattern. To help with the placement two coordinates are
 predefined: \bearwearkey{bearheart} and \bearwearkey{beartummy}.

 \begin{tcblisting}{tikz lower}
   \bear
   \bearwear[shirt deco =
    {\fill[red] (beartummy) circle (1pt);
     \fill[red] (bearheart) circle (1pt);}
     ]
 \end{tcblisting}

 \begin{tcblisting}{tikz lower}
  \bear
  \bearwear[shirt deco =
    {\node at (beartummy)
     {\includegraphics[width=5cm]
       {tartan3}};}]
 \end{tcblisting}

 \begin{tcblisting}{tikz lower}
  \bear
  \bearwear[body deco=
    {\node at ([yshift=-1mm]bearheart)
      {\includegraphics[width=0.3cm]
        {flag}};}]
 \end{tcblisting}

 \begin{tcblisting}{tikz lower}
  \bear
  \bearwear[
     shirt=Beige!80!black,
     body deco=
      {\node at ([yshift=-1mm]bearheart)
       {\includegraphics[width=0.5cm]
         {latex-project-logo}};}]
 \end{tcblisting}

 \begin{tcblisting}{tikz lower}
  \bear
  \bearwear[
     shirt=HotPink,
     body deco=
      {\path  (bearheart)--++(0,-3mm)
        pic{hippo};}];
 \end{tcblisting}

 \begin{tcblisting}{tikz lower}
  \bear
  \bearwear[
    arms= DeepSkyBlue,
    body deco =
     {\node at ([yshift=-2mm]beartummy)
       {\includegraphics[width=4cm]
         {montblanc}};
      \node[text=white,
           font=\tiny\sffamily]
        at ([yshift=1.95mm]beartummy)
        {{Mont Blanc}};
     }]
 \end{tcblisting}

 \subsection{Scaling}

 Scaling works as expected, but don't forget that nodes in \TikZ{} normally don't scale if you don't use the \lstinline|transform shape| key.
 You can use a scope for the scaling, or the \texttt{scale} key as as unknown keys are passed to tikz --
 in this case don't forget that both
 the bear and the shirt needs the same scaling factor.

 \begin{tcblisting}{tikz lower,before=\parindent0pt\nopagebreak,}
  \begin{scope}[scale=1.5]
  \bear
  \bearwear[
    arms= DeepSkyBlue,
    body deco =
     {\node at ([yshift=-2mm]beartummy)
       {\includegraphics[width=4cm]
         {montblanc}};
      \node[text=white,
           font=\tiny\sffamily]
        at ([yshift=2mm]beartummy)
        {{Mont Blanc}};
     }]
   \end{scope}
 \end{tcblisting}

\begin{tcblisting}{tikz lower,before=\parindent0pt\nopagebreak,}
  \bear[scale=0.7]
  \bearwear[scale=0.7,
    arms= DeepSkyBlue,
    body deco =
     {\node at ([yshift=-2mm]beartummy)
       {\includegraphics[width=4cm]
         {montblanc}};
      \node[text=white,
           font=\tiny\sffamily]
        at ([yshift=2mm]beartummy)
        {{Mont Blanc}};
     }]
 \end{tcblisting}

 \subsection{Moving}

It is possible to move the bear and the shirt with it. Ensure that the same shift
is used if you don't want to undress the bear.

\begin{tcblisting}{tikz lower,before=\parindent0pt\nopagebreak,}
  \coordinate (newbear) at (3,0);
  \bear\bearwear
  \bear[shift=(newbear)]\bearwear[shirt=red,shift=(newbear)]
\end{tcblisting}

 \subsection{Setting up defaults}

 With \lstinline|\bearwearsetup| you can change the defaults:

 \begin{tcblisting}{}
 \bearwearsetup
   {body=green!50!black,arms=green}
 \tikz{\bear;\bearwear;}
 \tikz{\bear;\bearwear;}
 \end{tcblisting}
 \section{The brains behind \texorpdfstring{\bearwearlogo{}}{BearWear}}
 \includegraphics[width=3cm]{baer}
 \begin{description}
 \item[Ulrike]
  Bär, your decision to create \bearwearlogo{} has come as a surprise to many. Did you expect this?
  \item[Bär] Quite true, Ulrike. I am better known as an outdoor type
  and the fashionistas didn't reckon with me at all.
 \item[Ulrike] So, why did you take this step?
 \item[Bär] There were quite a few reasons -- most importantly
 my deeply felt desire to bring more justice to the world.
 Look at the wonderful world of \TikZ ducks fashion, and even Marmots have come
 far in the area of refinement. Why should \TikZ bears be left behind?
 \item[Ulrike] You are also concerned with the more momentous issues of our day.
 \item[Bär] Correct! My fashion line is the first ever to have practically
 no negative influence on our environment. Manufacture and transportation
 are ecologically neutral. In fact it's the first time in the
 history of world economy that goods are produced without
 the use of raw materials.
 \item[Ulrike] You claim that \bearwearlogo{} will have a global impact.
 \item[Bär] Yes, the issue of globalization is one which has been interesting
  me for a long time. \bearwearlogo{} caters for the needs of \TikZ bears all
  over the world. There is the Longshirt Line for those who live near the poles,
  t-shirts for those in temperate regions and even a Muscle Shirt Line for the
  bears of Australia.
 \item[Ulrike] How about individuality?
 \item[Bär] I am particularly proud that \bearwearlogo{} enables every single
 bear to create his own personal shirt -- free of the dictates of the modern
 Brummells. He may use my suggestions but he need not do so.
 \item[Ulrike] Will you be seen wearing your own creations?
 \item[Bär] Well Ulrike, I am afraid this is not very likely.
 I have got this most beautiful fur and I'd hate to  cover it with artifical
 patterns -- no matter how ravishing.
 \item[Ulrike] One last question: what impulse got you moving towards
 \bearwearlogo{}?
 \item[Bär] The death of Karl Lagerfeld. Someone had to fill the void.
 \end{description}
 %</docu>