-
Notifications
You must be signed in to change notification settings - Fork 4
/
menukeys.dtx
2151 lines (2118 loc) · 78.7 KB
/
menukeys.dtx
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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
% \iffalse meta-comment
%
%% File: menukeys.dtx Copyright (c) Tobias Weh
%%
%% This file 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
%%
%<pkg>\NeedsTeXFormat{LaTeX2e}[2009/01/01]
%<rbk>\providecommand\DeclareRelease[3]{}
%<rbk>\providecommand\DeclareCurrentRelease[2]{}
%<rbk>\DeclareRelease{v1.6.1}{2020-12-19}{menukeys-2020-12-19.sty}
%<rbk>\DeclareCurrentRelease{v1.6.2}{2022-07-01}
%<pkg>\ProvidesPackage{menukeys}
%<cur> [2022/07/01 v1.6.2 -- A package to format menus, paths and shortcuts]
%<161> [2020/12/19 v1.6.1 -- A package to format menus, paths and shortcuts]
%
%<*driver>
\documentclass{ltxdoc}
\usepackage[T1]{fontenc}
\usepackage[latin1]{inputenc}
\usepackage{lmodern}
\usepackage[english]{babel}
\usepackage{menukeys}
\usepackage{xspace}
\usepackage[hang]{footmisc}
\usepackage{dblfnote}
\setlength{\footnotemargin}{1em}
\usepackage{listings}
\usepackage{xcolor}
\definecolor{darkred}{HTML}{770011}
\definecolor{darkblue}{HTML}{003b8b}
\PassOptionsToPackage{%
linkcolor=darkblue,
urlcolor=darkred,
bookmarksopen=true,
bookmarksdepth=10,
pdftitle={The menukeys package},
pdfsubject={%
Format menu sequences, paths and keystrokes from lists.%
},
pdfauthor={%
Tobias Weh ([email protected]), Jonathan P. Spratte
},
pdfkeywords={The menukeys package, LaTeX}
}{hyperref}
\PassOptionsToPackage{hyphens}{url}
\usepackage{hypdoc}
\renewcommand{\usage}[1]{\textbf{\hyperpage{#1}}}
\renewcommand{\main}[1]{\textit{#1}}
\newcommand{\menukeys}{\texttt{menukeys}\xspace}
\newcommand{\TikZ}{Ti\textit{k}Z\xspace}
\newcommand*{\pkg}[1]{\texttt{#1}}
\newcommand*{\env}[1]{\texttt{#1}}
\newcommand*{\fnt}[1]{\texttt{#1}}
\newcommand*{\opt}[1]{\texttt{#1}}
\newcommand{\DO}[1]{%
\marginpar{\raggedleft\texttt{#1} \footnotesize(opt.)}%
\index{#1=\texttt{#1} (option)|usage}%
\index{Options:>\texttt{#1}|usage}%
\ignorespaces
}
\newcommand{\DM}[1]{\DescribeMacro{#1}\ignorespaces}
\newcommand{\DE}[1]{\DescribeEnv{#1}\ignorespaces}
\newcommand{\AST}{\meta{\texttt{*}}}
\newcommand{\minisec}[1]{\par\medskip\noindent{\sffamily\bfseries#1}\quad}
\newcommand{\example}{\minisec{Example}\xspace}
\providemenumacro{\test}{roundedmenus}
\NewDocumentCommand{\teststyle}{ o m m m }{{%
\renewmenumacro{\test}{#2}%
\par\vspace{1.5\baselineskip plus 0.5\baselineskip minus 0.25\baselineskip}
\noindent
\fbox{\begin{minipage}{0.97\textwidth}
Name: \texttt{#2}
\index{#2=\texttt{#2} (style)|usage}%
\index{Styles:>\texttt{#2}|usage}
\par\vspace{0.5\baselineskip}%
\test{#3}
\par\vspace{0.5\baselineskip}%
\test{#4}%
\par\vspace{0.5\baselineskip}%
This is some more or less blind text, to demonstrate how
the sequence looks in text. This \test{#3} is the result
of a style which name is \texttt{#2}. And again some
blind text without any sense.%
\IfValueT{#1}{{%
\par\vspace{0.5\baselineskip}%
\itshape\footnotesize#1\par
}}%
\end{minipage}}%
}}
\makeatletter
\newcommand{\colortest}[1]{{%
\par\vspace{\baselineskip}%
\setlength{\fboxsep}{0pt}%
\noindent Name: \texttt{#1}\index{#1=\texttt{#1} (theme)|usage}%
\index{Color themes:>\texttt{#1}|usage}
\\[0.5\baselineskip]
Background: \fbox{\textcolor{tw@color@theme@#1@bg}{\rule[-0.4ex]{2.2ex}{2.2ex}}}
\quad Border: \fbox{\textcolor{tw@color@theme@#1@br}{\rule[-0.4ex]{2.2ex}{2.2ex}}}
\quad Text: \fbox{\textcolor{tw@color@theme@#1@txt}{\rule[-0.4ex]{2.2ex}{2.2ex}}}
\quad (A: \fbox{\textcolor{tw@color@theme@#1@a}{\rule[-0.4ex]{2.2ex}{2.2ex}}}
\quad B: \fbox{\textcolor{tw@color@theme@#1@b}{\rule[-0.4ex]{2.2ex}{2.2ex}}}
\quad C: \fbox{\textcolor{tw@color@theme@#1@c}{\rule[-0.4ex]{2.2ex}{2.2ex}}}\kern2pt)
}}
\makeatother
\MakeShortVerb{\|}
\setcounter{tocdepth}{3}
\makeatletter
\def\SpecialMainEnvIndex#1{\@bsphack\special@index{%
#1\actualchar
{\string\ttfamily\space#1}
(env)%
\encapchar main}%
\special@index{Environments:\levelchar#1\actualchar{%
\string\ttfamily\space#1}\encapchar
main}\@esphack}
\def\SpecialUsageIndex#1{\@bsphack
{\let\special@index\index\SpecialIndex@{#1}{\encapchar usage}}%
\@esphack}
\def\SpecialEnvIndex#1{\@bsphack
\index{#1\actualchar{\protect\ttfamily#1}
(env)\encapchar usage}%
\index{Environments:\levelchar#1\actualchar{\protect\ttfamily#1}\encapchar
usage}\@esphack}
\makeatother
\addto\captionsenglish{%
\def\indexname{Macro index}
\def\glossaryname{Change history}
}
\IndexPrologue{
\section{Macro index}
Numbers written in bold face refer to the page where the corresponding entry is described;
italic numbers refer to the code line of the definition; numbers in roman refer to the code
lines where the entry is used.
}
\GlossaryPrologue{
\section{Change history}\label{version}%
}
\setcounter{IndexColumns}{2}
\makeatletter
\tikzset{tw@menusbig@base/.style={%
tw@set@tikz@colors,
rounded corners=0.15ex,
inner sep=0pt,
inner xsep=2pt,
text height=2.1ex,
text depth=0.6ex,
minimum width=1.5em,
font=\Huge\bfseries\sffamily,
signal,
signal to=nowhere,
signal pointer angle=110,
ultra thick,
}}
\tw@declare@style*{menusbig}{%
\tikz[baseline={($([email protected])+(0,-0.2ex)$)}]{%
\node(tw@node)[tw@menusbig@base,signal to=east]%
{\strut\CurrentMenuElement};}%
}[\hspace{-0.2em}\hspace{0em plus 0.1em minus 0.05em}]%
{%
\tikz[baseline={($([email protected])+(0,-0.2ex)$)}]{%
\node(tw@node)[tw@menusbig@base,signal from=west,signal to=east]%
{\strut\CurrentMenuElement};}%
}{%
\tikz[baseline={($([email protected])+(0,-0.2ex)$)}]{%
\node(tw@node)[tw@menusbig@base,signal from=west,]%
{\strut\CurrentMenuElement};}%
}{%
\tikz[baseline={($([email protected])+(0,-0.2ex)$)}]{%
\node(tw@node)[tw@menusbig@base]{\strut\CurrentMenuElement};}%
}{blacknwhite}
\newmenumacro{\filefolder}[/]{pathswithblackfolder}
\newmenumacro{\MENU}[,]{menusbig}
\newcommand\email[1]{\href{mailto:#1}{\texttt{#1}}}
\makeatother
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\begin{document}
\DocInput{menukeys.dtx}
\end{document}
%</driver>
% \fi
%
% \CharacterTable
% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
% Digits \0\1\2\3\4\5\6\7\8\9
% Exclamation \! Double quote \" Hash (number) \#
% Dollar \$ Percent \% Ampersand \&
% Acute accent \' Left paren \( Right paren \)
% Asterisk \* Plus \+ Comma \,
% Minus \- Point \. Solidus \/
% Colon \: Semicolon \; Less than \<
% Equals \= Greater than \> Question mark \?
% Commercial at \@ Left bracket \[ Backslash \\
% Right bracket \] Circumflex \^ Underscore \_
% Grave accent \` Left brace \{ Vertical bar \|
% Right brace \} Tilde \~}
%
% \changes{v1.0}{2012/02/23}{Initial version}
% \changes{v1.1}{2012/02/26}{Improved manual}
% \changes{v1.2}{2013/07/23}{Tidy up version and date}
% \changes{v1.2}{2013/07/23}{Fixed GitHub issues \#9, \#10, \#11, \#13, \#17, \#24 and \#26}
% \changes{v1.2}{2013/07/23}{Added \cs{SPACE} and \cs{spacename}}
% \changes{v1.2}{2013/07/23}{Added \cs{normalsize} before symbol definitions to make
% the \texttt{ex} unit available}
% \changes{v1.2a}{2013/09/10}{Replaced obsolete \cs{tikzstyle}}
% \changes{v1.2a}{2013/09/10}{Added braces to the \cs{tikz} macro since the parser
% seems to crash with \pkg{babel}'s french option otherwise.}
% \changes{v1.3}{2014/03/10}{Improved key symbols.}
% \changes{v1.3}{2014/03/10}{Added \TikZ-styles for the key symbols.}
% \changes{v1.4}{2016/04/17}{The \texttt{path...} styles now use the text color
% of the selected color theme (fix issue \#16).}
% \changes{v1.4}{2016/04/18}{Extended color theme features.}
%
% \GetFileInfo{menukeys.sty}
%
% \DoNotIndex{\?,\_,\.,\@M,\@@input,\@Alph,\@alph,\@addtoreset,\@arabic}
% \DoNotIndex{\@badmath,\@centercr,\@cite}
% \DoNotIndex{\@dotsep,\@empty,\@float,\@gobble,\@gobbletwo,\@ignoretrue}
% \DoNotIndex{\@input,\@ixpt,\@m,\@minus,\@mkboth}
% \DoNotIndex{\@ne,\@nil,\@nomath,\@plus,\roman,\@set@topoint}
% \DoNotIndex{\@tempboxa,\@tempcnta,\@tempdima,\@tempdimb}
% \DoNotIndex{\@tempswafalse,\@tempswatrue,\@viipt,\@viiipt,\@vipt}
% \DoNotIndex{\@vpt,\@warning,\@xiipt,\@xipt,\@xivpt,\@xpt,\@xviipt}
% \DoNotIndex{\@xxpt,\@xxvpt,\\,\,,\addpenalty,\addtolength,\addvspace}
% \DoNotIndex{\advance,\ast,\begin,\begingroup,\bfseries,\bgroup,\box}
% \DoNotIndex{\bullet}
% \DoNotIndex{\cdot,\cite,\CodelineIndex,\cr,\day,\DeclareOption}
% \DoNotIndex{\def,\DisableCrossrefs,\divide,\DocInput,\documentclass}
% \DoNotIndex{\DoNotIndex,\egroup,\ifdim,\else,\fi,\em,\endtrivlist}
% \DoNotIndex{\EnableCrossrefs,\end,\end@dblfloat,\end@float,\endgroup}
% \DoNotIndex{\endlist,\everycr,\everypar,\ExecuteOptions,\expandafter}
% \DoNotIndex{\fbox}
% \DoNotIndex{\filedate,\filename,\fileversion,\fontsize,\framebox,\gdef}
% \DoNotIndex{\global,\halign,\hangindent,\hbox,\hfil,\hfill,\hrule}
% \DoNotIndex{\hsize,\hskip,\hspace,\hss,\if@tempswa,\ifcase,\or,\fi,\fi}
% \DoNotIndex{\ifhmode,\ifvmode,\ifnum,\iftrue,\ifx,\fi,\fi,\fi,\fi,\fi}
% \DoNotIndex{\input}
% \DoNotIndex{\jobname,\kern,\leavevmode,\let,\leftmark}
% \DoNotIndex{\list,\llap,\long,\m@ne,\m@th,\mark,\markboth,\markright}
% \DoNotIndex{\month,\newcommand,\newcounter,\newenvironment}
% \DoNotIndex{\NeedsTeXFormat,\newdimen}
% \DoNotIndex{\newlength,\newpage,\nobreak,\noindent,\null,\number}
% \DoNotIndex{\numberline,\OldMakeindex,\OnlyDescription,\p@}
% \DoNotIndex{\pagestyle,\par,\paragraph,\paragraphmark,\parfillskip}
% \DoNotIndex{\penalty,\PrintChanges,\PrintIndex,\ProcessOptions}
% \DoNotIndex{\protect,\ProvidesClass,\raggedbottom,\raggedright}
% \DoNotIndex{\refstepcounter,\relax,\renewcommand}
% \DoNotIndex{\rightmargin,\rightmark,\rightskip,\rlap,\rmfamily}
% \DoNotIndex{\secdef,\selectfont,\setbox,\setcounter,\setlength}
% \DoNotIndex{\settowidth,\sfcode,\skip,\sloppy,\slshape,\space}
% \DoNotIndex{\symbol,\the,\trivlist,\typeout,\tw@,\undefined,\uppercase}
% \DoNotIndex{\usecounter,\usefont,\usepackage,\vfil,\vfill,\viiipt}
% \DoNotIndex{\viipt,\vipt,\vskip,\vspace}
% \DoNotIndex{\wd,\xiipt,\year,\z@}
% \expandafter\DoNotIndex{\,}
% \DoNotIndex{\next,\unexpanded,\@backslashchar,
% \@ifundefinedcolor,\@nameuse,\detokenize,
% \cslet,\csname,\edef,\endcsname,
% \NewDocumentCommand}
% \DoNotIndex{\@afterheading,\@afterindentfalse,\@ifpackageloaded,\ ,
% \appto,\AtBeginDocument,\AtEndPreamble,\baselineskip,\BODY,
% \centering,\contentspage,\CurrentOption,\dots,\endquote,\fill,\filright,
% \tiny,\footnotesize,\Huge,\ifstrempty,\ifstrequal,\itshape,\Large,\large,\LARGE,
% \makebox,\MessageBreak,\NewEnviron,\newif,\normalfont,\normalsize,
% \pbox,\preto,\quote,\RequirePackage,\rule,\setstretch,
% \SetupKeyvalOptions,\sffamily,\singlespacing,\textbf,\textit,\textwidth,
% \thecontentslabel,\thecontentspage,\titlecontents,\xspace}
% \DoNotIndex{\0,\1,\2,\3,\4,\5,\6,\7,\8,\9,0,1,2,3,4,5,6,7,8,9}
% \DoNotIndex{\lccode,\listof,\lowercase,\PackageWarningNoLine,\PackageError,
% \PackageWarning,\renewenvironment,\romannumeral,\string,\strut}
% \DoNotIndex{\csdef,\cslet\csletcs,\letcs,\DeclareDocumentCommand,\ifcsundef,
% \RenewDocumentCommand,\ProvideDocumentCommand,\NewDocumentCommand,\hspace,
% \IfBooleanTF,\IfSubStr}
% \DoNotIndex{\tikz,\node,\draw,\definecolor,\colorlet,\usetikzlibrary,
% \texttt,\textcolor,\raisebox,\maxsizebox,\small,\ttfamily,\DeclareBoolOption}
% \DoNotIndex{\value,\usebox,\sbox,\providecommand,\ProcessKeyvalOptions,\newbox,
% \IfStrEq,\hyphenchar,\expandonce,\encodingdefault,\DeclareStringOption}
%
% \title{\Huge\MENU[,]{M,E,N,U,K,E,Y,S}}
% \author{^^A
% Tobias Weh\\
% {\normalsize\email{[email protected]}}\\
% {\normalsize\url{https://tobiw.de/en}}\\[\medskipamount]
% ^^A
% Jonathan P.\@ Spratte\\
% {\normalsize\email{[email protected]}}\\[\medskipamount]
% ^^A
% \normalsize\url{https://github.com/tweh/menukeys}\\
% \normalsize\url{https://www.ctan.org/pkg/menukeys}\\
% \normalsize\filefolder{macros/latex/contrib/menukeys}}
% \date{\filedate{} --- \fileversion}
% \thispagestyle{empty}
% \maketitle
%
% \begin{abstract}
% \noindent
% This package is build to format menu sequences, paths and keystrokes.
% \par\medskip\noindent
% You're welcome to send me feedback, questions, bug reports and feature requests.
% If you like to support this package -- especially improving or proofreading the
% manual -- send me an e-mail, please.
% \par\bigskip\noindent
% \emph{Many thanks to Ahmed Musa, who provided the original list parsing
% code at \url{https://tex.stackexchange.com/a/44989/4918}.}
% \par
% \end{abstract}
%
% \newpage\tableofcontents\newpage
%
% \section{Introduction}\label{intro}
% The \menukeys package is mainly designed to parse and print
% sequences of software menus, folders and files, or keystrokes.
% Most predefined styles use the power of \TikZ\footnote{See
% \url{https://www.ctan.org/pkg/pgf}.} to format the output.
%
% For example if you want to tell the reader of a manual how to set the ruler
% unit you may type
% \begin{verbatim}
% To set the unit of the rulers go to \menu{Extras > Settings > Rulers}
% and choose between millimeters, inches and pixels. The shortcut
% to view the rulers is \keys{cmd + R}. Pressing these keys again
% will hide the rulers.
%
% The standard path for saving your document is \directory{Macintosh HD/
% Users/Your Name/Documents} but you can change it at \menu{Extras >
% Settings > Saving} by clicking \menu{Change save path}.
% \end{verbatim}
% and get this:
%
% \medskip
% To set the unit of the rulers go to \menu{Extras > Settings > Rulers}
% and choose between millimeters, inches and pixels. The shortcut
% to view the rulers is \keys{cmd + R}. Pressing these keys again
% will hide the rulers.
%
% The standard path for saving your document is \directory{Macintosh HD/
% Users/Your Name/Documents} but you can change it at \menu{Extras >
% Settings > Saving} by clicking \menu{Change save path}.
%
% \bigskip\noindent
% The package is loaded as usual via
% \begin{verbatim}
% \usepackage{menukeys}
% \end{verbatim}
%
% \section{Installation}
% To install \menukeys manually run
% \begin{verbatim}
% latex menukeys.ins
% \end{verbatim}
% and copy |menukeys.sty| to a path where \LaTeX{} can find it.
%
% To typeset this manual run
% \begin{verbatim}
% pdflatex menukeys.dtx
% makeindex -s gglo.ist -o menukeys.gls menukeys.glo
% makeindex -s gind.ist -o menukeys.ind menukeys.idx
% pdflatex menukeys.dtx
% pdflatex menukeys.dtx
% \end{verbatim}
%
% \section{Package loading and options}\label{options}
% \changes{v1.6}{2020/10/27}{Load order no longer important}
% Since \menukeys used to use \pkg{catoptions}, which does some heavy changes on key-value
% options, it \textbf{was} recommended to load \menukeys as the last package
% (even after \pkg{hyperref}\footnote{See \url{https://tex.stackexchange.com/q/237683/4918}
% and \url{https://github.com/tweh/menukeys/issues/41}.}).
% \textbf{This is no longer the case!}
%
% These are the possible options:
% \begin{description}
% \item [definemenumacros:] Most of \menukeys' macros should not
% conflict with other packages\footnote{If you find a conflict send an e-mail.}
% but the predefined menu macros should be short and easy-to-read
% commands, which means that |\menu{A,B,C}| is preferred against
% |\printmenusequence{A,B,C}|. For that it's not unlikely that they
% conflict with other packages. To prevent this you can tell
% \menukeys to not define them by calling the option \DO{definemenumacros}
% |definemenumacros=false|. The default value is |true|.
%
% If you do so you have to define your own menu macros, see section~\ref{menumacros}
% for details.
% \item [definekeys:] Equal to |definemenumacros| \DO{definekeys} for the key macros.
% The default value is |true|.
% \item [mackeys:] This option \DO{mackeys} allows you to decide whether the mac keys
% are shown as text (|mackeys=text|) or symbols (|mackeys=symbols|). The default
% value is |symbols|.
% \item [os:] You can specify the OS \DO{os} by saying |os=mac| or |os=win|. This will cause
% some key macros to be rendered differently. The default value is |mac|.
% \item [hyperrefcolorlinks:] \emph{Obsolete}
% (see sec.~\ref{sec:issues} and~\ref{sec:hyperref-colorlinks}).
% \end{description}
%
% \section{Usage}
% \subsection{Basics}\label{basics}
% \menukeys comes with three ``menu macros'' that parse and print lists. We have
% \DM{\menu}|\menu|\marg{menu sequence}, with |>| as default input list separator,
% \DM{\directory}|\directory|\marg{path and files} with |/| as default separator and
% \DM{\keys}|\keys|\marg{keystrokes} with |+| as default separator. You've seen
% examples for all of them in section~\ref{intro}.
%
% These macros have also an optional argument to set the input list separator.
% E.g. if you want to put in your menus with |,| instead of |>| you can say
% |\menu[,]|\marg{menu sequence}.\footnote{If you want to change the input separator
% globally it's recommended to renew the menu macro as described in section~\ref{menumacros}.}
%
% The possible input separators are |/|, |=|, |*|, |+|, |,|, |;|, |:|, |-|, |>|,
% |<| and |bslash| (to use |\| as separator). You can hide a separator from the
% parser by putting a part of the sequence in braces. Spaces around the separator
% will be ignored, i.e. |\keys{\ctrl+C}| equals |\keys{\ctrl + C}|.
% \example |\menu[,]{Extras,Settings,{Units, rulers and origin}}| gives
% \menu[,]{Extras,Settings,{Units, rulers and origin}}
%
% \subsection{Styles}
% \menukeys defines several ``styles'' that determine the output format
% of a menu macro. There are some predefined styles and others can be
% created by the user.
% \subsubsection{Predefined styles}
%
% \teststyle{menus}{File,Extras,Preferences}{Menu}
% \teststyle{roundedmenus}{File,Extras,Preferences}{Menu}
% \teststyle{angularmenus}{File,Extras,Preferences}{Menu}
% \teststyle[The color of + is taken from optional color B.]
% {roundedkeys}{Ctrl,Alt,Q}{S}
% \teststyle[The color of + is taken from optional color B.\\
% The shadow color is taken from optional color C.]
% {shadowedroundedkeys}{Ctrl,Alt,Q}{S}
% \teststyle[The color of + is taken from optional color B.]
% {angularkeys}{Ctrl,Alt,Q}{S}
% \teststyle[The color of + is taken from optional color B.\\
% The shadow color is taken from optional color C.]
% {shadowedangularkeys}{Ctrl,Alt,Q}{S}
% \teststyle[The color of + is taken from optional color B.]
% {typewriterkeys}{Alt,Q}{S}
% \teststyle[The sep color is taken from optional color C.]
% {paths}{C:,User,Folder,MyFile.tex}{MyFile.tex}
% \teststyle[%
% The folder draw color is taken from optional color B.\\
% The folder fill color is taken from optional color A.\\
% The sep color is taken from optional color C.%
% ]
% {pathswithfolder}{C:,User,Folder,MyFile.tex}{MyFile.tex}
% \teststyle[%
% The folder draw color is taken from optional color B.\\
% The folder fill color is taken from optional color C.\\
% The sep color is taken from optional color C.%
% ]
% {pathswithblackfolder}{C:,User,Folder,MyFile.tex}{MyFile.tex}
%
% \bigskip\noindent
% The following three styles allow paths elements to be hyphenated, but
% they insert only a line break without a hyphen dash. Note that they only
% work with |T1| and |OT1| encoding (at least I tested only these ones)
% and that this in some cases doesn't work very well.
% \teststyle[The sep color is taken from optional color C.]
% {hyphenatepaths}{C:,Database,User,ALongUserNameHere,%
% ALongerFolderNameAtThisPlace,MyFile.tex}{MyFile.tex}
% \teststyle[%
% The folder draw color is taken from optional color B.\\
% The folder fill color is taken from optional color A.\\
% The sep color is taken from optional color C.%
% ]
% {hyphenatepathswithfolder}{C:,Database,User,ALongUserNameHere,%
% ALongerFolderNameAtThisPlace,MyFile.tex}{MyFile.tex}
% \teststyle[%
% The folder draw color is taken from optional color B.\\
% The folder fill color is taken from optional color C.\\
% The sep color is taken from optional color C.%
% ]
% {hyphenatepathswithblackfolder}{C:,Database,User,ALongUserNameHere,%
% ALongerFolderNameAtThisPlace,MyFile.tex}{MyFile.tex}
%
% \bigskip\pagebreak
% \minisec{Hint} The folder is drawn with the command \DM{\drawtikzfolder}
% |\drawtikzfolder| which is part of \menukeys and has two optional arguments
% to change the color of the lines and the fill color of the front:\\
% |\drawtikzfolder|\oarg{front fill}\oarg{draw}
%
% \subsubsection{Declaring styles}
% The simplest way to define a new style is to use \DM{\newmenustylesimple}
% |\newmenustylesimple|. It has six arguments: |\newmenustylesimple|\AST%
% \marg{name}\oarg{pre}\marg{style}\oarg{sep}\oarg{post}\linebreak \marg{theme}
% \begin{description}
% \item [name] is the name of the new style. It must follow the
% specifications of \TeX{} control sequences, which means it must
% contain only letters and no numbers.
% \item [pre] is the code which is executed before a menu macro.
% \item [style] is the style for the first list element. It has to be
% a \TikZ-style which is applied to a |node|, e.g. |draw,blue|.
% \item [sep] is the code executed between the lists elements, e.g. some
% space or a symbol.
% \item [post] is the code which is executed after a menu macro.
% \item [theme] is a color theme (see section~\ref{colors}).
% \end{description}
% \example Let us consider we want a list that prints a frame around its
% elements and separates them by a star. We can use
% \begin{verbatim}
% \newmenustylesimple{mystyle}{draw}[$\ast$]{mycolors}
% \end{verbatim}
%
% The more advanced command is \DM{\newmenustyle}|\newmenustyle|. It has
% nine arguments: |\newmenustyle|\AST\marg{name}\oarg{pre}\marg{first}%
% \oarg{sep}\marg{mid}\marg{last}\marg{single}\newline\oarg{post}\marg{theme}
% \begin{description}
% \item [name] is the name of the new style. It must follow the
% specifications of \TeX{} control sequences, which means it must
% contain only letters and no numbers.
% \item [pre] is the code which is executed before a menu macro.
% \item [first] is the style for the first list element. It has to be
% a \TikZ-style which is applied to a |node|, e.g. |draw,blue|.
% \item [sep] is the code executed between the lists elements, e.g. some
% space or a symbol.
% \item [mid] is the style for all elements between the first and the
% last one. It has to be a \TikZ style.
% \item [last] is the style for the last list element.
% It has to be a \TikZ style.
% \item [single] this style is used if the list contains only one element.
% It has to be a \TikZ style.
% \item [post] is the code which is executed after a menu macro.
% \item [theme] is a color theme (see section~\ref{colors}).
% \end{description}
% \example We can extend the previous example and desire that the first and
% the last element became red, and a single element should have a dashed frame. Furthermore
% the menu sequence should be preceded and followed by a bullet point:
% \begin{verbatim}
% \newmenustyle{mystyle}[$\bullet$]{draw,red}[$\ast$]%
% {draw}{draw,red}{draw,dashed}[$\bullet$]
% \end{verbatim}
%
% If the \TikZ |node| system doesn't fit your needs there are the \textbf{starred versions}:
% Use them and the arguments \meta{first},
% \meta{mid}, \meta{last}, \meta{single} can be any \LaTeX{} code. To access the
% current list element use \DM{\CurrentMenuElement}|\CurrentMenuElement|.
% \example consider that we want all menu elements simple be fat and not
% drawn with a \TikZ |node|. The separator should be the star again:
% \begin{verbatim}
% \newmenustylesimple*{mystyle}{\textbf{\CurrentMenuElement}}[$\ast$]
% \end{verbatim}
%
% If you want to make your own style you must take care of using the color
% theme. \DM{\usemenucolor} To access a color of the currently applied
% theme while defining a style use |\usemenucolor|\marg{element} (See
% section~\ref{colors} for details about possible elements).
%
% \subsubsection{Copying styles}
% To copy an existing style to a new style use \DM{\copymenustyle}|\copymenustyle|%
% \marg{copy}\marg{original}.
% \example To copy the definition of |mystyle| to |mycopy| use
% \begin{verbatim}
% \copymenustyle{mycopy}{mystyle}
% \end{verbatim}
%
% \subsubsection{Changing styles}
% The simplest change we can imagine is to change a single element or the color theme of
% an existing style. For the first case there is \DM{\changemenuelement}
% |\changemenuelement|\AST\marg{name} \marg{element}\marg{definition}, where the starred
% version works like the one of |\newmenustyle| does.
% \example To change the single element of |mystyle| from dashed to solid use the
% following code. You may save the original style by copying it as described above.
% \begin{verbatim}
% \changemenuelement{mystyle}{single}{draw}
% \end{verbatim}
% \DM{\changemenucolortheme}To satisfy the second case use |\changemenucolortheme|%
% \marg{name}\marg{color theme}.
% \example To change the color theme of |mystyle| to |myothercolors| call
% \begin{verbatim}
% \changemenucolortheme{mystyle}{myothercolors}
% \end{verbatim}
%
% \DM{\renewmenustylesimple}\DM{\providemenustylesimple}\DM{\renewmenustyle}%
% \DM{\providemenustyle} The next level is redefining a style. This package provides
% the following macros the work like their \LaTeX-paragons and have the same
% arguments as the above described macros: |\renewmenustylesimple|,
% |\providemenustylesimple|, |\renewmenustyle| and |\providemenustyle|.
%
% \subsection{Color themes}\label{colors}%
% To make the colors of a style become changeable without
% touching the style itself, \menukeys uses ``color themes''. Every color theme
% must contain three color definitions that can be used to draw a |node|
% background, a |node| frame and a text color, and additionally two optional
% colors used by some themes.
% \subsubsection{Predefined themes}
% There are two predefined color themes
% \colortest{gray}\colortest{blacknwhite}
% \subsubsection{Create a theme}
% \DM{\newmenucolortheme}To create a new theme use |\newmenucolortheme|. It uses the
% following arguments:\\
% |\newmenucolortheme|\marg{name}\marg{model}\marg{bg}\marg{br}\marg{txt}\oarg{a}\oarg{b}\oarg{c}
% \begin{description}
% \item [name] is the name of the theme and must contain only letters.
% \item [model] is the \pkg{xcolor} color model which is used to define a color, e.g.
% |named|, |rgb|, |cmyk|, \dots
% \item [bg] is the color definition for the |node| background.
% \item [br] is the color definition for the |node| border.
% \item [txt] is the color definition for the |node|'s text.
% \item [a] is an optional additional color (by default same as bg).
% \item [b] is an optional additional color (by default same as br).
% \item [c] is an optional additional color (by default same as txt).
% \end{description}
% \example To create a theme called |mycolors| we can say
% \begin{verbatim}
% \newmenucolortheme{mycolors}{named}{red}{green}{blue}
% \end{verbatim}
% \subsubsection{Copy a theme}
% \DM{\copymenucolortheme}To copy the definitions of one theme to another,
% use |\copymenucolortheme| \marg{copy}\marg{original}.
% \example To copy the colors of |mycolors| to |copycolors| type
% \begin{verbatim}
% \copymenucolortheme{copycolors}{mycolors}
% \end{verbatim}
% \subsubsection{Change a theme}
% \DM{\changemenucolor} If you want to change the color of a theme's element
% use |\changemenucolor|\marg{name} \marg{element}\marg{model}\marg{color definition},
% where name is the theme's name and \meta{element} is |bg|, |br|, or |txt|.
% \example Let's change the text color of |mycolors|:
% \begin{verbatim}
% \changemenucolor{mycolors}{txt}{named}{gray}
% \end{verbatim}
%
% \DM{\renewmenucolortheme}To redefine a complete theme use |\renewmenucolortheme|.
% It works with the same arguments as |\newmenucolortheme|.
%
% \subsection{Menu macros}\label{menumacros}%
% The ``menu marcos'' take a list separated by a special symbol to
% print it with a menu style.
% \subsubsection{Predefined menu macros}
% See section~\ref{basics}.
% \subsubsection{Defining or changing menu macros}
% \DM{\newmenumacro}To define a new menu macro call |\newmenumacro|\marg{macro}%
% \oarg{input sep}\marg{style}.
% \begin{description}
% \item [name] is a \LaTeX{} control sequence name.
% \item [input sep] is the default separator used in the input list
% (see section~\ref{basics} for a list of valid separators).
%
% If you don't give it the package's default (|,|) is used.
% \item [style] is a menu style.
% \end{description}
% This wil give you a macro like |\|\meta{macro}\oarg{input sep}\marg{list}
% \example Assuming you need a command to format Windows paths, you can
% define it with
% \begin{verbatim}
% \newmenumacro{\winpath}[bslash]{mystyle}
% \end{verbatim}
% and then use it as e.g. |\winpath{C:\System\Deep\Deeper\YourFile.txt}|.
% Note that |mystyle| must be defined before you call |\newmenumacro|.
%
% \DM{\providemenumacro}\DM{\renewmenumacro}There are also the two commands
% |\providemenumacro| and |\renewmenumacro| which take the same arguments as
% |\newmenumacro| and work like the \LaTeX{} macros |\renewcommand| and |\providecommand|.
% \example To change the default input separator of |\menu| you must know
% the default style (which is |menus|) and then you can say
% \begin{verbatim}
% \renewmenumacro{\menu}[,]{menus}
% \end{verbatim}
%
% \subsection{Keys}
% The \menukeys package comes with some macros to print
% special keys in the sequences set with |\keys|. Depending on
% the given OS (see section~\ref{options}) some macros behave
% differently to be able to use a key even if it's undefined
% via the \opt{os} option macros like |\|\meta{key}|mac| and
% |\|\meta{key}|win| that will always give the right symbol.
%
% The full ist of key macros is shown in table~\ref{tab:keys}.
%
% \begin{table}[ht]
% \caption{Overview of all key macros.}\label{tab:keys}
% \small
% \renewcommand{\arraystretch}{1.25}
% \begin{minipage}[t]{0.45\textwidth}
% \begin{tabular}[t]{lll}
% \hline
% \textbf{Macro} & \textbf{Mac} & \textbf{Win.} \\
% \hline
% |\shift| & \shift & \shift\\
% |\capslock| & \capslockmac & \capslockwin\\
% |\tab| & \tabmac & \tabwin\\
% |\esc| & esc / \escmac & \escwin\\
% |\oldesc| & esc / \oldescmac & \oldescwin\\
% |\ctrl| & \ctrlmac & \ctrlwin{}\\
% |\Alt| & alt / \Altmac & \Altwin \\
% |\AltGr| & & \AltGr \\
% |\cmd| & cmd / \cmdmac & \\
% |\Space| & [empty sp.] & [empty sp.] \\
% |\SPACE| & \spacename & \spacename \\
% |\return| & \returnmac & \returnwin \\
% |\enter| & \entermac & \enterwin \\
% \hline
% \end{tabular}
% \end{minipage}\hfill
% \begin{minipage}[t]{0.45\textwidth}
% \begin{tabular}[t]{lll}
% \hline
% \textbf{Macro} & \textbf{Mac} & \textbf{Win.} \\
% \hline
% |\winmenu| & & \winmenuwin \\
% |\backspace| & \backspace & \backspace\\
% |\del| & Del. / \delmac & \delwin{}\\
% |\backdel| & Del. / \backdelmac & \backdelwin{}\\
% |\arrowkey{^}| & \arrowkey{^} & \arrowkey{^} \\
% |\arrowkeyup| & \arrowkeyup & \arrowkeyup\\
% |\arrowkey{v}| & \arrowkey{v} & \arrowkey{v} \\
% |\arrowkeydown| & \arrowkeydown & \arrowkeydown\\
% |\arrowkey{>}| & \arrowkey{>} & \arrowkey{>} \\
% |\arrowkeyright| & \arrowkeyright & \arrowkeyright\\
% |\arrowkey{<}| & \arrowkey{<} & \arrowkey{<} \\
% |\arrowkeyleft| & \arrowkeyleft & \arrowkeyleft\\
% \hline
% \end{tabular}
% \end{minipage}
% \end{table}
%
% \DM{\arrowkey}
% The macro |\arrowkey|\marg{direction} is a little special
% since it takes the direction as a singe character |^|, |v|
% (lower case v), |>| or |<|.
%
% \DM{\ctrlname}\DM{\delname}\DM{\spacename}The texts for |\ctrl|,
% |\del| and |\SPACE| are saved in |\ctrlname|, |\delname|, |\spacename| respectively.
% So you can change them with |\renewcommand|.
%
% The rendering of some Mac macros depend on the option \DO{mackeys}\opt{mackeys}
% The different versions are shown in the table (left: |text|, right: |symbols|).
%
% \bigskip\noindent
% I apologize that there are no commands for the windows key
% and the apple logo, but that would be a copyright infringement.
%
% \section{Known issues and bugs}\label{sec:issues}
% \begin{itemize}
% \item If you use the \pkg{inputenc} package \menukeys must be
% loaded after it. Otherwise some key macros get corrupted.
% \item \changes{v1.1}{2012/02/26}{Load \pkg{xcolor} before \menukeys.}
% \menukeys must be loaded after \pkg{xcolor}, if you load
% the latter with options. Otherwise you'll get an option clash.
% Since \menukeys loads \pkg{xcolor} internally you may pass
% options as global options via |\documentclass| or directly to it via
% |\PassOptionsToPackage|.
% \example Set \pkg{xcolor} to |cmyk| model:
% \begin{verbatim}
% \documentclass{article}
% \PassOptionsToPackage{cmyk}{xcolor}
% \usepackage{menukeys}
% \begin{document}
% Hello World!
% \end{document}
% \end{verbatim}
% \end{itemize}
%
% If you find something to add to this list please send me an e-mail or report a
% bug on GitHub (\url{https://github.com/tweh/menukeys}).
%
% \StopEventually{\clearpage\PrintChanges\clearpage\PrintIndex}
%
% \section{Implementation}
% \begin{macrocode}
%<*pkg>
% \end{macrocode}
% \subsection{Required packages}
% \changes{v1.6}{2020/10/27}{Don't load \pkg{catoptions}}
% Load the required packages
% \begin{macrocode}
\RequirePackage{xparse}
\RequirePackage{xstring}
\RequirePackage{etoolbox}
% \end{macrocode}
% Furthermore we need \TikZ and some of its libraries,
% \begin{macrocode}
\RequirePackage{tikz}
\usetikzlibrary{calc,shapes.symbols,shadows}
% \end{macrocode}
% the color package \pkg{xcolor} and \pkg{adjustbox} for the
% |typewriterkeys| style.
% \begin{macrocode}
\RequirePackage{xcolor}
\RequirePackage{adjustbox}
% \end{macrocode}
% Load \pkg{relsize} to be able to change the font size
% relative to the surrounding text.
% \begin{macrocode}
\RequirePackage{relsize}
% \end{macrocode}
% To define the list parsing commands and allow |\| as
% a separator we used to load \pkg{catoptions}. Instead we now use some
% \pkg{expl3} functions to replace the macros we required from \pkg{catoptions}.
%
% The first few of these functions are more or less direct equivalents. A bit of
% attention has to be paid for |\tw@mk@xifinsetTF| as it requires the arguments
% to get swapped.
% \begin{macrocode}
\ExplSyntaxOn
\cs_new_eq:NN \tw@mk@trimspaces \tl_trim_spaces:n
\cs_new_eq:NN \tw@mk@exp@Nnno \exp_args:Nnno
\cs_new_eq:NN \tw@mk@string \cs_to_str:N
\prg_generate_conditional_variant:Nnn \tl_if_in:nn { xx } { TF }
\cs_new:Npn \tw@mk@xifinsetTF #1 #2
{
\tl_if_in:xxTF {#2} {#1}
}
% \end{macrocode}
% The replacement for |\indrisloop| will not set the conditional
% |\iflastindris|, instead we can check whether the sequence is empty to see
% whether this is the last element. This test will not use a TeX-like
% |\iflastindris...\else...\fi| construct but instead two branches.
% \begin{macrocode}
\cs_new:Npn \tw@mk@iflastindris
{
\seq_if_empty:NTF \l__twmk_indris_seq
}
% \end{macrocode}
% Replacing |\indrisloop| is a bit more work as it requires us to push some
% values to a stack (to allow nested usage, this may not be necessary for
% \pkg{menukeys}, but it is part of the original |\indrisloop| so we should
% play nice here). First we'll need a few variables.
% \begin{macrocode}
\seq_new:N \l__twmk_indris_seq
\int_new:N \l__twmk_indris_int
\tl_new:N \l__twmk_indris_tl
\cs_new_eq:NN \tw@mk@indrisnr \l__twmk_indris_int
\seq_new:N \l__twmk_indris_seqstack_seq
\seq_new:N \l__twmk_indris_intstack_seq
% \end{macrocode}
% Our stack will use another sequence in which the definitions of the parent
% call will be stored for the sequence and the integer. The other variables put
% on a stack by |\indrisloop| aren't required. The synopsis of
% |\tw@mk@indrisloop| will be different to the one provided by \pkg{catoptions}.
% The delimiter will be a mandatory argument (not in brackets), and there is no
% starred version.
% \begin{macrocode}
\cs_new_protected:Npn \__twmk_pushseq:
{
\seq_push:No \l__twmk_indris_seqstack_seq \l__twmk_indris_seq
}
\cs_new_protected:Npn \__twmk_pushint:
{
\seq_push:NV \l__twmk_indris_intstack_seq \l__twmk_indris_int
}
\cs_new_protected:Npn \__twmk_popseq:
{
\seq_if_empty:NTF \l__twmk_indris_seqstack_seq
{ \seq_clear:N \l__twmk_indris_seq }
{ \seq_pop:NN \l__twmk_indris_seqstack_seq \l__twmk_indris_seq }
}
\cs_new_protected:Npn \__twmk_popint:
{
\seq_if_empty:NTF \l__twmk_indris_intstack_seq
{ \int_zero:N \l__twmk_indris_int }
{
\group_begin:
\seq_pop:NN \l__twmk_indris_intstack_seq \l__twmk_indris_tl
\exp_args:NNNo
\group_end:
\int_set:Nn \l__twmk_indris_int \l__twmk_indris_tl
}
}
% \end{macrocode}
% The real loop works by first splitting the input into a sequence according to
% the delimiter in |#1|. Then this sequence is stepped through, but instead of
% using |\seq_map:NN| we'll have to pop the sequence into a local variable so
% that our test for the last element works. The parameter |#2| has to be
% expanded once as it is handed in as a token storing the real argument in later
% use.
% \begin{macrocode}
\cs_generate_variant:Nn \seq_set_split:Nnn { Noo }
\cs_new_protected:Npn \tw@mk@indrisloop #1 #2 #3
{
\__twmk_pushseq:
\__twmk_pushint:
\seq_set_split:Noo \l__twmk_indris_seq {#1} {#2}
\int_zero:N \l__twmk_indris_int
\bool_do_while:nn { \bool_not_p:n { \seq_if_empty_p:N \l__twmk_indris_seq } }
{
\int_incr:N \l__twmk_indris_int
\seq_pop_left:NN \l__twmk_indris_seq \l__twmk_indris_tl
\exp_args:No #3 \l__twmk_indris_tl
}
\__twmk_popseq:
\__twmk_popint:
}
\ExplSyntaxOff
% \end{macrocode}
%
% \subsection{Helper macros}
% \begin{macro}{\tw@mk@error}\begin{macro}{\tw@mk@warning}
% \begin{macro}{\tw@mk@warning@noline}
% Define macros to call |\PackageError| and warnings
% \begin{macrocode}
\newcommand*{\tw@mk@error}[2][Please consult the manual for more information.]{%
\PackageError{menukeys}{#2}{#1}%
}
\newcommand*{\tw@mk@warning}[1]{%
\PackageWarning{menukeys}{#1}%
}
\newcommand*{\tw@mk@warning@noline}[1]{%
\PackageWarningNoLine{menukeys}{#1}%
}
% \end{macrocode}
% \end{macro}\end{macro}\end{macro}
% \begin{macro}{\tw@mk@tempa}\begin{macro}{\tw@mk@tempb}
% Some commands for temporary use:
% \begin{macrocode}
\def\tw@mk@tempa{}
\def\tw@mk@tempb{}
% \end{macrocode}
% \end{macro}\end{macro}
% \begin{macro}{\tw@mk@gobble@args}
% Define a command to gobble arguments.
% \begin{macrocode}
\DeclareDocumentCommand{\tw@mk@gobble@args}{m}{%
\RenewDocumentCommand{\tw@mk@tempa}{#1}{}%
\tw@mk@tempa%
}
% \end{macrocode}
% \end{macro}
%
% \subsection{Options}
% First we declare and process the package options
% \begin{macrocode}
\RequirePackage{kvoptions}
\SetupKeyvalOptions{
family=tw@mk,
prefix=tw@mk@
}
\DeclareBoolOption[true]{definemenumacros}
\DeclareBoolOption[true]{definekeys}
\DeclareBoolOption[false]{hyperrefcolorlinks}
\DeclareStringOption[mac]{os}
\DeclareStringOption[symbols]{mackeys}
\ProcessKeyvalOptions{tw@mk}\relax
% \end{macrocode}
% Now we have to do some error treatment:
% \begin{macrocode}
\IfSubStr{.mac.win.}{.\tw@mk@os.}{}{%
\tw@mk@error{Unknown value for option 'os'\MessageBreak
Possible values are 'mac' or 'win'.}%
}
\IfSubStr{.symbols.text.}{.\tw@mk@mackeys.}{}{%
\tw@mk@error{Unknown value for option 'mackeys'\MessageBreak
Possible values are 'symbols' or 'text'.}%
}
% \end{macrocode}
%
% \subsection{Workarounds}
% Some workarounds to ``solve'' some incompatibilities:
% \subsubsection{\pkg{hyperref}'s \opt{colorlinks} option}\label{sec:hyperref-colorlinks}
% \changes{v1.6}{2020/10/27}{\opt{hyperrefcolorlinks} obsolete}
% \changes{v1.5}{2016/08/08}{New option \opt{hyperrefcolorlinks}}
% There used to be an issue with using the \opt{colorlinks} option of
% \pkg{hyperref} due to \pkg{catoptions} being loaded. Since \pkg{catoptions}
% isn't required any more, this workaround isn't necessary. For backwards
% compatibility the \opt{hyperrefcolorlinks} option is still evaluated and just
% uses |\hypersetup| or |\PassOptionsToPackage| depending on whether
% \pkg{hyperref} is already loaded.
% \begin{macrocode}
\iftw@mk@hyperrefcolorlinks
\tw@mk@warning{The option `hyperrefcolorlinks' is obsolete}
\@ifpackageloaded{hyperref}
{\hypersetup{colorlinks}}
{\PassOptionsToPackage{colorlinks}{hyperref}}
\fi
% \end{macrocode}
%
% \subsection{Color themes}
% \subsubsection{Internal commands}
% \begin{macro}{\tw@make@color@theme}
% First we define an internal command to make a color theme
% \begin{macrocode}
\newcommand*{\tw@make@color@theme}[8]{%
\definecolor{tw@color@theme@#1@bg}{#2}{#3}%
\definecolor{tw@color@theme@#1@br}{#2}{#4}%
\definecolor{tw@color@theme@#1@txt}{#2}{#5}%
\definecolor{tw@color@theme@#1@a}{#2}{#6}%
\definecolor{tw@color@theme@#1@b}{#2}{#7}%
\definecolor{tw@color@theme@#1@c}{#2}{#8}%
}
% \end{macrocode}