summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/worksheet/worksheet.sty
blob: aa9e7929b7cad95a73c2c71a8eeff6699510e2f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
%------------------------------------------------------------------------------------------------------------%
% Package worksheet by Benjamin Zöllner (c)2018                                                              %
%                                                                                                            %
% This work may be distributed and/or modified under the                                                     %
% conditions of the LaTeX Project Public License (latest version).                                           %
%------------------------------------------------------------------------------------------------------------%

\NeedsTeXFormat{LaTeX2e}[2018]
\ProvidesPackage{worksheet}[2018/08/08 by Benjamin Zoellner (c)2018 v1.1 This Package provides macros and an environment for easy worksheet creation]

\PassOptionsToPackage{headsepline=1pt}{scrlayer-scrpage}
\RequirePackage{scrlayer-scrpage}

% BEWARE!
% DO NOT CHANGE THE FORMATTING OF FOLLOWING CODE! DO NOT DELETE EMPTY COMMENTS!

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Extraxt Number From \jobname

% Bools for Number Detection
\newcounter{@worksheet@numberFound}
\newcounter{@worksheet@numberEnded}

% evil String Search Hacking using Latex-Kernel Macros \in@ & \ifin@
\def\@worksheet@isInString#1#2{TT\fi\begingroup % What the f**k?!
\edef\x{\endgroup\noexpand\in@{#1}{#2}}\x\ifin@}

% Character-wise expanding Macro Loop for extracting containing Numbers leaving leading Zeroes
% if a single Character #1 is a natural Number less than 10, a containing Number is found
%     @worksheet@numberFound will be set
%     #1 will be displayed
% every following natural Number less than 10 including 0 will be displayed until #1 is a Character other than
% a natural Number less than 10 or 0
%     @worksheet@numberEnded will be set when #1 is not a number
\def\@worksheet@loopElementsExtractNumber#1{%
	\ifx\relax#1\else
		\ifnum\value{@worksheet@numberEnded}=0
			\ifnum\value{@worksheet@numberFound}=0
				\if\@worksheet@isInString{#1}{123456789}#1\setcounter{@worksheet@numberFound}{1}\fi
			\else
				\if\@worksheet@isInString{#1}{0123456789}#1\else\setcounter{@worksheet@numberEnded}{1}\fi
			\fi
		\fi
	\expandafter\@worksheet@loopElementsExtractNumber%
	\fi
}

% expand Loop and extract a containing Number
\def\@worksheet@expandNumberExtractingLoop#1{\setcounter{@worksheet@numberFound}{0}\setcounter{@worksheet@numberEnded}{0}\@worksheet@loopElementsExtractNumber#1\relax}

% expand \jobname
\edef\@worksheet@expandjobname{\jobname}

% accurate Loop Command Expansion
\def\@worksheet@numberInFileName{\expandafter\@worksheet@expandNumberExtractingLoop\expandafter{\@worksheet@expandjobname}}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Language Selection

% Babel conforming Macros
\def\@worksheet@selectLanguage@english{
	\xdef\@worksheet@languageSelection@exercise{Exercise}
	\xdef\@worksheet@languageSelection@score{Maximum Score}
	\xdef\@worksheet@languageSelection@learningTargets{Learning Targets}
	\xdef\@worksheet@languageSelection@difficulty{Difficulty Level}
	\xdef\@worksheet@languageSelection@easy{easy}
	\xdef\@worksheet@languageSelection@medium{medium}
	\xdef\@worksheet@languageSelection@hard{hard}
}
\def\@worksheet@selectLanguage@french{
	\xdef\@worksheet@languageSelection@exercise{Exercice}
	\xdef\@worksheet@languageSelection@score{Points}
	\xdef\@worksheet@languageSelection@learningTargets{Buts}
	\xdef\@worksheet@languageSelection@difficulty{Difficulté}
	\xdef\@worksheet@languageSelection@easy{facile}
	\xdef\@worksheet@languageSelection@medium{moyen}
	\xdef\@worksheet@languageSelection@hard{difficile}
}
\def\@worksheet@selectLanguage@german{
	\xdef\@worksheet@languageSelection@exercise{Aufgabe}
	\xdef\@worksheet@languageSelection@score{Punkte}
	\xdef\@worksheet@languageSelection@learningTargets{Lernziele}
	\xdef\@worksheet@languageSelection@difficulty{Schwierigkeitsgrad}
	\xdef\@worksheet@languageSelection@easy{leicht}
	\xdef\@worksheet@languageSelection@medium{mittel}
	\xdef\@worksheet@languageSelection@hard{schwer}
}
\def\@worksheet@selectLanguage@ngerman{\@worksheet@selectLanguage@german}

% call Babel conforming Macro if defined
\def\@worksheet@checkLanguage{
	\expandafter\ifdefined\csname @worksheet@selectLanguage@\languagename\endcsname
		\csname @worksheet@selectLanguage@\languagename\endcsname
	\fi
}

% Macros to call at \begin{document}
\def\@worksheet@languageSelection@beginDocument{
	\let\@worksheet@originalselectlanguage\selectlanguage
	\def\selectlanguage##1{\@worksheet@originalselectlanguage{##1}\@worksheet@checkLanguage}

	\@worksheet@checkLanguage
}

% select default Language
\@worksheet@selectLanguage@english


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Title of worksheet

% worksheet internal Title & Subtitle
\def\@worksheet@title{}
\def\@worksheet@subTitle{}

% set worksheet internal Title & Subtitle by redifining
\def\worksheetTitle#1{\edef\@worksheet@title{#1}}
\def\worksheetSubTitle#1{\edef\@worksheet@subTitle{#1}}

% general Title Command
\def\worksheetMakeTitle{
	\ifx\relax\@worksheet@title\relax\else%
		\begin{center}
			\textbf{\sffamily\huge\@worksheet@title~\@worksheet@numberInFileName\nopagebreak}%
			\ifx\relax\@worksheet@subTitle\relax\else%
				\nopagebreak\par\addvspace{\topsep}{\sffamily\LARGE\@worksheet@subTitle}
			\fi
		\end{center}
		\nopagebreak\par\addvspace{\topsep}
	\fi	
}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Directory File Name Extraction for temporary defining \@worksheet@currentFileName

% seperate Name and Extension and leave Extension out
\def\@worksheet@omitFileExtension#1.#2\@nil{#1}

% loop through Directory Elements and seperate Extension from last Element
\def\@worksheet@loopDirectoryElementsExtractName#1/#2/#3\@nil{\ifx\relax#2\relax\expandafter\@worksheet@omitFileExtension#1.\@nil\else\expandafter\@worksheet@loopDirectoryElementsExtractName#2/#3/\@nil\fi}

% accurate Loop Command Expansion
\def\@worksheet@ExtractFileName#1{\expandafter\@worksheet@loopDirectoryElementsExtractName#1//\@nil}

% define empty current File Name
\def\@worksheet@currentFileName{}

% redefining \@iinput using original \@iinput
\let\@worksheet@original@iinput\@iinput
\def\@iinput#1{\edef\@worksheet@currentFileName{\@worksheet@ExtractFileName{#1}}\@worksheet@original@iinput{#1}\def\@worksheet@currentFileName{}}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Environment Exercise

% Counter for Number of Exercises
\newcounter{@worksheet@numberOfExercises}

% Control Flags
\newcounter{@worksheet@showFileNameFlag}
\newcounter{@worksheet@showScoreFlag}
\newcounter{@worksheet@showLearningTargetsFlag}
\newcounter{@worksheet@showDifficultyFlag}
\newcounter{@worksheet@showOccurrenceFlag}

% Commands: set and unset Flags
\def\worksheetShowFileName{\setcounter{@worksheet@showFileNameFlag}{1}}
\def\worksheetHideFileName{\setcounter{@worksheet@showFileNameFlag}{0}}
\def\worksheetShowScore{\setcounter{@worksheet@showScoreFlag}{1}}
\def\worksheetHideScore{\setcounter{@worksheet@showScoreFlag}{0}}
\def\worksheetShowLearningTargets{\setcounter{@worksheet@showLearningTargetsFlag}{1}}
\def\worksheetHideLearningTargets{\setcounter{@worksheet@showLearningTargetsFlag}{0}}
\def\worksheetShowDifficulty{\setcounter{@worksheet@showDifficultyFlag}{1}}
\def\worksheetHideDifficulty{\setcounter{@worksheet@showDifficultyFlag}{0}}
\def\worksheetShowOccurrence{\setcounter{@worksheet@showOccurrenceFlag}{1}}
\def\worksheetHideOccurrence{\setcounter{@worksheet@showOccurrenceFlag}{0}}

% Commands: set local Attributes of Exercise
\def\score#1{%
	\ignorespaces%
	\ifdefined\@worksheet@localExerciseGroup%
		\if\relax#1\relax\else%
			\edef\@worksheet@localScore{#1}%
		\fi%
	\fi%
	\ignorespaces%
}
\def\learningtargets#1{%
	\ignorespaces%
	\ifdefined\@worksheet@localExerciseGroup%
		\if\relax#1\relax\else%
			\edef\@worksheet@localLearningTargets{#1}%
		\fi%
	\fi%
	\ignorespaces%
}
\def\easy{%
	\ignorespaces%
	\ifdefined\@worksheet@localExerciseGroup%
		\edef\@worksheet@localDifficulty{\@worksheet@languageSelection@easy}%
	\fi%
	\ignorespaces%
}
\def\medium{%
	\ignorespaces%
	\ifdefined\@worksheet@localExerciseGroup%
		\edef\@worksheet@localDifficulty{\@worksheet@languageSelection@medium}%
	\fi%
	\ignorespaces%
}
\def\hard{%
	\ignorespaces%
	\ifdefined\@worksheet@localExerciseGroup%
		\edef\@worksheet@localDifficulty{\@worksheet@languageSelection@hard}%
	\fi%
	\ignorespaces%
}

% Commands: set global self emptying Attributes of Exercise
\def\@worksheet@occurence{}
\def\occurrence#1{%
	\ignorespaces%
	\ifdefined\@worksheet@localExerciseGroup%
		\if\relax#1\relax\else%
			\xdef\@worksheet@occurence{#1}%
		\fi%
	\fi%
	\ignorespaces%
}

% Exercise
\newenvironment{exercise}[1][]{

	% increase @worksheet@numberOfExercises
	\stepcounter{@worksheet@numberOfExercises}

	\begingroup\def\@worksheet@localExerciseGroup{}
	\sffamily
	% prevent other Text Sizes than normal, new Paragraph, make chaptersized vertical Space
	\normalsize\par\addvspace{\topsep}%

	% make Aufgabe Title preventing Indents and ignoring Spaces
	\noindent\ignorespaces\textbf{\@worksheet@languageSelection@exercise~\the@worksheet@numberOfExercises}%
	% call Commands in optional Argument which define \@worksheet@localScore, \@worksheet@localLearningTargets and \@worksheet@localDifficulty locally within this group
	#1%
	% check if Score should be shown and if Score have been set
	%     show footnotesized raggedleft Score
	\ifnum\value{@worksheet@showScoreFlag}=0\else
		\ifdefined\@worksheet@localScore
			{\hfill\footnotesize\@worksheet@languageSelection@score:~\@worksheet@localScore}
		\fi
	\fi

	% check if Difficulty should be shown and if Difficulty have been set
	%     show footnotesized natural Difficulty
	%     prevent Pagebreaks, Indents and Spaces
	\ifnum\value{@worksheet@showDifficultyFlag}=0\else
		\ifdefined\@worksheet@localDifficulty
			\nopagebreak\par\noindent\ignorespaces
			{\footnotesize\@worksheet@languageSelection@difficulty:~\@worksheet@localDifficulty%
			\ifnum\value{@worksheet@showLearningTargetsFlag}=0\else%
				\ifdefined\@worksheet@localLearningTargets%
					,%
				\fi%
			\fi%
			}%
		\fi%
	\fi%
	%
	% check if Learning Targets should be shown and if Learning Targets have been set
	%     show footnotesized raggedleft Learning Targets
	%     prevent Pagebreaks, Indents and Spaces
	\ifnum\value{@worksheet@showLearningTargetsFlag}=0\else%
		\ifdefined\@worksheet@localLearningTargets%
			\ifnum\value{@worksheet@showDifficultyFlag}=0%
				\nopagebreak\par\noindent\ignorespaces%
			\else%
				\ifdefined\@worksheet@localDifficulty\else%
					\nopagebreak\par\noindent\ignorespaces%
				\fi%
			\fi%
			{\footnotesize\hfill\@worksheet@languageSelection@learningTargets:~\@worksheet@localLearningTargets}
		\fi
	\fi

	\endgroup

	% prevent Pagebreaks, Indents and Spaces
	\nopagebreak\par\noindent\ignorespaces
}{
	% check if File Name should be shown and if \@worksheet@currentFilename is not empty
	%     prevent Pagebreaks, Indents and Spaces
	%     show tinyed non-empty \@worksheet@currentFileName
	\ifnum\value{@worksheet@showFileNameFlag}=0\else
		\if\@worksheet@currentFileName\relax\relax\else
			\nopagebreak\par\noindent\ignorespaces
			{\scriptsize\sffamily[\@worksheet@currentFileName]}%
		\fi%
	\fi%
	%
	% check if Occurrence should be shown and if \@worksheet@occurence is not empty
	%     prevent Pagebreaks, Indents and Spaces
	%     show tinyed non-empty \@worksheet@occurence
	\ifnum\value{@worksheet@showOccurrenceFlag}=0\else%
		\if\@worksheet@occurence\relax\relax\else%
			\ifnum\value{@worksheet@showFileNameFlag}=0%
				\nopagebreak\par\noindent\ignorespaces%
			\else%
				\if\@worksheet@currentFileName\relax\relax%
					\nopagebreak\par\noindent\ignorespaces%
				\fi%
			\fi%
			{\scriptsize\sffamily\hfill[\@worksheet@occurence]}
		\fi
	\fi
	\gdef\@worksheet@occurence{}
	
	\par\addvspace{\topsep}%
}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Header

% Header Flags
\newcounter{@worksheet@hideHeader}
\newcounter{@worksheet@noSFFamilyInHeader}

% prevent Header
\def\worksheetHideHeader{\setcounter{@worksheet@hideHeader}{1}}
\def\worksheetNoSFFamilyInHeader{\setcounter{@worksheet@noSFFamilyInHeader}{1}}

% lv-File which should be loaded
\edef\@worksheet@lvFile{./lv.tex}

% change lv-File Name and Path
\def\worksheetChangelvFile#1{\edef\@worksheet@lvFile{#1}}

% define Header Information
%     only if not empty
\def\worksheetAuthors#1{\if\relax#1\relax\else\xdef\@worksheet@authors{#1}\fi}
\def\worksheetCourseName#1{\if\relax#1\relax\else\xdef\@worksheet@course{#1}\fi}

% formatting of worksheet Header
%\def\@worksheet@head#1#2{\vbox{\sffamily\small#1\hfill #2\par\vspace{3pt}\hrule}}

% make Header
%     make Header \sffamily if Document Class is KOMA
\def\@worksheet@makeHead#1#2{
	\clearpairofpagestyles
	\cfoot*{\pagemark}
	\@ifundefined{KOMAClassName}{%
		\ihead{#1}
		\ohead{#2}
    }{%
		\ihead{\ifnum\value{@worksheet@hideHeader}=0\sffamily\fi#1}
		\ohead{\ifnum\value{@worksheet@hideHeader}=0\sffamily\fi#2}
    }
	\pagestyle{headings}
}

% Macros to call at \begin{document}
\def\@worksheet@header@beginDocument{
	% default Pagestyle
	\pagestyle{plain}

	% load \@worksheet@lvFile ("./lv.tex" by default) if existing
	\begingroup
	\IfFileExists{\@worksheet@lvFile}{
		\input{\@worksheet@lvFile}
		\ifdefined\coursename\if\relax\coursename\relax\else\worksheetCourseName{\coursename}\fi\fi
		\ifdefined\authors\if\relax\authors\relax\else\worksheetAuthors{\authors}\fi\fi
		\ifdefined\lvname\if\relax\lvname\relax\else\worksheetCourseName{\lvname}\fi\fi
		\ifdefined\autoren\if\relax\autoren\relax\else\worksheetAuthors{\autoren}\fi\fi
	}{}
	\endgroup

	% make Header at Begin of Document if \@worksheet@authors or \@worksheet@course is defined
	\ifnum\value{@worksheet@hideHeader}=0
		\ifdefined\@worksheet@authors
			\ifdefined\@worksheet@course
				\@worksheet@makeHead{\@worksheet@course}{\@worksheet@authors}
			\else
				\@worksheet@makeHead{}{\@worksheet@authors}
			\fi
		\else
			\ifdefined\@worksheet@course
				\@worksheet@makeHead{\@worksheet@course}{}
			\fi
		\fi
	\fi
	\def\@worksheet@header@beginDocument{}
}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% At Document Begin

\AtBeginDocument{
	\@worksheet@header@beginDocument
	\@worksheet@languageSelection@beginDocument
}

\endinput