Debian Codegraph @

texmf-dist/doc/latex/koma-script/README.md

raw
1 # KOMA-Script 2026/02/02 v3.49.2
2 Copyright [Markus Kohm](mailto:[email protected]) 1994–2026
3
4 This material is subject to the LaTeX Project Public License Version 1.3c. See [`lppl.txt`](lppl.txt) (English) or [`lppl-de.txt`](lppl-de.txt) (German) for the details of that license.
5
6 ------------------------------------------------------------------------------
7
8 KOMA-Script is a versatile bundle of LaTeX2e document classes and packages. The classes are designed as replacements to the standard LaTeX2e classes. Several features have been added to make them more configurable.
9
10 ------------------------------------------------------------------------------
11
12 ## Seeking assistance!
13
14 For over 30 years, KOMA-Script has largely been a one-man show. At times, there has been assistance with documentation. The first version of a letter class was also originally contributed by another developer. Currently, however, maintenance, development, documentation, and testing are once again largely in the hands of a single developer. Given the pace at which the LaTeX team is working on the LaTeX kernel and the core packages, this is hardly feasible for a huge project like KOMA-Script. The problem is exacerbated by the fact that other projects are also increasingly becoming orphaned. This means, for example, that cooperation with the authors of other previously well-maintained packages is now being interrupted, and compatibility with these packages can only be maintained unilaterally and thus in a limited way by KOMA-Script, requiring additional effort.
15
16 Therefore, assistance is urgently needed. The simplest form of assistance, namely testing, can be provided by almost every user. Unfortunately, due to the constant and sometimes quite short-term adjustments necessary for LaTeX developments, testing often falls by the wayside.
17
18 More information about how to contribute can be found in [`CONTRIBUTING.md`](https://sf.net/p/koma-script/code/HEAD/tree/trunk/CONTRIBUTING.md).
19
20
21 ## Classes and packages in this release:
22
23 ### `koma-script-source-doc` — internal source documentation class of KOMA-Script
24 <pre>
25 Maintainer: Markus Kohm
26 E-Mail: [email protected]
27 Abstract: koma-script-source-doc is an internal LaTeX class of the
28 KOMA-Script bundle. It is an extension of ltxdoc.
29 KOMA-Script uses scrdoc for the implementation documentation
30 and the documentation of packages that aren't KOMA-Script core
31 packages. The user manual of this class can be generated from
32 koma-script-source-doc.dtx. However average users should not
33 need the user manual, because they should never use this
34 internal class.
35 Requires: ltxdoc - the LaTeX2e source documentation class
36 doc.sty - at least version 3.0 is needed
37 scrartcl - the KOMA-Script article class
38 License: LPPL 1.3c or later
39 State: Author maintained
40 Version: 2022-07-08 v0.92
41 </pre>
42 ***
43
44 ### `scraddr` — Package to provide data from scrlttr2's adr-files
45 <pre>
46 Maintainer: Markus Kohm
47 E-Mail: [email protected]
48 Abstract: scraddr is a LaTeX package of the KOMA-Script bundle.
49 scrlttr2 uses adr-files to create form letters. The scraddr
50 package provides commands to read such files and to use the
51 data of the address entries not only with the scrlttr2 class
52 and not only for form letters.
53 Requires:
54 License: LPPL 1.3c or later
55 State: Author maintained
56 Version: 2022/01/24 v1.1d
57 </pre>
58 ***
59
60 ### `scrartcl` — versatile class may be used as a drop-in replacement of article
61 <pre>
62 Maintainer: Markus Kohm
63 E-Mail: [email protected]
64 Abstract: scrartcl is a LaTeX class of the KOMA-Script bundle. It is
65 the KOMA-Script drop-in replacement for the standard LaTeX
66 article class. It provides all options, environments,
67 counters, lengths and commands of the standard LaTeX article
68 class, as well as several additional options, environments,
69 commands, etc. to make it much more versatile. The default
70 layout of scrartcl differs from article, with an emphasis on
71 good typography. Nevertheless, by changing the defaults, you
72 can achieve a layout very similar to that of the standard
73 class.
74 Requires: scrkbase - internal KOMA-Script package
75 tocbasic - KOMA-Script package
76 typearea - KOMA-Script package
77 Recommended: scrlayer-scrpage - KOMA-Script package
78 License: LPPL 1.3c or later
79 State: Author maintained
80 Version: 2026/02/02 v3.49.2
81 </pre>
82 ***
83
84 ### `scrarticle` — wrapper class to scrartcl
85 <pre>
86 Maintainer: Markus Kohm
87 E-Mail: [email protected]
88 Abstract: scrarticle is a very simple wrapper class to scrartcl. It has
89 been made, because several younger KOMA-Script users do not
90 understand the 8.3 name scheme.
91
92 However it is still recommended to use scrartcl instead of
93 scrarticle.
94 Requires: scrartcl.cls - KOMA-Script class
95 License: LPPL 1.3c or later
96 State: Author maintained
97 Version: 2026/02/02 v3.49.2
98 </pre>
99 ***
100
101 ### `scrbase` — basic features for KOMA-Script, e.g. conditionals and key=value
102 <pre>
103 Maintainer: Markus Kohm
104 E-Mail: [email protected]
105 Abstract: scrbase is a LaTeX package of the KOMA-Script bundle. It
106 provides some basic functions used by KOMA-Script that can
107 also be used by authors and users of other classes and
108 packages.
109
110 First, it provides extended handling of key=value pairs
111 that can be used for run-time options of classes and
112 packages. Several packages in a family can share options,
113 and all the options in a family can be changed with a
114 single command.
115
116 Additional conditions like \ifundefinedorrelax, \ifpdftex,
117 \ifVTeX, \ifpdfoutput, \ifstr etc. are provided. Most of
118 them can be prevented from being defined and have
119 additional internal representations that can be used by
120 package or class authors.
121
122 It also provides commands to easily define or change
123 language-dependent terms that work not only with babel but
124 with other packages like ngerman too.
125
126 It provides some commands for package and class authors
127 missing in the LaTeX kernel like \ClassInfoNoLine,
128 \PackageInfoNoLine or \l@addto@macro.
129
130 Last but not least, it provides commands for integer
131 division and integer modulo operation that can be used,
132 for example, inside \numexpr ...\relax or with \ifnum.
133 Requires: keyval - key=value package from the graphics bundle
134 scrlfile - KOMA-Script package for file loading
135 manipulation
136 License: LPPL 1.3c or later
137 State: Author maintained
138 Version: 2026/02/02 v3.49.2
139 </pre>
140 ***
141
142 ### `scrbook` — versatile class may be used as a drop-in replacement of book
143 <pre>
144 Maintainer: Markus Kohm
145 E-Mail: [email protected]
146 Abstract: scrbook is a LaTeX class of the KOMA-Script bundle and a
147 drop-in replacement for the standard LaTeX book class. It
148 provides all options, environments, commands, etc. of the
149 standard LaTeX book class, as well as several additional
150 options, environments, commands, etc. to make it much more
151 versatile. The default layout of scrbook differs from book,
152 with an emphasis on good typography. Nevertheless, by changing
153 the defaults, you can achieve a layout very similar to that
154 of the standard class.
155 Requires: scrkbase - internal KOMA-Script package
156 tocbasic - KOMA-Script package
157 typearea - KOMA-Script package
158 License: LPPL 1.3c or later
159 State: Author maintained
160 Version: 2026/02/02 v3.49.2
161 </pre>
162 ***
163
164 ### `scrdate` — calender date operations, e.g. calculation of the day of the week
165 <pre>
166 Maintainer: Markus Kohm
167 E-Mail: [email protected]
168 Abstract: scrdate is a LaTeX package of the KOMA-Script bundle. It
169 provides several operations with calender dates, e.g., show
170 the century or the decade of a year, calculate the day of
171 the week of a given calender date, show the current
172 calender date in ISO form. It has support for several
173 languages, including English, German, French, Italian,
174 Spanish, Croatian, Finnish, Norsk, Swedish, Danish, Polish,
175 Czech, and Slovak.
176 Requires: scrkbase - KOMA-Script package for some basic features.
177 scrlfile - KOMA-Script package for file loading
178 manipulation
179 License: LPPL 1.3c or later
180 State: Author maintained
181 Version: 2026/02/02 v3.49.2
182 </pre>
183 ***
184
185 ### `scrextend` — make some features of the KOMA-Script classes available for others
186 <pre>
187 Maintainer: Markus Kohm
188 E-Mail: [email protected]
189 Abstract: scrextend is a LaTeX package of the KOMA-Script bundle. It
190 makes some features of the KOMA-Script classes available to
191 other classes, i.e., for the standard classes.
192 Requires: scrkbase - internal package with some basics of KOMA-Script
193 etoolbox - tool-box for LaTeX programming using e-TeX
194 License: LPPL 1.3c or later
195 State: Author maintained
196 Version: 2026/02/02 v3.49.2
197 </pre>
198 ***
199
200 ### `scrfontsizes` — package to generate a KOMA-Script font size file
201 <pre>
202 Maintainer: Markus Kohm
203 E-Mail: [email protected]
204 Abstract: scrfontsizes is a LaTeX package of the KOMA-Script bundle.
205 It provides a simple interface to generate KOMA-Script
206 font-size files.
207 Requires: scrextend - some KOMA-Script features for other classes
208 License: LPPL 1.3c or later
209 State: Author maintained
210 Version: 2026/02/02 v3.49.2
211 </pre>
212 ***
213
214 ### `scrjura` — contract environment for advocates and scholary persons in law
215 <pre>
216 Maintainer: Markus Kohm
217 E-Mail: [email protected]
218 Abstract: scrjura is a LaTeX package of the KOMA-Script bundle. It
219 has been made in cooperation with a German lawyer to
220 provide environments for contracts, laws, acts or other
221 legal purposes. It supports automatic numbering of
222 paragraphs and semi-automatic numbering of sentences.
223 Currently German and English are supported.
224 Requires: scrkbase - internal KOMA-Script package with basics
225 tocbasic - features for helper files and float environments
226 License: LPPL 1.3c or later
227 State: Author maintained
228 Version: 2026/02/02 v3.49.2
229 </pre>
230 ***
231
232 ### `scrkbase` — internal basic features for KOMA-Script classes and packages
233 <pre>
234 Maintainer: Markus Kohm
235 E-Mail: [email protected]
236 Abstract: scrkbase is an internal KOMA-Script packages that provides
237 some features that are common to several KOMA-Script
238 classes and packages. Users and class or package authors
239 should not use this package directly.
240 Requires: scrbase - KOMA-Script package for some basic features.
241 scrlfile - KOMA-Script package for file loading
242 manipulation
243 License: LPPL 1.3c or later
244 State: Author maintained
245 Version: 2026/02/02 v3.49.2
246 </pre>
247 ***
248
249 ### `scrlayer-notecolumn` — control note columns parallel to the main text
250 <pre>
251 Maintainer: Markus Kohm
252 E-Mail: [email protected]
253 Abstract: scrlayer-notecolumn is a LaTeX package of the KOMA-Script
254 bundle. It provides an end-user interface to scrlayer to
255 define and manage note columns. Those note columns are
256 somewhat similar to marginal notes (see the LaTeX
257 command \marginpar or packages like notecolumn), but you
258 can use several of them. The package provides page breaks
259 inside note columns and synchronization points between the
260 main text and note columns.
261
262 Like most of the KOMA-Script packages, you can use this
263 package not only with KOMA-Script classes but also with
264 several other classes, e.g., the standard LaTeX classes.
265 Requires: scrlayer.sty
266 License: LPPL 1.3c or later
267 State: Author maintained, proof of concept
268 Version: 2025/12/31 v0.4.4254
269 </pre>
270 ***
271
272 ### `scrlayer-scrpage` — controlling page headers and footers
273 <pre>
274 Maintainer: Markus Kohm
275 E-Mail: [email protected]
276 Abstract: scrlayer-scrpage is a LaTeX package of the KOMA-Script
277 bundle. It provides an end-user interface to scrlayer to
278 define and manage page styles. This end user interface is
279 sufficiently compatible to scrpage2 that users should easily
280 be able to switch from the old scrpage2 package to the new
281 one. Nevertheless, it provides several new features to control
282 headers and footers.
283
284 Like most of the KOMA-Script packages, you can use this
285 package not only with KOMA-Script classes but also with
286 several other classes, e.g., the standard LaTeX classes.
287 Requires: scrlayer.sty
288 License: LPPL 1.3c or later
289 State: Author maintained
290 Version: 2026/02/02 v3.49.2
291 </pre>
292 ***
293
294 ### `scrlayer` — defining layers and controlling page headers and footers
295 <pre>
296 Maintainer: Markus Kohm
297 E-Mail: [email protected]
298 Abstract: scrlayer is a LaTeX package of the KOMA-Script bundle.
299 Users may already be familiar with a type of layer from
300 packages like eso-pic or textpos. scrlayer is another package
301 that provides background and foreground layers, but unlike
302 those other packages, these layers are part of the page-style
303 definition. With this package, you can easily switch between
304 the layers used by switching the page style.
305
306 In short, the page-style interface of scrlayer provides
307 commands to define page styles based on a stack of layers and
308 to manage those layer stacks.
309
310 Nevertheless, using the layers directly is recommended for
311 advanced users only. End-user interfaces for beginners or
312 average users are provided by additional packages, that
313 load scrlayer on their own, e.g., scrlayer-scrpage.
314 Requires: scrkbase.sty
315 License: LPPL 1.3c or later
316 State: Author maintained
317 Version: 2026/02/02 v3.49.2
318 </pre>
319 ***
320
321 ### `scrletter` — wrapper class to scrartcl class + scrletter package
322 <pre>
323 Maintainer: Markus Kohm
324 E-Mail: [email protected]
325 Abstract: scrletter is a wrapper class to class scrartcl with package
326 scrletter. Is has been made, to provide a letter class, that
327 also supports features like sections and floats.
328 Requires: scrartcl.cls – KOMA-Script class
329 scrletter.sty – KOMA-Script package
330 License: LPPL 1.3c or later
331 State: Author maintained
332 Version: 2026/02/02 v3.49.2
333 </pre>
334 ***
335
336 ### `scrletter` — letter extension to KOMA-Script classes
337 <pre>
338 Maintainer: Markus Kohm
339 E-Mail: [email protected]
340 Abstract: scrletter provides the features of the letter class scrlttr2
341 when using the KOMA-Script classes scrartcl, scrreprt, and
342 scrbook, or the standard classes article, report, and book.
343 Requires: scrkbase - internal KOMA-Script package
344 typearea - KOMA-Script package
345 scrlayer-scrpage - KOMA-Script package
346 Recommended: marvosym - package by Martin Vogel providing symbols
347 License: LPPL 1.3c or later
348 State: Author maintained
349 Version: 2026/02/02 v3.49.2
350 </pre>
351 ***
352
353 ### `scrlfile-hook-3.34` — internal subpackage of scrlfile
354 <pre>
355 Maintainer: Markus Kohm
356 E-Mail: [email protected]
357 Abstract: scrlfile-hook-3.34 is an internal subpackage of scrlfile to
358 be used with LaTeX from version 2020-10-01, but before
359 version 2021-11-15.
360 Requires: scrlogo.sty
361 License: LPPL 1.3c or later
362 State: Author maintained
363 Version: 2026/02/02 v3.49.2
364 </pre>
365 ***
366
367 ### `scrlfile-hook` — internal subpackage of scrlfile
368 <pre>
369 Maintainer: Markus Kohm
370 E-Mail: [email protected]
371 Abstract: scrlfile-hook is an internal subpackage of scrlfile to be
372 be used with LaTeX from version 2021-11-15 on.
373 Requires: scrlogo.sty
374 License: LPPL 1.3c or later
375 State: Author maintained
376 Version: 2026/02/02 v3.49.2
377 </pre>
378 ***
379
380 ### `scrlfile-pacholdlatex` — internal subpackage of scrlfile
381 <pre>
382 Maintainer: Markus Kohm
383 E-Mail: [email protected]
384 Abstract: scrlfile-patcholdlatex is an internal subpackage of scrlfile
385 to be be used with LaTeX up to version 2010-04-01.
386 Requires: scrlogo.sty
387 License: LPPL 1.3c or later
388 State: Author maintained
389 Version: 2026/02/02 v3.49.2
390 </pre>
391 ***
392
393 ### `scrlfile` — control of package dependencies
394 <pre>
395 Maintainer: Markus Kohm
396 E-Mail: [email protected]
397 Abstract: scrlfile is a LaTeX package of the KOMA-Script bundle. It
398 provides the ability to execute commands before or after
399 loading files, classes, or packages. It can even
400 automatically load one file, class, or package in place of
401 another or prevent a package from being loaded. It also
402 provides the ability to execute commands before or after
403 closing the main aux file during \end{document}. It has
404 been used by the KOMA-Script classes for more than a
405 decade.
406 Requires: scrlfile-hook.sty, scrlfile-patcholdlatex.sty, scrlogo.sty
407 License: LPPL 1.3c or later
408 State: Author maintained
409 Version: 2026/02/02 v3.49.2
410 </pre>
411 ***
412
413 ### `scrlogo` — print the KOMA-Script logo
414 <pre>
415 Maintainer: Markus Kohm
416 E-Mail: [email protected]
417 Abstract: scrlogo is a LaTeX package of the KOMA-Script bundle. It
418 provides the command \KOMAScript to print the official
419 KOMA-Script logo.
420 Requires:
421 License: LPPL 1.3c or later
422 State: Author maintained
423 Version: 2026/02/02 v3.49.2
424 </pre>
425 ***
426
427 ### `scrlttr2` — versatile letter class with separation of text area and note paper
428 <pre>
429 Maintainer: Markus Kohm
430 E-Mail: [email protected]
431 Abstract: scrlttr2 is a letter class for LaTeX2e that allows
432 definition of several letterheads and text area settings
433 that are independent from the letterhead. So you can use
434 not only the KOMA-Script package typearea but even packages
435 like geometry to define the text area and the margins.
436
437 The positions of the elements of the letterhead can be
438 changed by so called pseudo-lengths. This makes it possible
439 to adjust scrlttr2 not only to local conventions and paper
440 sizes but also to a corporate brand identity.
441
442 Several predefined sets of parameters, called
443 letter-class-option or lco files are part of the
444 KOMA-Script bundle: two German letters, Swiss letters, US
445 letters, Japanese letters, and French letters. More can be
446 found on CTAN or the KOMA-Script homepage as separate
447 packages.
448
449 Additional lco-files for different letterheads can be found
450 on the KOMA-Script homepage, e.g., one demonstration file
451 for a letterhead similar to that of Washington State
452 University.
453 Requires: scrkbase - internal KOMA-Script package
454 typearea - KOMA-Script package
455 Recommended: marvosym - package by Martin Vogel providing symbols
456 License: LPPL 1.3c or later
457 State: Author maintained
458 Version: 2026/02/02 v3.49.2
459 </pre>
460 ***
461
462 ### `scrreport` — wrapper class to scrreprt
463 <pre>
464 Maintainer: Markus Kohm
465 E-Mail: [email protected]
466 Abstract: scrreport is a very simple wrapper class to scrreprt. It has
467 been made, because several younger KOMA-Script users do not
468 understand the 8.3 name scheme.
469
470 However it is still recommended to use scrreprt instead of
471 scrreport.
472 Requires: scrreprt.cls - KOMA-Script class
473 License: LPPL 1.3c or later
474 State: Author maintained
475 Version: 2026/02/02 v3.49.2
476 </pre>
477 ***
478
479 ### `scrreprt` — versatile class may be used as a drop-in replacement of report
480 <pre>
481 Maintainer: Markus Kohm
482 E-Mail: [email protected]
483 Abstract: scrreprt is the KOMA-Script drop-in replacement for the
484 standard LaTeX report class. It provides all options,
485 environments, counters, lengths, and commands of the standard
486 LaTeX report class, as well as several additional options,
487 environments, commands, etc., to make it much more versatile.
488 The default layout of scrreprt differs from that of report,
489 with an emphasis on good typography. Nevertheless, by changing
490 the defaults, you can achieve a layout very similar to that of
491 the standard class.
492 Requires: scrkbase - internal KOMA-Script package
493 tocbasic - KOMA-Script package
494 typearea - KOMA-Script package
495 License: LPPL 1.3c or later
496 State: Author maintained
497 Version: 2026/02/02 v3.49.2
498 </pre>
499 ***
500
501 ### `scrtime` — show the time of the LaTeX run
502 <pre>
503 Maintainer: Markus Kohm
504 E-Mail: [email protected]
505 Abstract: scrtime is a LaTeX package of the KOMA-Script bundle. It
506 provides only some small features to show the time of the
507 LaTeX run.
508 Requires: scrkbase - internal package with some basics of KOMA-Script
509 License: LPPL 1.3c or later
510 State: Author maintained
511 Version: 2026/02/02 v3.49.2
512 </pre>
513 ***
514
515 ### `tocbasic` — Management of tables and lists of contents using helper files
516 <pre>
517 Maintainer: Markus Kohm
518 E-Mail: [email protected]
519 Abstract: tocbasic is a LaTeX package of the KOMA-Script bundle. The
520 main purpose of package tocbasic is to provide features for
521 authors of classes and packages to create their own tables or
522 lists of contents like the list of figures and the list of
523 tables, and thereby allow other classes or packages some
524 measure of control over these. For example, the tocbasic
525 package delegates control of the language for all these tables
526 and lists of contents to the babel package. Thus changes of
527 language will be automatically reflected inside all these
528 tables and lists of contents. Using tocbasic will free
529 authors of classes and packages from the burden of
530 implementing of such features.
531
532 KOMA-Script itself uses tocbasic not only for the table of
533 contents but also for the lists of figures and tables
534 mentioned previously.
535 Requires: scrbase - KOMA-Script package for some basic features.
536 License: LPPL 1.3c or later
537 State: Author maintained
538 Version: 2026/02/02 v3.49.2
539 </pre>
540 ***
541
542 ### `typearea` — Calculating typeing area and margins depending on typographic rules
543 <pre>
544 Maintainer: Markus Kohm
545 E-Mail: [email protected]
546 Abstract: Many LaTeX classes, including the standard classes, present
547 the user with the largely fixed configuration of margins
548 and type area. With the standard classes, the choice is
549 limited to selecting a font size. There are separate packages,
550 such as geometry, which give the user complete control over,
551 but also full responsibility for, setting the type area and
552 margins.
553
554 KOMA-Script takes a somewhat different approach with its
555 typearea package. Users are offered ways to adjust the design
556 and algorithms based on established typographic standards,
557 making it easier for them to make good choices.
558 Requires: scrkbase - internal basic features for KOMA-Script packages
559 License: LPPL 1.3c or later
560 State: Autor maintained
561 Version: 2026/02/02 v3.49.2
562 </pre>
563 ***
564
565 ## Installation:
566
567 We highly recommend installing the latest official release via the package manager of the TeX distribution you are using. For example, for Vanilla TeX Live this would be `tlmgr` or `tlshell` or `tlcockpit`. For MiKTeX it would be `MiKTeX Console`. Linux users who use the TeX Live of their Linux distribution will often find KOMA script in one of the many TeX Live supplementary packages. In Debian, for example, it is in `texlive-latex-recommended`.
568
569 If the package manager does not offer the desired KOMA-Script version, you can find [various versions in the KOMA-Script Project](https://komascript.de/current). There is also the installation from a TDS archive explained.
570
571 From KOMA-Script sources of a [release on SourceForge](https://sourceforge.net/p/koma-script/code/HEAD/tree/tags/) one can build and even install KOMA-Script with the help of `l3build`. More details can be found in the instructions for `l3build`.
572
573 If you want to generate KOMA-Script step by step from the sources, first run `tex scrmain.ins`. This will generate a larger number of files with the extensions `.cls`, `.sty`, `.lco`, `.clo` and `.hak`. All these files are needed for KOMA-Script to work properly. They have to be copied either into the document directory of your LaTeX project or into a directory of one of your TEXMF search trees. In the TEXMF search tree further actions may be necessary. Consult the instructions of your TeX distribution. After the correct installation of these files, the manual is to be generated. To do this, change to the subdirectory `/doc` and first run `pdflatex scrguide-en.tex` there. Then repeat the runs of `bibtex scrguide-en`, `makeindex scrguide-en`, `pdflatex scrguide-en.tex` min. four times. This way you get a form of the English user manual with a simplified index. The German user manual can be generated in the same way by substituting `scrguide-en` for `scrguide-de`.
574
575 If you like to have the implementation documentation of KOMA-Script as a PDF, first create the required class `koma-script-source-doc.cls` with `tex koma-script-source-doc.dx`. This class can then be used to generate the implementation documentation of this class with repeated calls to `lualatex-dev koma-script-source-doc.dtx` and `mkindex koma-script-source-doc`. Correspondingly, the documentation of the other KOMA-Script components can be generated.