-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathscrkernel-notepaper.dtx
More file actions
5056 lines (5055 loc) · 177 KB
/
scrkernel-notepaper.dtx
File metadata and controls
5056 lines (5055 loc) · 177 KB
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
% ======================================================================
% scrkernel-notepaper.dtx
% Copyright (c) Markus Kohm, 2006-2023
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
% This work may be distributed and/or modified under the conditions of
% the LaTeX Project Public License, version 1.3c of the license.
% The latest version of this license is in
% http://www.latex-project.org/lppl.txt
% and version 1.3c or later is part of all distributions of LaTeX
% version 2005/12/01 or later and of this work.
%
% This work has the LPPL maintenance status "author-maintained".
%
% The Current Maintainer and author of this work is Markus Kohm.
%
% This work consists of all files listed in MANIFEST.md.
% ======================================================================
%%% From File: $Id: scrkernel-notepaper.dtx 4113 2024-06-07 08:20:20Z kohm $
%<option>%%% (run: option)
%<body>%%% (run: body)
%<*dtx>
\ifx\ProvidesFile\undefined\def\ProvidesFile#1[#2]{}\fi
\begingroup
\def\filedate$#1: #2-#3-#4 #5${\gdef\filedate{#2/#3/#4}}
\filedate$Date: 2024-06-07 10:20:20 +0200 (Fri, 07 Jun 2024) $
\def\filerevision$#1: #2 ${\gdef\filerevision{r#2}}
\filerevision$Revision: 4113 $
\edef\reserved@a{%
\noexpand\endgroup
\noexpand\ProvidesFile{scrkernel-notepaper.dtx}
[\filedate\space\filerevision\space
KOMA-Script source
(note-paper)]
}%
\reserved@a
\documentclass[USenglish]{koma-script-source-doc}
\usepackage{babel}
\setcounter{StandardModuleDepth}{3}
\begin{document}
\DocInput{scrkernel-notepaper.dtx}
\end{document}
%</dtx>
% \fi
%
% \changes{v2.95}{2006/03/16}{first version after splitting \file{scrclass.dtx}}
% \changes{v3.36}{2022/02/26}{\cs{@newplength} replaced by \cs{newplength}}
% \changes{v3.36}{2022/02/26}{\cs{@setplength} replaced by \cs{setplength}}
% \changes{v3.36}{2022/02/26}{\cs{@addtoplength} replaced by \cs{addtoplength}}
% \changes{v3.36}{2022/03/02}{switch over from \cls*{scrdoc} to
% \cls*{koma-script-source-doc}}
% \changes{v3.36}{2022/03/02}{whole implementation documentation in English}
% \changes{v3.40}{2023/04/17}{guide names changed}
%
% \GetFileInfo{scrkernel-notepaper.dtx}
% \title{Specific Code for Letters and Especially the Notepaper with
% \href{https://komascript.de}{\KOMAScript}}
% \author{\href{mailto:komascript@gmx.info}{Markus Kohm}}
% \date{Revision \fileversion{} of \filedate}
% \maketitle
% \begin{abstract}
% The notepaper is something with high interest for letters. \KOMAScript{}
% provides a wide range of configurations for it. \file{scrkernel-notepaper}
% implements these features with options, variables and pseudo lengths
% \end{abstract}
% \tableofcontents
%
% \section{User Manual}
%
% You can find the user documentation the commands implemented here in the
% \KOMAScript{} manual, either the German \file{scrguide-de.pdf} or the
% English \file{scrguide-en.pdf}.
%
% \MaybeStop{\PrintIndex}
%
%
% \section{Implementation of the Notepaper of Letters}
%
% This code is only valid for letters with \cls*{scrlttr2} or
% \pkg*{scrletter}.
%
% \begin{macrocode}
%<*letter>
% \end{macrocode}
%
%
% \subsection{Options of the letter head}
%
% There are several options for the letter head.
%
% \begin{option}{firsthead}
% \changes{v2.97e}{2007/11/22}{added}
% \begin{macro}{\@firstheadfalse,\@firstheadtrue,\if@firsthead}
% \changes{v2.8q}{2002/01/25}{added}
% Optionally the whole letter head can be switched off (default is on).
% \begin{macrocode}
%<*option>
\KOMA@ifkey{firsthead}{@firsthead}
\KOMAExecuteOptions{firsthead=true}
% \end{macrocode}
% \end{macro}
% \end{option}
%
% \begin{option}{fromalign}
% \changes{v2.8q}{2002/01/25}{added}
% \changes{v3.12}{2013/03/05}{using \cs{FamilyKeyState}}
% \changes{v3.17}{2015/03/16}{using internal value storage}
% \changes{v3.39}{2022/11/11}{initial dot removed from member argument of
% option storage commands}
% \begin{macro}{\@alignfrom}
% \changes{v2.8q}{2002/01/25}{added}
% \changes{v2.97e}{2007/11/13}{new values added}
% The option provides several values for placing the sender of the letter. The
% decision is saved as numerical value of the macro.
% \begin{center}
% \begin{tabular}{lrl}
% \opt{fromalign} & \cs{@alignfrom} & placement\\\hline
% \opt{=left} & 0 & left in the head\\
% \opt{=center} & 1 & centered in the head\\
% \opt{=right} & 2 & right in the head\\
% \opt{=locationleft} & 3 & left in the location field\\
% \opt{=locationright} & 4 & right in the location field\\
% \opt{=false} & 10000 & \emph{don't touch} \\
% \end{tabular}
% \end{center}
% Initial setting is \emph{don't touch}, which means not to change the content
% of variable \var{firsthead} of \var{location}.
% \begin{macrocode}
\newcommand*{\@alignfrom}{0}
\KOMA@key{fromalign}{%
\KOMA@set@ncmdkey{fromalign}{@alignfrom}{%
{left}{0},%
{center}{1},{centered}{1},{middle}{1},%
{right}{2},%
{locationleft}{3},{leftlocation}{3},%
{locationright}{4},{rightlocation}{4},{location}{4},%
{no}{10000},{false}{10000},{off}{10000}%
}{#1}%
\ifx\FamilyKeyState\FamilyKeyStateProcessed
\KOMA@kav@xreplacevalue{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{fromalign}{#1}%
\ifcase\@alignfrom\or\or\or\@firstheadfalse\or\@firstheadfalse\fi
\fi
}
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{fromalign}{left}
% \end{macrocode}
% \end{macro}
% \end{option}
%
% \begin{option}{fromrule}
% \changes{v2.8q}{2002/01/25}{added}
% \changes{v3.17}{2015/03/16}{using internal value storage}
% \begin{macro}{\@rulefrom}
% \changes{v2.8q}{2002/01/25}{added}
% Should there be a horizontal rule inside the sender of the automatic
% generated letter head of option \opt{fromalign}?
% \begin{center}
% \begin{tabular}{lrl}
% \opt{fromrule} & \cs{@rulefrom} & rule placement \\\hline
% \opt{=false} & 0 & nowhere \\
% \opt{=aftername} & 1 & below the senders name \\
% \opt{=below} & 2 & below the senders address \\
% \end{tabular}
% \end{center}
% Initial setting is nowhere.
% \begin{macrocode}
\KOMA@ncmdkey{fromrule}[below]{@rulefrom}{%
{false}{0},{no}{0},{off}{0},{aftername}{1},%
{below}{2},{afteraddress}{2},{true}{2},{yes}{2},{on}{2}%
}
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{fromrule}{false}
% \end{macrocode}
% \end{macro}
% \end{option}
%
% \begin{option}{fromphone}
% \changes{v2.8q}{2002/01/25}{added}
% \begin{macro}{\@phonefalse,\@phonetrue,\if@phone}
% \changes{v2.8q}{2002/01/25}{added}
% Show the sender's telephone number in the letter head automatically
% generated by option \opt{fromalign}?
% \begin{macrocode}
\KOMA@ifkey{fromphone}{@phone}
% \end{macrocode}
% \end{macro}
% \end{option}
%
% \begin{option}{frommobilephone}
% \changes{v3.12}{2013/05/29}{added}
% \begin{macro}{\@mobilephonefalse,\@mobilephonetrue,\if@mobilephone}
% \changes{v3.12}{2013/05/29}{added}
% Show the sender's mobile telephone number in the letter head automatically
% generated by option \opt{fromalign}?
% \begin{macrocode}
\KOMA@ifkey{frommobilephone}{@mobilephone}
% \end{macrocode}
% \end{macro}
% \end{option}
%
% \begin{option}{fromfax}
% \changes{v2.8q}{2002/01/25}{added}
% \begin{macro}{\@faxfalse,\@faxtrue,\if@fax}
% \changes{v2.8q}{2002/01/25}{added}
% Show the sender's telefax number in the letter head automatically generated
% by option \opt{fromalign}?
% \begin{macrocode}
\KOMA@ifkey{fromfax}{@fax}
% \end{macrocode}
% \end{macro}
% \end{option}
%
% \begin{option}{fromemail}
% \changes{v2.8q}{2002/01/25}{added}
% \begin{macro}{\@emailfalse,\@emailtrue,\if@email}
% \changes{v2.8q}{2002/01/25}{added}
% Show the sender's email address in the letter head automatically generated
% by option \opt{fromalign}?
% \begin{macrocode}
\KOMA@ifkey{fromemail}{@email}
% \end{macrocode}
% \end{macro}
% \end{option}
%
% \begin{option}{fromurl}
% \changes{v2.8q}{2002/01/25}{added}
% \begin{macro}{\@wwwfalse,\@wwwtrue,\if@www}
% \changes{v2.8q}{2002/01/25}{added}
% Show a sender's url (e.g. of the homepage) in the letter head automatically
% generated by option \opt{fromalign}?
% \begin{macrocode}
\KOMA@ifkey{fromurl}{@www}
% \end{macrocode}
% \end{macro}
% \end{option}
%
% \begin{option}{fromlogo}
% \changes{v2.8q}{2002/01/25}{added}
% \begin{macro}{\@logofalse,\@logotrue,\if@logo}
% \changes{v2.8q}{2002/01/25}{added}
% Show a sender's logo in the letter head automatically generated by option
% \opt{fromalign} (placement also depends on \opt{fromalign})?
% \begin{macrocode}
\KOMA@ifkey{fromlogo}{@logo}
%</option>
% \end{macrocode}
% \end{macro}
% \end{option}
%
%
% \subsection{Options for the addressee and the location field}
%
% \begin{option}{addrfield}
% \changes{v2.8q}{2001/10/09}{added}
% \changes{v3.03}{2009/03/04}{new values added}
% \changes{v3.17}{2015/03/16}{using internal value storage}
% \begin{macro}{\@afieldmode}
% \changes{v3.03}{2009/03/04}{added}
% There are several settings for the address field---not only to switch it on
% and off:
% \begin{center}
% \begin{tabular}{lrl}
% \opt{addrfield} & \cs{@afieldmode} & meaning \\\hline
% false & 0 & don't show the address
% field\\
% true & 1 & show address field
% centered\\
% PP & 2 & address field with
% pospaid\\
% backgroundimage & 3 & address field with
% background image\\
% image & 4 & address field by image\\
% topaligned & 5 & show address field top
% aligned\\
% \end{tabular}
% \end{center}
% \begin{macrocode}
%<*option>
\newcommand*{\@afieldmode}{\@ne}
\KOMA@ncmdkey{addrfield}[true]{@afieldmode}{%
{false}{0},{off}{0},{no}{0},%
{true}{1},{on}{1},{yes}{1},%
{PP}{2},{pp}{2},%
{PPexplicite}{2},{PPExplicite}{2},%
{ppexplicite}{2},{ppExplicite}{2},%
{backgroundimage}{3},%
{PPbackgroundimage}{3},{PPBackgroundImage}{3},{PPBackGroundImage}{3},%
{ppbackgroundimage}{3},{ppBackgroundImage}{3},{ppBackGroundImage}{3},%
{image}{4},{Image}{4},%
{PPimage}{4},{PPImage}{4},%
{ppimage}{4},{ppImage}{4},%
{topaligned}{5},{alignedtop}{5}%
}
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{addrfield}{true}
% \end{macrocode}
% \begin{macro}{\@afieldfalse,\@afieldtrue,\if@afield}
% \changes{v3.03}{2009/03/04}{replaced by \cs{@afieldmode}}
% \changes{v3.36}{2022/03/02}{removed}
% \end{macro}
% \end{macro}
% \end{option}
%
% \begin{option}{priority}
% \changes{v3.03}{2009/03/04}{added}
% \changes{v3.17}{2015/03/16}{using internal value storage}
% \changes{v3.36}{2022/03/02}{value \opt{\quotechar=manual} fixed}
% \begin{macro}{\ltr@priority}
% \changes{v3.03}{2009/03/04}{added}
% The international postage convention allows two priorities for
% letters. Together with no (or manually given) priority we have three of
% them:
% \begin{center}
% \begin{tabular}{lrl}
% \opt{priority} & \cs{ltr@priority} & meaning \\\hline
% false & 0 & use variable \var{specialmail}\\
% B & 1 & set \var{specialmail} to
% B-Economy\\
% A & 2 & set \var{specialmail} to
% A-Priority\\
% \end{tabular}
% \end{center}
% \begin{macrocode}
\KOMA@ncmdkey{priority}[A]{ltr@priority}{%
{no}{0},{off}{0},{false}{0},{manual}{0},%
{B}{1},{b}{1},%
{economy}{1},{Economy}{1},{ECONOMY}{1},%
{B-ECONOMY}{1},{B-Economy}{1},{b-economy}{1},%
{A}{2},{a}{2},%
{priority}{2},{Priority}{2},{PRIORITY}{2},%
{A-PRIORITY}{2},{A-Priority}{2},{a-priority}{2}%
}%
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{priority}{false}
% \end{macrocode}
% \end{macro}
% \end{option}
%
% \begin{option}{backaddress}
% \changes{v2.8q}{2002/01/22}{added}
% \changes{v3.12}{2013/03/05}{using \cs{FamilyKeyState}}
% \changes{v3.17}{3015/03/16}{using internal value storage}
% \changes{v3.39}{2022/11/11}{initial dot removed from member argument of
% option storage commands}
% \begin{macro}{\@baddrfalse,\@baddrtrue,\if@baddr}
% \begin{macro}{\backaddr@format}
% \changes{v2.96}{2006/07/31}{added}
% The address field of the addressee can also contain a small sender's address
% also known as return address.
% \begin{center}
% \begin{tabular}{llll}
% \opt{backaddress} & \cs{if@baddr} & \cs{backaddr@format} & meaning \\\hline
% \opt{=false} & \cs{iffalse} & unchanged & don't show a
% return
% address\\
% \opt{=true} & \cs{iftrue} & unchanged & show the
% return address\\
% \opt{=underlined} & \cs{iftrue} & \cs{underline} & show
% underlined
% return
% address\\
% \opt{=plain} & \cs{iftrue} & \cs{@firstofone} & show the
% return
% address
% unchanged\\
% \end{tabular}
% \end{center}
% Initial setting is to show a underlined return address.
% \begin{macrocode}
\newcommand{\backaddr@format}[1]{}
\let\backaddr@format\underline
\newif\if@baddr\@baddrtrue
\KOMA@key{backaddress}[true]{%
\begingroup
\KOMA@set@ncmdkey{backaddress}{@tempa}{%
{false}{0},{off}{0},{no}{0},%
{true}{1},{on}{1},{yes}{1},%
{underlined}{2},%
{plain}{3}%
}{#1}%
\ifx\FamilyKeyState\FamilyKeyStateProcessed
\aftergroup\FamilyKeyStateProcessed
\ifcase\@tempa
\endgroup
\@baddrfalse
\or
\endgroup
\@baddrtrue
\or
\endgroup
\@baddrtrue
\let\backaddr@format\underline
\or
\endgroup
\@baddrtrue
\let\backaddr@format\@firstofone
\else
\endgroup
\fi
\if@baddr
\ifx\backaddr@format\underline
\KOMA@kav@replacevalue{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{backaddress}{underlined}%
\else
\ifx\backaddr@format\@firstofone
\KOMA@kav@replacevalue{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{backaddress}{plain}%
\else
\KOMA@kav@replacevalue{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{backaddress}{true}%
\fi
\fi
\else
\KOMA@kav@replacevalue{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{backaddress}{false}%
\fi
\else
\endgroup
\FamilyKeyStateUnknownValue
\fi
}
% \end{macrocode}
% \end{macro}^^A \backaddr@format
% \end{macro}^^A \if@baddr
% \end{option}^^A backaddress
%
% \begin{option}{locfield}
% \changes{v2.8q}{2001/10/09}{added}
% \changes{v2.97c}{2007/03/30}{inverted meaning fixed}
% \changes{v3.12}{2013/03/05}{using \cs{FamilyKeyState}}
% \changes{v3.17}{2015/03/16}{using internal value storage}
% \changes{v3.39}{2022/11/11}{initial dot removed from member argument of
% option storage commands}
% \changes{v3.42}{2024/06/07}{missing \cs{FamilyKeyStateProcessed} after end
% of group added}
% \begin{macro}{\@biglocfalse,\@bigloctrue,\if@bigloc}
% We allow two different automatic settings for the location field right
% beside the addressee's address field:
% \begin{center}
% \begin{tabular}{lll}
% \opt{locfield} & \cs{if@bigloc} & meaning \\\hline
% \opt{=wide} & \cs{iftrue} & set \plen{locwidth} to 2/3 of
% available space\\
% \opt{=narrow} & \cs{iffalse} & set \plen{locwidth} to 1/2 of
% available space\\
% \end{tabular}
% \end{center}
% Initial setting is \opt{locfield=narrow}.
% \begin{macrocode}
\newif\if@bigloc
\KOMA@key{locfield}[wide]{%
\begingroup
\KOMA@set@ncmdkey{locfield}{@tempa}{{wide}{0},{narrow}{1}}{#1}%
\ifx\FamilyKeyState\FamilyKeyStateProcessed
\aftergroup\FamilyKeyStateProcessed
\ifcase\@tempa
\endgroup
\@bigloctrue
\KOMA@kav@replacevalue{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{locfield}{wide}%
\else
\endgroup
\@biglocfalse
\KOMA@kav@replacevalue{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{locfield}{narrow}%
\fi
\else
\endgroup
\FamilyKeyStateUnknownValue
\fi
}
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{locfield}{narrow}
% \end{macrocode}
% \begin{option}{wlocfield,slocfield}
% \changes{v3.01a}{2008/11/20}{deprecated}
% \changes{v3.99}{2022/11/16}{removed from \KOMAScript~4}
% \begin{macrocode}
%<*!v4>
\KOMA@DeclareDeprecatedOption{wlocfield}{locfield=wide}
\KOMA@DeclareDeprecatedOption{slocfield}{locfield=narrow}
%</!v4>
%</option>
% \end{macrocode}
% \end{option}^^A wlocfield,slocfield
% \end{macro}^^A \if@bigloc
% \end{option}^^A locfield
%
%
% \subsection{Options of the fold marks}
%
% \KOMAScript{} provides a large number of horizontal and vertical fold marks.
% \begin{option}{foldmarks}
% \changes{v2.8q}{2001/09/10}{added}
% \changes{v3.00}{2008/06/06}{locally re-definition of \cs{FamilyUnkownKeyVal}
% instead of \cs{KOMA@unkown@keyval}}
% \changes{v3.12}{2013/03/05}{using \cs{FamilyKeyState}}
% \changes{v3.17}{2015/03/16}{using internal value storage}
% \changes{v3.39}{2022/11/11}{initial dot removed from member argument of
% option storage commands}
% \begin{macro}{\@foldfalse,\@foldtrue,\if@fold}
% \begin{macro}{\@usefolds}
% \changes{v2.97e}{2007/11/08}{added}
% Fold marks can be generally switched on and off and it can be selected,
% which fold marks should be shown, if fold marks has been activated:
% \begin{center}
% \begin{tabular}{llll}
% \opt{foldmarks} & \cs{if@fold} & \cs{@usefolds} & meaning\\\hline
% \opt{=true} & \cs{iftrue} & \emph{no change} & switch on fold
% marks\\
% \opt{=false} & \cs{iffalse} & \emph{no change} & switch off fold
% marks\\
% \opt{=\dots T\dots} & \emph{no change} & \texttt{T} \emph{added} & top
% fold mark
% enabled\\
% \opt{=\dots M\dots} & \emph{no change} & \texttt{M} \emph{added} & middle
% fold mark
% enabled\\
% \opt{=\dots B\dots} & \emph{no change} & \texttt{B} \emph{added} & bottom
% fold mark
% enabled\\
% \opt{=\dots P\dots} & \emph{no change} & \texttt{P} \emph{added} & hole
% punch fold mark
% enabled\\
% \opt{=\dots H\dots} & \emph{no change} & \texttt{TMBP} \emph{added} & all
% horizontal fold
% marks enabled\\
% \opt{=\dots L\dots} & \emph{no change} & \texttt{L} \emph{added} & left
% fold mark
% enabled\\
% \opt{=\dots V\dots} & \emph{no change} & \texttt{L} \emph{added} & all
% vertical fold
% marks enabled\\
% \opt{=\dots t\dots} & \emph{no change} & \texttt{T} \emph{removed} & top
% fold mark
% disabled\\
% \opt{=\dots m\dots} & \emph{no change} & \texttt{M} \emph{removed} & middle
% fold mark
% disabled\\
% \opt{=\dots b\dots} & \emph{no change} & \texttt{B} \emph{removed} & bottom
% fold mark
% disabled\\
% \opt{=\dots p\dots} & \emph{no change} & \texttt{P} \emph{removed} & hole
% punch fold mark
% disabled\\
% \opt{=\dots h\dots} & \emph{no change} & \texttt{TMBP} \emph{removed} & all
% horizontal fold
% marks disabled\\
% \opt{=\dots l\dots} & \emph{no change} & \texttt{L} \emph{removed} & left
% fold mark
% disabled\\
% \opt{=\dots v\dots} & \emph{no change} & \texttt{L} \emph{removed} & all
% vertical fold
% marks disabled\\
% \end{tabular}
% \end{center}
% Enabling or disabling a fold mark does not enable printing of fold
% marks. the enabled fold marks are only printed, if fold marks are switched
% on. The initial state is to switch on the top, middle, bottom, punch hole
% and left fold mark (in other words: all fold marks).
% \begin{macrocode}
%<*option>
\newif\if@fold\@foldtrue
\newcommand*{\@usefolds}{TMBPL}
\KOMA@key{foldmarks}[true]{%
\begingroup
\KOMA@set@ifkey\@empty{@fold}{#1}%
\ifx\FamilyKeyState\FamilyKeyStateProcessed
\if@fold\aftergroup\@foldtrue\else\aftergroup\@foldfalse\fi
\aftergroup\FamilyKeyStateProcessed
\else
\aftergroup\FamilyKeyStateProcessed
\def\sc@nf@ldch@rs##1{%
\ifx ##1\@nil\else
\if ##1T\g@addto@macro\@usefolds{##1}\else
\if ##1M\g@addto@macro\@usefolds{##1}\else
\if ##1B\g@addto@macro\@usefolds{##1}\else
\if ##1P\g@addto@macro\@usefolds{##1}\else
\if ##1L\g@addto@macro\@usefolds{##1}\else
\if ##1V\g@addto@macro\@usefolds{L}\else
\if ##1H\g@addto@macro\@usefolds{TMBP}\else
\if ##1t\scr@removechar\@usefolds{T}\else
\if ##1m\scr@removechar\@usefolds{M}\else
\if ##1b\scr@removechar\@usefolds{B}\else
\if ##1p\scr@removechar\@usefolds{P}\else
\if ##1l\scr@removechar\@usefolds{L}\else
\if ##1v%
\scr@removechar\@usefolds{L}%
\else
\if ##1h%
\scr@removechar\@usefolds{T}%
\scr@removechar\@usefolds{M}%
\scr@removechar\@usefolds{B}%
\else
\aftergroup\FamilyKeyStateUnknownValue
\fi
\fi
\fi
\fi
\fi
\fi
\fi
\fi
\fi
\fi
\fi
\fi
\fi
\fi
\expandafter\sc@nf@ldch@rs
\fi
}%
\expandafter\sc@nf@ldch@rs#1\@nil
\fi
\endgroup
\ifx\FamilyKeyState\FamilyKeyStateProcessed
\KOMA@kav@xreplacevalue{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{foldmarks}{\@usefolds}%
\KOMA@kav@xadd{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{foldmarks}{\if@fold true\else false\fi}%
\fi
}
\KOMA@kav@xadd{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{foldmarks}{\@usefolds}%
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{foldmarks}{true}%
% \end{macrocode}
% \begin{macro}{\scr@removechar}
% \changes{v2.97e}{2007/11/08}{added}
% Used to remove one char from a character list macro like \cs{@usefolds}.
% \begin{macrocode}
\newcommand*{\scr@removechar}[2]{%
\def\in@@##1#2##2##3\in@@{%
\ifx\in@##2\else
\def\in@@####1#2\in@{\gdef#1{##1####1}}%
\in@@##2##3%
\fi}%
\expandafter\in@@#1#2\in@\in@@
}
%</option>
% \end{macrocode}
% \end{macro}^^A \scr@removechar
% \end{macro}^^A \@usefolds
% \end{macro}^^A \if@fold
% \end{option}^^A foldmarks
%
%
% \subsection{Options of the reference line}
%
% \begin{option}{refline}
% \changes{v2.8n}{2001/09/08}{added}
% \changes{v2.96a}{2006/12/07}{alternated meaning fixed}
% \changes{v3.12}{2013/03/05}{using \cs{FamilyKeyState}}
% \changes{v3.17}{2015/03/16}{using internal value storage}
% \changes{v3.09}{2011/03/07}{values \opt{\quotechar=dateleft},
% \opt{\quotechar=dateright}, \opt{\quotechar=nodate} added}
% \changes{v3.27}{2019/05/03}{new value \opt{\quotechar=false} added}
% \changes{v3.39}{2022/11/11}{initial dot removed from member argument of
% option storage commands}
% \begin{macro}{\@refwidefalse,\@refwidetrue,\if@refwide}
% \changes{v2.8n}{2001/09/08}{added}
% \begin{macro}{\@datepos}
% \changes{v3.09}{2011/03/07}{added}
% \begin{macro}{\@reflinefalse,\@reflinetrue,\if@refline}
% \changes{v3.27}{2019/05/03}{added}
% The reference line support two predefined widths, switching off and
% three different positions for the date:
% \begin{center}
% \begin{tabular}{lllrl}
% \opt{refline} & \cs{if@refwide} & \cs{if@refline} & \cs{@datepos} &
% meaning\\\hline
% \opt{false} & \emph{unchanged}& \cs{iffalse} & \emph{unchanged} &
% deactivate reference line\\
% \opt{=wide} & \cs{iftrue} & \cs{iftrue} & \emph{unchanged} &
% print wide reference line\\
% \opt{=narrow} & \cs{iffalse} & \cs{iftrue} & \emph{unchanged} &
% print narrow reference line\\
% \opt{=nodate}& \emph{unchanged} & \emph{unchanged} & 1 & don't print
% date in reference line\\
% \opt{=dateright}& \emph{unchanged} & \emph{unchanged} & 1 & add date
% rightmost to reference line\\
% \opt{=dateleft} & \emph{unchanged} & \emph{unchanged} & 2 & add date
% leftmost to reference line\\
% \end{tabular}
% \end{center}
% \begin{macrocode}
%<*option>
\newif\if@refwide
%<package>\newif\if@refline\@reflinetrue
\newcommand*{\@datepos}{1}
\KOMA@key{refline}[wide]{%
\begingroup
\KOMA@set@ncmdkey{refline}{@tempa}{{wide}{0},{narrow}{1},%
{dateleft}{2},{leftdate}{2},%
{dateright}{3},{rightdate}{3},%
{nodate}{4}%
%<package> ,{no}{5},{off}{5},{false}{5}%
}{#1}%
\ifx\FamilyKeyState\FamilyKeyStateProcessed
\aftergroup\FamilyKeyStateProcessed
\ifcase\@tempa% wide
\endgroup
\@refwidetrue
%<*package>
\@reflinetrue
\KOMA@kav@remove{scrletter.\scr@pkgextension}{refline}{false}%
%</package>
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{wide}%
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{narrow}%
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{wide}%
\or% narrow
\endgroup
\@refwidefalse
%<*package>
\@reflinetrue
\KOMA@kav@remove{scrletter.\scr@pkgextension}{refline}{false}%
%</package>
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{wide}%
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{narrow}%
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{narrow}%
\or% dateleft
\endgroup
\def\@datepos{2}%
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{dateleft}%
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{dateright}%
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{nodate}%
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{dateleft}%
\or% dateright
\endgroup
\def\@datepos{1}%
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{dateleft}%
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{dateright}%
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{nodate}%
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{dateright}%
\or% nodate
\endgroup
\def\@datepos{0}%
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{dateleft}%
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{dateright}%
\KOMA@kav@remove{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{nodate}%
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{nodate}%
%<*package>
\or% false
\endgroup
\@reflinefalse
\KOMA@kav@remove{scrletter.\scr@pkgextension}{refline}{wide}%
\KOMA@kav@remove{scrletter.\scr@pkgextension}{reline}{narrow}%
\KOMA@kav@add{scrletter.\scr@pkgextension}{refline}{false}%
%</package>
\fi
\else
\endgroup
\FamilyKeyStateUnknownValue
\fi
}
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{dateright}%
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{refline}{narrow}%
%</option>
% \end{macrocode}
% \end{macro}^^A \@reflinefalse,\@reflinetrue,\if@refline
% \end{macro}^^A \@datepos
% \end{macro}^^A \@refwidefalse,\@refwidetrue,\if@refwide
% \end{option}^^A refline
%
%
% \subsection{Options of the subject}
%
% \begin{option}{subject}
% \changes{v2.8q}{2001/10/09}{added}
% \changes{v3.12}{2013/03/05}{using \cs{FamilyKeyState}}
% \changes{v3.17}{2015/03/16}{using internal value storage}
% \begin{macro}{\@subjtrue,\@subjfalse,\if@subj}
% \begin{macro}{\@subjaftertrue,\@subjafterfalse,\if@subjafter}
% \begin{macro}{\subject@format}
% \changes{v2.97c}{2007/07/06}{added}
% \begin{command}{\raggedsubject}
% \changes{v2.97c}{2007/07/06}{added}
% The subject can be printed with or without title before or after the
% opening. Different alignments and formats are also supported:
% \begin{center}
% \begin{tabular}{lllll}
% \opt{subject} & \cs{if@subj} & \cs{if@subjafter} & \cs{subject@format} &
% \cs{raggedsubject}\\\hline
% \opt{=titled} & \cs{iftrue} & \emph{unchanged} & \emph{unchanged} &
% \emph{unchanged}\\
% \opt{=untitled} & \cs{iffalse} & \emph{unchanged} & \emph{unchanged} &
% \emph{unchanged}\\
% \opt{=afteropening} & \emph{unchanged} & \cs{iftrue} & \emph{unchanged} &
% \emph{unchanged}\\
% \opt{=beforeopening} & \emph{unchanged} & \cs{iffalse} & \emph{unchanged} &
% \emph{unchanged}\\
% \opt{=underlined} & \emph{unchanged} & \emph{unchanged} & \cs{underline}
% & \emph{unchanged}\\
% \opt{=left} & \emph{unchanged} & \emph{unchanged} & \emph{unchanged} &
% \cs{raggedright} \\
% \opt{=right} & \emph{unchanged} & \emph{unchanged} & \emph{unchanged} &
% \cs{raggedleft} \\
% \opt{=centered} & \emph{unchanged} & \emph{unchanged} & \emph{unchanged} &
% \cs{centering} \\
% \end{tabular}
% \end{center}
% \begin{macrocode}
%<*option>
\newcommand{\subject@format}[1]{#1}
\newcommand*{\raggedsubject}{}
\newif\if@subj
\newif\if@subjafter
\KOMA@key{subject}{%
\begingroup
\KOMA@set@ncmdkey{subject}{@tempa}{%
{titled}{0},%
{untitled}{1},%
{afteropening}{2},%
{beforeopening}{3},%
{underlined}{4},%
{left}{5},%
{right}{6},%
{centered}{7}%
}{#1}%
\ifx\FamilyKeyState\FamilyKeyStateProcessed
\aftergroup\FamilyKeyStateProcessed
\ifcase\@tempa
\aftergroup\@subjtrue
\or
\aftergroup\@subjfalse
\or
\aftergroup\@subjaftertrue
\or
\aftergroup\@subjafterfalse
\or
\aftergroup\let\aftergroup\subject@format\aftergroup\underline
\or
\aftergroup\let\aftergroup\raggedsubject\aftergroup\raggedright
\or
\aftergroup\let\aftergroup\raggedsubject\aftergroup\raggedleft
\or
\aftergroup\let\aftergroup\raggedsubject\aftergroup\centering
\fi
\else
\aftergroup\FamilyKeyStateUnknownValue
\fi
\endgroup
\ifx\FamilyKeyState\FamilyKeyStateProcessed
\KOMA@kav@xreplacevalue{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{subject}{\if@subj titled\else untitled\fi}%
\KOMA@kav@xadd{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{subject}{\if@subjafter after\else before\fi opening}%
\ifx\subject@format\underline
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{subject}{underlined}%
\fi
\ifx\raggedsubject\raggedright
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{subject}{left}%
\else
\ifx\raggedsubject\raggedleft
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{subject}{right}%
\else
\ifx\raggedsubject\centering
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{subject}{centered}%
\fi
\fi
\fi
\fi
}
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{subject}{untitled}%
\KOMA@kav@add{%
%<class> \KOMAClassFileName
%<package> scrletter.\scr@pkgextension
}{subject}{beforeopening}%
%</option>
% \end{macrocode}
% \end{command}^^A \raggedsubject
% \end{macro}^^A \subject@format
% \end{macro}^^A \@subjaftertrue,\@subjafterfalse,\if@subjafter
% \end{macro}^^A \@subjtrue,\@subjfalse,\if@subj
% \end{option}^^A subject
%
%
% \subsection{Options of the typing area}
%
% \begin{option}{enlargefirstpage}
% \changes{v2.8o}{2001/09/18}{added}
% \begin{macro}{\@enlargefpfalse,\@enlargefptrue,\if@enlargefp}
% \changes{v2.8o}{2001/09/18}{added}
% Usually the text at the notepaper is placed regarding the general typing
% area. But if the position of the foot of the note paper is to high, the text