-
Notifications
You must be signed in to change notification settings - Fork 3
/
edu.tex
9532 lines (7936 loc) · 274 KB
/
edu.tex
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
%% edu Documentclass for typesetting educational documents
%%
%% Copyright (C) 2012-2018 by Daniel Wunderlich <code@wu-web.de>
%%
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3
%% of this license or (at your option) any later version.
%% The latest version of this license is in
%% http://www.latex-project.org/lppl.txt
%% and version 1.3 or later is part of all distributions of LaTeX
%% version 2005/12/01 or later.
%%
%% This work has the LPPL maintenance status `maintained'.
%%
%% The current maintainer of this work is Daniel Wunderlich.
%%
%% This work consists of the file edu.tex and the derived files:
%% * edu.cls
%% * edu-styles-wu.sty
%% * edu-colors-wu.sty
%% * edu.pdf
%% * edu-de.pdf
\documentclass{skdoc}
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{array}
\usepackage{booktabs}
\usepackage{cancel}
\usepackage{datetime}
\usepackage{enumitem}
\usepackage{esvect}
\usepackage{etoolbox}
\usepackage{eurosym}
\usepackage{fancyvrb}
\usepackage{filecontents}
\usepackage{geometry}
\usepackage[notcomma, notperiod, notquote, notquery]{hanging}
%\usepackage{listings}
\usepackage{multicol}
\usepackage{polynom}
\usepackage{tabularx}
\usepackage{tikz}
\usepackage{units}
\usepackage{xspace}
\usepackage[only, lightning]{stmaryrd}
\usepackage[newcommands]{ragged2e}
\usepackage{hyperref}
\let\SI\relax
\usepackage{siunitx}
\DeclareSIUnit\point{pt}
\usepackage{hologo,booktabs,xcoffins,calc}
\usepackage[style=authoryear]{biblatex}
\usepackage{csquotes}
\usepackage{varioref,cleveref}
%\usepackage{chslacite}
\usetikzlibrary{positioning}
\ExplSyntaxOn
\cs_set_protected_nopar:Npn\ExplHack{
\char_set_catcode_letter:n{ 58 }
\char_set_catcode_letter:n{ 95 }
}
\ExplSyntaxOff
% Geometry
\geometry{left=4cm, top=2.5cm, right=2.5cm, bottom=2.5cm, includefoot}
% Fancyvrb
\fvset{frame=single, rulecolor=\color{coderule}}
% Font
\usepackage{sourcesanspro}
% Fontsize
\KOMAoption{fontsize}{10}
% Colors
% Original colors of skdoc:
%\definecolorset{RGB}{}{}{
% section,145,0,0;
% intlink,140,35,24;
% keydesc,140,35,24;
% scriptcolor,140,35,24;
% sharp,250,105,0;
% bright,198,229,217;
% extlink,2,10,61;
% macrodesc,73,10,61;
% macroimpl,73,10,61;
% optioncolor,73,10,61;
% opt,73,10,61;
% meta,11,72,107
%}
\definecolor{section}{RGB}{145,0,0}
\definecolor{extlink}{RGB}{145,0,0}
\definecolor{intlink}{RGB}{145,0,0}
\definecolor{macrodesc}{RGB}{145,0,0}
\definecolor{macroimpl}{RGB}{145,0,0}
\definecolor{opt}{RGB}{145,0,0}
\definecolor{optioncolor}{RGB}{145,0,0}
\definecolor{meta}{RGB}{120,120,120}
% New colors (not used in skdoc)
\definecolor{itemize}{RGB}{145,0,0}
\definecolor{csref}{RGB}{145,0,0} % used by \cs
\definecolor{envref}{RGB}{145,0,0} % used by \env
\definecolor{optref}{RGB}{145,0,0} % used by \opt
\definecolor{pkgref}{RGB}{145,0,0} % used by \pkg
\definecolor{coderule}{RGB}{145,0,0} % used by fancyvrb
\definecolor{previewrule}{RGB}{140,140,140} % used by \pdfinput
% Multilanguage support
\ExplSyntaxOn
\tl_gset:Nn \locale {de}
\tl_new:N \g_edu_warningname
\tl_gset:Nn \g_edu_warningname {Warning}
\cs_generate_variant:Nn \tl_if_eq:nnT { xnT }
\cs_generate_variant:Nn \tl_if_eq:nnTF { xnTF }
\tl_if_eq:xnT {\locale} {de} {
\usepackage{ngerman}
\AtBeginDocument{
\cs_gset:Npn\abstractname{Zusammenfassung}
\cs_gset:Npn\appendixname{Anhang}
\cs_gset:Npn\bibname{Bibliographie}
\cs_gset:Npn\contentsname{Inhalt}
\cs_gset:Npn\figurename{Abbildung}
\cs_gset:Npn\glossaryname{Abbildung}
\cs_gset:Npn\refname{Referenzen}
\cs_gset:Npn\tablename{Tabelle}
\tl_gset:Nn \partname {Teil}
\tl_gset:Nn \g_edu_bugname {Bug}
\tl_gset:Nn \g_edu_noticename {Bemerkung}
\tl_gset:Nn \g_edu_todoname {Todo}
\tl_gset:Nn \g_edu_warningname {Warnung}
}
}
\cs_new:Npn \__edu_use_language:nn #1 #2 {
\tl_if_eq:xnT {\locale} {#1} {
#2}
}
\DeclareExpandableDocumentCommand \localeDE { +m } {
\__edu_use_language:nn {de} {#1}
}
\DeclareDocumentCommand \localeEN { +m } {
\__edu_use_language:nn {en} {#1}
}
\DeclareDocumentCommand \endcode { } {
\relax
}
\DeclareDocumentCommand \skipcode { +u \endcode } {
\relax
}
\DeclareDocumentCommand \startcode { m } {
\bool_if:nT {!\str_if_eq_p:nV {#1} {\locale}} {\skipcode}
}
\DeclareDocumentCommand \codeinput { m } {
\vspace{0.75\baselineskip}
\noindent \begin{minipage}{\linewidth}
\VerbatimInput{#1.tex}
\vspace{-\baselineskip}
\vspace{-4.5pt}
\setlength{\fboxsep}{1.5pt}
\noindent
\colorbox{coderule}{\textcolor{white}{
\scriptsize\texttt{\LaTeX}
}}
\end{minipage}
}
\DeclareDocumentCommand \pdfinput { O{\linewidth-2\fboxsep} m } {
\par
\IfFileExists{#2.pdf}{
\noindent
\begin{minipage}{\linewidth}
\setlength{\fboxsep}{1.5pt}
\hspace*{0pt}\hfill
\colorbox{previewrule}{\textcolor{white}{
\scriptsize\texttt{PDF}}
}
\hspace*{-2\fboxrule}%\hspace*{-0.5em}
\par
\vspace*{-2.5\fboxrule}
\setlength{\fboxsep}{5pt}
\noindent\fcolorbox{previewrule}{white}{
\makebox[\linewidth-2\fboxsep][l]{
\includegraphics[width=#1]{#2.pdf}
}
}
\end{minipage}
\vspace{\baselineskip}
}{
\Warning{Die~Graphik~\texttt{#2.pdf}~ist~nicht~vorhanden.~Erzeuge~die~ Graphiken~der~Dokumentation~durch~\texttt{make~all}.}
}
}
\DeclareDocumentEnvironment {codefilecontent} { s O{\linewidth-2\fboxsep} m } {
\IfBooleanTF{#1} {
\VerbatimOut{#3-nopreview.tex}
}{
\VerbatimOut{#3.tex}
}
} {
\endVerbatimOut
\IfBooleanTF{#1} {
\codeinput{#3-nopreview}
}{
\codeinput{#3}
}
\par
\IfBooleanTF{#1} {
\vspace{0.5\baselineskip}
}{
\pdfinput[#2]{#3}
}
}
% Hack, because xparse doesn't generate starred environments:
\cs_new:cpn {codefilecontent*} {\codefilecontent*}
\cs_new_eq:cN {endcodefilecontent*} \endcodefilecontent
% Git support
\tl_new:N \g_edu_gitrepo
\tl_gset:Nn \g_edu_gitrepo {wunderlich/edu}
\tl_new:N \g_edu_gitrepourl
\tl_gset:Nn \g_edu_gitrepourl {https://github.com/wunderlich/edu/}
\DeclareDocumentCommand \gitIssue { m } {
{\ttfamily \href{\tl_use:N \g_edu_gitrepourl issues/#1.html}{\g_edu_gitrepo / \# #1}}\xspace
}
% Reimplementing inline referencing concerning color
\makeatletter
\DeclareDocumentCommand \cs { s m } {
\IfBooleanTF{#1}{
\texttt{\char`\\#2}
}{
\textcolor{csref}{\texttt{\char`\\#2}}
}
\bool_if:NF\g__skdoc_no_index_bool{
\IfBooleanTF{#1}{}{\index@macro{#2}}
}
}
\DeclareDocumentCommand \env { s m } {
\IfBooleanTF{#1}{
\texttt{#2}
}{
\textcolor{envref}{\texttt{#2}}
}
\bool_if:NF\g__skdoc_no_index_bool{
\IfBooleanTF{#1}{}{\index@environment{#2}}
}
}
\DeclareDocumentCommand \opt { s m } {
\IfBooleanTF{#1}{
\texttt{#2}
}{
\textcolor{optref}{\texttt{#2}}
}
\bool_if:NF\g__skdoc_no_index_bool{
\IfBooleanTF{#1}{}{\index@option{#2}}
}
}
\DeclareDocumentCommand \pkg { s m } {
\IfBooleanTF{#1}{
\textsf{#2}
}{
\textcolor{pkgref}{\texttt{#2}}
}
\bool_if:NF\g__skdoc_no_index_bool{
\IfBooleanTF{#1}{}{\index@package{#2}}
}
}
\makeatother
% New Commands:
\DeclareDocumentCommand \fpbox { O{\linewidth-2\fboxsep-2\fboxrule} m } {
\noindent\fbox{\parbox{#1}{#2}}
}
\DeclareDocumentCommand \Bug { +m } {
\vspace{\baselineskip}
\par\noindent
\group_begin:
\color{section}
\fbox{
\begin{minipage}[c]{\linewidth-2\fboxsep-2\fboxrule}
\textsf{\textbf{\g_edu_bugname{}:}}~
#1
\end{minipage}
}
\vspace{\baselineskip}
\group_end:
\par
}
\DeclareDocumentCommand \BugGit { +m } {
\Bug{\gitIssue{#1}}
}
\DeclareDocumentCommand \Notice { +m } {
\textsf{\textbf{\g_edu_noticename{}:}}~
\itshape
#1
\upshape
}
\DeclareDocumentCommand \Todo { +m } {
\vspace{\baselineskip}
\par\noindent
\group_begin:
\color{lightgray}
\fbox{
\begin{minipage}[c]{\linewidth-2\fboxsep-2\fboxrule}
\textsf{\textbf{\g_edu_todoname{}:}}~
#1
\end{minipage}
}
\vspace{\baselineskip}
\group_end:
\par
}
\DeclareDocumentCommand \Warning { +m } {
\vspace{\baselineskip}
\par\noindent
\fbox{
\begin{minipage}[c]{\linewidth-2\fboxsep-2\fboxrule}
\textsf{\textbf{\g_edu_warningname{}:}}~
#1
\end{minipage}
}
\vspace{\baselineskip}
\par
}
\ExplSyntaxOff
\DeclareDocumentCommand \WarningStylethemeDE { s } {
\IfBooleanTF {#1} {
\Warning{Obige Optionen können durch Styletheme überschrieben werden.}
}{
\Warning{Obige Option kann durch Styletheme überschrieben werden.}
}
}
\DeclareDocumentCommand \WarningColorthemeDE { s } {
\IfBooleanTF {#1} {
\Warning{Obige Optionen können durch Colortheme überschrieben werden.}
}{
\Warning{Obige Option kann durch Colortheme überschrieben werden.}
}
}
% Lists
\setlist{%
partopsep=0ex,
topsep=0.5\baselineskip - \parskip,
itemsep=0.5\baselineskip - \parskip,
parsep=\parskip,
leftmargin=1.5em,
}
\setlist[itemize, 1]{label=\color{itemize}\rule[0.3ex]{0.7ex}{0.7ex}}
\setlist[itemize, 2]{label=\color{itemize}\rule[0.5ex]{0.7ex}{0.4ex}}
\setlist[itemize, 3]{label=\color{itemize}\rule[0.55ex]{0.7ex}{0.2ex}}
% Hide the implementation
\OnlyDescription
% Bibliography entries
\begin{filecontents}{edu.bib}
@online{koma,
author = {Markus Kohm},
title = {koma-script -- A bundle of versatile classes and packages},
year = {2012},
url = {http://www.ctan.org/pkg/koma-script}
}
@online{fonts,
author = {Walter Schmidt},
title = {Using common PostScript fonts with LaTeX},
year = {2004},
url = {http://mirrors.ctan.org/macros/latex/required/psnfss/psnfss2e.pdf}
}
@online{fontcatalogue,
author = {Palle J{\o}rgensen},
title = {The LaTeX Font Catalogue},
year = {2012},
url = {http://www.tug.dk/FontCatalogue}
}
@online{tikz,
author = {Till Tantau},
title = {pgf -- Create PostScript and PDF graphics in \TeX},
year = {2008},
url = {http://www.ctan.org/pkg/pgf}
}
% @article{kpfonts,
% author = {Christophe Caignaert},
% title = {KP-Fonts 3.31},
% year = {2010},
% url = {http://www.tex.ac.uk/tex-archive/fonts/kpfonts/doc/kpfonts.pdf}
% }
% @standard{ISO216,
% title = {ISO 216:2007},
% subtitle = {Writing paper and certain classes of printed matter -- Trimmed sizes -- A and B series, and indication of machine direction},
% author = {{International Organization for Standardization, Technical Committee 6}},
% year = {2007}
% }
% @standard{ISO8601,
% title = {ISO 8601:2004},
% subtitle = {Data elements and interchange formats -- Information interchange -- Representation of dates and times},
% author = {{International Organization for Standardization, Technical Committee 154}},
% year = {2004}
% }
\end{filecontents}
\addbibresource{edu.bib}
% Declare the target files
\SelfPreambleTo{\mypreamble}
\DeclareFile[key=class,preamble=\mypreamble]{edu.cls}
% This is where the documentation begins
\usepackage[scaled=0.8]{beramono}
% Change & version info
\version{0.5 (Build: \pdfdate)}
\changes{0.5}{%
\localeEN{Initial version}%
\localeDE{Initiale Version}%
}
% Metadata
\package[ctan=edu,vcs=https://github.com/wunderlich/edu]{edu}
\localeEN{\title{The \textbf{\thepackage} document class}}%
\localeDE{\title{Die \textbf{\thepackage} Dokumentenklasse}}%
\author{Daniel Wunderlich}
\email{code@wu-web.de}
\begin{document}
% First page
\maketitle
\begin{abstract}
\localeEN{This documentclass provides the easy typesetting of documents for educational use, like worksheets, exams, summaries, lecture notes or scheduling lessons. It loads many useful packages and allows the easy setup of documents (e.\,g. font/-size, margins, header and footer with metadata). It also defines a lot of macros for creating exercises, solutions, questions and for scheduling lessons. At the moment it focuses on mathematics and german schools.
\color{red} \textbf{Warning:} The \thepackage\ document class is currently under development. All functionality, settings and macros as well as file names can change in later versions and may be incomplete! It is experimental and not ready for production use.}
\localeDE{Diese Dokumentenklasse dient dem Satz von Dokumenten im Kontext der Bildung wie Arbeitsblättern, Klassenarbeiten/Klausuren, Zusammenfassungen, Skripten oder zur Unterrichtsplanung. Sie lädt viele gebräuchliche Packages, erlaubt eine erleichterte Einrichtung der Dokumente (z.\,B. Schriftarten, Seitenränder, Kopf- und Fußzeilen mit Metadaten). Außerdem stellt sie diverse Makros zur Verfügung, u.\,A. zur Erstellung von Aufgaben, Lösungen, Fragen oder der Unterrichtsplanung. Zur Zeit liegt der Schwerpunkt auf Mathematik und deutschen Gegebenheiten.
\medskip
\color{red} \textbf{Warnung:} Die \thepackage\ Dokumentenklasse befindet sich in der Entwicklung. Alle
Funktionen, Einstellungen und Makros sowie Dateinamen können sich in späteren
Versionen ändern oder können unvollständig sein. Sie ist noch nicht für den
produktiven Einsatz bereit.
}
\end{abstract}
\tableofcontents
\newpage
\localeDE{\part{Einleitung}}
\localeDE{\section{Über \thepackage}}
\localeDE{
Das komfortable Erstellen von Arbeitsblättern, Klassenarbeiten/Klausuren oder ähnlichen Dokumentenmit \LaTeX\ Standard-Dokumentenklassen erweist sich für Lehrende je nach Anspruch als umständliches Unterfangen. Diese Dokumentenklasse stellt eine Vielzahl von Makros zur Verfügung, die das effiziente Erstellen solcher Dokumente ermöglicht. Sie erlaubt außerdem das Ändern vieler gängiger \LaTeX{}-Optionen, die in diesem Kontext relevant sind.
Hierzu erweitert \thepackage\ die herausragende Dokumentenklasse \pkg{scrartcl} des \emph{KOMA-Scripts} von \textsc{Michael Kohm} \footcite{koma} um die gewünschte Funktionalität und passt entsprechende Parameter (nach Meinung des Autors) sinnvoll an. Außerdem werden in diesem Kontext häufig verwendete Packages geladen und konfiguriert.
% Abschnitt~\ref{verwendung} dieser Dokumentation stellt neben den neuen Befehlen der \textsf{edu}-Klasse auch viele der geladenen und dem Benutzer eventuell unbekannte Packages vor, welche für Lehrende von Interesse sein könnten und erläutert deren grundlegende Verwendung. Die Funktionen dieser Packages werden in den meisten Fällen jedoch nur angeschnitten -- bei Interesse empfiehlt sich ein Blick in die jeweiligen Dokumentationen. Auch grundlegende Aspekte von \LaTeX\ und Typographie im Allgemeinen werden an wenigen Stellen thematisiert. Ein Beispieldokument, welches die Funktionalität der Dokumentenklasse in deutscher Sprache demonstriert, stellt |edu-demo-de.sty| mit dem zugehörigen PDF |edu-demo-de.pdf| dar.
%
% Die Implementierung des Packages in Abschnitt~\ref{implementierung} enthällt den Code der Klasse und ist im Allgemeinen nur für Autoren von Klassen oder Packages interessant. Benutzer können diesen Abschnitt im Normalfall vernachlässigen.
}
\localeDE{
\section{Über diese Dokumentation}
Diese Dokumentation verwendet verschiedene Schriftarten und -stile zur Auszeichnung unterschiedlicher Komponenten. Tabelle~\ref{tab:components} zeigt diese Arten der Auszeichnungen.
\begin{table}[h!tp]
\centering
\caption{Auszeichnung durch Schriftarten und -stile dieser Dokumentation.}
\label{tab:components}
\medskip
\begin{tabular}{ll} \toprule
\textsf{Schrift} & \textsf{Beschreibung} \\ \midrule
\pkg*{package} & Package \\
\opt*{option} & Option \\
\cs*{macro} & Makro\footnotemark \\
\env*{umgebung} & Umgebung \\
\meta{argument} & Argument (allgemein) \\
\marg{argument} & Notwendiges Argument \\
\oarg{argument} & Optionales Argument \\
\bottomrule
\end{tabular}
\end{table}
\footnotetext{{Es wird versucht, in dieser Dokumentation ausschließlich den Begriff \emph{Makro} zu verwenden. Die Begriffe \emph{Befehl}, \emph{Funktion} und \emph{Kommando} sind -- sollten sie wider Erwarten doch verwendet werden -- als Synonyme zu verstehen.}}
An einem Beispiel sei an dieser Stelle kurz der Unterschied zwischen notwendigen und optionalen Argumenten erläutert: Wir betrachten das Makro \Macro\fpbox[<Breite>=\cs*{linewidth}]{<Inhalt>} erzeugt einen umrahmten Absatz. Das Argument \meta{Inhalt} ist \emph{notwendig} und \emph{muss} angegeben werden. (Was wäre ein Absatz ohne Inhalt?). Der Aufruf \Macro\fpbox{Dies ist ein umrahmter Absatz.} erzeugt einen umrahmten Absatz, der sich über die gesamte Breite der aktuellen Zeile erstreckt:
\medskip
\fpbox{Dies ist ein umrahmter Absatz.}
\medskip
\noindent Das Argument \meta{Breite} ist \emph{optional}, es \emph{kann} angegeben werden. Im obigen Beispiel war dies nicht der Fall. Das Makro greift dann ggf. auf einen Standardwert, in diesem Fall \cs*{linewidth} (Breite der aktuellen Zeile), zurück. Der Aufruf \Macro\fpbox[3cm]{Dies ist ein umrahmter Absatz.} hingegen erzeugt einen umrahmten Absatz der Breite 5\,cm:
\medskip
\fpbox[3cm]{Dies ist ein umrahmter Absatz.}
}
\newpage
\localeDE{\part{Installation}}
\localeDE{\section{Voraussetzungen}}
\localeDE{
Die \thepackage-Klasse benötigt neben Standard-\LaTeX-Packages die Dokumentenklasse \pkg{scrartcl} des \emph{KOMA-Scripts} \footcite{koma} und die folgenden Packages:
\begin{multicols}{5}\raggedcolumns
{\sffamily
\noindent beramono*\\
bibgerm\\
booktabs\\
calc\\
ccicons\\
datetime\\
enumitem\\
etoolbox\\
eurosym\\
expdlist\\
expl3\\
fontawesome\\
geometry\\
graphicx\\
hanging\\
hyperref\\
l3keys2e\\
lastpage\\
lato*\\
listings\\
menukeys\\
multicol\\
multirow\\
pdflscape\\
roboto*\\
rotating\\
ragged2e\\
scrpage2\\
setspace\\
siunitx\\
sourcecodepro*\\
sourcesanspro*\\
struktex\\
subfig\\
tabularx\\
textcomp\\
tikz\\
tikzsymbols\\
tikz-qtree\\
titlesec\\
ulem\\
verse*\\
xcolor\\
xparse\\
xsim\\
xspace}
\end{multicols}
\noindent\textsf{* optional}
\bigskip
Werden weitere \thepackage\ Packages geladen, gelten entsprechend deren Voraussetzungen.
Alle Packages sind über \emph{CTAN} erhältlich -- sie können unter Linux über \emph{TeX Live}, unter Windows über \emph{MiKTeX} und unter MacOSX über \emph{MacTeX} bezogen werden.
}
%\section{Installation}
%
%Die manuelle Installation von Packages bzw. Dokumentenklassen wird an vielen Stellen im Internet erläutert. Deshalb wird sie hier nur sehr kompakt beschrieben. Bei Problemen bieten diverse Websiten Hilfestellung.
%
%\subsection{Linux (Ubuntu 12.04/Linux Mint 13)}
%
%\begin{enumerate}
% \item Per Kommandozeile in den Ordner navigieren, indem sich die heruntergeladene Datei \verb+edu.cls+ befindet.
% \item Einen Ordner für die Dokumentenklasse im \TeX-Verzeichnisbaum erstellen:
% \begin{verbatim}
%sudo mkdir /usr/share/texmf/tex/latex/edu
% \end{verbatim}\vspace{-\baselineskip}
% \item Nun wird die Datei \verb+edu.cls+ in den neuen Ordner kopiert:
% \begin{verbatim}
%sudo cp edu.cls /usr/share/texmf/tex/latex/edu/
% \end{verbatim}\vspace{-\baselineskip}
% \item Abschließend muss der \TeX-Verzeichnisbaum neu aufgebaut werden:
% \begin{verbatim}
%sudo mktexlsr
% \end{verbatim}\vspace{-\baselineskip}
%\end{enumerate}
%
%
%\subsection{Windows\,7}
%
%\begin{enumerate}
% \item Bei einer Standardinstalltion von MiKTeX~2.9 unter Windows\,7 zuerst den Ordner
% \begin{verbatim}
%C:\Program Files (x86)\MiKTeX 2.9\tex\latex\edu
% \end{verbatim}
% \vspace{-\baselineskip}
% erstellen.
% \item Dann die Datei \verb+edu.cls+ in diesen Ordner verschieben.
% \item Das Programm \verb+Settings+ von MiKTeX öffnen:
% \begin{center}
% \itshape Startmenü $\rightarrow$ Alle Programme $\rightarrow$ MiKTeX 2.9 $\rightarrow$ Maintenance $\rightarrow$ Settings
% \end{center}
% \item Über die Schaltfläche \emph{Refresh~FNDB} wird die neue Datei eingelesen.
% \end{enumerate}
\newpage
\localeDE{\part{Allgemeines zum Textsatz in der Schule}}
\localeDE{\section{Kopf- und Fußzeilen}\label{sec:allg:kopfzeile}}
\localeDE{\section{Absatzauszeichnung}}
\localeDE{
Es gibt zwei gängige Möglichkeiten, Absätze auszuzeichnen (d.\,h. kenntlich zu machen). Zum einen kann vor einem Absatz ein Abstand eingefügt werden. Diese Methode hat jedoch den gravierenden Nachteil, dass Absatzumbrüche an Seitenenden, Gleitobjekten (z.\,B. durch \env*{figure}- oder \env*{table}- Umgebungen) und abgesetzten Formeln nicht zu erkennen sind. Auch die Tatsache, dass in der letzten Zeile eines Absatzes kein Blocksatz erzwungen wird und sie somit "`linksbündig"' erscheint, beseitigt diesen Nachteil nicht zufriedenstellend: Da je nach Beschaffung eines Absatzes auch die letzte Zeile als Blocksatz erkannt werden kann (wenn sie "`komplett gefüllt"' ist), genügt dieses Kriterium im Allgemeinen nicht. Außerdem ist zu Beginn einer neuen Seite die letzte Zeile des letzten Absatzes nicht zu erkennen und erfordert ggf. ein Umblättern.
Deshalb ist die zweite Methode \emph{grundsätzlich} vorzuziehen: In jedem Absatz wird die erste Zeile eingerückt. Hierdurch werden alle Nachteile beseitigt und man erkennt beim Lesen unmittelbar den Beginn eines neuen Absatzes. In vielen gedruckten Büchern wird diese Art der Absatzauszeichnung deshalb verwendet.
\emph{Im Kontext der Schule}, insbesondere bei Dokumenten wie Arbeitsblättern und Klausuren im naturwissenschaftlichen Bereich, werden jedoch überwiegend sehr kurze "`Absätze"' verwendet. Häufige Absatzeinrückungen sind die Folge. Diese stören das Gesamtbild des Dokuments in diesem Fall jedoch stark. Aus diesem Grund wird in \thepackage\ standardmäßig Absatzabstand zur Auszeichnung von Absätzen verwendet. Es sei jedoch noch einmal darauf hingewiesen, dass dies eine Ausnahme darstellt, welche der Beschaffenheit von Dokumenten in der Schule geschuldet ist.
}
\newpage
\input{edu-tut.tex}
\newpage
\localeDE{
\part{Dokumentation}
\label{sec:doc}
}
\localeDE{\subsection{Allgemeines}}
\localeDE{\subsubsection{Farben}}
\localeDE{
\subsection{Optionen}
Die Optionen von \thepackage\ werden thematisch gruppiert beschrieben. Der Standardwert ist rechtsbündig in Klammern angegeben.
}
\localeDE{\subsubsection{Medienarten}\label{sec:doc:medienarten}}
\localeDE{
\thepackage\ verfügt über Modi für spezielle Medienarten. Diese Modi führen zu einer Anpassung insbesondere der Schriftgröße und der Seitenränder. In manchen fällen kann außerdem die Schriftfamilie geändert werden.
\Warning{Diese Optionen werden mit hoher Priorität verarbeitet. D.\,h. andere Optionen (z.\,B. \opt{fontsize}) werden gegebenenfalls überschrieben und habe keine Wirkung mehr.}
}
\localeDE{
\Option{twoup}\WithValues{true, false}\AndDefault{false}
Diese Option dient zum Ausdruck einer DIN-A4-Seite, die nach oder vor dem Druck auf DIN-A5 herunter skaliert wird. Dies dient insbesondere dem Druck von zwei DIN-A5-Seiten auf ein DIN-A4-Blatt. Hierzu wird die Schrift vergrößert und die Seitenränder angepasst.
Im Folgenden wird dieser Zustand als \opt*{twoup}-Modus bezeichnet.
}
\localeDE{
\Option{transparency}\WithValues{true, false}\AndDefault{false}
Möchte man Folien für Overhead-Projektoren erstellen, sollten einige Eigenschaften des Dokuments angepasst werden: Die Schrift muss (drastisch) vergrößert werden, Seitenränder können hingegen minimiert werden. Außerdem sollte serifenlose Schrift als Standardschrift verwendet werden, da sie die Lesbarkeit auf größerer Entfernung verbessert. Silbentrennung wird überdies deaktiviert. Diese Anpassungen werden durch die Option \opt*{transparency} vorgenommen.
Im Folgenden wird dieser Zustand als \opt*{transparency}-Modus bezeichnet.
}
\localeDE{
\Option{glue}\WithValues{true, false}\AndDefault{false}
In niedrigeren Klassenstufen werden Ausdrucke häufig in ein Heft geklebt. Um dies zu vereinfachen, kann man das Blatt rechts und unten etwas beschneiden. Die Option \opt*{glue} passt die Seitenränder so an, dass der untere und rechte Seitenrand 5\,mm größer als der obere und linke Seitenrand sind. Nach dem Beschneiden besitzt der Inhalt ungefähr den gleichen Abstand zu allen Rändern des Blattes.
Im Folgenden wird dieser Zustand als \opt*{glue}-Modus bezeichnet.
}
\localeDE{\subsubsection{Schriftarten}}
\localeDE{
\Option{sfdefault}\WithValues{true, false}\AndDefault{false}
Mit dieser Option kann als Standardschriftart serifenlose Schrift gewählt werden.
}
%\medskip
%
%\localeDE{
%\Option{beramono}\WithValues{true, false}\AndDefault{true}
%Mit dieser Option wird \emph{Bera Mono} mithilfe des Packages \pkg*{bera} als Standardschriftart für nichtproportionale Schrift gewählt.
%}
%
%\medskip
%
%\localeDE{
%\Option{lato}\WithValues{true, false}\AndDefault{false}
%Mit dieser Option wird \emph{Lato} mithilfe des Packages \pkg*{lato} als Standardschriftart für serifenlose Schrift gewählt.
%}
%
%\medskip
%
%\localeDE{
%\Option{palatino}\WithValues{true, false}\AndDefault{true}
%Mit dieser Option wird \emph{Palatino} mithilfe des Packages \pkg*{mathpazo} als Standardschriftart für serifenlose Schrift gewählt. Dies umfasst auch die Mathemik-Schriftarten.
%}
%
%\medskip
%
%\localeDE{
%\Option{sourcecodepro}\WithValues{true, false}\AndDefault{false}
%Mit dieser Option wird \emph{Source Code Pro} mithilfe des Packages \pkg*{sourcecodepro} als Standardschriftart für serifenlose Schrift gewählt.
%}
%
%\medskip
%
%\localeDE{
%\Option{sourcesanspro}\WithValues{true, false}\AndDefault{true}
%Mit dieser Option wird \emph{Source Sans Pro} mithilfe des Packages \pkg*{sourcesanspro} als Standardschriftart für serifenlose Schrift gewählt.
%}
\localeDE{\subsubsection{Schriftgrößen}}
\localeDE{
\Option{fontsize}\WithValues{\meta{Schriftgröße}}\AndDefault{11pt}
Gibt die Schriftgröße des Fließtextes im Dokument an.
}
\medskip
\localeDE{
\Option{twoupfontsize}\WithValues{\meta{Schriftgröße}}\AndDefault{14}
Gibt die Schriftgröße des Fließtextes im Dokument an, falls der \opt{twoup}-Modus gewählt wurde.
}
\medskip
\localeDE{
\Option{transparencyfontsize}\WithValues{\meta{Schriftgröße}}\AndDefault{20pt}
Gibt die Schriftgröße des Fließtextes im Dokument an, falls der \opt{transparency}-Modus gewählt wurde.
}
\localeDE{\subsubsection{Absatzauszeichnung}}
\localeDE{
\Option{parindent}\WithValues{true, false}\AndDefault{false}
Absatzeinzug kann (de-)aktiviert werden.
}
\medskip
\localeDE{
\Option{parskip}\WithValues{true, false}\AndDefault{true}
Absatzabstand kann (de-)aktiviert werden.
}
\localeDE{\subsubsection{Seitenränder}}
\localeDE{
\Option{top}\WithValues{\meta{Oberer Seitenrand}}\AndDefault{15mm}
\Option{right}\WithValues{\meta{Rechter Seitenrand}}\AndDefault{15mm}
\Option{bottom}\WithValues{\meta{Unterer Seitenrand}}\AndDefault{15mm}
\Option{left}\WithValues{\meta{Linker Seitenrand}}\AndDefault{22.5mm}
Diese Optionen dienen der Anpassung der Seitenränder. Sie beziehen sich auf den gesamten Inhalt der Seite, inklusive Kopf- und Fußzeile.
}
\medskip
\localeDE{
\Option{twouptop}\WithValues{\meta{Oberer Seitenrand}}\AndDefault{20mm}
\Option{twoupright}\WithValues{\meta{Rechter Seitenrand}}\AndDefault{20mm}
\Option{twoupbottom}\WithValues{\meta{Unterer Seitenrand}}\AndDefault{20mm}
\Option{twoupleft}\WithValues{\meta{Linker Seitenrand}}\AndDefault{25mm}
Diese Optionen dienen der Anpassung der Seitenränder im \opt{twoup}-Modus. Sie beziehen sich auf den gesamten Inhalt der Seite, inklusive Kopf- und Fußzeile.
}
\medskip
\localeDE{
\Option{transparencytop}\WithValues{\meta{Oberer Seitenrand}}\AndDefault{10mm}
\Option{transparencyright}\WithValues{\meta{Rechter Seitenrand}}\AndDefault{10mm}
\Option{transparencybottom}\WithValues{\meta{Unterer Seitenrand}}\AndDefault{10mm}
\Option{transparencyleft}\WithValues{\meta{Linker Seitenrand}}\AndDefault{22.5mm}
Diese Optionen dienen der Anpassung der Seitenränder im \opt{transparency}-Modus. Sie beziehen sich auf den gesamten Inhalt der Seite, inklusive Kopf- und Fußzeile.
}
\medskip
\localeDE{
\Option{gluetop}\WithValues{\meta{Oberer Seitenrand}}\AndDefault{10mm}
\Option{glueright}\WithValues{\meta{Rechter Seitenrand}}\AndDefault{15mm}
\Option{gluebottom}\WithValues{\meta{Unterer Seitenrand}}\AndDefault{15mm}
\Option{glueleft}\WithValues{\meta{Linker Seitenrand}}\AndDefault{10mm}
Diese Optionen dienen der Anpassung der Seitenränder im \opt{glue}-Modus. Sie beziehen sich auf den gesamten Inhalt der Seite, inklusive Kopf- und Fußzeile.
}
\localeDE{\subsubsection{Teile (Parts)}}
\localeDE{
\Option{parts}\WithValues{true, false}\AndDefault{false}
Werden im Dokument Teile als Gliederungsebene verwendet (\cs*{part}), sollte diese Option gewählt werden. Es wird dann die Schriftgröße anderer Textelemente angemessen vergrößert.
}
\localeDE{\subsubsection{Listen}}
\localeDE{
\Option{listarraysep}\WithValues{\meta{Länge}}\AndDefault{0.5em}
Bestimmt in Aufgaben den Abstand zwischen Aufgabennummerierung und dem folgenden Text (s.\,Abb.\,\ref{fig:lists}).
\begin{figure}[h!tp]
\centering
\localeDE{\caption{\opt*{listarraymargin} und \opt*{listarraysep}.}}
\label{fig:lists}
\medskip
\setlength{\fboxsep}{0cm}
\noindent \tikz{\draw (0,0cm) -- (0, 1.3cm) node[right, yshift=-5pt]{\localeDE{Textrand}}; \draw[<->] (0,2.5pt) -- node[above]{\opt*{listarraymargin}} +(3cm,0);}\fbox{\textsf{m)}}\tikz{\draw (0,0); \draw[<->] (0,2.5pt) -- node[above]{\opt*{listarraysep}} +(2.5cm,0);}\fbox{Lorem ipsum \dots}
\end{figure}
}
\localeDE{
\Option{listarraymargin}\WithValues{\meta{Länge}}\AndDefault{0.5em}
Bestimmt in Aufgaben den Abstand zwischen Textrand und Aufgabennummerierung (s.\,Abb.\,\ref{fig:lists}).
\Warning{Um ein einheitliches Bild zu gewährleisten, wirken sich die Optionen \opt*{listarraysep} und \opt*{listarraymargin} analog auch auf \env*{itemize} und \env*{enumerate} aus.}
}
\localeDE{\subsubsection{Metadaten}}
\localeDE{
\Option{authorstyle}\WithValues{\meta{Format}}\AndDefault{\cs*{large}\cs*{sffamily}\cs*{scshape}}
\Option{classstyle}\WithValues{\meta{Format}}\AndDefault{\cs*{large}\cs*{sffamily}}
\Option{datestyle}\WithValues{\meta{Format}}\AndDefault{\cs*{small}\cs*{sffamily}}
\Option{emailstyle}\WithValues{\meta{Format}}\AndDefault{\cs*{footnotesize}\cs*{sffamily}}
\Option{fieldstyle}\WithValues{\meta{Format}}\AndDefault{\cs*{large}\cs*{sffamily}}
\Option{groupstyle}\WithValues{\meta{Format}}\AndDefault{\cs*{Large}\cs*{sffamily}\cs*{bfseries}}
\Option{licensestyle}\WithValues{\meta{Format}}\AndDefault{\cs*{small}\cs*{sffamily}}
\Option{shortstyle}\WithValues{\meta{Format}}\AndDefault{\cs*{Large\cs*{sffamily}\cs*{bfseries}}}
\Option{subjectstyle}\WithValues{\meta{Format}}\AndDefault{\cs*{large}\cs*{sffamily}}
\Option{subtitlestyle}\WithValues{\meta{Format}}\AndDefault{\cs*{Large}\cs*{sffamily}\cs*{bfseries}}
\Option{timestamp}\WithValues{\meta{Boolean}}\AndDefault{\cs*{false}\cs*{sffamily}\cs*{bfseries}}
\Option{titlestyle}\WithValues{\meta{Format}}\AndDefault{\cs*{LARGE}\cs*{sffamily}\cs*{bfseries}}
\Option{versionstyle}\WithValues{\meta{Format}}\AndDefault{\cs*{small}\cs*{sffamily}}
Mit diesen Optionen kann das Erscheinungsbild des Titels angepasst werden.
\WarningStylethemeDE
}
\localeDE{\subsubsection{Titel}}
\localeDE{
\Option{titleskip}\WithValues{\meta{Abstand}}\AndDefault{1.75cm}
Definiert den Abstand zwischen dem gesamten Titel und dem folgenden Inhalt des Dokuments. Dies betrifft jedoch nur den ausführlichen Titel, erzeugt durch \cs{maketitle}, nicht den kurzen Titel (\cs{maketitle*}).
}
\medskip
\localeDE{
\Option{titlefg}\WithValues{\meta{Farbe}}\AndDefault{black}
\Option{titlebg}\WithValues{\meta{Farbe}}\AndDefault{white}
Bestimmen die Vorder- und Hintergrundfarbe des Titels.
}
\medskip
\localeDE{
\Option{groupfg}\WithValues{\meta{Farbe}}\AndDefault{white}
\Option{groupbg}\WithValues{\meta{Farbe}}\AndDefault{black}
\Option{shortfg}\WithValues{\meta{Farbe}}\AndDefault{white}
\Option{shortbg}\WithValues{\meta{Farbe}}\AndDefault{black}
Bestimmen die Vorder- und Hintergrundfarbe der Gruppe.
\WarningColorthemeDE*
}
\localeDE{\subsubsection{Kopf- und Fußzeile}}
\localeDE{
\Option{headerrulewidth}\WithValues{\meta{Breite}}\AndDefault{0.5pt}
Bestimmt die Breite der Trennlinie der Kopfzeile an.
}
\medskip
\localeDE{
\Option{footer}\WithValues{true, false}\AndDefault{true}
Schaltet die Fußzeile ein oder aus.
}
\medskip
\localeDE{
\Option{pagecount}\WithValues{true, false}\AndDefault{true}
Bestimmt, ob die Gesamtzahl der Seiten des Dokuments in der Fußzeile angezeigt werden soll.
}
\medskip
\localeDE{
\Option{footskip}\WithValues{\meta{Abstand}}\AndDefault{1cm}
\Option{twoupfootskip}\WithValues{\meta{Abstand}}\AndDefault{0.75cm}
Bestimmt, den Abstand zwischen der Grundlinie der Fußzeile und der Grundlinie der letzten Zeile des Seiteninhalts. \opt*{twoupfootskip} bezieht sich hierbei auf den \opt{twoup}-Modus.
}
\localeDE{\subsubsection{Inhaltsverzeichnis}}
\localeDE{
\Option{exetoc}\WithValues{true, false}\AndDefault{false}
Mit dieser Option kann bestimmt werden, ob Aufgaben, Unteraufgaben, Lösungen und Unterlösungen im Inhaltsverzeichnis aufgeführt werden.
}
\localeDE{\subsubsection{Aufzählungen, Nummerierungen und Beschreibungen}}
\localeDE{
\Option{itemizefg}\WithValues{\meta{Farbe}}\AndDefault{black}
\Option{enumeratefg}\WithValues{\meta{Farbe}}\AndDefault{black}
\Option{descriptionfg}\WithValues{\meta{Farbe}}\AndDefault{black}
Diese Optionen bestimmen die Farbe der Beschriftung von Aufzählungen, Nummerierungen und Beschreibungen.
\WarningColorthemeDE*
}
\localeDE{\subsubsection{Überschriften}}
\localeDE{Zum einen können die Schriftgrößen der Überschriften angegeben werden:}
\localeDE{
\Option{partnumbersize}\WithValues{\meta{Größe}}\AndDefault{\cs*{Large}}
\Option{sectionnumbersize}\WithValues{\meta{Größe}}\AndDefault{\cs*{normalsize}}
\Option{subsectionnumbersize}\WithValues{\meta{Größe}}\AndDefault{\cs*{footnotesize}}
Diese Optionen bestimmen die Schriftgrößen von Überschriften (\cs*{part}, \cs*{section} und \cs*{subsection}).
}
\localeDE{Zum anderen können die Farben der Überschriften angegeben werden:}
\localeDE{
\Option{partnumberfg}\WithValues{\meta{Farbe}}\AndDefault{white}
\Option{partnumberbg}\WithValues{\meta{Farbe}}\AndDefault{black}
\Option{sectionnumberfg}\WithValues{\meta{Farbe}}\AndDefault{white}
\Option{sectionnumberbg}\WithValues{\meta{Farbe}}\AndDefault{black}