diff options
Diffstat (limited to 'Master/texmf-dist/source')
35 files changed, 7265 insertions, 5411 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/ChangeLog b/Master/texmf-dist/source/latex/koma-script/ChangeLog index 50b392d663e..1d2759ac6be 100644 --- a/Master/texmf-dist/source/latex/koma-script/ChangeLog +++ b/Master/texmf-dist/source/latex/koma-script/ChangeLog @@ -1,3 +1,691 @@ +r510 2007-10-01 09:18:44 +0200 mjk: + + * scrkvers.dtx: version number fixed + +r509 2007-09-28 10:01:05 +0200 mjk: + + * scrkvers.dtx, scrkcomp.dtx: version fixed + +r508 2007-09-28 09:45:33 +0200 mjk: + + * scrkvers.dtx, scrkcomp.dtx: prepared for v2.97c + +r507 2007-09-27 09:42:11 +0200 mjk: + + * doc/, doc/english/, doc/english/scrpage2.tex, + doc/english/guide-english.tex, doc/english/typearea.tex, + doc/english/scrlttr2.tex, doc/english/scraddr.tex, + doc/english/scrbookreportarticle.tex, doc/english/adrconvnote.tex: + index fixed + +r506 2007-09-26 16:44:56 +0200 mjk: + + * doc/, doc/english/, doc/english/scrdatetime.tex, + doc/english/scrpage2.tex, doc/english/guide-english.tex, + doc/english/introduction.tex, doc/english/typearea.tex, + doc/english/scrlttr2.tex, doc/english/scrlfile.tex, + doc/english/scraddr.tex, doc/english/scrbookreportarticle.tex: + improved by GH + +r505 2007-09-26 09:23:54 +0200 mjk: + + * doc/, doc/english/, doc/english/scrdatetime.tex, + doc/english/scrpage2.tex, doc/english/guide-english.tex, + doc/english/introduction.tex, doc/english/typearea.tex, + doc/english/scrlttr2.tex, doc/english/scrlfile.tex, + doc/english/scraddr.tex, doc/english/scrbookreportarticle.tex: + improved by GH + +r504 2007-09-25 09:07:38 +0200 mjk: + + * scrbeta.dtx: tocstyle added + +r503 2007-09-25 09:05:04 +0200 mjk: + + * scrmain.ins: no logo at lco files + +r502 2007-09-25 08:34:49 +0200 mjk: + + * tocstyle.dtx: docu fix + +r501 2007-09-25 08:32:57 +0200 mjk: + + * scrkpage.dtx: date fixed + +r500 2007-09-25 08:32:30 +0200 mjk: + + * scrkpage.dtx: warning \scr@fnt@wrn@pagehead changed + +r499 2007-09-21 09:06:57 +0200 mjk: + + * doc/, doc/koma-script.html: name of english guide fixed [Stephan + Hennig] + +r498 2007-09-20 15:08:33 +0200 mjk: + + * doc/, doc/english/, doc/english/scrpage2.tex: two more translators + added + +r497 2007-09-18 12:04:55 +0200 mjk: + + * doc/, doc/scrguide.cls, doc/guide.tex, doc/german/, + doc/german/guide-ngerman.tex, doc/english/, + doc/english/scrdatetime.tex, doc/english/scrpage2.tex, + doc/english/guide-english.tex, doc/english/introduction.tex, + doc/english/scrlttr2.tex, doc/english/scrlfile.tex, + doc/english/scraddr.tex, doc/english/scrbookreportarticle.tex, + doc/english/adrconvnote.tex: new command \translator at the guide + +r496 2007-09-18 11:52:41 +0200 mjk: + + * doc/, doc/english/, doc/english/typearea.tex: \translator added + +r495 2007-09-18 10:37:10 +0200 mjk: + + * doc/, doc/scrguide.cls: sectioning --> disposition + +r494 2007-09-17 12:46:21 +0200 mjk: + + * scrkplen.dtx: it's save but not compatible not to use e-TeX + +r493 2007-09-17 12:45:25 +0200 mjk: + + * scrkfont.dtx: test for needed e-TeX feature + +r492 2007-09-17 12:31:34 +0200 mjk: + + * scrkplen.dtx: less functionality, if eTeX not used + +r491 2007-09-17 11:57:42 +0200 mjk: + + * scrkfloa.dtx: there where to many \scr@smashdp + +r490 2007-09-17 11:48:43 +0200 mjk: + + * scrkfloa.dtx: use of \scr@smashdp fixed + +r489 2007-09-17 11:48:28 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: macro name fixed + +r488 2007-09-17 11:46:47 +0200 mjk: + + * scrkbase.dtx: Warning message break changed + +r487 2007-09-17 11:35:22 +0200 mjk: + + * scrkfloa.dtx: \@@makecaption uses \scr@smashdp + +r486 2007-09-17 11:34:48 +0200 mjk: + + * scrkbase.dtx: date fixed + +r485 2007-09-17 11:34:33 +0200 mjk: + + * scrkbase.dtx: new: scr@smashdp + +r484 2007-09-17 10:13:55 +0200 mjk: + + * doc/, doc/english/, doc/english/scraddr.tex: improved by GH + +r483 2007-09-17 10:12:16 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: improved by GH + +r482 2007-09-17 10:06:30 +0200 mjk: + + * doc/, doc/german/, doc/german/scrlttr2.tex: Kleinere Verbesserungen + +r481 2007-09-12 17:05:12 +0200 mjk: + + * TODO: change about lco files + +r480 2007-09-12 17:03:04 +0200 mjk: + + * scrktare.dtx, scrklco.dtx: loading of lco file via \documentclass + option fixed + +r479 2007-09-12 12:47:27 +0200 mjk: + + * doc/, doc/german/, doc/german/scrlttr2.tex: Tabellenüberschrift + für Tabelle 6.18 (Datumsbefehle und Ausgabebeispiel) ergänzt [GH] + +r478 2007-09-12 12:44:45 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: improved by GH + +r477 2007-09-06 11:05:54 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: improved by GH + +r476 2007-09-06 11:01:22 +0200 mjk: + + * doc/, doc/german/, doc/german/scrlttr2.tex: Fehlende schließende + Klammer ergänzt + +r475 2007-09-06 10:55:26 +0200 mjk: + + * doc/, doc/german/, doc/german/scrlttr2.tex: toaddrindent etwas + genauer dokumentiert + +r474 2007-09-04 11:48:13 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: translated + german file changed + +r473 2007-09-04 11:46:50 +0200 mjk: + + * doc/, doc/german/, doc/german/scrbookreportarticle.tex: Gesucht sind + linksbündige Fußnotenmarkierungen, nicht linksb+ndige Fußnoten + +r472 2007-09-04 11:31:06 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: improved by GH + +r471 2007-09-04 11:26:21 +0200 mjk: + + * doc/, doc/german/, doc/german/scrlttr2.tex: Vertippser korrigiert + [GH] + +r470 2007-09-02 11:16:22 +0200 mjk: + + * doc/, doc/plength.dtx: some english terms changed [GH] + +r469 2007-08-31 11:41:50 +0200 mjk: + + * scrktitl.dtx: back side of title pages should use page style empty + +r468 2007-08-31 09:29:35 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: improved by GH + +r467 2007-08-22 11:58:23 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: improved by GH + +r466 2007-08-22 11:33:32 +0200 mjk: + + * doc/, doc/german/, doc/german/scrlttr2.tex: Adresse von Markus + korrigiert + +r465 2007-08-20 10:36:52 +0200 mjk: + + * doc/, doc/english/, doc/english/scrpage2.tex: one more fix + +r464 2007-08-19 12:38:46 +0200 mjk: + + * doc/, doc/english/, doc/english/scrpage2.tex: \EndIndex{Cmd}{page + style} changed to \EndIndex{Cmd}{pagestyle} + +r463 2007-08-19 12:35:00 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: One + \BeginIndex{}{circular letters} changed into \EndIndex{}{circular + letters} + +r462 2007-08-19 12:31:40 +0200 mjk: + + * doc/, doc/english/, doc/english/scrpage2.tex: \EndIndex{Page + style}{useheadings} fixed (must be + \EndIndex{Pagestyle}{useheadings}) + +r461 2007-08-19 12:26:22 +0200 mjk: + + * doc/, doc/german/, doc/german/scrlttr2.tex: Verbesserung von Gernot + Hassenpflug + +r460 2007-08-19 12:22:13 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: improved by GH + +r459 2007-08-19 12:15:31 +0200 mjk: + + * doc/, doc/english/, doc/english/scrpage2.tex: improved by GH + +r458 2007-08-10 18:55:58 +0200 mjk: + + * scrklang.dtx: text of \languagename warning changed [Stephan Hennig] + +r457 2007-08-09 17:30:26 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: index improved by GH + +r456 2007-08-09 17:22:02 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: coding changed + +r455 2007-08-09 17:19:29 +0200 mjk: + + * doc/, doc/english/, doc/english/guide-english.tex: improved by GH + +r454 2007-08-09 17:13:37 +0200 mjk: + + * doc/, doc/english/, doc/english/scrdatetime.tex: encoding info + changed + +r453 2007-08-09 17:08:00 +0200 mjk: + + * doc/, doc/english/, doc/english/scrpage2.tex: improved by GH + +r452 2007-08-07 13:22:59 +0200 mjk: + + * doc/, doc/german/, doc/german/scrlfile.tex, doc/english/, + doc/english/scrlfile.tex: german version extended to english version + +r451 2007-08-07 13:14:42 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlfile.tex: improved by Gernot + Hassenpflug + +r450 2007-08-07 12:54:26 +0200 mjk: + + * doc/, doc/english/, doc/english/scrdatetime.tex: improved by Gernot + Hassenpflug + +r449 2007-08-07 12:44:15 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: overfull change + +r448 2007-08-07 12:41:56 +0200 mjk: + + * doc/, doc/english/, doc/english/scraddr.tex: two fixes + +r447 2007-08-07 12:28:04 +0200 mjk: + + * doc/, doc/english/, doc/english/scraddr.tex: improved by Gernot + Hassenpflug + +r446 2007-08-07 12:12:25 +0200 mjk: + + * doc/, doc/english/, doc/english/adrconvnote.tex: improved by Gernot + Hassenpflug + +r445 2007-07-30 11:49:20 +0200 mjk: + + * tocstyle.dtx: loading redefines \@starttoc, \@starttoc redefines + \@dottedtocline and \l@..., \@dottedtocline redefines \numberline + +r444 2007-07-30 10:55:56 +0200 mjk: + + * tocstyle.dtx: all options renamed + +r443 2007-07-26 11:22:41 +0200 mjk: + + * tocstyle.dtx: Checksum and one \z --> \z@ + +r442 2007-07-25 09:41:22 +0200 mjk: + + * scrkvers.dtx: prepared for 2.97c BETA + +r441 2007-07-24 11:37:42 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: smib GH + +r440 2007-07-24 10:53:54 +0200 mjk: + + * doc/, doc/german/, doc/german/scrbookreportarticle.tex, + doc/english/, doc/english/scrbookreportarticle.tex: mib GH and MK + +r439 2007-07-23 11:12:39 +0200 mjk: + + * scrpage.dtx: a lot of % added and removed + +r438 2007-07-23 09:33:21 +0200 mjk: + + * tocstyle.dtx: \l@part uses level -1 at chapter classes and 0 at no + chapter classes + +r437 2007-07-23 09:27:58 +0200 mjk: + + * scrksect.dtx: revert to: \partlevel is -1 at chapter classes and 0 + at no chapter classes + +r436 2007-07-23 09:21:31 +0200 mjk: + + * scrpage.dtx: revert to: \partlevel is -1 at chapter classes and 0 at + no chapter classes + +r435 2007-07-23 09:02:33 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: smib GH + +r434 2007-07-22 10:58:23 +0200 mjk: + + * doc/, doc/german/, doc/german/scrbookreportarticle.tex: Typofix + [Gernot Hassenpflug] + +r433 2007-07-22 10:57:05 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: some more + improvements by Gernot Hassenpflug + +r432 2007-07-21 09:48:15 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: some more + improvements by Gernot Hassenpflug + +r431 2007-07-19 15:27:54 +0200 mjk: + + * scrkplen.dtx: \useplength may be used with factor prefix (e.g. + .5\useplength{firstheadwidth}) + +r430 2007-07-18 09:44:04 +0200 mjk: + + * scrkpage.dtx, scrktare.dtx, scrkmisc.dtx: The classes and + typearea.sty allow to set option twoside to a new value at the + document's body. + +r429 2007-07-18 09:12:39 +0200 mjk: + + * scrkpage.dtx: change: the classes should tolerate late changes of + option twoside + +r428 2007-07-17 18:59:20 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: one more + change by Gernot Hassenpflug + +r427 2007-07-16 14:44:41 +0200 mjk: + + * scrksect.dtx: several \nobreak after \sectfont added + +r426 2007-07-14 07:52:26 +0200 mjk: + + * TODO: new feature + +r425 2007-07-10 17:20:29 +0200 mjk: + + * scrkfont.dtx, scrkbase.dtx: \l@addto@macro moved to scrkbase + +r424 2007-07-10 10:29:58 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: many + improvements by Gernot Hassenpflug + +r423 2007-07-10 10:15:02 +0200 mjk: + + * doc/, doc/german/, doc/german/scrbookreportarticle.tex: einige + Fehler korrigiert [Gernot Hassenpflug] + +r422 2007-07-06 16:09:52 +0200 mjk: + + * TODO, scrknpap.dtx: new values for option subject: underlined, + left, right, centered + +r421 2007-07-06 15:33:02 +0200 mjk: + + * TODO: new font elements + +r420 2007-07-06 15:04:14 +0200 mjk: + + * scrknpap.dtx: new font elements: specialmail, addressee, toname, + toaddress, and internal use of \specialmail@format. + +r419 2007-07-06 12:24:58 +0200 mjk: + + * tocstyle.dtx: version and date fixed + +r418 2007-07-06 12:24:27 +0200 mjk: + + * tocstyle.dtx: more user documentation + +r417 2007-07-06 11:59:05 +0200 mjk: + + * tocstyle.dtx: two macros renamed and documentation added + +r416 2007-07-06 11:46:38 +0200 mjk: + + * tocstyle.dtx: - you may deactivate tocstyle for all or single tocs + now - some documentation added + +r415 2007-07-06 10:03:31 +0200 mjk: + + * scrpage.dtx: fix: \partlevel is always -1 even if no chapter level + is available + +r414 2007-07-06 09:57:57 +0200 mjk: + + * doc/, doc/german/, doc/german/scrbookreportarticle.tex, + doc/english/, doc/english/scrbookreportarticle.tex: secnumdepth fixed + +r413 2007-07-06 09:56:01 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: lots of + improvements and new translations by Gernot Hassenpflug + +r412 2007-07-06 09:52:07 +0200 mjk: + + * doc/, doc/german/, doc/german/scrbookreportarticle.tex: Bei scrartcl + haben die Gliederungsebenen dieselben Nummern wie bei scrbook und + scrreprt. + +r411 2007-07-06 09:17:18 +0200 mjk: + + * doc/, doc/german/, doc/german/scrbookreportarticle.tex: typo fix + [Gernot Hassenpflug] + +r410 2007-07-05 18:56:09 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: several + improvements by our famous translator Gernot Hassenpflug + +r409 2007-07-04 17:16:12 +0200 mjk: + + * scrkfont.dtx, scrktare.dtx: initialize more font size dependent + lengths + +r408 2007-07-02 18:15:54 +0200 mjk: + + * tocstyle.dtx: fix: use depth 0 at \l@chapter + +r406 2007-07-02 10:11:25 +0200 mjk: + + * tocstyle.dtx: new package, that may be used outside KOMA-Script, too + +r405 2007-06-28 17:57:23 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: lots of + modifications by Gernot Hassenpflug + +r404 2007-06-27 08:28:01 +0200 mjk: + + * TODO: new feature + +r399 2007-06-21 13:20:21 +0200 mjk: + + * scrksect.dtx: \l@chapter and \l@section reimplemented to make + \raggedchapterentry and \raggedsectionentry work + +r398 2007-06-21 11:07:34 +0200 mjk: + + * doc/, doc/german/, doc/german/guide-ngerman.tex: tex-master changed + +r397 2007-06-21 11:06:08 +0200 mjk: + + * scrksect.dtx, TODO: new font elements: partentry, + partentrypagenumber, chapterentry, chapterentrypagenumber, + sectionentry, sectionentrypagenumber + +r396 2007-06-21 10:55:34 +0200 mjk: + + * scrpage.dtx: \if@mainmatter test fixed + +r395 2007-06-20 11:10:51 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: Date fixed + +r394 2007-06-20 11:10:25 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: serveral + improvement by Gernot Hassenpflug + +r393 2007-06-20 10:53:58 +0200 mjk: + + * scrkbase.dtx: renamed \scr@ifvtex to \scr@ifVTeX and \ifvtex to + \ifVTeX + +r392 2007-06-20 10:21:09 +0200 mjk: + + * scrkfont.dtx, scrkbase.dtx, scrktare.dtx, scrkcomp.dtx: + \scr@ifundefined renamed to \scr@ifundefinedorrelax, \ifundefined + renamed to \ifundefinedorrelax + +r391 2007-06-20 09:28:05 +0200 mjk: + + * scrktitl.dtx, TODO: new title command \subtitle with font element + subtitle + +r390 2007-06-14 09:56:35 +0200 mjk: + + * scrpage.dtx: more robust definition of \if@mainmatter and support of + article classes with \if@mainmatter + +r389 2007-06-06 09:32:40 +0200 mjk: + + * doc/, doc/german/, doc/german/scrbookreportarticle.tex: "Es wird + auch kein zusätzlicher vertikaler Abstand vor und nach der Umgebung + eingefügt." added at declaration of addmargin + +r388 2007-06-06 09:28:51 +0200 mjk: + + * scrkfloa.dtx: vertical alignment of captions fixed by adding + \unskip\strut + +r387 2007-06-06 08:40:10 +0200 mjk: + + * doc/, doc/german/, doc/german/guide-ngerman.tex: more hyphenations + [Stephan Hennig] + +r386 2007-06-05 09:03:45 +0200 mjk: + + * doc/, doc/german/, doc/german/guide-ngerman.tex: one more + hyphenation [Stephan Hennig] + +r385 2007-05-31 10:33:27 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: many + corrections by Gernot Hassenpflug + +r384 2007-05-30 15:26:34 +0200 mjk: + + * TODO: Noch zwei Dinge zu tun + +r383 2007-05-30 15:24:01 +0200 mjk: + + * doc/, doc/english/, doc/english/scrlttr2.tex: two references fixed + (Stephan Hennig) + +r382 2007-05-29 16:59:52 +0200 mjk: + + * doc/, doc/german/, doc/german/scrbookreportarticle.tex: scrlettr --> + scrlttr2 + +r381 2007-05-29 16:57:50 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: scrrprt + --> scrreprt + +r380 2007-05-29 16:56:36 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: many + corrections and new translations by Gernot Hassenpflug + +r379 2007-05-28 14:53:53 +0200 mjk: + + * doc/, doc/english/, doc/english/typearea.tex: many corrections by + Gernot Hassenpflug, new file date, some more fixes + +r378 2007-05-28 12:13:28 +0200 mjk: + + * scrkvers.dtx: prepared for new 2.97c BETA + +r377 2007-05-28 12:11:20 +0200 mjk: + + * scrkfont.dtx: fix: use of \KOMA@UseObsolete replaced + +r376 2007-05-25 12:19:59 +0200 mjk: + + * doc/, doc/english/, doc/english/scrbookreportarticle.tex: typo fix + [reported by Beat Birkofer] + +r375 2007-05-22 17:39:37 +0200 mjk: + + * doc/, doc/german/, doc/german/scrbookreportarticle.tex: fix: one + \KOMAoption --> \KOMAoptions + +r374 2007-05-17 10:30:34 +0200 mjk: + + * scrknpap.dtx: file date fixed + +r373 2007-05-17 10:30:11 +0200 mjk: + + * scrknpap.dtx: new: \flushbottom uses \stopletter to deactivate + itself at the last page + +r372 2007-05-14 18:30:12 +0200 mjk: + + * scrknpap.dtx: new: font elements "refname" and "refvalue" + +r371 2007-05-12 18:20:38 +0200 mjk: + + * scrkcomp.dtx: checksum fixed + +r370 2007-05-12 18:04:15 +0200 mjk: + + * scrkvers.dtx, scrkcomp.dtx: prepared for 2.97c BETA + +r369 2007-05-08 11:56:13 +0200 mjk: + + * TODO: new features + +r368 2007-05-08 11:18:59 +0200 mjk: + + * scrknpap.dtx: font (color) and thickness of foldmarks and fromrule + configurable using font elements "foldmark" and "fromrule" and + pseudo lengths "foldmarkthickness" and "fromrulethickness" + +r367 2007-04-19 17:15:07 +0200 mjk: + + * scrkbase.dtx, scrkpage.dtx, scrktare.dtx, scrkmisc.dtx: New + implementation of option execution + +r366 2007-04-17 09:33:44 +0200 mjk: + + * scrkbase.dtx: - changed: message text about obsolete options etc. + +r365 2007-03-30 12:56:32 +0200 mjk: + + * scrknpap.dtx: `locfield=narrow' and `locfield=wide' fixed + +r364 2007-03-25 11:13:12 +0200 mjk: + + * scrkvers.dtx: Pepared for new BETA + +r363 2007-03-25 11:12:55 +0200 mjk: + + * releaselist.txt: Release 2007/03/25 v2.97b + +r362 2007-03-25 10:48:11 +0200 mjk: + + * scrkvers.dtx, scrkcomp.dtx: prepared for release 2.97b + +r361 2007-03-09 15:22:09 +0100 mjk: + + * scrksect.dtx: bug at \@@makechapterhead using chapterprefix fixed + +r360 2007-03-08 11:49:23 +0100 mjk: + + * scrkbase.dtx: use of \ifcsname for definition of \scr@ifundefined + fixed + +r359 2007-03-07 11:07:50 +0100 mjk: + + * scrkvers.dtx: prepared for new BETA + +r358 2007-03-07 11:07:29 +0100 mjk: + + * releaselist.txt: Release 2007/03/07 v2.97a + r357 2007-03-07 10:47:26 +0100 mjk: * Makefile: renamed komascript-texmf.zip to komascript.tds.zip diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/adrconvnote.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/adrconvnote.tex index 4e05274f219..07273965b18 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/adrconvnote.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/adrconvnote.tex @@ -40,27 +40,29 @@ % % ---------------------------------------------------------------------- % -% Kapitel über adrconv in der KOMA-Script-Anleitung -% Verwaltet von Jens-Uwe Morawski (mit Unterstützung von Markus Kohm) +% Kapitel ueber adrconv in der KOMA-Script-Anleitung +% Verwaltet von Jens-Uwe Morawski (mit Unterstuetzung von Markus Kohm) % % ====================================================================== -\ProvidesFile{adrconvnote.tex}[{2005/11/27 KOMA-Script guide (chapter: - adrconv)}] +\ProvidesFile{adrconvnote.tex}[2007/09/27 KOMA-Script guide (chapter: + adrconv)] +\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm} + % Date of translated german file: 2005/08/10 \chapter{Creating Address Files from a Address Database}% \labelbase{addrconv}% -\index{address file}% -\index{address database}% +\Index{address>file}% +\Index{address>database}% \IndexPackage{addrconv} -In former versions of \KOMAScript{} the package \Package{addrconv} was a -permanent part of the \KOMAScript{} sytem. The chief involvment with -\KOMAScript{} was that with the help of \Package{addrconv} it was possible to -create address files from a address database in \BibTeX{} format. Next the -address file could be used for the \KOMAScript{} letter class or with the -package \Package{scraddr}. +In former versions of {\KOMAScript} the package \Package{addrconv} was +a permanent part of the {\KOMAScript} system. The chief involvement +with {\KOMAScript} was that with the help of \Package{addrconv} it was +possible from an address database in {\BibTeX} format to create +address files compatible with the {\KOMAScript} letter class or with +the package \Package{scraddr}. \begin{lstlisting} @address{HMUS, @@ -76,21 +78,22 @@ package \Package{scraddr}. } \end{lstlisting} -From entries, as can be seen above, address files can be generated. For this -\Package{addrconv} employs \BibTeX{} and some \BibTeX{} styles. Additionally -there are some \LaTeX{} files which help to create various telephon and -address lists for printing. - -The package \Package{addrconv} was indeed a separate package, since besides -what is required for \KOMAScript{} it includes some interessting features -more. Therefore the package \Package{addrconv}, as announced in the previous -\KOMAScript{} release, is removed from the \KOMAScript{} system. +From entries such as that given above, address files can be generated. +For this \Package{addrconv} employs {\BibTeX} and various {\BibTeX} +styles. Additionally, there are some {\LaTeX} files which can help to +create various telephone and address lists for printing. -The package \Package{adrconv}, only one \emph{d}, replaces \Package{addrconv} -entirely. If it is not included in your \TeX{} distribution then it can be -downloaded from \cite{package:adrconv} and you can install it separately. +However, the package \Package{addrconv} was actually an independent +package, since besides what is required for {\KOMAScript} it includes +several more interesting features. Therefore, the package +\Package{addrconv} has for some time already been removed from the +{\KOMAScript} system. The package \Package{adrconv}, with a single +\emph{d}, entirely replaces \Package{addrconv}. If it is not included +in your {\TeX} distribution then it can be downloaded from +\cite{package:adrconv} and you can install it separately. %%% Local Variables: %%% mode: latex +%%% coding: latin-1 %%% TeX-master: "../guide" %%% End: diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex index 0f4892fb247..24d329185a0 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/guide-english.tex @@ -45,7 +45,7 @@ % % ====================================================================== % -\ProvidesFile{guide-english.tex}[{2006/05/10 +\ProvidesFile{guide-english.tex}[{2007/09/27 KOMA-Script guide language dependencies}] % % \section{Title} @@ -54,6 +54,7 @@ % \begin{macro}{\GuideTitle} % \begin{macro}{\GuideSubTitle} % \begin{macro}{\GuideAuthorHeadline} +% \begin{macro}{\GuideTranslatorHeadline} % \begin{macro}{\GuideWarrantyHeadline} % \begin{macro}{\GuideWarranty} % \begin{macro}{\GuideCopyright} @@ -62,27 +63,28 @@ % \begin{macrocode} \newcommand*{\GuideSubject}{The Guide}% \newcommand*{\GuideTitle}{\KOMAScript}% -\newcommand*{\GuideSubTitle}{a versatile \LaTeXe{} bundle}% -\newcommand*{\GuideAuthorHeadline}{Authors of the \KOMAScript{} Bundle}% +\newcommand*{\GuideSubTitle}{a versatile {\LaTeXe} bundle}% +\newcommand*{\GuideAuthorHeadline}{Authors of the {\KOMAScript} Bundle}% +\newcommand*{\GuideTranslatorHeadline}{English translation of this manual by: } \newcommand*{\GuideWarrantyHeadline}{Legal Notes:}% \newcommand*{\GuideWarranty}{There is no warranty for any part of the documented Software. The authors have taken care in the preparation of this book, but make no expressed or implied warranty of any kind and assume no responsibility for errors or omissions. No liability is assumed for incidental or consequential damages in connection with or arising out of the - use of the inromation or programs contained here.\par\medskip% + use of the information or programs contained here.\par\medskip% Many of the designations used by manufacturers and sellers to distinguish their products are claimed as trademarks. Where those designations appear in - this book, and the authors were aware ot a trademark claim, the designations + this book, and the authors were aware of a trademark claim, the designations have been printed with initial capital letters or in all capitals.}% \newcommand*{\GuideCopyright}{Free screen version without any optimization of paragraph and page breaks\par\medskip% - This guide is part of \KOMAScript{}, which is free under the terms and - conditions of LaTeX Project Public License Version 1.3b. A version of this - license, which is valid to \KOMAScript{}, is part of \KOMAScript{} (see + This guide is part of {\KOMAScript}, which is free under the terms and + conditions of {\LaTeX} Project Public License Version 1.3b. A version of this + license, which is valid to {\KOMAScript}, is part of {\KOMAScript} (see \File{lppl.txt}). Distribution of this manual\,---\,even if it is - printed\,---\,is allowed provided that all parts of \KOMAScript{} are - distributed. Distribution without the other parts of \KOMAScript{} needs a + printed\,---\,is allowed provided that all parts of {\KOMAScript} are + distributed. Distribution without the other parts of {\KOMAScript} needs a explicit, additional authorization by the authors.}% \newcommand*{\GuideDedication}{To All Friends of Typography!}% % \end{macrocode} @@ -201,7 +203,7 @@ % \begin{macro}{\GuidePseudoPrefix} % The prefix »pseudo« at the term »pseudo length« and the term itself. % \begin{macrocode} -\newcommand*{\GuidePseudoPrefix}{pseudo } +\newcommand*{\GuidePseudoPrefix}{pseudo-} \newcommand*{\GuidePLength}{\GuidePseudoPrefix\GuideLength} % \end{macrocode} % \end{macro} @@ -214,6 +216,20 @@ % \end{macrocode} % \end{macro} % +% \begin{macro}{\GuideAnd} +% The ``and'' at a list of two. +% \begin{macrocode} +\newcommand*{\GuideAnd}{ and } +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuideListAnd} +% The ``and'' at a list of more than two. +% \begin{macrocode} +\newcommand*{\GuideListAnd}{, and } +% \end{macrocode} +% \end{macro} +% % % \section{Index} % @@ -233,7 +249,7 @@ \newcommand*{\GuidecmdIndex}{Index of Commands, Environments, and Variables}% \newcommand*{\GuidecmdIndexShort}{Index of Commands etc.}% \newcommand*{\GuidelenIndex}{Index of Lengths and Counters}% -\newcommand*{\GuidelenIndexShort}{Index der Lengths etc.}% +\newcommand*{\GuidelenIndexShort}{Index of Lengths etc.}% \newcommand*{\GuideelmIndex}{Index of Elements with Capability of Font Adjustment}% \newcommand*{\GuideelmIndexShort}{Index of Elements}% @@ -272,10 +288,10 @@ from the main text. In many cases the reference points to documents or directories which can be accessed via Internet. In these cases the reference includes a URL instead of a publisher. If the reference points to - a \LaTeX{} package then the URL is written in the form + a {\LaTeX} package then the URL is written in the form ``\url{CTAN://}\emph{destination}''. The prefix ``\url{CTAN://}'' means the - \TeX{} archive on a CTAN server or mirror. For example, you can substitude - the prefix with \url{ftp://\GuideCTANserver/tex-archive/}. For \LaTeX{} + \TeX{} archive on a CTAN server or mirror. For example, you can substitute + the prefix with \url{ftp://\GuideCTANserver/tex-archive/}. For {\LaTeX} packages it is also important to mention that we have tried to give a version number appropriate to the text that cites the reference. But for some packages is is very difficult to find a consistent version number and @@ -295,7 +311,7 @@ % \begin{macrocode} \newcommand*{\GuideChangeLogPreamble}{% At this list of changes you will find all significant changes of the user - interface of the \KOMAScript{} bundle at the last few versions. The list was + interface of the {\KOMAScript} bundle at the last few versions. The list was sorted about the names of the classes and packages and their version. The numbers behind the versions are the pages, where the changes are described. At the margins of these pages you will find corresponding version @@ -332,7 +348,7 @@ \ifnum #1>49 system transforms in actual deeds. Head and eyes already react. - They follow the text, taking the informations present there + They follow the text, taking the information present there and transmit them via the optic nerve. \fi } @@ -420,5 +436,6 @@ \endinput %%% Local Variables: %%% mode: doctex +%%% coding: iso-latin-1 %%% TeX-master: "guide" %%% End: diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex index 107d05c9072..b865de9cb9f 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/introduction.tex @@ -37,18 +37,18 @@ % % Introduction of the KOMA-Script guide % Maintained by Markus Kohm -% Translation: Kevin Pfeiffer, Markus Kohm % % ---------------------------------------------------------------------- % % Einleitung der KOMA-Script-Anleitung % Verwaltet von Markus Kohm -% Übersetzung: Kevin Pfeiffer, Markus Kohm % % ====================================================================== -\ProvidesFile{introduction.tex}[2006/07/04 KOMA-Script guide introduction] -% Date of translated german file: 2006-07-01 +\ProvidesFile{introduction.tex}[2007/09/26 KOMA-Script guide introduction] +\translator{Kevin Pfeiffer\and Gernot Hassenpflug\and Markus Kohm} + +% Date of translated german file: 2006/07/05 \chapter{Introduction} \labelbase{introduction} @@ -56,34 +56,34 @@ \section{Preface}\label{sec:introduction.preface} The {\KOMAScript} bundle is actually several packages and classes. It -provides counterparts or replacements for the standard \LaTeX{} classes such +provides counterparts or replacements for the standard {\LaTeX} classes such as \emph{article}, \emph{book}, etc. (see \autoref{cha:maincls}), but offers many additional features and its own unique look and feel. -The \KOMAScript{} user guide is intended to serve the advanced as well as the -inexperienced \LaTeX{} user and is accordingly quite large. The result is a +The {\KOMAScript} user guide is intended to serve the advanced as well as the +inexperienced {\LaTeX} user and is accordingly quite large. The result is a compromise and we hope that you will keep this in mind when using it. Your suggestions for improvement are, of course, always welcome. \section{Structure of the Guide}\label{sec:introduction.structure} -The \KOMAScript{} user guide is not intended to be a \LaTeX{} primer. -Those new to \LaTeX{} should look at \emph{The Not So Short Introduction -to \LaTeXe{}} \cite{lshort} or \emph{\LaTeXe{} for Authors} -\cite{latex:usrguide} or a \LaTeX{} reference book. You will also find -useful information in the many \LaTeX{} FAQs, including the \emph{TeX +The {\KOMAScript} user guide is not intended to be a {\LaTeX} primer. +Those new to {\LaTeX} should look at \emph{The Not So Short Introduction +to {\LaTeXe}} \cite{lshort} or \emph{{\LaTeXe} for Authors} +\cite{latex:usrguide} or a {\LaTeX} reference book. You will also find +useful information in the many {\LaTeX} FAQs, including the \emph{{\TeX} Frequently Asked Questions on the Web} \cite{UK:FAQ}. \begin{Explain} - In this guide you will find supplemental information about \LaTeX{} and - \KOMAScript{} in (san serif) paragraphs like this one. + In this guide you will find supplemental information about {\LaTeX} and + {\KOMAScript} in (sans serif) paragraphs like this one. The information given in these explanatory sections is not essential for - using \KOMAScript{}, but if you experience problems you should - take a look at it -- particularly before sending a bug report. + using {\KOMAScript}, but if you experience problems you should + take a look at it\,---\,particularly before sending a bug report. \end{Explain} -If you are only interested in using a single \KOMAScript{} class or +If you are only interested in using a single {\KOMAScript} class or package you can probably successfully avoid reading the entire guide. Each class and package typically has its own chapter; however, the three main classes (\Class{scrbook}, \Class{scrrprt}, and \Class{scrartcl}) @@ -92,54 +92,55 @@ applies to one or two of the three classes, it is called out in the margin. \OnlyAt{\Class{Like this.}} \begin{Explain} - The primary documentation for \KOMAScript is in German and has been - translated for your convenience; like most of the \LaTeX{} world, its + The primary documentation for {\KOMAScript} is in German and has been + translated for your convenience; like most of the {\LaTeX} world, its commands, environments, options, etc., are in English. In a few cases, the name of a command may sound a little strange, but even so, we hope and - believe that with the help of this guide \KOMAScript{} will still be usable + believe that with the help of this guide {\KOMAScript} will be usable and useful to you. \end{Explain} -\section{History of \KOMAScript}\label{sec:introduction.history} +\section{History of {\KOMAScript}}\label{sec:introduction.history} In the early 1990s, Frank Neukam needed a method to publish an -instructor's lecture notes. At that time \LaTeX was \LaTeX2.09 and there -was no distinction between classes and packages -- there were only +instructor's lecture notes. At that time {\LaTeX} was {\LaTeX}2.09 and there +was no distinction between classes and packages\,---\,there were only \emph{styles}. Frank felt that the standard document styles were not good enough for his work; he wanted additional commands and environments. At the same time he was interested in typography and, after reading Tschichold's \emph{Ausgewählte Aufsätze über Fragen der Gestalt des Buches und der Typographie} (Selected Articles on the Problems of Book Design and Typography) \cite{JTsch87}, he decided to -write his own document style -- and not just a one-time solution to his +write his own document style\,---\,and not just a one-time solution to his lecture notes, but an entire style family, one specifically designed for -European and German typography. Thus \Script{} was born. +European and German typography. Thus {\Script} was born. -Markus Kohm, the developer of \KOMAScript{}, came across {\Script} in +Markus Kohm, the developer of {\KOMAScript}, came across {\Script} in December 1992 and added an option to use the A5 paper format. This and -other changes were then incorporated in to\ScriptII{}, released by Frank +other changes were then incorporated into {\ScriptII}, released by Frank in December 1993. -Beginning in mid-1994, \LaTeXe{} became available and brought with it -many changes. Users of \ScriptII{} were faced with either limiting their -usage to \LaTeXe{}'s compatibility mode or giving up \Script{} -altogether. This situation lead Markus to put together a new \LaTeXe{} -package, released on 7~July 1994 as \KOMAScript{}; a few months later -Frank declared \KOMAScript{} to be the official successor to \Script{}. -\KOMAScript{} originally provided no \emph{letter} class, but this +Beginning in mid-1994, {\LaTeXe} became available and brought with it +many changes. Users of {\ScriptII} were faced with either limiting their +usage to {\LaTeXe}'s compatibility mode or giving up {\Script} +altogether. This situation led Markus to put together a new {\LaTeXe} +package, released on 7~July 1994 as {\KOMAScript}; a few months later +Frank declared {\KOMAScript} to be the official successor to {\Script}. +{\KOMAScript} originally provided no \emph{letter} class, but this deficiency was soon remedied by Axel Kielhorn, and the result became part -of \KOMAScript{} in December 1994. Axel also wrote the first true +of {\KOMAScript} in December 1994. Axel also wrote the first true German-language user guide, which was followed by an English-language guide by Werner Lemberg. -Since then much time has passed. \LaTeX{} has changed in only minor ways, but -the \LaTeX{} lanscape has changed a great deal; many new packages and classes -are now available and \KOMAScript{} itself has grown far beyond what it was in -1994. The initial goal was to provide good \LaTeX classes for German-language -authors, but today its primary purpose is to provide more-flexible -alternatives to the standard classes. \KOMAScript{}'s success has lead to -e-mail from users all over the world and this has lead to many new macros -- all +Since then much time has passed. {\LaTeX} has changed in only minor +ways, but the {\LaTeX} landscape has changed a great deal; many new +packages and classes are now available and {\KOMAScript} itself has +grown far beyond what it was in 1994. The initial goal was to provide +good {\LaTeX} classes for German-language authors, but today its +primary purpose is to provide more-flexible alternatives to the +standard classes. {\KOMAScript}'s success has led to e-mail from users +all over the world, and this has led to many new macros\,---\,all needing documentation; hence this ``small guide.'' @@ -147,9 +148,9 @@ needing documentation; hence this ``small guide.'' Acknowledgements in the introduction? No, the proper acknowledgements can be found in the addendum. My comments here are not intended for the authors of -this guide -- and those thanks should rightly come from you, the reader, -anyhow. I, the author of \KOMAScript, would like to extend my personal thanks -to Frank Neukam. Without his \Script{} family, \KOMAScript{} would not have +this guide\,---\,and those thanks should rightly come from you, the reader, +anyhow. I, the author of {\KOMAScript}, would like to extend my personal thanks +to Frank Neukam. Without his {\Script} family, {\KOMAScript} would not have come about. I am indebted to the many persons who have contributed to {\KOMAScript}, but with their indulgence, I would like to specifically mention Jens-Uwe Morawski and Torsten Kr\"uger. The English translation of the guide @@ -160,11 +161,11 @@ encouraged me to go on, to make things better and less error-prone, or to implement additional features. Thanks go as well to DANTE, Deutschsprachige -Anwendervereinigung \TeX~e.V\kern-.18em, (the German-Language TeX User Group). -Without the DANTE server, \KOMAScript{} could not have been released and -distributed. Thanks as well to everybody in the \TeX{} newsgroups and mailing +Anwendervereinigung {\TeX}~e.V\kern-.18em, (the German-Language {\TeX} User Group). +Without the DANTE server, {\KOMAScript} could not have been released and +distributed. Thanks as well to everybody in the {\TeX} newsgroups and mailing lists who answer questions and have helped me to provide support for -\KOMAScript{}. +{\KOMAScript}. \section{Legal Notes}\label{sec:introduction.legal} @@ -173,36 +174,36 @@ will find it in the file \File{lppl.txt}. An unofficial German-language translation is also available in \File{lppl-de.txt} and is valid for all German-speaking countries. -\iffree{This document and the \KOMAScript{} bundle are provided ``as is'' and +\iffree{This document and the {\KOMAScript} bundle are provided ``as is'' and without warranty of any kind.}% {Please note: the printed version of this guide is not free under the -conditions of the LaTeX{} Project Public Licence. If you need a free version -of this guide, use the version that is provided as part of the \KOMAScript{} +conditions of the {\LaTeX} Project Public Licence. If you need a free version +of this guide, use the version that is provided as part of the {\KOMAScript} bundle.} \section{Installation}\label{sec:introduction.installation} Installation information can be found in the file \File{INSTALL.txt}. You -should also read the documentation that comes with the \TeX{} distribution you +should also read the documentation that comes with the {\TeX} distribution you are using. \section{Bugreports and Other Requests} \label{sec:introduction.errors} If you think you have found an error in the documentation or a bug in one of -the \KOMAScript{} classes, one of the \KOMAScript{} packages, or another -part of \KOMAScript{}, please do the following: first have a look at -CTAN to see if a newer version of \KOMAScript{} is available; in this case +the {\KOMAScript} classes, one of the {\KOMAScript} packages, or another +part of {\KOMAScript}, please do the following: first have a look on +CTAN to see if a newer version of {\KOMAScript} is available; in this case install the applicable section and try again. -If you are using the most recent version of \KOMAScript and still have a -bug, please provide a short \LaTeX{} document that demonstrates the problem. You +If you are using the most recent version of {\KOMAScript} and still have a +bug, please provide a short {\LaTeX} document that demonstrates the problem. You should only use the packages and definitions needed to demonstrate the problem; do not use any unusual packages. By preparing such an example it often becomes clear whether the problem is -truly a \KOMAScript{} bug or something else. Please report \KOMAScript{} (only) -bugs to the author of \KOMAScript{}. Please use \File{komabug.tex}, an -interactive \LaTeX{} document, to generate your bug report and send it to the +truly a {\KOMAScript} bug or something else. Please report {\KOMAScript} (only) +bugs to the author of {\KOMAScript}. Please use \File{komabug.tex}, an +interactive {\LaTeX} document, to generate your bug report and send it to the address you may find at \File{komabug.tex}. If you want to ask your question in a newsgroup or mailing list, you @@ -212,17 +213,18 @@ numbers of all packages in use, simply put \Macro{listfiles} in the preamble of your example and read the end of the \File{log}-file. -\section{Additional Informations} +\section{Additional Information} \label{sec:introduction.moreinfos} -Once you become an experienced \KOMAScript{} user you may want to look at some +Once you become an experienced {\KOMAScript} user you may want to look at some more advanced examples and information. These you will find on the -\KOMAScript{} documentation web site \cite{homepage}. The main +{\KOMAScript} documentation web site \cite{homepage}. The main language of the site is German, but nevertheless English is welcome. \endinput %%% Local Variables: %%% mode: latex +%%% coding: iso-latin-1 %%% TeX-master: "../guide.tex" %%% End: diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex index b96d6c69320..b1d03f6f975 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scraddr.tex @@ -40,53 +40,68 @@ % % ---------------------------------------------------------------------- % -% Kapitel über scraddr in der KOMA-Script-Anleitung -% Verwaltet von Jens-Uwe Morawski (mit Unterstützung von Markus Kohm) +% Kapitel ueber scraddr in der KOMA-Script-Anleitung +% Verwaltet von Jens-Uwe Morawski (mit Unterstuetzung von Markus Kohm) % % ====================================================================== -\ProvidesFile{scraddr.tex}[2005/11/27 KOMA-Script guide (chapter: scraddr)] -% Date of translated german file: 2002/10/15 +\ProvidesFile{scraddr.tex}[2007/09/27 KOMA-Script guide (chapter: scraddr)] +\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm} + +% Date of translated german file: 2005/08/10 \chapter{Access to Address Files with \Package{scraddr}}% \labelbase{scraddr}% \BeginIndex{Package}{scraddr} \section{Overview}\label{sec:scraddr.overview} -The package \Package{scraddr} is a small extension to -the \KOMAScript{} letter class. -Its aim is to make access to the data of address files -more flexible and easier. -Basically the package implements a new loading mechanism -for address files, which contain address entries of the kind -described in the previous chapter. +The package \Package{scraddr} is a small extension to the +{\KOMAScript} letter class. Its aim is to make access to the data of +address files more flexible and easier. Basically, the package +implements a new loading mechanism for address files which contain +address entries in the form of \Macro{adrentry} and newer +\Macro{addrentry} commands, as described in the previous chapter. \begin{Declaration} \Macro{InputAddressFile}\Parameter{file name} \end{Declaration}% \BeginIndex{Cmd}{InputAddressFile}% % -The command \Macro{InputAddressFile} reads the content -of the address file, given as its parameter. -If the file does not exist the command returns an -error message. +The command \Macro{InputAddressFile} is the main command of the +\Package{scraddr}, and reads the content of the address +file\Index{address>file} given as its parameter. If the file does not +exist the command returns an error message. -For every entry in the address file the command generates a -set of macros for accessing the data. -First a short reminder of how an address entry is structured. +For every entry in the address file the command generates a set of +macros for accessing the data. For large address files this will take +a lot of {\TeX} memory. \begin{Declaration}% \Macro{adrentry}\Parameter{Lastname}\Parameter{Firstname}% - \Parameter{Address}\Parameter{Telephone}\Parameter{F1}\Parameter{F2}% + \Parameter{Address}\Parameter{Phone}\Parameter{F1}\Parameter{F2}% \Parameter{Comment}\Parameter{Key}\\ + % \Macro{addrentry}\Parameter{Lastname}\Parameter{Firstname}% - \Parameter{Address}\Parameter{Telephone}\Parameter{F1}\Parameter{F2}% - \Parameter{F3}\Parameter{F4}\Parameter{Key} + \Parameter{Address}\Parameter{Phone}\Parameter{F1}\Parameter{F2}% + \Parameter{F3}\Parameter{F4}\Parameter{Key}\\ + % + \Macro{adrchar}\Parameter{initial}\\ + \Macro{addrchar}\Parameter{initial}% \end{Declaration}% -The last parameter is the identifier of an entry, thus the -\PName{Key} has to be unique and not blank. If the file contains more -than one entry with the same \PName{Key} value, the last occurrence -will be used. The \PName{Key} should only be composed of letters. +\IndexCmd{adrentry}% +\IndexCmd{addrentry}% +\IndexCmd{adrchar}% +\IndexCmd{addrchar}% + +The structure of the address entries in the address file was discussed +in detail in \autoref{sec:scrlttr2.addressFile} from +\autopageref{desc:scrlttr2.macro.adrentry} onwards. The division of +the address file with the help of \Macro{adrchar} or \Macro{addrchar}, +also discussed therein, has no meaning for \Package{scraddr} and is +simply ignored. + +The commands for accessing the data are given by the name of the data +field they are intended for. \begin{Declaration} \Macro{Name}\Parameter{Key}\\ \Macro{FirstName}\Parameter{Key}\\ @@ -104,13 +119,16 @@ will be used. The \PName{Key} should only be composed of letters. \BeginIndex{Cmd}{FreeII}\BeginIndex{Cmd}{FreeIII}\BeginIndex{Cmd}{FreeIV}% \BeginIndex{Cmd}{Comment}% % -These commands give access to data of your address file. -The parameter \PName{Key} is the same as in the -\Macro{adrentry} or \Macro{addrentry} command. -In the address of letters often both, first-name and -last-name, are required. -The command \Macro{Name}\PParameter{Key} is an abridgement for -\Macro{FirstName}\PParameter{Key} \Macro{LastName}\PParameter{Key}. + +These commands give access to data of your address file. The last +parameter, i.\,e., parameter 8 for the \Macro{adrentry} entry and +parameter 9 for the \Macro{addrentry} entry, is the identifier of an +entry, thus the \PName{Key} has to be unique and non-blank. The +\PName{Key} should only be composed of letters. + +If the file contains more than one entry with the same \PName{Key} +value, the last occurrence will be used. + \EndIndex{Cmd}{InputAddressFile}% \EndIndex{Cmd}{Name}\EndIndex{Cmd}{FirstName}\EndIndex{Cmd}{LastName}% @@ -120,9 +138,9 @@ The command \Macro{Name}\PParameter{Key} is an abridgement for \section{Usage}\label{sec:scraddr.usage} -First of all, we need an address file with valid address entries. -In this example the file has the name \emph{lotr.adr} and contains -the following entries. +First of all, we need an address file with valid address entries. In +this example the file has the name \File{lotr.adr} and contains the +following entries. \begin{lstlisting} \addrentry{Baggins}{Frodo}% {The Hill\\ Bag End/Hobbiton in the Shire}{}% @@ -138,36 +156,31 @@ the following entries. {The Master of Wood, Water and Hill}{TOM} \end{lstlisting} -The 4\textsuperscript{th} parameter, the telephone number, has been left -blank. If you know the story behind these addresses you -will agree that a telephone number makes no sense here. -The command \Macro{InputAddressFile} is used to load -the address file shown above. +The 4\textsuperscript{th} parameter, the telephone number, has been +left blank. If you know the story behind these addresses you will +agree that a telephone number makes no sense here, and besides, it +should simply be possible to leave them out. The command +\Macro{InputAddressFile} is used to load the address file shown above: \begin{lstlisting} \InputAddressFile{lotr} \end{lstlisting} -With the help of the commands introduced in this chapter -we can now write a letter to the old \textsc{Tom Bombadil}. -In this letter we ask him, if he can remember two -fellow-travelers from Elder Days. +With the help of the commands introduced in this chapter we can now +write a letter to old \textsc{Tom Bombadil}. In this letter we ask +him if he can remember two fellow-travelers from Elder Days. \begin{lstlisting} \begin{letter}{\Name{TOM}\\\Address{TOM}} \opening{Dear \FirstName{TOM} \LastName{TOM},} - or \FreeIII{TOM}, how your delightful \FreeI{TOM} calls - you. - Can you remember Mr.\,\LastName{FRODO}, - strictly speaking \Name{FRODO}, since there was - Mr.\,\FreeI{FRODO} too. - He was \Comment{FRODO} in the Third Age - and \FreeIV{FRODO} - \Name{SAM}, \Comment{SAM}, has attended him. + or \FreeIII{TOM}, how your delightful \FreeI{TOM} calls you. Can + you remember Mr.\,\LastName{FRODO}, strictly speaking + \Name{FRODO}, since there was Mr.\,\FreeI{FRODO} too. He was + \Comment{FRODO} in the Third Age and \FreeIV{FRODO} \Name{SAM}, + \Comment{SAM}, has attended him. - Their pasions were very wordly. - \FirstName{FRODO} enjoyed to smoke \FreeII{FRODO}, - his attendant has appreciate a good meal with + Their passions were very worldly. \FirstName{FRODO} enjoyed + smoking \FreeII{FRODO}, his attendant appreciated a good meal with \FreeII{SAM}. Do you remember? Certainly Mithrandir has told you much @@ -178,28 +191,29 @@ fellow-travelers from Elder Days. and the leaves' laughter!''} \end{letter} \end{lstlisting} -The 5\textsuperscript{th} and 6\textsuperscript{th} parameter of the -\Macro{adrentry} or \Macro{adrentry} command are for free use. They are -accessible with the commands \Macro{FreeI} and \Macro{FreeII}. In this -example the 5\textsuperscript{th} parameter contains the name of a person who -is the most important in the life of the entry's person, the -6\textsuperscript{th} contains the person's passion. The +In the address of letters often both firstname and lastname are +required. Thus, the command \Macro{Name}\PParameter{Key} is an +abridgement for \Macro{FirstName}\PParameter{Key} +\Macro{LastName}\PParameter{Key}. + +The 5\textsuperscript{th} and 6\textsuperscript{th} parameters of the +\Macro{adrentry} or \Macro{adrentry} commands are for free use. They +are accessible with the commands \Macro{FreeI} and \Macro{FreeII}. In +this example, the 5\textsuperscript{th} parameter contains the name of +a person who is the most important in the life of the entry's person, +the 6\textsuperscript{th} contains the person's passion. The 7\textsuperscript{th} parameter is a comment or in general also a free -parameter. The commands \Macro{Comment} or \Macro{FreeIII} give access to the -data. Using \Macro{FreeIV} is only valid for \Macro{addrentry} entries; for -\Macro{adrentry} entries it results in a warning. +parameter. The commands \Macro{Comment} or \Macro{FreeIII} give access +to this data. Use of \Macro{FreeIV} is only valid for +\Macro{addrentry} entries; for \Macro{adrentry} entries it results in +an error. More on this is covered in the next section. \EndIndex{Package}{scraddr} \section{Package Warning Options} -As mentioned above the command \Macro{FreeIV} leads -to a fault if it is used for \Macro{adrentry} entries. - -Therefore \Package{scraddr} supports package options -in order to give the user the possibility to -choose how the package should react in such situation. -It is possible to choose different settings between -\emph{ignore} and \emph{rupture} of the \LaTeX{} run. +As mentioned above, the command \Macro{FreeIV} leads to an error if it +is used for \Macro{adrentry} entries. How \Package{scraddr} reacts in +such a situation is decide by package options. \begin{Declaration} \Option{adrFreeIVempty}\\ @@ -211,9 +225,9 @@ It is possible to choose different settings between \BeginIndex{Option}{adrFreeIVempty}\BeginIndex{Option}{adrFreeIVshow} \BeginIndex{Option}{adrFreeIVwarn}\BeginIndex{Option}{adrFreeIVstop} % -One of these options can be given in the optional argument -of the \Macro{usepackage} command. The default setting is -\Option{adrFreeIVshow}. +These four options allow the user to choose between \emph{ignore} and +\emph{rupture} during the {\LaTeX} run if \Macro{FreeIV} has been used +with an \Macro{adrentry} entry. \begin{labeling}[\,--]{\Option{adrFreeIVempty}} \item[\Option{adrFreeIVempty}] @@ -222,14 +236,20 @@ of the \Macro{usepackage} command. The default setting is ``(entry FreeIV undefined at \PName{Key})'' will be written as warning in the text \item[\Option{adrFreeIVwarn}] - writes a warning in the log-file + writes a warning in the logfile \item[\Option{adrFreeIVstop}] - the \LaTeX{} run will be interrupted with an error message + the {\LaTeX} run will be interrupted with an error message \end{labeling} +To choose the desired reaction, one of these options can be given in +the optional argument of the \Macro{usepackage} command. The default +setting is \Option{adrFreeIVshow}. +% \EndIndex{Option}{adrFreeIVempty}\EndIndex{Option}{adrFreeIVshow} \EndIndex{Option}{adrFreeIVwarn}\EndIndex{Option}{adrFreeIVstop} + %%% Local Variables: %%% mode: latex +%%% coding: iso-latin-1 %%% TeX-master: "../guide" %%% End: diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex index 263b3c74128..f1115446cce 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrbookreportarticle.tex @@ -40,22 +40,22 @@ % % ---------------------------------------------------------------------- % -% Kapitel über scrbook, scrreprt und scrartcl in der KOMA-Script-Anleitung +% Kapitel über scrbook, scrreprt und scrartcl in der KOMA-Script-Anleitung % Verwaltet von Markus Kohm % % ============================================================================ -\ProvidesFile{scrbookreportarticle.tex}[2007/01/09 KOMA-Script guide (chapter: +\ProvidesFile{scrbookreportarticle.tex}[2007/09/27 KOMA-Script guide (chapter: scrbook, scrreprt, scrartcl)] -% Date of translated german file: 2005-11-26 +\translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm} -% TODO: See further TODO comments +% Date of translated german file: 2007-09-04 -\chapter{The Main Classes \Class{scrbook}, \Class{scrrprt} and +\chapter{The Main Classes \Class{scrbook}, \Class{scrreprt} and \Class{scrartcl}} \labelbase{maincls} -\AddSeeIndex{command}{gen}{\GuidecmdIndexShort}{cmd} +%\AddSeeIndex{command}{gen}{\GuidecmdIndexShort}{cmd}% <-- set automaticly \AddSeeIndex{macro}{gen}{\GuidecmdIndexShort}{cmd}% \begin{Explain} @@ -65,40 +65,40 @@ scrbook, scrreprt, scrartcl)] classes \Class{book}\IndexClass{book}, \Class{report}\IndexClass{report} and \Class{article}\IndexClass{article}. There is also a replacement for - the standard class \Class{letter}\IndexClass{letter}. The - document class for letters is described in a separate chapter, - because it is fundamentally different from the three main classes - (see \autoref{cha:scrlttr2}).The names of the {\KOMAScript} - classes are composed of the prefix "\texttt{scr}" and the - abbreviated name of the corresponding standard class. In order to - restrict the length of the names to eight letters, the vowels, - starting with the last one, are left off if necessary. The - \autoref{tab:maincls.overview} shows an overview. The table also - includes the names of the \LaTeX2.09 style files that were used in - {\KOMAScript}. + the standard class \Class{letter}\IndexClass{letter}. The document + class for letters is described in a separate chapter, because it is + fundamentally different from the three main classes (see + \autoref{cha:scrlttr2}).The names of the {\KOMAScript} classes are + composed of the prefix ``\texttt{scr}'' and the abbreviated name of + the corresponding standard class. In order to restrict the length of + the names to eight letters, the vowels, starting with the last one, + are left off as necessary. The \autoref{tab:maincls.overview} shows + an overview of the correspondence between the standard classes and + the {\KOMAScript} classes. \end{Explain} -The simplest way to use a \KOMAScript-class instead of a standard one -is to substitute the class name in the \verb|\documentclass| command -according to \autoref{tab:maincls.overview}. Normally the document -should be processed without errors by \LaTeX{}, just like before the -substitution. The look however should be different. Additionally, the -\KOMAScript{} classes provide new possibilities and options that are -described in the following sections. +The simplest way to use a {\KOMAScript} class instead of a standard +one is to substitute the class name in the \verb|\documentclass| +command according to \autoref{tab:maincls.overview}. Normally, the +document should be processed without errors by {\LaTeX}, just like +before the substitution. The look however should be +different. Additionally, the {\KOMAScript} classes provide new +possibilities and options that are described in the following +sections. \begin{table}[htbp] \centering \caption[Class correspondence]{Correspondence between - standard classes, \KOMAScript{} classes and + standard classes, {\KOMAScript} classes and \Script{} styles.} \begin{tabular}{ll} \toprule - standard class & \KOMAScript{} class \\%& \Script-Stil (\LaTeX2.09)\\ + standard class & {\KOMAScript} class \\%& \Script-Stil (\LaTeX2.09)\\ \midrule \Class{article} & \Class{scrartcl} \\%& \File{script\textunderscore s} \\ \Class{report} & \Class{scrreprt} \\%& \File{script} \\ \Class{book} & \Class{scrbook} \\%& \File{script} \\ - \Class{letter} & \Class{scrlettr} \\%& \File{script\textunderscore l} \\ + \Class{letter} & \Class{scrlttr2} \\%& \File{script\textunderscore l} \\ \bottomrule \end{tabular} \label{tab:maincls.overview} @@ -124,7 +124,7 @@ set, either by default or by the user. \begin{table}[htbp] \centering - \caption{Default options of the \KOMAScript{} classes} + \caption{Default options of the {\KOMAScript} classes} \begin{tabular}{llll} Option & \Class{scrbook} & \Class{scrreprt} & \Class{scrartcl} \\ @@ -137,6 +137,8 @@ set, either by default or by the user. \emph{undefined} & default & default \\ \Option{bigheadings} & default & default & default \\ + \Option{chapteratlists=} & + \PValue10{pt} & \PValue{10pt} & \emph{undefined} \\ \Option{final} & default & default & default \\ \Option{footnosepline} & @@ -169,6 +171,8 @@ set, either by default or by the user. default & default & default \\ \Option{twoside} & default & & \\ + \Option{version=} & + \PValue{first} & \PValue{first} & \PValue{first} \\ \end{tabular} \label{tab:maincls.stdOptions} \end{table} @@ -187,70 +191,68 @@ set, either by default or by the user. that is done, you can concentrate on the fine points of presentation. Besides the choice of options, this means correcting things like hyphenation, page breaks, and the distribution of tables - and figures. As an example consider the - \autoref{tab:maincls.stdOptions} that I have moved repeatedly - between the beginning and the end of this section. The choice of the - actual position will only be made during the final production of the + and figures. As an example consider + \autoref{tab:maincls.stdOptions}, which I moved repeatedly between + the beginning and the end of this section. The choice of the actual + position will only be made during the final production of the document. \end{Explain} \par -\subsection{Optionen for Compatibility} +\subsection{Options for Compatibility} \label{sec:maincls.compatibilityOptions} \BeginIndex{}{Compatibility} -% TODO: Translate this -\minisec{Sorry, Still waiting for translation:} -Wer seine Dokumente im Quellcode archiviert, legt in der Regel allergroessten -Wert darauf, dass bei zukuenftigen \LaTeX{}-Laeufen immer wieder exakt dasselbe -Ergebnis erzielt wird. In einigen Faellen ist es aber so, dass Verbesserungen -und Korrekturen an der Klasse zu aenderungen im Verhalten, inbesondere beim -Umbruch, fuehren. +% added translation 29 May 2007, 22:30 LT +Users who archive their documents as source code generally place great value +on obtaining exactly the same output in future {\LaTeX} runs. However, in some +cases, improvements and corrections to a class can lead to changes in +behaviour, particularly as regards line and page breaks. \begin{Declaration} \Option{version}\\ - \XOption{version}=\PName{Wert} + \XOption{version}=\PName{value} \end{Declaration} \BeginIndex{Option}{version}% -Seit\ChangedAt{v2.96a}{\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} -Version~2.96a besteht bei \KOMAScript\ die Wahl, ob eine Quelldatei so weit -irgend moeglich auch zukuenftig bei einem \LaTeX{}-Lauf zu exakt demselben -Ergebnis fuehren soll oder ob jeweils entsprechend der Anpassungen der neusten -Version der Klasse zu setzen ist. Zu welcher Version Kompatibilitaet -herzustellen ist, wird dabei ueber die Option \Option{version} -festgelegt. Voreingestellt ist Version~2.9t. Dasselbe Ergebnis kann mit +Since\ChangedAt{v2.96a}{\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} +version~2.96a {\KOMAScript} offers the choice of whether a source file +should output as far as possible identical results in future {\LaTeX} +runs, or whether output should be determined according to the latest +changes in the class. The option \Option{version} determines with +which version compatibility is to be maintained. The default setting +is version~2.9t. The same result can be achieved by setting \begin{lstlisting} version=first \end{lstlisting} -oder +or \begin{lstlisting} version=2.9 \end{lstlisting} -oder +or \begin{lstlisting} - version=2.9t + version=2.9t. \end{lstlisting} -erreicht werden. Bei Angabe einer unbekannten Version als \PName{Wert} wird -eine Warnung ausgegeben und sicherheitshalber \Option{version=}\PValue{first} -angenommen. Mit +If an unknown version number is given as \PName{value} a warning is +output and for safety's sake the option is set to +\Option{version=}\PValue{first}. With \begin{lstlisting} version=last \end{lstlisting} -kann die jeweils neuste Version ausgewaehlt werden. In diesem Fall wird also -auf zukuenftige Kompatibilitaet verzichtet. Wird die Option ohne Wertangabe -verwendet, so wird ebenfalls \PValue{last} angenommen. - -Die Frage der Kompatiblitaet betrifft in erster Linie Fragen des Umbruchs. Neue -Moeglichkeiten, die sich nicht auf den Umbruch auswirken, sind auch dann -verfuegbar, wenn man per Option die Kompatibilitaet zu einer aelteren Version -ausgewaehlt hat. Die Option hat keine Auswirkungen auf Umbruchaenderungen, die -bei Verwendung einer neueren Version durch Beseitigung eindeutiger Fehler -entstehen. Wer auch im Fehlerfall unbedingte Umbruchkompatibitlitaet benoetigt, -sollte stattdessen mit dem Dokument auch die verwendete \KOMAScript-Version -archivieren. - -Es ist zu beachten, dass die Option \Option{version} nach dem Laden der Klasse -nicht mehr veraendert werden kann.% +the current latest version can be selected. In this case future +compatibility is switched off. If the option is used without a value, +then once again the value of \PValue{last} is assumed. + +The question of compatibility is first of all a question of line and page +breaking. New capabilities, which do not affect page breaks, are also +available if the option of compatibility to an older version is +selected. The option has no effect on changes in the page breaking +when using a newer version, which result purely through the correction +of errors. If absolute compatibility including errors is required, +then the requisite {\KOMAScript} version should be archived along with +the document source. + +It should be noted that the option \Option{version} cannot be changed +after the loading of the class.% % \EndIndex{Option}{version}% % @@ -259,17 +261,21 @@ nicht mehr veraendert werden kann.% \subsection{Options for Page Layout} \label{sec:maincls.typeareaOptions} -With the standard classes the page layout\Index{page layout} is established by -the option files \File{size10.clo}, \File{size11.clo}, \File{size12.clo} (or -\File{bk10.clo}, \File{bk11.clo}, \File{bk12.clo} for the book class) and by -fixed values in the class definitions. The \KOMAScript{} classes, however, do -not use a fixed page layout, but one that depends on the paper -format\Index{paper format} and font size. For this task all three main classes -use the \Package{typearea} package\IndexPackage{typearea} (see +With the standard classes the page layout\Index{page>layout} is +established by the option files \File{size10.clo}, \File{size11.clo}, +\File{size12.clo} (or \File{bk10.clo}, \File{bk11.clo}, +\File{bk12.clo} for the book class) and by fixed values in the class +definitions. The {\KOMAScript} classes, however, do not use a fixed +page layout, but one that depends on the paper format\Index{paper + format} and font size. For this task all three main classes use the +\Package{typearea} package\IndexPackage{typearea} (see \autoref{cha:typearea}). The package is automatically loaded by the -\KOMAScript{} main classes. Therefore it is not necessary to use the command -\Macro{usepackage}\OParameter{package options}\PParameter{typearea} -explicitly. +{\KOMAScript} main classes. Therefore it is not necessary to load the +package using \Macro{usepackage}\PParameter{typearea}. If a {\LaTeX} +run results in an error ``\texttt{Option clash for package + typearea}'', then this is most likely owing to the use of an +explicit command \Macro{usepackage}\OParameter{package + options}\PParameter{typearea}. \begin{Declaration} @@ -290,14 +296,16 @@ explicitly. \BeginIndex{Option}{c0paper}% \BeginIndex{Option}{d0paper}% \BeginIndex{Option}{landscape}% -The basic options for the choice of paper format are not processed directly by -the classes. They are automatically processed by the \Package{typearea} -package as global options (see \autoref{sec:typearea.options}, -\autopageref{desc:typearea.option.letterpaper}). The options \Option{a5paper}, -\Option{a4paper}, \Option{letterpaper}, \Option{legalpaper} and -\Option{executivepaper} correspond to the options of the standard classes that -have the same name and define the same paper format. The page layout -calculated for each is different, however. +The basic options for the choice of paper format are not processed +directly by the classes. Instead, they are automatically processed by +the \Package{typearea} package as global options (see +\autoref{sec:typearea.options}, +\autopageref{desc:typearea.option.letterpaper}). The options +\Option{a5paper}, \Option{a4paper}, \Option{letterpaper}, +\Option{legalpaper} and \Option{executivepaper} correspond to the +likewise-named options of the standard classes and define the same +paper format. The page layout calculated for each is different, +however. % \EndIndex{Option}{letterpaper}% \EndIndex{Option}{legalpaper}% @@ -309,16 +317,16 @@ calculated for each is different, however. \EndIndex{Option}{landscape} \begin{Explain} - The options for the A, B, C or D format are actually not processed - by the \Package{typearea}, because they are global options, but - because the \KOMAScript{} classes explicitly pass them to the - \Package{typearea} package. This is caused by the way option + The reason that the options for the A, B, C or D format are not + processed by the \Package{typearea} is not because they are global + options, but because the {\KOMAScript} classes explicitly pass them + to the \Package{typearea} package. This is caused by the way option processing is implemented in the \Package{typearea} package and by the operation of the underlying option passing and processing - mechanism of \LaTeX. + mechanism of {\LaTeX}. This is also valid for the options, described subsequently, that set - the binding correcting, the divisor and the number of header lines. + the binding correction, the divisor and the number of header lines. \end{Explain} @@ -351,10 +359,11 @@ for the option that sets the number of header lines. \subsection{Options for Document Layout} \label{sec:maincls.layoutOptions} -This subsection collects all the options that affect the document -layout, not only the page layout. Strictly speaking all page layout -options (see \autoref{sec:maincls.typeareaOptions}) are also -document layout options. The reverse is also partially true. +This subsection deals with all the options that affect the document +layout in general and not only the page layout. Strictly speaking, of +course, all page layout options (see +\autoref{sec:maincls.typeareaOptions}) are also document layout +options. The reverse is also partially true. \begin{Declaration} \Option{oneside}\\ @@ -362,16 +371,16 @@ document layout options. The reverse is also partially true. \end{Declaration}% \BeginIndex{Option}{oneside} \BeginIndex{Option}{twoside}% -These two options have the same effect as with the standard classes. +These two options have the same effect as in the standard classes. The option \Option{oneside} defines a one-sided document layout with a one-sided page layout. This means in particular that normally a ragged page bottom is used. The option \Option{twoside} defines a two-sided document layout with a -two-sided page layout. This means that the \LaTeX{} command +two-sided page layout. This means that the {\LaTeX} command \Macro{flushbottom}\IndexCmd{flushbottom} is used to ensure that page -breaks don't leave a variable empty space at the bottom of the page. A -ragged page bottom can be obtained with the \LaTeX{} command +breaks don't leave a variable empty space at the bottom of a page. A +ragged page bottom can be obtained with the {\LaTeX} command \Macro{raggedbottom}\IndexCmd{raggedbottom}. % \EndIndex{Option}{oneside}% @@ -386,7 +395,7 @@ ragged page bottom can be obtained with the \LaTeX{} command \BeginIndex{Option}{twocolumn}% These options have the same effect as the corresponding standard options. They are used to switch between a one-column and a two-column -layout. The standard \LaTeX{} capabilities for multi-column layout are +layout. The standard {\LaTeX} capabilities for multi-column layout are only useful for very simple uses. The standard package \Package{multicol} is much more versatile (see \cite{package:multicol}).\Index{columns}\IndexPackage{multicol} @@ -402,16 +411,16 @@ only useful for very simple uses. The standard package \BeginIndex{Option}{openright}% These\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} options have the same effect as the corresponding standard options. They affect the -choice of the page where a chapter\Index[indexmain]{chapter} can begin, -so they are not available with the \Class{scrartcl} class, since there -the main unit below ``part'' is the ``section''. The chapter level is -not available in \Class{scrartcl}. +choice of the page where a chapter\Index[indexmain]{chapter} can +begin, so they are not available with the \Class{scrartcl} class, +since the next largest unit below ``part'' is ``section''. The chapter +level is not available in \Class{scrartcl}. -A chapter always begins with a new page. When the option +A chapter always begins on a new page. When the option \Option{openany} is active, any page can be used. The option -\Option{openright} causes the chapter to begin with a new right page. +\Option{openright} causes the chapter to begin on a new right page. An empty left page may be inserted automatically in this case. The -empty pages are created by the implicit execution of the \LaTeX{} +empty pages are created by the implicit execution of the {\LaTeX} command \Macro{cleardoublepage}\IndexCmd{cleardoublepage}. The option \Option{openright} has no effect with a one-sided layout, @@ -432,10 +441,11 @@ right pages. For this reason it should only be used together with the \BeginIndex{Option}{cleardoubleplain}% \BeginIndex{Option}{cleardoubleempty}% If one wishes the empty pages created by the \Macro{cleardoublepage} -command to have no headers or footers while using the standard -classes, the only possibility is to redefine the command -appropriately. {\KOMAScript} provides options that avoid this. The -option \Option{cleardoublestandard} enables the default +command to have no headers but only a page number, or neither headers +nor page number while using the standard classes, the only possibility +is to redefine the command appropriately. {\KOMAScript} provides +options that avoid this necessity. The option +\Option{cleardoublestandard} enables the default \Macro{cleardoublepage} behaviour. If the option \Option{cleardoubleplain} is used, then the \PValue{plain}\IndexPagestyle{plain} page style is applied to the @@ -458,7 +468,7 @@ Both options have the same effect as the corresponding standard ones. The \Option{titlepage} option makes {\LaTeX} use separate pages for the titles. These pages are set inside a \Environment{titlepage} environment and normally have neither header nor footer. In comparison -with standard \LaTeX, \KOMAScript{} expands the handling of the titles +with standard {\LaTeX}, {\KOMAScript} expands the handling of the titles significantly (see \autoref{sec:maincls.titles}). The option \Option{notitlepage} specifies that an \emph{in-page} title @@ -491,56 +501,58 @@ abstract or a section. \BeginIndex{Option}{halfparskip+}% \BeginIndex{Option}{halfparskip-}% \BeginIndex{Option}{parindent}% - The standard classes normally set - paragraphs\Index[indexmain]{paragraph} indented and without any - vertical inter-paragraph space. This is the best solution when - using a regular page layout, like the ones produced with the - \Package{typearea} package. If there where no indentation and no - vertical space, only the length of last line would give the reader a - reference point. In extreme cases, it is very difficult to detect if - a line is full or not. Furthermore, it is found that a marker at the - paragraph's end tends to be easily forgotten. A marker at the - paragraph's beginning is easily remembered. Inter-paragraph spacing - has the drawback of disappearing in some contexts. For instance, - after a displayed formula it would be impossible to detect if the - previous paragraph continues or if a new one begins. Also, when - starting to read at a new page it might be necessary to look at the - previous page in order determine if a new paragraph has been started - or not. All these problems disappear when using indentation. A - combination of indentation and vertical inter-paragraph spacing is - redundant and should be rejected. The - indentation\Index[indexmain]{indentation} is perfectly sufficient by - itself. The only drawback of indentation is the reduction of the - line length. The use of inter-paragraph spacing is therefore - justified when using short lines, for instance in a newspaper. +The standard classes normally set +paragraphs\Index[indexmain]{paragraph} indented and without any +vertical inter-paragraph space. This is the best solution when using +a regular page layout, like the ones produced with the +\Package{typearea} package. If neither indentation nor vertical space +is used, only the length of the last line would give the reader a +reference point. In extreme cases, it is very difficult to detect +whether a line is full or not. Furthermore, it is found that a marker +at the paragraph's end tends to be easily forgotten by the start of +the next line. A marker at the paragraph's beginning is more easily +remembered. Inter-paragraph spacing has the drawback of disappearing +in some contexts. For instance, after a displayed formula it would be +impossible to detect if the previous paragraph continues or if a new +one begins. Also, when starting to read at the top of a new page it +might be necessary to look at the previous page in order determine if +a new paragraph has been started or not. All these problems disappear +when using indentation. A combination of indentation and vertical +inter-paragraph spacing is redundant and therefore should be +avoided. The indentation\Index[indexmain]{indentation} is perfectly +sufficient by itself. The only drawback of indentation is the +reduction of the line length. The use of inter-paragraph spacing is +therefore justified when using short lines, for instance in a +newspaper. \end{Explain} Independently of the explanation above, there are often requests for a document layout with vertical inter-paragraph spacing instead of -indentation. \KOMAScript{} provides a large number of related +indentation. {\KOMAScript} provides a large number of related options: \Option{parskip}, \Option{parskip-}, \Option{parskip*}, \Option{parskip+} and \Option{halfparskip}, \Option{halfparskip-}, \Option{halfparskip*} and \Option{halfparskip+}. -The four \Option{parskip} options define an inter-paragraph spacing of -one line. The four \Option{halfparskip} options use just a spacing of -half a line. In order to avoid a change of paragraph going unnoticed, -for instance after a page break, three of the options of each set -ensure that the last line of a paragraph is not full. The variants -without plus or star sign ensure a free space of 1\Unit{em}. The plus -variant ensures that at least a third of the line is free and the star -variant ensures that at least a fourth of the line is free. The minus -variants make no special provision for the last line of a paragraph. - -All eight options change the spacing before, after and inside list -environments. This avoids the problem of having these environments or -the paragraphs inside them with a larger separation than the +The four \Option{parskip} options each define an inter-paragraph +spacing of one line. The four \Option{halfparskip} options use just a +spacing of half a line. In order to avoid a change of paragraph going +unnoticed, for instance after a page break, three of the options of +each set ensure that the last line of a paragraph is not completely +filled. The variants without plus or star sign ensure a free space of +1\Unit{em}. The plus variant ensures that at least a third of the line +is free and the star variant ensures that at least a fourth of the +line is free. The minus variants make no special provision for the +last line of a paragraph. + +All eight options also change the spacing before, after and inside +list environments. This avoids the problem of these environments or +the paragraphs inside them having a larger separation than the separation between the paragraphs of normal text. Additionally, these options ensure that the table of contents and the lists of figures and tables are set without any additional spacing. -The default behaviour of \KOMAScript{} follows the \Option{parindent} +The default behaviour of {\KOMAScript} follows the \Option{parindent} option. In this case, there is no spacing between paragraphs, only an indentation of the first line by 1\Unit{em}. % @@ -568,13 +580,14 @@ In order to have a line separating the header from the text body use the option \Option{headsepline}. The option \Option{headnosepline} has the reverse effect. These options have no effect with the page styles \PValue{empty} and \PValue{plain}, because there is no header in this -case. Such a line always has the effect of visually approximating -header and text body. That doesn't mean that the header must be put -farther apart from the text body. Instead, the header should be -considered to belong to the text body for the purpose of page layout -calculations. {\KOMAScript} takes this into account by automatically -passing the option \Option{headinclude} to the \Package{typearea} -package whenever the \Option{headsepline} option is used. +case. Such a line always has the effect of visually bringing header +and text body closer together. That doesn't mean that the header must +now be moved farther from the text body. Instead, the header should be +considered as belonging to the text body for the purpose of page +layout calculations. {\KOMAScript} takes this into account by +automatically passing the option \Option{headinclude} to the +\Package{typearea} package whenever the \Option{headsepline} option is +used. The presence of a line between text body and footer is controlled by the options \Option{footsepline} and \Option{footnosepline}, that @@ -599,11 +612,11 @@ when used together with the page style \PValue{plain}, because the \BeginIndex{Option}{nochapterprefix}% With\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} the standard classes \Class{book} and \Class{report} a chapter -title\Index[indexmain]{chapter title} consists of a line with the word -"Chapter"\footnote{When using another language the word - "Chapter" is naturally translated to the appropriate language.}% +title\Index[indexmain]{chapter>title} consists of a line with the word +``Chapter''\footnote{When using another language the word + ``Chapter'' is naturally translated to the appropriate language.}% followed by the chapter number. The title itself is set left-justified -on the following lines. The same effect is obtained in \KOMAScript{} +on the following lines. The same effect is obtained in {\KOMAScript} with the class option \Option{chapterprefix}. The default however is \Option{nochapterprefix}. These options also affect the automatic running titles in the headers (see @@ -622,7 +635,7 @@ running titles in the headers (see Sometimes\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} one wishes to have the chapter titles in simplified form according to \Option{nochapterprefix}. But at the same time, one wishes a title of -an appendix\Index{appendix} to be preceded by a line with "Appendix" +an appendix\Index{appendix} to be preceded by a line with ``Appendix'' followed by the appendix letter. This is achieved by using the \Option{appendixprefix} option. Since this results in an inconsistent document layout, I advise against using this option. @@ -648,18 +661,22 @@ captions when the \Option{noonelinecaption} option is given. \begin{Explain} The avoidance of a special treatment for the caption has an - additional effect that is sometimes greatly desired. Footnotes - that appear inside a \Macro{caption} command often have a wrong - number assigned to them. This happens because the footnote counter - is incremented once when the line is measured. When the - \Option{noonelinecaption} option is used no such measurement is - made. The footnote numbers are therefore correct. - - But since \KOMAScript{} version~2.9 you don't need the option + additional effect that is sometimes highly desirable. Footnotes that + appear inside a \Macro{caption} command often have a wrong number + assigned to them. This happens because the footnote counter is + incremented once as soon as the text is measured to determine if it + will be one line or more. When the \Option{noonelinecaption} option + is used no such measurement is made. The footnote numbers are + therefore correct. + + But since {\KOMAScript} version~2.9 you don't need the option \Option{noonelinecaption} to avoid the above described - effect. \KOMAScript{} classes contain a workaround, so if you have - footnotes at captions you simply should put the contents of the - figure or table into a minipage and everything will be nice. + effect. {\KOMAScript} classes contain a workaround, so you can have + footnotes inside captions. It should be mentioned though that when + using footnotes inside floating environments, the contents of the + floating environment should be encapsulated inside a minipage. That + way it is guaranteed that floating environment and footnote are + inseparable. \end{Explain} % \EndIndex{Option}{onelinecaption}% @@ -686,13 +703,15 @@ currently has no such options. The options \Option{10pt}, \Option{11pt} and \Option{12pt} have the same effect as the corresponding standard options. In contrast to the standard classes, {\KOMAScript} can be used to choose other font -sizes\Index[indexmain]{font size}. However {\LaTeX} provides the +sizes\Index[indexmain]{font>size}. However, {\LaTeX} provides the necessary class option files only for 10\Unit{pt}, 11\Unit{pt} und -12\Unit{pt}, so that the user must provide any other class option -files. The package \Package{extsizes} (see -\cite{package:extsizes})\IndexPackage{extsizes} can be used for that -task. Very big font sizes may lead to arithmetic overflow inside the -page layout calculations of the \Package{typearea} package. +12\Unit{pt}, and {\KOMAScript} does not provide any class option files, +so the user must provide any other class option files. The package +\Package{extsizes} (see +\cite{package:extsizes})\IndexPackage{extsizes}, for example, can be +used to provide a \File{size14.clo} class file. Very big font sizes +may lead to arithmetic overflow inside the page layout calculations of +the \Package{typearea} package. % \EndIndex{Option}{10pt}% \EndIndex{Option}{11pt}% @@ -708,22 +727,24 @@ page layout calculations of the \Package{typearea} package. \BeginIndex{Option}{smallheadings}% \BeginIndex{Option}{normalheadings}% \BeginIndex{Option}{bigheadings}% -The font size used for the titles\index{title}\index{document structure} is -relatively big, both with the standard classes and with {\KOMAScript}. Not -everyone likes this choice; moreover it is specially problematic for small -paper sizes. Consequently {\KOMAScript} provides, besides the large title font -size defined by the \Option{bigheadings} option, the two options -\Option{normalheadings} and \Option{smallheadings}, that allow for smaller -title font sizes. The resulting font sizes for headings at \Class{scrbook} and -\Class{scrreprt} shows\autoref{tab:maincls.structureElementsFont}, -\autopageref{tab:maincls.structureElementsFont}. At \Class{scrartcl} smaller -font sizes are used. +The font size used for the titles\index{title}\index{document + structure} is relatively big, both with the standard classes and +with {\KOMAScript}. Not everyone likes this choice; moreover it is +specially problematic for small paper sizes. Consequently, +{\KOMAScript} provides, besides the large title font size defined by +the \Option{bigheadings} option, the two options +\Option{normalheadings} and \Option{smallheadings}, that allow for +smaller title font sizes. The font sizes for headings resulting from +these options for \Class{scrbook} and \Class{scrreprt} are shown in +\autoref{tab:maincls.structureElementsFont}, +\autopageref{tab:maincls.structureElementsFont}. For \Class{scrartcl} +smaller font sizes are generally used. \OnlyAt{\Class{scrbook}\and\Class{scrreprt}}The spacing before and after chapter titles is also influenced by these options. Chapter titles are also influenced by the options \Option{chapterprefix} and \Option{nochapterprefix}, and appendix titles by the options -\Option{appendixprefix} and \Option{noappendixprefix}, all of them +\Option{appendixprefix} and \Option{noappendixprefix}, all of which are described in \autoref{sec:maincls.layoutOptions}, \autopageref{desc:maincls.option.chapterprefix}. % @@ -735,9 +756,10 @@ are described in \autoref{sec:maincls.layoutOptions}, \label{sec:maincls.tocOptions} {\KOMAScript} has several options that affect the entries in the table -of contents\Index[indexmain]{table of contents}. The form of the table -of contents is fixed but several variations of the contents can be -obtained with the options provided. +of contents\Index[indexmain]{table>of + contents}\Index[indexmain]{contents>table of}. The form of the table +of contents is fixed but several variations can be obtained with the +options provided. \begin{Explain}% \begin{Declaration} @@ -752,24 +774,30 @@ obtained with the options provided. \BeginIndex{Option}{bibtotoc}% \BeginIndex{Option}{bibtotocnumbered}% \BeginIndex{Option}{liststotocnumbered}% - Lists of tables and figures, index and bibliography are not normally - included in the table of contents. These entries are omitted in - classical typography because it is silently assumed that, if at all, - lists of figures and tables come after the table of contents, the - index comes at the end and the bibliography comes before the index. - Books with all these parts often include ribbons that can be used to - mark the location of these parts in the book, so that the reader - only has to look for them once. +Normally, lists of tables and figures, index and bibliography are not +included in the table of contents. These entries are purposely omitted +in classical typography because, among other things, a very particular +placement of these items is silently assumed, if they are present at +all: +\begin{itemize} +\item table of contents after the title pages, +\item lists of tables and figures after the table of contents, +\item index right at the end, +\item bibliography before the index. +\end{itemize} +Books, in which all these items are present, often include ribbons +that can be used to mark the location of these items in the book, so +that the reader only has to look for them once. \end{Explain} It is becoming increasingly common to find entries in the table of contents for the lists of tables and figures, for the bibliography, -and, sometimes, even for the index. This is certainly related to the +and, sometimes, even for the index. This is surely also related to the recent trend of putting lists of figures and tables at the end of the document. Both lists are similiar to the table of contents in structure and intention. I'm therefore sceptical of this evolution. -Since it makes no sense to include only one of the aforementioned lists -in the table of contents, there exists only one option +Since it makes no sense to include only one of the lists of tables and +figures in the table of contents, there exists only one option \Option{liststotoc} that causes entries for both types of lists to be included. This also includes any lists produced with version~1.2e or later of the \Package{float}\IndexPackage{float} package (see @@ -777,27 +805,34 @@ later of the \Package{float}\IndexPackage{float} package (see contain entries that reference other sections of the document. The option \Option{idxtotoc} causes an entry for the index to be -included in the table of contents. The index is also unnumbered since -it only includes references to the contents of the other sectional +included in the table of contents. The index is unnumbered since it +too only includes references to the contents of the other sectional units. The bibliography is a different kind of listing. It does not list the contents of the present document but refers instead to external -documents. On these reasons it could be argued that it is a different +documents. For that reason, it could be argued that it qualifies as a chapter (or section) and, as such, should be numbered. The option \Option{bibtotocnumbered} has this effect, including the generation of -the corresponding entry in the table of contents. I think that a -similar reasoning would lead us to consider a classical list of -sources to be a separate chapter. Also, the bibliography is not -something that was written by the document's author. In view of this, -the bibliography merits nothing more than an unnumbered entry in the -table of contents, and that can be achieved with the \Option{bibtotoc} -option. - -The author of \KOMAScript{} doesn't like option -\Option{bibtotocnumbered}. He almost detests option -\Option{liststotocnumbered}. Because of this you won't find a detailed -description of this option. Nevertheless it exists. +the corresponding entry in the table of contents. I personally think +that this reasoning would lead us to consider a classical list of +sources also to be a separate chapter. On the other hand, the +bibliography is finally not something that was written by the +document's author. In view of this, the bibliography merits nothing +more than an unnumbered entry in the table of contents, and that can +be achieved with the \Option{bibtotoc} option. + +As\ChangedAt{v2.8q}{% + \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} the author +of {\KOMAScript} already views the option \Option{liststotoc} with +open skepticism, and frankly detests option \Option{bibtotocnumbered}, +it should come as no surprise that he implemented option +\Option{liststotocnumbered} only under extreme duress. He fears that +as a next step someone will want the table of contents numbered and +entered in the table of contents. Therefore, those looking in this +documentation for a detailed description of option \Option{liststotoc} +will search in vain. A similar option for the index would be just +as silly, so its implementation has been determinedly refused so far. % \EndIndex{Option}{liststotoc}% \EndIndex{Option}{idxtotoc}% @@ -813,20 +848,21 @@ description of this option. Nevertheless it exists. \BeginIndex{Option}{tocindent}% \BeginIndex{Option}{tocleft}% The table of contents is normally\ChangedAt{v2.8q}{% - \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} setup so + \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} set up so that different sectional units have different indentations. The section number is set left-justified in a fixed-width field. This setup is selected with the option \Option{tocindent}. When there are many sections, the corresponding numbering tends to become very wide, so that the reserved field overflows. The FAQ -\cite{DANTE:FAQ} suggests that the table of contents should be redefined -in such a case. \KOMAScript{} offers an alternative format that avoids -the problem completely. If the option \Option{tocleft} is selected, -then no variable indentation is applied to the titles of the sectional -units. Instead, a table-like organisation is used, where all unit -numbers and titles, respectively, are set in a left-justified column. -The space necessary for the unit numbers is determined automatically. +\cite{DANTE:FAQ} suggests that the table of contents should be +redefined in such a case. {\KOMAScript} offers an alternative format +that avoids the problem completely. If the option \Option{tocleft} is +selected, then no variable indentation is applied to the titles of the +sectional units. Instead, a table-like organisation is used, where all +unit numbers and titles, respectively, are set in a left-justified +column. The space necessary for the unit numbers is thus determined +automatically. \begin{Explain} In order to calculate automatically the space taken by the unit @@ -837,13 +873,14 @@ The space necessary for the unit numbers is determined automatically. \Option{tocindent}, since it does not make any redefinitions. When using packages that affect the format of the table of contents, it is possible that the use of options \Option{tocleft} and - \Option{tocindent} may lead to problems. In that case, one should - use neither of these global (class) option. + \Option{tocindent} too may lead to problems. When using such + packages then, for safety's sake, one should refrain from using + either of these options as global (class) options. If the \Option{tocleft} option is active, the width of the field for unit numbering is determined when outputting the table of contents. After a change that affects the table of contents, at most three - \LaTeX{} runs are necessary to obtain a correctly set table of + {\LaTeX} runs are necessary to obtain a correctly set table of contents. \end{Explain} % @@ -853,12 +890,13 @@ The space necessary for the unit numbers is determined automatically. \subsection{Options for Lists of Floats} \label{sec:maincls.listsOptions} -The best known lists of floats are the list of figures and the list of tables. -With help from the \Package{float}\IndexPackage{float} package, for instance, -it is possible to produce new float environments with the corresponding lists. +The best known lists of floats are the list of figures and the list of +tables. Additionally, with help from the +\Package{float}\IndexPackage{float} package, for instance, it is +possible to produce new float environments with corresponding lists. \begin{Explain} - Whether \KOMAScript{} options have any effect on lists of floats + Whether {\KOMAScript} options have any effect on lists of floats produced by other packages depends mainly on those packages. This is generally the case with the lists of floats produced by the \Package{float}\IndexPackage{float} package. @@ -878,31 +916,59 @@ it is possible to produce new float environments with the corresponding lists. \BeginIndex{Option}{listsleft}% Lists of figures and tables\ChangedAt{v2.8q}{% \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} are -generally setup so that their numbering uses a fixed space. This +generally set up so that their numbering uses a fixed space. This corresponds to the use of option \Option{listsindent}. -If the numbers get too large, for instance because many tables are used, it -may happen that the available space is exceeded. Therefore \KOMAScript{} -supplies an option called \Option{listsleft} that is similar to the -\Option{tocleft} option. The width of the numbers is automatically determined -and the space for them correspondingly adjusted. Concerning the mode of -operation and the side effects, the observations made in -\autoref{sec:maincls.tocOptions}, \autopageref{desc:maincls.option.tocleft} -for the \Option{tocleft} option are equally valid in this case. Please note -that when using the \Option{listsleft} option several \LaTeX{} runs are -necessary before the lists of floats achieve their final form. +If the numbers become too large, for instance because many tables are +used, it may happen that the available space is exceeded. Therefore +{\KOMAScript} supplies an option called \Option{listsleft} that is +similar to the \Option{tocleft} option. The width of the numbers is +automatically determined and the space for them correspondingly +adjusted. Concerning the mode of operation and the side effects, the +observations made in \autoref{sec:maincls.tocOptions}, +\autopageref{desc:maincls.option.tocleft} for the \Option{tocleft} +option are equally valid in this case. Please note that when using the +\Option{listsleft} option several {\LaTeX} runs are necessary before +the lists of floats achieve their final form. % \EndIndex{Option}{listsindent}% \EndIndex{Option}{listsleft}% +\begin{Declaration} + \Option{chapteratlists}\\ + \XOption{chapteratlists}=\PName{value} +\end{Declaration}% +\BeginIndex{Option}{chapteratlists}% +\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}% +Normally,\ChangedAt{v2.96a}{\Class{scrbook}\and \Class{scrreprt}} +every chapter entry generated with \Macro{chapter} introduces vertical +spacing into the lists of floats. Since version~2.96a this applies +also for the command \Macro{addchap}, if no compatibility option to an +earlier version was chosen (see option \Option{version} in +\autoref{sec:maincls.compatibilityOptions}, +\autopageref{desc:maincls.option.version}). + +Furthermore, now the option \Option{chapteratlists} can be used to +change the spacing, by passing the desired distance as +\PName{value}. The default setting is 10\,pt. If the value is set to +\PValue{entry} or no value is specified, then instead of a vertical +distance the chapter entry itself will be entered into the lists. + +This option can be changed with +\Macro{KOMAoptions}\Parameter{chapteratlists} or +\Macro{KOMAoptions}\Parameter{chapteratlists=\PName{value}} even +inside the document. It takes effect from the next heading +onwards. However, changes to the option will only become effective in +the lists following two more {\LaTeX} runs. +\EndIndex{Option}{chapteratlists}% \subsection{Options Affecting the Formatting} \label{sec:maincls.formattingOptions} Formatting options are all those options that affect the form or -formatting of the document and are not assigned to other sections. -They are the \emph{remaining options}. +formatting of the document and cannot be assigned to other sections. +They are therefore the \emph{remaining options}. \begin{Declaration} \Option{abstracton}\\ @@ -911,21 +977,21 @@ They are the \emph{remaining options}. \BeginIndex{Option}{abstracton}% \BeginIndex{Option}{abstractoff}% In\OnlyAt{\Class{scrreprt}\and\Class{scrartcl}} the standard classes -the \Environment{abstract} environment sets the text "\abstractname" -centered before the summary text\Index[indexmain]{summary}. This was the -normal procedure in the past. In the meantime, newspaper reading has -trained the readers to recognize a displayed text at the beginning of -an article or report as the abstract. This is even more so when the -abstract comes before the table of contents. It is also surprising -that precisely this title appears small and centered. {\KOMAScript} +the \Environment{abstract} environment sets the text ``\abstractname'' +centered before the summary text\Index[indexmain]{summary}. This was +normal practice in the past. In the meantime, newspaper reading has +trained readers to recognize a displayed text at the beginning of an +article or report as the abstract. This is even more true when the +text comes before the table of contents. It is also surprising when +precisely this title appears small and centered. {\KOMAScript} provides the possibility of including or excluding the abstract's title with the options \Option{abstracton} and \Option{abstractoff}. \begin{Explain} Books typically use another type of summary. In that case there is usually a dedicated summary chapter at the beginning or end of the - book. This chapter is often combined with the introduction or with a - description of further aspects. Therefore, the class \Class{scrbook} + book. This chapter is often combined with the introduction or a + description of wider prospects. Therefore, the class \Class{scrbook} has no \Environment{abstract} environment. A summary chapter is also recommended for reports in a wider sense, like a Master's or Ph.D. thesis. @@ -942,27 +1008,28 @@ title with the options \Option{abstracton} and \Option{abstractoff}. \BeginIndex{Option}{pointednumbers}% \BeginIndex{Option}{pointlessnumbers}% \begin{Explain}% - According to {\small DUDEN}, the numbering of sectional units should - have no point at the end if only arabic numbers are used (see - \cite[R\,3]{DUDEN}). On the other hand, if roman numerals or letters - are used, then a point should appear at the end of the numbering (see - \cite[R\,4]{DUDEN}). {\KOMAScript} has an internal mechanisms that - tries to implement these rules. The resulting effect is that, - normally, after the sectional commands \Macro{part} and - \Macro{appendix} a switch is made to numbering with a point at the - end. The information is saved in the \File{aux} file and takes - effect on the next \LaTeX{} run. + In German, according to {\small DUDEN}, the numbering of sectional + units should have no dot at the end if only arabic numbers are used + (see \cite[R\,3]{DUDEN}). On the other hand, if roman numerals or + letters are appear in the numbering, then a dot should appear at the + end of the numbering (see \cite[R\,4]{DUDEN}). {\KOMAScript} has an + internal mechanisms that tries to implement this somewhat complex + rule. The resulting effect is that, normally, after the sectional + commands \Macro{part} and \Macro{appendix} a switch is made to + numbering with an ending dot. The information is saved in the + \File{aux} file and takes effect on the next {\LaTeX} run. \end{Explain} -In some cases the mechanism that switches the end point may fail or -other languagues may have different rules. Therefore it is possible to -activate the use of the end point with the option -\Option{pointednumbers} or to deactivate it with +In some cases the mechanism for placing or leaving off the ending dot +may fail, or other languagues may have different rules. Therefore it +is possible to activate the use of the ending dot manually with the +option \Option{pointednumbers} or to deactivate it with \Option{pointlessnumbers}. -Please note that the mechanism only takes effect on the next \LaTeX{} -run. When trying to use these options to control the numbering -format, a run without changing any options should be made. +Please note that the mechanism only takes effect on the next {\LaTeX} +run. Therefore, before trying to use these options to forcibly +control the numbering format, a further run without changing any +options should be made. Calling these options \Option{dottednumbers}\IndexOption{dottednumbers} and \Option{dotlessnumbers}\IndexOption{dotlessnumbers} or similar would be more @@ -1004,23 +1071,29 @@ loaded. Displayed equations are then left-justified. As described in \autoref{sec:maincls.floats}, \autopageref{desc:maincls.macro.caption}, the \Macro{caption}\IndexCmd{caption} command acts with figures like the -\Macro{captionbelow}\IndexCmd{captionbelow} command. The behaviour with tables -depends on two options. With the default \Option{tablecaptionbelow} options, -the \Macro{caption} macro acts like the \Macro{captionbelow} command. With the +\Macro{captionbelow}\IndexCmd{captionbelow} command. The behaviour +with tables, however, depends on these two options. In the default +setting, \Option{tablecaptionbelow}, the \Macro{caption} macro acts +also with tables like the \Macro{captionbelow} command. With the \Option{tablecaptionabove} option, \Macro{caption} acts like the \Macro{captionabove}\IndexCmd{captionabove} command. -Note that using any of these options does not changes the possition of the -caption from above the top of the table to the bottom of the table or vica -versa. It only changes the spacing between caption and e.g. tabular. +Note that using any of these options does not change the position of +the caption from above the top of the table to below the bottom of the +table or vica versa. It only affects whether the text is formatted as +a caption for use above or below a table. Whether the text is in fact +placed above or below a table is set through the position of the +\Macro{caption} command inside the \Environment{table} environment. Note\OnlyAt{\Package{float}}\IndexPackage{float} that when using the \Package{float} package, the options \Option{tablecaptionbelow} and -\Option{tablecaptionabove} cease to act correctly when the -\Macro{restylefloat} is applied to tables. More details of the \Package{float} -package's \Macro{restylefloat} can be obtained from -\cite{package:float}. Additional support for \Package{float} may be found at -\autoref{sec:maincls.floats}, \autopageref{desc:maincls.floatstyle.komaabove}. +\Option{tablecaptionabove} cease to act correctly when +\Macro{restylefloat} is applied to tables. More details of the +\Package{float} package and \Macro{restylefloat} can be found in +\cite{package:float}. Additional support in {\KOMAScript} for the +\Package{float} package may be found at the explanation of +\PValue{komaabove} in \autoref{sec:maincls.floats}, +\autopageref{desc:maincls.floatstyle.komaabove}. % \EndIndex{Option}{tablecaptionbelow}% \EndIndex{Option}{tablecaptionabove}% @@ -1032,20 +1105,22 @@ package's \Macro{restylefloat} can be obtained from \end{Declaration}% \BeginIndex{Option}{origlongtable}% The package\OnlyAt{\Package{longtable}} -\Package{longtable}\IndexPackage{longtable} (see \cite{package:longtable}) -sets table captions internally by calling the command \Macro{LT@makecaption}. -In order to ensure that these table captions match the ones used with normal -tables, the \KOMAScript{} classes normally redefine that command. See +\Package{longtable}\IndexPackage{longtable} (see +\cite{package:longtable}) sets table captions internally by calling +the command \Macro{LT@makecaption}. In order to ensure that these +table captions match the ones used with normal tables, the +{\KOMAScript} classes normally redefine that command. See \autoref{sec:maincls.floats}, -\autopageref{desc:maincls.macro.caption.longtable} for more details. The -redefinition is performed with help of the command \Macro{AfterPackage} -immediately after the loading of package \Package{longtable}. If the package -\Package{caption2}\IndexPackage{caption2} (see \cite{package:caption}) has -been previously loaded, the redefinition is not made in order not to interfere -with the \Package{caption2} package. +\autopageref{desc:maincls.macro.caption.longtable} for more +details. The redefinition is performed with help of the command +\Macro{AfterPackage} immediately after the loading of package +\Package{longtable}. If the package +\Package{caption2}\IndexPackage{caption2} (see \cite{package:caption}) +has been previously loaded, the redefinition is not made in order not +to interfere with the \Package{caption2} package. \end{Explain} If the table captions produced by the \Package{longtable} package -should not be redefined by the \KOMAScript{}, activate the +should not be redefined by the {\KOMAScript} classes, activate the \Option{origlongtable} option. % \EndIndex{Option}{origlongtable}% @@ -1057,7 +1132,7 @@ should not be redefined by the \KOMAScript{}, activate the \BeginIndex{Option}{openbib}% The standard option \Option{openbib} switches to an alternative bibliography format. The effects are twofold: The first line of a -bibliography entry, normally containing the author's name, gets a +bibliography entry, normally containing the author's name, receives a smaller indentation; and the command \Macro{newblock} is redefined to produce a paragraph. Without this option, \Macro{newblock} introduces only a stretchable horizontal space. @@ -1073,13 +1148,13 @@ only a stretchable horizontal space. \BeginIndex{Option}{final}% The two standard options \Option{draft} and \Option{final} are normally used to distinguish between the draft and final versions of a -document. The option \Option{draft} activates small black boxes that -are set at the end of overly long lines. The boxes help the untrained -eye to find paragraphs that have to be treated manually. With the -\Option{final} option no such boxes are shown. +document. In particular, the option \Option{draft} activates small +black boxes that are set at the end of overly long lines. The boxes +help the untrained eye to find paragraphs that have to be treated +manually. With the \Option{final} option no such boxes are shown. The two options are also processed by other packages and affect their -workings. For instance, the \Package{graphics}\IndexPackage{graphics} +operation. For instance, the \Package{graphics}\IndexPackage{graphics} and the \Package{graphicx}\IndexPackage{graphicx} packages don't actually output the graphics when the option \Option{draft} is specified. Instead they output a framed box of the appropriate size @@ -1094,32 +1169,32 @@ containing only the graphic's filename (see \cite{package:graphics}). Some document characteristics do not apply to a particular section of the document like the titling, the text body or the bibliography, but -they affect the entire document. Some of these characteristics were +do affect the entire document. Some of these characteristics were already described in \autoref{sec:maincls.options}. \subsection{Changing Fonts} \label{sec:maincls.font} -\BeginIndex{}{font}\BeginIndex{}{font size}% +\BeginIndex{}{font}\BeginIndex{}{font>size}% \begin{Explain} - \KOMAScript{} does not use fixed fonts and attributes to emphasize - different elements of the text. Instead there are variables - that contain the commands used for changing fonts and other text - attributes. In previous versions of \KOMAScript{} the user had to + {\KOMAScript} does not use fixed fonts and attributes to emphasize + different elements of the text. Instead there are variables that + contain the commands used for changing fonts and other text + attributes. In previous versions of {\KOMAScript} the user had to use \Macro{renewcommand} to redefine those variables. It was also not easy to determine the name of the variable affecting an element - given the element's name. It was also often necessary to determine - the original definition before proceeding to redefine it. - - These difficulties were actually intended, since the interface was not - for users, but only for package authors building their - packages on top of \KOMAScript{}. The years have shown that the - interface was mainly used by document authors. So a new, simpler - interface was created. However, the author advises explicitly the - typographically inexperienced user against changing font sizes and - other graphical characteristics according to his taste. Knowledge - and feeling are basic conditions for the selection and mixture of - different font sizes, attributes and families. + given the element's name. Besides, it was also often necessary to + determine the original definition before proceeding to redefine it. + + These difficulties were actually intended, since the interface was + not for users, but only for package authors building their packages + on top of {\KOMAScript}. The years have shown, however, that the + interface was in fact mainly used by document authors. So a new, + simpler interface was created. However, the author explicitly + advises the typographically inexperienced user against changing font + sizes and other graphical characteristics according to his + taste. Knowledge and feeling are basic conditions for the selection + and mixture of different font sizes, attributes and families. \end{Explain} \begin{Declaration} @@ -1137,31 +1212,31 @@ and \Macro{addtokomafont} it is possible to define the \PName{element}. Theoretically all possible statements including literal text could be used as \PName{commands}. You should however absolutely limit yourself to those statements that really switch only -one font attribute. This are usually the commands \Macro{normalfont}, -\Macro{rmfamily}, \Macro{sffamily}, \Macro{ttfamily}, -\Macro{mdseries}, \Macro{bfseries}, \Macro{upshape}, \Macro{itshape}, -\Macro{slshape}, \Macro{scshape} and the font size commands -\Macro{Huge}, \Macro{huge}, \Macro{LARGE} etc. The description of -these commands can be found in \cite{lshort}, \cite{latex:usrguide} or -\cite{latex:fntguide}. Color switching commands like -\Macro{normalcolor} (see \cite{package:graphics}) are also acceptable. -The behavior when using other commands, specially those that make -redefinitions or generate output, is not defined. Strange behavior is -possible and does not represent a bug. +one font attribute. This will usually be the commands +\Macro{normalfont}, \Macro{rmfamily}, \Macro{sffamily}, +\Macro{ttfamily}, \Macro{mdseries}, \Macro{bfseries}, \Macro{upshape}, +\Macro{itshape}, \Macro{slshape}, \Macro{scshape} and the font size +commands \Macro{Huge}, \Macro{huge}, \Macro{LARGE}, etc. The +description of these commands can be found in \cite{lshort}, +\cite{latex:usrguide} or \cite{latex:fntguide}. Color switching +commands like \Macro{normalcolor} (see \cite{package:graphics}) are +also acceptable. The behavior when using other commands, specially +those that make redefinitions or generate output, is not +defined. Strange behavior is possible and does not represent a bug. The command \Macro{setkomafont } provides a font switching command with a completely new definition. In contrast to this the -\Macro{addtokomafont} commands extends the existing definition. - -It is not recommended to use both statements in the same +\Macro{addtokomafont} command merely extends an existing +definition. It is recommended to not use both commands in the same document. Usage examples can be found in the paragraphs on the corresponding element. Names and meanings of the individual items are listed in \autoref{tab:maincls.elementsWithoutText}. The default values are shown in the corresponding paragraphs. The command \Macro{usekomafont} can change the current font -specification to the one used with the specified \PName{element}. +specification to the one currently used with the specified +\PName{element}. \begin{Example} Assume that you want to use for the element \FontElement{captionlabel} the same font specification that is used @@ -1178,20 +1253,20 @@ specification to the one used with the specified \PName{element}. \Macro{addtokomafont}\label{tab:maincls.elementsWithoutText}}\\ \Endfirsthead \caption[]{Elements, whose type style can be - changed (\emph{pursuit})}\\ + changed (\emph{continuation})}\\ \Endhead \standardfoot% \feentry{caption}{Text of a table or figure caption}% \feentry{captionlabel}{Label of a table or figure caption; used according to the element \FontElement{caption}}% \feentry{chapter}{Title of the sectional unit \Macro{chapter}}% - \feentry{descriptionlabel}{Labels, i.e. the optional argument of - \Macro{item}, in the \Environment{description} environment}% - \feentry{dictum}{smart saing (see command \Macro{dictum})}% - \feentry{dictumauthor}{Author of a smart saying; used according to the + \feentry{descriptionlabel}{Labels, i.\,e., the optional argument of + \Macro{item} in the \Environment{description} environment}% + \feentry{dictum}{wise saying (see command \Macro{dictum})}% + \feentry{dictumauthor}{Author of a wise saying; used according to the element \FontElement{dictumtext}}% \feentry{dictumtext}{Another name for \FontElement{dictum}}% - \feentry{disposition}{All sectional unit titles, i.e. the arguments of + \feentry{disposition}{All sectional unit titles, i.\,e., the arguments of \Macro{part} down to \Macro{subparagraph} and \Macro{minisec}, including the title of the abstract; used before the element of the corresponding unit}% @@ -1199,34 +1274,38 @@ specification to the one used with the specified \PName{element}. \feentry{footnotelabel}{Mark of a footnote; used according to the element \FontElement{footnote}}% \feentry{footnotereference}{Footnote reference in the text}% - \feentry{minisec}{Title of \Macro{minisec}} + \feentry{minisec}{Title of \Macro{minisec}}% \feentry{pagefoot}{The foot of a page, but also the head of a page}% \feentry{pagehead}{The head of a page, but also the foot of a page}% \feentry{pagenumber}{Page number in the header or footer}% \feentry{pagination}{Another name for \FontElement{pagenumber}}% \feentry{paragraph}{Title of the sectional unit \Macro{paragraph}}% \feentry{part}{Title of the \Macro{part} sectional unit, without the line - with the part number}% - \feentry{partnumber}{Line with the part number in a title of the sectional - unit \Macro{part}}% + containing the part number}% + \feentry{partnumber}{Line containing the part number in a title of the + sectional unit \Macro{part}}% \feentry{section}{Title of the sectional unit \Macro{section}}% \feentry{sectioning}{Another name for \FontElement{disposition}}% \feentry{subparagraph}{Title of the sectional unit \Macro{subparagraph}}% \feentry{subsection}{Title of the sectional unit \Macro{subsection}}% \feentry{subsubsection}{Title of the sectional unit \Macro{subsubsection}}% - \feentry{title}{Main title of the document, i.e. the argument of - \Macro{title} (for details about the size see the additional note at the - text on \autopageref{desc:maincls.macro.title})}% + \feentry{title}{Main title of the document, i.\,e., the argument of + \Macro{title} (for details about the title size see the additional note in + the text from \autopageref{desc:maincls.macro.title})}% \end{desctable} % \EndIndex{Cmd}{setkomafont}% \EndIndex{Cmd}{addtokomafont}% \EndIndex{Cmd}{usekomafont}% -\EndIndex{}{font}\EndIndex{}{font size}% +\EndIndex{}{font}\EndIndex{}{font>size}% \subsection{Page Style} \label{sec:maincls.pageStyle} +One of the general characteristics of a document is the page +style\Index[indexmain]{page>style}. In {\LaTeX} this means mostly the +contents of headers and footers. + \begin{Declaration} \Macro{pagestyle}\PParameter{empty}\\ \XMacro{pagestyle}\PParameter{plain}\\ @@ -1240,30 +1319,31 @@ specification to the one used with the specified \PName{element}. \BeginIndex{Pagestyle}{plain}% \BeginIndex{Pagestyle}{headings}% \BeginIndex{Pagestyle}{myheadings}% -One of the general characteristics of a document is the page -style\Index[indexmain]{page style}. In {\LaTeX} this means mostly the -contents of headers and footers. Usually one distinguishes four -different page styles. +Usually one distinguishes four different page styles. \begin{description} \item[\phantomsection\label{desc:maincls.pagestyle.empty}empty] is the page style with entirely empty headers and footers. In {\KOMAScript} this is completely identical to the standard classes. -\item [plain] is the page style with empty head and only a page number - in the foot. With the standard classes this page number is - always centered in the foot. With {\KOMAScript} the page number +\item [plain] is the page style with empty header and only a page + number in the footer. With the standard classes this page number is + always centered in the footer. With {\KOMAScript} the page number appears on double-sided\Index {double-sided} layout on the outer - side of the foot. The one-sided page style behaves like the + side of the footer. The one-sided page style behaves like the standard setup. -\item[headings] is the page style with running titles in the head. - With the classes \Class{scrbook}\IndexClass{scrbook} and +\item[headings] is the page style with running headings in the + header. These are headings for which titles are automatically + inserted into the header. + \OnlyAt{\Class{scrbook}\and\Class{scrreprt}}With the classes + \Class{scrbook}\IndexClass{scrbook} and \Class{scrreprt}\IndexClass{scrreprt} the titles of chapters and - sections are repeated in the head\,---\,with {\KOMAScript} on the outer - side, with the standard classes on the inner side. The page number - comes with {\KOMAScript} on the outer side of the foot, with the - standard classes it comes on the inner side of the head. In - one-sided layouts only the headings of the chapters are used and - are, with {\KOMAScript}, centered in the head. The page numbers are - set with {\KOMAScript} centered in the foot. + sections are repeated in the header for double-sided + layout\,---\,with {\KOMAScript} on the outer side, with the standard + classes on the inner side. The page number is set on the outer side + of the footer with {\KOMAScript}, with the standard classes it is + set on the inner side of the header. In one-sided layouts only the + titles of the chapters are used and are, with {\KOMAScript}, + centered in the header. The page numbers are set centered in the + footer with {\KOMAScript}. \OnlyAt{\Class{scrartcl}}\Class{scrartcl}\IndexClass{scrartcl} behaves similarly, but starting a level deeper in the section hierarchy with sections and subsections, because the chapter level @@ -1272,11 +1352,11 @@ different page styles. While the standard classes automatically set running headings always in capitals, {\KOMAScript} applies the style of the title. This has several typographic reasons. Capitals as a decoration are actually - too strong. If one applies them nevertheless, they should be set - with a smaller type size and tighter spacing. The standard classes - don't take these points in consideration. + far too strong. If one applies them nevertheless, they should be set + in a one point smaller type size and with tighter spacing. The + standard classes do not take these points in consideration. \item [myheadings] corresponds mostly to the page style - \PValue{headings}, but the running headings s are not automatically + \PValue{headings}, but the running headings are not automatically produced, but have to be defined by the user. The commands \Macro {markboth}\IndexCmd{markboth} and \Macro{markright}\IndexCmd{markright} can be used for that purpose. @@ -1292,19 +1372,18 @@ changes only the style of the current page. The page style can be set at any time with the help of the \Macro{pagestyle} command and takes effect with the next page that is -output. Usually one sets the page style only once at the beginning of the -document or in the preamble. To change the page style of the current -page one uses the \Macro{thispagestyle} command. This also happens at -some places in the document automatically. For example, the -instruction \Macro{thispagestyle}\PParameter{plain} is issued -implicitly on the first page of a chapter. +output. Usually one sets the page style only once at the beginning of +the document or in the preamble. To change the page style of the +current page only, one uses the \Macro{thispagestyle} command. This +also happens automatically at some places in the document. For +example, the instruction \Macro{thispagestyle}\PParameter{plain} is +issued implicitly on the first page of a chapter. Please note that the change between automatic and manual running -headings is not performed by page style changes when using the -\Package{scrpage2} package, but instead special instructions must be -used. The page styles \PValue{headings} and \PValue{myheadings} should -not be used together with this package (see -\autoref{cha:scrpage}, +headings is no longer performed by page style changes when using the +\Package{scrpage2} package, but instead via special instructions. The +page styles \PValue{headings} and \PValue{myheadings} should not be +used together with this package (see \autoref{cha:scrpage}, \autopageref{desc:scrpage.pagestyle.useheadings}). % \EndIndex{Cmd}{pagestyle}% @@ -1315,15 +1394,15 @@ not be used together with this package (see \EndIndex{Pagestyle}{myheadings}% \BeginIndex[indexother]{}{type style}% -In order to change the type style used in the head, foot or for the -page number\ChangedAt{v2.8p}{% +In order to change the type style used in the header, footer or for +the page number\ChangedAt{v2.8p}{% \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}% , please use the interface described in -\autoref{sec:maincls.font}. The same element is used for head and -foot, which you can designate equivalently with +\autoref{sec:maincls.font}. The same element is used for header and +footer, which you can designate equivalently with \FontElement{pagehead}\IndexFontElement{pagehead} or \FontElement{pagefoot}\IndexFontElement{pagefoot}. The element for -the page number within the head or foot is called +the page number within the header or footer is called \FontElement{pagenumber}\IndexFontElement{pagenumber}. The default settings can be found in \autoref{tab:maincls.defaultFontsHeadFoot}. % @@ -1348,10 +1427,10 @@ settings can be found in \autoref{tab:maincls.defaultFontsHeadFoot}. % \begin{Example} \phantomsection\label{sec:maincls.pageStyle.example}% - Assume that you want to set head and foot in a smaller type size and - in italics. However, the page number should not be set in italics - but bold. Apart from the fact that the result will look horribly, - you can reach this as follows: + Assume that you want to set header and footer in a smaller type size + and in italics. However, the page number should not be set in + italics but bold. Apart from the fact that the result will look + horrible, you can obtain this as follows: \begin{lstlisting} \setkomafont{pagehead}{% \normalfont\normalcolor\itshape\small @@ -1376,15 +1455,15 @@ automatically for the running headings. For that, please use the If you define your own page styles, the commands \Macro{usekomafont}\PParameter{pagehead} and -\Macro{usekomafont}\PParameter {pagenumber} can find a meaningful use. -If you use for that not the \KOMAScript{} package \Package{scrpage2} -(see \autoref{cha:scrpage}), but, for example, the package +\Macro{usekomafont}\PParameter {pagenumber} can be useful. If you do +not use the {\KOMAScript} package \Package{scrpage2} (see +\autoref{cha:scrpage}) for that, but, for example, the package \Package{fancyhdr}\IndexPackage{fancyhdr} (see \cite{package:fancyhdr}), you can use these commands in your -definitions. Thereby you can remain compatible with \KOMAScript. If -you do not use these commands in your own definitions, changes like -those shown in the previous examples have no effect. The packages -\Package{scrpage}\IndexPackage{scrpage} and +definitions. Thereby you can remain compatible with {\KOMAScript} as +much as possible. If you do not use these commands in your own +definitions, changes like those shown in the previous examples have no +effect. The packages \Package{scrpage}\IndexPackage{scrpage} and \Package{scrpage2}\IndexPackage {scrpage2} take care to keep the maximum possible compatibility with other packages. % @@ -1403,7 +1482,10 @@ maximum possible compatibility with other packages. \BeginIndex{Cmd}{indexpagestyle}% For some pages a different page style is chosen with the help of the command \Macro{thispagestyle}. Which page style this actually is, is -defined by these four macros. The default values for all four cases is +defined by these four macros, of which \Macro{partpagestyle} and +\Macro{chapterpagestyle}\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} +are found only with classes \Class{scrbook} and \Class{scrreprt}, but +not in \Class{scrartcl}. The default value for all four cases is \PValue{plain}. The meaning of these macros can be taken from \autoref{tab:specialpagestyles}. % @@ -1429,9 +1511,9 @@ The page styles can be redefined with the \Macro{renewcommand} macro. \begin{lstlisting} \renewcommand*{\partpagestyle}{empty} \end{lstlisting} - As mentioned previously, the page style \PValue{empty} is exactly - what is required in this example. Naturally you can also use a - user-defined page style. +As mentioned previously on \autopageref{desc:maincls.pagestyle.empty}, +the page style \PValue{empty} is exactly what is required in this +example. Naturally you can also use a user-defined page style. Assume you have defined your own page style for initial chapter pages with the package \Package{scrpage2} (see @@ -1485,7 +1567,7 @@ The page styles can be redefined with the \Macro{renewcommand} macro. For sure, the page style \PValue{headings} is thereby applied to the initial page of a chapter. But nevertheless no running headings appear when using the \Option{openright} option. - The reason for this behaviour can be found in the \LaTeX{} + The reason for this behaviour can be found in the {\LaTeX} core. There, the command \Macro{rightmark}, that generates the marks for right-hand pages, is defined with; \begin{lstlisting} @@ -1537,21 +1619,22 @@ The page styles can be redefined with the \Macro{renewcommand} macro. \BeginIndex{Cmd}{cleardoublestandardpage}% \BeginIndex{Cmd}{cleardoubleplainpage}% \BeginIndex{Cmd}{cleardoubleemptypage}% -The \LaTeX{} core contains the \Macro{clearpage} command, which takes -care of the fact that all floats that have not yet been output and -starts a new page. There exists the instruction -\Macro{cleardoublepage} which works like \Macro{clearpage} but that, -in the double-sided layouts (see layout option \Option{twoside} in +The {\LaTeX} core contains the \Macro{clearpage} command, which takes +care that all not yet output floats are output, and then starts a new +page. There exists the instruction \Macro{cleardoublepage} which +works like \Macro{clearpage} but which, in the double-sided layouts +(see layout option \Option{twoside} in \autoref{sec:maincls.layoutOptions}, -\autopageref{desc:maincls.option.twoside}) starts a new right-hand page. -An empty left page in the current page style is output if necessary. +\autopageref{desc:maincls.option.twoside}) starts a new right-hand +page. An empty left page in the current page style is output if +necessary. -With \Macro{cleardoublestandardpage} \KOMAScript{} works as described +With \Macro{cleardoublestandardpage} {\KOMAScript} works as described above. The \Macro{cleardoubleplainpage} command changes the page style of the empty left page to \PValue{plain} in order to suppress the running heading. Analogously, the page style \PValue{empty} is applied to the empty page with \Macro{cleardoubleemptypage}, -suppressing the page number as well as the runnning title. The page is +suppressing the page number as well as the runnning heading. The page is thus entirely empty. However, the approach used by \Macro{cleardoublepage} is dependent on the layout options \Option{cleardoublestandard}, \Option{cleardoubleplain} and @@ -1574,23 +1657,24 @@ active option. \BeginIndex{Cmd}{ifthispageodd}% \BeginIndex{Cmd}{ifthispagewasodd}% \begin{Explain}% - A peculiarity of \LaTeX{} consists in the fact that it is not + A peculiarity of {\LaTeX} consists of the fact that it is not possible to determine on which page the current text will fall. It is also difficult to say whether the current page has an odd or an even page number. Now some will argue that there is, nevertheless, - the \TeX test macro \Macro{ifodd} which one needs only to apply to + the {\TeX} test macro \Macro{ifodd} which one needs only to apply to the current page counter. However, this is an error. At the time of - the evaluation of such a test \LaTeX{} does not know at all whether + the evaluation of such a test {\LaTeX} does not know at all whether the text just processed will be typeset on the current page or only - on the next. The page breaks take place not while reading the paragraph, - but only in the \emph{output} routine of \LaTeX{}. However, at that - moment a command of the form \verb|\ifodd\value{page}| would already - have been completely evaluated. + on the next. The page breaks take place not while reading the + paragraph, but only in the \emph{output} routine of + {\LaTeX}. However, at that moment a command of the form + \verb|\ifodd\value{page}| would already have been completely + evaluated. To find out reliably whether a text falls on an even or odd page, one must usually work with a label and a page reference to this label. One must also take special precautionary measures during - the first \LaTeX{} run, when the label is not yet known. + the first {\LaTeX} run, when the label is not yet known. \end{Explain} If one wants to find out with {\KOMAScript} whether a text falls on an even or odd page, one can use the \Macro {ifthispageodd} command. The @@ -1617,7 +1701,7 @@ page. Otherwise the \PName{false} argument is executed. \end{Example} Because the \Macro{ifthispageodd} command uses a mechanism that is -very similar to a label and a reference to it, at least two \LaTeX{} +very similar to a label and a reference to it, at least two {\LaTeX} runs are required after every text modification. Only then the decision is correct. In the first run a heuristic is used to make the first choice. @@ -1626,12 +1710,12 @@ first choice. \begin{Explain} There are situations where the \Macro{ifthispageodd} command never leads to the correct result. Suppose that the command is used within - a box. A box is set by \LaTeX{} always as a whole. No page breaks + a box. A box is set by {\LaTeX} always as a whole. No page breaks take place inside. Assume further that the \PName{true} part is very big, but the \PName{false} part is empty. If we suppose further that the box with the \PName {false} part still fits on the current, even page, but that with the \PName{true} part it does not. Further - assume that \KOMAScript{} heuristically decides for the first run + assume that {\KOMAScript} heuristically decides for the first run that the \PName{true} part applies. The decision is wrong and is revised in the next run. The \PName{false} part is thereby processed, instead of the \PName{true} part. The decision must again @@ -1652,14 +1736,14 @@ first choice. \Macro{pagenumbering}\Parameter{numbering style} \end{Declaration} \BeginIndex{Cmd}{pagenumbering}% -This command works the same way in \KOMAScript{} as in the standard -classes. More precisely it is a command from the \LaTeX{} kernel. You +This command works the same way in {\KOMAScript} as in the standard +classes. More precisely it is a command from the {\LaTeX} kernel. You can specify with this command the \PName{numbering style} of page numbers. The changes take effect immediately, hence starting with the page that contains the command. The possible settings can be found in \autoref{tab:numberKind}. Using the command \Macro{pagenumbering} -also resets the page counter\Index{page counter}\Index{page number}. -Thus the page number of the next page which \TeX{} outputs will have +also resets the page counter\Index{page>counter}\Index{page>number}. +Thus the page number of the next page which {\TeX} outputs will have the number 1 in the style \PName{numbering style}. % \begin{table} @@ -1711,17 +1795,17 @@ With the standard classes and with {\KOMAScript} all title pages are defined in a special environment, the \Environment{titlepage} environment. This environment always starts a new page\,---\,in the two-sided layout a new right page. For this page, the style is changed -as by \Macro{thispagestyle}\PParameter{empty}, so that neither page -number nor running title are output. At the end of the environment the -page is automatically shipped out. Should you not be able to use the -automatic layout of the title page, it is advisable to design a new -one with the help of this environment. +by \Macro{thispagestyle}\PParameter{empty}, so that neither page +number nor running heading are output. At the end of the environment +the page is automatically shipped out. Should you not be able to use +the automatic layout of the title page, it is advisable to design a +new one with the help of this environment. \begin{Example} - Assume you want a title page on which only the word " ` Me " ' - stands at the top on the left, as large as possible and in bold -- - no author, no date, nothing else. The following document makes just + Assume you want a title page on which only the word ``Me'' stands at + the top on the left, as large as possible and in bold\,---\,no + author, no date, nothing else. The following document creates just that: \begin{lstlisting} \documentclass{scrbook} @@ -1745,18 +1829,20 @@ items title, author and date, with {\KOMAScript} the \Macro{maketitle} command can produce up to six pages. In contrast to the standard classes, the \Macro{maketitle} macro in -{\KOMAScript} accepts an optional numeric argument. If it is used, the number -is made the page number of the first title page. However, this page number is -not output, but affects only the numbering. You should choose an odd number, -because otherwise the whole counting gets mixed up. In my opinion there are -only two meaningful applications for the optional argument. On the one hand, -one could give to the half-title\Index[indexmain]{half-title} the logical page -number \(-1\) in order to give the full title page the number 1. On the other -hand it could be used to start at a higher page number, for instance, 3, 5, or -7 to accommodate other title pages added by the publishing house. The -optional argument is ignored for \emph{in-page} titles. However the page style -of such a title page can be changed by redefining the \Macro{titlepagestyle} -macro. For that see \autoref{sec:maincls.pageStyle}, +{\KOMAScript} accepts an optional numeric argument. If it is used, +this number is made the page number of the first title page. However, +this page number is not output, but affects only the numbering. You +should choose an odd number, because otherwise the whole counting gets +mixed up. In my opinion there are only two meaningful applications for +the optional argument. On the one hand, one could give to the +half-title\Index[indexmain]{half-title} the logical page number \(-\)1 +in order to give the full title page the number 1. On the other hand, +it could be used to start at a higher page number, for instance, 3, 5, +or 7 to accommodate other title pages added by the publishing house. +The optional argument is ignored for \emph{in-page} titles. However, +the page style of such a title page can be changed by redefining the +\Macro{titlepagestyle} macro. For that see +\autoref{sec:maincls.pageStyle}, \autopageref{desc:maincls.macro.titlepagestyle}. The following commands do not lead necessarily to the production of the @@ -1774,9 +1860,9 @@ the preamble before \Macro{begin}\PParameter{document} (see \BeginIndex{Cmd}{extratitle}% In earlier times the inner book was often not protected from dirt by a cover. This task was then taken over by the first page of the book which - carried mostly a shortened title, precisely the \emph{half-title}. + carried mostly a shortened title called the \emph{half-title}. Nowadays the extra page is often applied before the real full title - and contains information on the publisher, series number and similar + and contains information about the publisher, series number and similar information. \end{Explain} @@ -1792,7 +1878,7 @@ takes place as part of the titles produced by \Macro{maketitle}. \begin{Example} Let's go back to the previous example and assume - that the spartan "Me" is the half-title. The full title should + that the spartan ``Me'' is the half-title. The full title should still follow the half-title. One can proceed as follows: \begin{lstlisting} \documentclass{scrbook} @@ -1838,7 +1924,7 @@ takes place as part of the titles produced by \Macro{maketitle}. \BeginIndex{Cmd}{and}% \BeginIndex{Cmd}{thanks}% The contents of the full title page are defined by six elements. The -\PName{title head}\Index[indexmain]{title head} is defined with the +\PName{title head}\Index[indexmain]{title>head} is defined with the command \Macro {titlehead}. It is typeset in regular paragraph style and full width at the top of the page. It can be freely designed by the user. @@ -1913,21 +1999,21 @@ the items are centered horizontally. The information is summarised in the university's name and address at the top, flush left, and the semester flush right. As usual a title is to be used, including author and delivery date. - The advisor must also be indicated, together with the fact that the + The adviser must also be indicated, together with the fact that the document is a dissertation. This can be obtained as follows: \begin{lstlisting} \documentclass{scrbook} \begin{document} \titlehead{{\Large Unseen University \hfill SS~2002\\} - Higher Analytical Institut\\ + Higher Analytical Institute\\ Mythological Rd\\ 34567 Etherworld} \subject{Dissertation} \title{Digital space simulation with the DSP\,56004} \author{Fuzzy George} \date{30. February 2002} - \publishers{Advisor Prof. John Excentric Doe} + \publishers{Adviser Prof. John Eccentric Doe} \maketitle \end{document} \end{lstlisting} @@ -1935,15 +2021,15 @@ the items are centered horizontally. The information is summarised in \begin{Explain} -A frequent misunderstanding concerns the role of the full title side. -It is often erroneous assumed that the cover (or dust cover) is meant. +A frequent misunderstanding concerns the role of the full title page. +It is often erroneously assumed that the cover (or dust cover) is meant. Therefore, it is frequently expected that the title page does not follow -the normal page layout, but have equally large left and right margins. +the normal page layout, but has equally large left and right margins. -However if one takes a book and opens it, one hits very quickly on at +However if one takes a book and opens it, one notices very quickly at least one title page under the cover within the so-called inner book. -Precisely these title pages are produced by \Macro{maketitle}. Like it -happens with the half-title, the full title page belongs to the inner +Precisely these title pages are produced by \Macro{maketitle}. As is +the case with the half-title, the full title page belongs to the inner book, and therefore should have the same page layout as the rest of the document. A cover is actually something that should be created in a separate document. The cover often has a very individual format. It @@ -2049,10 +2135,10 @@ whether one should not proceed likewise. \section{The Table of Contents} \label{sec:maincls.toc} -The titles are normally followed by the table of contents\Index{table -of contents}. -Often the table of contents is followed by lists of floats, e.g. lists -of tables and figures, see \autoref{sec:maincls.floats}). +The titles are normally followed by the table of contents\Index{table>of + contents}\Index{contents>table of}. Often the table of contents is followed +by lists of floats, e.\,g., lists of tables and figures (see +\autoref{sec:maincls.floats}). \begin{Declaration} \Macro{tableofcontents}\\ @@ -2060,69 +2146,75 @@ of tables and figures, see \autoref{sec:maincls.floats}). \end{Declaration}% \BeginIndex{Cmd}{tableofcontents}% \BeginIndex{Cmd}{contentsname}% - The production of the table of contents is done by the -\Macro{tableofcontents} command. -To get a correct table of contents, at least two \LaTeX{} runs are -necessary after every change. The option \Option{liststotoc} causes -the lists of figures and tables to be included in the table of -contents. \Option{idxtotoc} is the corresponding option for the index. -This is rather uncommon in classical typography. One finds the -bibliography included in the table of contents a little bit more -frequently. This can be obtained with the options \Option{bibtotoc} -and \Option{bibtotocnumbered}. These options are explained in -\autoref{sec:maincls.tocOptions}, +The production of the table of contents is done by the +\Macro{tableofcontents} command. To get a correct table of contents, +at least two {\LaTeX} runs are necessary after every change. The +option \Option{liststotoc} causes the lists of figures and tables to +be included in the table of contents. \Option{idxtotoc} is the +corresponding option for the index. This is rather uncommon in +classical typography. One does find the bibliography included in the +table of contents slightly more frequently. This can be obtained with +the options \Option{bibtotoc} and \Option{bibtotocnumbered}. These +options are explained in \autoref{sec:maincls.tocOptions}, \autopageref{desc:maincls.option.liststotoc}. \begin{Explain} - The table of contents is set as a not numbered chapter and is therefore - subjected to the side effects of the standard \Macro{chapter*} command, + The table of contents is set as an unnumbered chapter and is therefore + subject to the side effects of the standard \Macro{chapter*} command, which are described in \autoref{sec:maincls.structure}, \autopageref{desc:maincls.macro.chapter*}. However, the running - titles\Index{running title} for left and right pages are correctly filled - with the heading of the table of contents. The text of the heading is given - by the macro \Macro{contentsname}. + headings\Index{running heading} for left and right pages are correctly filled + with the heading of the table of contents. + + The text of the heading is given by the macro + \Macro{contentsname}. If you make use of a language package such as + \Package{babel}, please read the documentation of that package + before redefining this macro. \end{Explain}% \EndIndex{Cmd}{tableofcontents}% \EndIndex{Cmd}{contentsname}% - -There is only one variant for the construction of the table of -contents. The titles of the sectional units are indented so that the -unit number is flush left to the edge of the title of the next upper -unit. However, the place for the numbers is thereby limited and is -only sufficient for a little bit more than 1.5 places per level. -Should this become a problem, help can be found in \cite{DANTE:FAQ}. +There are two variants for the construction of the table of +contents. With the standard variant, the titles of the sectional units +are indented so that the unit number is flush left to the edge of the +text of the next upper sectional unit. However, the space for the +numbers is thereby limited and is only sufficient for a little more +than 1.5 places per unit level. Should this become a problem, the +option \Option{tocleft} can be used to set the behaviour such that all +entries in the table of contents are set flush left under one +another. As explained in \autoref{sec:maincls.tocOptions}, +\autopageref{desc:maincls.option.tocleft}, several {\LaTeX} runs are +needed. \begin{Explain} -The entry for the highest sectional unit below \Macro{part}, i.e., -\Macro{chapter} with \Class{scrbook}\IndexClass{scrbook} and -\Class{scrreprt}\IndexClass{scrreprt} or \Macro{section} with -\Class{scrartcl}\IndexClass {scrartcl} is not indented. It is however -affected by the settings of the element -\FontElement{disposition}\IndexFontElement{disposition} (see -\autoref{tab:maincls.elementsWithoutText}, -\autopageref{tab:maincls.elementsWithoutText}). There is no point -between the text of the sectional unit heading and the page number. The -typographic reasons for this are that the font is usually different -and the desire for appropriate emphasis. The table of contents of this -manual is a good example of these considerations.% + The entry for the highest sectional unit below \Macro{part}, i.\,e., + \Macro{chapter} with \Class{scrbook}\IndexClass{scrbook} and + \Class{scrreprt}\IndexClass{scrreprt} or \Macro{section} with + \Class{scrartcl}\IndexClass {scrartcl} is not indented. The font + style is however affected by the settings of the element + \FontElement{disposition}\IndexFontElement{disposition} (see + \autoref{tab:maincls.elementsWithoutText}, + \autopageref{tab:maincls.elementsWithoutText}). There are no dots + between the text of the sectional unit heading and the page + number. The typographic reasons for this are that the font is + usually different, and the desire for appropriate emphasis. The + table of contents of this manual is a good example of these + considerations.% \end{Explain} \begin{Declaration} \Counter{tocdepth} \end{Declaration}% \BeginIndex{Counter}{tocdepth}% -Normally, the units included in the table of contents are all the -units from \Macro{part} to \Macro{subsection} (for the classes -\Class{scrbook} and \Class{scrreprt}) or from \Macro{part} to -\Macro{subsubsection} (for the class \Class{scrartcl}). The inclusion -of a sectional unit in the table of contents is controlled by the -counter \Counter{tocdepth}. It has the value \(-1\) for \Macro{part}, -\(0\) for \Macro{chapter} and so on. Since the class \Class{scrartcl} has -no \Macro{chapter}, the counter starts with 0 for the \Macro{part}. By -setting, incrementing or decrementing the counter, one can choose the -lowest sectional unit level to be included in the table of contents. -The same happens with the standard classes. +Normally, the units included in the table of contents are all the units from +\Macro{part} to \Macro{subsection} (for the classes \Class{scrbook} and +\Class{scrreprt}) or from \Macro{part} to \Macro{subsubsection} (for the class +\Class{scrartcl}). The inclusion of a sectional unit in the table of contents +is controlled by the counter \Counter{tocdepth}. This has the value \(-\)1 for +\Macro{part}, 0 for \Macro{chapter}, and so on. By setting, incrementing +or decrementing the counter, one can choose the lowest sectional unit level to +be included in the table of contents. The same happens with the standard +classes. The user of the \Package{scrpage2}\IndexPackage{scrpage2} package (see \autoref{cha:scrpage}) does not need to remember the numerical @@ -2138,49 +2230,50 @@ macros \Macro{chapterlevel}, \Macro{sectionlevel} and so on down to \documentclass{scrartcl} \setcounter{tocdepth}{2} \end{lstlisting} -You set the counter \Counter{tocdepth} to 2, because you know that +You set the counter \Counter{tocdepth} to 2 because you know that this is the value for \Macro{subsection}. If you know that -\Class{scrartcl} normally includes all levels up to +\Class{scrartcl} normally includes all levels down to \Macro{subsubsection} in the table of contents, you can simply decrement the counter \Counter{tocdepth} by one: \begin{lstlisting} \documentclass{scrartcl} \addtocounter{tocdepth}{-1} \end{lstlisting} -How much you should add to or take from the \Counter{tocdepth} counter +How much you should add to or subtract from the \Counter{tocdepth} counter can also be found by looking at the table of contents after the first -\LaTeX{} run. +{\LaTeX} run. \end{Example} +A small hint in order that you do not need to remember which sectional +unit has which number: in the table of contents count the number of +units required extra or less and then, as in the above example, use +\Macro{addtocounter} to add or subtract that number to or from +\Counter{tocdepth}.% + +{\KOMAScript} has always attempted to avoid page breaking directly +between a sectional unit and the adjacent next lower unit, for +example, between a chapter title and its first section title. However, +the mechanism worked poorly or not at all until version~2.96. In +version~2.96a\ChangedAt{v2.96a}{% + \Class{scrbook} \and\Class{scrreprt} \and\Class{scrartcl}} the +mechanism was much improved and should now always work +correctly. There can be changes in the page breaking in the table of +contents as a result though. Thus, the new mechanism is only active, +if the compatibility option is not set to version~2.96 or less (see +option \Option{version}, \autoref{sec:maincls.compatibilityOptions}, +\autopageref{desc:maincls.option.version}). The mechanism also does +not work if the commands to generate the table of contents are +redefined, for example, by the use of the package \Package{tocloft}. % \EndIndex{Counter}{tocdepth}% -% TODO: Translate this: -\minisec{Sorry, Still waiting for translation:} -\KOMAScript{} hat schon immer versucht, im Inhaltsverzeichnis Umbrueche -unmittelbar zwischen einer Gliederungsebene und der zugehoerigen Unterebene, -also beispielsweise zwischen einer Kapitel- und der zugehoeriger erster -Abschnittsueberschrift, zu vermeiden. Leider funktionierte dieser Mechanismus -bis Version~2.96 sehr schlecht bis gar nicht. In -Version~2.96a\ChangedAt{v2.96a}{% - \Class{scrbook} \and\Class{scrreprt} \and\Class{scrartcl}} wurde er -erheblich verbessert und sollte nun immer funktionieren. Allerdings kann dies -zu Umbruchaenderungen im Inhaltsverzeichnis fuehren. Daher ist der neue -Mechanismus nur aktiv, wenn die Kompatibilitaet nicht auf Version~2.96 oder -kleiner eingestellt ist (siehe Option \Option{version}, -\autoref{sec:maincls.compatibilityOption}, -\autopageref{desc:maincls.option.version}). Der Mechanismus funktioniert auch -nicht mehr, wenn die Befehle zur Erzeugung der Inhaltsverzeichniseintraege -umdefiniert werden, etwa bei Verwendung des Pakets \Package{tocloft}. - \section{Lists of Floats} -As a rule, the lists of floats\index{float environments}, -e.g. list of tables\index{list of tables} and -list of figures\index{list of figures}, can be found directly -after the table of contents. -In some documents, they even can be found in the appendix. -However, the author of this manual prefers the location -after the table of contents, therefore it is discussed here. +As a rule, the lists of floats\Index{floating environments}, e.\,g., list of +tables\Index[indexmain]{list>of tables} and list of +figures\Index[indexmain]{list>of figures}, can be found directly after the +table of contents. In some documents, they can even be found in the appendix. +However, the author of this manual prefers their location after the table of +contents, therefore the explanation is given here. \begin{Declaration} \Macro{listoftables}\\ @@ -2192,21 +2285,21 @@ after the table of contents, therefore it is discussed here. \BeginIndex{Cmd}{listoffigures}% \BeginIndex{Cmd}{listtablename}% \BeginIndex{Cmd}{listfigurename}% -These commands generate a list of tables or figures. Changes in the document, -that modify these lists will require two \LaTeX{} runs in order to take -effect. The layout of the lists can be influenced by the options -\Option{listsindent} and \Option{listsleft}, see +These commands generate a list of tables or figures. Changes in the +document that modify these lists will require two {\LaTeX} runs in +order to take effect. The layout of the lists can be influenced by +the options \Option{listsindent} and \Option{listsleft} (see \autoref{sec:maincls.listsOptions}, -\autopageref{desc:maincls.option.listsleft}. Moreover, the options -\Option{liststotoc} and \Option{liststotocnumbered} have indirect influence, -see \autoref{sec:maincls.tocOptions}, +\autopageref{desc:maincls.option.listsleft}). Moreover, the options +\Option{liststotoc} and \Option{liststotocnumbered} have indirect +influence (see \autoref{sec:maincls.tocOptions}, \autopageref{desc:maincls.option.liststotoc}). \begin{Explain} -The terms of the titles of this tables are stored at the macros -\Macro{listtablename} and \Macro{listfigurename}. If you're using a language -package like \Package{babel} and want to change these terms, you should read -the documentation of the language package. + The text of the titles of this tables are stored in the macros + \Macro{listtablename} and \Macro{listfigurename}. If you use a + language package like \Package{babel} and want to redefine these + macros, you should read the documentation of the language package. \end{Explain} % \EndIndex{Cmd}{listoftables}% @@ -2218,21 +2311,21 @@ the documentation of the language package. \section{Main Text} \label{sec:maincls.mainText} -This section explains everything provided by \KOMAScript{} +This section explains everything provided by {\KOMAScript} in order to write the main text. The main text is the part that the author should focus on first. Of course this includes tables, figures and comparable information as well. -\subsection{Separation}{Separation\protect\OnlyAt{\Class{scrbook}}} +\subsection[{Separation}]{Separation\protect\OnlyAt{\Class{scrbook}}} \label{sec:maincls.separation} -Before\OnlyAt{\Class{scrbook}} getting to the main text eventually we will -have a short look at three commands which exist both in the standard class -\Class{book} and the {\KOMAScript} class \Class{scrbook}. They are used for -separation of the \emph{font matter}\Index{front matter}, the \emph{main - matter}\Index{main matter} and the \emph{back matter}\Index{back matter} of -a book. +Before\OnlyAt{\Class{scrbook}} getting to the main text we will have a +short look at three commands which exist both in the standard class +\Class{book} and the {\KOMAScript} class \Class{scrbook}. They are +used for separation of the \emph{front matter}\Index{front matter}, the +\emph{main matter}\Index{main matter} and the \emph{back + matter}\Index{back matter} of a book. \begin{Declaration} \Macro{frontmatter}\\ @@ -2242,24 +2335,31 @@ a book. \BeginIndex{Cmd}{frontmatter}% \BeginIndex{Cmd}{mainmatter}% \BeginIndex{Cmd}{backmatter}% -The macro \Macro{frontmatter} introduces the font matter in which roman -numbers are used for the page numbers. Chapter headings in a front matter -don't have any numbers. The foreword can be set as a normal chapter. -A foreword should never be divided into sections but kept short. -Therefore there is no need for a deeper structuring than chapter. - -\Macro{mainmatter} introduces the main matter with the main text. If there is -no fton matter this command can be omitted. The default in the main matter is -arabic page numbering (re)starting with 1. - -The back matter is introduced with \Macro{backmatter}. Opinions differ in -what should be part of the back matter. So in some cases you will only find -the bibliography\Index{bibliography}, in some cases only the -index\Index{index} and in other cases both of it and the appendix. -Besides, the chapters at the back matter are similar to the chapters at the -front matter, but page numbering doesn't change. Nevertheless you may use -command \Macro{pagenumbering} from \autoref{sec:maincls.pageStyle}, -\autopageref{desc:maincls.macro.pagenumbering} of you want to change this. +The macro \Macro{frontmatter} introduces the front matter in which +roman numerals are used for the page numbers. Chapter headings in a +front matter are not numbered. The section titles would be numbered, +start at chapter 0, and would be consecutively numbered across chapter +boundaries. However, this is of no import, as the front matter is used +only for the title pages, table of contents, lists of figures and +tables, and a foreword. The foreword can thus be set as a normal +chapter. A foreword should never be divided into sections but kept as +short as possible. Therefore in the foreword there is no need for a +deeper structuring than the chapter level. + +\Macro{mainmatter} introduces the main matter with the main text. If +there is no front matter then this command can be omitted. The default +page numbering in the main matter uses Arabic numerals (re)starting in +the main matter at 1. + +The back matter is introduced with \Macro{backmatter}. Opinions differ +in what should be part of the back matter. So in some cases you will +find only the bibliography\Index{bibliography}, in some cases only the +index\Index{index}, and in other cases both of these as well as the +appendices. The chapters in the back matter are similar to the +chapters in the front matter, but page numbering is not reset. If you +do require separate page numbering you may use the command +\Macro{pagenumbering} from \autoref{sec:maincls.pageStyle}, +\autopageref{desc:maincls.macro.pagenumbering}. % \EndIndex{Cmd}{frontmatter}% \EndIndex{Cmd}{mainmatter}% @@ -2288,50 +2388,68 @@ sections and so on. \BeginIndex{Cmd}{subsubsection}% \BeginIndex{Cmd}{paragraph}% \BeginIndex{Cmd}{subparagraph}% -The standard disposition commands in {\KOMAScript} work quite similar -to the standard classes. Normally the section headings show up in the -table of contents exactly as they are entered in the text. The entry -for the table of contents can be specified as an optional argument in -front of the actual heading. -\OnlyAt{\Class{scrartcl}}\Macro{chapter} only exists in book or -report classes but not in article classes. In addition to this, the -command \Macro{chapter} in {\KOMAScript} differs substantially from -the version in the standard class. While in the standard classes every -chapter number is used together with the prefix ``Chapter'' on a -separate line above the heading, {\KOMAScript} only places the chapter -number in front of the heading. - -Please note that \Macro{part} and \Macro{chapter} change the page -style for one page. The applied page style in \KOMAScript{} is defined -in \Macro{partpagestyle} and \Macro{chapterpagestyle} (see +The standard sectioning commands in {\KOMAScript} work in a similar +fashion to those of the standard classes. Thus, an alternative entry +for the table of contents and running headings can be specified as an +optional argument to the sectioning commands. + +The title of the level part (\Macro{part}) is distinguished from other +sectioning levels by being numbered independently from the other +parts. This means that the chapter level (in \Class{scrbook} or +\Class{scrreprt}), or the section level (in \Class{scrartcl}) is +numbered consecutively over all parts. Furthermore, for classes +\Class{scrbook} and \Class{scrreprt} the title of the part level +together with the corresponding preamble (see \Macro{setpartpreamble}, +\autopageref{desc:maincls.macro.setpartpreamble}) is set on a separate +page. + +\Macro{chapter} \OnlyAt{\Class{scrartcl}} only exists in book or +report classes, that is, in classes \Class{book}, \Class{scrbook}, +\Class{report} and \Class{scrreport}, but not in the article classes +\Class{article} and \Class{scrartcl}. In addition to this, the command +\Macro{chapter} in {\KOMAScript} differs substantially from the +version in the standard class. In the standard classes the chapter +number is used together with the prefix ``Chapter'', or the +corresponding word in the appropriate language, on a separate line +above the actual chapter title test. This overpowering style is +replaced in {\KOMAScript} by a simple chapter number before the +chapter heading text, can however be reverted by the option +\Option{chapterprefix} (see \autoref{sec:maincls.layoutOptions}, +\autopageref{desc:maincls.option.chapterprefix}). + +Please note that \Macro{part} and \Macro{chapter} in classes +\Class{scrbook} and \Class{scrreprt} +\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} change the page style for +one page. The applied page style in {\KOMAScript} is defined in the +macros \Macro{partpagestyle} and \Macro{chapterpagestyle} (see \autoref{sec:maincls.pageStyle}, \autopageref{desc:maincls.macro.titlepagestyle}). \BeginIndex[indexother]{}{font}% -\BeginIndex[indexother]{}{font size}% +\BeginIndex[indexother]{}{font>size}% The font of all headings\ChangedAt{v2.8p}{% \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} % can be changed with the commands \Macro{setkomafont}\IndexCmd{setkomafont} and \Macro{addtokomafont}\IndexCmd{addtokomafont} described in -\autoref{sec:maincls.font}. First of all the element -\FontElement{disposition}\IndexFontElement{disposition} is used, which -is followed by a specific element for every section level (see +\autoref{sec:maincls.font}. In doing this, generally the element +\FontElement{disposition}\IndexFontElement{disposition} is used, +followed by a specific element for every section level (see \autoref{tab:maincls.elementsWithoutText}, -\autopageref{tab:maincls.elementsWithoutText}). The font for the element -\FontElement{disposition}\IndexFontElement{disposition} is predefined as -\Macro{normalfont}\Macro{normalcolor}\Macro{sffamily}% -\Macro{bfseries}. The default font size for the specific elements depends -on the options \Option{bigheadings}, \Option{normalheadings} and -\Option{smallheadings} (see \autoref{sec:maincls.fontOptions}, -\autopageref{desc:maincls.option.smallheadings}). The -defaults are listed in \autoref{tab:maincls.structureElementsFont} +\autopageref{tab:maincls.elementsWithoutText}). The font for the +element \FontElement{disposition}\IndexFontElement{disposition} is +predefined as \Macro{normalfont}\Macro{normalcolor}\Macro{sffamily}% +\Macro{bfseries}. The default font size for the specific elements +depends on the options \Option{bigheadings}, \Option{normalheadings} +and \Option{smallheadings} (see \autoref{sec:maincls.fontOptions}, +\autopageref{desc:maincls.option.smallheadings}). The defaults are +listed in \autoref{tab:maincls.structureElementsFont} % \begin{table} \centering% \caption[{Default font sizes for different levels of document structuring}]{Default font sizes for different levels of document - structuring at \Class{scrbook} and \Class{scrreprt}} + structuring in \Class{scrbook} and \Class{scrreprt}} \begin{tabular}{lll} \toprule class option & element & default\\ @@ -2378,69 +2496,74 @@ defaults are listed in \autoref{tab:maincls.structureElementsFont} \end{table} \begin{Example} - Suppose you are using the class option \Option{bigheadings} and notice - that the very big headings of document parts are to bold. You could change - this as follows: + Suppose you are using the class option \Option{bigheadings} and + notice that the very big headings of document parts are too + bold. You could change this as follows: \begin{lstlisting} \setkomafont{disposition}{\normalcolor\sffamily} \part{Appendices} \addtokomafont{disposition}{\bfseries} \end{lstlisting} - Using the command above you only switch off the font attribute - \textbf{bold} for the heading ``Appendices''. A much more comfortable - and elegant solution is to change all \Macro{part} headings in one go. - This is done either by: +Using the command above you only switch off the font attribute +\textbf{bold} for a heading ``Appendices''. A much more comfortable +and elegant solution is to change all \Macro{part} headings at once. +This is done either by: \begin{lstlisting} \addtokomafont{part}{\normalfont\sffamily} \addtokomafont{partnumber}{\normalfont\sffamily} \end{lstlisting} - or using: + or simply using: \begin{lstlisting} \addtokomafont{part}{\mdseries} \addtokomafont{partnumber}{\mdseries} \end{lstlisting} - The last version is to be preferred because it gives you the correct - result even when you change the \FontElement{disposition} - element\IndexFontElement{disposition} as follows: +The last version is to be preferred because it gives you the correct +result even when you make changes to the \FontElement{disposition} +element\IndexFontElement{disposition}, for instance: \begin{lstlisting} \setkomafont{disposition}{\normalcolor\bfseries} \end{lstlisting} - With this change it is possible to set all section levels at once to not + With this change it is possible to set all section levels at once to no longer use sans serif fonts. \end{Example} -Please be warned of using the possibilities of font switching to mix fonts, -font sizes and font attributes excessively. Picking the most suitable font for -a given task is a hard thing even for professionals and has nothing to do with -personal taste of beginners. Please refer to the citation at the end of -\autoref{sec:typearea.tips}, \autopageref{sec:typearea.tips.cite} and the -following explanation. +Please be warned of misusing the possibilities of font switching to +mix fonts, font sizes and font attributes excessively. Picking the +most suitable font for a given task is a hard task even for +professionals and has almost nothing to do with the personal tastes of +non-experts. Please refer to the citation at the end of +\autoref{sec:typearea.tips}, \autopageref{sec:typearea.tips.cite} and +to the following explanation. \begin{Explain} - It is possible to use different font types for different section levels - in {\KOMAScript}. As a typographical beginner you should refrain from - using these possibilities for typographical reasons. - - There is a rule which states that you should mix fonts only as few as - possible. Using sans serif for headings seems already a breach of this - rule. However, you should know that bold, huge and serif letters are much to - heavy for headings. In general you would have to use a normal instead of a - bold or semi bold font. However, in deeper levels of the structuring a - normal font appears rather leight weighted. On the other hand sans serif - fonts in headings have a very pleasant appearance and are to be used only in - headings. That's why sans serif is the default in {\KOMAScript}. - - More variety should be avoided. Font mixing is only for professionals. In - case you want to use other fonts than the standard \TeX-Fonts\,---\,no matter - whether using CM \Index{CM fonts} or EC fonts\Index{EC fonts}\,---\,you should - consult an expert or redefine the font for the element - \FontElement{disposition}\IndexFontElement{disposition} as seen in the example - above. You often find the combinations Times and Helvetica or Palatino with - Helvetica. The author of this documentation does not favour these - combinations. + It is possible to use different font types for different section + levels in {\KOMAScript}. Non-experts in typography should for very + good typographical reasons refrain absolutely from using these + possibilities. + + There is a rule in typography which states that one should mix as + few fonts as possible. Using sans serif for headings already seems + to be a breach of this rule. However, one should know that bold, + large serif letters are much to heavy for headings. Strictly + speaking, one would then have to at least use a normal instead of a + bold or semi bold font. However, in deeper levels of the structuring + a normal font may then appear too lightly weighted. On the other + hand, sans serif fonts in headings have a very pleasant appearance + and in fact find acceptance almost solely for headings. That is why + sans serif is the carefully chosen default in {\KOMAScript}. + + More variety should however be avoided. Font mixing is only for + professionals. In case you want to use other fonts than the standard + {\TeX} fonts\,---\,regardless of whether these are CM \Index{CM + fonts}, EC \Index{EC fonts} or LM fonts \Index{LM fonts}\,---\,you + should consult an expert, or for safety's sake redefine the font for + the element \FontElement{disposition}\IndexFontElement{disposition} + as seen in the example above. The author of this documentation + considers the commonly encountered combinations Times and Helvetica + or Palatino with Helvetica as unfavourable. \end{Explain} \EndIndex[indexother]{}{font}% -\EndIndex[indexother]{}{font size}% +\EndIndex[indexother]{}{font>size}% % \EndIndex{Cmd}{part}% \EndIndex{Cmd}{chapter}% @@ -2467,30 +2590,31 @@ following explanation. \BeginIndex{Cmd}{subsubsection*}% \BeginIndex{Cmd}{paragraph*}% \BeginIndex{Cmd}{subparagraph*}% -All disposition commands exist as ``starred'' versions. They produce -section headings which do not show up in the table of -contents\Index{table of contents}, in the page header\Index{header} -and which are not numbered\Index{numbering}. Not using a headline -often has an unwanted side effect. For example, if a chapter which is -set using \Macro{chapter*} spans over several pages the headline of -the chapter before comes up again. {\KOMAScript} offers a solution -which is described below. -\OnlyAt{\Class{scrartcl}}\Macro{chapter*} only exists in book and -report classes which includes \Class{book}, \Class{scrbook}, -\Class{report} and \Class{scrreport}, but not the article classes -\Class{article} and \Class{scrartcl}. +All disposition commands have starred versions, which are +unnumbered\Index{numbering}, and produce section headings which do not +show up in the table of contents\Index{table>of contents}\Index{contents>table + of} or in in the +running heading\Index{header}. The absence of a running heading often +has an unwanted side effect. For example, if a chapter which is set +using \Macro{chapter*} spans several pages, then the running heading +of the previous chapter suddenly reappears. {\KOMAScript} offers a +solution for this which is described +below. \OnlyAt{\Class{scrbook}\and\Class{scrreprt}}\Macro{chapter*} +only exists in book and report classes, that is, \Class{book}, +\Class{scrbook}, \Class{report} and \Class{scrreport}, but not the +article classes \Class{article} and \Class{scrartcl}. Please note that \Macro{part} and \Macro{chapter} change the page -style for one page. The applied style is defined in -\Macro{partpagestyle} and \Macro{chapterpagestyle} in \KOMAScript{} +style for one page. The applied style is defined in the macros +\Macro{partpagestyle} and \Macro{chapterpagestyle} in {\KOMAScript} (see \autoref{sec:maincls.pageStyle}, \autopageref{desc:maincls.macro.titlepagestyle}). As for the possibilities of font switching\ChangedAt{v2.8p}{% - \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} % -the same explanations apply which were given above with the normal -disposition commands. The elements of structuring are named in the same -way as the ``unstarred'' versions. + \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}, % +the same explanations apply as were given above for the unstarred +variants. The structuring elements are named the same since they do +not indicate variants but structuring levels. % \EndIndex{Cmd}{part*}% \EndIndex{Cmd}{chapter*}% @@ -2500,9 +2624,10 @@ way as the ``unstarred'' versions. \EndIndex{Cmd}{paragraph*}% \EndIndex{Cmd}{subparagraph*}% -\iffalse In the standard classes there are no further disposition commands. In -particular, there are no commands which produce unnumbered chapters or -sections which show up in the table of contents or in the page header. \fi +\iffalse In the standard classes there are no further structuring +commands. In particular, there are no commands which can produce +unnumbered chapters or sections which show up in the table of contents +and in the running heading. \fi \begin{Declaration} \Macro{addpart}\OParameter{Short version}\Parameter{Heading}\\ @@ -2518,38 +2643,39 @@ sections which show up in the table of contents or in the page header. \fi \BeginIndex{Cmd}{addchap*}% \BeginIndex{Cmd}{addsec}% \BeginIndex{Cmd}{addsec*}% -In addition to the standard classes {\KOMAScript} offers the new -commands \Macro{addsec} and \Macro{addchap}. They are similar to the -standard commands \Macro{chapter} und \Macro{section} except the -missing numbering. The produce both a running headline and an entry in -the table of contents. The starred versions \Macro{addchap*} and -\Macro{addsec*} are similar to the standard commands \Macro{chapter*} -and \Macro{section*} apart from a tiny but important difference: The -headlines are deleted. This eliminates the side effect of obsolete -headers mentioned above. \OnlyAt{\Class{scrartcl}}\Macro{addchap} -and \Macro{addchap*} of course only exist in book and report classes, -namely \Class{book}, \Class{scrbook}, \Class{report} and -\Class{scrreport}, but not in the article classes \Class{article} and -\Class{scrartcl}. - -Similar to this, the command \Macro{addpart} produces an unnumbered -document part with an entry in the table of contents. Since the -headers are already deleted by \Macro{part} and \Macro{part*} the -problem of obsolete headers doesn't exist. The starred version -\Macro{addpart*} is identical to \Macro{part*} and is only defined for -consistency reasons. - -Please note that \Macro{addpart} and \Macro{addchap} including their -starred versions change the page style for one page. The particular -page style is defined in the macros \Macro{partpagestyle} and +In addition to the commands of the standard classes {\KOMAScript} +offers the new commands \Macro{addsec} and \Macro{addchap}. They are +similar to the standard commands \Macro{chapter} and +\Macro{section} except that they are unnumbered. They thus produce +both a running heading and an entry in the table of contents. The +starred variants \Macro{addchap*} and \Macro{addsec*} are similar to +the standard commands \Macro{chapter*} and \Macro{section*} except for +a tiny but important difference: The running headings are +deleted. This eliminates the side effect of obsolete headers mentioned +above. Instead, the running headings on following pages remain +empty. \OnlyAt{\Class{scrartcl}}\Macro{addchap} and \Macro{addchap*} +of course only exist in book and report classes, namely \Class{book}, +\Class{scrbook}, \Class{report} and \Class{scrreport}, but not in the +article classes \Class{article} and \Class{scrartcl}. + +Similarly, the command \Macro{addpart} produces an unnumbered document +part with an entry in the table of contents. Since the running +headings are already deleted by \Macro{part} and \Macro{part*} the +problem of obsolete headers does not exist. The starred version +\Macro{addpart*} is thus identical to \Macro{part*} and is only +defined for consistency reasons. + +Please note that \Macro{addpart} and \Macro{addchap} and their starred +versions change the page style for one page. The particular page style +is defined in the macros \Macro{partpagestyle} and \Macro{chapterpagestyle} (see \autoref{sec:maincls.pageStyle}, \autopageref{desc:maincls.macro.titlepagestyle}). As for the possibilities of font switching\ChangedAt{v2.8p}{% - \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} % -the same explanations apply which were given above with the normal -disposition commands. The elements of structuring are named in the same -way as the ``unstarred'' versions. + \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}, % +the same explanations apply as given above for the normal structuring +commands. The elements are named the same since they describe not +variants but structuring levels. % \EndIndex{Cmd}{addpart}% \EndIndex{Cmd}{addpart*}% @@ -2564,17 +2690,17 @@ way as the ``unstarred'' versions. \end{Declaration}% \BeginIndex{Cmd}{minisec}% Sometimes a heading\Index{heading} is wanted which is highlighted but -closely linked to the following text. Such a heading shouldn't be -separated by a vertical skip. +also closely linked to the following text. Such a heading should not +be separated by a large vertical skip. -The command \Macro{minisec} is designed for this situation. This heading -isn't linked to a level of structuring. Such a \emph{Mini-section} -does not produce an entry in the table of contents nor does it receive -any numbering. +The command \Macro{minisec} is designed for this situation. This +heading is not associated with any structuring level. Such a +\emph{mini section} does not produce an entry in the table of contents +nor does it receive any numbering. \begin{Example} You have developed a kit for building a mouse trap and want the - documentation separated into the things needed and an assembly - description. Using \Macro{minisec} you could write the following: + documentation separated into a list of necessary items and an + assembly description. You could write the following: \begin{lstlisting} \minisec{Items needed} @@ -2589,18 +2715,16 @@ any numbering. \end{flushleft} \minisec{Assembly} - At first one searches the mouse-hole and puts the - drawing pin directly behind the hole. - Thus the mouse cannot escape meanwhile the following - actions. - - Afterwards one knocks in the spring-plug with the hammer - in the mouse-hole. - If the spring-plug's size is not big enough in order to - shut the mouse-hole entirely, then one can utilize - the plank instead and fasten it with the two screws - employing the knife on the mouse-hole. - Instead of the knife one can use a screw-driver as well. + At first one searches the mouse-hole and puts the drawing pin + directly behind the hole. Thus the mouse cannot escape during the + following actions. + + Then one knocks the spring-plug with the hammer into the mouse-hole. + If the spring-plug's size is not big enough in order to shut the + mouse-hole entirely, then one can utilize the plank instead and + fasten it against the front of the mouse-hole utilizing the two + screws and the knife. Instead of the knife one can use a + screw-driver instead. \end{lstlisting} Which gives: \begin{ShowOutput}[\baselineskip]\setlength{\parindent}{1em} @@ -2617,28 +2741,28 @@ any numbering. \end{flushleft} \minisec{Assembly} - At first one searches the mouse-hole and puts the drawing pin - directly behind the hole. Thus the mouse cannot escape - meanwhile the following actions. - - Afterwards one knocks in the spring-plug with the hammer - in the mouse-hole. - If the spring-plug's size is not big enough in order to - shut the mouse-hole entirely, then one can utilize - the plank instead and fasten it with the two screws - employing the knife on the mouse-hole. - Instead of the knife one can use a screw-driver as well. + At first one searches the mouse-hole and puts the drawing pin + directly behind the hole. Thus the mouse cannot escape during the + following actions. + + Then one knocks the spring-plug with the hammer into the + mouse-hole. If the spring-plug's size is not big enough in order + to shut the mouse-hole entirely, then one can utilize the plank + instead and fasten it against the front of the mouse-hole + utilizing the two screws and the knife. Instead of the knife one + can use a screw-driver instead. \end{ShowOutput} \end{Example} -The font type of the disposition command \Macro{minisec} be -changed using the element +The font type of the structuring command \Macro{minisec} be changed +using the element \FontElement{disposition}\IndexFontElement{disposition} (see \autoref{tab:maincls.elementsWithoutText}, -\autopageref{tab:maincls.elementsWithoutText}) or +\autopageref{tab:maincls.elementsWithoutText}) and \FontElement{minisec}\ChangedAt{2.96a}{% - \Class{scrbook} \and\Class{scrreprt} \and\Class{scrartcl}}. Default setting -of element \FontElement{minisec} is empty. + \Class{scrbook} \and\Class{scrreprt} \and\Class{scrartcl}}. Default +setting of element \FontElement{minisec} is empty, so the default of +the element \FontElement{disposition} is active. % \EndIndex{Cmd}{minisec}% @@ -2650,27 +2774,27 @@ of element \FontElement{minisec} is empty. In the standard classes headings are set as justified text. That means that hyphenated words can occur and headings with more than one line are stretched up to the text border. This is a rather uncommon -approach in typography. {\KOMAScript} formats the headings left -aligned with hanging indentation using \Macro{raggedsection} with the -definition: +approach in typography. {\KOMAScript} therefore formats the headings +left aligned with hanging indentation using \Macro{raggedsection} with +the definition: \begin{lstlisting} \newcommand*{\raggedsection}{\raggedright} \end{lstlisting} This command can be redefined with \Macro{renewcommand}. \begin{Example} - You prefer justified headings. You write in the preamble of your document: + You prefer justified headings, so you write in the preamble of your document: \begin{lstlisting} \renewcommand*{\raggedsection}{} \end{lstlisting} - or short: + or more compactly: \begin{lstlisting} \let\raggedsection\relax \end{lstlisting} - You will get a formatting of the headings which is very close to the - standard classes. Even closer it will get when you combine this change - with the change of the element - \FontElement{disposition}\IndexFontElement{disposition} mentioned - above. +You will get a formatting of the headings which is very close to that +of the standard classes. It will become even closer when you combine +this change with the change of the element +\FontElement{disposition}\IndexFontElement{disposition} mentioned +above. \end{Example} % \EndIndex{Cmd}{raggedsection}% @@ -2687,39 +2811,42 @@ This command can be redefined with \Macro{renewcommand}. \BeginIndex{Cmd}{chapterformat}% \BeginIndex{Cmd}{othersectionlevelsformat}% \BeginIndex{Cmd}{autodot}% - As you might know, for every counter in {\LaTeX} there is a command - \Macro{the}\PName{counter name}, which gives you the value of the - counter. Depending on the class the counter for a particular level - starting from \Macro{section} (\Class{book}, \Class{scrbook}, - \Class{report}, \Class{scrreprt}) or \Macro{subsection} - (\Class{article}, \Class{scrartcl}) is composed of the counter for the - higher level followed by a dot and the arabic number of the - \PName{counter name} of the respective level.\par +As you might know, for every counter in {\LaTeX} there is a command +\Macro{the}\PName{countername}, which outputs the value of the +counter. Depending on the class the counter for a particular level +starting from \Macro{section} (\Class{book}, \Class{scrbook}, +\Class{report}, \Class{scrreprt}) or \Macro{subsection} +(\Class{article}, \Class{scrartcl}) is composed of the counter for the +next higher level followed by a dot and the Arabic number of the +\PName{countername} of the respective level.\par \end{Explain} -\KOMAScript{} has added to the output of the section number a further -logical level. The counter for the respective heading are formatted -using \Macro{partformat}, \Macro{chapterformat} and -\Macro{othersectionlevelsformat}. +{\KOMAScript} has added a further logical level to the output of the +section number. The counters for the respective heading are not merely +output. They are formatted using the commands \Macro{partformat}, +\Macro{chapterformat} and \Macro{othersectionlevelsformat}. \OnlyAt{\Class{scrbook}\and\Class{scrreprt}}Of course the command -\Macro{chapterformat} doesn't exist in the class \Class{scrartcl}. +\Macro{chapterformat} like \Macro{thechapter} does not exist in the +class \Class{scrartcl} but only in the classes \Class{scrbook} and +\Class{scrreprt}. As described in \autoref{sec:maincls.formattingOptions}, -\autopageref{desc:maincls.option.pointlessnumbers} -{\KOMAScript} handles dots in section numbers according to -\cite{DUDEN}. The command \Macro{autodot} makes sure that these rules -are being followed. Except from \Macro{part} in all levels a dot is -followed by a \Macro{enskip}. This is similar to a horizontal skip of -\(0.5\Unit{em}\). - -The command \Macro{othersectionlevelsformat} takes the name of the -section level, such as ``\PName{section}'', ``\PName{subsection}'' -\dots{}, as parameter. As default, only the levels \Macro{part} and -\Macro{chapter} have formatting commands on their own, while all other -section levels are covered by one formatting command only. This has -historical reasons. At the time Werner Lemberg suggested a suitable -extension of {\KOMAScript} for his \Package{CJK} package, only this -differentiation was needed. +\autopageref{desc:maincls.option.pointlessnumbers}, dots in section +numbers should be handled for the German-speaking region according to +the rules given in \cite{DUDEN}. The command \Macro{autodot} in +{\KOMAScript} ensures that these rules are being followed. In all +levels except for \Macro{part} a dot is followed by a further +\Macro{enskip}. This corresponds to a horizontal skip of +0.5\Unit{em}. + +The command \Macro{othersectionlevelsformat} takes as a parameter the +name of the section level, such as ``\PName{section}'', +``\PName{subsection}'' \dots{} Per default therefore, only the levels +\Macro{part} and \Macro{chapter} have formatting commands of their +own, while all other section levels are covered by one general +formatting command. This has historical reasons. At the time that +Werner Lemberg suggested a suitable extension of {\KOMAScript} for his +\Package{CJK} package, only this differentiation was needed. The formatting commands can be redefined using \Macro{renewcommand} to fit them to your personal needs. The following original definitions @@ -2733,31 +2860,31 @@ are used by the {\KOMAScript} classes: \end{lstlisting} \begin{Example} - Assume you don't want the word ``Part'' written in front of the part number. - You could use the following command in the preamble of your document: + Assume that when using \Macro{part} you do not want the word + ``Part'' written in front of the part number. You could use the + following command in the preamble of your document: \begin{lstlisting} \renewcommand*{\partformat}{\thepart\autodot} \end{lstlisting} - In fact, you could do without \Macro{autodot} at this point and insert - a fixed point instead. As \Macro{part} is numbered with roman numbers, - according to \cite{DUDEN} a dot has to be applied. However, you would - give up the possibility to use one of the options - \Option{pointednumbers} und \Option{pointlessnumbers} then. More - details concerning class options you can find in - \autoref{sec:maincls.formattingOptions}, - \autopageref{desc:maincls.option.pointlessnumbers}). +Strictly speaking, you could do without \Macro{autodot} at this point +and insert a fixed dot instead. As \Macro{part} is numbered with roman +numerals, according to \cite{DUDEN} a dot has to be applied. However, +you thereby give up the possibility to use one of the options +\Option{pointednumbers} and \Option{pointlessnumbers} and optionally +depart from the rules. More details concerning class options can be +found in \autoref{sec:maincls.formattingOptions}, +\autopageref{desc:maincls.option.pointlessnumbers}. - An additional possibility could be to place the section numbers - in the left margin. That can be done in a way that the heading - text is left aligned with the surrounding text. - This can be accomplished with: +An additional possibility could be to place the section numbers in the +left margin in such a way that the heading text is left aligned with +the surrounding text. This can be accomplished with: \begin{lstlisting} \renewcommand*{\othersectionlevelsformat}[1]{% \llap{\csname the#1\endcsname\autodot\enskip}} \end{lstlisting} - The almost unknown command \Macro{llap} in the definition above, - puts its argument left to the current possition without changing the - position. A much better \LaTeX{} solution would be: +The little known {\TeX} command \Macro{llap} in the definition above +puts its argument left of the current position without changing the +position thereby. A much better {\LaTeX} solution would be: \begin{lstlisting} \renewcommand*{\othersectionlevelsformat}[1]{% \makebox[0pt][r]{% @@ -2781,18 +2908,19 @@ are used by the {\KOMAScript} classes: \BeginIndex{Cmd}{chapapp}% These\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}% \ChangedAt{v2.8o}{\Class{scrbook}\and\Class{scrreprt}} two commands -are used internally by {\KOMAScript} and are also provided at the user -interface. Using the layout option \Option{chapterprefix} (see -\autoref{sec:maincls.layoutOptions}, +are not only used internally by {\KOMAScript} but are also provided to +the user. Later it will be shown how they can be used for example to +redefine other commands. Using the layout option +\Option{chapterprefix} (see \autoref{sec:maincls.layoutOptions}, \autopageref{desc:maincls.option.chapterprefix}) -\Macro{chapappifchapterprefix} issues the word -``Chapter''\Index{chapter} in the main part of your document in the -current language followed by \PName{additional text}. In the -appendix\Index{appendix} instead, the word ``Appendix'' in the current -language followed by \PName{additional text} is issued. Having set the -option \Option{nochapterprefix} there is no additional output. - -The command \Macro{chapapp} always issues the word ``Chapter'' or +\Macro{chapappifchapterprefix} outputs the word +``Chapter''\Index{chapter} in the main part of the document in the +current language, followed by \PName{additional text}. In the +appendix\Index{appendix}, the word ``Appendix'' in the current +language is output instead, followed by \PName{additional text}. If the +option \Option{nochapterprefix} is set, then nothing is output. + +The command \Macro{chapapp} always outputs the word ``Chapter'' or ``Appendix''. In this case the options \Option{chapterprefix} and \Option{nochapterprefix} have no effect. @@ -2804,9 +2932,9 @@ Since chapters only exist in the classes \Class{scrbook} and \begin{Declaration} - \Macro{chaptermark}\Parameter{Running head}\\ - \Macro{sectionmark}\Parameter{Running head}\\ - \Macro{subsectionmark}\Parameter{Running head}\\ + \Macro{chaptermark}\Parameter{Running heading}\\ + \Macro{sectionmark}\Parameter{Running heading}\\ + \Macro{subsectionmark}\Parameter{Running heading}\\ \Macro{chaptermarkformat}\\ \Macro{sectionmarkformat}\\ \Macro{subsectionmarkformat} @@ -2819,32 +2947,32 @@ Since chapters only exist in the classes \Class{scrbook} and \BeginIndex{Cmd}{subsectionmarkformat}% \begin{Explain}% As mentioned in \autoref{sec:maincls.pageStyle} the page style - \PValue{headings} works with running heads\Index{running - head}. For this, the commands \Macro{chaptermark} and - \Macro{sectionmark} as well as \Macro{sectionmark} and - \Macro{subsectionmark} respectively are defined. Every disposition - command (\Macro{chapter}, \Macro{section}, \Macro{subsection} \dots) + \PValue{headings} works with automatic running + headings\Index{running heading}. For this, the commands + \Macro{chaptermark} and \Macro{sectionmark}, or \Macro{sectionmark} + and \Macro{subsectionmark}, respectively, are defined. Every + structuring command (\Macro{chapter}, \Macro{section} \dots) automatically carries out the respective \Macro{\dots mark} command. - The parameter handed over takes the text of the section + The parameter passed contains the text of the section heading\Index{heading}. The respective section number is added - automatically to the \Macro{\dots mark} command. The formatting is done - according to the section level with the command + automatically in the \Macro{\dots mark} command. The formatting is + done according to the section level with one of the three commands \Macro{chaptermarkformat}, \Macro{sectionmarkformat} or \Macro{subsectionmarkformat}. \OnlyAt{\Class{scrbook}\and\Class{scrreprt}}Of course there is no command \Macro{chaptermark} or \Macro{chaptermarkformat} in - \Class{scrartcl}. \OnlyAt{\Class{scrartcl}}Accordingly - \Macro{subsectionmark} and the command \Macro{subsectionmarkformat} - only exist in \Class{scrartcl}. This changes when you use the + \Class{scrartcl}. \OnlyAt{\Class{scrartcl}}Accordingly, + \Macro{subsectionmark} and \Macro{subsectionmarkformat} exist only + in \Class{scrartcl}. This changes when you use the \Package{scrpage2} package (see \autoref{cha:scrpage}).\par \end{Explain} -Similar to \Macro{chapterformat} and \Macro{othersectionlevelsformat} the -commands \Macro{chaptermarkformat} (not at \Class{scrartcl}), -\Macro{sectionmarkformat} and the command \Macro{subsectionmarkformat} -(only at \Class{scrartcl}) define the formatting of the section numbers -in running heads. They can be adapted to your personal needs with -\Macro{renewcommand}. The original definitions from the {\KOMAScript} -classes are: +Similar to \Macro{chapterformat} and \Macro{othersectionlevelsformat}, +the commands \Macro{chaptermarkformat} (not in \Class{scrartcl}), +\Macro{sectionmarkformat} and \Macro{subsectionmarkformat} (only in +\Class{scrartcl}) define the formatting of the sectioning numbers in +the automatic running headings. They can be adapted to your personal +needs with \Macro{renewcommand}. The original definitions for the +{\KOMAScript} classes are: \begin{lstlisting} \newcommand*{\chaptermarkformat}{% \chapappifchapterprefix{\ }\thechapter\autodot\enskip} @@ -2853,16 +2981,16 @@ classes are: \thesubsection\autodot\enskip} \end{lstlisting} \begin{Example} - Suppose you want to combine the chapter number in the header with the word - ``Chapter''. For example you could insert in the preamble of your - document the following definition: + Suppose you want to prepend the word ``Chapter'' to the chapter + number in the running heading. For example you could insert the + following definition in the preamble of your document : \begin{lstlisting} \renewcommand*{\chaptermarkformat}{% \chapapp~\thechapter\autodot\enskip} \end{lstlisting} \end{Example} -As you can see both the commands \Macro{chapappifchapterprefix} and -\Macro{chapapp} explained above are used. +As you can see, both the commands \Macro{chapappifchapterprefix} and +\Macro{chapapp} explained above are used here. % \EndIndex{Cmd}{chaptermark}% \EndIndex{Cmd}{sectionmark}% @@ -2876,21 +3004,20 @@ As you can see both the commands \Macro{chapappifchapterprefix} and \Counter{secnumdepth} \end{Declaration}% \BeginIndex{Counter}{secnumdepth}\BeginIndex{}{numbering}% -As default in the classes \Class{scrbook}\IndexClass{scrbook} and +Per default, in the classes \Class{scrbook}\IndexClass{scrbook} and \Class{scrreprt}\IndexClass{scrreprt} the section levels from \Macro{part}\IndexCmd{part}\IndexCmd{chapter}\IndexCmd{section} down to \Macro{subsection}\IndexCmd{subsection} and in the class \Class{scrartcl}\IndexClass{scrartcl} the levels from \Macro{part} down to \Macro{subsubsection}\IndexCmd{subsubsection} are numbered. -This is controlled by the \LaTeX\ counter \Counter{secnumdepth}. The -value \(-1\) represents \Macro{part}, \(0\) the level \Macro{chapter} -and so on. Since in \Class{scrartcl} there is no \Macro{chapter} the -counting in this class starts with \(0\) at the level \Macro{part}. By -way of defining, decrementing or incrementing this counter you can -determine down to which level the headings are numbered. The same -applies in the standard classes. Please refer also to the explanations +This is controlled by the {\LaTeX} counter \Counter{secnumdepth}. The +value \(-\)1 represents \Macro{part}, 0 the level \Macro{chapter}, +and so on. By defining, incrementing or decrementing this counter you +can determine down to which level the headings are numbered. The same +applies in the standard classes. Please refer also to the explanation concerning the counter \Counter{tocdepth} in -\autoref{sec:maincls.toc}, \autopageref{desc:maincls.counter.tocdepth}. +\autoref{sec:maincls.toc}, +\autopageref{desc:maincls.counter.tocdepth}. % \EndIndex{Counter}{secnumdepth}\EndIndex{}{numbering} @@ -2905,35 +3032,36 @@ concerning the counter \Counter{tocdepth} in \BeginIndex{Cmd}{setchapterpreamble}% Parts\OnlyAt{\Class{scrbook}\and\Class{scrreprt}} and chapters in {\KOMAScript} can be started with a \PName{preamble}. This is -particularily useful when you are using a two column layout with the -class option \Option{twocolumn}\IndexOption{twocolumn}. Together with -the heading the \PName{preamble} is always set in a one column layout. -The \PName{preamble} can comprise more than one paragraph. The command -for issuing the \PName{preamble} has to be put in front of the -respective \Macro{part}, \Macro{addpart}, \Macro{chapter} or -\Macro{addchap} command. +particularly useful when you are using a two column layout with the +class option \Option{twocolumn}\IndexOption{twocolumn}, since the +heading together with the \PName{preamble} is always set in a one +column layout. The \PName{preamble} can comprise more than one +paragraph. The command to output the \PName{preamble} has to be placed +before the respective \Macro{part}, \Macro{addpart}, \Macro{chapter} +or \Macro{addchap} command. \begin{Example} - You are writing a report on the situation of a company. You organize - the report in such a way that every department gets its own partial report. - Every one of these parts should be introduced by a short abstract on the - title page. You could write the following: + You are writing a report about the condition of a company. You + organize the report in such a way that every department gets its own + partial report. Every one of these parts should be introduced by an + abstract on the corresponding title page. You could write the + following: \begin{lstlisting} \setpartpreamble{% \begin{abstract} - This is a blind text. This text should show, how a - printed text will look like at this place. If you - read this text, you will get no information. + This is a filler text. It serves merely to demonstrate the + capabilities of {\KOMAScript}. If you read this text, you will + get no information. \end{abstract} } \part{Department for Word Processing} \end{lstlisting} - Depending on the settings for the heading\Index{heading} (see - \autoref{sec:maincls.fontOptions}, - \autopageref{desc:maincls.option.smallheadings}) size and the - \Environment{abstract} environment\IndexEnv{abstract} (see - \autoref{sec:maincls.formattingOptions}, - \autopageref{desc:maincls.option.abstracton}), the result would look similar - to: +Depending on the settings for the heading font size\Index{heading} +(see \autoref{sec:maincls.fontOptions}, +\autopageref{desc:maincls.option.smallheadings}) and the options for +the \Environment{abstract} environment\IndexEnv{abstract} (see +\autoref{sec:maincls.formattingOptions}, +\autopageref{desc:maincls.option.abstracton}), the result would look +similar to: \begin{ShowOutput}\centering {\LARGE\usekomafont{disposition} Part III.\par\vspace{20pt}} {\LARGE\usekomafont{disposition} Department for Word Processing\strut\par} @@ -2942,9 +3070,10 @@ respective \Macro{part}, \Macro{addpart}, \Macro{chapter} or \begin{center} \usekomafont{disposition}\abstractname \end{center} - \vspace{2ex} This is a blind text. This text should show, how a - printed text will look like at this place. If you read this text, - you will get no information. + \vspace{2ex} + This is a filler text. It serves merely to demonstrate the + capabilities of {\KOMAScript}. If you read this text, you will + get no information. \end{quote} \end{ShowOutput} \end{Example} @@ -2962,19 +3091,19 @@ vertical placement there are two possibilities at present: \item [\quad\texttt{o}:] above the heading \item [\quad\texttt{u}:] below the heading \end{description} -You can insert a preamble both above and below a heading. For the +You can insert one preamble above and another below a heading. For the horizontal placement you have the choice between three alignments: \begin{description} \item [\quad\texttt{l}:] left-aligned \item [\quad\texttt{r}:] right-aligned \item [\quad\texttt{c}:] centered \end{description} -However, this does not issue the text of the \PName{preamble} but -inserts a box whose width is determined by the second optional -argument \PName{width}. If you leave out this second argument the -whole text width is used. In this case the option for horizontal -positioning will have no effect. You can combine one letter from the -vertical with one letter from the horizontal positioning. +However, this does not output the text of the \PName{preamble} in such +a manner, but inserts a box whose width is determined by the second +optional argument \PName{width}. If you leave out this second argument +the whole text width is used. In that case the option for horizontal +positioning will have no effect. You can combine exactly one letter +from the vertical with one letter from the horizontal positioning. % \EndIndex{Cmd}{setpartpreamble}% \EndIndex{Cmd}{setchapterpreamble}% @@ -2996,7 +3125,7 @@ vertical with one letter from the horizontal positioning. \BeginIndex{Cmd}{raggeddictumauthor}% Apart\OnlyAt{\Class{scrbook}\and\Class{scrreprt}}% \ChangedAt{v2.8q}{\Class{scrbook}\and\Class{scrreprt}} from an -introducing paragraph you can use \Macro{setpartpreamble} or +introductory paragraph you can use \Macro{setpartpreamble} or \Macro{setchapterpreamble} for a kind of \PName{aphorism}\Index{aphorism} (also known as ``dictum'') at the beginning of a chapter or section. The command \Macro{dictum} inserts @@ -3005,39 +3134,40 @@ either the command \Macro{setchapterpreamble} or \Macro{setpartpreamble}. However, this is not obligatory. The dictum together with an optional \PName{author} is inserted in a -\Macro{parbox}\IndexCmd{parbox} (see \cite{latex:usrguide}) of the -width \Macro{dictumwidth}. Yet \Macro{dictumwidth} is not a length -which is set with \Macro{setlength}. It is a macro that can be -redefined using \Macro{renewcommand}. Default setting is +\Macro{parbox}\IndexCmd{parbox} (see \cite{latex:usrguide}) of width +\Macro{dictumwidth}. Yet \Macro{dictumwidth} is not a length which can +be set with \Macro{setlength}. It is a macro that can be redefined +using \Macro{renewcommand}. Default setting is \verb;0.3333\textwidth;, which is a third of the textwidth. The box itself is positioned with the command \Macro{raggeddictum}. Default -here is \Macro{raggedleft}\IndexCmd{raggedleft}. The command -\Macro{raggeddictum} can be redefined using \Macro{renewcommand}. +here is \Macro{raggedleft}\IndexCmd{raggedleft}, that is, right +justified. The command \Macro{raggeddictum} can be redefined using +\Macro{renewcommand}. Within the box the \PName{dictum} is set using \Macro{raggeddictumtext}. Default setting is -\Macro{raggedright}\IndexCmd{raggedright}. Similar to -\Macro{raggeddictum} it can be redefined with \Macro{renewcommand}. -The output uses the default font which is set for the element -\FontElement{dictumtext}. It can be changed with the commands from -\autoref{sec:maincls.font}. Default settings are listed in -\autoref{tab:maincls.dictumfont}. - -If there is an \PName{author} it is separated from the \PName{dictum} -by a line with the width of the \Macro{parbox}. This is defined by the -macro \Macro{raggeddictumauthor}. Default is \Macro{raggedleft}. This -command can also be redefined using \Macro{renewcommand}. The format -of the output is defined with \Macro{dictumauthorformat}. This macro -expects the \Macro{author} as argument. As default -\Macro{dictumauthorformat} is defined as: +\Macro{raggedright}\IndexCmd{raggedright}, that is, left +justified. Similarly to \Macro{raggeddictum} this can be redefined +with \Macro{renewcommand}. The output uses the default font setting +for the element \FontElement{dictumtext}, which can be changed with +the commands from \autoref{sec:maincls.font}. Default settings are +listed in \autoref{tab:maincls.dictumfont}. + +If there is an \PName{author} name, it is separated from the +\PName{dictum} by a line the full width of the \Macro{parbox}. This is +defined by the macro \Macro{raggeddictumauthor}. Default is +\Macro{raggedleft}. This command can also be redefined using +\Macro{renewcommand}. The format of the output is defined with +\Macro{dictumauthorformat}. This macro expects the \Macro{author} as +argument. As default \Macro{dictumauthorformat} is defined as: \begin{lstlisting} \newcommand*{\dictumauthorformat}[1]{(#1)} \end{lstlisting} -Thus the \PName{author} is set in in round parenthesis. For the -element \FontElement{dictumauthor} a different font as for the element -\FontElement{dictumtext} can be defined. Default settings are listed -in \autoref{tab:maincls.dictumfont}. Changes can be made using the -commands from \autoref{sec:maincls.font}. +Thus the \PName{author} is set enclosed in rounded parenthesis. For +the element \FontElement{dictumauthor} a different font than for the +element \FontElement{dictumtext} can be defined. Default settings are +listed in \autoref{tab:maincls.dictumfont}. Changes can be made using +the commands from \autoref{sec:maincls.font}. % \begin{table} \centering% @@ -3056,21 +3186,21 @@ commands from \autoref{sec:maincls.font}. \end{table} % If \Macro{dictum} is used within the macro \Macro{setchapterpreamble} -or \Macro{setpartpreamble} you have to take care of the following: The +or \Macro{setpartpreamble} you have to take care of the following: the horizontal positioning is always done with \Macro{raggeddictum}. -Therefore, the optional argument for horizontal positioning, which is -implemented for these two commands, has no effect. \Macro{textwidth} -is not the width of the whole text corpus but the actually used text +Therefore, the optional argument for horizontal positioning which is +implemented for these two commands has no effect. \Macro{textwidth} is +not the width of the whole text corpus but the actually used text width. If \Macro{dictumwidth} is set to \verb;.5\textwidth; and \Macro{setchapterpreamble} has an optional width of -\verb;.5\textwidth; too, you will get a box with a width of a quarter +\verb;.5\textwidth; too, you will get a box with a width one quarter of the text width. Therefore, if you use \Macro{dictum} it is recommended to refrain from setting the optional width for \Macro{setchapterpreamble} or \Macro{setpartpreamble}. -If you have more than one dictum you should separate them by an -additional vertical space. You could easely use the command -\Macro{bigskip}\IndexCmd{bigskip} for that. +If you have more than one dictum one under another, you should +separate them by an additional vertical space, easily accomplished +using the command \Macro{bigskip}\IndexCmd{bigskip}. \begin{Example} You are writing a chapter on an aspect of weather forecasting. You @@ -3091,8 +3221,8 @@ additional vertical space. You could easely use the command happen and then to explain why it didn't.} \end{ShowOutput} - If you would rather prefer the dictum to span over only a quarter of - the text width you can redefine \Macro{dictumwidth}: + If you would rather the dictum span only a quarter of the text width + rather than one third you can redefine \Macro{dictumwidth}: \begin{lstlisting} \renewcommand*{\dictumwidth}{.25\textwidth} \end{lstlisting} @@ -3112,9 +3242,9 @@ package~\Package{ragged2e}~\cite{package:ragged2e}. \subsection{Footnotes} \label{sec:maincls.footnotes} -Footnotes are not limited to the main part of the document. Since -footnotes\Index{footnotes} are mainly used in the main text they are -being covered in this section. +Footnotes are not limited to the main part of the document. However, +since footnotes\Index{footnotes} are mainly used in the main text they +are covered in this section. \begin{Declaration} \Macro{footnote}\OParameter{number}\Parameter{text}\\ @@ -3124,14 +3254,13 @@ being covered in this section. \BeginIndex{Cmd}{footnote}% \BeginIndex{Cmd}{footnotemark}% \BeginIndex{Cmd}{footnotetext}% -Similar to the standard classes footnotes in {\KOMAScript} are -produced with the \Macro{footnote} command. -An alternative is the usage in pairs of the commands -\Macro{footnotemark} and \Macro{footnotetext}. -As in the standard classes it is possible that a page break occurs -within a footnote. Normally this happens if the footnote mark is -placed near the bottom of a page thus leaving \LaTeX\ no choice as to -break the page at this point. +Similarly to the standard classes, footnotes in {\KOMAScript} are +produced with the \Macro{footnote} command, or alternatively the +pairwise usage of the commands \Macro{footnotemark} and +\Macro{footnotetext}. As in the standard classes it is possible that +a page break occurs within a footnote. Normally this happens if the +footnote mark is placed so near the bottom of a page as to leave +{\LaTeX} no choice but to break the footnote onto the next page. % \EndIndex{Cmd}{footnote}% \EndIndex{Cmd}{footnotemark}% @@ -3149,21 +3278,19 @@ break the page at this point. \BeginIndex{Cmd}{deffootnotemark}% \BeginIndex{Cmd}{thefootnotemark}% \BeginIndex{Cmd}{textsuperscript}% -Formatting footnotes in {\KOMAScript} is slightly different to the -standard classes. As in the standard classes the footnote mark in the -text is formed as a small number in superscript. The same formatting -is used in the footnote itself. - -The mark in the footnote is type-set right-aligned in a box -with width \PName{mark width}. The first line of the footnote -follows directly. +Footnotes are formatted slightly differently in {\KOMAScript} to in +the standard classes. As in the standard classes the footnote mark in +the text is depicted using a small superscripted number. The same +formatting is used in the footnote itself. The mark in the footnote is +type-set right-aligned in a box with width \PName{mark width}. The +first line of the footnote follows directly. All following lines will be indented by the length of -\PName{indent}. If the optional parameter \PName{mark width} -was not specified, then it defaults to \PName{indent}. -If the footnote consists of more than one paragraph, then the -first line of a paragraph is indented in addition to \PName{indent} -by the value of \PName{parindent}. +\PName{indent}. If the optional parameter \PName{mark width} is not +specified, it defaults to \PName{indent}. If the footnote consists of +more than one paragraph, then the first line of a paragraph is +indented, in addition to \PName{indent}, by the value of +\PName{parindent}. \begin{figure} \centering\setlength{\unitlength}{1mm} \begin{picture}(100,22) @@ -3210,69 +3337,71 @@ by the value of \PName{parindent}. \end{figure} Figure \ref{fig:maincls.deffootnote} illustrates the layout parameters -ones more. The default configuration of \KOMAScript{} is: +once more. The default configuration of {\KOMAScript} is: \begin{lstlisting} \deffootnote[1em]{1.5em}{1em} {\textsuperscript{\thefootnotemark}} \end{lstlisting} -\Macro{textsuperscript} causes both the superscript and the smaller +\Macro{textsuperscript} controls both the superscript and the smaller font size. \Macro{thefootnotemark} is the current footnote mark without any formatting. The\ChangedAt{v2.8q}{% - \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} font element -\FontElement{footnote}\IndexFontElement{footnote} determines the font -of the footnote including the footnote mark. Using the element -\FontElement{footnotelabel}\IndexFontElement{footnotelabel} the font -of the footnote mark can be changed separately with the commands -mentioned in \autoref{sec:maincls.font} Please refer also to the + \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} font +element \FontElement{footnote}\IndexFontElement{footnote} determines +the font of the footnote including the footnote mark. Using the +element \FontElement{footnotelabel}\IndexFontElement{footnotelabel} +the font of the footnote mark can be changed separately with the +commands mentioned in \autoref{sec:maincls.font} Please refer also to \autoref{tab:maincls.elementsWithoutText}, \autopageref{tab:maincls.elementsWithoutText}. Default setting is no -changing of the font. +change in the font. -The footnote mark in the text is defined separately with +The footnote mark in the text is defined separately from the mark in +front of the actual footnote. This is done with \Macro{deffootnotemark}. Default setting is: \begin{lstlisting} \deffootnotemark{% \textsuperscript{\thefootnotemark}} \end{lstlisting} -Above\ChangedAt{v2.8q}{% +In the above\ChangedAt{v2.8q}{% \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} the font for the element \FontElement{footnotereference}\IndexFontElement{footnotereference} is applied (see \autoref{tab:maincls.elementsWithoutText}, -\autopageref{tab:maincls.elementsWithoutText}). Thus the -footnote marks in the text and the footnote itself are identical. The -font can be changed with the commands described in +\autopageref{tab:maincls.elementsWithoutText}). Thus the footnote +marks in the text and in the footnote itself are identical. The font +can be changed with the commands described in \autoref{sec:maincls.font}. \begin{Example} - A feature often asked for are footnote marks which are neither in + A feature often asked for is footnote marks which are neither in superscript nor in a smaller font size. They should not touch the - footnote text but have a small space in between. This can be + footnote text but be separated by a small space. This can be accomplished as follows: \begin{lstlisting} \deffootnote{1em}{1em}{\thefootnotemark\ } \end{lstlisting} - The footnote mark and the space is set right-aligned into a - box of the width 1\Unit{em}. The following lines of the footnote - text is also indented by 1\Unit{em} from the left margin. +The footnote mark and the following space are therefore set +right-aligned into a box of width 1\Unit{em}. The following lines of +the footnote text are also indented by 1\Unit{em} from the left +margin. - Another often requested footnote layout are left-aligned - footnote marks. These can be reached with: +Another often requested footnote layout is left-aligned footnote +marks. These can be obtained with: \begin{lstlisting} \deffootnote{1.5em}{1em}{% \makebox[1.5em][l]{\thefootnotemark}} \end{lstlisting} - If you want however change the font for all footnotes, for example - to sans serif, you can simply solve this problem using the commands - from \autoref{sec:maincls.fontOptions}: +If you want however only to change the font for all footnotes, for +example to sans serif, you can solve this problem simply by using the +commands from \autoref{sec:maincls.fontOptions}: \begin{lstlisting} \setkomafont{footnote}{\sffamily} \end{lstlisting} \end{Example} -As demonstrated with the examples above the simple user interface of +As demonstrated with the examples above, the simple user interface of {\KOMAScript} provides a great variety of different footnote formattings. % @@ -3287,11 +3416,12 @@ formattings. Both {\LaTeX} and the standard classes offer different environments for lists. Though slightly changed or extended all these list are of -course offered in {\KOMAScript} as well. In general all lists\,---\,even -of different kind\,---\,can be nested up to four levels. From a -typographical view, anything more would make no sense. Even more than -three levels are hard to perceive. Recommendation in these cases is to -split your huge list in several small ones. +course offered in {\KOMAScript} as well. In general all +lists\,---\,even of different kind\,---\,can be nested up to four +levels. From a typographical view, anything more would make no sense, +as more than three levels can no longer be easily perceived. The +recommended procedure in such a case is to split the large list into +several smaller ones. \begin{Declaration} \Environment{itemize}\\ @@ -3307,13 +3437,17 @@ split your huge list in several small ones. \BeginIndex{Cmd}{labelitemii}% \BeginIndex{Cmd}{labelitemiii}% \BeginIndex{Cmd}{labelitemiv}% -The most simple form of a list is an \Environment{itemize} list. -Depending on the level {\KOMAScript} uses the following marks: -"`{\labelitemi}"', "`{\labelitemii}"', "`{\labelitemiii}"' and -"`{\labelitemiv}"'. The definition of these symbols is specified in +The simplest form of a list is an \Environment{itemize} list. The +users of a certain disliked word processing package often refer to +this form of a list as \emph{bulletpoints}. Presumably, these users +are unable to envisage that, depending on the level, a different +symbol from a large dot could be used to introduce each +point. Depending on the level, {\KOMAScript} uses the following marks: +``{\labelitemi}'', ``{\labelitemii}'', ``{\labelitemiii}'' and +``{\labelitemiv}''. The definition of these symbols is specified in the macros \Macro{labelitemi}, \Macro{labelitemii}, -\Macro{labelitemiii} and \Macro{labelitemiv}. All of this macros can -be redefined using \Macro{renewcommand}. Every item is introduced with +\Macro{labelitemiii} and \Macro{labelitemiv}, all of which can be +redefined using \Macro{renewcommand}. Every item is introduced with \Macro{item}. \begin{Example} You have a simple list which is nested in several levels. You write @@ -3321,7 +3455,7 @@ be redefined using \Macro{renewcommand}. Every item is introduced with \begin{lstlisting} \minisec{Vehicles} \begin{itemize} - \item aeroplans + \item aeroplanes \begin{itemize} \item biplane \item jets @@ -3329,18 +3463,24 @@ be redefined using \Macro{renewcommand}. Every item is introduced with \begin{itemize} \item single-engined \begin{itemize} - \item{jet-driven} - \item{propeller-driven} + \item jet-driven + \item propeller-driven \end{itemize} \item multi-engined \end{itemize} - \item helicopter + \item helicopters \end{itemize} +%% wahrsheinlich Platzfiller in Deutscher Ausgabe? +% \item motorcycles +% \begin{itemize} +% \item historically accurate +% \item futuristic, not real +% \end{itemize} \item automobiles \begin{itemize} - \item racing car - \item private car - \item lorry + \item racing cars + \item private cars + \item lorries \end{itemize} \item bicycles \end{itemize} @@ -3349,26 +3489,32 @@ be redefined using \Macro{renewcommand}. Every item is introduced with \begin{ShowOutput}[\baselineskip] \minisec{Vehicles} \begin{itemize} - \item aeroplans + \item aeroplanes \begin{itemize} - \item biplane + \item biplanes \item jets \item transport planes \begin{itemize} \item single-engined \begin{itemize} - \item{jet-driven} - \item{propeller-driven} + \item jet-driven + \item propeller-driven \end{itemize} \item multi-engined \end{itemize} - \item helicopter + \item helicopters \end{itemize} +%% wahrsheinlich Platzfiller in Deutscher Ausgabe? +% \item motorcycles +% \begin{itemize} +% \item historically accurate +% \item futuristic, not real +% \end{itemize} \item automobiles \begin{itemize} - \item racing car - \item private car - \item lorry + \item racing cars + \item private cars + \item lorries \end{itemize} \item bicycles \end{itemize} @@ -3406,8 +3552,8 @@ be redefined using \Macro{renewcommand}. Every item is introduced with \BeginIndex{Cmd}{labelenumiii}% \BeginIndex{Cmd}{labelenumiv}% Another form of a list often used is a numbered list which is already -implemented by the {\LaTeX} kernel. Depending on the level the -numbering\Index{numbering} uses the following characters: arabic +implemented by the {\LaTeX} kernel. Depending on the level, the +numbering\Index{numbering} uses the following characters: Arabic numbers, small letters, small roman numerals and capital letters. The kind of numbering is defined with the macros \Macro{theenumi} down to \Macro{theenumiv}. The output format is determined by the macros @@ -3416,39 +3562,45 @@ the second level is followed by a round parenthesis, the values of all other levels are followed by a dot. Every item is introduced with \Macro{item}. \begin{Example} - Replacing every occurence of an \Environment{itemize} environment + Replacing every occurrence of an \Environment{itemize} environment with an \Environment{enumerate} environment in the example above we get the following result: \begin{ShowOutput}[\baselineskip] \minisec{Vehicles} \begin{enumerate} - \item aeroplans + \item aeroplanes \begin{enumerate} - \item biplane + \item biplanes \item jets \item transport planes \begin{enumerate} \item single-engined \begin{enumerate} - \item{jet-driven}\label{xmp:maincls.jets} - \item{propeller-driven} + \item jet-driven\label{xmp:maincls.jets} + \item propeller-driven \end{enumerate} \item multi-engined \end{enumerate} - \item helicopter + \item helicopters \end{enumerate} +%% wahrsheinlich Platzfiller in Deutscher Ausgabe? +% \item motorcycles +% \begin{enumerate} +% \item historically accurate +% \item futuristic, not real +% \end{enumerate} \item automobiles \begin{enumerate} - \item racing car - \item private car - \item lorry + \item racing cars + \item private cars + \item lorries \end{enumerate} \item bicycles \end{enumerate} \end{ShowOutput} Using \Macro{label} within a list you can set labels which are - referenced with \Macro{ref}. In the example above a label - was set after the jet-driven, single-engined transport plane with + referenced with \Macro{ref}. In the example above, a label was set + after the jet-driven, single-engined transport planes with \Macro{label}\PParameter{xmp:jets}. The \Macro{ref} value is then \ref{xmp:maincls.jets}. \end{Example} @@ -3471,12 +3623,12 @@ other levels are followed by a dot. Every item is introduced with \end{Declaration}% \BeginIndex{Env}{description}% \BeginIndex{Cmd}{item}% -Another list form is the description list. Its main use is the +A further list form is the description list. Its main use is the description of several items. The item itself is an optional parameter in \Macro{item}. The font\Index{font}\ChangedAt{v2.8p}{% \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}}% -, which is responsible for emphasizing the item can be changed with -the commands for the element +which is responsible for emphasizing the item can be changed with the +commands for the element \FontElement{descriptionlabel}\IndexFontElement{descriptionlabel} (see \autoref{tab:maincls.elementsWithoutText}, \autopageref{tab:maincls.elementsWithoutText}) described in @@ -3495,20 +3647,19 @@ the commands for the element abbreviated source code is: \begin{lstlisting} \begin{description} - \item[empty] is the page style without - any header or footer - \item[plain] is the page style without running headline. - \item[headings] is the page style with running headline. - \item[myheadings] is the page style for manual headline. + \item[empty] is the page style without any header or footer. + \item[plain] is the page style without headings. + \item[headings] is the page style with running headings. + \item[myheadings] is the page style for manual headings. \end{description} \end{lstlisting} This abbreviated version gives: \begin{ShowOutput} \begin{description} - \item[empty] is the page style without any header or footer - \item[plain] is the page style without running headline. - \item[headings] is the page style with running headline. - \item[myheadings] is the page style for manual headline. + \item[empty] is the page style without any header or footer. + \item[plain] is the page style without headings. + \item[headings] is the page style with running headings. + \item[myheadings] is the page style for manual headings. \end{description} \end{ShowOutput} \end{Example} @@ -3519,29 +3670,30 @@ the commands for the element \begin{Declaration} \Environment{labeling}\OParameter{delimiter}\Parameter{widest pattern}\\ - \XMacro{item}\OParameter{key word} + \XMacro{item}\OParameter{keyword} \end{Declaration}% \BeginIndex{Env}{labeling}% \BeginIndex{Cmd}{item}% -An additional form of a description list in {\KOMAScript} is the -\Environment{labeling} environment. In difference to the -\Environment{description} environment you can provide a pattern, which -determines the indentation of all items. Furthermore you can put an -optional \PName{delimiter} between item and description. +An additional form of a description list is only available in the +{\KOMAScript} classes: the \Environment{labeling} environment. Unlike +the \Environment{description} environment, you can provide a pattern +whose length determines the indentation of all items. Furthermore, you +can put an optional \PName{delimiter} between the item and its +description. \begin{Example} Slightly changing the example from the \Environment{description} - environment we could write: + environment, we could write: \begin{lstlisting} \begin{labeling}[~--]{% \usekomafont{descriptionlabel}myheadings} \item[\usekomafont{descriptionlabel}empty] Page style without header and footer \item[\usekomafont{descriptionlabel}plain] - Page style for chapter beginnings without headline + Page style for chapter beginnings without headings \item[\usekomafont{descriptionlabel}headings] - Page style for running headline + Page style for running headings \item[\usekomafont{descriptionlabel}myheadings] - Page style for manual headline + Page style for manual headings \end{labeling} \end{lstlisting} As result we get: @@ -3550,22 +3702,23 @@ optional \PName{delimiter} between item and description. \item[\usekomafont{descriptionlabel}empty] Page style without header and footer \item[\usekomafont{descriptionlabel}plain] - Page style for chapter beginnings without headline + Page style for chapter beginnings without headings \item[\usekomafont{descriptionlabel}headings] - Page style for running headline + Page style for running headings \item[\usekomafont{descriptionlabel}myheadings] - Page style for manual headline + Page style for manual headings \end{labeling} \end{ShowOutput} - As can be seen in this example a font changing command has to be - repeated both in the pattern and in the optional parameter in every + As can be seen in this example, a font changing command has to be + repeated both in the pattern and in the optional parameter of every \Macro{item} command in this environment. \end{Example} -Originally this environment was implemented for things like ``Given -is\dots, Asked is\dots, Solution'' that are often used in hand-outs. -By now this environment has found many different applications. For -example the environment for examples in this guide was defined with -the \Environment{labeling} environment. +Originally this environment was implemented for things like +``Precondition, Assertion, Proof'', or ``Given, Required, Solution'' +that are often used in lecture hand-outs. By now this environment has +found many different applications. For example, the environment for +examples in this guide was defined with the \Environment{labeling} +environment. % \EndIndex{Env}{labeling}% \EndIndex{Cmd}{item}% @@ -3575,22 +3728,24 @@ the \Environment{labeling} environment. \Environment{verse} \end{Declaration}% \BeginIndex{Env}{verse}% -Normally the \Environment{verse} environment isn't perceived as a list -environment because you don't work with \Macro{item} commands. Instead -fixed line breaks are used like within the \Environment{flushleft} -environment. Yet internally in both the standard classes as well -as {\KOMAScript} it is a list environment. +Usually the \Environment{verse} environment is not perceived as a list +environment because you do not work with \Macro{item} +commands. Instead, fixed line breaks are used within the +\Environment{flushleft} environment. Yet internally in both the +standard classes as well as {\KOMAScript} it is indeed a list +environment. In general the \Environment{verse} environment is used for -poems\Index{poems}. Lines are indented both left and right. Single -verses are ended by a fixed line break \verb|\\|. Verses are set as a -paragraph, thus separated by an empty line. Often also -\Macro{medskip}\IndexCmd{medskip} or \Macro{bigskip}\IndexCmd{bigskip} -is used instead. To avoid a page break at the end of a line you insert -\verb|\\*| instead of \verb|\\|. +poems\Index{poems}. Lines are indented both left and +right. Individual lines of verse are ended by a fixed line break +\verb|\\|. Verses are set as paragraphs, separated by an empty +line. Often also \Macro{medskip}\IndexCmd{medskip} or +\Macro{bigskip}\IndexCmd{bigskip} is used instead. To avoid a page +break at the end of a line of verse you as usual insert \verb|\\*| +instead of \verb|\\|. \begin{Example} - As example the first lines of ``Little Red Riding Hood and the - Wolf'' by Roald Dahl: + As an example, the first lines of ``Little Red Riding Hood and the + Wolf'' by Roald Dahl: \begin{lstlisting} \begin{verse} As soon as Wolf began to feel\\* @@ -3601,7 +3756,7 @@ is used instead. To avoid a page break at the end of a line you insert And Wolfie said, 'May I come in?' \end{verse} \end{lstlisting} - The result would like as follows: + The result is as follows: \begin{ShowOutput} \begin{verse} As soon as Wolf began to feel\\* @@ -3612,19 +3767,42 @@ is used instead. To avoid a page break at the end of a line you insert And Wolfie said, 'May I come in?' \end{verse} \end{ShowOutput} - Yet if you have very long lines \verb|\\*| can not prevent a page - break within a verse. That would be possible here for example: - \begin{ShowOutput} + However, if you have very long lines of verse, for instance: +\begin{lstlisting} \begin{verse} - Both the philosoph and the house-owner\nopagebreak - have always something to repair\\ + Both the philosopher and the house-owner + have always something to repair.\\ \bigskip - Don't trust a men, my son, who tells you\nopagebreak - that he has never lain. + Don't trust a man, my son, who tells you + that he has never lied. \end{verse} - \end{ShowOutput} +\end{lstlisting} +where a line break occurs within a line of verse: +\begin{ShowOutput} + \begin{verse} + Both the philosopher and the house-owner + have always something to repair.\\ + \bigskip + Don't trust a man, my son, who tells you + that he has never lied. + \end{verse} +\end{ShowOutput} +there \verb|\\*| can not prevent a page break occurring within a verse +at such a line break. To prevent such a page break, a +\Macro{nopagebreak}\IndexCmd{nopagebreak} would have to be inserted +somewhere in the first line: +\begin{lstlisting} + \begin{verse} + Both the philosopher and the house-owner\nopagebreak + have always something to repair.\\ + \bigskip + Don't trust a man, my son, who tells you\nopagebreak + that he has never lied. + \end{verse} +\end{lstlisting} - These two verses were separated by a \Macro{bigskip}. +In the above example, \Macro{bigskip} was used to separate the lines +of verse. \end{Example} % \EndIndex{Env}{verse}% @@ -3640,12 +3818,13 @@ These two environments are also list environments and can be found both in the standard and the {\KOMAScript} classes. Both environments use justified text which is indented both on the left and right side. Usually they are used to separate long citations\Index{citations} from -the main text. The difference between these two lies in the matter how -paragraphs are typeset. While \Environment{quote} paragraphs are +the main text. The difference between these two lies in the manner in +which paragraphs are typeset. While \Environment{quote} paragraphs are highlighted by vertical space, in \Environment{quotation} paragraphs the first line is indented. This is also true for the first line of a -\Environment{quotation} environment. To get around this behaviour you -have to insert a \Macro{noindent} command\IndexCmd{noindent} in front. +\Environment{quotation} environment. To prevent indentation you have +to insert a \Macro{noindent} command\IndexCmd{noindent} before the +text. \begin{Example} You want to highlight a short anecdote. You write the following \Environment{quotation} environment for this: @@ -3718,22 +3897,26 @@ have to insert a \Macro{noindent} command\IndexCmd{noindent} in front. \Environment{addmargin*}\OParameter{inner indentation}\Parameter{indentation} \end{Declaration} \BeginIndex{Env}{addmargin}% -Similar to \Environment{quote} and \Environment{quotation} the +Similar to \Environment{quote} and \Environment{quotation}, the \Environment{addmargin} environment changes the margin\Index{margin}. -Different to the first two environments using \Environment{addmargin} -the user can influence the width of the indentation. Furthermore this -environment doesn't change the indentation of the first line and the -vertical spacing between paragraphs. +In contrast to the first two environments, with +\Environment{addmargin} the user can set the width of the +indentation. Besides this, this environment does not change the +indentation of the first line nor the vertical spacing between +paragraphs. If only the obligatory argument \PName{indentation} is given, both the left and right margin are expanded by this value. If the optional -argument \PName{indentation} is given the value \PName{left - indentation} is added to \PName{indentation} at the left margin. +argument \PName{left indentation} is given as well, then at the left +margin the value \PName{left indentation} is used instead of +\PName{indentation}. The starred \Environment{addmargin*} only differs from the normal -version in a twoside layout. In addition the difference only occurs if -the optional argument \PName{inner indentation} is used. In this case -this value is added to the normal inner indentation. Then the value of +version in a two-sided layout. Furthermore, the difference only occurs +if the optional argument \PName{inner indentation} is used. In this +case this value \PName{inner indentation} is added to the normal inner +indentation. For right-hand pages this is the left margin, for +left-hand pages the right margin. Then the value of \PName{indentation} determines the width of the opposite margin. Both versions of this environment take also negative values for all @@ -3742,7 +3925,7 @@ margin. \begin{Example} Suppose you write a documentation which includes short source code examples. To highlight these you want them separated from the text - by a horizontal line and slightly spanning into the outer + by a horizontal line and shifted slightly into the outer margin. First you define the environment: \begin{lstlisting} \newenvironment{SourceCodeFrame}{% @@ -3781,48 +3964,52 @@ margin. } \end{lstlisting} \end{SourceCodeFrame} - This may be feasible or not. In any way it shows the usage of this + This may be feasible or not. In any case it shows the usage of this environment. \end{ShowOutput} The optional argument of the \Environment{addmargin*} environment makes sure that the inner margin is extended by 1\Unit{em}. In turn the outer margin is decreased by 1\Unit{em}. The result is a shift - by 1\Unit{em} to the outside. Instead of \PValue{1em} you can use a - length of, for example, \PValue{2\Macro{parindent}} of course. + by 1\Unit{em} to the outside. Instead of \PValue{1em} you can of + course use a length, for example, \PValue{2\Macro{parindent}}. \end{Example} There is one problem with the \Environment{addmargin*} which you should be aware of. If a page break occurs within an -\Environment{addmargin*} environment the indentation on the following -page is on the wrong side. This means that suddenly the \PName{inner - indentation} is applied on the outside of the page. Therefore it is -recommended to prevent page breaks within this environment. This can -be achieved by using an additional \Macro{parbox} or, as in the -example above, a \Environment{minipage}. This makes use of the fact -that neither the argument of a \Macro{parbox} nor the content of a -\Environment{minipage} is broken at the end of a page. Unfortunately -this is not without disadvantages: In some cases pages can't be filled -correctly which has the effect of several warnings. - -By the way, whether a page is going to be on the left or right side of the -book can't be determined in the first \LaTeX\ compiling for sure. For details -please refer to the explanation for the command \Macro{ifthispageodd} and -\Macro{ifthispagewasodd} at \autoref{sec:maincls.pageStyle}, +\Environment{addmargin*} environment, the indentation on the following +page will be on the wrong side. This means that suddenly the +\PName{inner indentation} is applied on the outside of the +page. Therefore it is recommended to prevent page breaks within this +environment. This can be achieved by using an additional +\Macro{parbox} or, as in the example above, a +\Environment{minipage}. This makes use of the fact that neither the +argument of a \Macro{parbox} nor the content of a +\Environment{minipage} breaks at the end of a page. Unfortunately +this is not without another disadvantage: in some cases pages can no +longer be filled correctly, which has the effect of generating several +warnings. + +Incidentally, whether a page is going to be on the left or right side +of the book can not be determined for certain in the first {\LaTeX} +run. For details please refer to the explanation of the commands +\Macro{ifthispageodd} and \Macro{ifthispagewasodd} in +\autoref{sec:maincls.pageStyle}, \autopageref{desc:maincls.macro.ifthispageodd}. % \EndIndex{Env}{addmargin}% \begin{Explain} - One concluding note to the list environments: In the internet and - support it is often asked why such an environment is followed by a - indented\Index{indentation} paragraph. In fact this is the result of - demanding a new paragraph. In \LaTeX\ empty lines are interpreted as - a new paragraph. This is also the case before and after list - environments. Thus, if you want a list environment to be set within - a paragraph you have to omit empty lines before and after. To - separate this environment from the rest of your text nevertheless, - you can insert a comment line which only consists of a percent - character in the {\LaTeX} source. + One concluding remark on list environments: on the internet and + during support it is often asked why such an environment is followed + by a indented\Index{indentation} paragraph. In fact, this is not the + case but is the result of the user demanding a new paragraph. In + {\LaTeX} empty lines are interpreted as a new paragraph. This is + also the case before and after list environments. Thus, if you want + a list environment to be set within a paragraph you have to omit + empty lines before and after. To nevertheless separate the + environment from the rest of your text in the {\LaTeX} source file, + you can insert a comment line before and after, that is, lines which + begin with a percent character and contain nothing more. \end{Explain} \EndIndex[indexother]{}{lists} @@ -3835,48 +4022,52 @@ please refer to the explanation for the command \Macro{ifthispageodd} and \end{Declaration}% \BeginIndex{Cmd}{marginpar}% \BeginIndex{Cmd}{marginline}% -Usually margin notes\Index[indexmain]{margin notes} in {\LaTeX} are +Usually margin notes\Index[indexmain]{margin>notes} in {\LaTeX} are inserted with the command \Macro{marginpar}. They are placed in the -outer margin. In documents with oneside layout the right border is -used. Though \Macro{marginpar} optionally can take a different margin -note in case the output is on the left margin, margin notes are always -in justified layout. But many users prefer left- or right-aligned -margin notes instead. {\KOMAScript} offers the command -\Macro{marginline} for that. +outer margin. In documents with one-sided layout the right border is +used. Though \Macro{marginpar} can take an optional different margin +note argument in case the output is in the left margin, margin notes +are always set in justified layout. However, experience has shown +that many users prefer left- or right-aligned margin notes instead. +To facilitate this, {\KOMAScript} offers the command +\Macro{marginline}. \begin{Example} - At several places in this documentation you find the classes mentioned - written in the margin. This can be produced\footnote{In fact, instead - of \Macro{texttt}, a semantic highlighting was used. To avoid confusion - this was replaced in the example.} with: + In the introduction, the class name \Class{scrartcl} can be found in + the margin. This can be produced\footnote{In fact, instead of + \Macro{texttt}, a semantic highlighting was used. To avoid + confusion this was replaced in the example.} with: \begin{lstlisting} \marginline{\texttt{scrartcl}} \end{lstlisting} - Instead of \Macro{marginline} you could have used \Macro{marginpar} - too. In fact the first command is implemented internally as: +Instead of \Macro{marginline} you could have used +\Macro{marginpar}. In fact the first command is implemented internally +as: \begin{lstlisting} \marginpar[\raggedleft\texttt{scrartcl}] {\raggedright\texttt{scrartcl}} \end{lstlisting} - Eventually \Macro{marginline} is only an abbreviating writing of the - code above. +Thus \Macro{marginline} is really only an abbreviated writing of the +code above. \end{Example} % \begin{Explain} - Unfortunately \Macro{marginpar} doesn't always work correctly in the - twoside\Index{twoside} layout. Whether a margin note is going to show - up on the left or right is already decided while evaluating the command - \Macro{marginpar}. If the output routine now shifts the margin note - onto the next page the alignment isn't correct anymore. This behaviour - is deeply founded within {\LaTeX} and was therefore declared a feature - by the \LaTeX3 team. \Macro{marginline} suffers from this ``feature'' - too. The package \Package{mparhack}\IndexPackage{mparhack} (see - \cite{package:mparhack}) would be a solution for this problem with both - \Macro{marginpar} and \Macro{marginline}. - - Note that you may not use \Macro{marginpar} or \Macro{marginnote} within - float environemnts like tables or figures. And you may not use these - commands at displayed math. + Unfortunately \Macro{marginpar} does not always work correctly in + two-sided\Index{twoside} layout. Whether a margin note will end up + in the left or right margin is already decided while evaluating the + command \Macro{marginpar}. If the output routine now shifts the + margin note onto the next page the formatting is no longer + correct. This behaviour is deeply rooted within {\LaTeX} and was + therefore declared a feature by the {\LaTeX}3 team. \Macro{marginline} + suffers from this ``feature'' too. The package + \Package{mparhack}\IndexPackage{mparhack} (see + \cite{package:mparhack}) offers a standard solution for this problem + which naturally benefits also \Macro{marginpar} and + \Macro{marginline}. + + Note that you may not use \Macro{marginpar} or \Macro{marginline} + within float environments such as tables or figures. Also, these + commands will not function in displayed math formulas. \end{Explain} % \EndIndex{Cmd}{marginpar}% @@ -3889,40 +4080,28 @@ margin notes instead. {\KOMAScript} offers the command \begin{Explain} With the floating environments {\LaTeX} offers a very capable and comfortable mechanism for automatic placement of - figures\Index{figures} and tables\Index{tables}. But often these + figures\Index{figure} and tables\Index{table}. But often these floating environments\Index[indexmain] {floating environments} are slightly misunderstood by beginners. They often ask for a fixed - position of a table or figure within the text. As these floating - environments are being referenced in the text this is not necessary - in most cases. It is not sensible too because such an object can - only be set on the page if there is enough space left. If this is - not the case the object would have to be shifted onto the next page - leaving a huge space on the page before. + position of a table or figure within the text. However, since these + floating environments are being referenced in the text this is not + necessary in most cases. It is also not sensible because such an + object can only be set on the page if there is enough space left for + it. If this is not the case the object would have to be shifted onto + the next page, thereby possibly leaving a huge blank space on the + page before. - % TODO: Translate this: -% Haeufig werden die Fliessumgebungen\Index[indexmain]% -% {Fliessumgebung=Fliessumgebung} von Anfaengern nicht richtig -% verstanden. So wird oft die Forderung aufgestellt, eine Tabelle oder -% Abbildung genau an einer bestimmten Position im Text zu setzen. Dies -% ist jedoch nicht erforderlich, da auf Fliessumgebungen im Text ueber -% eine Referenz verwiesen wird. Es ist auch nicht sinnvoll, da ein -% solches Objekt an einer Stelle nur dann gesetzt werden kann, wenn -% auf der Seite noch genuegend Platz fuer das Objekt vorhanden ist. Ist -% dies nicht der Fall, muesste das Objekt auf die naechste Seite -% umbrochen werden und auf der aktuellen Seite wuerde ein -% moeglicherweise sehr grosser leerer Raum bleiben. - - Often in many documents the same optional argument for positioning - an object is found with every floating object. This also makes no - sense. In such cases you should change the standard parameters + Often one finds in a document for every floating object the same + optional argument for positioning the object. This also makes no + sense. In such cases one should rather change the standard parameter globally. For more details refer to \cite{DANTE:FAQ}.\par \end{Explain} -One last important note before starting this section: The most -mechanisms described here which extend the capabilities of the -standard classes do not work correctly when used together with -packages which interfere with the typesetting of captions of figures -and tables. This should be without saying but is often neglected. +One last important note before starting this section: most mechanisms +described here which extend the capabilities of the standard classes +no longer work correctly when used together with packages which modify +the typesetting of captions of figures and tables. This should be self +evident, but it is often not understood. \begin{Declaration} \Macro{caption}\OParameter{entry}\Parameter{title}\\ @@ -3932,29 +4111,29 @@ and tables. This should be without saying but is often neglected. \BeginIndex{Cmd}{caption}% \BeginIndex{Cmd}{captionabove}% \BeginIndex{Cmd}{captionbelow}% -In the standard classes captions of tables and figures are inserted -with the \Macro{caption} command below the table or figure. In general -this is correct with figures. Opinions differ as to whether captions -of tables are to be placed above or together with captions of -figures\Index{captions of figures} below the table\Index{captions of - tables}. That's the reason why \KOMAScript{}, unlike the standard -classes, offers \Macro{captionbelow} for captions below and -\Macro{captionabove} for captions above tables or figures. Using -\Macro{caption} together with figures always produces captions below -the figure whereas the behaviour of \Macro{captionbelow} can be -modified using the options +In the standard classes caption text \PName{title} of tables and +figures is inserted with the \Macro{caption} command below the table +or figure. In general this is correct for figures. Opinions differ as +to whether captions of tables are to be placed above or, consistent +with captions of figures\Index{caption>of figure}, below the +table\Index{caption>of table}. That is the reason why {\KOMAScript}, +unlike the standard classes, offers \Macro{captionbelow} for captions +below and \Macro{captionabove} for captions above tables or +figures. Using \Macro{caption} for figures always produces captions +below the figure, whereas with tables the behaviour of \Macro{caption} +can be modified using the options \Option{tablecaptionabove}\IndexOption{tablecaptionabove} and \Option{tablecaptionbelow}\IndexOption{tablecaptionbelow} (see \autoref{sec:maincls.formattingOptions}, -\autopageref{desc:maincls.option.tablecaptionabove}). For compatibility -reasons the default behaviour of \Macro{caption} together with tables -is similar to \Macro{captionbelow}. +\autopageref{desc:maincls.option.tablecaptionabove}). For +compatibility reasons the default behaviour of \Macro{caption} used +with tables is similar to \Macro{captionbelow}. % \begin{Example} - Instead of using captions below the table you want to place your - captions above it\Index{table caption}, because you have tables - which span over more then one page. In the standard classes you - could only write: + Instead of using captions below a table you want to place your + captions above it\Index{table>caption}, because you have tables + which span more then one page. In the standard classes you could + only write: \begin{lstlisting} \begin{table} \caption{This is an example table} @@ -3975,7 +4154,7 @@ is similar to \Macro{captionbelow}. This & is & an & example. \end{tabular} \end{ShowOutput} - Using \KOMAScript{} you write instead: + Using {\KOMAScript} you write instead: \begin{lstlisting} \begin{table} \captionabove{This is just an example table} @@ -3996,7 +4175,7 @@ is similar to \Macro{captionbelow}. This & is & an & example. \end{tabular} \end{ShowOutput} - Since you want all your tables typeset with captions above you could + Since you want all your tables typeset with captions above, you could of course use the option \Option{tablecaptionabove} instead (see \autoref{sec:maincls.formattingOptions}, \autopageref{desc:maincls.option.tablecaptionabove}). Then you can use @@ -4006,35 +4185,39 @@ is similar to \Macro{captionbelow}. \begin{Explain} Some would argue that you could achieve the same result using the - \Macro{topcaption} from the \Package{topcapt} - package\IndexPackage{topcapt} (see \cite{package:topcapt}). But that - is not the case. The command \Macro{topcaption} is neglected by + \Macro{topcaption} command from the \Package{topcapt} + package\IndexPackage{topcapt} (see \cite{package:topcapt}). However, + that is not the case. The command \Macro{topcaption} is ignored by packages which directly redefine the \Macro{caption} macro. The - \Package{hyperref} package (see \cite{package:hyperref}) is one example - for this. In \KOMAScript{} \Macro{captionabove} and - \Macro{captionbelow} are implemented so, that the changes have an - effect on both of these commands. + \Package{hyperref} package (see \cite{package:hyperref}) is one such + example. In {\KOMAScript}, \Macro{captionabove} and + \Macro{captionbelow} are so implemented that changes have an effect + on both of these commands as well. - If the \Package{longtable} package\IndexPackage{longtable} is used - \KOMAScript{} makes sure that captions above tables which are placed within - a \Environment{longtable} environment have the same appearance as in a - normal \Environment{table} environment. This also means that you can apply - the same settings as in a \Environment{table} environment. Please note that - in the \Package{longtable} package the maximum width of a table caption can + If the \Package{longtable} package\IndexPackage{longtable} is used, + {\KOMAScript} ensures that captions above tables which are placed + within a \Environment{longtable} environment have the same + appearance as those in a normal \Environment{table} + environment. This also means that you can apply the same settings as + in a \Environment{table} environment. Please note that in the + \Package{longtable} package the maximum width of a table caption can be limited and the default is set to 4\Unit{in} (see - \cite{package:longtable}). Using \KOMAScript{} this mechanism in - \Package{longtable} only works when the class option \Option{origlongtable} - is set (see \autoref{sec:maincls.formattingOptions}, - \autopageref{desc:maincls.option.origlongtable}). If - \Package{caption2}\IndexPackage{caption2} (see \cite{package:caption}) is - loaded, table captions are handled by this package. + \cite{package:longtable}). Used together with {\KOMAScript} this + mechanism in \Package{longtable} works only if the class option + \Option{origlongtable} is set (see + \autoref{sec:maincls.formattingOptions}, + \autopageref{desc:maincls.caption.origlongtable}). If the + \Package{caption2}\IndexPackage{caption2} or + \Package{caption}\IndexPackage{caption} package (see + \cite{package:caption}) is loaded, table captions are handled by + this package. - Please note that \Macro{captionabove} and \Macro{captionbelow} if placed - within a \Environment{float} environment which was defined using the - \Package{float}\IndexPackage{float} package have the same behaviour as - described in \cite{package:float} for the \Macro{caption} command. In this - case, only the float style determines whether it is a caption below or above - the figure or table. + Please note that \Macro{captionabove} and \Macro{captionbelow}, if + placed within a \Environment{float} environment which was defined + using the \Package{float}\IndexPackage{float} package, have the + exact same behaviour described in \cite{package:float} for the + \Macro{caption} command. In this case, the float style determines + whether the caption will be set below or above the figure or table. \end{Explain} @@ -4049,51 +4232,51 @@ is similar to \Macro{captionbelow}. \BeginIndex{Env}{captionbeside}% Apart\ChangedAt{v2.8q}{% \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} from -captions above and below the figure you often find captions, in +captions above and below the figure, one often finds captions, in particular with small figures, which are placed beside the figure. In -general in this case both the baseline of the figure and the caption -are aligned at the bottom. With some fiddling and the use of two -\Macro{parbox} commands this could be achieved in the standard -classes. But \KOMAScript{} offers a special environment for this -problem. This environment can be used within the floating environment. -The first optional parameter \PName{entry} and the obligatory -parameter \PName{title} are similar to the parameters of +general in this case both the baseline of the figure and of the +caption are aligned at the bottom. With some fiddling and the use of +two \Macro{parbox} commands this could also be achieved in the +standard classes. However, {\KOMAScript} offers a special environment +for this which can be used within the floating environment. The first +optional parameter \PName{entry} and the obligatory parameter +\PName{title} mean the same as the corresponding parameters of \Macro{caption}, \Macro{captionabove} or \Macro{captionbelow}. The -\PName{title} is placed beside the content of the environment in this -case. +caption text \PName{title} is placed beside the content of the +environment in this case. -Whether the \PName{title} is placed left or right can be determined by -the parameter \PName{placement}. One of the following letters is -accepted: +Whether the caption text \PName{title} is placed on the left or the +right can be determined by the parameter \PName{placement}. Exactly +one of the following letters is allowed: \begin{labeling}[--~]{\PValue[o]} \item[\PValue{l}] left \item[\PValue{r}] right -\item[\PValue{i}] inner margin in twoside layout -\item[\PValue{o}] outer margin in twoside layout +\item[\PValue{i}] inner margin in two-sided layout +\item[\PValue{o}] outer margin in two-sided layout \end{labeling} -Default setting is at the right side of the content of the -environment. If either \PValue{o} or \PValue{i} are used you have to -run {\LaTeX} twice to get the correct placement. - -As default the content of the environment and the \PName{title} fill -the whole available text width. However, using the optional parameter -\PName{width} it is possible to adjust the used width. This width -could even be more than the current text width. - -When supplying a \PName{width} the used width is centered with respect -to the text width. Using the optional parameter \PName{offset} you can -shift the environment relative to the left margin. A positive value -corresponds to a shift to the right whereas a negative value -corresponds to a shift to the left. An \PName{offset} of 0\Unit{pt} -gives you a left-aligned output. - -Adding a star to the optional parameter \PName{offset} the value means -a shift relative to the right margin on left pages in double sided -layout. A positive value corresponds to a shift towards the outer -margin whereas a negative value corresponds to a shift towards the -inner margin. An \PName{offset} of 0\Unit{pt} means alignment with the -inner margin. As mentioned before, in some cases it takes two \LaTeX{} -runs for this to work correctly. +Default setting is to the right of the content of the environment. If +either \PValue{o} or \PValue{i} are used you may need to run {\LaTeX} +twice to obtain the correct placement. + +Per default the content of the environment and the caption text +\PName{title} fill the entire available text width. However, using the +optional parameter \PName{width}, it is possible to adjust the width +used. This width could even be larger than the current text width. + +When supplying a \PName{width} the used width is usually centered with +respect to the text width. Using the optional parameter +\PName{offset}, you can shift the environment relative to the left +margin. A positive value corresponds to a shift to the right, whereas +a negative value corresponds to a shift to the left. An \PName{offset} +of 0\Unit{pt} gives you a left-aligned output. + +Adding a star to the optional parameter \PName{offset} makes the the +value mean a shift relative to the right margin on left hand pages in +two-sided layout. A positive value corresponds to a shift towards the +outer margin, whereas a negative value corresponds to a shift towards +the inner margin. An \PName{offset} of 0\Unit{pt} means alignment with +the inner margin. As mentioned before, in some cases it takes two +{\LaTeX} runs for this to work correctly. \begin{Example} An example for the usage of the \Environment{captionbeside} environment @@ -4121,30 +4304,30 @@ runs for this to work correctly. \end{captionbeside} \label{fig:maincls.captionbeside} \end{figure} - Thus, the width is the current available width + The total width is thus the currently available width \PValue{\Macro{linewidth}}. However, this width is shifted - \PValue{2em} to the outside. The title or the description is placed - inside beside the figure. Therefore, the figure itself is shifted - 2\Unit{em} into the margin. + \PValue{2em} to the outside. The caption text or description is + placed on the inner side beside the figure. The figure itself is + shifted 2\Unit{em} into the outer margin. \end{Example} % \EndIndex{Env}{captionbeside} -\BeginIndex[indexother]{}{font style} +\BeginIndex[indexother]{}{font>style} The font style\ChangedAt{v2.8p}{% - \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} for the description -and the label\,---\,``Figure'' or ``Table'' followed by the number and the -delimiter\,---\,can be changed with the commands mentioned in -\autoref{sec:maincls.font}. The respective elements for this are -\FontElement{caption}\IndexFontElement{caption} and + \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} for the +description and the label\,---\,``Figure'' or ``Table'', followed by +the number and the delimiter\,---\,can be changed with the commands +described in \autoref{sec:maincls.font}. The respective elements for +this are \FontElement{caption}\IndexFontElement{caption} and \FontElement{captionlabel}\IndexFontElement{captionlabel} (see \autoref{tab:maincls.elementsWithoutText}, -\autopageref{tab:maincls.elementsWithoutText}). First the font style for the -element \FontElement{caption} is applied on the element +\autopageref{tab:maincls.elementsWithoutText}). First the font style +for the element \FontElement{caption} is applied to the element \FontElement{captionlabel} too. After this the font style of -\FontElement{captionlabel} is applied on the respective element. The default -settings are listed in \autoref{tab:maincls.captionFont}. +\FontElement{captionlabel} is applied on the respective element. The +default settings are listed in \autoref{tab:maincls.captionFont}. % \begin{table} \centering% @@ -4175,7 +4358,7 @@ settings are listed in \autoref{tab:maincls.captionFont}. As you can see, simple extensions of the default definitions are possible. \end{Example} -\EndIndex[indexother]{}{font style} +\EndIndex[indexother]{}{font>style} % \EndIndex{Cmd}{caption}% \EndIndex{Cmd}{captionabove}% @@ -4189,19 +4372,22 @@ settings are listed in \autoref{tab:maincls.captionFont}. \end{Declaration}% \BeginIndex{Floatstyle}{komaabove}% \BeginIndex{Floatstyle}{komabelow}% -Using\OnlyAt{\Package{float}} the \Package{float}\IndexPackage{float} package -the appearance of the float environments is solely defined by the \emph{float} -style. This includes the fact whether captions above or below are used. In the -\Package{float} package there is no predefined style which gives you the same -output and offers the same setting options (see below) as \KOMAScript{}. -Therefore \KOMAScript{} defines the two additional styles \PValue{komaabove} -and \PValue{komabelow}. When using the \Package{float} package both these -styles can be activated as the styles \PValue{plain}\IndexFloatstyle{plain}, -\PValue{boxed}\IndexFloatstyle{boxed} or \PValue{ruled}\IndexFloatstyle{ruled} -in \Package{float} are defined. For details refer to \cite{package:float}. -The style \PValue{komaabove} inserts \Macro{caption}, \Macro{captionabove} and -\Macro{captionbelow} above whereas \PValue{komabelow} inserts them below the -float content. +If you use\OnlyAt{\Package{float}} the +\Package{float}\IndexPackage{float} package the appearance of the +float environments is solely defined by the \emph{float} style. This +includes whether captions above or below are used. In the +\Package{float} package there is no predefined style which gives you +the same output and offers the same setting options (see below) as +{\KOMAScript}. Therefore {\KOMAScript} defines the two additional +styles \PValue{komaabove} and \PValue{komabelow}. When using the +\Package{float} package these styles can be activated just like the +styles \PValue{plain}\IndexFloatstyle{plain}, +\PValue{boxed}\IndexFloatstyle{boxed} or +\PValue{ruled}\IndexFloatstyle{ruled} defined in \Package{float}. For +details refer to \cite{package:float}. The style \PValue{komaabove} +inserts \Macro{caption}, \Macro{captionabove} and \Macro{captionbelow} +above, whereas \PValue{komabelow} inserts them below the float +content. % \EndIndex{Floatstyle}{komaabove}% \EndIndex{Floatstyle}{komabelow}% @@ -4213,11 +4399,11 @@ float content. \end{Declaration}% \BeginIndex{Cmd}{captionformat}% In {\KOMAScript} there are different ways to change the formatting of -the description. The definition of different font styles was already +the caption text. The definition of different font styles was already explained above. This or the caption delimiter between the label and the label text itself is specified in the macro \Macro{captionformat}. -In difference to all other \Macro{\dots}format commands in this case -it doesn't contain the counter but the items which follow it. The +In contrast to all other \Macro{\dots}format commands, in this case it +does not contain the counter but only the items which follow it. The original definition is: \begin{lstlisting} \newcommand*{\captionformat}{:\ } @@ -4230,7 +4416,7 @@ This too can be changed with \Macro{renewcommand}. \begin{lstlisting} \renewcommand*{\captionformat}{~--~} \end{lstlisting} - This definition you should put in the preamble of your document. +This definition should be put in the preamble of your document. \end{Example} % \EndIndex{Cmd}{captionformat}% @@ -4242,13 +4428,14 @@ This too can be changed with \Macro{renewcommand}. \end{Declaration}% \BeginIndex{Cmd}{figureformat}% \BeginIndex{Cmd}{tableformat}% -It was already mentioned that \Macro{captionformat} doesn't contain a -formatting for the label itself. But this label shouldn't in any case -be changed using redefinitions of the commands for the output of -counters, \Macro{thefigure} or \Macro{thetable}. Such a redefinition -would have unwanted side effects on the output of \Macro{ref} or, for -example, of the list of figures. For this case {\KOMAScript} offers -two \Macro{\dots format} commands instead. These are predefined as +It was already mentioned that \Macro{captionformat} does not contain +formatting for the label itself. This situation should under no +circumstances be changed using redefinitions of the commands for the +output of counters, \Macro{thefigure} or \Macro{thetable}. Such a +redefinition would have unwanted side effects on the output of +\Macro{ref} or the table of contents, list of figures and list of +tables. To deal with the situation, {\KOMAScript} offers two +\Macro{\dots format} commands instead. These are predefined as follows: \begin{lstlisting} \newcommand*{\figureformat}{\figurename~\thefigure\autodot} @@ -4257,14 +4444,18 @@ follows: They also can be adapted to your personal preferences with \Macro{renewcommand}. \begin{Example} - From time to time label texts without any label and delimiter are - wanted. In {\KOMAScript} it takes only the following definitions to - achieve this: + From time to time captions without any label and of course without + delimiter are desired. In {\KOMAScript} it takes only the following + definitions to achieve this: \begin{lstlisting} \renewcommand*{\figureformat}{} \renewcommand*{\tableformat}{} \renewcommand*{\captionformat}{} \end{lstlisting} +It should be noted, however, that although no numbering is output, the +internal counters are nevertheless incremented. This becomes important +especially if this redefinition is applied only to selected +\Environment{figure} or \Environment{table} environments. \end{Example} % \EndIndex{Cmd}{figureformat}% @@ -4279,48 +4470,56 @@ They also can be adapted to your personal preferences with \BeginIndex{Cmd}{setcapindent*}% \BeginIndex{Cmd}{setcaphanging}% As mentioned previously, in the standard classes the captions are set -in a not-hanging style. That means that in descriptions with more than -one line the second and subsequent lines start directly beneath the -label. There is no straight way in the standard classes to change -this behaviour. In {\KOMAScript}, on the contrary, beginning at the -second line all lines are indented by the width of the label. - -This behaviour which corresponds to the usage of \Macro{setcaphanging} -can easily be changed by using the command \Macro{setcapindent} or -\Macro{setcapindent*}. Here the parameter \PName{Einzug} determines -the indentation of the second and subsequent lines. - -If you want a line break before the label and the description you -define the indentation \PName{xindent} of the description with the -starred version of the command instead: \Macro{setcapindent*}. - -Using a negative value of \PName{indent} instead, a page break is -inserted and only the first line but not the subsequent lines are -indented by \(-\PName{indent}\). +in a non-hanging style, that is, in multi-line captions the second and +subsequent lines start directly beneath the label. The standard +classes provide no direct mechanism to change this behaviour. In +{\KOMAScript}, on the contrary, beginning at the second line all lines +are indented by the width of the label so that the caption text is +aligned. + +This behaviour, which corresponds to the usage of +\Macro{setcaphanging}, can easily be changed by using the command +\Macro{setcapindent} or \Macro{setcapindent*}. Here the parameter +\PName{indent} determines the indentation of the second and subsequent +lines. + +If you want a line break after the label and before the caption text, +then you can define the indentation \PName{xindent} of the caption +text with the starred version of the command instead: +\Macro{setcapindent*}. + +Using a negative value of \PName{indent} instead, a line break is also +inserted before the caption text and only the first line of the +caption text but not subsequent lines are indented by +the absolute value of \PName{indent}. Whether one-line captions are set as captions with more than one line or are treated separately is specified with the class options \Option{onelinecaption} and \Option{noonelinecaption}. For details -please refer to the explanations of this options in +please refer to the explanations of these options in \autoref{sec:maincls.layoutOptions}, \autopageref{desc:maincls.option.noonelinecaption}. \begin{Example} - As examples please refer to the + For the examples please refer to figures~\ref{fig:maincls.caption.first} to - \ref{fig:maincls.caption.last}. As you can see the usage of a - complete hanging indentation is not preferable together with a small - column width: + \ref{fig:maincls.caption.last}. As you can see the usage of a fully + hanging indentation is not advantageous when combined with narrow + column width. To illustrate, the source code for the second figure + is given here with a modified caption text: \begin{lstlisting} \begin{figure} \setcapindent{1em} \fbox{\parbox{.95\linewidth}{\centering{\KOMAScript}}} - \caption{Examples with slightly indented caption + \caption{Example with slightly indented caption starting at the second line} \end{figure} \end{lstlisting} - As can be seen the formatting can also be changed locally within the - \Environment{figure} environment\IndexEnv{figure}. +As can be seen the formatting can also be changed locally within the +\Environment{figure} environment\IndexEnv{figure}. The change then +affects only the current figure. Following figures once again use the +default settings or global settings set, for example, in the preamble +of the document. This also of course applies to tables. \begin{figure} \typeout{^^J--- Ignore underfull and overfull \string\hbox:} \addtokomafont{caption}{\small} @@ -4385,101 +4584,103 @@ please refer to the explanations of this options in \BeginIndex{Cmd}{setcapmargin*}% Using\ChangedAt{v2.8q}{% \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} these three -commands you can specify the width and justification of the label -text. In general the whole text or column width is available for the -description. +commands you can specify the width and justification of the caption +text. In general the whole text width or column width is available +for the caption. With the command \Macro{setcapwidth} you can decrease this -\PName{width}. The obligatory argument determines the \PName{with} of -the description. As an optional argument you can supply one letter -which specifies the horizontal justification. The possible -justifications are given in the following list. +\PName{width}. The obligatory argument determines the maximum +\PName{width} of the caption. As an optional argument you can supply +exactly one letter which specifies the horizontal justification. The +possible justifications are given in the following list. \begin{labeling}[--~]{\PValue[o]} \item[\PValue{l}] left-aligned \item[\PValue{c}] centered \item[\PValue{r}] right-aligned -\item[\PValue{i}] alignment at the inner margin in a double sided output -\item[\PValue{o}] alignment at the outer margin in a double sided output +\item[\PValue{i}] alignment at the inner margin in double-sided output +\item[\PValue{o}] alignment at the outer margin in double-sided output \end{labeling} The justification inside and outside corresponds to left-aligned and -right-aligned respectively in single sided output. Within +right-aligned, respectively, in single-sided output. Within \Package{longtable}\IndexPackage{longtable} tables the justification -inside or outside doesn't work correctly. In particular the captions -of tables of subsequent pages are aligned corresponding to the first -part of the table. This is a problem which has its roots in the -implementation of \Package{longtable}. +inside or outside does not work correctly. In particular, the captions +on subsequent pages of such tables are aligned according to the format +of the caption on the first page of the table. This is a conceptual +problem in the implementation of \Package{longtable}. With the command \Macro{setcapmargin} you can specify a \PName{margin} which is to be left free next to the description in addition to the normal text margin. If you want margins with different widths at the left and right side you can specify these using the optional argument \PName{margin left}. The starred version \Macro{setcapmargin*} defines -instead of a \PName{margin left} a \PName{margin inside} in a double -sided layout. In case of \Package{longtable}\IndexPackage{longtable} -tables you have to deal with the same problem with justification -inside or outside as mentioned with the macro \Macro{setcapwidth}. -Furthermore the usage of \Macro{setcapmargin} or \Macro{setcapmargin*} -switches the option \Option{noonelinecaption} (see +instead of a \PName{margin left} a \PName{margin inside} in a +double-sided layout. In case of +\Package{longtable}\IndexPackage{longtable} tables you have to deal +with the same problem with justification inside or outside as +mentioned with the macro \Macro{setcapwidth}. Furthermore, the usage +of \Macro{setcapmargin} or \Macro{setcapmargin*} switches on the +option \Option{noonelinecaption} (see \autoref{sec:maincls.layoutOptions}, -\autopageref{desc:maincls.option.noonelinecaption}) for the descriptions which -are typeset with this margin setting. +\autopageref{desc:maincls.option.noonelinecaption}) for the captions +which are typeset with this margin setting. \begin{Explain} - \Package{longtable} places the description in a box, which is issued - again at the subsequent pages if needed. While treating a box the - macros needed for the creation of it aren't run through - again. That's why it is not possible for \KOMAScript{} to swop - margin settings in double sided layout on even pages. This would be - necessary to produce a justification which is shifted towards the - outside or inside. + \Package{longtable} places the caption in a box, which is issued + again on subsequent pages as needed. When outputting a box, the + macros needed for its creation are not reevaluated. That is the + reason why it is not possible for {\KOMAScript} to swap margin + settings for even pages in double-sided layout . This is what would + be necessary in order to produce a justification which is shifted + towards the outside or inside. You can also submit negative values for \PName{margin} and - \PName{margin right} or \PName{margin outside}. This has the effect - of the description spanning into the margin. + \PName{margin left} or \PName{margin inside}. This has the effect + of the caption expanding into the margin. \end{Explain} \begin{Example} - A rather odd problem is a figure caption which is both centered and - of the same width as the figure itself. If the width of the figure - is known the solution with \KOMAScript{} is quite easy. Suppose the - figure has a width of 8\Unit{cm}, it only takes: + A rather odd problem is that of a figure caption which is required + to be both centered and of the same width as the figure itself. If + the width of the figure is known in advance, the solution with + {\KOMAScript} is quite easy. Supposing the figure has a width of + 8\Unit{cm}, it only takes: \begin{lstlisting} \setcapwidth[c]{8cm} \end{lstlisting} - directly in front of \Macro{caption} or \Macro{captionbelow}. If it - is unknown first you have to define a length in the preamble of your - document: +directly in front of \Macro{caption} or \Macro{captionbelow}. If the +width is unknown then you first have to define a length in the +preamble of your document: \begin{lstlisting} - \newlength{\Figurewidth} + \newlength{\FigureWidth} \end{lstlisting} Having done this you can calculate the width directly with the - \LaTeX{} command \Macro{settowidth} (see \cite{latex:usrguide}) + {\LaTeX} command \Macro{settowidth} (see \cite{latex:usrguide}) in many cases. A possible solution would look as follows: \begin{lstlisting} \begin{figure} \centering% - \settowidth{\Figurewidth}{% - \fbox{\quad\KOMAScript\qaud}% + \settowidth{\FigureWidth}{% + \fbox{\quad\KOMAScript\quad}% }% \fbox{\quad\KOMAScript\quad}% - \setcapwidth[c]{\Figurewidth} + \setcapwidth[c]{\FigureWidth} \caption{Example of a centered caption below the figure} \end{figure} \end{lstlisting} - However, it is awkward to write the content twice and to use - \Macro{setcapwidth} with every figure. But nothing is easier than - defining a new command in the preamble of your document which - hides the three steps: +However, it is awkward to write the content twice and to call +\Macro{setcapwidth} for every figure. Yet nothing is easier than +defining a new command in the preamble of your document which hides +the three steps of: \begin{enumerate} - \item Defining the width of the argument - \item Specifying the width of the caption - \item Output of the argument + \item defining the width of the argument + \item specifying the width of the caption + \item outputting the argument \end{enumerate} in: \begin{lstlisting} \newcommand{\Figure}[1]{% - \settowidth{\Figurewidth}{#1}% - \setcapwidth[c]{\Figurewidth}% + \settowidth{\FigureWidth}{#1}% + \setcapwidth[c]{\FigureWidth}% #1} \end{lstlisting} Using this command the example abbreviates to: @@ -4491,24 +4692,24 @@ are typeset with this margin setting. \end{figure} \end{lstlisting} - But a command has the disadvantage that errors in the macros of the - argument in case of arguments with more than one line aren't - reported with the very correct line number by \LaTeX{}. In these - cases the usage of an environment has advantages. But then the - question is raised how the width of the content of the environment - can be determined. The solution offers the \Environment{lrbox} - environment, which is described in \cite{latex:usrguide}: +However, commands have the disadvantage that errors in the macros of +the argument in case of arguments with more than one line are not +reported with the very accurate line numbers by {\LaTeX}. Thus in some +cases the use of an environment has advantages. Then, however, the +question arises of how the width of the content of the environment can +be determined. The solution involves the \Environment{lrbox} +environment, described in \cite{latex:usrguide}: \begin{lstlisting} - \newsavebox{\Figurebox} + \newsavebox{\FigureBox} \newenvironment{FigureDefinesCaptionWidth}{% - \begin{lrbox}{\Figurebox}% + \begin{lrbox}{\FigureBox}% }{% \end{lrbox}% - \global\setbox\Figurebox=\box\Figurebox% - \aftergroup\Setfigurebox% + \global\setbox\FigureBox=\box\FigureBox% + \aftergroup\SetFigureBox% } - \newcommand{\Setfigurebox}{% - \Figure{\usebox{\Figurebox}}} + \newcommand{\SetFigureBox}{% + \Figure{\usebox{\FigureBox}}} \end{lstlisting} This definition uses the macro \Macro{Figure} defined above. In the main text you write: @@ -4521,19 +4722,20 @@ are typeset with this margin setting. \caption{Example of a centered caption below the figure} \end{figure} \end{lstlisting} - Admittingly, the environment in this example is not necessary. But - its definition using \Macro{global} is quite clever. Most users - wouldn't be able to define such an environment without help. But as - this can be very useful, it was introduced in the example above. +Admittedly, the environment in this example is not necessary. However, +its definition using \Macro{global} is quite tricky. Most users would +probably not be able to define such an environment without help. Thus, +as this definition can be very useful, it was introduced in the above +example. - If the \Environment{captionbeside} environment wouldn't exist you - could nevertheless place the figure caption beside the figure in a - quite simple way. For this \Macro{Setfigurebox} from the example - above would have to be redefined first: +Even if the \Environment{captionbeside} environment did not exist you +could nevertheless place the figure caption beside the figure in a +quite simple way. For this \Macro{SetFigureBox} from the example above +would have to be redefined first: \begin{lstlisting} - \renewcommand{\Setfigurebox}{% - \settowidth{\captionwidth}{\usebox{\Figurebox}}% - \parbox[b]{\captionwidth}{\usebox{\Figurebox}}% + \renewcommand{\SetFigureBox}{% + \settowidth{\captionwidth}{\usebox{\FigureBox}}% + \parbox[b]{\captionwidth}{\usebox{\FigureBox}}% \hfill% \addtolength{\captionwidth}{1em}% \addtolength{\captionwidth}{-\hsize}% @@ -4541,8 +4743,8 @@ are typeset with this margin setting. \setcapwidth[c]{\captionwidth}% } \end{lstlisting} - As the next step you only have to put the \Macro{caption} command in - a \Macro{parbox} too: +Finally you only have to put the \Macro{caption} command in a +\Macro{parbox} too: \begin{lstlisting} \begin{figure} \centering% @@ -4550,14 +4752,14 @@ are typeset with this margin setting. \fbox{\rule{0pt}{5\baselineskip}% \hspace{1em}\KOMAScript\hspace{1em}} \end{FigureSetsCaptionWidth} - \parbox[b]{\Figurewidth}{% + \parbox[b]{\FigureWidth}{% \caption{Example of a centered caption below the figure} } \end{figure} \end{lstlisting} - The \Macro{rule} command in this example only serves as an unvisible - support to produce an example figure with a greater vertical height. +The \Macro{rule} command in this example only serves as an invisible +support to produce an example figure with a greater vertical height. \end{Example} % \EndIndex{Cmd}{setcapwidth}% @@ -4569,14 +4771,14 @@ are typeset with this margin setting. \label{sec:maincls.emphasis} \begin{Explain} - \LaTeX{} offers different possibilities for logical - markup\Index{logical markup}\Index{markup} of text. In a sense, a - heading is a kind of markup too. However, in this section we are - only concerned with direct markup, i.e. markup which doesn't have an - additional meaning and which can be used for different - purposes. More details to the normally defined possibilities you can - find in \cite{lshort}, \cite{latex:usrguide} and - \cite{latex:fntguide}. + {\LaTeX} offers different possibilities for logical + markup\Index{logical markup}\Index{markup} of text. Strictly + speaking, a heading is a kind of markup too. However, in this + section we are only concerned with direct markup, i.\,e., markup which + does not have an additional semantic meaning and which can be used + for different purposes. More details on the normally defined + possibilities can be found in \cite{lshort}, \cite{latex:usrguide} + and \cite{latex:fntguide}. \end{Explain} \begin{Declaration} @@ -4584,59 +4786,58 @@ are typeset with this margin setting. \end{Declaration} \BeginIndex{Cmd}{textsubscript}% In \autoref{sec:maincls.footnotes}, -\autopageref{desc:maincls.macro.textsuperscript} the command +\autopageref{desc:maincls.macro.textsuperscript}, the command \Macro{textsuperscript}\IndexCmd{textsuperscript} was already -introduced which is a part of the \LaTeX{} kernel. Unfortunately -\LaTeX{} itself doesn't offer a command to produce a text in -subscript\Index{text, subscript}\Index{subscript} instead of -superscript\Index{text, superscript}\Index{superscript}. \KOMAScript{} -defines \Macro{textsubscript} for this. +introduced as an integral part of the {\LaTeX} kernel. Unfortunately, +{\LaTeX} itself does not offer a command to produce text in +subscript\Index{text>subscript}\Index{subscript} instead of +superscript\Index{text>superscript}\Index{superscript}. {\KOMAScript} +defines \Macro{textsubscript} for this purpose. % \begin{Example} - You are writing a text on the human metabolism. From time to time - you have to mention some simple sum formulas in which the - numbers are in subscript. Being convinced from logical markup you - first define in the document preamble or in a separate package: + You are writing a text on human metabolism. From time to time you + have to give some simple chemical formulas in which the numbers are + in subscript. For enabling logical markup you first define in the + document preamble or in a separate package: \begin{lstlisting} - \newcommand*{\Molek}[2]{#1\textsubscript{#2}} + \newcommand*{\molec}[2]{#1\textsubscript{#2}} \end{lstlisting} - \newcommand*{\Molek}[2]{#1\textsubscript{#2}} + \newcommand*{\molec}[2]{#1\textsubscript{#2}} Using this you then write: \begin{lstlisting} - The cell produces its energy from reaction of - \Molek C6\Molek H{12}\Molek O6 and \Molek O2 to - \Molek H2\Molek O{} and \Molek C{}\Molek O2. - However, Arsenic (\Molek{As}{}) has a detrimental - effect on the metabolism. + The cell produces its energy partly from reaction of \molec C6\molec + H{12}\molec O6 and \molec O2 to produce \molec H2\Molec O{} and + \molec C{}\molec O2. However, arsenic (\molec{As}{}) has a quite + detrimental effect on the metabolism. \end{lstlisting} The output looks as follows: \begin{ShowOutput} - The cell produces its energy from reaction of \Molek C6\Molek - H{12}\Molek O6 and \Molek O2 to \Molek H2\Molek O{} and \Molek - C{}\Molek O2. However, Arsenic (\Molek{As}{}) has a detrimental - effect on the metabolism. + The cell produces its energy from reaction of \molec C6\molec + H{12}\molec O6 and \molec O2 to produce \molec H2\molec O{} and + \molec C{}\molec O2. However, arsenic (\molec{As}{}) has a quite + detrimental effect on the metabolism. \end{ShowOutput} - Some time later you decide that the sum formulas should be - typeset in sans serif. Now you can see the advantages of a - consequent logical markup. You only have the redefine the - \Macro{Molek} command: + Some time later you decide that the chemical formulas should be + typeset in sans serif. Now you can see the advantages of using + logical markup. You only have the redefine the \Macro{molec} + command: \begin{lstlisting} - \newcommand*{\Molek}[2]{\textsf{#1\textsubscript{#2}}} + \newcommand*{\molec}[2]{\textsf{#1\textsubscript{#2}}} \end{lstlisting} - \renewcommand*{\Molek}[2]{\textsf{#1\textsubscript{#2}}} + \renewcommand*{\molec}[2]{\textsf{#1\textsubscript{#2}}} Now the output in the whole document changes to: \begin{ShowOutput} - The cell produces its energy from reaction of \Molek C6\Molek - H{12}\Molek O6 and \Molek O2 to \Molek H2\Molek O{} and \Molek - C{}\Molek O2. However, Arsenic (\Molek{As}{}) has a detrimental - effect on the metabolism. + The cell produces its energy partly from reaction of \molec + C6\molec H{12}\molec O6 and \molec O2 to produce \molec H2\molec + O{} and \molec C{}\molec O2. However, arsenic (\molec{As}{}) has + a quite detrimental effect on the metabolism. \end{ShowOutput} \end{Example} \begin{Explain} - In the example above the writing ``\verb|\Molek C6|'' is used. This - makes use of the fact that arguments which consist of only one - character doesn't have to be enclosed in parenthesis. That's why - ``\verb|\Molek C6|'' is similar to ``\verb|\Molek{C}{6}|''. You + In the example above, the notation ``\verb|\molec C6|'' is used. This + makes use of the fact that arguments consisting of only one + character do not have to be enclosed in parentheses. That is why + ``\verb|\molec C6|'' is similar to ``\verb|\molec{C}{6}|''. You might already know this from indices or powers in mathematical environments, such as ``\verb|$x^2$|'' instead of ``\verb|$x^{2}$|'' for ``$x^2$''. @@ -4660,16 +4861,17 @@ necessary, the index\Index{index}. \BeginIndex{Cmd}{appendix}% The appendix in the standard as well as the {\KOMAScript} classes is introduced with \Macro{appendix}. This command switches, among other -things, the chapter numbering to upper case letters thus making sure -that the rules according to \cite{DUDEN} are being followed. These -rules are explained in more detail in the description of the class -options \Option{pointednumbers} and \Option{pointlessnumbers} in -\autoref{sec:maincls.formattingOptions}, +things, the chapter numbering to upper case letters, also ensuring +that the rules according to \cite{DUDEN} are followed (for +German-speaking regions). These rules are explained in more detail in +the description of the class options \Option{pointednumbers} and +\Option{pointlessnumbers} in \autoref{sec:maincls.formattingOptions}, \autopageref{desc:maincls.option.pointlessnumbers}. Please note that \Macro{appendix} is a command, \emph{not} an -environment! This command does not need an argument. The disposition -commands in the appendix are used in the same way as in the main part. +environment! This command does not expect any argument. Sectioning in +the appendix uses \Macro{chapter} and \Macro{section} just as does the +main text. % \EndIndex{Cmd}{appendix} @@ -4680,30 +4882,31 @@ commands in the appendix are used in the same way as in the main part. \end{Declaration}% \BeginIndex{Cmd}{appendixmore}% There is a peculiarity within the \Macro{appendix} command in the -{\KOMAScript} classes. In case the command \Macro{appendixmore} is -defined, \Macro{appendix} is executed too. Internally the -{\KOMAScript} classes \Class{scrbook} and \Class{scrreprt} take -advantage of this behaviour for implementing the options -\Option{appendixprefix} and \Option{noappendixprefix} (see +{\KOMAScript} classes. If the command \Macro{appendixmore} is defined, +this command is executed also by the \Macro{appendix} +command. Internally the {\KOMAScript} classes \Class{scrbook} and +\Class{scrreprt} take advantage of this behaviour to implement the +options \Option{appendixprefix} and \Option{noappendixprefix} (see \autoref{sec:maincls.layoutOptions}, -\autopageref{desc:maincls.option.appendixprefix}). You should take care of this -in case you are going to define or redefine the \Macro{appendixmore} -by yourself. In case one of these options is set, you will receive an -error message when using -\verb|\newcommand{\appendixmore}{|\dots\verb|}|. This is thought to -prevent you from changing options without noticing. +\autopageref{desc:maincls.option.appendixprefix}). You should take +note of this in case you decide to define or redefine the +\Macro{appendixmore}. In case one of these options is set, you will +receive an error message when using +\verb|\newcommand{\appendixmore}{|\dots\verb|}|. This behaviour is +intended to prevent you from disabling options without noticing it. \begin{Example} You do not want the chapters in the main part of the classes - \Class{scrbook} or \Class{scrreprt} to be introduced by a prefix line - (see layout options \Option{chapterprefix} and \Option{nochapterprefix} - in \autoref{sec:maincls.layoutOptions}, - \autopageref{desc:maincls.option.chapterprefix}). For being consistent you - do not want such a line in the appendix either. Instead you would like - to see the word "`Chapter"' in the language of your choice written in - front of the chapter letter and, simultaneously, in the page headings. - Instead of using the layout options \Option{appendixprefix} or - \Option{noappendixprefix}, you would define in the document preamble: + \Class{scrbook} or \Class{scrreprt} to be introduced by a prefix + line (see layout options \Option{chapterprefix} and + \Option{nochapterprefix} in \autoref{sec:maincls.layoutOptions}, + \autopageref{desc:maincls.option.chapterprefix}). For consistency + you also do not want such a line in the appendix either. Instead, + you would like to see the word ``Chapter'' in the language of your + choice written in front of the chapter letter and, simultaneously, + in the page headings. Instead of using the either layout option + \Option{appendixprefix} or \Option{noappendixprefix}, you would + define in the document preamble: % \begin{lstlisting} \newcommand*{\appendixmore}{% @@ -4714,12 +4917,11 @@ prevent you from changing options without noticing. } \end{lstlisting} % - In case you are going to change your mind and want to use the option - \Option{appendixprefix} at a later state, you will get an error - message because of the already defined \Macro{appendixmore} command. - This prevents the definition mentioned above from changing the - settings already set using \Option{chapterprefix} and - \Option{nochapterprefix}. + In case you subsequently change your mind and decide to use the option + \Option{appendixprefix} at a later stage, you will get an error message + because of the already defined \Macro{appendixmore} command. This behaviour + prevents the definition made above from invisibly changing the settings + intended with the option. It is also possible to get a similar behaviour of the appendix for the class \Class{scrartcl}. You would write in the preamble of your @@ -4733,12 +4935,13 @@ prevent you from changing options without noticing. \appendixname~\thesection\autodot\enskip} } \end{lstlisting} - In addition the package \Package{ifthen}\IndexPackage{ifthen} (see + In addition, the package \Package{ifthen}\IndexPackage{ifthen} (see \cite{package:ifthen}) is required. Redefined commands are explained in more detail in - \autoref{sec:maincls.structure}, \autopageref{desc:maincls.macro.partformat} - and \autopageref{desc:maincls.macro.chaptermark}. + \autoref{sec:maincls.structure}, + \autopageref{desc:maincls.macro.chapterformat} and + \autopageref{desc:maincls.macro.chaptermarkformat}. \end{Example} % \EndIndex{Cmd}{appendixmore}% @@ -4748,37 +4951,32 @@ prevent you from changing options without noticing. \Macro{setbibpreamble}\Parameter{preamble} \end{Declaration}% \BeginIndex{Cmd}{setbibpreamble}% -The command \Macro{setbibpreamble} can be used for setting a preamble -for the bibliography\Index{bibliography}. This can be achieved by -placing the preamble before the command for issuing the bibliography. -However, it doesn't have to be directly in front of it. For example it -could be placed at the beginning of the document. Similar to the class -options \Option{bibtotoc} and \Option{bibtotocnumbered} this command -can only be successful if you haven't loaded a package which prevents -this by redefining the \Environment{thebibliography} environment. -Though the \Package{natbib} package \IndexPackage{natbib} unauthorized -uses internal macros of {\KOMAScript} it could be made sure that -\Macro{setbibpreamble} works with the current version of -\Package{natbib} (see \cite{package:natbib}). +The command \Macro{setbibpreamble} can be used to set a preamble for +the bibliography\Index{bibliography}. This can be achieved by placing +the preamble before the command for issuing the bibliography. +However, it does not have to be directly in front of it. For example, +it could be placed at the beginning of the document. Similar to the +class options \Option{bibtotoc} and \Option{bibtotocnumbered}, this +command can only be successful if you have not loaded a package which +prevents this by redefining the \Environment{thebibliography} +environment. Even though the \Package{natbib} package +\IndexPackage{natbib} makes unauthorized use of internal macros of +{\KOMAScript} it could be achieved that \Macro{setbibpreamble} works +with the current version of \Package{natbib} (see +\cite{package:natbib}). \begin{Example} You want to point out that the sorting of the references in the - bibliography is not according to their occuring in the text but in - alphabetical order. You use the following command: + bibliography is not according to their occurrence in the text, but + in alphabetical order. You use the following command: \begin{lstlisting} \setbibpreamble{References are in alphabetical order. References with more than one author are sorted - according to the first author.} + according to the first author.\par\bigskip} \end{lstlisting} The \Macro{bigskip}\IndexCmd{bigskip} command makes sure that the - preamble and the first reference are separated by a big skip. - - Another usage of the preamble in the bibliography would be setting - the references ragged right. Just put the preamble as follows: -\begin{lstlisting} - \setbibpreamble{\raggedright} -\end{lstlisting} - You can have a look at the result in the bibliography of this guide. + preamble and the first reference are separated by a large vertical + space. \end{Example} % \EndIndex{Cmd}{setbibpreamble} @@ -4788,29 +4986,30 @@ uses internal macros of {\KOMAScript} it could be made sure that \Macro{setindexpreamble}\Parameter{preamble} \end{Declaration}% \BeginIndex{Cmd}{setindexpreamble}% -Similar to the bibliography you can use a preamble in the index. This -is often the case if you have more than one index or if you use -different kinds of referencing by highlighting the page numbers in -different ways. +Similarly to the bibliography you can use a preamble to the +index. This is often the case if you have more than one index or if +you use different kinds of referencing by highlighting the page +numbers in different ways. \begin{Example} - You have a document in which terms are both defined an used. The + You have a document in which terms are both defined and used. The page numbers of definitions are in bold. Of course you want to make - your reader aware of this fact. Thus you insert a preamble in the + your reader aware of this fact. Thus you insert a preamble for the index: \begin{lstlisting} - \setindexpreamble{In \textbf{bold} printed page numbers - are references to the definition of terms.\par\bigskip} + \setindexpreamble{In \textbf{bold} printed page numbers are + references to the definition of terms. Other page numbers indicate + the use of a term.\par\bigskip} \end{lstlisting} \end{Example} % Please note that the page style of the first page of the index is changed. The applied page style is defined in the macro -\Macro{indexpagestyle}(see \autoref{sec:maincls.pageStyle}, +\Macro{indexpagestyle} (see \autoref{sec:maincls.pageStyle}, \autopageref{desc:maincls.macro.titlepagestyle}). The production, sorting and output of the index is done by the -standard \LaTeX{} packages and additional programs. Similar to the +standard {\LaTeX} packages and additional programs. Similar to the standard classes {\KOMAScript} only provides the basic macros and environments. % @@ -4821,22 +5020,24 @@ environments. \label{sec:maincls.obsolete} \begin{Explain} - In this section you will find commands, which should not be used any - more. They are part of older \KOMAScript{} versions. For compatibility - reasons they can still be used in the new \KOMAScript{} release. There - are new mechanisms and user interfaces however, which you should use - instead. The reason for listing the obsolete macros in this - documentation is to aid users with understanding old documents. - Furthermore, package authors are free to use these macros in the future. + In this section you will find commands which should not be used any + longer. They are part of older {\KOMAScript} versions and their use + was documented. For compatibility reasons they can still be used in + the current {\KOMAScript} release. There are however new mechanisms + and user interfaces which you should use instead. The reason for + listing the obsolete macros in this documentation is only to aid + users in understanding old documents. Furthermore, package authors + are free to use these macros in the future. \begin{Declaration} \Macro{sectfont} \end{Declaration} \BeginIndex{Cmd}{sectfont}% - This macro sets the font which is used for all section headings, the - main title an the highest level below \Macro{part} in the table of - contents. Use element \FontElement{disposition} instead, which is - described in more detail in \autoref{sec:maincls.font}.% + This macro sets the font which is used for all section headings and + the abstract, the main title and the highest level below + \Macro{part} in the table of contents. Instead, use the commands for + the element \FontElement{disposition}, described in + \autoref{sec:maincls.font}.% \EndIndex{Cmd}{sectfont}% \begin{Declaration} @@ -4848,9 +5049,9 @@ environments. The macro \Macro{capfont} sets the font which is used for captions in tables and figures. The macro \Macro{caplabelfont} sets the font which is used for the label and numbering of tables and pictures. - Please use element \FontElement{caption} and - \FontElement{captionlabel} of the current \KOMAScript{} instead - which are described in \autoref{sec:maincls.font}.% + Instead, use the commands for the elements \FontElement{caption} and + \FontElement{captionlabel}, described in + \autoref{sec:maincls.font}.% \EndIndex{Cmd}{capfont}% \EndIndex{Cmd}{caplabelfont}% @@ -4858,15 +5059,16 @@ environments. \Macro{descfont} \end{Declaration} \BeginIndex{Cmd}{descfont}% - This macro sets the font for the optional item arguments of an - \Environment{description} environment. Please use element - \FontElement{descriptionlabel} instead, which are described in - section ~\ref{sec:maincls.font}.% + This macro sets the font for the optional item arguments of a + \Environment{description} environment. Instead, use the commands for + the element \FontElement{descriptionlabel}, described in section + ~\ref{sec:maincls.font}.% \EndIndex{Cmd}{descfont}% \end{Explain} %%% Local Variables: %%% mode: latex +%%% coding: iso-latin-1 %%% TeX-master: "../guide" %%% End: diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex index 483c1a25349..1f9bdedb1e7 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex @@ -40,66 +40,71 @@ % % ---------------------------------------------------------------------- % -% Kapitel über scrpage2 in der KOMA-Script-Anleitung +% Kapitel über scrpage2 in der KOMA-Script-Anleitung % Verwaltet von Markus Kohm % % ============================================================================ -\ProvidesFile{scrdatetime.tex}[{2005/11/27 KOMA-Script guide (chapter: +\ProvidesFile{scrdatetime.tex}[{2007/09/26 KOMA-Script guide (chapter: scrdate, scrtime)}] +\translator{Gernot Hassenpflug\and Markus Kohm} + % Date of translated german file: 2005-11-27 -\chapter{Week-Day and Time Using \Package{scrdate} and \Package{scrtime}} +\chapter{Weekday and Time Using \Package{scrdate} and + \Package{scrtime}} \labelbase{datetime} -There are two packages at \KOMAScript{} to improve and extend the -handling of date\Index{date} and time\Index{time}. So you have not -only the standard commands \Macro{today} and \Macro{date}. Like all -the other packages from \KOMAScript{} bundle these two packages may be used -not only with \KOMAScript{} classes but also with standard and many -other classes. +There are two packages included in {\KOMAScript} to improve and extend +the handling of date\Index{date} and time\Index{time} over and above +what is provided by the standard commands \Macro{today} and +\Macro{date}. Like all the other packages from the {\KOMAScript} +bundle these two packages may be used not only with {\KOMAScript} +classes but also with the standard and many other classes. -\section{The Name of the Current Day of Week Using \Package{scrdate}} +\section{The Name of the Current Day of the Week Using + \Package{scrdate}} \label{sec:sec:datetime.scrdate} \BeginIndex{Package}{scrdate} -The first problem is the question about the current day of week. The answer -may be given by the package \Package{scrdate}. +The first problem is the question of the current day of the week. The +answer may be given using the package \Package{scrdate}. \begin{Declaration} \Macro{todaysname} \end{Declaration}% \BeginIndex{Cmd}{todaysname}% -You should know, that you may get the current date with -\Macro{today}\IndexCmd{today} in a language dependend -spelling. \Package{scrdate} offers you the command \Macro{todaysname}. This -results in the name of the current day of week in a language dependend +You should know that with \Macro{today}\IndexCmd{today} one obtains +the current date in a language-dependent spelling. \Package{scrdate} +offers you the command \Macro{todaysname} with which one can obtain +the name of the current day of the week in a language-dependent spelling. \begin{Example} - At your document you want to show the name of the week-day at which - the \File{dvi}-file was generated using \LaTeX. To do this, you + In your document you want to show the name of the weekday on which + the \File{dvi} file was generated using {\LaTeX}. To do this, you write: -\begin{lstlisting} - I've done the \LaTeX-run of this document on a \todaysname. -\end{lstlisting} - This will result in e.g.: + \begin{lstlisting} + I have done the {\LaTeX} run of this document on a \todaysname. + \end{lstlisting} + This will result in, e.\,g.: \begin{quote} - I've done the \LaTeX-run of this document on a \todaysname. + I have done the {\LaTeX} run of this document on a \todaysname. \end{quote} \end{Example} -Note that the package isn't able to decline. The known terms are the nominativ -singular that may be used e.g. at the date of a letter. For this the example -above is correct only at some languages. +Note that the package is not able to decline words. The known terms +are the nominative singular that may be used, e.\,g., in the date of a +letter. Given this limitation, the example above can work correctly +only for some languages. \begin{Explain} - \textbf{Tip:} The names of the week-days are saved in - capitalization. So the first letter is a capital letter, all the - others are small letters. But at some languages you also need the - names with a first letter in lower case. You may achieve this using - the standard \LaTeX{} command \Macro{MakeLowercase}. You simply have - to write \Macro{MakeLowercase}\PParameter{\Macro{todaysname}}. + \textbf{Tip:} The names of the weekdays are saved in capitalized + form, i.\,e., the first letter is a capital letter, all the others are + lowercase letters. But for some languages you may need the names + completely in lowercase. You may achieve this using the standard + {\LaTeX} command \Macro{MakeLowercase}. You simply have to write + \Macro{MakeLowercase}\PParameter{\Macro{todaysname}}. \end{Explain} \EndIndex{Cmd}{todaysname} @@ -107,43 +112,44 @@ above is correct only at some languages. \Macro{nameday}\Parameter{name} \end{Declaration}% \BeginIndex{Cmd}{nameday}% -You should know, that you may change the output of \Macro{today} using -\Macro{date}\IndexCmd{date}. In a analogous way you can change the -output of \Macro{todaysname} using \Macro{nameday} into \PName{name}. +Analogous to how the output of \Macro{today} can be modified using +\Macro{date}\IndexCmd{date}, so the output of \Macro{todaysname} can +be changed to \PName{name} by using \Macro{nameday}. \begin{Example} - You're changing the current date into a fix value using - \Macro{date}. You are not interested in the name of the day, but - you want to show, that it is a workday. So you set: + You change the current date to a fixed value using \Macro{date}. You + are not interested in the actual name of the day, but want only to + show that it is a workday. So you set: \begin{lstlisting} \nameday{workday} \end{lstlisting} After this the previous example will result in: \begin{quote} - I've done the \LaTeX-run of this document on a workday. + I have done the {\LaTeX} run of this document on a workday. \end{quote} \end{Example} \EndIndex{Cmd}{nameday} -Package \Package{scrdate} knows the languages english (english, american, -USenglish, UKenglish and british), german (german, ngerman and austrian), -french, italian, spanish, croatian, and finnish. If you want to configure it -for other languages, see \File{scrdate.dtx}. +Currently the package \Package{scrdate} knows the languages english +(english, american, USenglish, UKenglish and british), german (german, +ngerman and austrian), french, italian, spanish, croatian, and +finnish. If you want to configure it for other languages, see +\File{scrdate.dtx}. -At current implementation it doesn't matter, if you're loading +In the current implementation it does not matter whether you load \Package{scrdate} before or after \Package{german}\IndexPackage{german}, \Package{ngerman}\IndexPackage{ngerman}, \Package{babel}\IndexPackage{babel} or similar packages. The current -language will be setup at \Macro{begin}\PParameter{document}. +language will be set up at \Macro{begin}\PParameter{document}. \begin{Explain} - To explain it a little bit more exactly: While you are using a - language selection, which works in a compatible way to + To explain a little bit more exactly: while you are using a language + selection which works in a compatible way to \Package{babel}\IndexPackage{babel} or \Package{german}\IndexPackage{german}, the correct language will be used by \Package{scrdate}. If you are using another language - selection you will get english caption names. At \File{scrdate.dtx} - you will find the description of the \Package{scrdate}-commands for + selection you will get (US) english names. In \File{scrdate.dtx} you + will find the description of the \Package{scrdate} commands for defining the names. \end{Explain} \EndIndex{Package}{scrdate} @@ -153,39 +159,39 @@ language will be setup at \Macro{begin}\PParameter{document}. \label{sec:datetime.scrtime} \BeginIndex{Package}{scrtime} -The second problem is the question about current time. The solution may be -found using package \Package{scrtime}. +The second problem is the question of the current time. The solution +may be found using package \Package{scrtime}. \begin{Declaration}% \Macro{thistime}\OParameter{delimiter}\\ \Macro{thistime*}\OParameter{delimiter} \end{Declaration}% \BeginIndex{Cmd}{thistime}\BeginIndex{Cmd}{thistime*}% -\Macro{thistime} results in the current\Index{time}. -The delimiter between the values of hour and minute -can be given in the optional argument. -The default symbol of the delimiter is "\PValue{:}". - -\Macro{thistime*} works in the same way as \Macro{thistime}. -The difference between both is that the value of the minute -using \Macro{thistime*} is not preceded with zero when its value -is less than 10, thus using \Macro{thistime} the minute-value -has always two places. +\Macro{thistime} results in the current time\Index{time}. The +delimiter between the values of hour, minutes and seconds can be given +in the optional argument. The default symbol of the delimiter is +``\PValue{:}''. + +\Macro{thistime*} works in almost the same way as \Macro{thistime}. +The only difference is that unlike with \Macro{thistime}, with +\Macro{thistime*} the value of the minute field is not preceded by a +zero when its value is less than 10. Thus, with \Macro{thistime} the +minute field has always two places. \begin{Example} The line \begin{lstlisting} - Your train departs at \thistime . + Your train departs at \thistime. \end{lstlisting} - results for example in: + results, for example, in: \begin{quote} - Your train departs at \thistime . + Your train departs at \thistime. \end{quote} or: \begin{quote} Your train departs at 23:09. \end{quote} \bigskip - In contrast to the prevous example a line like: + In contrast to the previous example a line like: \begin{lstlisting} This day is already \thistime*[\ hours and\ ] minutes old. \end{lstlisting} @@ -201,15 +207,14 @@ has always two places. \EndIndex{Cmd}{thistime}\EndIndex{Cmd}{thistime*} \begin{Declaration}% - \Macro{settime}\Parameter{Time} + \Macro{settime}\Parameter{time} \end{Declaration}% \BeginIndex{Cmd}{settime}% -\Macro{settime} sets the output \Macro{thistime} and -\Macro{thistime*} on the value of \PName{Time}. -Afterwards the optinal parameter of \Macro{thistime} or -\Macro{thistime*} is ignored, since the result -of \Macro{thistime} or \Macro{thistime*} -was completely determined using \Macro{settime}.% +\Macro{settime} sets the output of \Macro{thistime} and +\Macro{thistime*} to the value \PName{time}. Now the optional +parameter of \Macro{thistime} or \Macro{thistime*} is ignored, since +the result of \Macro{thistime} or \Macro{thistime*} was completely +determined using \Macro{settime}.% \EndIndex{Cmd}{settime} \begin{Declaration} @@ -217,17 +222,16 @@ was completely determined using \Macro{settime}.% \Option{24h} \end{Declaration}% \BeginIndex{Option}{12h}\BeginIndex{Option}{24h}% -Using the options \Option{12h} and \Option{24h} one can -select whether the result of \Macro{thistime} and \Macro{thistime*} -is in 12- or in 24-hour format. The default is \Option{24h}.% - -The option has no effect on the results of -\Macro{thistime} and \Macro{thistime*} if \Macro{settime} -has been used.% +Using the options \Option{12h} and \Option{24h} one can select whether +the result of \Macro{thistime} and \Macro{thistime*} is in 12- or in +24-hour format. The default is \Option{24h}. The option has no effect +on the results of \Macro{thistime} and \Macro{thistime*} if +\Macro{settime} is used.% \EndIndex{Option}{12h}\EndIndex{Option}{24h} \EndIndex{Package}{scrtime} %%% Local Variables: %%% mode: latex +%%% coding: iso-latin-1 %%% TeX-master: "../guide" %%% End: diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex index fd1ce916852..d55e5f98219 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlfile.tex @@ -40,13 +40,15 @@ % % ---------------------------------------------------------------------------- % -% Kapitel über scrlfile in der KOMA-Script-Anleitung +% Kapitel ueber scrlfile in der KOMA-Script-Anleitung % Verwaltet von Markus Kohm % % ============================================================================ -\ProvidesFile{scrlfile.tex}[2005/11/27 KOMA-Script guide (chapter: scrlfile)] -% Date of translated german file: 2005/08/10 +\ProvidesFile{scrlfile.tex}[2007/09/26 KOMA-Script guide (chapter: scrlfile)] +\translator{Gernot Hassenpflug\and Markus Kohm} + +% Date of translated german file: 2007/08/07 \chapter{Control Package Dependencies with \Package{scrlfile}} \labelbase{scrlfile} @@ -54,104 +56,111 @@ \BeginIndex{Package}{scrlfile} \begin{Explain} - The introduction of \LaTeXe{} in 1994 brought many changes in the handling - with \LaTeX-extensions. Today the package author has many macros in order - to determine if another package or class is employed and whether specific - options are used. The author can load other packages or can specify options - in the the case the package is loaded later. This has led to the - expectation that the order of package-loading will be not important. But + The introduction of {\LaTeXe} in 1994 brought many changes in the + handling of {\LaTeX} extensions. Today the package author has many + macros available to determine if another package or class is + employed and whether specific options are used. The author can load + other packages or can specify options in the the case that the + package is loaded later. This has led to the expectation that the + order in which package are loaded would not be important. Sadly this hope has not been fulfilled. \end{Explain} \section{About Package Dependencies} \label{sec:scrlfile.dependency} \begin{Explain} - Often different packages define or redefine one macro again and again. In - such a case the order of package-loading becomes very important. For the - user this is sometimes difficult to understand the behaviour and in some - cases the user wants only react on the loading of a package. This is also - not really simple. + More and more frequently, different packages either newly define or + redefine the same macro again. In such a case the order in which a + package is loaded becomes very important. For the user it sometimes + becomes very difficult to understand the behaviour, and in some + cases the user wants only to react to the loading of a package. This + too is not really a simple matter. - Assuming the simple example that loads the package \Package{longtable} with - a \KOMAScript{} document-class employed. The \Package{longtable} package - defines table captions suitable for the standard classes, but the captions - are totally unsuitable for documents using \KOMAScript{} and thus the - provided configuration commands have no influence. In order to solve this - problem the commands which are responsible for the table captions of the - \Package{longtable} package have to be re-defined. But at the moment when - the \Package{longtable} is loaded the \KOMAScript{} class is already - processed. + Let us take the simple example of loading the package + \Package{longtable} with a {\KOMAScript} document class. The + \Package{longtable} package defines table captions very well suited + to the standard classes, but the captions are totally unsuitable for + documents using {\KOMAScript} and also do not react to the options + of the provided configuration commands. In order to solve this + problem, the \Package{longtable} package commands which are + responsible for the table captions need to be redefined. However, by + the time the \Package{longtable} package is loaded, the + {\KOMAScript} class has already been processed. - The only chance for \KOMAScript{} was to delay the re-definition until the - begin of the document with help of the macro \Macro{AtBeginDocument}. If - the user wants to change the definitions too, it is recommended to do this - in the preamble of the document. But this is impossible since later at - \Macro{begin}\PParameter{document} \KOMAScript will again overwrite the - user-definition with its own. Therefore the user has to delay his - definition with \Macro{AtBeginDocument} as well. + Until the present, the only way for {\KOMAScript} to solve this + problem was to delay the redefinition until the beginning of the + document with help of the macro \Macro{AtBeginDocument}. If the + user wants to change the definitions too, it is recommended to do + this in the preamble of the document. However, this is impossible + since later at \Macro{begin}\PParameter{document} {\KOMAScript} will + again overwrite the user definition with its own. Therefore, the + user too has to delay his definition with \Macro{AtBeginDocument}. - However, \KOMAScript{} shouldn't delay the re-definition until - \Macro{begin}\PParameter{document}. It would be enough to delay until the - package \Package{longtable} has been loaded. But unfortunately the basic - \LaTeX{} does not define appropriate commands. The package - \Package{scrlfile} provides redress here. + Actually, {\KOMAScript} should not need to delay the redefinition + until \Macro{begin}\PParameter{document}. It would be enough to + delay exactly until the package \Package{longtable} has been + loaded. Unfortunately, the {\LaTeX} kernel does not define + appropriate commands. The package \Package{scrlfile} provides + redress here. - Likewise, it might be conceivable that before a package is loaded one would - like to save the definition of a macro in a help-macro, in order to restore - its meaning after the package has been loaded. The package - \Package{scrlfile} allows this too. + Likewise, it might be conceivable that before a package is loaded + one would like to save the definition of a macro in a help-macro, in + order to restore its meaning after the package has been loaded. The + package \Package{scrlfile} allows this, too. - The employment of \Package{scrlfile} is not limited to package dependencies - only. Even dependencies with any other file can be attended. For example - the user can be warned if the not uncritical file \File{french.ldf} has been - loaded. + The employment of \Package{scrlfile} is not limited to package + dependencies only. Even dependencies on any other file can be + considered. For example, the user can be warned if the not + uncritical file \File{french.ldf} has been loaded. - Though the package is particularly interesting for package authors, there - are of course applications for normal \LaTeX{} users too. Therefore this - chapter gives and explains examples for both groups of users. + Although the package is particularly of interest for package + authors, there are of course applications for normal {\LaTeX} users, + too. Therefore, this chapter gives and explains examples for both + groups of users. \end{Explain} -\section{Actions Prior and After Loading} +\section{Actions Prior to and After Loading} \label{sec:scrlfile.macros} +\Package{scrlfile} can execute actions both before and after the +loading of files. In the commands used to do this, distinctions are +made made between general files, classes, and packages. + \begin{Declaration} \Macro{BeforeFile}\Parameter{file}\Parameter{instructions}\\ \Macro{AfterFile}\Parameter{file}\Parameter{instructions} \end{Declaration}% \BeginIndex{Cmd}{BeforeFile}% \BeginIndex{Cmd}{AfterFile}% -The macro \Macro{BeforeFile} enables to execute \PName{instructions} -the next time the \PName{file} is loaded. -In the same way works \Macro{AfterFile}, but here the -\PName{instructions} will be executed after the \PName{file} -has been loaded. -If \PName{file} will never be loaded then the \PName{instructions} -will never be executed. +The macro \Macro{BeforeFile} ensures that \PName{instructions} are +only executed before the next time \PName{file} is loaded. +\Macro{AfterFile} works in a similar fashion, and the +\PName{instructions} will be executed only after the \PName{file} has +been loaded. If \PName{file} is never loaded then the +\PName{instructions} will never be executed. \begin{Explain} - In order to implement those features \Package{scrlfile} - re-defines the well known \LaTeX{} command - \Macro{InputIfFileExists}. - If this macro has not the expected definition \Package{scrlfile} - gives a warning. - This is for the case that in future \LaTeX{} versions - the macro can have a different definition or an other package - has already re-defined it. + In order to implement those features \Package{scrlfile} redefines + the well known {\LaTeX} command \Macro{InputIfFileExists}. If this + macro does not have the expected definition then \Package{scrlfile} + issues a warning. This is for the case that in future {\LaTeX} + versions the macro can have a different definition, or that another + package has already redefined it. - The command \Macro{InputIfFileExists} is used - everytime \LaTeX{} has to load a file. - This is independent from whether the actual command was \Macro{LoadClass}, - \Macro{documentclass}, \Macro{usepackage}, \Macro{RequiresPackage}, - or \Macro{include}. Exclusively the command -\begin{lstlisting} - \input foo -\end{lstlisting} - loads the file \texttt{foo} without to utilize - \Macro{InputIfFileExists}. Therefore one should always use -\begin{lstlisting} - \input{foo} -\end{lstlisting} + The command \Macro{InputIfFileExists} is used by {\LaTeX} every time + a file is to be loaded. This is independent of whether the actual + load command is \Macro{include}, \Macro{LoadClass}, + \Macro{documentclass}, \Macro{usepackage}, \Macro{RequirePackage}, + or similar. Exceptionally, the command + \begin{lstlisting} + \input foo + \end{lstlisting} + loads the file \texttt{foo} without utilizing + \Macro{InputIfFileExists}. Therefore, one should always use + \begin{lstlisting} + \input{foo} + \end{lstlisting} instead. Notice the parentheses surrounding the file name! \end{Explain} % @@ -164,12 +173,11 @@ will never be executed. \end{Declaration}% \BeginIndex{Cmd}{BeforeClass}% \BeginIndex{Cmd}{BeforePackage}% -These both commands work the same way as \Macro{BeforeFile}. -The only difference is that the document class \PName{class} -and the \LaTeX{} package \PName{package} are specified -with their names and not with their file names. -That means the file extensions \File{.cls} and \File{.sty} -can be omitted. +These two commands work in the same way as \Macro{BeforeFile}. The +only difference is that the document class \PName{class} and the +{\LaTeX} package \PName{package} are specified with their names and +not with their file names. That means that the file extensions +\File{.cls} and \File{.sty} can be omitted. % \EndIndex{Cmd}{BeforeClass}% \EndIndex{Cmd}{BeforePackage}% @@ -184,15 +192,13 @@ can be omitted. \BeginIndex{Cmd}{AfterClass*}% \BeginIndex{Cmd}{AfterPackage}% \BeginIndex{Cmd}{AfterPackage*}% -The commands \Macro{AfterClass} und \Macro{AfterPackage} -work the same way as \Macro{AfterFile}. -The only difference is that the document class \PName{class} -and the \LaTeX{} package \PName{package} are specified -with their names and not with their file names. -That means the file extensions \File{.cls} and \File{.sty} -can be omitted. -The starred versions execute the \PName{instructions} not -only next time the class or package is loaded, but also +The commands \Macro{AfterClass} and \Macro{AfterPackage} work in the +same way as \Macro{AfterFile}. The only difference is that the +document class \PName{class} and the {\LaTeX} package \PName{package} +are specified with their names and not with their file names. That +means that the file extensions \File{.cls} and \File{.sty} can be +omitted. The starred versions execute the \PName{instructions} not +only at next time that the class or package is loaded, but also immediately if the class or package has been loaded already. % \EndIndex{Cmd}{AfterClass}% @@ -201,9 +207,8 @@ immediately if the class or package has been loaded already. \EndIndex{Cmd}{AfterPackage*}% \begin{Example} - In the following an example for class and package authors - shall be given. - It shows how \KOMAScript{} itself employs the new commands. + In the following, an example for class and package authors shall be + given. It shows how {\KOMAScript} itself employs the new commands. The class \Class{scrbook} contains: \begin{lstlisting} \AfterPackage{hyperref}{% @@ -218,46 +223,41 @@ immediately if the class or package has been loaded already. Please update hyperref to at least version 6.71b}}} \end{lstlisting} - Old versions of the \Package{hyperref} package re-define - a macro of the \Class{scrbook} class in a way that does not - work with newer \KOMAScript{} versions. - New versions of \Package{hyperref} neglect these changes - if a new \KOMAScript{} version is detected. - For the case that \Package{hyperref} is loaded the code - in \Class{scrbook} verifies that a appropriate - \Package{hyperref} version is used. If not the command gives - a warning. +Old versions of the \Package{hyperref} package redefine a macro of the +\Class{scrbook} class in such a way that does not work with newer +{\KOMAScript} versions. New versions of \Package{hyperref} desist +from making these changes if a new {\KOMAScript} version is detected. +For the case that \Package{hyperref} is loaded at a later stage, +therefore, the code in \Class{scrbook} verifies that a acceptable +\Package{hyperref} version is used. If not, the command issues a +warning. - At other places in three \KOMAScript{} classes following can be found: +At other places in three {\KOMAScript} classes the following can be +found: \begin{lstlisting} \AfterPackage{caption2}{% \renewcommand*{\setcapindent}{% \end{lstlisting} - Next the package \Package{caption2} has been loaded, and only - if the package has been loaded really, \KOMAScript{} re-defines - its own command \Macro{setcapindent}. - The exact code of the definition is not important. - It should only be noted that \Package{caption2} claims the - control over the \Macro{caption} macro. - Thus the normal definition of the \Macro{setcapindent} macro - would not work as expected. - The re-definition improves the collaboration with \Package{caption2}. +After the package \Package{caption2} has been loaded, and only if it +has been loaded, {\KOMAScript} redefines its own command +\Macro{setcapindent}. The exact code of the redefinition is not +important. It should only be noted that \Package{caption2} takes +control of the \Macro{caption} macro and that therefore the normal +definition of the \Macro{setcapindent} macro would become ineffective. +The redefinition improves the collaboration with \Package{caption2}. - There are of course useful examples for normal \LaTeX{} user too. - Suppose a document that should be availbale as PS file, using - LaTeX{} and dvips, and as PDF file, using pdf\LaTeX. - The document should contain hyper-links. - In the List of Tables there are entries longer than one line. - This is not a problem for the pdf\LaTeX{} way, since here - hyper-links can run across multiple lines. - But if a \Package{hyperref} driver for dvips or - hyper\TeX{} is used then this is not possible. - In this case one wants that for the \Package{hyperref} setup - the \Option{linktocpage} is used. - - The decision what \Package{hyperref} driver has to be used - happens automatically via \File{hyperref.cfg}. - The file has for example the content below. +There are however also useful examples for normal {\LaTeX} user. +Suppose a document that should be available as a PS file, using +{\LaTeX} and dvips, as well as a PDF file, using pdf{\LaTeX}. In +addition, the document should contain hyperlinks. In the list of +tables there are entries longer than one line. This is not a problem +for the pdf{\LaTeX} method, since here hyperlinks can be broken across +multiple lines. However, if a \Package{hyperref} driver for dvips or +hyper{\TeX} is used then this is not possible. In this case one +desires that for the \Package{hyperref} setup \Option{linktocpage} is +used. The decision which \Package{hyperref} driver to use happens +automatically via \File{hyperref.cfg}. The file has, for example, the +following content: \begin{lstlisting} \ProvidesFile{hyperref.cfg} \@ifundefined{pdfoutput}{\ExecuteOptions{dvips}} @@ -265,7 +265,7 @@ immediately if the class or package has been loaded already. \endinput \end{lstlisting} - All following is now the task of \Macro{AfterFile}. +All the rest can now be left to \Macro{AfterFile}. \begin{lstlisting} \documentclass{article} \usepackage{scrlfile} @@ -276,35 +276,33 @@ immediately if the class or package has been loaded already. \listoffigures \clearpage \begin{figure} - \caption{This is an example for a long figure caption, - but even though it does not employ the optional - caption argument that would allow to write - a short caption in the List of Figures.} + \caption{This is an example for a fairly long figure caption, but + which does not employ the optional caption argument that would + allow one to write a short caption in the list of figures.} \end{figure} \end{document} \end{lstlisting} - If now \Package{hyperref} drivers \Option{hypertex} or - \Option{dvips} are used then the useful \Package{hyperref} option - \Option{linktocpage} will be set. - In the pdf\LaTeX{} case the option will not be set, since - in that case an other \Package{hyperref} driver \File{hpdftex.def} - will be used. That means neither \File{hdvips.def} nor - \File{hypertex.def} will be loaded. +If now the \Package{hyperref} drivers \Option{hypertex} or +\Option{dvips} are used, then the useful \Package{hyperref} option +\Option{linktocpage} will be set. In the pdf{\LaTeX} case, the option +will not be set, since in that case another \Package{hyperref} driver, +\File{hpdftex.def}, will be used. That means neither \File{hdvips.def} +nor \File{hypertex.def} will be loaded. \end{Example} \begin{Explain} - Furthermore the loading of package \Package{scrlfile} - and the \Macro{AfterFile} statement can be written - in the private \File{hyperref.cfg}. - But then instead of \Macro{usepackage} the macro - \Macro{RequiresPackage} ought be used, see \cite{latex:clsguide}. - The new lines have to be inserted directly after - \Macro{ProvidesFile} line, thus prior to the execution - of the options \Option{dvips} or \Option{pdftex}. + Furthermore, the loading of package \Package{scrlfile} and the + \Macro{AfterFile} statement can be written in a private + \File{hyperref.cfg}. If you do so, then instead of + \Macro{usepackage} the macro \Macro{RequirePackage} ought be used + (see \cite{latex:clsguide}). The new lines have to be inserted + directly after the \Macro{ProvidesFile} line, thus immediately prior + to the execution of the options \Option{dvips} or \Option{pdftex}. \end{Explain}% \EndIndex{Package}{scrlfile} %%% Local Variables: %%% mode: latex +%%% coding: iso-latin-1 %%% TeX-master: "../guide" %%% End: diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex index fecaafafd0a..3c876d38fe3 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrlttr2.tex @@ -49,139 +49,211 @@ % % ============================================================================ -\ProvidesFile{scrlttr2.tex}[2006/07/06 KOMA-Script guide (chapter: scrlttr2)] -% Date of translated german file: 2006-04-24 -% +\ProvidesFile{scrlttr2.tex}[2007/09/27 KOMA-Script guide (chapter: scrlttr2)] +\translator{Harald Bongartz\and Georg Grandke\and Raimund Kohl\and Jens-Uwe + Morawski\and Stephan Hennig\and Gernot Hassenpflug\and Markus Kohm} + +% Date of translated german file: 2007-09-17 \chapter{The New Letter Class \Class{scrlttr2}} \labelbase{scrlttr2} -\BeginIndex{Class}{scrlttr2}\BeginIndex{}{Letters}% +\BeginIndex{Class}{scrlttr2}\BeginIndex{}{letters}% \begin{Explain} -Since June 2002 release \KOMAScript{} provides a completely -rewritten letter class\ChangedAt{v2.8q}{\Class{scrlttr2}}. Although part -of the code is identical to main classes described in \autoref{cha:maincls}, -letters are quite different from articles, reports, books, and such. -That alone justifies a separate chapter about the letter class. But -there is another reason for a chapter on \Class{scrlttr2}. This class has -been redeveloped from scratch and provides a new user interface different -from every other class the author knows. This new user interface may be -uncommon but the author is convinced both old and new \KOMAScript{} users -will benefit from its advantages. + Since the June 2002 release {\KOMAScript} provides a completely + rewritten letter class\ChangedAt{v2.8q}{\Class{scrlttr2}}. Although + part of the code is identical to that of the main classes described + in \autoref{cha:maincls}, letters are quite different from articles, + reports, books, and suchlike. That alone justifies a separate + chapter about the letter class. But there is another reason for a + chapter on \Class{scrlttr2}. This class has been redeveloped from + scratch and provides a new user interface different from every other + class the author knows of. This new user interface may be uncommon, + but the author is convinced both experienced and new {\KOMAScript} + users will benefit from its advantages. \section{Looking Back on the Old Letter Class} \label{sec:scrlttr2.scrlettr} -With June 2002 release the old letter class -\Class{scrlettr}\IndexClass{scrlettr} became obsolete. It is recommended -not to use that class for new applications. There is no development on -the old letter class anymore, and support is very restricted. However, -if you really need the documentation of the old letter class, you can -still find it in file \File{scrlettr.dtx}, but only in German. You can -run it through \LaTeX{} some times, like that: +With the June 2002 release the old letter class +\Class{scrlettr}\IndexClass{scrlettr} became obsolete. It is +recommended not to use that class for new applications. There is no +more active development of the old letter class, and support is very +restricted. However, if you really need the documentation of the old +letter class, you can still find it in the file \File{scrlettr.dtx}, +but only in German. You should run it through {\LaTeX} several times, +like this: \begin{lstlisting} latex scrlettr.dtx latex scrlettr.dtx latex scrlettr.dtx \end{lstlisting} -You get file \File{scrlettr.dvi} containing the old German manual. - -To facilitate the transition to the new class, there is a compatibility -option. In general, the complete functionality still remains in the new class. -Without that compatibility option, the user interface and the defaults will be -different. More detail on this option is provided in -\autoref{sec:scrlttr2.options} and \autoref{sec:scrlttr2.fromscrlettr}. +Then you obtain the file \File{scrlettr.dvi} containing the old German +manual. + +To facilitate the transition to the new class, there is a +compatibility option. In general, the complete older functionality +still remains in the new class. Without that compatibility option, +the user interface and the defaults will be different. More details on +%this option is provided in \autoref{sec:scrlttr2.options} and +%\autoref{sec:scrlttr2.fromscrlettr}. +this option are provided in \autoref{sec:scrlttr2.lcoFile}, +\autoref{tab:lcoFiles} and \autoref{sec:scrlttr2.fromscrlettr}. \end{Explain} \section{Options} \label{sec:scrlttr2.options} The letter class \Class{scrlttr2} uses the package -\Package{keyval}\IndexPackage{keyval} to handle options. This is part of -the \Package{graphics} package (see \cite{package:graphics}). Since -\Package{graphics} is part of the \emph{required} section of \LaTeX, it -should be found in every \LaTeX{} distribution. Should your \TeX{} -distribution contain \LaTeX, but not the packages \Package{graphics} -and \Package{keyval}, please complain to your \TeX{} distributor. If you -want to use \Class{scrlttr2}, you will have to install the +\Package{keyval}\IndexPackage{keyval} to handle options. This is part +of the \Package{graphics} package (see \cite{package:graphics}). Since +\Package{graphics} is part of the \emph{required} section of {\LaTeX}, +it should be found in every {\LaTeX} distribution. Should your {\TeX} +distribution contain {\LaTeX}, but not the packages \Package{graphics} +and \Package{keyval}, please complain to your {\TeX} distributor. If +you want to use \Class{scrlttr2}, you will have to install the \Package{graphics} package yourself in that case. \begin{Explain} - The special feature of the \Package{keyval} package is the possibility to - accompany options by values. You do not only need a lot less options, but - maybe even fewer optional arguments. You will see that when discussing the - \Environment{letter} environment in \autoref{sec:scrlttr2.addressee}, - \autopageref{desc:scrlttr2.environment.letter}. The class will automatically - load the \Package{keyval} package. If you need to supply options to the - \Package{keyval} package, you should use the \Macro{PassOptionsToPackage} - command before \Macro{documentclass}. + The special feature of the \Package{keyval} package is that options + can have values. Thus, you not only need a lot less options, but + perhaps also fewer optional arguments. You will see that when + discussing the \Environment{letter} environment in + \autoref{sec:scrlttr2.addressee}, + \autopageref{desc:scrlttr2.environment.letter}. The class will + automatically load the \Package{keyval} package. If you need to + supply options to the \Package{keyval} package, you should use the + \Macro{PassOptionsToPackage} command before \Macro{documentclass}. \end{Explain} \subsection{Defining Options Later} \label{sec:scrlttr2.options.late} +\BeginIndex{}{options} -This section anticipates a feature of the new letter class. The meaning -of this feature will not become clear until the structure of a document -with more than one letter inside and another feature of \Class{scrlttr2} -will be understood. But to keep the number of forward references low, it -is reasonable to describe them this early. +This section anticipates a feature of the new letter class. The +meaning of this feature will not become clear until the structure of a +document with more than one letter inside and another feature of +\Class{scrlttr2} is understood. However, to keep the number of forward +references low, it is reasonable to describe the feature this early. \begin{Declaration} \Macro{KOMAoptions}\Parameter{option list} \end{Declaration} \BeginIndex{Cmd}{KOMAoptions}% -The possibility to change many options after loading the class is a -special feature of the \Class{scrlttr2} class. The \Macro{KOMAoptions} -command serves this purpose, taking options and their values as -arguments. You can list multiple options, separated by commas, like in -the optional argument of \Macro{documentclass}. If an option is only -available when loading the class, i.\,e.\ as an optional argument to -\Macro{documentclass}, there will be an explicit remark in the option's -description. +A special feature of the \Class{scrlttr2} class is the possibility to +change many options even after loading the class. The +\Macro{KOMAoptions} command serves this purpose, taking options and +their values as arguments. You can list multiple options, separated by +commas, just like in the optional argument of +\Macro{documentclass}. If an option is only available when loading the +class, i.\,e., as an optional argument to \Macro{documentclass}, this +will be explicitly mentioned in the option's description. \begin{Explain} -If you set an option to an illegal value within the \PName{option -list}, \LaTeX{} will stop and show an error message. By entering -``\texttt{h}'' you will get an explanation that will also list possible -values for that particular option. + If you set an option to an illegal value within the \PName{option + list}, {\LaTeX} will stop and show an error message. By entering + ``\texttt{h}'' you will get an explanation that will also list + possible values for that particular option. \end{Explain} % \EndIndex{Cmd}{KOMAoptions}% +\EndIndex{}{options}% + +\subsection{Options for Compatibility} +\label{sec:scrlttr2.compatibilityOptions} +\BeginIndex{}{compatibility}% + +People who archive their letters in source code format generally place +the highest priority on obtaining exactly the same results in future +{\LaTeX} runs. In some cases however, improvements and corrections to +the class can lead to changes in behaviour, particularly as regards +page breaking. + +\begin{Declaration} + \Option{version}=\PName{value} +\end{Declaration} +\BeginIndex{Option}{version}% +With\ChangedAt{v2.9t}{\Class{scrlttr2}} \Class{scrlttr2} there is the +choice, whether a source file should give, as far as is technically +possible, the same in any future {\LaTeX} runs, or whether the +document should be set according to the latest version of the +class. To which version compatibility should be retained is determined +by the option \Option{version}. The default is version 2.9t. The same effect can be obtained with +\begin{lstlisting} + version=first +\end{lstlisting} +or +\begin{lstlisting} + version=2.9 +\end{lstlisting} +or +\begin{lstlisting} + version=2.9t +\end{lstlisting} +If an unknown version is entered for \PName{value}, a warning is +output and for safety's sake \Option{version=}\PValue{first} is +assumed. With +\begin{lstlisting} + version=last +\end{lstlisting} +the current newest version can be selected. In this case future +compatibility is waived. If the option is used without any value, then +\PValue{last} is assumed as well. + +The question of compatibility concerns first and foremost page +breaking. New features which have no effect on page breaking will be +available even when compatibility to an earlier version is chosen by +this option. The option also has no effect on changes in page breaking +which result from the removal of old errors in the new version +class. If page breaking compatibility is required absolutely, to the +point of incorporating previous class errors, then the document should +rather be archived together with the relevant version of \KOMAScript. + +It should be noted that the option \Option{version} can no longer be +changed after loading of the class.% +% +\EndIndex{Option}{version}% +% +\EndIndex{}{compatibility}% \subsection{Page Layout Options} \label{sec:scrlttr2.typeareaOptions} +\BeginIndex{}{page>layout}% -In contrast to the old \Class{scrlettr} class, but in correspondence -with the other \KOMAScript{} classes, the \Class{scrlttr2} class refers -to the \Package{typearea} package for the construction of the page -layout (see \autoref{cha:typearea}). The package will be loaded -by the class automatically, and the class controls the package. The -necessary options will be explained in this section. +In contrast to the old \Class{scrlettr} class, but in agreement with +the other {\KOMAScript} classes, the \Class{scrlttr2} class refers to +the \Package{typearea} package for the construction of the page layout +(see \autoref{cha:typearea}). The package will be loaded by the class +automatically, and the class then controls the package. The necessary +options will be explained in this section. \begin{Declaration} \Option{paper}=\PName{format} \end{Declaration} \BeginIndex{Option}{paper}% +\BeginIndex{}{paper format}% This option defines the paper format. Theoretically, all paper formats -the \Package{typearea} package knows about are supported. But you have -to leave out the suffix \PValue{paper} when entering a value. So, for -letter format you would use the value \PValue{letter}. The formats of -the ISO A, B, C, and D series must be entered with small letters, e.,g. +known by the \Package{typearea} are supported. However, you must leave +out the suffix \PValue{paper} when entering a value. So, for letter +format, you would use the value \PValue{letter}. The formats of the +ISO A, B, C, and D series must be entered in lowercase letters, e.\,g., \PValue{a4} for ISO A4. See also \autoref{sec:typearea.paperTypes}. \begin{Explain} -Although every paper size supported by \Package{typearea} can be used, -several formats may result in unexpected results on the first page of -a letter by now. That is not a matter of the class concept, but there -exist only parameter sets for ISO A4 at this time. Unfortunately, there -are no general rules to define the placement of the address field and -similar for an arbitrary paper size. But it is possible to define -additional parameter sets. See \autoref{sec:lcoFile} for more -information. + Although every paper size supported by \Package{typearea} can be + used, several formats may result in unexpected results on the first + page of a letter. That is not a conceptual problem with the class, + but a reflection that there currently exist only parameter sets for + ISO A4. Unfortunately, there are no general rules to calculate the + placement of the address field and so on for arbitrary paper + sizes. However, it is possible to define additional parameter sets + for different paper sizes. See \autoref{sec:scrlttr2.lcoFile} for more + information. \end{Explain} % \EndIndex{Option}{paper}% +\EndIndex{}{paper format}% \begin{Declaration} \Option{BCOR}=\PName{length}\\ @@ -190,17 +262,19 @@ information. \end{Declaration} \BeginIndex{Option}{BCOR}% \BeginIndex{Option}{DIV}% -\BeginIndex{Option}{headlines}% -The options for the divisor, the binding correction\Index{binding correction}, -and the number of headlines will be translated directly into the corresponding -options of the \Package{typearea} package. If the options are set using -\Macro{KOMAoptions} and not as class options, the \Macro{typearea} command -from the \Package{typearea} package will be used instead. See -\autoref{sec:typearea.options}, \autopageref{desc:typearea.macro.typearea}. +\BeginIndex{Option}{header lines}% +The options for the divisor, the binding correction\Index{binding + correction}, and the number of headlines will be translated directly +into the corresponding options of the \Package{typearea} package and +passed to it. If the options are set using \Macro{KOMAoptions} and +not as class options, the \Macro{typearea} command from the +\Package{typearea} package will be used instead. See +\autoref{sec:typearea.options}, +\autopageref{desc:typearea.macro.typearea}. % \EndIndex{Option}{BCOR}% \EndIndex{Option}{DIV}% -\EndIndex{Option}{headlines}% +\EndIndex{Option}{header lines}% \begin{Declaration} \Option{enlargefirstpage} @@ -208,18 +282,19 @@ from the \Package{typearea} package will be used instead. See \BeginIndex{Option}{enlargefirstpage}% As described later in this chapter, the first page of a letter always uses a different page layout. The \Class{scrlttr2} class provides a -mechanism to calculate height and vertical alignment of head and foot -of the first page independently of the following pages. If, as a -result, the foot of the first page would reach into the text area, -this text area would automatically be made smaller using the +mechanism to calculate height and vertical alignment of header and +footer of the first page independently of the following pages. If, as +a result, the footer of the first page would reach into the text area, +this text area is automatically made smaller using the \Macro{enlargethispage}\IndexCmd{enlargethispage} macro. On the other -hand, if the text area should become larger, supposed the foot on the -first page allows that, you could use this option. At best, some more -text would fit on the first page. See also the description of pseudo -length \PLength{firstfootvpos} at \autoref{sec:scrlttr2.firstFoot}, -\autopageref{desc:scrlttr2.plength.firstfootvpos}. -This option can take the standard values for simple switches, as -listed in \autoref{tab:scrlttr2.simpleSwitchValues}, +hand, if the text area should become larger, supposing that the footer +on the first page allows that, you can also use this option. At best, +a little more text will then fit on the first page. See also the +description of the pseudo-length \PLength{firstfootvpos} in +\autoref{sec:scrlttr2.firstFoot}, +\autopageref{desc:scrlttr2.plength.firstfootvpos}. This option can +take the standard values for simple switches, as listed in +\autoref{tab:scrlttr2.simpleSwitchValues}, \autopageref{tab:scrlttr2.simpleSwitchValues}. Default is \PValue{false}. % @@ -227,6 +302,7 @@ listed in \autoref{tab:scrlttr2.simpleSwitchValues}, \begin{table} \centering + \caption{Standard values for simple switches in \Class{scrlttr2}} \begin{tabular}{ll} Value & Description \\\hline\\[-1.75ex] \PValue{true} & activates the option \\ @@ -234,47 +310,66 @@ listed in \autoref{tab:scrlttr2.simpleSwitchValues}, \PValue{false}& deactivates the option \\ \PValue{off} & deactivates the option \\ \end{tabular} - \caption{Standard values for simple switches in \Class{scrlttr2}} \label{tab:scrlttr2.simpleSwitchValues} \end{table} +\EndIndex{}{page>layout}% + \subsection{Other Layout Options} \label{sec:scrlttr2.layout} -In this subsection, you will find all options that have influence on -the layout in general, except page layout. Strictly speaking, all page -layout options (see~\ref{sec:scrlttr2.typeareaOptions}) are also layout -options, and vice versa for some of them. +In this subsection, you will find all options, except the specific +page layout options, that have an influence on the layout in +general. Strictly speaking, all page layout options +(see~\ref{sec:scrlttr2.typeareaOptions}) are also layout options, and +vice versa for some of them. + +\begin{Declaration} + \Option{mpinclude}\\ + \Option{mpexclude} +\end{Declaration} +\BeginIndex{Option}{mpinclude}% +\BeginIndex{Option}{mpexclude}% +These two options of the \Package{typearea} package should not be used +with the \Class{scrlttr2} class, because the first page in particular +does not take this option into account. To anticipate any complaints, a +warning will be issued when this option is used. If you feel adventurous +you could try how these options, especially \Option{mpinclude}, interact +with other class options. +% +\EndIndex{Option}{mpinclude}% +\EndIndex{Option}{mpexclude}% \begin{Declaration} \Option{twoside} \end{Declaration}% \BeginIndex{Option}{oneside}% From the author's point of view, double-sided letters do not make much -sense. Therefore, the option \Option{twoside} only partially switches to -double-sided layout. You get the possibility to have different margins -on left and right pages, but it is not used. So this option really means -\emph{activate the possibilities of a double-sided document, but stay - with the one-sided layout as far and as long as possible.} -This option can take the standard values for simple switches, as listed -in \autoref{tab:scrlttr2.simpleSwitchValues}, +sense. Therefore, the option \Option{twoside} only partially switches +to double-sided layout. You thus get the possibility to have different +margins on left and right pages, but this possibility is not used. So +this option really means \emph{activate the possibilities of a + double-sided document, but stay with the one-sided layout as far and + as long as possible.} This option can take the standard values for +simple switches, as listed in +\autoref{tab:scrlttr2.simpleSwitchValues}, \autopageref{tab:scrlttr2.simpleSwitchValues}. Default is \PValue{false}. % \EndIndex{Option}{twoside}% By the way, double-sided letters are not supported, because they seem -unreasonable. +entirely unreasonable. \begin{Declaration} \Option{cleardoublepage}=\PName{style} \end{Declaration} \BeginIndex{Option}{cleardoublepage}% If you want pages inserted by the \Macro{cleardoublepage} command to -just contain a page number in head and foot or to be empty, this can be -accomplished with this option. There are three different styles -supported that are listed at \autoref{tab:scrlttr2.cleardoublepage}. Default -is \PValue{standard}. +just contain a page number in the header and footer, or to be empty, +this can be accomplished with this option. There are three different +styles supported that are listed at +\autoref{tab:scrlttr2.cleardoublepage}. Default is \PValue{standard}. \begin{table} \caption[{Possible values of option \Option{cleardoublepage} with @@ -282,7 +377,7 @@ is \PValue{standard}. selection of page style of empty left pages with \Class{scrlttr2}} \label{tab:scrlttr2.cleardoublepage} \begin{desctabular} - \pventry{empty}{switches to page style\Index{page style} + \pventry{empty}{switches to page style\Index{page>style} \PValue{empty}\IndexPagestyle{empty} for inserted pages}% \pventry{plain}{switches to page style \PValue{plain}\IndexPagestyle{plain} for inserted pages} @@ -298,79 +393,67 @@ is \PValue{standard}. \end{Declaration} \BeginIndex{Option}{headsepline}% \BeginIndex{Option}{footsepline}% -These two options insert a separator line below the head or above the -foot, resp., on consecutive pages. In the lingo of this manual, all -pages of a letter except the first one are consecutive pages. -This option can take the standard values for simple switches, as listed -in \autoref{tab:scrlttr2.simpleSwitchValues}, +These two options insert a separator line below the header or above +the footer, respectively, on consecutive pages. In the terminology of +this manual, all pages of a letter except the first one are +consecutive pages. This option can take the standard values for +simple switches, as listed in +\autoref{tab:scrlttr2.simpleSwitchValues}, \autopageref{tab:scrlttr2.simpleSwitchValues}. Default is -\PValue{false}. If one of the options is used without value, like in the -declaration above, this evaluates as \PValue{true}, so the separator -line will be activated. When used as a \Macro{documentclass} option, the -\Package{typearea} package will be called with the option -\Option{headinclude} or \Option{footinclude}, resp.\ -(see~\ref{sec:typearea.options}). +\PValue{false}. If one of the options is used without a value, like in +the declaration above, this evaluates as \PValue{true}, so the +separator line will be activated. When used as a \Macro{documentclass} +option, the option \Option{headinclude} or \Option{footinclude}, +respectively, will be passed on to the \Package{typearea} package (see +\autoref{sec:typearea.options}, +\autopageref{desc:typearea.option.headinclude}). % \EndIndex{Option}{headsepline}% \EndIndex{Option}{footsepline}% \begin{Declaration} - \Option{mpinclude}\\ - \Option{mpexclude} -\end{Declaration} -\BeginIndex{Option}{mpinclude}% -\BeginIndex{Option}{mpexclude}% -These two options of the \Package{typearea} package should not be used -with the \Class{scrlttr2} class, because the first page in particular -does not take this option into account. To anticipate any complaints, a -warning will be issued when this option is used. If you feel adventurous -you could try how these options, especially \Option{mpinclude}, interact -with other class options. -% -\EndIndex{Option}{mpinclude}% \EndIndex{Option}{mpexclude}% - -\begin{Declaration} \Option{pagenumber}=\PName{position} \end{Declaration} \BeginIndex{Option}{pagenumber}% This option defines if and where a page number will be placed on -consecutive pages. All pages without a letter-head are consecutive -pages. This option effects the page layouts\Index{page layout} -\PValue{headings} and \PValue{plain}. It also effects the default page +consecutive pages. All pages without a letterhead are consecutive +pages. This option affects the page styles\Index{page>style} +\PValue{headings} and \PValue{plain}. It also affects the default page styles of the \Package{scrpage2} package, if set before loading the package (see \autoref{cha:scrpage}). It can take values only -influencing horizontal, only vertical, or both positions. Possible value -are shown in \autoref{tab:scrlttr2.pagenumber}. Default is \PValue{botcenter}. +influencing horizontal, only vertical, or both positions. Possible +value are shown in \autoref{tab:scrlttr2.pagenumber}. Default is +\PValue{botcenter}. \begin{table} \caption[{Possible values of option \Option{pagenumber} with \Class{scrlttr2}}]{Possible values of option \Option{pagenumber} for the - position of the page number at page styles \PValue{headings} and + position of the page number in page styles \PValue{headings} and \PValue{plain} with \Class{scrlttr2}} \label{tab:scrlttr2.pagenumber} \begin{desctabular} \entry{\PValue{bot}, \PValue{foot}}{% - page number in foot, horizontal position not changed}% + page number in footer, horizontal position not changed}% \entry{\PValue{botcenter}, \PValue{botcentered}, \PValue{botmittle}, \PValue{footcenter}, \PValue{footcentered}, \PValue{footmiddle}}{% - page number in foot, centered}% + page number in footer, centered}% \entry{\PValue{botleft}, \PValue{footleft}}{% - page number in foot, left justified}% + page number in footer, left justified}% \entry{\PValue{botright}, \PValue{footright}}{% - page number in foot, right justified}% + page number in footer, right justified}% \entry{\PValue{center}, \PValue{centered}, \PValue{middle}}{% page number centered horizontally, vertical position not changed}% \entry{\PValue{false}, \PValue{no}, \PValue{off}}{% no page number}% \entry{\PValue{head}, \PValue{top}}{% - page number in head, horizontal position not changed}% + page number in header, horizontal position not changed}% \entry{\PValue{headcenter}, \PValue{headcentered}, \PValue{headmiddle}, \PValue{topcenter}, \PValue{topcentered}, \PValue{topmiddle}}{% - page number in head, centered}% + page number in header, centered}% \entry{\PValue{headleft}, \PValue{topleft}}{% - page number in head, left justified}% + page number in header, left justified}% \entry{\PValue{headright}, \PValue{topright}}{% - page number in head, right justified}% + page number in header, right justified}% \entry{\PValue{left}}{% page number left, vertical position not changed}% \entry{\PValue{right}}{% @@ -385,31 +468,29 @@ are shown in \autoref{tab:scrlttr2.pagenumber}. Default is \PValue{botcenter}. \end{Declaration}% \BeginIndex{Option}{parskip}% \begin{Explain}% -Especially in letters you often encounter paragraphs marked not with -indentation of the first line, but with a vertical skip between them. It -is a matter of tradition. Apparently it has been easier for a secretary -to operate the carriage return lever twice than setting an indentation -using a tab stop or the space bar. Correct justification is almost -impossible using a typewriter, so letters are traditionally typeset -unjustified. - -However, typographers like Jan Tschichold take the view that letters, -written using means of modern typesetting, should take advantage of -their possibilities like other documents do. Under these circumstances, -letters should also be typeset using paragraph indentation and -justification. The author of \Class{scrlttr2} shares this point of view, -but nevertheless refrains from imposing to many restrictions upon the -user. + Especially in letters you often encounter paragraphs marked not with + indentation of the first line, but with a vertical skip between + them. This is a matter of tradition. Apparently, it was easier for a + secretary to operate the carriage return lever twice than to set an + indentation using a tab stop or the space bar. Correct justification + is almost impossible using a typewriter, so letters are + traditionally typeset unjustified. + + However, typographers like Jan Tschichold take the view that + letters, written using means available to modern typesetting, should + take advantage of their possibilities just like other documents + do. Under these circumstances, letters should also be typeset using + paragraph indentation and justification. \end{Explain} -As as reaction to many serious requests, \Class{scrlttr2} offers the +As a reaction to many serious requests, \Class{scrlttr2} offers the possibility to mark paragraphs not only by indentation of the first -line, but alternatively by vertical skip. You can choose between full or -half a line of vertical space. When using paragraph spacing, it seems -often useful to keep the last line of a paragraph shorter, so that -paragraph recognition will be eased. All these features are controlled -by different values for the \Option{parskip} option shown at -\autoref{tab:scrlttr2.parskip}. Default is \PValue{false}. +line, but alternatively by a vertical skip. You can choose between a +full or half a line of vertical space. When using paragraph spacing, +it is often useful to keep the last line of a paragraph shorter so +that paragraph recognition will be eased. All these features are +controlled by different values for the \Option{parskip} option, shown +in \autoref{tab:scrlttr2.parskip}. Default is \PValue{false}. \begin{table} \caption[{Possible values of option \Option{parskip} with @@ -444,64 +525,66 @@ by different values for the \Option{parskip} option shown at \subsection{Font Options} \label{sec:scrlttr2.fontOptions} -Fonts options are any options with influence on the size of the base -font or of fonts for letter parts. In theory, options affecting the font -type would also count as font options. At present there is only one -option for font size in \Class{scrlttr2}. +Fonts options are any options which influence the size of the base +font or of fonts for particular parts of the letter. In theory, +options affecting the font type would also count as font options. At +present there is only one option for font size in \Class{scrlttr2}. \begin{Declaration} \Option{fontsize}=\PName{size} \end{Declaration} \BeginIndex{Option}{fontsize}% -In the main classes, you choose the font size\Index{font size} for the -document using the \Option{10pt}, \Option{12pt}, etc. options. In the -\Class{scrlttr2} class, the desired \PName{size} is set using the -\Option{fontsize} option. The functionality is the same. This option can -only be used with \Macro{documentclass}, not with \Macro{KOMAoptions}. -Default is \PValue{12pt}. +Whereas in the main classes you choose the font size\Index{font>size} +for the document using the \Option{10pt}, \Option{12pt}, etc., +options, in the \Class{scrlttr2} class the desired \PName{size} is set +using the \Option{fontsize} option. The functionality is however the +same. This option can only be used with \Macro{documentclass}, not +with \Macro{KOMAoptions}. Default is \PValue{12pt}. % \EndIndex{Option}{fontsize}% -\subsection{Options for Letter-Head and Address} +\subsection{Options for Letterhead and Address} \label{sec:scrlttr2.headoptions} +\BeginIndex{}{letter>head}\BeginIndex{}{address}% -The \Class{scrlttr2} class offers lots of extensions for the design of -the letter-head. There are also options for address formatting, -extending the possibilities of the standard letter class, although these -features could already be found in the now obsolete \Class{scrlettr} -class. +The \Class{scrlttr2} class offers numerous extensions for the design +of the letterhead. There are also options for address formatting, +extending the possibilities of the standard letter class, although +these features could already be found in the now obsolete +\Class{scrlettr} class. \begin{Declaration} \Option{fromalign} \end{Declaration} \BeginIndex{Option}{fromalign}% -This option defines the placement of the from address in the letter-head -of the first page. At the same time, this option serves as a switch to -activate or deactivate the extended letter-head options. If these -extensions are deactivated, some other options will have no effect. This -will be noted with the respecting options. Possible values for -\Option{fromalign} are shown at \autoref{tab:scrlttr2.fromalign}. Default is -\PValue{left}. +This option defines the placement of the from address in the +letterhead of the first page. At the same time, this option serves as +a switch to activate or deactivate the extended letterhead options. If +these extensions are deactivated, some other options will have no +effect. This will be noted in the explanations of the respective +options. Possible values for \Option{fromalign} are shown in +\autoref{tab:scrlttr2.fromalign}. Default is \PValue{left}. \begin{table} \caption[{Possible values of option \Option{fromalign} with \Class{scrlttr2}}]{Possible values of option \Option{fromalign} for - setting the position of the from address at the letter head with + setting the position of the from address in the letterhead with \Class{scrlttr2}} \label{tab:scrlttr2.fromalign} \begin{desctabular} \entry{\PValue{center}, \PValue{centered}, \PValue{middle}}{% - return address centered; an optional logo will be on top of the extended - return address; letter-head extensions will be activated}% + return address centered; an optional logo will be above the + extended return address; letterhead extensions will be + activated}% \entry{\PValue{false}, \PValue{no}, \PValue{off}}{% - standard design will be used for the return address; the letter-head - extensions are deactivated}% + standard design will be used for the return address; the + letterhead extensions are deactivated}% \entry{\PValue{left}}{% - left justified return address; an optional logo will be right justified; - letter-head extensions will be activated}% + left-justified return address; an optional logo will be right + justified; letterhead extensions will be activated}% \entry{\PValue{right}}{% - right justified return address; an optional logo will be left justified; - letter-head extensions will be activated}% + right-justified return address; an optional logo will be left + justified; letterhead extensions will be activated}% \end{desctabular} \end{table} % @@ -511,16 +594,18 @@ will be noted with the respecting options. Possible values for \Option{fromrule} \end{Declaration} \BeginIndex{Option}{fromrule}% -This option is part of the letter-head extensions (see option -\Option{fromalign} above). It allows you to place a horizontal line within the -return address. The possible values are shown at -\autoref{tab:scrlttr2.fromrule}. Default is \PValue{false}. You can not -activate more than one line at a time. +This option is part of the letterhead extensions (see option +\Option{fromalign} above). It allows you to place a horizontal line +within the return address. The possible values are shown in +\autoref{tab:scrlttr2.fromrule}. Default is \PValue{false}. You can +not activate more than one line at a time. Regarding the length of the +line, see \autoref{sec:scrlttr2.other}, +\autopageref{desc:scrlttr2.plength.fromrulewidth}. \begin{table} \caption[{Possible values of option \Option{fromrule} with \Class{scrlttr2}}]{Possible values of option \Option{fromrule} for the - position of the rule at the from address with + position of the rule in the from address with \Class{scrlttr2}} \label{tab:scrlttr2.fromrule} \begin{desctabular} @@ -528,7 +613,7 @@ activate more than one line at a time. \PValue{yes}}{% rule below the return address}% \entry{\PValue{aftername}}{% - rule right below the sender's name}% + rule directly below the sender's name}% \entry{\PValue{false}, \PValue{no}, \PValue{off}}{% no rule}% \end{desctabular} @@ -540,11 +625,13 @@ activate more than one line at a time. \Option{fromphone} \end{Declaration} \BeginIndex{Option}{fromphone}% -This option is part of the letter-head extensions (see option -\Option{fromalign} above). It defines whether the phone number will be part of -the return address. This option can take the standard values for simple -switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is \PValue{false}. +This option is part of the letterhead extensions (see option +\Option{fromalign} above). It defines whether the phone number will be +part of the return address. This option can take the standard values +for simple switches, as listed in +\autoref{tab:scrlttr2.simpleSwitchValues}, +\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is +\PValue{false}. % \EndIndex{Option}{fromphone}% @@ -552,11 +639,13 @@ switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, \Option{fromfax} \end{Declaration} \BeginIndex{Option}{fromfax}% -This option is part of the letter-head extensions (see option -\Option{fromalign} above). It defines whether the facsimile number will be -part of the return address. This option can take the standard values for -simple switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is \PValue{false}. +This option is part of the letterhead extensions (see option +\Option{fromalign} above). It defines whether the facsimile number +will be part of the return address. This option can take the standard +values for simple switches, as listed in +\autoref{tab:scrlttr2.simpleSwitchValues}, +\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is +\PValue{false}. % \EndIndex{Option}{fromfax}% @@ -564,7 +653,7 @@ simple switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, \Option{fromemail} \end{Declaration} \BeginIndex{Option}{fromemail}% -This option is part of the letter-head extensions (see option +This option is part of the letterhead extensions (see option \Option{fromalign} above). It defines whether the email address will be part of the return address. This option can take the standard values for simple switches, as listed in @@ -577,7 +666,7 @@ the standard values for simple switches, as listed in \Option{fromurl} \end{Declaration} \BeginIndex{Option}{fromurl}% -This option is part of the letter-head extensions (see option +This option is part of the letterhead extensions (see option \Option{fromalign} above). It defines whether the URL will be part of the return address. This option can take the standard values for simple switches, as listed in @@ -590,12 +679,14 @@ the standard values for simple switches, as listed in \Option{fromlogo} \end{Declaration} \BeginIndex{Option}{fromlogo}% -This option is part of the letter-head extensions (see option -\Option{fromalign} above). It defines whether the -logo will be part of the return address. This option can take -the standard values for simple switches, as listed in +This option is part of the letterhead extensions (see option +\Option{fromalign} above). It defines whether the logo will be part of +the return address. This option can take the standard values for +simple switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is \PValue{false}. +\autopageref{tab:scrlttr2.simpleSwitchValues}. Regarding the placement +of the logo, see also the explanation of the option \Option{fromalign} +above. Default is \PValue{false}. % \EndIndex{Option}{fromlogo}% @@ -603,11 +694,12 @@ the standard values for simple switches, as listed in \Option{addrfield} \end{Declaration} \BeginIndex{Option}{addrfield}% -This option defines whether an address field will be set. Default is to -use the address field. This option can take the standard values for +This option defines whether an address field will be set. Default is +to use the address field. This option can take the standard values for simple switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is \PValue{true}. +\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is +\PValue{true}. % \EndIndex{Option}{addrfield}% @@ -629,12 +721,12 @@ Default is \PValue{true}. \Option{subject} \end{Declaration} \BeginIndex{Option}{subject}% -This option serves two purposes: First, you can choose if your subject should -have a title, given by the \PName{subject} variable (see +This option serves two purposes: first, you can choose if your subject +should have a title, given by the \PName{subject} variable (see \autoref{tab:scrlttr2.subjectTerm}, -\autopageref{tab:scrlttr2.subjectTerm}). Second, you can choose if the subject -should be set before or after the opening. Possible values for this option -are shown at \autoref{tab:scrlttr2.subject}. Defaults are +\autopageref{tab:scrlttr2.subjectTerm}); second, you can choose if the +subject should be set before or after the opening. Possible values for +this option are shown in \autoref{tab:scrlttr2.subject}. Defaults are \PValue{beforeopening} and \PValue{untitled}. \begin{table} @@ -658,16 +750,17 @@ are shown at \autoref{tab:scrlttr2.subject}. Defaults are \end{Declaration} \BeginIndex{Option}{locfield}% \Class{scrlttr2} places a field with additional sender attributes next -to the address field. This can be used for bank accounts or similar. -Depending on the \Option{fromalign} option, it will also be used for the -sender logo. The width of this field may be defined within an \File{lco} -file (see \autoref{sec:lcoFile}). If the width is set to 0 in that -file, then the \Option{locfield} option can toggle between two presets -for the field width. See the explanation on the \Variable{locwidth} -pseudo length in \autoref{sec:scrlttr2.locationField}, -\autopageref{desc:scrlttr2.plength.locwidth}. Possible -values for this option are shown at \autoref{tab:scrlttr2.locfield}. Default -is \PValue{narrow}. +to the address field. This can be used, for example, for bank account +or similar additional information. Depending on the +\Option{fromalign} option, it will also be used for the sender +logo. The width of this field may be defined within an \File{lco} file +(see \autoref{sec:scrlttr2.lcoFile}). If the width is set to 0 in that file, +then the \Option{locfield} option can toggle between two presets for +the field width. See the explanation on the \Variable{locwidth} pseudo +length in \autoref{sec:scrlttr2.locationField}, +\autopageref{desc:scrlttr2.plength.locwidth}. Possible values for this +option are shown in \autoref{tab:scrlttr2.locfield}. Default is +\PValue{narrow}. \begin{table} \caption[{Possible values of option \Option{locfield} with @@ -676,8 +769,8 @@ is \PValue{narrow}. \Class{scrlttr2}} \label{tab:scrlttr2.locfield} \begin{desctabular} - \pventry{narrow}{small sender supplement field}% - \pventry{wide}{large sender supplement field}% + \pventry{narrow}{narrow sender supplement field}% + \pventry{wide}{wide sender supplement field}% \end{desctabular} \end{table} % @@ -687,12 +780,12 @@ is \PValue{narrow}. \Option{foldmarks} \end{Declaration} \BeginIndex{Option}{foldmarks}% -This option activates fold marks for two or three panel folding of the -letter. The exact placement of the fold marks for three panel letter fold -depends on user settings or the \File{lco} file, resp.\ (see -\autoref{sec:lcoFile}). The folding need not result in equal sized -parts. This option can take the standard values for simple switches, as -listed in \autoref{tab:scrlttr2.simpleSwitchValues}, +This option activates fold marks for two- or three-panel folding of +the letter. The exact placement of the fold marks for three-panel +letter folding depends on user settings or the \File{lco} file (see +\autoref{sec:scrlttr2.lcoFile}). The folding need not result in +equal-sized parts. This option can take the standard values for simple +switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, \autopageref{tab:scrlttr2.simpleSwitchValues}. Default is \PValue{true}, which implies setting the fold marks. % @@ -703,18 +796,18 @@ listed in \autoref{tab:scrlttr2.simpleSwitchValues}, \end{Declaration} \BeginIndex{Option}{numericaldate}% This option toggles between the standard, language-dependent date -presentation and a short, numerical one. \KOMAScript{} does not +presentation, and a short, numerical one. {\KOMAScript} does not provide the standard presentation. It should be defined by packages -like \Package{german}\IndexPackage{german}, +such as \Package{german}\IndexPackage{german}, \Package{babel}\IndexPackage{babel}, or \Package{isodate}\IndexPackage{isodate}. The short, numerical -presentation will be produced by \Class{scrlttr2} itself. This option -can take the standard values for simple switches, as listed in -\autoref{tab:scrlttr2.simpleSwitchValues}, +presentation, on the other hand, is produced by \Class{scrlttr2} +itself. This option can take the standard values for simple switches, +as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, \autopageref{tab:scrlttr2.simpleSwitchValues}. Default is \PValue{false}, which results in standard date presentation. In the -now obsolete \Class{scrlettr} class, this was achieved using the -\Option{orgdate} option, but with opposite results. +now obsolete \Class{scrlettr} class, the opposite effect was achieved +using the \Option{orgdate} option. % \EndIndex{Option}{numericaldate}% @@ -722,32 +815,36 @@ now obsolete \Class{scrlettr} class, this was achieved using the \Option{refline} \end{Declaration} \BeginIndex{Option}{refline}% -With the \Class{scrlttr2} class, the head, foot, address, and +With the \Class{scrlttr2} class, the header, footer, address, and sender attributes may extend beyond the normal type area to the left -and to the right. This option defines if that also applies to the -reference line. Normally, the reference line contains at least the date, -but it can hold additional data. Possible values for this option are shown at +and to the right. This option defines whether that should also apply +to the reference fields line. Normally, the reference fields line +contains at least the date, but it can hold additional data. Possible +values for this option are shown in \autoref{tab:scrlttr2.refline}. Default is \PValue{narrow}. \begin{table} \caption[{Possible value of option \Option{refline} with \Class{scrlttr2}}]{Possible value of option \Option{refline} for setting - the width of the reference line with + the width of the reference fields line with \Class{scrlttr2}} \label{tab:scrlttr2.refline} \begin{desctabular} - \pventry{narrow}{reference line restricted to type area}% - \pventry{wide}{reference line corresponds to address and sender - attributes}% + \pventry{narrow}{reference fields line restricted to type area}% + \pventry{wide}{reference fields line corresponds to address and + sender attributes}% \end{desctabular} \end{table} % \EndIndex{Option}{refline}% -\subsection{Format Options} +% +\EndIndex{}{letter>head}\EndIndex{}{address}% + +\subsection{Formatting Options} \label{sec:scrlttr2.formatingOptions} -Format options are those, which influence form or format of the +Formatting options are those which influence form or formatting of the output and do not belong to another section. You might also call them the \emph{miscellaneous options}. @@ -758,57 +855,58 @@ the \emph{miscellaneous options}. This option toggles between the final\Index{final version} and the draft\Index{draft version} version of a document. In particular, enabling the \Option{draft} option activates little black boxes that -will be drawn at the end of overfull lines. For the unpracticed eye, -these boxes ease the identification of paragraphs that need manual -improvement. When the \Option{draft} option is disabled, there will be -no such boxes. This option can take the standard values for simple +will be drawn at the end of overfull lines. These boxes allow the +unpracticed eye to more easily identify paragraphs that need manual +intervention. When the \Option{draft} option is disabled, there will +be no such boxes. This option can take the standard values for simple switches, as listed in \autoref{tab:scrlttr2.simpleSwitchValues}, -\autopageref{tab:scrlttr2.simpleSwitchValues}. -Default is \PValue{false}, as usual. But I strongly recommend enabling -the \Option{draft} option when designing a letter, as for every other +\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is +\PValue{false}, as usual. However, I strongly recommend enabling the +\Option{draft} option when designing a letter, as for every other document. % \EndIndex{Option}{draft}% \subsection{The Letter Class Option Files} -\label{sec:lcoFile} +\label{sec:scrlttr2.lcoFile} -\BeginIndex{}{lco=\File{lco}}% +\BeginIndex{}{lco=\File{lco}}\BeginIndex{}{letter>class option}% Normally, you would not redefine parameters like the distance between the address field and the top edge of the paper every time you write a letter. Instead, you would reuse a whole set of parameters for certain -occasions. It will be much the same for the letter-head and foot used on -the first page. Therefore, it is reasonable to save these settings in a -separate file. For this purpose, the \Class{scrlttr2} class offers the -\File{lco} files. The \File{lco} suffix is an abbreviation for -\emph{\emph{l}etter \emph{c}lass \emph{o}ption}. - -In an \File{lco} file you can use all commands available to the document -at the time the \File{lco} file is loaded. Additionally, it can contain -internal commands available to package writers. For \Class{scrlttr2}, -these are in particular the commands \Macro{@newplength}, \Macro{@setplength}, -\Macro{@addtoplength} and \Macro{addtolengthplength} (see -\autoref{sec:scrlttr2.pseudoLength}). - -There are already some \File{lco} files included in the \KOMAScript{} -distribution. The \File{DIN.lco}, \File{DINmtext.lco}, \File{SNleft.lco}, and -\File{SN.lco} files serve to adjust \KOMAScript{} to different layout -standards. They are well suited as templates for your own parameter sets. The -\File{KOMAold.lco} file, however, serves to improve compatibility with the old -letter class \Class{scrlettr}. Because it contains internal commands not open -to package writers, you should not use them as a template for your own -\File{lco} files. You can find a list of predefined \File{lco} files in -\autoref{tab:lcoFiles}, \autopageref{tab:lcoFiles}. +occasions. It will be much the same for the letterhead and footer used +on the first page. Therefore, it is reasonable to save these settings +in a separate file. For this purpose, the \Class{scrlttr2} class +offers the \File{lco} files. The \File{lco} suffix is an abbreviation +for \emph{\emph{l}etter \emph{c}lass \emph{o}ption}. + +In an \File{lco} file you can use all commands available to the +document at the time the \File{lco} file is loaded. Additionally, it +can contain internal commands available to package writers. For +\Class{scrlttr2}, these are in particular the commands +\Macro{@newplength}, \Macro{@setplength}, and \Macro{@addtoplength} +(see \autoref{sec:scrlttr2.pseudoLength}). + +There are already some \File{lco} files included in the {\KOMAScript} +distribution. The \File{DIN.lco}, \File{DINmtext.lco}, +\File{SNleft.lco}, and \File{SN.lco} files serve to adjust +{\KOMAScript} to different layout standards. They are well suited as +templates for your own parameter sets. The \File{KOMAold.lco} file, on +the other hand, serves to improve compatibility with the old letter +class \Class{scrlettr}. Since it contains internal commands not open +to package writers, you should not use this as a template for your own +\File{lco} files. You can find a list of predefined \File{lco} files +in \autoref{tab:lcoFiles}, \autopageref{tab:lcoFiles}. \begin{Explain} -If you have defined a parameter set for a letter standard not yet -supported by \KOMAScript{}, you are explicitly invited to send this -parameter set to the \KOMAScript{} support address. Please do not forget -to include the permission for distribution under the \KOMAScript{} -license (see the \File{lppl.txt} file). If you know the necessary -metrics for an unsupported letter standard, but are not able to write a -corresponding \File{lco} file yourself, you can also contact the \KOMAScript{} -author. + If you have defined a parameter set for a letter standard not yet + supported by \KOMAScript, you are explicitly invited to send this + parameter set to the {\KOMAScript} support address. Please do not + forget to include the permission for distribution under the + {\KOMAScript} license (see the \File{lppl.txt} file). If you know + the necessary metrics for an unsupported letter standard, but are + not able to write a corresponding \File{lco} file yourself, you can + also contact the {\KOMAScript} author, Markus Kohm, directly. \end{Explain} \begin{Declaration} @@ -820,9 +918,9 @@ Usually, the \File{lco} files will be loaded by the without suffix as an option. The \File{lco} file will be loaded right after the class file. -But it is also possible to load an \File{lco} file later, or even from -within another \File{lco} file. This can be done with the -\Macro{LoadLetterOption} command, which gets the \PName{name} of the +However, it is also possible to load an \File{lco} file later, or even +from within another \File{lco} file. This can be done with the +\Macro{LoadLetterOption} command, which takes the \PName{name} of the \File{lco} file without suffix as a parameter. \begin{Example} You write a document containing several letters. Most of them should @@ -830,35 +928,36 @@ comply with the German DIN standard. So you start with: \begin{lstlisting} \documentclass{scrlttr2} \end{lstlisting} -But one letter should use the \File{DINmtext} variant, with the address -field placed more to the top, which results in more text fitting on the -first page. The folding will be modified so that the address field still -matches the address window in a DIN~C6/5 envelope. +However, one letter should use the \File{DINmtext} variant, with the +address field placed more toward the top, which results in more text +fitting on the first page. The folding will be modified so that the +address field still matches the address window in a DIN~C6/5 envelope. You can achieve this as follows: \begin{lstlisting} \begin{letter}{Markus Kohm\\ - Fichtenstra\ss e 63\\68535 Edingen-Neckarhausen} + Freiherr-von-Drais-Stra\ss e 66\\68535 Edingen-Neckarhausen} \LoadLetterOption{DINmtext} \opening{Hello,} \end{lstlisting} Since construction of the page does not start before the -\Macro{opening}, it is sufficient to load the \File{lco} file before the -\Macro{opening} command. In particular, this need not be done before -\Macro{begin}\PParameter{letter}. So the changes made by loading the -\File{lco} file are local to the corresponding letter. +\Macro{opening} command, it is sufficient to load the \File{lco} file +before this. In particular, the laoding need not be done before +\Macro{begin}\PParameter{letter}. Therefore the changes made by +loading the \File{lco} file are local to the corresponding letter. \end{Example} \begin{Explain} -If an \File{lco} file is loaded via \Macro{documentclass}, it may -nevertheless take the name of an option, provided it is an option that -does not take an argument. However, it would be possible to give the -name \File{fromalign=left.lco} to an \File{lco} file. It will get -loaded every time the \Macro{documentclass} option \Option{fromalign} -is used with the value \PValue{left}. Admittedly, this is quite -academic. Of course you can use this feature only if your operating and -file system support this kind of file names. Otherwise you have to -choose another file name and add the corresponding option, if -needed. + If an \File{lco} file is loaded via \Macro{documentclass}, it may + nevertheless take the name of an option, provided it is an option + that does not take an argument. Nevertheless, it would be possible + to give the name \File{fromalign=left.lco} to an \File{lco} + file. This will then be loaded every time the \Macro{documentclass} + option \Option{fromalign} is used with the value + \PValue{left}. Admittedly, this is only of academic interest. Of + course you can use this feature only if your operating system and + file system support this kind of file name. Otherwise you have to + choose another file name and add the corresponding option, if + needed. \end{Explain} \begin{Example} @@ -867,35 +966,42 @@ needed. \begin{lstlisting} \ProvidesFile{mkohm.lco}[2002/02/25 letter class option] \setkomavar{fromname}{Markus Kohm} - \setkomavar{fromaddress}{Fichtenstra\ss e 63\\ + \setkomavar{fromaddress}{Freiherr-von-Drais-Stra\ss e 66\\ 68535 Edingen-Neckarhausen} \end{lstlisting} - Please note that the German sharp s, ``\ss'', was entered using the - \TeX{} macro \Macro{ss}, because right after \Macro{documentclass} - no packages for input encoding, for example - \Macro{usepackage}\PValue{[latin1]}\PParameter{inputenc} for Unix or - \Macro{usepackage}\PValue{[ansinew]}\PParameter{inputenc} for - Windows, and no language packages, like - \Macro{usepackage}\PParameter{ngerman}\IndexPackage{ngerman} for the - new German orthography, are loaded. +The command \Macro{setkomavar} used above, and the principle of +variables will be explained in detail +in\autoref{sec:scrlttr2.variables}, +\autopageref{desc:scrlttr2.macro.setkomavar}. In the example given +here, knowledge of the exact function of the command is not +critical. It is only important to note what can be done with +\File{lco} files, less so exactly how this might be +accomplished. Please note that the German sharp s, ``\ss'', was +entered using the {\TeX} macro \Macro{ss}, because directly after +\Macro{documentclass} no packages for input encoding, for example +\Macro{usepackage}\PValue{[latin1]}\PParameter{inputenc} for Unix or +\Macro{usepackage}\PValue{[ansinew]}\PParameter{inputenc} for Windows, +and no language packages, like +\Macro{usepackage}\PParameter{ngerman}\IndexPackage{ngerman} for the +new German orthography, are loaded. - But if you would always use the same input encoding, you could also - include it into your \File{lco} file. This would look like this: +However, if you would always use the same input encoding, you could +also include it into your \File{lco} file. This would look as follows: \begin{lstlisting} \ProvidesFile{mkohm.lco}[2002/02/25 letter class option] \RequirePackage[latin1]{inputenc} \setkomavar{fromname}{Markus Kohm} - \setkomavar{fromaddress}{Fichtenstraße 63\\ - 68535 Edingen-Neckarhausen} + \setkomavar{fromaddress}{Freiherr-von-Drais-Stra\ss e 66\\ + 68535 Edingen-Neckarhausen} \end{lstlisting} - There is one problem with this usage: you cannot load this - \File{lco} file later in your document. If you want to have letters - with different senders in one document, you should refrain from - loading packages in your \File{lco} file. +There is one distinct disadvantage with this usage: you can no longer +load this \File{lco} file later in your document. If you want to have +letters with different senders in one document, you should therefore +refrain from loading packages in your \File{lco} file. - Let us further assume that I always typeset letters using the preset - \File{KOMAold}. Then I could add the following line to my - \File{mkohm.lco} file: +Let us further assume that I always typeset letters using the preset +parameters \File{KOMAold}. Then I could add the following line to my +\File{mkohm.lco} file: \begin{lstlisting} \LoadLetterOption{KOMAold} \end{lstlisting} @@ -906,20 +1012,22 @@ needed. \end{lstlisting} \end{Example} -In \autoref{tab:lcoFiles}, \autopageref{tab:lcoFiles} you find a list of all -predefined \File{lco} files. If you use a printer that has large unprintable -areas on the left or right side, you might have problems with the -\Option{SN}\IndexOption{SN} option. The Swiss standard SN~101\,130 defines the -address field to be placed 8\,mm from the right paper edge, so the headline -and the sender attributes will be set with the same small distance to the -paper edge. This also applies to the reference line when using the -\Option{refline}\PValue{=wide} option (see \autoref{sec:scrlttr2.headoptions}, -\autopageref{desc:scrlttr2.option.refline}). If you have this kind of problem, -create your own \File{lco} file that loads \Option{SN} first and then changes -\PLength{toaddrhpos}\IndexPLength{toaddrhpos} (see +In \autoref{tab:lcoFiles}, \autopageref{tab:lcoFiles} you can find a +list of all predefined \File{lco} files. If you use a printer that has +large unprintable areas on the left or right side, you might have +problems with the \Option{SN}\IndexOption{SN} option. Since the Swiss +standard SN~101\,130 defines the address field to be placed 8\,mm from +the right paper edge, the headline and the sender attributes too will +be set with the same small distance from the paper edge. This also +applies to the reference fields line when using the +\Option{refline}\PValue{=wide} option (see +\autoref{sec:scrlttr2.headoptions}, +\autopageref{desc:scrlttr2.option.refline}). If you have this kind of +problem, create your own \File{lco} file that loads \Option{SN} first +and then changes \PLength{toaddrhpos}\IndexPLength{toaddrhpos} (see \autoref{sec:scrlttr2.addressee}, -\autopageref{desc:scrlttr2.plength.toaddrvpos}) to a smaller value. Please -also reduce \PLength{toaddrwidth} accordingly. +\autopageref{desc:scrlttr2.plength.toaddrvpos}) to a smaller +value. Additionally, also reduce \PLength{toaddrwidth} accordingly. % \EndIndex{Cmd}{LoadLetterOption}% @@ -931,18 +1039,18 @@ also reduce \PLength{toaddrwidth} accordingly. \File{lco} file & Description and features \\ \midrule \Option{DIN}\IndexOption[indexmain]{DIN}% - & parameter set for letters on A4 size paper, + & parameter set for letters on A4-size paper, complying with German standard DIN~676; suitable for window envelopes in the sizes C4, C5, C6, and C6/5 (C6 long).\\ \Option{DINmtext}\IndexOption[indexmain]{DINmtext}% - & parameter set for letters on A4 size paper, + & parameter set for letters on A4-size paper, complying with DIN~676, but using an alternate layout with more text on the first page; only suitable for window envelopes in the sizes C6 and C6/5 (C6 long).\\ \Option{KOMAold}\IndexOption[indexmain]{KOMAold}% - & parameter set for letters on A4 size paper using a + & parameter set for letters on A4-size paper using a layout close to the now obsolete \Class{scrlettr} letter class; suitable for window envelopes in the sizes C4, C5, C6, and C6/5 (C6 long); @@ -973,73 +1081,76 @@ also reduce \PLength{toaddrwidth} accordingly. \Parameter{option name}\Parameter{paper size} \end{Declaration} \BeginIndex{Cmd}{LetterOptionNeedsPapersize} -As mentioned in \autoref{sec:scrlttr2.typeareaOptions}, there are -only parameter sets and \File{lco} files for A4 sized paper. But in -every \File{lco} file distributed with \KOMAScript{} you will find a -\Macro{LetterOptionNeedsPapersize} command so that you will be warned -when using another \PName{paper size}. The first argument is the name of -the \File{lco} file without the ``\File{.lco}'' suffix. Second argument -is the paper size the \File{lco} file is designed for. - -If several \File{lco} files are loaded, the +As mentioned in \autoref{sec:scrlttr2.typeareaOptions}, at present +there exist only parameter sets and \File{lco} files for A4-sized +paper. In order that you will at least be warned when using another +\PName{paper size}, you will find a \Macro{LetterOptionNeedsPapersize} +command in every \File{lco} file distributed with {\KOMAScript}. The +first argument is the name of the \File{lco} file without the +``\File{.lco}'' suffix. The second argument is the paper size for +which the \File{lco} file is designed. + +If several \File{lco} files are loaded in succession, a \Macro{LetterOptionNeedsPapersize} command can be contained in each of -them, but the \Macro{opening} -command will only check the last given \PName{paper size}. As shown in -the following example, an experienced user can thus easily write -\File{lco} files with parameter sets for other paper sizes. If you do -not plan to set up \File{lco} files yourself, you may just forget about -this option and skip the example. +them, but the \Macro{opening} command will only check the last given +\PName{paper size}. As shown in the following example, an experienced +user can thus easily write \File{lco} files with parameter sets for +other paper sizes. If you do not plan to set up such \File{lco} files +yourself, you may just forget about this option and skip the example. \begin{Example} -Supposed you use A5 sized paper in normal, i.\,e.\ upright or -portrait, orientation for your letters. We further assume that you want -to put them into standard C6 window envelopes. Then, the position of the -address field would be the same as for a DIN standard letter on A4 sized -paper. The main difference is that A5 paper needs only one fold. So you -want to disable the upper and lower fold marks. The easiest way to -achieve this is to place the marks outside the paper area. + Suppose you use A5-sized paper in normal, i.\,e., upright or + portrait, orientation for your letters. We further assume that you + want to put them into standard C6 window envelopes. In that case, + the position of the address field would be the same as for a DIN + standard letter on A4-sized paper. The main difference is that A5 + paper needs only one fold. So you want to disable the upper and + lower fold marks. The easiest way to achieve this is to place the + marks outside of the paper area. \begin{lstlisting} \ProvidesFile{paper=a5.lco}[2002/05/02 letter class option] \LetterOptionNeedsPapersize{paper=a5}{a5} \@setplength{tfoldmarkvpos}{\paperheight} \@setplength{bfoldmarkvpos}{\paperheight} \end{lstlisting} -Besides, the placement of the foot must be adjusted. It is left to the -reader to find an appropriate value. When using such an \File{lco} file, -you must only take care that other \File{lco} file options, like -\File{SN}, are declared before the paper size, i.\,e.\ before loading -``\File{paper=a5.lco}''. This seems too complicated? Only before you -used it the first time. Anyway, how often do you write letters not using -your standard format? +Besides this, the placement of the foot, that is, the pseudo-length +\PLength{firstfootvpos}, must be adjusted. It is left to the reader to +find an appropriate value. When using such an \File{lco} file, you +must only take care that other \File{lco} file options, like +\File{SN}, are declared before the paper size, i.\,e., before loading +``\File{paper=a5.lco}''. Does this seem too complicated? Only before +you have used it the first time. Anyway, how often do you write +letters not using your standard formats for A4-size or letter-size +paper? \end{Example} % \EndIndex{Cmd}{LetterOptionNeedsPapersize} \end{Explain} -By the way, the \File{DIN} \File{lco} file will always be loaded as the -first \File{lco} file. This ensures that all pseudo lengths will have -more or less reasonable default values. +By the way, the \File{DIN} \File{lco} file will always be loaded as +the first \File{lco} file. This ensures that all pseudo-lengths will +have more or less reasonable default values. Please note that it is not possible to use \Macro{PassOptionsToPackage} to pass options to packages from within an \File{lco} file that have already been loaded by the class. Normally, this only applies to the \Package{typearea}, \Package{scrlfile}, and \Package{keyval} packages. % -\EndIndex{}{lco=\File{lco}}% +\EndIndex{}{lco=\File{lco}}\EndIndex{}{letter>class option}% \section{General Document Properties} \label{sec:scrlttr2.general} -Some document properties aren't assigned to a certain part of the -document such as the letter-head or the letter body. Several of -these properties have already been mentioned in +Some document properties are not assigned to any particular part of +the document such as to the letterhead or the letter body. Several of +these properties have already been mentioned or explained in \autoref{sec:scrlttr2.options}. \subsection{Font Selection} \label{sec:scrlttr2.font} -\BeginIndex{}{font style}\BeginIndex{}{font size}% +\BeginIndex{}{font>style}\BeginIndex{}{font>size}% \begin{Explain} Commands for defining, extending and querying the font of a specific element can be found~\ref{sec:maincls.font}. These commands work exactly @@ -1048,42 +1159,42 @@ this way are listed in \autoref{tab:scrlttr2.elementsWithoutText}. % \begin{table} \centering% - \caption{Alphabetical list of the elements, whose font can be - changed in \Class{scrlttr2} using the commands \Macro{setkomafont} and + \caption{Alphabetical list of elements whose font can be + changed in \Class{scrlttr2} using the commands \Macro{setkomafont} and \Macro{addtokomafont}} \begin{desctabular} \feentry{backaddress}{% return address for a window envelope}% \feentry{descriptionlabel}{% - label, i.e. the optional argument of \Macro{item}, in a + label, i.\,e., the optional argument of \Macro{item}, in a \Environment{description} environment}% \feentry{fromaddress}{% - sender's address in the letter-head}% + sender's address in the letterhead}% \feentry{fromname}{% - sender's address in the letter-head if different from + sender's address in the letterhead if different from \FontElement{fromaddress}}% \feentry{pagefoot}{% in most cases the footer, sometimes the header of a page}% \feentry{pagehead}{% in most cases the header, sometimes the footer of page}% \feentry{pagenumber}{% - page number in the footer or header which is inserted with + page number in the footer or header, inserted with \Macro{pagemark}}% \feentry{subject}{% subject in the opening of the letter}% \feentry{title}{% - headline in the opening of the letter}% + title in the opening of the letter}% \end{desctabular} \label{tab:scrlttr2.elementsWithoutText} \end{table} \end{Explain} % -\EndIndex{}{font style}\EndIndex{}{font size}% +\EndIndex{}{font>style}\EndIndex{}{font>size}% \subsection{Page Style} \label{sec:scrlttr2.pageStyle} One of the general properties of a -document is the page style. Please refer also the +document is the page style. Please refer also to \autoref{sec:maincls.pageStyle} and \autoref{cha:scrpage}. \begin{Declaration} @@ -1105,41 +1216,56 @@ page styles. \item[empty] is the page style, in which the header and footer of subsequent pages (all pages apart from the first) are completely empty. This page style is also used for the first page, because - header and footer of this page are set using the macro - \Macro{opening}. - + header and footer of this page are set by otehr means using the + macro \Macro{opening}\IndexCmd{opening} (see + \autoref{sec:scrlttr2.firstHead}, \autoref{sec:scrlttr2.firstFoot}, + as well as \autoref{sec:scrlttr2.opening}, + \autopageref{desc:scrlttr2.macro.opening}). + \item[plain] is the page style with only page numbers in the header or footer on subsequent pages. The placement of these page numbers is determined by the option \Option{pagenumber} (see - \autoref{sec:scrlttr2.layout}). + \autoref{sec:scrlttr2.layout}, + \autopageref{desc:scrlttr2.option.pagenumber}). -\item[headings] is the page style for automatic page headings of +\item[headings] is the page style for running (automatic) headings on subsequent pages. The inserted marks are the sender's name from the variable \Variable{fromname}\IndexVariable{fromname} and the subject from the variable \Variable{subject}\IndexVariable{subject} (see - \autoref{sec:scrlttr2.firstHead} and - \autoref{sec;scrlttr2.titleSubject}). At which position these - marks and the page numbers are placed depends on the option - \Option{pagenumber} (see \autoref{sec:scrlttr2.layout}). Apart - from that, the author can change these marks after \Macro{opening} - manually. -\item[myheadings] is the page style for manual page headings of + \autoref{sec:scrlttr2.firstHead}, + \autopageref{desc:scrlttr2.variable.fromname} and + \autoref{sec:scrlttr2.titleSubject}, + \autopageref{desc:scrlttr2.variable.subject}). At which position + these marks and the page numbers are placed, depends on the option + \Option{pagenumber} (see \autoref{sec:scrlttr2.layout}, + \autopageref{desc:scrlttr2.option.pagenumber}). The author can also + change these marks manually after the \Macro{opening} command. To + this end, the commands \Macro{markboth} and \Macro{markright} are + available as usual, and with the use of package \Package{scrpage2} + also \Macro{markleft} (see \autoref{sec:scrpage.basics.mark}, + \autopageref{desc:scrpage.macro.automark}) is available. + +\item[myheadings] is the page style for manual page headings on subsequent pages. This is very similar to \PValue{headings}, but - here the marks are set by the author using the commands + here the marks must be set by the author using the commands \Macro{markboth}\IndexCmd{markboth} and - \Macro{markright}\Index{markright}. + \Macro{markright}\Index{markright}. With the use of package + \Package{scrpage2} also \Macro{markleft} can be utilized. \end{description} +In the terminology of this manual, subsequent pages are all pages of a +letter except for the first one. + Page styles are also influenced by the option -\Option{headsepline}\IndexOption{headsepline} or +\Option{headsepline}\IndexOption{headsepline} and \Option{footsepline}\IndexOption{footsepline} (see -\autoref{sec:scrlttr2.layout}). The page style beginning with -the current page is switched with \Macro{pagestyle}. In contrast, -\Macro{thispagestyle} changes only the page style of the current -page. The letter class itself uses +\autoref{sec:scrlttr2.layout}, +\autopageref{desc:scrlttr2.option.headsepline}). The page style +beginning with the current page is switched using +\Macro{pagestyle}. In contrast, \Macro{thispagestyle} changes only the +page style of the current page. The letter class itself uses \Macro{thispagestyle}\PParameter{empty} within -\Macro{opening}\IndexCmd{opening} for the first page of the -letter. +\Macro{opening}\IndexCmd{opening} for the first page of the letter. % \EndIndex{Cmd}{pagestyle}% \EndIndex{Cmd}{thispagestyle}% @@ -1148,21 +1274,20 @@ letter. \EndIndex{Pagestyle}{headings}% \EndIndex{Pagestyle}{myheadings}% -\BeginIndex[indexother]{}{font style}% +\BeginIndex[indexother]{}{font>style}% For changing the font style of headers or footers you should use the -user interface described in \autoref{sec:maincls.font}. For -header and footer the same element is used which you can name either +user interface described in \autoref{sec:maincls.font}. For header +and footer the same element is used, which you can name either \FontElement{pagehead}\IndexFontElement{pagehead} or \FontElement{pagefoot}\IndexFontElement{pagefoot}. The element for the page number within the header or footer is named \FontElement{pagenumber}\IndexFontElement{pagenumber}. Default settings are listed in \autoref{tab:maincls.defaultFontsHeadFoot}, -\autopageref{tab:maincls.defaultFontsHeadFoot}. -Please have also a look at the example in -\autoref{sec:maincls.pageStyle}, +\autopageref{tab:maincls.defaultFontsHeadFoot}. Please have also a +look at the example in \autoref{sec:maincls.pageStyle}, \autopageref{sec:maincls.pageStyle.example}. % -\EndIndex[indexother]{}{font style}% +\EndIndex[indexother]{}{font>style}% \begin{Declaration} \Macro{clearpage}\\ @@ -1194,31 +1319,32 @@ in \autoref{sec:scrlttr2.layout}, \subsection{Variables} \label{sec:scrlttr2.variables} -\BeginIndex{}{Variables}% -Apart from options, commands, environments, counters and lengths -additional elements have already been introduced in \KOMAScript{}. -A typical property of an element is the font style and the option -to change it (see \autoref{sec:maincls.font}). At this point -we now are going to introduce variables. Variables have a name by -which they are called and they have a content. The content of a -variable can be set independently from time and location of the -actual usage. The main difference between a command and a variable -is that a command usually triggers an action whereas a variable -only consist of plain text. Furthermore a variable can have an -additional description, which can be set and issued. - -This section only gives a short introduction to the term variable. -The following examples have no special meaning. More detailed -examples can be found in the explanation of predefined variables -of the letter class in the following sections. An overview of all -variables is given in \autoref{tab:scrlttr2.variables}. +\BeginIndex{}{variables}% +Apart from options, commands, environments, counters and lengths, +additional elements have already been introduced in \KOMAScript. A +typical property of an element is the font style and the option to +change it (see \autoref{sec:maincls.font}). At this point we now +introduce variables. Variables have a name by which they are called, +and they have a content. The content of a variable can be set +independently from time and location of the actual usage in the same +way as the contents of a command can be separated from its usage. The +main difference between a command and a variable is that a command +usually triggers an action, whereas a variable only consists of plain +text which is then output by a command. Furthermore, a variable can +additionally have a description which can be set and output. + +This section specifically only gives an introduction to the concept of +variables. The following examples have no special meaning. More +detailed examples can be found in the explanation of predefined +variables of the letter class in the following sections. An overview +of all variables is given in \autoref{tab:scrlttr2.variables}. \begin{desctable} \caption{Alphabetical list of all supported variables in \Class{scrlttr2}\label{tab:scrlttr2.variables}}\\ \Endfirsthead \caption[]{Alphabetical list of all supported variables in - \Class{scrlttr2} (\emph{pursuit})}\\ + \Class{scrlttr2} (\emph{continued})}\\ \Endhead% \standardfoot% \ventry{backaddress}{return address for window envelopes @@ -1227,7 +1353,7 @@ variables is given in \autoref{tab:scrlttr2.variables}. \ventry{backaddressseparator}{separator within the return address (\autoref{sec:scrlttr2.addressee}, \autopageref{desc:scrlttr2.variable.backaddressseparator})}% - \ventry{ccseparator}{separator between title of additional addressees and + \ventry{ccseparator}{separator between title of additional addressees, and additional addressees (\autoref{sec:scrlttr2.afterClosing}, \autopageref{desc:scrlttr2.variable.ccseparator})}% @@ -1240,13 +1366,13 @@ variables is given in \autoref{tab:scrlttr2.variables}. \ventry{emailseparator}{separator between e-mail name and e-mail address (\autoref{sec:scrlttr2.firstHead}, \autopageref{desc:scrlttr2.variable.emailseparator})}% - \ventry{enclseparator}{separator between title of enclosure and enclosures + \ventry{enclseparator}{separator between title of enclosure, and enclosures (\autoref{sec:scrlttr2.afterClosing}, \autopageref{desc:scrlttr2.variable.enclseparator})}% - \ventry{faxseparator}{separator between title of fax and fax number + \ventry{faxseparator}{separator between title of fax, and fax number (\autoref{sec:scrlttr2.firstHead}, \autopageref{desc:scrlttr2.variable.faxseparator})}% - \ventry{fromaddress}{sender's address without its name + \ventry{fromaddress}{sender's address without sender name (\autoref{sec:scrlttr2.firstHead}, \autopageref{desc:scrlttr2.variable.fromaddress})}% \ventry{frombank}{sender's bank account @@ -1261,13 +1387,13 @@ variables is given in \autoref{tab:scrlttr2.variables}. \ventry{fromlogo}{commands for inserting the sender's logo (\autoref{sec:scrlttr2.firstHead}, \autopageref{desc:scrlttr2.variable.fromlogo})}% - \ventry{fromname}{complete name of the sender + \ventry{fromname}{complete name of sender (\autoref{sec:scrlttr2.firstHead}, \autopageref{desc:scrlttr2.variable.fromname})}% \ventry{fromphone}{sender's telephone number (\autoref{sec:scrlttr2.firstHead}, \autopageref{desc:scrlttr2.variable.fromphone})}% - \ventry{fromurl}{one url of the sender + \ventry{fromurl}{a url of the sender (\autoref{sec:scrlttr2.firstHead}, \autopageref{desc:scrlttr2.variable.fromurl})}% \ventry{invoice}{invoice number @@ -1285,20 +1411,20 @@ variables is given in \autoref{tab:scrlttr2.variables}. \ventry{placeseparator}{separator between place and date (\autoref{sec:scrlttr2.refLine}, \autopageref{desc:scrlttr2.variable.placeseparator})}% - \ventry{phoneseparator}{separator between title of telephone and telephone + \ventry{phoneseparator}{separator between title of telephone, and telephone number (\autoref{sec:scrlttr2.firstHead}, \autopageref{desc:scrlttr2.variable.phoneseparator})}% \ventry{signature}{signature beneath the ending of the letter (\autoref{sec:scrlttr2.closing}, \autopageref{desc:scrlttr2.variable.signature})}% - \ventry{specialmail}{special mail + \ventry{specialmail}{mode of dispatch (\autoref{sec:scrlttr2.addressee}, \autopageref{desc:scrlttr2.variable.specialmail})}% \ventry{subject}{subject (\autoref{sec:scrlttr2.titleSubject}, \autopageref{desc:scrlttr2.variable.subject})}% - \ventry{subjectseparator}{separator between title of subject and subject + \ventry{subjectseparator}{separator between title of subject, and subject (\autoref{sec:scrlttr2.titleSubject}, \autopageref{desc:scrlttr2.variable.subjectseparator})}% \ventry{title}{letter title @@ -1307,7 +1433,7 @@ variables is given in \autoref{tab:scrlttr2.variables}. \ventry{toname}{complete name of addressee (\autoref{sec:scrlttr2.addressee}, \autopageref{desc:scrlttr2.variable.toname})}% - \ventry{toaddress}{address of addressee without its name + \ventry{toaddress}{address of addressee without addressee name (\autoref{sec:scrlttr2.addressee}, \autopageref{desc:scrlttr2.variable.toaddress})}% \ventry{yourmail}{date of addressee's mail @@ -1321,40 +1447,54 @@ variables is given in \autoref{tab:scrlttr2.variables}. \begin{Declaration} \Macro{newkomavar}\OParameter{description}\Parameter{name}\\ \Macro{newkomavar*}\OParameter{description}\Parameter{name}\\ + \Macro{removereffields}\\ + \Macro{defaultreffields}\\ \Macro{addtoreffields}\Parameter{name} \end{Declaration} \BeginIndex{Cmd}{newkomavar}\BeginIndex{Cmd}{newkomavar*}% -\BeginIndex{Cmd}{addtoreffields}% -With \Macro{newkomavar} a new variable is defined. This variable -is addressed via \PName{name}. As an option you can define a -\PName{description} for the variable \PName{name}. Using the -command \Macro{addtoreffields} you can add the variable -\PName{name} to the reference fields (see -\autoref{sec:scrlttr2.refLine}). The \PName{description} and -the content of the variable are added at the end of the reference -fields. The starred version \Macro{newkomavar*} is similar to the -one without star with a subsequent call of the command -\Macro{addtoreffields}. Thus, the starred version automatically -adds the variable to the reference fields. +\BeginIndex{Cmd}{addtoreffields}\BeginIndex{Cmd}{removereffields}% +\BeginIndex{Cmd}{defaultreffields}% +With \Macro{newkomavar} a new variable is defined. This variable is +addressed via \PName{name}. As an option you can define a +\PName{description} for the variable \PName{name}. Using the command +\Macro{addtoreffields} you can add the variable \PName{name} to the +reference fields line (see \autoref{sec:scrlttr2.refLine}). The +\PName{description} and the content of the variable are added at the +end of the reference fields line. The starred version +\Macro{newkomavar*} is similar to the unstarred version, with a +subsequent call of the command \Macro{addtoreffields}. Thus, the +starred version automatically adds the variable to the reference +fields line. \begin{Example} - Suppose you need an additional field for a direct dialling. You - can define this field either with + Suppose you need an additional field for direct dialling. You can + define this field either with \begin{lstlisting} \newkomavar[Direct dialling]{myphone} \addtoreffields{myphone} \end{lstlisting} - or more concise with + or more concisely with \begin{lstlisting} \newkomavar*[direct dialling]{myphone} \end{lstlisting} \end{Example} -When you define a variable for the reference fields you should -always give them a description. +When you define a variable for the reference fields line you should always +give it a description. + +With the command \Macro{removereffields} all variables in the ference +line can be removed. This also includes the predefined variables of +the class. The reference fields line is then empty except for the date +which is always appended to the end. This can be useful, for example, +if you wish to change the order of the variables in the reference +fields line. + +The command \Macro{defaultreffields} acts to reset the reference +fields line to its predefined format. In doing so, all custom-defined +variables are removed from the reference fields line. % +\EndIndex{Cmd}{defaultreffields}% \EndIndex{Cmd}{newkomavar}\EndIndex{Cmd}{newkomavar*}% -\EndIndex{Cmd}{addtoreffields}% - +\EndIndex{Cmd}{addtoreffields}\EndIndex{Cmd}{removereffields}% \begin{Declaration} \Macro{setkomavar}% @@ -1374,13 +1514,13 @@ of the variable. In contrast, \Macro{setkomavar*} can only set the \setkomavar{myphone}{-\,11} \end{lstlisting} In addition, you want to replace the term ``direct dialling'' - with ``Connexion''. Thus you add the description + with ``Connection''. Thus you add the description: \begin{lstlisting} - \setkomavar*{myphone}{Connexion} + \setkomavar*{myphone}{Connection} \end{lstlisting} - or you can put both in one command: + or you can combine both in one command: \begin{lstlisting} - \setkomavar{myphone}[Connexion]{-\,11} + \setkomavar{myphone}[Connection]{-\,11} \end{lstlisting} \end{Example} By the way: You may delete the content of a variable using an empty @@ -1388,7 +1528,7 @@ By the way: You may delete the content of a variable using an empty empty \PName{description} argument. \begin{Example} Suppose you have defined a direct dialling as mentioned above and - you now don't want a description to be set. You write: + you now no longer want a description to be set. You write: \begin{lstlisting} \setkomavar*{myphone}{} \end{lstlisting} @@ -1408,28 +1548,31 @@ empty \PName{description} argument. \Macro{usekomavar*}\OParameter{command}\Parameter{name} \end{Declaration} \BeginIndex{Cmd}{usekomavar}\BeginIndex{Cmd}{usekomavar*}% -In\ChangedAt{v2.9i}{\Class{scrlttr2}} some cases it is necessary that -the user can access the content or the description of a variable. This -is specially important when you have defined a variable which is not -added to the reference fields. Using the command \Macro{usekomavar} you -have access to the content of the variable \PName{name} whereas the -starred version \Macro{usekomavar*} gives you the description. +In\ChangedAt{v2.9i}{\Class{scrlttr2}} some cases it is necessary for +the user to access the content or the description of a variable, and +not to leave this only up to the class. This is specially important +when you have defined a variable which is not added to the reference +fields line. Using the command \Macro{usekomavar} you have access to the +content of the variable \PName{name}, whereas the starred version +\Macro{usekomavar*} allows you to access the description. \begin{Explain} - The commands \Macro{usekomavar} and \Macro{usekomavar*} are, similar - to all commands where a starred version or an optional argument - exists, not fully expandable. Nevertheless if used within - \Macro{markboth}\IndexCmd{markboth}, - \Macro{markright}\IndexCmd{markright} or similar commands you - needn't insert a \Macro{protect}\IndexCmd{protect} before using - them. Of course this is also true in \Package{scrpage2} for - \Macro{markleft}\IndexCmd{markleft}. But they couldn't be used at - commands like \Macro{MakeUppercase}\IndexCmd{MakeUppercase}. + The commands \Macro{usekomavar} and \Macro{usekomavar*} are, + similarly to all commands where a starred version exists or which + can take an optional argument, not fully expandable. Nevertheless, + if used within \Macro{markboth}\IndexCmd{markboth}, + \Macro{markright}\IndexCmd{markright} or similar commands, you need + not insert a \Macro{protect}\IndexCmd{protect} before using them. + Of course this is also true for \Macro{markleft}\IndexCmd{markleft} + if using package \Package{scrpage2}. However, these kinds of + commands can not be used within commands like + \Macro{MakeUppercase}\IndexCmd{MakeUppercase} which directly + influence their argument. \Macro{MakeUppercase}\PParameter{\Macro{usekomavar}\Parameter{name}} would result in \Macro{usekomavar}\Parameter{NAME}. To avoid this - problem you may use commands like \Macro{MakeUppercase} as optional - argument of \Macro{usekomavar} or \Macro{usekomavar*}. So you'll get - the upper case content of a variable using + problem you may use commands like \Macro{MakeUppercase} as an + optional argument to \Macro{usekomavar} or \Macro{usekomavar*}. Then + you will get the uppercase content of a variable using \Macro{usekomavar}\PValue{[\Macro{MakeUppercase}]}\Parameter{name}. \end{Explain} % @@ -1443,66 +1586,78 @@ starred version \Macro{usekomavar*} gives you the description. \end{Declaration} \BeginIndex{Cmd}{ifkomavarempty}% With\ChangedAt{v2.9i}{\Class{scrlttr2}} these commands you may check -whether or not the expanded contents or description of a variable is -empty. The \PName{true} argument will be executed if the contents or +whether or not the expanded content or description of a variable is +empty. The \PName{true} argument will be executed if the content or description is empty. Otherwise the \PName{false} argument will be -executed. The variant with star sign handles the description of a -variable, the variant without star the contents. +executed. The starred variant handles the description of a variable, +the unstarred variant handles the contents. \begin{Explain} - Maybe it is important to know, that the contents or description of - the variable will be expanded using \Macro{edef}. If this results in - spaces or unexpandable macros like \Macro{relax}, it is not - empty. This is even true, if the use of the variable would not - result in any output. + It is important to know that the content or description of the + variable will be expanded as far as this is possible with + \Macro{edef}. If this results in spaces or unexpandable macros like + \Macro{relax}, the result will be not empty even where the use of + the variable would not result in any visible output. - Both variants of the command must not be used at the argument of - \Macro{MakeUppercase}\IndexCmd{MakeUppercase} or commands, which - have similar effects to their arguments. See the description of - \Macro{usekomavar} above for more information about using commands - like \Macro{usekomavar} or \Macro{ifkomavarempty} at the argument of - \Macro{MakeUppercase}. But they are robust enough to be used at the - argument of e.g. \Macro{markboth} or \Macro{footnote}. + Both variants of the command also must not be used as the argument + of \Macro{MakeUppercase}\IndexCmd{MakeUppercase} or other commands + which have similar effects to their arguments (see the description + of \Macro{usekomavar} above for more information about using + commands like \Macro{usekomavar} or \Macro{ifkomavarempty} at the + argument of \Macro{MakeUppercase}). However, they are robust enough + to be used as the argument of, e.\,g., \Macro{markboth} or + \Macro{footnote}. \end{Explain} -\subsection{The Pseudo Lengths} +\subsection{The Pseudo-Lengths} \label{sec:scrlttr2.pseudoLength} +\BeginIndex{}{pseudo-lengths} \begin{Explain} - \TeX{} works with a fixed number of registers. There are registers + {\TeX} works with a fixed number of registers. There are registers for tokens, for boxes, for counters, for skips and for dimensions. - Overall there are 256 for each of them. For \LaTeX{} lengths, which - are addressed with \Macro{newlength} skip registers are used. If all - of these registers are in use you can not define additional lengths. - The letter class \Class{scrlttr2} only for the first page would use - up more than 20 of such registers. \LaTeX{} itself already uses 40 + Overall there are 256 registers for each of these categories. For + {\LaTeX} lengths, which are addressed with \Macro{newlength}, skip + registers are used. Once all these registers are in use, you can not + define any more additional lengths. The letter class + \Class{scrlttr2} would normally use up more than 20 of such + registers for the first page alone. {\LaTeX} itself already uses 40 of these registers. The \Package{typearea} package needs some of - them too. Thus approximately a quarter of the precious registers is - already in use. That's the reason why lengths specific to letters in - \Class{scrlttr2} are defined with macros instead of lengths. The - drawback of this is that computations withs macros is somewhat more - complicated than with real lengths. + them too; thus, approximately a quarter of the precious registers + would already be in use. That is the reason why lengths specific to + letters in \Class{scrlttr2} are defined with macros instead of + lengths. The drawback of this approach is that computations with + macros is somewhat more complicated than with real lengths. + + It can be pointed out that the now recommended {\LaTeX} installation + with {\eTeX} no longer suffers from the above-mentioned + limitation. However, that improvement came too late for + \Class{scrlttr2}. \end{Explain} -A list of all pseudo length at \Class{scrlttr2} is shown at -\autoref{tab:scrlttr2.pseudoLength} from -\autopageref{tab:scrlttr2.pseudoLength}. The meaning is shown at -\autoref{fig:scrlttr2.pseudoLength}. +A list of all pseudo-lengths in \Class{scrlttr2} is shown in +\autoref{tab:scrlttr2.pseudoLength} starting at +\autopageref{tab:scrlttr2.pseudoLength}. The meaning of the various +pseudo-lengths is shown graphically in +\autoref{fig:scrlttr2.pseudoLength}. The dimensions used in the figure +correspond to the default settings of \Class{scrlttr2}. More detailed +description of the individual pseudo-lengths is found in the +individual sections of this chapter. \begin{figure} \centering \includegraphics{plenDIN} - \caption{Schematic of letter paper's pseudo lengths} + \caption{Schematic of the pseudo-lengths for a letter} \label{fig:scrlttr2.pseudoLength} \end{figure} \begin{desctable} - \caption{Pseudo lengths provided by class \Class{scrlttr2}% + \caption{Pseudo-lengths provided by class \Class{scrlttr2}% \label{tab:scrlttr2.pseudoLength}}\\ \Endfirsthead % - \caption[]{Pseudo lengths provided by class \Class{scrlttr2} - (\emph{pursuit})}\\% + \caption[]{Pseudo-lengths provided by class \Class{scrlttr2} + (\emph{continued})}\\% \Endhead% \standardfoot% \pentry{foldmarkhpos}{% @@ -1554,11 +1709,11 @@ A list of all pseudo length at \Class{scrlttr2} is shown at (\autoref{sec:scrlttr2.addressee}, \autopageref{desc:scrlttr2.plength.backaddrheight})}% \pentry{specialmailindent}{% - left indentation of special mail within address field + left indentation of mode of dispatch within address field (\autoref{sec:scrlttr2.addressee}, \autopageref{desc:scrlttr2.plength.specialmailindent})}% \pentry{specialmailrightindent}{% - right indentation of special mail within address field + right indentation of mode of dispatch within address field (\autoref{sec:scrlttr2.addressee}, \autopageref{desc:scrlttr2.plength.specialmailrightindent})}% \pentry{locwidth}{% @@ -1568,20 +1723,20 @@ A list of all pseudo length at \Class{scrlttr2} is shown at (\autoref{sec:scrlttr2.locationField}, \autopageref{desc:scrlttr2.plength.locwidth})}% \pentry{refvpos}{% - vertical distance of business line from top paper edge + vertical distance of reference fields line from top paper edge (\autoref{sec:scrlttr2.refLine}, \autopageref{desc:scrlttr2.plength.refvpos})}% \pentry{refwidth}{% - width of business line + width of reference fields line (\autoref{sec:scrlttr2.refLine}, \autopageref{desc:scrlttr2.plength.refwidth})}% \pentry{refhpos}{% - horizontal distance of business line from left paper edge; for zero - value business line is centered horizontally on letter paper + horizontal distance of reference fields line from left paper edge; for zero + value reference fields line is centered horizontally on letter paper (\autoref{sec:scrlttr2.refLine}, \autopageref{desc:scrlttr2.plength.refhpos})}% \pentry{refaftervskip}{% - vertical skip below business line + vertical skip below reference fields line (\autoref{sec:scrlttr2.refLine}, \autopageref{desc:scrlttr2.plength.refaftervskip})}% \pentry{sigbeforevskip}{% @@ -1603,135 +1758,135 @@ A list of all pseudo length at \Class{scrlttr2} is shown at \autopageref{desc:scrlttr2.plength.firstfootwidth})}% \end{desctable} - \begin{Declaration} \Macro{@newplength}\Parameter{name} \end{Declaration} \BeginIndex{Cmd}{@newplength}% -This command defines an new pseudo length. This new pseudo length -can clearly identified with its \PName{name}. It is made sure that -every \PName{name} can only be given once. +This command defines an new pseudo-length. This new pseudo-length is +uniquely identified by its \PName{name}. If with this command a +redefinition of an already existing pseudo-length is attempted, the +commands exits with an error message. -Since the user in general doesn't define its own pseudo lengths it -is not intended as a user command. Thus, it can not be used within -a document, but for example within a \File{lco} file. +Since the user in general does not define own pseudo-lengths, this +command is not intended as a user command. Thus, it can not be used +within a document, but it can, for example, be used within an +\File{lco} file. % \EndIndex{Cmd}{@newplength}% \begin{Declaration} + \Macro{@setplength}% + \OParameter{factor}\Parameter{pseudo-length}\Parameter{value}\\ + \Macro{@addtoplength}% + \OParameter{factor}\Parameter{pseudo-length}\Parameter{value} +\end{Declaration} +\BeginIndex{Cmd}{@setplength}% +\BeginIndex{Cmd}{@addtoplength}% +Using the command \Macro{@setplength} you can assign the multiple of a +\PName{value} to a \PName{pseudo-length}. The \PName{factor} is given +as an optional argument (see also \Macro{setlengthtoplength}). The +command \Macro{@addtoplength} adds the \PName{value} to a +\PName{pseudo-length}. To assign, or to add the multiple of, one +\PName{pseudo-length} to another pseudo-length, the command +\Macro{useplength} is used within \PName{value}. To subtract the +value of one pseudo-length from another \PName{pseudo-length} a minus +sign, or \PValue{-1}, is used as the \PName{factor}. + +Since the user in general does not define own pseudo-lengths, this +command is not intended as a user command. Thus, it can not be used +within a document, but can, for example, be used within an \File{lco} +file. +% +\EndIndex{Cmd}{@setplength}% +\EndIndex{Cmd}{@addtoplength}% + +\begin{Declaration} \Macro{useplength}\Parameter{name} \end{Declaration} \BeginIndex{Cmd}{useplength}% -Using this command you can access the value of the pseudo length -with the given \PName{name}. This is the only user command in -connection with pseudo lengths. Of course this command can also be -used with a \File{lco} file. +Using this command you can access the value of the pseudo-length with +the given \PName{name}. This is one of the few user commands in +connection with pseudo-lengths. Of course this command can also be +used with an \File{lco} file. % \EndIndex{Cmd}{useplength}% \begin{Declaration} \Macro{setlengthtoplength}% - \OParameter{factor}\Parameter{length}\Parameter{pseudo length}\\ + \OParameter{factor}\Parameter{length}\Parameter{pseudo-length}\\ \Macro{addtolengthplength}% - \OParameter{factor}\Parameter{length}\Parameter{pseudo length} + \OParameter{factor}\Parameter{length}\Parameter{pseudo-length} \end{Declaration} \BeginIndex{Cmd}{setlengthtoplength}% \BeginIndex{Cmd}{addtolengthplength}% \begin{Explain}% -While you can combine a length with a factor this is not possible -with pseudo lengths. Suppose you have a length \Macro{test} with -the value 2\Unit{pt}, then \texttt{3\Macro{test}} gives you the -value 6\Unit{pt}. Using pseudo lengths instead -\texttt{3\Macro{useplength}\PParameter{test}} would give you -32\Unit{pt}. This is especially annoying if you want a real -\PName{length} assign the value of a \PName{pseudo length}. + While you can simply prepend a factor to a length, this is not + possible with pseudo-lengths. Suppose you have a length \Macro{test} + with the value 2\Unit{pt}; then \texttt{3\Macro{test}} gives you the + value 6\Unit{pt}. Using pseudo-lengths instead, + \texttt{3\Macro{useplength}\PParameter{test}} would give you + 32\Unit{pt}. This is especially annoying if you want a real + \PName{length} to take the value of a \PName{pseudo-length}. \end{Explain} -Using the command \Macro{setlengthtoplength} you can assign a -multiple of a \PName{pseudo length} to a real \PName{length}. -Instead of putting the \PName{factor} in front of the -\PName{pseudo length} it is given as an optional argument. You -should also use this command when you want to assign a negative -value of a \PName{pseudo length} to a \PName{length}. In this case -you can either use a minus sign or \PValue{-1} as the -\PName{factor}. The command \Macro{addtolengthplength} works very -similar to that. It adds a multiple of \PName{pseudo length} to -\PName{length}. +Using the command \Macro{setlengthtoplength} you can assign the +multiple of a \PName{pseudo-length} to a real \PName{length}. Here, +instead of prepending the \PName{factor} to the \PName{pseudo-length}, +it is given as an optional argument. You should also use this command +when you want to assign the negative value of a \PName{pseudo-length} +to a \PName{length}. In this case you can either use a minus sign or +\PValue{-1} as the \PName{factor}. The command +\Macro{addtolengthplength} works very similarly; it adds the multiple +of a \PName{pseudo-length} to the \PName{length}. % \EndIndex{Cmd}{setlengthtoplength}% \EndIndex{Cmd}{addtolengthplength}% - -\begin{Declaration} - \Macro{@setplength}% - \OParameter{factor}\Parameter{pseudo length}\Parameter{value}\\ - \Macro{@addtoplength}% - \OParameter{factor}\Parameter{pseudo length}\Parameter{value} -\end{Declaration} -\BeginIndex{Cmd}{@setplength}% -\BeginIndex{Cmd}{@addtoplength}% -Using the command \Macro{@setplength} you assign a multiple of a -\PName{value} to a \PName{pseudo length}. The \PName{factor} is -given as an optional argument. -The command \Macro{@addtoplength} -adds the \PName{value} to a \PName{pseudo length}. For assigning -or adding the multiple of \PName{pseudo length} to another pseudo -length the command \Macro{useplength} is used within \PName{value}. -To subtract the value of a \PName{pseudo length} from another -\PName{pseudo length} a minus sign or \PValue{-1} as -\PName{factor} is used. - -Since the user in general doesn't define its own pseudo lengths it -is not intended as a user command. Thus, it can not be used within -a document, but for example within a \File{lco} file. % -\EndIndex{Cmd}{@setplength}% -\EndIndex{Cmd}{@addtoplength}% - - +\EndIndex{}{pseudo-lengths} \subsection{The General Structure of a Letter Document} \label{sec:scrlttr2.document} -The general structure of a letter document differs somewhat from -the structure of a normal document. Whereas a book document in -general contains only one book, a letter document can contain -several letters. As illustrated in -\autoref{fig:scrlttr2.document} a letter document consists of a -preamble, the individual letters and the closing. +The general structure of a letter document differs somewhat from the +structure of a normal document. Whereas a book document in general +contains only one book, a letter document can contain several +letters. As illustrated in \autoref{fig:scrlttr2.document}, a letter +document consists of a preamble, the individual letters, and the +closing. The preamble comprises all settings that in general concern all -letters. Most of them can be overwritten in the settings of the +letters. Most of them can also be overwritten in the settings of the individual letters. The only setting which can not be changed within a single letter is the font size (see option \Option{fontsize} in \autoref{sec:scrlttr2.fontOptions}, -\autopageref{desc:scrlttr2.option.fontsize})). General settings such as the -loading of packages and the setting of options should be placed before -\Macro{begin}\PParameter{document} only. All settings that comprise -the setting of variables or other text features should be done after -\Macro{begin}\PParameter{document}. This is particularly recommend -when the \Package{babel} package\IndexPackage{babel} (see -\cite{package:babel}) is used or language dependent variables of -\Class{scrlttr2} are to be changed. - -The closing usually consists only of the standard closing for the -end of a document. Of course you can also insert additional -comments at this point. +\autopageref{desc:scrlttr2.option.fontsize}). It is recommended that +only general settings such as the loading of packages and the setting +of options be placed before \Macro{begin}\PParameter{document}. All +settings that comprise the setting of variables or other text features +should be done after \Macro{begin}\PParameter{document}. This is +particularly recommended when the \Package{babel} +package\IndexPackage{babel} (see \cite{package:babel}) is used, or +language-dependent variables of \Class{scrlttr2} are to be changed. + +The closing usually consists only of +\Macro{end}\PParameter{document}. Of course you can also insert +additional comments at this point. \begin{figure} \centering\small\setlength{\fboxsep}{1.5ex} \fbox{\parbox{.667\linewidth}{\raggedright% \Macro{documentclass}\OParameter{\dots}\PParameter{scrlttr2}\\ \dots\\ - {\centering\emph{Settings for all letters}\\} + {\centering\emph{settings for all letters}\\} \dots\\ \Macro{begin}\PParameter{document}\\ \dots\\ - {\centering\emph{Settings for all letters}\\} + {\centering\emph{settings for all letters}\\} \dots\\ }}\\ \fbox{\parbox{.667\linewidth}{\raggedright% \Macro{begin}\PParameter{letter}\Parameter{addressee}\\ \dots\\ - {\centering\emph{Content of the individual letter}\\} + {\centering\emph{content of the individual letter}\\} \dots\\ \Macro{end}\PParameter{letter}\\ }}\\ @@ -1748,7 +1903,7 @@ individual letters (the structure of a single letter is shown in \Macro{begin}\PParameter{letter}% \OParameter{options}\Parameter{addressee}\\ \dots\\ - {\centering\emph{Settings for this letter}\\} + {\centering\emph{settings for this letter}\\} \dots\\ \Macro{opening}\Parameter{opening}\\ }}\\ @@ -1772,61 +1927,63 @@ document (see also \autoref{fig:scrlttr2.document})} \label{fig:scrlttr2.letter} \end{figure} -As shown in \autoref{fig:scrlttr2.letter} every single letter -itself consists of an introduction, the letter body and the -closing. In the introduction all settings for only this letter are +As shown in \autoref{fig:scrlttr2.letter}, every single letter itself +consists of an introduction, the letter body, and the closing. In the +introduction, all settings pertaining only to the current letter are defined. It is important that this introduction always ends with -\Macro{opening}. Similarly the closing starts with -\Macro{closing}. If needed both arguments \PName{opening} and -\PName{closing} can be left empty. Nevertheless both commands have -to be used and must have an argument. +\Macro{opening}. Similarly, the closing always starts with +\Macro{closing}. The two arguments \PName{opening} and \PName{closing} +can be left empty, but both commands must be used and must have an +argument. \begin{Explain} -There are further settings that can be changed between the -individual letters. These settings have an effect on all -subsequent letters. For reasons of maintainability of your letter -documents it is not recommended to use further general settings -with limited validity between the letters. + It should be noted that several settings can be changed between the + individual letters. Such changes then have an effect on all + subsequent letters. For reasons of maintainability of your letter + documents, it is however not recommended to use further general + settings with limited scope between the letters. \end{Explain} -As already mentioned you can use all settings in the preamble of a -letter document in the preamble of the individual letters apart -from the font size. Therefore you will not find more detailed -explanations for the possible settings at this point. Please refer -to \autoref{sec:scrlttr2.startLetter}. +As already mentioned, all general settings used in the preamble of a +letter document, with the exception of font size, can also be in the +preamble of the individual letters. Therefore, you will not find more +detailed explanations for the possible settings in this +section. Please refer to \autoref{sec:scrlttr2.startLetter}. \section{The Letter Declaration} \label{sec:scrlttr2.startLetter} -The letter declaration gives all settings for the letter itself as well -as for the first page of the body. The first page consists of more than just the -prelims of the letter; it consists of several different parts. +The letter declaration gives all settings for the letter itself, as +well as for the first page of the body. The first page consists of +more than just the preliminaries of the letter; in fact, it consists +of several different parts. -\subsection{The Letter-Head} +\subsection{The Letterhead} \label{sec:scrlttr2.firstHead} - -The term letter-head here refers to all of the sender's data and is printed -above the addressee's address. It usually is expected to have all this set via -the page style setting. The earlier version of letter class \Class{scrlettr} -worked that way. But with \Class{scrlttr2}, the letter-head has gotten -independent of the page style setting and is run by the command +\BeginIndex{}{letter>head}% + +The term letterhead here refers to all of the data pertaining to the +sender and which is set above the addressee's address. It is usually +expected that this information is set via the page style settings. In +fact, this was the case in the earlier incarnation of the letter +class, \Class{scrlettr}. But with \Class{scrlttr2}, the letterhead is +made independent of the page style setting, and is set by the command \Macro{opening}. % Fuellmaterial -\iftrue -The position of the letter-head is absolute and independent of the type -area. In fact the first page of a letter, that page that holds the letter-head, -is set by \PValue{empty}. -\fi +\iftrue The position of the letterhead is absolute and independent of +the type area. In fact, the first page of a letter, the page that +holds the letterhead, is set using the page style \PValue{empty}. \fi % Ende des Fuellmaterials \begin{Declaration} \PLength{firstheadvpos} \end{Declaration} \BeginIndex{PLength}{firstheadvpos}% -The pseudo length \PLength{firstheadvpos} gives the distance between the top of -the sheet and the letter-head. This value is set differently in the predefined -\File{lco}-files. A typical value is 8\Unit{mm}. +The pseudo-length \PLength{firstheadvpos} gives the distance between +the top edge of the paper and start of the letterhead. This value is +set differently in the various predefined \File{lco} files. A typical +value is 8\Unit{mm}. % \EndIndex{PLength}{firstheadvpos} @@ -1834,11 +1991,11 @@ the sheet and the letter-head. This value is set differently in the predefined \PLength{firstheadwidth} \end{Declaration} \BeginIndex{PLength}{firstheadwidth}% -The pseudo length \PLength{firstheadwidth} gives the width of the -letter-head. This value is set differently in the predefined -\File{lco}-files. While this value usually depends on the paper width and the -distance between the left side of the sheet and the address' field, it was -the type area width in \Option{KOMAold}. +The pseudo-length \PLength{firstheadwidth} gives the width of the +letterhead. This value is set differently in the various predefined +\File{lco} files. While this value usually depends on the paper width +and the distance between the left edge of the paper and the adressee +address field, it was the type area width in \Option{KOMAold}. % \EndIndex{PLength}{firstheadwidth}% @@ -1859,21 +2016,22 @@ the type area width in \Option{KOMAold}. \BeginIndex{Variable}{fromurl}% \BeginIndex{Variable}{fromlogo}% % -These variables give all statements concerning the sender necessary to create -the letter-head. Which variable will be used to build the letter-head in the -end can be chosen by use of the letter-head extensions (see option -\Option{fromalign} in \autoref{sec:scrlttr2.headoptions}, -\autopageref{desc:scrlttr2.option.fromalign}) and the options -given there. The variables \Variable{fromname}, and \Variable{fromaddress}, -and \Variable{fromlogo} will be set in the letter-head without their label; -the variables \Variable{fromphone}, \Variable{fromfax}, \Variable{fromemail} -and \Variable{fromurl} will be set with it's label. The labels are taken from -\autoref{tab:scrlttr2.fromTerm}, +These variables give all information concerning the sender necessary +to create the letterhead. Which variables will actually be used to +finally build the letterhead can be chosen by use of the letterhead +extensions (see option \Option{fromalign} in +\autoref{sec:scrlttr2.headoptions}, +\autopageref{desc:scrlttr2.option.fromalign}) and the options given +there. The variables \Variable{fromname}, \Variable{fromaddress} and +\Variable{fromlogo} will be set in the letterhead without their +labels; the variables \Variable{fromphone}, \Variable{fromfax}, +\Variable{fromemail} and \Variable{fromurl} will be set with their +labels. The labels are shown in \autoref{tab:scrlttr2.fromTerm}, \autopageref{tab:scrlttr2.fromTerm}. % \begin{table} \centering - \caption{The sender's predefined labels for the letter head} + \caption{The sender's predefined labels for the letterhead} \begin{desctabular}[1.8em] \ventry{fromemail}{\Macro{usekomavar*}\PParameter{emailseparator}% \Macro{usekomavar}\PParameter{emailseparator}}% @@ -1888,19 +2046,27 @@ and \Variable{fromurl} will be set with it's label. The labels are taken from \label{tab:scrlttr2.fromTerm} \end{table} -An important hint concerns the sender's address. Within the sender's address, -parts such as Street, P.O.~Box, State, Country etc, are separated with a -double backslash. Depending on how the sender's address is used this double -backslash will be interpreted differently and therefore not strictly as a line -break. Paragraphs, vertical distances and the like usually aren't allowed within -the sender's address declaration. One has to have very good knowledge of -\Class{scrlttr2} to use things like those mentioned above, intelligently. +An important hint concerns the sender's address: within the sender's +address, parts such as street, P.O.~Box, state, country, etc., are +separated with a double backslash. Depending on how the sender's +address is used, this double backslash will be interpreted differently +and therefore is not strictly always a line break. Paragraphs, +vertical spacing and the like are usually not allowed within the +sender's address declaration. One has to have very good knowledge of +\Class{scrlttr2} to use things like those mentioned above, +intelligently. Another point to note is the one should most certainly +set the variables for return address (see +\autoref{sec:scrlttr2.addressee}, +\autopageref{desc:scrlttr2.variable.backaddress}) and signature (see +\autoref{sec:scrlttr2.closing}, +\autopageref{desc:scrlttr2.variable.signature}) oneself. -It's possible, by the way, to load an external picture to use it as a logo. In -this case then put the content of \Variable{fromlogo} to a -\Macro{includegraphics}-command. The corresponding package (see -\cite{package:graphics}) of course has to be given with the letter declaration -(see \autoref{sec:scrlttr2.document}). +It is possible, by the way, to load an external picture to use as a +logo. For this purpose one can put as content of \Variable{fromlogo} +an \Macro{includegraphics} command. Naturally, the corresponding +package, that is, either \Package{graphics} or \Package{graphicx} (see +\cite{package:graphics}), has to be loaded in the preamble of the +letter document (see \autoref{sec:scrlttr2.document}). % \EndIndex{Variable}{fromname}% \EndIndex{Variable}{fromaddress}% @@ -1914,17 +2080,18 @@ this case then put the content of \Variable{fromlogo} to a \PLength{fromrulewidth} \end{Declaration} \BeginIndex{PLength}{fromrulewidth}% -Depending on class options \Option{fromrule} and \Option{fromalign} a -horizontal rule is drawn in the letter-head (see +Depending on the class option \Option{fromrule} (see \autoref{sec:scrlttr2.headoptions}, -\autopageref{desc:scrlttr2.option.fromrule}). If pseudo length -\PLength{fromrulewidth} has a value of 0\Unit{pt}, which is the default, rule -length is calculated automatically taking into account, e.\,g., letter-head -width or an optional logo. Users can adjust rule length manually by setting -this pseudo length to positive values using \Macro{\@setplength} (see +\autopageref{desc:scrlttr2.option.fromrule}), a horizontal rule can be +drawn the predefined letterheads under or within the sender +address. If the pseudo-length \PLength{fromrulewidth} has a value of +0\Unit{pt}, which is the default in the predefined \File{lco} files, +the rule length is calculated automatically taking into account, +e.\,g., letterhead width or an optional logo. Users can adjust rule +length manually in their own \File{lco} files by setting this +pseudo-length to positive values using \Macro{\@setplength} (see \autoref{sec:scrlttr2.pseudoLength}, -\autopageref{desc:scrlttr2.macro.@setplength}) in a \File{lco}-file on his -own. +\autopageref{desc:scrlttr2.macro.@setplength}). % \EndIndex{PLength}{fromrulewidth}% @@ -1938,11 +2105,12 @@ own. \BeginIndex{Variable}{faxseparator}% \BeginIndex{Variable}{emailseparator}% \BeginIndex{Variable}{urlseparator}% -With these variables, hyphens are defined. If applicable they are used with the -sender's data in the letter-head (see \autoref{tab:scrlttr2.fromTerm}). As -a feature, they are labeled and used in the sender's details -of the letter-head. To look up the predefined labels -and their contents, see \autoref{tab:scrlttr2.fromSeparator}. +With these variables, hyphens are defined. If applicable, they are +used in the sender's data in the letterhead (see +\autoref{tab:scrlttr2.fromTerm}). As a feature, they are labeled and +the labels also used in the sender's details of the letterhead. To +look up the predefined labels and their contents, see +\autoref{tab:scrlttr2.fromSeparator}. % % table moved in following paragraph (JUM) >>> % @@ -1956,22 +2124,24 @@ and their contents, see \autoref{tab:scrlttr2.fromSeparator}. \Macro{firsthead}\Parameter{construction} \end{Declaration} \BeginIndex{Cmd}{firsthead}% -Mostly \Class{scrlttr2} and its variables offer enough possibilities to create -a letter-head. In very rare situations one may wish to have more freedom to -create. In those situations one will have to do without predefined -letter-heads, which could have been chosen via options. Instead one is to -create freely. Therefore one has to define the preferred \PName{construction} -with the command \Macro{firsthead}. Within \Macro{firsthead} and with the help -of the \Macro{parbox}-command (see \cite{latex:usrguide}) one can set several -boxes side by side or one underneath the other. An advanced user will thus be -able to create a letter-head on his own. And doing this of course the -\PName{construct} may use variables with the help of \Macro{usekomavar}. +For most cases, \Class{scrlttr2} with its options and variables offers +enough possibilities to create a letterhead. In very rare situations +one may wish to have more freedom in terms of layout. In those +situations one will have to do without predefined letterheads, which +could have been chosen via options. Instead, one needs to create one's +own letterhead from scratch. To do so, one has to define the preferred +\PName{construction} with the command \Macro{firsthead}. Within +\Macro{firsthead}, and with the help of the \Macro{parbox} command +(see \cite{latex:usrguide}), one can set several boxes side by side, +or one underneath the other. An advanced user will thus be able to +create a letterhead on his own. Of course the \PName{construct} may +use variables with the help of \Macro{usekomavar}. % % <<< table of previous paragraph \begin{table} \centering \caption{predefined labels and contents of hyphens for sender's data in the - letter-head} + letterhead} \begin{tabular}{lll} \toprule name & label & content \\ @@ -1986,29 +2156,44 @@ able to create a letter-head on his own. And doing this of course the \end{table} % \EndIndex{Cmd}{firsthead}% - +% +\EndIndex{}{letter>head}% \subsection{The Footer} \label{sec:scrlttr2.firstFoot} -As the first page holds a letter-head of its own it holds a footer of its own -too. And, same as with the letter-head, it will be printed independent of the -page style settings but with the use of \Macro{opening}. +\BeginIndex{}{letter>footer}% + +As the first page holds a letterhead of its own, it also holds a +footer of its own. And, as with the letterhead, it will not be set by +the page style settings, but directly with the use of \Macro{opening}. \begin{Declaration} \PLength{firstfootvpos} \end{Declaration} \BeginIndex{PLength}{firstfootvpos}% % -This pseudo length gives the distance between the footer and the upper -border of the sheet. This value is set different in the predefined -\File{lco}-files. Also it takes care of preventing text jutting into the -footer area. If needed, it can help to shorten the text height on the first page -using \Macro{enlargethispage}. -Likewise and if it is needed the textheight can -be extended with help of the option \Option{enlargefirstpage}. This way, the -distance between text area and the first page's footer can be reduced to -the value \Length{footskip}. See also \autoref{sec:scrlttr2.typeareaOptions}, +This pseudo-length gives the distance between the footer and the upper +edge of the paper. This value is set differently in the various +predefined \File{lco} files. It also takes care of preventing text +from jutting into the footer area. If needed, it can help to shorten +the text height on the first page using \Macro{enlargethispage}. +Likewise, and if it is needed, the text height can conversely be +extended with the help of the option \Option{enlargefirstpage}. This +way, the distance between text area and the first page's footer can be +reduced to the value \Length{footskip}. See also +\autoref{sec:scrlttr2.typeareaOptions}, \autopageref{desc:scrlttr2.option.enlargefirstpage}. + +With the compatibility option set\ChangedAt{2.9t}{\Class{scrlttr2}} up +to version 2.9t (see \Option{version} in +\autoref{sec:scrlttr2.compatibilityOptions}, +\autopageref{desc:scrlttr2.option.version}) the footer is set +independently of the type area in all predefined \File{lco} files (see +\autoref{sec:scrlttr2.lcoFile}) except for \Option{KOMAold}. The +option \Option{enlargefirstpage} also loses its effect. From version +2.9u onwards the footer is set in a position at the bottom edge of the +paper. In this situation, the height of the type area also becomes +dependent on \Option{enlargefirstpage}. % \EndIndex{PLength}{firstfootvpos}% @@ -2017,9 +2202,9 @@ the value \Length{footskip}. See also \autoref{sec:scrlttr2.typeareaOptions}, \PLength{firstfootwidth} \end{Declaration} \BeginIndex{PLength}{firstfootwidth}% -This pseudo length gives the width of the letter's first page footer. The -value is set in dependency of the pseudo length \PLength{firstheadwidth} in the -\File{lco} files. +This pseudo-length gives the width of the letter's first page +footer. The value is set equal to that of the pseudo-length +\PLength{firstheadwidth} in the predefined \File{lco} files. % \EndIndex{PLength}{firstfootwidth}% @@ -2028,74 +2213,86 @@ value is set in dependency of the pseudo length \PLength{firstheadwidth} in the \Macro{firstfoot}\Parameter{construction} \end{Declaration} \BeginIndex{Cmd}{firstfoot}% -The first page's footer is preset to empty. But with the -\Macro{firstfoot} command it is possible to give definitions the same -way as with defining the letter-head with \Macro{firsthead}. +The first page's footer is preset to empty. However, with the +\Macro{firstfoot} command, it is possible to create a +\PName{construction} the same way as when defining the letterhead with +\Macro{firsthead}. \begin{Example} - As the first page's footer, you may want to set the content of the variable - \Variable{bank} (the bank account). The double backslash shall be exchanged - with a comma at the same time: -\begin{lstlisting} - \firstfoot{% - \parbox[b]{\linewidth}{% - \centering\def\\{, }\usekomavar{frombank}% - }% - } -\end{lstlisting} - For the hyphen you might define a variable of your own if you like. Consider - that has been left to the reader as an exercise. + In the first page's footer, you may want to set the content of the + variable \Variable{frombank} (the bank account). The double + backslash should be exchanged with a comma at the same time: + \begin{lstlisting} + \firstfoot{% + \parbox[b]{\linewidth}{% + \centering\def\\{, }\usekomavar{frombank}% + }% + } + \end{lstlisting} + For the hyphen you might define a variable of your own if you like. + This is left as an exercise for the reader. - Nowadays it has become very common to create a proper footer to have - some balance to the letter-head. This can be done like this: -\begin{lstlisting} - \firstfoot{% - \parbox[t]{\textwidth}{\footnotesize - \begin{tabular}[t]{l@{}}% - \multicolumn{1}{@{}l@{}}{partners:}\\ - Jim Smith\\ - Russ Mayer - \end{tabular}% - \hfill - \begin{tabular}[t]{l@{}}% - \multicolumn{1}{@{}l@{}}{Manager:}\\ - Jane Fonda\\[1ex] - \multicolumn{1}{@{}l@{}}{Court Of Jurisdiction:}\\ - Great Plains - \end{tabular}% - \ifkomavarempty{frombank}{}{% + Nowadays it has become very common to create a proper footer in + order to obtain some balance with respect to the letterhead. This + can be done as follows: + \begin{lstlisting} + \firstfoot{% + \parbox[t]{\textwidth}{\footnotesize + \begin{tabular}[t]{l@{}}% + \multicolumn{1}{@{}l@{}}{Partners:}\\ + Jim Smith\\ + Russ Mayer + \end{tabular}% \hfill \begin{tabular}[t]{l@{}}% - \multicolumn{1}{@{}l@{}}{\usekomavar*{frombank}:}\\ - \usekomavar{frombank} + \multicolumn{1}{@{}l@{}}{Manager:}\\ + Jane Fonda\\[1ex] + \multicolumn{1}{@{}l@{}}{Court Of Jurisdiction:}\\ + Great Plains \end{tabular}% + \ifkomavarempty{frombank}{}{% + \hfill + \begin{tabular}[t]{l@{}}% + \multicolumn{1}{@{}l@{}}{\usekomavar*{frombank}:}\\ + \usekomavar{frombank} + \end{tabular}% }% }% } -\end{lstlisting} + \end{lstlisting} This example, by the way, came from Torsten Kr\"uger. With -\begin{lstlisting} - \setkomavar{frombank}{Account No. 12\,345\,678\\ - at Citibank\\ - bank code no: 876\,543\,21} -\end{lstlisting} - the bank account can be set accordingly. If the footer will have a - height like that it might happen that you have to shift its position. You - do this with the pseudo length - \PLength{firstfootvpos}\IndexPLength{firstfootvpos}, which is described - above in this section. + \begin{lstlisting} + \setkomavar{frombank}{Account No. 12\,345\,678\\ + at Citibank\\ + bank code no: 876\,543\,21} + \end{lstlisting} + the bank account can be set accordingly. If the footer will have + such a large height then it might happen that you have to shift its + position. You can do this with the pseudo-length + \PLength{firstfootvpos}\IndexPLength{firstfootvpos}, which is + described above in this section. \end{Example} -% -\EndIndex{Cmd}{firstfoot}% +In the previous example a multi-line footer was set. With a +compatibility setting to version 2.9u (see \Option{version} in +\autoref{sec:scrlttr2.compatibilityOptions}, +\autopageref{desc:scrlttr2.option.version}) the space will in general +not suffice. In that case, you may need to reduce +\PLength{firstfootvpos} (see +\autopageref{desc:scrlttr2.plength.firstfootvpos}) appropriately. +% +\EndIndex{Cmd}{firstfoot}% +% +\EndIndex{}{letter>footer}% \subsection{The Address} \label{sec:scrlttr2.addressee} -The term address here refers to addressee's name and address which are -output in an address field. Additional information can be output within -this address field such as dispatch type or a return address. The latter -being especially useful when using window envelopes. The address is -centered vertically within the remaining part of the address field below -dispatch type information. +\BeginIndex{}{address}% + +The term address here refers to the addressee's name and address which +are output in an address field. Additional information can be output +within this address field, such as dispatch type or a return address; +the latter is especially useful when using window envelopes. The +address directly follows the letterhead. \begin{Declaration} \PLength{toaddrvpos}\\ @@ -2103,25 +2300,63 @@ dispatch type information. \end{Declaration} \BeginIndex{PLength}{toaddrvpos}% \BeginIndex{PLength}{toaddrhpos}% -These pseudo lengths define vertical and horizontal position of the -address field. Values should be set in \File{lco} files according to -standard envelopes window's measures. Care must be taken to avoid -letter-head and address field to overlap. Whether address field is -output or not can be controlled by class option \Option{addrfield} -(see \autoref{sec:scrlttr2.headoptions}). +These pseudo-lengths define vertical and horizontal position of the +address field relative to the top-left corner of the paper. Values are +set differently in the various predefined \File{lco} files, according +to standard envelope window measures. A special feature of +\PLength{toaddrhpos} is that with negative values the offset is that +of the right edge of the address field relative to the right edge of +the paper. This can be found, for instance, in the case of +\Option{SN}. The smallest value of \PLength{toaddrvpos} is found with +\Option{DINmtext}. Care must be taken to avoid overlap of letterhead +and address field. Whether the address field is output or not can be +controlled by class option \Option{addrfield} (see +\autoref{sec:scrlttr2.headoptions}, +\autopageref{desc:scrlttr2.option.addrfield}). % \EndIndex{PLength}{toaddrhpos}% \EndIndex{PLength}{toaddrvpos}% - +\begin{Declaration} + \PLength{toaddrheight} +\end{Declaration} +\BeginIndex{PLength}{toaddrheight}% +The pseudo-length \PLength{toaddrheight} defines the height of the +address field, including the dispatch type. If no dispatch type is +specified, then the address is vertically centered in the field. If a +dispatch type is specified, then the address is set below the dispatch +type, and vertically centered in the remaining field height. +% +\EndIndex{PLength}{toaddrheight}% + \begin{Declaration} \PLength{toaddrwidth} \end{Declaration} \BeginIndex{PLength}{toaddrwidth}% -Pseudo length \PLength{toaddrwidth} defines the width of the address -field. It should be set in an \File{lco} file according to standard -envelopes window's measures. Typical values are 70\Unit{mm} to -100\Unit{mm}. +The pseudo-length \PLength{toaddrwidth} defines the width of the +address field. Values are set differently in the various predefined +\File{lco} files, according to standard envelope window +measures. Typical values are between 70\Unit{mm} and 100\Unit{mm}. +\begin{Example} + Assume that your printer has a very wide left or right margin of + 15\Unit{mm}. In this case, when using the option \Option{SN}, the + letterhead, sender's extensions and the address can not be + completely printed. Thus, you create a new \File{lco} file with the + following content: + \begin{lstlisting} + \ProvidesFile{SNmmarg.lco} + [2002/06/04 v0.1 my own lco] + \LoadLetterOption{SN} + \@addtoplength{toaddrwidth}{% + -\useplength{toaddrhpos}} + \@setplength{toaddrhpos}{-15mm} + \@addtoplength{toaddrwidth}{% + \useplength{toaddrhpos}} + \endinput + \end{lstlisting} + Then, until you can obtain a printer with smaller page margins, you + simply use the option \Option{SNmmarg} instead of \Option{SN}. +\end{Example} % \EndIndex{PLength}{toaddrwidth}% @@ -2130,9 +2365,9 @@ envelopes window's measures. Typical values are 70\Unit{mm} to \PLength{toaddrindent} \end{Declaration} \BeginIndex{PLength}{toaddrindent}% -Additional indentation of addressee within address field can be -controlled by pseudo length \PLength{toaddrindent}. Its value applies -to both left and right margin. Default value is 0\Unit{pt}. +Additional indentation of the address within address field can be +controlled by the pseudo-length \PLength{toaddrindent}. Its value +applies to both left and right margin. Default value is 0\Unit{pt}. % \EndIndex{PLength}{toaddrindent}% @@ -2144,20 +2379,25 @@ to both left and right margin. Default value is 0\Unit{pt}. \end{Declaration} \BeginIndex{Variable}{backaddress}\BeginIndex{Variable}{backaddressseparator}% \BeginIndex{PLength}{backaddrheight}% -When using window envelopes sender's address is often included within -the window. This information, called return address, is placed at the -top of the window above addressee and dispatch type information, -separated by a horizontal rule and set at a smaller font size. Variable -\Variable{backaddress} is usually built automatically from variables -\Variable{fromname} and \Variable{fromaddress}. During output double -backslashes within return address are replaced by content of variable -\Variable{backaddressseparator}, whose default value is a -comma followed by a white space. Return address field's height is -defined by pseudo length \PLength{backaddrheight}, which should be set -in a proper \File{lco} file. DIN and SN values are 5\Unit{mm}. Document -class options \Option{addrfield} and \Option{backaddress} control -whether return address is output or not (see -\autoref{sec:scrlttr2.headoptions}). +When using window envelopes, the sender's return address is often +included within the window, placed at the top above the addressee and +dispatch type information, separated by a horizontal rule and set in a +smaller font size. The contents of the return address, stored in the +variable \Variable{backaddress}, are usually built automatically from +the variables \Variable{fromname} and \Variable{fromaddress}. Within +the return address, double backslashes are replaced by the content of +the variable \Variable{backaddressseparator}, whose default value is a +comma followed by a non-breaking space. + +The height reserved for the return address within the address field is +defined by the pseudo-length \PLength{backaddrheight}. In the +predefined \File{lco} files, this is typically set to +5\Unit{mm}. Whether the return address is output or not is controlled +by document class options \Option{addrfield} (see +\autoref{sec:scrlttr2.headoptions}, +\autopageref{desc:scrlttr2.option.addrfield}) and \Option{backaddress +} (see \autoref{sec:scrlttr2.headoptions}, +\autopageref{desc:scrlttr2.option.backaddress}). % \EndIndex{PLength}{backaddrheight}% \EndIndex{Variable}{backaddress}\EndIndex{Variable}{backaddressseparator}% @@ -2171,14 +2411,15 @@ whether return address is output or not (see \BeginIndex{Variable}{specialmail}% \BeginIndex{PLength}{specialmailindent}% \BeginIndex{PLength}{specialmailrightindent}% -An optional dispatch type can be output within address field above -the addressee by setting variable \Variable{specialmail}. Left and -right alignment are determined by pseudo lengths -\PLength{specialmailindent} and \PLength{specialmailrightindent}. -In the \File{lco} files provided by \KOMAScript{} -\PLength{specialmailindent} is set to rubber length \Macro{fill}, -while \PLength{specialmailrightindent} is set to 1\Unit{em}. Thus -dispatch type is printed 1\Unit{em} off address field's right margin. +An optional dispatch type can be output within the address field +between the return address and the addressee address, by setting the +variable \Variable{specialmail}. Left and right alignment are +determined by pseudo-lengths \PLength{specialmailindent} and +\PLength{specialmailrightindent}, respectively. In the predefined +\File{lco} files provided by \KOMAScript, \PLength{specialmailindent} +is set to rubber length \Macro{fill}, while +\PLength{specialmailrightindent} is set to 1\Unit{em}. Thus the +dispatch type is set 1\Unit{em} from the address field's right margin. % \EndIndex{PLength}{specialmailindent}% \EndIndex{PLength}{specialmailrightindent}% @@ -2191,12 +2432,13 @@ dispatch type is printed 1\Unit{em} off address field's right margin. \end{Declaration} \BeginIndex{Variable}{toname}% \BeginIndex{Variable}{toaddress}% -These two variables contain addressee's name and address as output in -the address field. Usually you won't access these variables manually, -but their values are taken from the argument to the -\Environment{letter}-environment\IndexEnv{letter}. Hints on -address formatting given in \autoref{sec:scrlttr2.firstHead} apply -here as well. +These two variables contain the addressee's name and address as output +in the address field. Usually you will not access these variables +directly, but their values are taken from the argument to the +\Environment{letter} environment\IndexEnv{letter}. Please see the +important hint on address formatting given in +\autoref{sec:scrlttr2.firstHead}, +\autopageref{desc:scrlttr2.variable.fromname}. % \EndIndex{Variable}{toname}% \EndIndex{Variable}{toaddress}% @@ -2206,18 +2448,26 @@ here as well. \Environment{letter}\OParameter{options}\Parameter{addressee} \end{Declaration} \BeginIndex{Env}{letter}% -As in standard letter class \Environment{letter} environment is the -key environment of \Class{scrlttr2}. A special \Class{scrlttr2} feature +The \Environment{letter} environment is only one of the key +environments of the letter class. A special \Class{scrlttr2} feature are optional arguments to the \Environment{letter} environment. These -\PName{options} are executed via \Macro{KOMAoptions} command. -Mandatory \Environment{letter} environment argument is -\PName{addressee}. Addressee's parts have to be separated by double -backslashes. These parts are output on individual lines in the address -field. First part of \PName{addressee} is stored in variable -\Variable{toname}, while the rest is stored in variable -\Variable{toaddress} for further use. Vertical material such as -paragraphs or vertical space is not permitted within \PName{addressee}. The \Environment{letter} environment doesn't actually start +\PName{options} are executed internally via the \Macro{KOMAoptions} +command. + +The \PName{addressee} is a mandatory argument passed to the +\Environment{letter} environment. Parts of the addressee contents are +separated by double backslashes. The first part of \PName{addressee} +is stored in variable \Variable{toname}, while the rest is stored in +variable \Variable{toaddress} for further use. These parts are output +on individual lines in the address field. Nevertheless, the double +backslash should not be interpreted as a certain line break. Vertical +material such as paragraphs or vertical space is not permitted within +\PName{addressee}, and could lead to unexpected results and error +messages, as is the case also for the standard letter class. + +The \Environment{letter} environment does not actually start the letter output. This is done by the \Macro{opening} command. +% \EndIndex{Env}{letter}% @@ -2225,24 +2475,26 @@ letter output. This is done by the \Macro{opening} command. \Macro{AtBeginLetter}\Parameter{commands} \end{Declaration} \BeginIndex{Cmd}{AtBeginLetter}% -\LaTeX{} enables the user to declare \PName{commands} whose execution +{\LaTeX} enables the user to declare \PName{commands} whose execution is delayed until a determined point. Such points are called \emph{hooks}. Known macros for using hooks are \Macro{AtBeginDocument} -and \Macro{AtEndOfClass}. Letter class \Class{scrlttr2} provides an -additional hook that can be used via macro \Macro{AtBeginLetter}. -Originally, hooks were provided for package and class authors, as they -are documented in \cite{latex:clsguide} only. But in letters there are -useful applications of \Macro{AtBeginLetter} as the following example -may illustrate: +and \Macro{AtEndOfClass}. The letter class \Class{scrlttr2} provides +an additional hook that can be used via the macro +\Macro{AtBeginLetter}. Originally, hooks were provided for package +and class authors, so they are documented in \cite{latex:clsguide} +only, and not in \cite{latex:usrguide}. However, with letters there +are useful applications of \Macro{AtBeginLetter} as the following +example may illustrate: % \begin{Example} - Given one has to set multiple letters with questionnaires within one - document. Questions are numbered automatically within single letters - using a counter. Since, in contrast to page numbering, that counter is - not known by \Class{scrlttr2}, it wouldn't be reset at each start of a - new letter. Given each questionnaire contains ten questions, question~1 - would get number~11 in the second letter. Solution is to reset this - counter at the beginning of each new letter: + It is given that one has to set multiple letters with questionnaires + within one document. Questions are numbered automatically within + single letters using a counter. Since, in contrast to page + numbering, that counter is not known by \Class{scrlttr2}, it would + not be reset at the start of each new letter. Given that each + questionnaire contains ten questions, question~1 would get number~11 + in the second letter. A solution is to reset this counter at the + beginning of each new letter: \begin{lstlisting} \newcounter{Question} \newcommand{\Question}[1]{% @@ -2250,40 +2502,43 @@ may illustrate: \@hangfrom{\makebox[2em][r]{\theQuestion:~}}{#1}} \AtBeginLetter{\setcounter{Question}{0}} \end{lstlisting} - This way question~1 remains question~1, even in the 1001st letter. Of course - definitions like those mentioned above need to be stated either between - macros \Macro{makeatletter} and \Macro{makeatother} (see \cite{DANTE:FAQ}) - in letter declarations (see \autoref{sec:scrlttr2.document} and - \autoref{fig:scrlttr2.document}, \autopageref{fig:scrlttr2.document}), - in a unique package, or in an \File{lco}-file - (see \autoref{sec:lcoFile}). +This way question~1 remains question~1, even in the 1001st letter. Of +course definitions like those mentioned above need to be stated either +between macros \Macro{makeatletter} and \Macro{makeatother} (see +\cite{DANTE:FAQ}) in letter declarations (see +\autoref{sec:scrlttr2.document} and \autoref{fig:scrlttr2.document}, +\autopageref{fig:scrlttr2.document}), in a unique package, or in an +\File{lco} file (see \autoref{sec:scrlttr2.lcoFile}). \end{Example} % \EndIndex{Cmd}{AtBeginLetter}% - +% +\EndIndex{}{address}% \subsection{The Sender's Extensions} \label{sec:scrlttr2.locationField} -Often, especially with business letters, the space for letter-head or page foot -seems to be too tight to put all you want to have set. To give more details -about the sender, often the space right beside the addressee's field is -used. In this manual this field is called \emph{sender's extension} +Often, especially with business letters, the space for the letterhead +or page footer seems to be too tight to include all you want. To give +more details about the sender, often the space right beside the +addressee's field is used. In this manual this field is called the +\emph{sender's extension} \begin{Declaration} \PLength{locwidth} \end{Declaration} \BeginIndex{PLength}{locwidth}% -This pseudo length \PLength{locwidth} declares the width of the sender's -extensions. Its value is set typically 0\Unit{pt} in the predefined -\File{lco} files. This value takes on a special position. It does not mean -that the sender's extension has no width. Instead it's actual width is set -with the \Macro{opening} when paper width, address window width, and distance -between left border of the sheet and address window is given. With it the -option \Option{locfield} (see \autoref{sec:scrlttr2.headoptions}, -\autopageref{desc:scrlttr2.option.locfield}) is -taken into account. +This pseudo-length \PLength{locwidth} declares the width of the +sender's extension field. Its value is typically set to 0\Unit{pt} in +the predefined \File{lco} files. This value takes on a special +meaning: it does not mean that the sender's extension has no width; +instead the actual width is set with \Macro{opening} when the paper +width, address window width, and the distance between the left edge of +the paper and the address window are known. The option +\Option{locfield} (see \autoref{sec:scrlttr2.headoptions}, +\autopageref{desc:scrlttr2.option.locfield}) is also taken into +account. % \EndIndex{PLength}{locwidth} @@ -2292,18 +2547,20 @@ taken into account. \Variable{location} \end{Declaration} \BeginIndex{Variable}{location}% -The content of the sender's extension is determined by the variable -\Variable{location}. To set this variable's content it's allowed to use -formatting commands like \Macro{raggedright}. One has to consider that -depending on the use of the options \Option{fromalign} and \Option{fromlogo}, -a part of the space for the sender's extension may be in use already (see +The contents of the sender's extension field is determined by the +variable \Variable{location}. To set this variable's content, it is +permitted to use formatting commands like \Macro{raggedright}. One has +to consider that depending on the use of the options +\Option{fromalign} and \Option{fromlogo}, a part of the space for the +sender's extension may already be reserved for a logo (see \autoref{sec:scrlttr2.headoptions}, \autopageref{desc:scrlttr2.option.fromalign} and \autopageref{desc:scrlttr2.option.fromlogo}). % \begin{Example} - Given you like to put the names of your partners, manager, or court of - jurisdiction with the sender's extension, you can do this like: + Assume that you would like to put the names of your partners, + manager, or court of jurisdiction in the sender's extension + field. You can do this as follows: \begin{lstlisting} \KOMAoptions{locfield=wide} \setkomavar{location}{\raggedright @@ -2316,89 +2573,92 @@ a part of the space for the sender's extension may be in use already (see \quad Washington, DC } \end{lstlisting} - The option \Option{locfield=wide} is set to make the details fit in - horizontally. Sender details like those mentioned in the above example, - can be given together with the common sender address with your own - \File{lco}-file. +The option \Option{locfield=wide} is set to make the details fit +horizontally. Sender details like those mentioned in the above example +can be written, together with the common sender address details, into +your own \File{lco} file. \end{Example} % \EndIndex{Variable}{location}% -\subsection{The Business Line} +\subsection{The Reference Fields Line} \label{sec:scrlttr2.refLine} +\BeginIndex{}{reference fields line}% -Especially with business letters, a line can be found that gives initials, dial -code, customer number, invoice number, or a reference to a previous letter. -In this manual this line is called \emph{business line}. The business line can -consist of more than just one line and is set only if one of those variables -mentioned above is given. Only those fields will be set that are given. To set -a seemingly empty field, one needs to give as value at least a white space or -\Macro{null}. If you want to have your letter without a business line, then -just the variable \Variable{date} will be set instead. +Especially with business letters, a line can be found that gives +initials, dial code, customer number, invoice number, or a reference +to a previous letter. In this manual this line is called the +\emph{reference fields line}. The reference fields line can consist of +more than just one line and is set only if one of those variables +mentioned above is given. Only those fields will be set that are +given. To set a seemingly empty field, one needs to give as value at +least a white space or \Macro{null}. If you want to have your letter +without a reference fields line, then instead of it the label and +contents of the variable \Variable{date} will be set. \begin{Declaration} \PLength{refvpos} \end{Declaration} \BeginIndex{PLength}{refvpos}% -This pseudo length gives the distance between the upper border of the sheet -and the business line. It's value is set differently in the predefined -\File{lco} files. Typical values are between 80{,}5\Unit{mm} and -98{,}5\Unit{mm}. +This pseudo-length gives the distance between the upper edge of the +paper and the reference fields line. Its value is set differently in +the various predefined \File{lco} files. Typical values are between +80.5\Unit{mm} and 98.5\Unit{mm}. % \EndIndex{PLength}{refvpos}% \begin{Declaration} - \PLength{refwidth} + \PLength{refwidth}\\ + \PLength{refhpos} \end{Declaration} \BeginIndex{PLength}{refwidth}% -This pseudo length gives the width that is available for the business line. -The value is set typically to 0\Unit{pt} in the predefined \File{lco}-files. -This value has a special meaning. In no way does it determine that there is -no available width for the business line. Instead this value means that the -width will be calculated with the \Macro{opening}. Thus the calculated width -depends on the determination of the options \Option{refline} (see +This pseudo-length gives the width that is available for the reference +fields line. The value is set typically to 0\Unit{pt} in the +predefined \File{lco} files. This value has a special meaning: in no +way does it determine that there is no available width for the +business line; instead, this value means that the width will be +calculated with the \Macro{opening}. Thus the calculated width depends +on the determination of the options \Option{refline} (see \autoref{sec:scrlttr2.headoptions}, -\autopageref{desc:scrlttr2.option.refline}). +\autopageref{desc:scrlttr2.option.refline}). At the same time, +\PLength{refhpos} will be set according to this option. With +\Option{refline=}\PValue{wide}, the reference fields line is centered, +while with \Option{refline=}\PValue{narrow} it is aligned on the left. + +If \PLength{refwidth} non-null, i.\,e., the width of the reference +fields line is therefore not determined by the option +\Option{refline}, then \PLength{refhpos} gives the distance of the +reference fields line from the left edge of the paper. If this +distance is null, then the reference fields line is set so that the +ratio between its distances from the left and right edges of the paper +equal the ratio of distance of the type area from the left and right +edges of the paper. Thus, for a type area horizontally centered on the +paper, the reference fields line too will be centered. + +As a rule, these special cases are likely to be of little interest to +the normal user. The simplest rule is as follows: either +\PLength{refhpos} is left at null and so the width and alignment of +the reference fields line are left to the option \Option{refline}, or +\PLength{refwidth} as well as \PLength{refhpos} are set by the user. % \EndIndex{PLength}{refwidth}% +\EndIndex{PLength}{refhpos}% \begin{Declaration} \PLength{refaftervskip} \end{Declaration} \BeginIndex{PLength}{refaftervskip}% -This pseudo length gives the vertical space that has to be inserted beneath -the business line. The value is set in the predefined \File{lco} files. It -effects directly the textheight of the first page. A typical value is -something between one and two lines. +This pseudo-length gives the vertical space that has to be inserted +beneath the reference fields line. The value is set in the predefined +\File{lco} files. It directly affects the text height of the first +page. A typical value lies between one and two lines. % \EndIndex{PLength}{refaftervskip}% - -\begin{Declaration} - \Variable{place}\\ - \Variable{placeseparator} -\end{Declaration} -\BeginIndex{Variable}{place}% -\BeginIndex{Variable}{placeseparator}% -As said before in the introduction of this paragraph, the business line can be -left out. This happens if all variables of the business line are empty with -the exception of the variable for the date. In this case, the content of -\Variable{place} and \Variable{placeseparator} will be set, followed by the -content of \Variable{date}. The predefined content of the -\Variable{placeseparator} is a comma followed by a white space. If this -variable \Variable{place} has no value then the hyphen remains unset also. -The predefined subject of \Variable{date} is \Macro{today} and depends on the -setting of the option \Option{numericaldate} (see -\autoref{sec:scrlttr2.headoptions}). -% -\EndIndex{Variable}{place}% -\EndIndex{Variable}{placeseparator}% - - \begin{Declaration} \Variable{yourref}\\ \Variable{yourmail}\\ @@ -2413,16 +2673,17 @@ setting of the option \Option{numericaldate} (see \BeginIndex{Variable}{customer}% \BeginIndex{Variable}{invoice}% \BeginIndex{Variable}{date}% -These variables are typical for business line fields. To find out about their -meaning, see table~\ref{tab:scrlttr2.variables} on -\autopageref{tab:scrlttr2.variables}. Each variable covers a predefined label -that can be seen at \autoref{tab:scrlttr2.reflineTerm}. The field width that -belongs to each variable, adjusts itself automatically to its label and -content. +These variables are typical reference fields. Their meanings are given +in \autoref{tab:scrlttr2.variables} on +\autopageref{tab:scrlttr2.variables}. Each variable has also a +predefined label, shown in \autoref{tab:scrlttr2.reflineTerm}. The +field width that belongs to each variable, adjusts itself +automatically to its label and content. % \begin{table} \centering - \caption{predefined labels of the business line's typical variables. The + \caption{predefined labels of typical variables of the reference + fields line. The content of the macros depend on language.} \begin{tabular}{lll} \toprule @@ -2445,30 +2706,55 @@ content. \EndIndex{Variable}{customer}% \EndIndex{Variable}{invoice}% \EndIndex{Variable}{date}% +% +\begin{Declaration} + \Variable{place}\\ + \Variable{placeseparator} +\end{Declaration} +\BeginIndex{Variable}{place}% +\BeginIndex{Variable}{placeseparator}% +As said before in the introduction of this subsection, the reference +fields line can be omitted. This happens if all variables of the +business line are empty with the exception of the variable for the +date. In this case, the content of \Variable{place} and +\Variable{placeseparator} will be set, followed by the content of +\Variable{date}. The predefined content of the +\Variable{placeseparator} is a comma followed by a non-breaking +space. If the variable \Variable{place} has no value then the hyphen +remains unset also. The predefined content of \Variable{date} is +\Macro{today} and depends on the setting of the option +\Option{numericaldate} (see \autoref{sec:scrlttr2.headoptions}, +\autopageref{desc:scrlttr2.option.numericaldate}). +% +\EndIndex{Variable}{place}% +\EndIndex{Variable}{placeseparator}% +% +\EndIndex{}{reference fields line}% \subsection{The Title and the Subject Line} -\label{sec;scrlttr2.titleSubject} -Business letters most often carry a subject line. The subject line indicates -in short of what that letter is about. Usually the subject should be short and -precise and not run across several lines. The letter may also carry a title. -Titles find usage with unregular letters like an Invoice or a Reminder. +\label{sec:scrlttr2.titleSubject} +Business letters very often carry a subject line. The subject line +indicates briefly the respect of the letter. Usually the subject +should be short and precise and not run across several lines. Apart +fom the subject, such a letter may also carry a title. Titles find +usage most often with irregular letters such as a warning, an invoice +or a reminder. \begin{Declaration} \Variable{title} \end{Declaration} \BeginIndex{Variable}{title}% -With \Class{scrlttr2} a letter can carry an additional title. The title -becomes centered and set with letter size \Macro{LARGE} right -after and beneath the business line. -The predefined font setup for this element -(\Macro{normalcolor}\Macro{sffamily}\Macro{bfseries}) can be changed with -help of the interface described in \autoref{sec:maincls.font}. Font size -declarations are allowed. +With \Class{scrlttr2} a letter can carry an additional title. The +title is centered and set with font size \Macro{LARGE} directly after +and beneath the reference fields line. The predefined font setup for +this element (\Macro{normalcolor}\Macro{sffamily}\Macro{bfseries}) can +be changed with help of the interface described in +\autoref{sec:maincls.font}. Font size declarations are allowed. \begin{Example} - Given you are to write a reminder. Thus you put the title: + Assume that you are to write a reminder. Thus you put as title: \begin{lstlisting} \setkomavar{title}{Reminder} \end{lstlisting} @@ -2484,18 +2770,19 @@ declarations are allowed. \end{Declaration} \BeginIndex{Variable}{subject}% \BeginIndex{Variable}{subjectseparator}% -In case a subject should be set then you have to determine the variable -\Variable{subject} fit. Depending on what the option \Option{subject} is set -to a label can be put in front of the subject issue; also the vertical -position of the subject issue can be changed (see -\autoref{sec:scrlttr2.headoptions}, -\autopageref{desc:scrlttr2.option.subject}). To see the predetermined labels -look at \autoref{tab:scrlttr2.subjectTerm}. The predefined value of -\Variable{subjectseparator} is a colon followed by a white space. +In case a subject should be set, the contents of the variable +\Variable{subject} need to be defined. Depending on what the option +\Option{subject} is set to, a label can be placed in front of the +subject contents; also, the vertical position of the subject contents +can be changed (see \autoref{sec:scrlttr2.headoptions}, +\autopageref{desc:scrlttr2.option.subject}). The predefined labels are +shown in \autoref{tab:scrlttr2.subjectTerm}. The predefined value of +\Variable{subjectseparator} is a colon followed by a non-breaking +space. % \begin{table} \centering - \caption{Predefined Labels Of The Subject's Variables.} + \caption{Predefined labels of subject-related variables.} \begin{tabular}{lll} \toprule name & label \\ @@ -2510,16 +2797,16 @@ look at \autoref{tab:scrlttr2.subjectTerm}. The predefined value of \label{tab:scrlttr2.subjectTerm} \end{table} -The subject line is set in a separate type face. To change this use -the user interface described in \autoref{sec:maincls.font}. For -the element \FontElement{subject}\IndexFontElement{subject} the -predetermined type face in \Class{scrlttr2} is +The subject line is set in a separate font. To change this use the +user interface described in \autoref{sec:maincls.font}. For the +element \FontElement{subject}\IndexFontElement{subject} the +predetermined font in \Class{scrlttr2} is \Macro{normalfont}\Macro{normalcolor}\Macro{bfseries}. \begin{Example} - Given you are a board member and want to write a letter to another member of - that board about a few internals of the organization. You want to - clarify with your subject line what this letter is all about, but without - labeling it thus. You can do this that way: + Assume you are a board member and want to write a letter to another + member of that board about a few internals of the organization. You + want to clarify with your subject line what this letter is all + about, but without labeling it thus. You can do this as follows: \begin{lstlisting} \setkomavar{subject}[Subject ]{% organization's internals} @@ -2529,22 +2816,23 @@ predetermined type face in \Class{scrlttr2} is \setkomavar{subject}[]{% about organization's internals} \end{lstlisting} - More than just that you may want to have set the subject line not only bold but - also with sans serif types: +Furthermore, if you want to set the subject line not only in bold but +also in sans serif: \begin{lstlisting} \addtokomafont{subject}{\sffamily} \end{lstlisting} - As you can see, it's really easy to solve this problem. +As you can see, it is really easy to solve such problems. \end{Example} % \EndIndex{Variable}{subject}% \EndIndex{Variable}{subjectseparator}% -\subsection{Further Issues} -In this paragraph variables and settings are listed which couldn't be assigned -to any other paragraph of the letter declaration but somehow belong to this -chapter. +\subsection{Further Settings} +\label{sec:scrlttr2.other} +In this paragraph variables and settings are listed which could not be +assigned to any other part of the letter declaration but somehow +belong to this section. \begin{Declaration} \PLength{tfoldmarkvpos}\\ @@ -2552,18 +2840,19 @@ chapter. \end{Declaration} \BeginIndex{PLength}{tfoldmarkvpos}% \BeginIndex{PLength}{bfoldmarkvpos}% -The letterclass \Class{scrlttr2} all in all has 3 fold marks. The one in the -middle serves to halve the paper and is therefore printed always in the middle -of paper height. The position of the upper fold mark, seen from the upper -sheet's border, is determined by the pseudo length \PLength{tfoldmarkvpos}; the -lower one is determined by the pseudo length \PLength{bfoldmarkvpos}. All three -fold marks do not serve to exactly fold to a standard 3 panel letter -fold. Instead the idea is to have the paper folded so that the address -field is seen in the window of a window envelope. The settings therefore are -different in the predefined \File{lco}-files. A special case is +The letterclass \Class{scrlttr2} knows about 3 fold marks. The one in +the middle serves to halve the paper and is therefore printed always +in the middle of the paper height. The position of the upper fold +mark, seen from the upper edge of the paper, is determined by the +pseudo-length \PLength{tfoldmarkvpos}; the lower one is determined by +the pseudo-length \PLength{bfoldmarkvpos}. These two fold marks do not +serve to exactly fold into three equally-sized panels. Instead the +idea is to have the paper folded so that the address field is seen in +the window of a window envelope. The settings therefore are different +in the various predefined \File{lco} files. A special case is \Option{DINmtext}. In this case the envelope format C6/5 (also called -``C6~long'') is necessary. Letters produced in this format aren't compatible -with neither format C~5 nor C~4. +``C6~long'') is necessary. Letters produced in this format are not +compatible with envelopes in either C5 or C4 formats. % \EndIndex{PLength}{tfoldmarkvpos}% \EndIndex{PLength}{bfoldmarkvpos}% @@ -2573,14 +2862,15 @@ with neither format C~5 nor C~4. \PLength{foldmarkhpos} \end{Declaration} \BeginIndex{PLength}{foldmarkhpos}% -This pseudo length gives the distance between all of the three fold marks -and the sheet's left border. Usually it's 3{,}5\Unit{mm}. In case you work -with a printer with a broader unprintable left margin this value can be -changed in your own \File{lco}-file. The length of the upper and lower -fold mark is the same and 4\Unit{mm} long. The thickness of all three is -2\Unit{pt}. At the moment there are no plans to change this value. If the fold -marks will be set at all depends on the option \Option{foldmarks} (see -\autoref{sec:scrlttr2.headoptions}, +This pseudo-length gives the distance between all three fold marks and +the left edge of the paper. Usually this is 3.5\Unit{mm}. In case +you work with a printer with a broader unprintable left margin, this +value can be changed in your own \File{lco} files. The length of the +upper and lower fold marks is identically 2\Unit{mm}, while the center +fold mark is 4\Unit{mm} long. The thickness of all three is +2\Unit{pt}. At the moment there are no plans to change these value. If +the fold marks will be set at all depends on the option +\Option{foldmarks} (see \autoref{sec:scrlttr2.headoptions}, \autopageref{desc:scrlttr2.option.foldmarks}). % \EndIndex{PLength}{foldmarkhpos}% @@ -2590,9 +2880,10 @@ marks will be set at all depends on the option \Option{foldmarks} (see \Variable{frombank} \end{Declaration} \BeginIndex{Variable}{frombank}% -This variable at the moment takes on a special position. Not in use internally -up to this moment it can come into usage if one e.g. wants to have set his -bank account within the sender's extension field or the footer. +This variable at the moment takes on a special meaning: it is not used +internally at this point, and the user can make use of it to set, for +example, his bank account within the sender's extension field or the +footer. % \EndIndex{Variable}{frombank}% @@ -2604,70 +2895,73 @@ bank account within the sender's extension field or the footer. \BeginIndex{Cmd}{nexthead}% \BeginIndex{Cmd}{nextfoot}% The possibilities that are offered with variables and options in -\Class{scrlttr2} should be good enough in most of the cases to create -letter-heads and foots for those pages that follow the first letter page. This -even more since you can additionally change the sender's statements with -\Macro{markboth} and \Macro{markright} that \Class{scrlttr2} uses to create -the letter head. With the term ``follow up pages'' in this manual all pages -are meant excepted the first letter page. The commands -\Macro{markboth}\IndexCmd{markboth} and \Macro{markright}\IndexCmd{markright} -can be used all together with pagestyle\Index{page style} +\Class{scrlttr2} should be good enough in most cases to create +letterheads and footers for those pages that follow the first letter +page. Even more so since you can additionally change with +\Macro{markboth} and \Macro{markright} the sender's statements that +\Class{scrlttr2} uses to create the letterhead. The term ``subsequent +pages'' in this manual refers to all pages following the first letter +page. The commands \Macro{markboth}\IndexCmd{markboth} and +\Macro{markright}\IndexCmd{markright} can in particular be used +together with pagestyle\Index{page>style} \PValue{myheadings}\IndexPagestyle{myheadings}. If the package -\Package{scrpage2}\IndexPackage{scrpage2} is used this, of course, is valid -also for pagestyle \PValue{scrheadings}\IndexPagestyle{scrheadings}. Then too -the command \Macro{markleft}\IndexCmd{markleft} is available. - -At times one wants to have more freedom with creating letter head or foot of -the follow up pages. Then one has to let go of the possibilities of predefined -letter heads or foots, that could have been chosen via option. Instead one is -free to create it just the way one wants to have them set. Therefore one is to -create the desired \PName{construction} with use of the command -\Macro{nexthead} or \Macro{nextfoot} respectively. Within \Macro{nexthead} and -\Macro{nextfoot} for example you can have several boxes side by side or one -beneath the other by use of \Macro{parbox}-command (see -\cite{latex:usrguide}). With this a more advanced user should have no problems -with creating letter heads of foots of his own. With \PName{construction} of -course you can make use of the variables of \Macro{usekomavar} too. +\Package{scrpage2}\IndexPackage{scrpage2} is used then this, of +course, is valid also for pagestyle +\PValue{scrheadings}\IndexPagestyle{scrheadings}. There the command +\Macro{markleft}\IndexCmd{markleft} is furthermore available. + +At times one wants to have more freedom with creating the letterhead +or footer of subsequent pages. Then one has to give up the +possibilities of predefined letterheads or footers that could have +been chosen via the option \Option{pagenumber}\IndexOption{pagenumber} +(see \autoref{sec:scrlttr2.layout}, +\autopageref{desc:scrlttr2.option.pagenumber}). Instead one is free to +create the letterhead and footer of subsequent pages just the way one +wants to have them set. For that, one creates the desired letterhead +or footer \PName{construction} using the command \Macro{nexthead} or +\Macro{nextfoot}, respectively. Within \Macro{nexthead} and +\Macro{nextfoot} you can, for example, have several boxes side by side +or one beneath the other by use of the \Macro{parbox} command (see +\cite{latex:usrguide}). A more advanced user should have no problems +creating letterheads of footers of his own. Within +\PName{construction} you can of course also make use of the variables +by using \Macro{usekomavar}. % \EndIndex{Cmd}{nexthead}% \EndIndex{Cmd}{nextfoot}% - \section{The Text} \label{sec:scrlttr2.text} -In contrast to an article, a report or a book the letter has -no chapter or section structure. -Even float environments with tables and figure are unusual. -Therefore a letter has no table of contents, lists of -figures and tables, index, bibliography, glossary or other things. -The letter texts mainly consist of an opening and the main -text. Thereupon follows the signature, a postscript -and different listings. +In contrast to an article, a report or a book, a letter normally has +no chapter or section structure. Even float environments with tables +and figure are unusual. Therefore, a letter has no table of contents, +lists of figures and tables, index, bibliography, glossary or similar +things. The letter text mainly consists of an opening and the main +text. Thereupon follow the signature, a postscript and various +listings. \subsection{The Opening} \label{sec:scrlttr2.opening} \begin{Explain} -In the early days of computer generated letters the programs didn't -have many capabilities, therefore the letters seldom had -an opening. -Today the capabilities have been enhanced. Thus personal -openings are very common, even in mass-production -advertising letters. + In the early days of computer-generated letters, programs did not + have many capabilities, therefore the letters seldom had an opening. + Today the capabilities have been enhanced. Thus personal openings + are very common, even in mass-production advertising letters. \end{Explain} \begin{Declaration} \Macro{opening}\Parameter{opening} \end{Declaration} \BeginIndex{Cmd}{opening}% -This is the most important command in \Class{scrlttr2}. -For the user it seems that only the opening will be typeset, -but the command also typesets the folding marks, headings, -address field, subject, the page foot and others. -That means: without \Macro{opening} there is no letter. +This is one of the most important commands in \Class{scrlttr2}. For +the user it may seem that only the opening is typeset, but the command +also typesets the folding marks, letterhead, address field, reference +fields line, subject, the page footer and others. In short, without +\Macro{opening} there is no letter. % \EndIndex{Cmd}{opening}% @@ -2675,36 +2969,34 @@ That means: without \Macro{opening} there is no letter. \label{sec:scrlttr2.footnotes} In letters footnotes should be used more sparingly than in normal -documents. However, \Class{scrlttr2} is equipped with all -mechanisms mentioned in \autoref{sec:maincls.footnotes} for -the main document classes. Therefore it will not be discussed -here again. +documents. However, \Class{scrlttr2} is equipped with all mechanisms +mentioned in \autoref{sec:maincls.footnotes} for the main document +classes. Therefore they will not be discussed here again. \subsection{Lists} \label{sec:scrlttr2.lists} -Lists have the same validity in letters as in normal documents. -Thus \Class{scrlttr2} provides the same possibilities -as mentioned in \autoref{sec:maincls.lists} for the -main document classes. +Lists have the same validity in letters as in normal documents. Thus +\Class{scrlttr2} provides the same possibilities as mentioned in +\autoref{sec:maincls.lists} for the main document classes. Therefore +they will not be discussed here again. \subsection{Margin Notes} \label{sec:scrlttr2.marginNotes} -Margin notes are quite uncommon in letters. Therefore the -option \Option{mpinclude} is not supported by \Class{scrlttr2}. -However, \Class{scrlttr2} is equipped with all -mechanisms mentioned in \autoref{sec:maincls.marginNotes} for -the main document classes. Therefore it will not be discussed -here again. +Margin notes are quite uncommon in letters. Therefore the option +\Option{mpinclude} is not actively supported by \Class{scrlttr2}. +However, \Class{scrlttr2} is equipped with all mechanisms mentioned in +\autoref{sec:maincls.marginNotes} for the main document +classes. Therefore they will not be discussed here again. \subsection{Text Emphasis} \label{sec:scrlttr2.emphasis} -The distinction of text has the same importance in letters as in -other documents. Thus the same rules apply that means: emphasize -text sparingly. Even letters should be readable and a letter -where each word is typeset in an other font is indeed unreadable. +The distinction of text has the same importance in letters as in other +documents. Thus the same rules apply, meaning: emphasize text +sparingly. Even letters should be readable and a letter where each +word is typeset in another font is quite unreadable. The class \Class{scrlttr2} is equipped with all mechanisms mentioned in \autoref{sec:maincls.emphasis} for @@ -2714,31 +3006,29 @@ here again. \section{The Closing Part} \label{sec:scrlttr2.backend} -A letter always ends with a closing phrase. -Even computer generated letters without signature -have this phrase. -Sometimes this is a sentence like ``This letter has been -generated automatically.''. -Sometimes a sentence like this will even be used as signature. -Thereupon can follow a postscript and some listings. +A letter always ends with a closing phrase. Even computer-generated +letters without signature have such a phrase. Sometimes this is a +sentence such as, ``This letter has been generated automatically and +is valid without a signature.''. Sometimes a sentence like this will +even be used as a signature. Thereupon can follow a postscript and +various listings. \subsection{Closing} \label{sec:scrlttr2.closing} -The closing consists of three parts. Besides the closing phrase -there are a hand-written inscription and the signature, an explanation -for the inscription. +The closing consists of three parts: besides the closing phrase there +are a hand-written inscription and the signature, which acts as an +explanation for the inscription. \begin{Declaration} \Variable{signature} \end{Declaration} \BeginIndex{Variable}{signature}% -The variable \Variable{signature} includes an explanation -for the inscription. Their content is predefined as -\Macro{usekomavar}\PParameter{fromname}. -The explanation can consist of multiple lines. The lines -should be separated by a double backslash. Paragraphs -in the explanation are not permitted. +The variable \Variable{signature} holds an explanation for the +inscription. The content is predefined as +\Macro{usekomavar}\PParameter{fromname}. The explanation may consist +of multiple lines. The lines should then be separated by a double +backslash. Paragraphs in the explanation are however not permitted. % \EndIndex{Variable}{signature}% @@ -2746,15 +3036,13 @@ in the explanation are not permitted. \Macro{closing}\Parameter{closing phrase} \end{Declaration} \BeginIndex{Cmd}{closing}% -The command \Macro{closing} does not only typeset the -closing phrase, but moreover it typesets the phrase followed -by a vertical space and the content of the variable \Variable{signature}. -The closing phrase can consists of multiple lines, but -paragraphs are not permitted. +The command \Macro{closing} not only typesets the closing phrase, but +also the content of the variable \Variable{signature}. The closing +phrase may consists of multiple lines, but paragraphs are not +permitted. % \EndIndex{Cmd}{closing}% - \begin{Declaration} \PLength{sigindent}\\ \PLength{sigbeforevskip}\\ @@ -2763,43 +3051,41 @@ paragraphs are not permitted. \BeginIndex{PLength}{sigindent}% \BeginIndex{PLength}{sigbeforevskip}% \BeginIndex{Cmd}{raggedsignature}% -Closing phrase, inscription and signature will be typeset -in a box. The width of the box is determined by the length -of the longest line of the closing phrase or signature. - -The box will be typeset with indentation of the length -in pseudo-length \PLength{sigindent}. In the default -\File{lco} file this length is set to 0\Unit{mm}. - -The command \Macro{raggedsignature} defines the alignment -inside the box. In the default \File{lco} file the command -is either defined as \Macro{centering} (all besides \Option{KOMAold}) -or \Macro{raggedright} (\Option{KOMAold}). -In order to get flush-right or flush-left alignment inside the box -the command can be redefined in the same way as -\Macro{raggedsection} (see \autoref{sec:maincls.structure}, +Closing phrase and signature will be typeset in a box. The width of +the box is determined by the length of the longest line of the closing +phrase or signature. + +The box will be typeset with indentation of the length set in +pseudo-length \PLength{sigindent}. In the predefined \File{lco} files +this length is set to 0\Unit{mm}. + +The command \Macro{raggedsignature} defines the alignment inside the +box. In the predefined \File{lco} files the command is either defined +as \Macro{centering} (all besides \Option{KOMAold}) or +\Macro{raggedright} (\Option{KOMAold}). In order to obtain +flush-right or flush-left alignment inside the box, the command can be +redefined in the same way as \Macro{raggedsection} (see +\autoref{sec:maincls.structure}, \autopageref{desc:maincls.macro.raggedsection}). -Between closing phrase and signature a vertical space is -inserted. The height of this space is defined in the pseudo-length -\PLength{sigbeforevskip}. It defaults to 2 lines. -In this space you can write your inscription. +Between closing phrase and signature a vertical space is inserted, the +height of which is defined in the pseudo-length +\PLength{sigbeforevskip}. In the predefined \File{lco} files this is +set to 2 lines. In this space you can then write your inscription. \begin{Example} - You are writing as directorate of a society a letter - to all members. - Moreover you want in one respect elucidate that you are writing - in the name of the board of directors and on the other hand - you want indicate your position in the board of directors. + You are writing as the directorate of a society a letter to all + members. Moreover, you want on the one hand to elucidate that you + are writing in the name of the board of directors, and on the other + hand you want indicate your position on the board of directors. \begin{lstlisting} \setkomavar{signature}{John McEnvy\\ {\small (Vice-President ``The Other Society'')}} \closing{Regards\\ (for the board of directors)} \end{lstlisting} - Certainly you can set the variable \Variable{signature} - in your private \File{lco} file. - Usually you should prefer to define the variable in the - letter preamble. +You can of coure set the variable \Variable{signature} in your private +\File{lco} files. Otherwise it is advisable to define the variable in +the letter preamble (see \autoref{sec:scrlttr2.startLetter}). \end{Example} % \EndIndex{PLength}{sigindent}% @@ -2809,34 +3095,32 @@ In this space you can write your inscription. \subsection{Postscript, Carbon Copy and Enclosures} \label{sec:scrlttr2.afterClosing} -After the closing can follow some other statements. -Besides the postscript there are the distribution list -of carbon copies and the reference to enclosures. +After the closing can follow some other statements. Besides the +postscript, there are the distribution list of carbon copies, and the +reference to enclosures. \begin{Explain}% \begin{Declaration} \Macro{ps} \end{Declaration}% \BeginIndex{Cmd}{ps}% -In the time when letters were written by hand it was quite usual -to use a postscript because this was the only way to add -information which one had forget to mention in the main part of -the letter. Of course, in letters written with \LaTeX{} you can -insert additional lines easily. Nevertheless, it is still popular -to use the postscript. It gives a good possibility to underline -again the most important or sometimes the less important things of -this letter. +In the time when letters were written by hand it was quite common to +use a postscript because this was the only way to add information +which one had forgotten to mention in the main part of the letter. Of +course, in letters written with {\LaTeX} you can insert additional +lines easily. Nevertheless, it is still popular to use the +postscript. It gives one a good possibility to underline again the +most important or sometimes the less important things of the +particular letter. % \end{Explain} -This instruction just switches to the postscript. -Therefore a new paragraph begins and a vertical distance --- usually below the signature -- is inserted. -The command \Macro{ps} is followed by normal text. If you -want the postscript to be introduced with the acronym "PS:" you -have to type the acronym inside the command. By the way, this -acronym is been written without a full stop. The acronym is -neither be typeset automatically nor optionally by the class -\Class{scrlttr2}. +This instruction merely switches to the postscript. Hence, a new +paragraph begins, and a vertical distance\,---\,usually below the +signature\,---\,is inserted. The command \Macro{ps} is followed by +normal text. If you want the postscript to be introduced with the +acronym ``PS:'' , which by the way is written without a full stop, you +have to type this yourself. The acronym is typeset neither +automatically nor optionally by the class \Class{scrlttr2}. % \EndIndex{Cmd}{ps} @@ -2848,25 +3132,24 @@ neither be typeset automatically nor optionally by the class \BeginIndex{Cmd}{cc}% \BeginIndex{Variable}{ccseparator}% With the command \Macro{cc} it is possible to typeset a -\PName{distribution list}. -The command gets the \PName{distribution list} as argument. -If the content of the variable \Variable{ccseparator} -isn't empty then the name and the content of the variable -is inserted prior to \PName{distribution list}. -In this case the \PName{distribution list} will be indented -appropriately. -It is a good idea to set the \PName{distribution list} -\Macro{raggedright} and to separate the lines by a double backslash. +\PName{distribution list}. The command takes the \PName{distribution + list} as its argument. If the content of the variable +\Variable{ccseparator} is not empty, then the name and the content of +this variable is inserted before \PName{distribution list}. In this +case the \PName{distribution list} will be indented appropriately. It +is a good idea to set the \PName{distribution list} +\Macro{raggedright} and to separate the individual entries with a +double backslash. \begin{Example} -You want to indicate that your letter is addressed to all members of a -society and to the board of directors: + You want to indicate that your letter is sent to all members of a + society and to the board of directors: \begin{lstlisting} \cc{% the board of directors\\ - all society members\\ + all society members} \end{lstlisting} - Write this instruction below the \Macro{closing}-instruction - from the previous example or below a possible postscript. +This instruction should be written below the \Macro{closing} +instruction from the previous example, or below a possible postscript. \end{Example} A vertical space is inserted automatically before the distribution list. @@ -2882,8 +3165,8 @@ list. \BeginIndex{Cmd}{encl}% \BeginIndex{Variable}{enclseparator}% \PName{Enclosures} have the same structure as the distribution list. -There is just a single difference, the enclosures starts with -the name and the content of the variable \Variable{enclseparator}. +The only difference is that here the enclosures starts with the name +and content of the variable \Variable{enclseparator}. % \EndIndex{Cmd}{encl}% \EndIndex{Variable}{enclseparator}% @@ -2891,67 +3174,87 @@ the name and the content of the variable \Variable{enclseparator}. \section{Language Support} \label{sec:scrlttr2.languages} +\BeginIndex{}{language}% The document class \Class{scrlttr2} supports many languages. These -are German \PValue{ngerman} (\PValue{german} for old German -orthography), \PValue{austrian} for Austrian, English -(\PValue{english} without specification whether American or British -should be used, \PValue{american} and \PValue{USenglish} for American, -\PValue{british} and \PValue{UKenglish} for British), French, Italian, -Spanish, Dutch and Croatian. +include German (\PValue{german} for old German orthography, +\PValue{ngerman} for the new orthography, and \PValue{austrian} for +Austrian), English (\PValue{english} without specification as to +whether American or British should be used, \PValue{american} and +\PValue{USenglish} for American, and \PValue{british} and +\PValue{UKenglish} for British), French, Italian, Spanish, Dutch, +Croatian and Finnish. \subsection{Language Selection} \label{sec:scrlttr2.switchLanguage} -\Index[indexmain]{language selection} - -If the package \Package{babel}\IndexPackage{babel} is used one can -switch between languages with the command -\Macro{selectlanguage}\Parameter{language}. Other packages like -\Package{german}\IndexPackage{german} and -\Package{ngerman}\IndexPackage{ngerman} also define this command. As -a rule the language selection takes place when such a package is -loaded. - -There is one thing more to mention about language packages. The -package \Package{french}\IndexPackage{french} re-defines not only the -terms of \autoref{sec:scrlttr2.languageTerms}. The package even -re-defines the command \Macro{opening}, since it assumes that the -definition of the standard \Class{letter} is used. Therefore the -package \Package{french} spoils the definition of the \Class{scrlttr2} -class. I think this is a fault of the \Package{french} package. - -If one utilizes the \Package{babel}\IndexPackage{babel} package in -order to switch to language \PValue{french} and the package -\Package{french}\IndexPackage{french} is installed too, then the same -problems occur since \Package{babel} employs definitions from the -\Package{french} package. If the package \Package{french} is not -installed then there are no problems. - -Additionally there is no problem if for \Package{babel} instead of -\PValue{french} other languages like \PValue{acadian}, -\PValue{canadien}, \PValue{francais} or \PValue{frenchb} are chosen. -Therefore I recommend -\Macro{usepackage}\PValue{[frenchb]}\PParameter{babel} in order to -select french. - -Other languages can cause these problems too. Currently there are no -problems known with the \Package{babel} package for the german -language and the various english language selections. - -\iftrue -% You may use this paragraphs to improve page break: -Most \Package{babel} features at \Package{babel} or original -language definition files of \Package{babel} (e.g. \File{frenchb.ldf}), -which may cause problems with other packages or classes, can be -switched off. This is a great advantage of babel. So if you have a -problem, try to switch of such features or ask the authors of -\Package{babel}. - -There are no problems known using the -\Package{german}\IndexPackage{german} or -\Package{ngerman}\IndexPackage{ngerman} package for german selection -with old or new orthography. -\fi +\Index[indexmain]{language>selection} + +If the package \Package{babel}\IndexPackage{babel} (see +\cite{package:babel}) is used, one can switch between languages with +the command \Macro{selectlanguage}\Parameter{language}. Other +packages like \Package{german}\IndexPackage{german} (see +\cite{package:german}) and \Package{ngerman}\IndexPackage{ngerman} +(see \cite{package:ngerman}) also define this command. As a rule +though, the language selection takes place already as a direct +consequence of loading such a package. Further information can be +obtained in the documentation of the relevant packages. + +\begin{Explain} + There is one thing more to mention about language packages. The + package \Package{french}\IndexPackage{french} (see + \cite{package:french}) redefines not only the terms of + \autoref{sec:scrlttr2.languageTerms}, but also other, for instance + it even redefines the command \Macro{opening}, since it assumes that + the definition of the standard \Class{letter} is used. With + \Class{scrlttr2} this is not the case, therefore the package + \Package{french} destroys the definition in \Class{scrlttr2} and + does not work correctly with \KOMAScript. The author views this is a + fault in the \Package{french} package. + + If one utilizes the \Package{babel}\IndexPackage{babel} package in + order to switch to language \PValue{french} while the package + \Package{french}\IndexPackage{french} is simultaneously installed, + then the same problems will likely occur, since \Package{babel} + employs definitions from the \Package{french} package. If the + package \Package{french} is not installed then there are no + problems. Aimilarly, there is no problem if for \Package{babel} + instead of \PValue{french} other languages like \PValue{acadian}, + \PValue{canadien}, \PValue{francais} or \PValue{frenchb} are chosen. + + From \Package{babel} version 3.7j this problem only occurs when it + is indicated explicitly by means of an option that \Package{babel} + should use the \Package{french} package. + + If it cannot be ascertained that a new version of \Package{babel} is + being used, it is recommended to use + + %\Macro{usepackage}\PValue{[...,frenchb,...]}\PParameter{babel} + + \begin{lstlisting} + \usepackage[...,frenchb,...]{babel} + \end{lstlisting} + + in order to select french. + + Other languages can possibly cause similar problems. Currently there + are no known problems with the \Package{babel} package for the + german language and the various english language selections. + +% \iftrue +% % You may use this paragraphs to improve page break: +% Most \Package{babel} features in \Package{babel} or original +% language definition files of \Package{babel} (e.\,g., +% \File{frenchb.ldf}), which may cause problems with other packages or +% classes, can be switched off. This is a great advantage of babel. So +% if you have a problem, try to switch of such features or ask the +% authors of \Package{babel}. + +% There are no known problems with using the +% \Package{german}\IndexPackage{german} or +% \Package{ngerman}\IndexPackage{ngerman} package for german selection +% with old or new orthography, nor for the various english selections. +% \fi +\end{Explain} \begin{Declaration} \Macro{captionsenglish}\\ @@ -2966,7 +3269,8 @@ with old or new orthography. \Macro{captionsitalian}\\ \Macro{captionsspanish}\\ \Macro{captionsdutch}\\ - \Macro{captionscroatian} + \Macro{captionscroatian} \\ + \Macro{captionsfinnish} \end{Declaration} \BeginIndex{Cmd}{captionsenglish}\BeginIndex{Cmd}{captionsUSenglish} \BeginIndex{Cmd}{captionsamerican}\BeginIndex{Cmd}{captionsbritish} @@ -2974,11 +3278,12 @@ with old or new orthography. \BeginIndex{Cmd}{captionsngerman} \BeginIndex{Cmd}{captionsaustrian}\BeginIndex{Cmd}{captionsfrench} \BeginIndex{Cmd}{captionsitalian}\BeginIndex{Cmd}{captionsspanish} -\BeginIndex{Cmd}{captionsdutch}\BeginIndex{Cmd}{captionscroatian} If -one switches the language then using these commands the language-terms -from \autoref{sec:scrlttr2.languageTerms} are re-defined. -If the used language selection scheme does not support this -then the commands above can be used directly. +\BeginIndex{Cmd}{captionsdutch}\BeginIndex{Cmd}{captionscroatian} +\BeginIndex{Cmd}{captionsfinnish} If one switches the language then +using these commands the language-dependent terms from +\autoref{sec:scrlttr2.languageTerms} are redefined. If the used +language selection scheme does not support this then the commands +above can be used directly. % \EndIndex{Cmd}{captionsenglish}\EndIndex{Cmd}{captionsUSenglish} \EndIndex{Cmd}{captionsamerican}\EndIndex{Cmd}{captionsbritish} @@ -2987,7 +3292,7 @@ then the commands above can be used directly. \EndIndex{Cmd}{captionsaustrian}\EndIndex{Cmd}{captionsfrench} \EndIndex{Cmd}{captionsitalian}\EndIndex{Cmd}{captionsspanish} \EndIndex{Cmd}{captionsdutch}\EndIndex{Cmd}{captionscroatian} - +\EndIndex{Cmd}{captionsfinnish} \begin{Declaration} \Macro{dateenglish}\\ @@ -3013,11 +3318,10 @@ then the commands above can be used directly. \BeginIndex{Cmd}{dateitalian}\BeginIndex{Cmd}{datespanish} \BeginIndex{Cmd}{datedutch}\BeginIndex{Cmd}{datecroatian}% \BeginIndex{Cmd}{datefinnish}% -The date\Index{Date} in its numerical representation -(see option \Option{numericaldate} in -\autoref{sec:scrlttr2.headoptions}) will be written depending -on the selected language. Some examples can be found in -\autoref{tab:date}. +The numerical representation of the date\Index{date} (see option +\Option{numericaldate} in \autoref{sec:scrlttr2.headoptions}) will be +written depending on the selected language. Some examples can be found +in \autoref{tab:date}. % \EndIndex{Cmd}{dateenglish}\EndIndex{Cmd}{dateUSenglish} \EndIndex{Cmd}{dateamerican}\EndIndex{Cmd}{datebritish} @@ -3058,12 +3362,11 @@ on the selected language. Some examples can be found in \subsection{Language-Dependent Terms}% \label{sec:scrlttr2.languageTerms}% -\Index[indexmain]{language-dependent terms}% -\Index[indexmain]{terms, language-dependent} +\BeginIndex{}{language>-dependent terms}% +\BeginIndex{}{terms>language-dependent} -As usual in \LaTeX{}, the language-dependent terms are defined -by commands. These commands are re-defined when one switches -the language. +As is usual in {\LaTeX}, the language-dependent terms are defined by +commands which are then redefined when one switches the language. \begin{Declaration} \Macro{yourrefname}\\ @@ -3094,15 +3397,14 @@ the language. \BeginIndex{Cmd}{phonename}\BeginIndex{Cmd}{faxname} \BeginIndex{Cmd}{emailname}\BeginIndex{Cmd}{wwwname} \BeginIndex{Cmd}{bankname} The commands above contain the -language-dependent terms. These definitions can be modified in -order to support a new language or for private customization. -How this can be done is described in -\autoref{sec:scrlttr2.defLanguageTerms}. -The definitions become active at \Macro{begin}\PParameter{document}. -Therefore they are not available in the \LaTeX{} preamble. -Thus they even can not be re-defined there. -In \autoref{tab:scrlttr2.languageTerms} the default settings -for \Option{english} and \Option{ngerman} can be found. +language-dependent terms. These definitions can be modified in order +to support a new language or for private customization. How this can +be done is described in \autoref{sec:scrlttr2.defLanguageTerms}. The +definitions become active only at \Macro{begin}\PParameter{document}. +Therefore they are not available in the {\LaTeX} preamble and cannot +be redefined there. In \autoref{tab:scrlttr2.languageTerms} the +default settings for \Option{english} and \Option{ngerman} can be +found. % \EndIndex{Cmd}{yourrefname}\EndIndex{Cmd}{yourmailname} \EndIndex{Cmd}{myrefname} @@ -3145,30 +3447,32 @@ for \Option{english} and \Option{ngerman} can be found. \end{tabular} \label{tab:scrlttr2.languageTerms} \deffootnote{1em}{1em}{\textsuperscript{1}}% - \footnotetext[1000]{Normally these terms are defined by language packages - like \Package{babel}. At this case they are not redefined by - \Class{scrlttr2} and may differ from the table above.} + \footnotetext[1000]{Normally these terms are defined by language + packages like \Package{babel}. In this case they are not redefined + by \Class{scrlttr2} and may differ from the table above.} \end{minipage} \end{table} % -\subsection{Defining Language Terms} +\subsection{Defining and Changing Language-dependent Terms} \label{sec:scrlttr2.defLanguageTerms} -\Index[indexmain]{language definition} +\Index[indexmain]{language>definition} \begin{Explain} - Normally one has to change or define the language terms of - \autoref{sec:scrlttr2.switchLanguage} in a way that additionally - to the available terms even the new or re-defined terms are - defined. Some packages like \Package{german}\IndexPackage{german} or - \Package{ngerman}\IndexPackage{ngerman} re-define those settings - when they are loaded. These packages re-define the definitions in a - way that spoils all previous private settings. That is also the - reason, why \Class{scrlttr2} delays its own changes with - \Macro{AtBeginDocument} until - \Macro{begin}\PParameter{document}. The user can also use - \Macro{AtBeginDocument} or re-define the language terms after - \Macro{begin}\PParameter{document}. The class \Class{scrlttr2} - provides some commands for defining language terms. + Normally one has to change or define the language-dependent terms of + \autoref{sec:scrlttr2.switchLanguage} in such a way that in addition + to the available terms the new or redefined terms are defined. This + is made more difficult by the fact that some packages like + \Package{german}\IndexPackage{german} or + \Package{ngerman}\IndexPackage{ngerman} redefine those settings when + the packages are loaded. This definitions unfortunately occurs in + such a manner as to destroy all previous private settings. That is + also the reason why \Class{scrlttr2} delays its own changes, with + \Macro{AtBeginDocument} until \Macro{begin}\PParameter{document}, + that is, after package loading is completed. The user can also use + \Macro{AtBeginDocument}, or redefine the language-dependent terms + after \Macro{begin}\PParameter{document}, that is, not put them in + the preamble at all. The class \Class{scrlttr2} even provides some + additional commands for defining language-dependent terms. \end{Explain} \begin{Declaration} @@ -3182,83 +3486,85 @@ for \Option{english} and \Option{ngerman} can be found. \BeginIndex{Cmd}{providecaptionname}% \BeginIndex{Cmd}{newcaptionname}% \BeginIndex{Cmd}{renewcaptionname}% -Using one of the commands above the user can assign -a \PName{definition} for a \PName{language} to a \PName{term} . -The \PName{term} is always a command. The commands differ -dependent from whether a \PName{term} is already define -in \PName{language} or not. - -If \PName{language} is not defined then \Macro{providecaptionname} -writes only a message in the log-file. This happens only -once for each language. -If \PName{language} is defined but \PName{term} isn't defined -yet, then it will be defined using \PName{definition}. -The \PName{term} will not be re-defined if the \PName{language} -already has a definition. Instead of this a log-message will be written. +Using one of the commands above, the user can assign a +\PName{definition} for a particular \PName{language} to a +\PName{term}. The \PName{term} is always a macro. The commands differ +dependent on whether a given \PName{language} or a \PName{term} within +a given \PName{language} are already defined or not at the time the +command is called. + +If \PName{language} is not defined, then \Macro{providecaptionname} +does nothing other than writes a message in the log file. This happens +only once for each language. If \PName{language} is defined but +\PName{term} is not yet defined for it, then it will be defined using +\PName{definition}. The \PName{term} will not be redefined if the +\PName{language} already has such a definition; instead, an +appropriate message is written to the log file. The command \Macro{newcaptionname} has a slightly different behaviour. -If the \PName{language} is not yet defined then a new language -command (see \autoref{sec:scrlttr2.switchLanguage}) -will be created and a log-message will be written. -If \PName{term} is not yet defined in \PName{language} then -it will be defined with \PName{definition}. -If \PName{term} already exists in \PName{language} then this -results in an error message. - -The command \Macro{renewcaptionname} requires an existing -definition of \PName{term} in \PName{language}. -In this case \PName{term} for \PName{language} will be re-defined -according to \PName{definition}. If neither \PName{language} -nor \PName{term} exist or \PName{term} is unknown in a defined -language then a error message will be given. +If the \PName{language} is not yet defined, then a new language +command (see \autoref{sec:scrlttr2.switchLanguage}) will be created +and a message written to the log file. If \PName{term} is not yet +defined in \PName{language}, then it will be defined using +\PName{definition}. If \PName{term} already exists in +\PName{language}, then this results in an error message. + +The command \Macro{renewcaptionname} again behaves differently. It +requires an existing definition of \PName{term} in \PName{language}. +If neither \PName{language} nor \PName{term} exist or \PName{term} is +unknown in a defined language then a error message will be +given. Otherwise, the \PName{term} for \PName{language} will be +redefined according to \PName{definition}. The class \Class{scrlttr2} itself employs \Macro{providecaptionname} in order to define the commands in \autoref{sec:scrlttr2.languageTerms}. \begin{Example} - If you prefer ``Your message of'' instead of ``Your letter of'' - you have to re-define the definition of \Macro{yourmailname}. + If you prefer ``Your message of'' instead of ``Your letter of'', you + have to redefine the definition of \Macro{yourmailname}. \begin{lstlisting} \renewcaptionname{english}{\yourmailname}{% Your message of} \end{lstlisting} - Since only available terms can be re-defined you have to - delay the command until \Macro{begin}\PParameter{document} - using \Macro{AtBeginDocument}. - Furthermore you will get an error message if there is no - package used that defines a language selection command - for \PName{english}. +Since only existing terms in available languages can be redefined, you +have to put the command after \Macro{begin}\PParameter{document} or +delay the command by using \Macro{AtBeginDocument}. Furthermore, you +will get an error message if there is no package used that switches +language selection to \PName{english}. \end{Example} % \EndIndex{Cmd}{providecaptionname}% \EndIndex{Cmd}{newcaptionname}% \EndIndex{Cmd}{renewcaptionname}% +% +\EndIndex{}{language}% +\EndIndex{}{language>-dependent terms}% +\EndIndex{}{terms>language-dependent} \section{Address Files and Circular Letters} \label{sec:scrlttr2.addressFile} +\BeginIndex{}{address>file}\BeginIndex{}{circular letters}% -When people write circular letters they mostly dislike to -type the many addresses. -The class \Class{scrlttr2} and its predecessor \Class{scrlettr} -as well provide basic support for it. -Currently there are plans for a much enhanced support. +When people write circular letters one of the more odious tasks is the +typing of many different addresses. The class \Class{scrlttr2}, as +did its predecessor \Class{scrlettr} as well, provides basic support +for this task. Currently there are plans for much enhanced support. \typeout{^^J--- Ignore underfull and overfull \string\hbox:}% \begin{Declaration} \Macro{adrentry}\Parameter{Lastname}\Parameter{Firstname}% - \Parameter{Address}\Parameter{Telephone}\Parameter{F1}\Parameter{F2}% + \Parameter{Address}\Parameter{Phone}\Parameter{F1}\Parameter{F2}% \Parameter{Comment}\Parameter{Key} \end{Declaration}% \typeout{^^J--- Don't ignore underfull and overfull \string\hbox:} \BeginIndex{Cmd}{adrentry} \label{decl:adrentry} -The class \Class{scrlttr2} supports to use address files. -These address files contain address entries. -Each entry is an \Macro{adrentry} command with eight parameters as -can be seen above. -The file extension of the address file has to be \File{.adr}. +The class \Class{scrlttr2} supports the use of address files which +contain address entries, very useful for circular letters. The file +extension of the address file has to be \File{.adr}. Each entry is an +\Macro{adrentry} command with eight parameters, for example: \begin{lstlisting} \adrentry{McEnvy} {Flann} @@ -3269,120 +3575,111 @@ The file extension of the address file has to be \File{.adr}. {niggard} {FLANN} \end{lstlisting} -The 5\textsuperscript{th} and 6\textsuperscript{th} element, \PValue{F1} and -\PValue{F2}, can be used freely, for example for the gender, the academic -grade, the birthday or the date the person has joined a society. The last -parameter \PName{Key} should only consist of uppercase letters in order to not -interfere with other \TeX{} or \LaTeX{} commands. +The 5\textsuperscript{th} and 6\textsuperscript{th} elements, +\PValue{F1} and \PValue{F2}, can be used freely: for example, for the +gender, the academic grade, the birthday, or the date on which the +person joined a society. The last parameter \PName{Key} should only +consist of uppercase letters in order to not interfere with existing +{\TeX} or {\LaTeX} commands. \begin{Example} - Mr.\,McEnvy is one of your most important business partners, - but every day you get a reclamation from him. - Before long you don't want to bother typing his boring - address again and again. - Here \Class{scrlttr2} can help. - All your business partners have an entry in your - \File{partners.adr} address file. - If you now have to answer Mr.\,McEnvy again, then you - can save typing as can be seen below: -\begin{lstlisting} - \input{partners.adr} - \begin{letter}{\FLANN} - Your today's reclamation \dots - \end{letter} -\end{lstlisting} - Your \TeX{} system must be configured to have access to your - address file. Without access the \Macro{input} command results - in an error. You can either put your address file where you - are running \LaTeX{} or configure your system to find - the file in a special directory. + Mr.\,McEnvy is one of your most important business partners, but + every day you receive correspondence from him. Before long you do + not want to bother typing his boring address again and again. Here + \Class{scrlttr2} can help. Assume that all your business partners + have an entry in your \File{partners.adr} address file. If you now + have to reply to Mr.\,McEnvy again, then you can save typing as + follows: + \begin{lstlisting} + \input{partners.adr} + \begin{letter}{\FLANN} + Your correspondence of today \dots + \end{letter} + \end{lstlisting} + Your {\TeX} system must be configured to have access to your address + file. Without access, the \Macro{input} command results in an + error. You can either put your address file in the same directory + where you are running {\LaTeX}, or configure your system to find the + file in a special directory. \end{Example} -% +% \EndIndex{Cmd}{adrentry} \typeout{^^J--- Ignore underfull and overfull \string\hbox:}% \begin{Declaration} \Macro{addrentry}\Parameter{Lastname}\Parameter{Firstname}% - \Parameter{Address}\Parameter{Telephone}\Parameter{F1}\Parameter{F2}% + \Parameter{Address}\Parameter{Phone}\Parameter{F1}\Parameter{F2}% \Parameter{F3}\Parameter{F4}\Parameter{Key} \end{Declaration}% \typeout{^^J--- Dont't ignore underfull and overfull \string\hbox:} \BeginIndex{Cmd}{addrentry}% -Over the years people objected that the \Macro{adrentry} has only -two free parameters. Since \TeX{} supports at maximum nine -parameters per command, there now exists a new command called -\Macro{addrentry}, note the additional ``d''. -This command supports four freely definable parameters, that -means one parameter more than \Macro{adrentry}, since the comment -parameter has been replaced with the fourth free parameter. -The numbers of parameters is the only difference between -both commands. Thus you can mix both entry types in -one address file. - -There are some packages which can employ \File{adr} files. -For example \Package{adrconv} by Axel Kielhorn can be used -to create address lists from \File{adr} files. -But it has currently no support for command \Macro{addrentry}. -The only choice is to extent the package yourself. +Over the years people have objected that the \Macro{adrentry} has only +two free parameters. To cater to this demand, there now exists a new +command called \Macro{addrentry}\,---\,note the additional +``d''\,---\,which supports four freely-definable parameters. Since +{\TeX} supports maximally nine parameters per command, the comment +parameter has fallen away. Other than this difference, the use is the +same as that of \Macro{adrentry}. + +Both \Macro{adrentry} and \Macro{addrentry} commands can be freely +mixed in the \File{adr} files. However, it should be noted that there +are some packages which are not suited to the use of +\Macro{addrentry}. For example, the \Package{adrconv} by Axel +Kielhorn can be used to create address lists from \File{adr} files, +but it has currently no support for command \Macro{addrentry}. In +this case, the only choice is to extend the package yourself. % \EndIndex{Cmd}{addrentry} -Besides the simple access to addresses the address files can -be easily used in order to write circular letters. -Thus there is no complicated data-base system and its connection -to \TeX{} required. +Besides the simple access to addresses, the address files can be +easily used in order to write circular letters. Thus, there is no +requirement to access a complicated database system via {\TeX}. % \begin{Example} - Suppose you are member of a society and want write a invitation - for the next general meeting to all members. -\begin{lstlisting} - \documentclass{scrlttr2} + Suppose you are member of a society and want write an invitation for + the next general meeting to all members. + \begin{lstlisting} + \documentclass{scrlttr2} \begin{document} \renewcommand*{\adrentry}[8]{ \begin{letter}{#2 #1\\#3} - \opening{Dear members,} - our next general meeting will be on monday - August 12, 2002. The following topics are \dots + \opening{Dear members,} Our next general meeting will be on + Monday, August 12, 2002. The following topics are \dots \closing{Regards,} \end{letter} } \input{members.adr} - \end{document} + \end{document} \end{lstlisting} - If the address file contains \Macro{addrentry} statements - too, then even an additional definition for \Macro{addrentry} - is required. +If the address file contains \Macro{addrentry} commands too, than an +additional definition for \Macro{addrentry} is required before loading +the address file: \begin{lstlisting} - \renewcommand*{\addrentry}[9]{ - \begin{letter}{#2 #1\\#3} - \opening{Dear members,} - our next general meeting will be on Monday - August 12, 2002. The topics of the meeting are \dots - \closing{Regards,} - \end{letter} - } + \renewcommand*{\addrentry}[9]{% + \adrentry{#1}{#2}{#3}{#4}{#5}{#6}{#7}{#9}% + } \end{lstlisting} - In this simple example the extra freely definable parameter - is not used. +In this simple example the extra freely-definable parameter is not +used, and therefore \Macro{addrentry} is defined with the help of +\Macro{adrentry}. \end{Example} -With some additional programming one can let the contents -depend on the address data. For this the free parameters -can be used. +With some additional programming one can let the content of the +letters depend on the address data. For this the free parameters of +the \Macro{adrentry} and and \Macro{addrentry} commands can be used. \begin{Example} - Suppose the fifth parameter of the \Macro{adrentry} command - contains the gender of a member (\PValue{m/f}). - The sixth parameter contains what member subscription - has still not been discharged by the member. - If you would like to write a more personal reminder - then the next example can help you. + Suppose the 5\textsuperscript{th} parameter of the \Macro{adrentry} + command contains the gender of a member (\PValue{m/f}), and the + 6\textsuperscript{th} parameter contains what amount of subscription + has not yet been paid by the member. If you would like to write a + more personal reminder to each such member, then the next example + can help you: \begin{lstlisting} \renewcommand*{\adrentry}[8]{ - \ifcase #6 - % #6 greater than 0? - % this selects all members with open subscription - \else + \ifdim #6pt>0pt\relax + % #6 is an amount greater than 0. + % Thus, this selects all members with due subscription. \begin{letter}{#2 #1\\#3} \if #5m \opening{Dear Mr.\,#2,} \fi \if #5f \opening{Dear Mrs.\,#2,} \fi @@ -3398,34 +3695,33 @@ can be used. } \end{lstlisting} \end{Example} -As you can see the letter text can be made more personal -depending on attributes of the letter's addressee. -The number of attributes is only restricted by number of the -two free parameters of the \Macro{adrentry} command or -four free parameters of the \Macro{addrentry} command. +As you can see, the letter text can be made more personal by depending +on attributes of the letter's addressee. The number of attributes is +only restricted by number of two free parameters of the +\Macro{adrentry} command, or four free parameters of the +\Macro{addrentry} command. \begin{Declaration} \Macro{adrchar}\Parameter{initial letter}\\ \Macro{addrchar}\Parameter{initial letter} \end{Declaration} \BeginIndex{Cmd}{adrchar}\BeginIndex{Cmd}{addrchar} -\Index[indexmain]{address list}\Index[indexmain]{telephone list}% -As already mentioned above it is possible to create address -and telephone lists using \File{adr} files. -For that the additional package \Package{adrconv} by -Axel Kielhorn (see \cite{package:adrconv}) is needed. -This package contains interactive \LaTeX{} documents -which help to create those lists. - -The address files have to be sorted already in order to -get sorted lists. It is recommended to sort and separate the -entries by the initial letter of \PName{Lastname}. -As a separator the commands \Macro{adrchar} and \Macro{addrchar} -can be used. These commands will be ignored if the address files -are utilized in \Class{scrlettr2}. +\Index[indexmain]{address>list}\Index[indexmain]{telephone list}% +As already mentioned above, it is possible to create address and +telephone lists using \File{adr} files. For that, the additional +package \Package{adrconv} by Axel Kielhorn (see +\cite{package:adrconv}) is needed. This package contains interactive +{\LaTeX} documents which help to create those lists. + +The address files have to be sorted already in order to obtain sorted +lists. It is recommended to separate the sorted entries at each +different initial letter of \PName{Lastname}. As a separator, the +commands \Macro{adrchar} and \Macro{addrchar} can be used.. These +commands will be ignored if the address files are utilized in +\Class{scrlettr2}. % \begin{Example} - Suppose the following address file: + Suppose you have the following short address file: \begin{lstlisting} \adrchar{A} \adrentry{Angel}{Gabriel} @@ -3436,12 +3732,12 @@ are utilized in \Class{scrlettr2}. {000\,01\,02\,04}{}{}{archangel}{MICHAEL} \adrchar{K} \adrentry{Kohm}{Markus} - {Fichtenstra\ss e 63\\68535 Edingen-Neckarhausen} + {Freiherr-von-Drais-Stra\ss e 66\\68535 Edingen-Neckarhausen} {+49~62\,03~1\,??\,??}{}{}{no angel at all} {KOMA} \end{lstlisting} This address file can be treated with \File{adrdir.tex} of the - \Package{adrconv} package \cite{package:adrconv}. + \Package{adrconv} package~\cite{package:adrconv}. The result should look like this: \begin{center} \setlength{\unitlength}{1mm} @@ -3460,125 +3756,123 @@ are utilized in \Class{scrlettr2}. \small~\\\textsc{gabriel}\\000\,01\,02\,03}}} \put(10,4){\makebox(0,20)[l]{\parbox{5cm}{\raggedright \textsc{Angel}, Michael\\\quad\small Cloud 3a\\ - \quad 12345 Heaven'S Realm\\ + \quad 12345 Heaven's Realm\\ \quad (archangel)}}} \put(70,4){\makebox(0,20)[r]{\parbox{2cm}{\raggedright~\\ \small~\\\textsc{michael}\\000\,01\,02\,04}}} \qbezier(0,3)(10,6)(40,3)\qbezier(40,3)(60,0)(80,3) \end{picture} \end{center} - The letter in the page heading is created by the - \Macro{adrchar} command, see the definition in \File{adrdir.tex}. + The letter in the page header is created by the \Macro{adrchar} + command. The definition can be found in \File{adrdir.tex}. \end{Example} More about the \Package{adrconv} package can be found in its -documentation. There you should even find information if -the version of \Package{adrconv} supports already the -\Macro{addrentry} and \Macro{addrchar} commands. -Former versions only know the commands \Macro{adrentry} and -\Macro{adrchar}. +documentation. There you should also find information about whether +the current version of \Package{adrconv} supports the +\Macro{addrentry} and \Macro{addrchar} commands. Former versions only +know the commands \Macro{adrentry} and \Macro{adrchar}. % \EndIndex{Cmd}{adrchar}\EndIndex{Cmd}{addrchar}% - +% +\EndIndex{}{address>file}\EndIndex{}{circular letters}% \section{From \Class{scrlettr} to \Class{scrlttr2}} \label{sec:scrlttr2.fromscrlettr} -The first step in the conversion of an old letter written with -the \Class{scrlettr} class is to load the appropriate -\File{lco} file using option \Option{KOMAold} at -\Macro{documentclass}. -Thereupon most commands of the old class should work. -But you will encounter some differences in the output, since -the page layout of both classes is not the same. -The reason is that the calculation of the type-area in \Class{scrlettr} -has some minor bugs. For example the position of the folding marks -used to depend on the height of the page heading, which again has -dependence to the font size. That was an unambiguous design fault. - -There is no compatibility regarding the defined lengths -in \Class{scrlettr}. -If one has changed the page layout of \Class{scrlettr} -then those statements have to be deleted or commented out. -In some cases the modification of length can cause -an error, since this length is not defined anymore. -You should delete or comment these modifications as well. - -The old letter example: +The first step in the conversion of an old letter written with the +\Class{scrlettr} class is to load the appropriate \File{lco} file +using option \Option{KOMAold} at \Macro{documentclass}. Thereupon +most commands of the old class should work. However, you will +encounter some differences in the output, since the page layout of the +old class is not realized exactly. The reason is that the calculation +of the type area in \Class{scrlettr} has some minor bugs. For example, +the position of the folding marks used to depend on the height of the +page header, which again depended on the font size. That was +unambiguously a design error. + +There is no compatibility regarding the defined lengths in +\Class{scrlettr}. Thus, if a user has changed the page layout of +\Class{scrlettr}, then the relevant statements should be deleted or +commented out. In some cases, the modification of a length can cause +an error, since this length is no longer defined in \Class{scrlttr2}. +The user should delete or comment out such modifications as well. + +After the switch from \Class{scrlettr} to \Class{scrlttr2}, the old +letter example can be successfully compiled already alone through the +setting of the option \Option{KOMAold}: \begin{lstlisting} \documentclass[10pt,KOMAold]{scrlttr2} - \name{\KOMAScript{} team} - \address{Class Alley 1\\12345 \LaTeX{} City} - \signature{Your \KOMAScript{} team} + \name{{\KOMAScript} team} + \address{Class Alley 1\\12345 {\LaTeX} City} + \signature{Your {\KOMAScript} team} \begin{document} - \begin{letter}{\KOMAScript{} users\\ + \begin{letter}{{\KOMAScript} users\\ Everywhere\\world-wide} - \opening{Dear \KOMAScript{} users,} - the \KOMAScript{} team is proud to announce \dots - \closing{Happy \TeX{}ing} + \opening{Dear {\KOMAScript} users,} + the {\KOMAScript} team is proud to announce \dots + \closing{Happy {\TeX}ing} \end{letter} \end{document} \end{lstlisting} -works as expected only by option \Option{KOMAold}. - -The next step is that the layout of the old letter will -not be used anymore, but the old commands should still -be available. -If for example one wants the layout of \Option{DIN} -then this option can be given in \Macro{documentclass}, -but is has to be specified \emph{after} the option -\Option{KOMAold}. +The next step is that while wanting the old commands to be still be +available, the layout of the old letter should no longer be used. If, +for example, one wants to sue the layout of the letter class option +\Option{DIN}, then this option can be given in \Macro{documentclass}, +but is has to be specified \emph{after} the option \Option{KOMAold}: \begin{lstlisting} \documentclass[10pt,KOMAold,DIN]{scrlttr2} - \name{\KOMAScript{} team} - \address{Class Alley 1\\12345 \LaTeX{} City} - \signature{Your \KOMAScript{} team} + \name{{\KOMAScript} team} + \address{Class Alley 1\\12345 {\LaTeX} City} + \signature{Your {\KOMAScript} team} \begin{document} - \begin{letter}{\KOMAScript{} users\\ + \begin{letter}{{\KOMAScript} users\\ Everywhere\\world-wide} - \opening{Dear \KOMAScript{} users,} - the \KOMAScript{} team is proud to announce \dots - \closing{Happy \TeX{}ing} + \opening{Dear {\KOMAScript} users,} + the {\KOMAScript} team is proud to announce \dots + \closing{Happy {\TeX}ing} \end{letter} \end{document} \end{lstlisting} -Using more options this way you have further influence on the -layout, but a more inherent change is really recommended. +By using more options this way, you can further influence the +layout. However, the author recommends a more inherent change right +away. -That is to replace all old commands with its new representations -and omit the option \Option{KOMAold}. -It can help to read the contents of \File{KOMAold.lco}. -In that file the old commands are defined using the new ones. +The last step is to replace all old commands with their new +equivalents, and to omit the option \Option{KOMAold}. For this task, +it may help to read the contents of \File{KOMAold.lco}. In that file +the old commands are defined using the new commands and variables. \begin{lstlisting} \documentclass{scrlttr2} - \setkomavar{fromname}{\KOMAScript{} team} + \setkomavar{fromname}{{\KOMAScript} team} \setkomavar{fromaddress}{Class Alley 1\\ - 12345 \LaTeX{} City} - \setkomavar{signature}{Your \KOMAScript{} team} + 12345 {\LaTeX} City} + \setkomavar{signature}{Your {\KOMAScript} team} \let\raggedsignature=\raggedright \begin{document} - \begin{letter}{\KOMAScript{} users\\ + \begin{letter}{{\KOMAScript} users\\ Everywhere\\ world-wide} - \opening{Dear \KOMAScript{} users,} - the \KOMAScript{} team is proud to announce \dots - \closing{Happy \TeX{}ing} + \opening{Dear {\KOMAScript} users,} + the {\KOMAScript} team is proud to announce \dots + \closing{Happy {\TeX}ing} \end{letter} \end{document} \end{lstlisting} -This example shows also the possibility to change the -alignment of the signature by re-defining the command -\Macro{raggedsignature}. -This is recommended if the width of the real signature -is greater than the signature-definition of the command -\Macro{setkomavar}\PParameter{signature}\PParameter{\dots}. +This example shows also the possibility to change the alignment of the +signature by redefining the command \Macro{raggedsignature}. This is +always recommended when the width of the explanation of the signature as +defined by the command +\Macro{setkomavar}\PParameter{signature}\PParameter{\dots} is greater than the +width of the argument of \Macro{closing}. % -\EndIndex{Class}{scrlttr2}\EndIndex{}{Letters} +\EndIndex{Class}{scrlttr2}\EndIndex{}{letters} %%% Local Variables: %%% mode: latex +%%% coding: iso-latin-1 %%% TeX-master: "../guide" %%% End: diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex index f04590023ae..cee23e6fe5f 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrpage2.tex @@ -40,83 +40,82 @@ % % ---------------------------------------------------------------------- % -% Kapitel über scrpage2 in der KOMA-Script-Anleitung -% Verwaltet von Jens-Uwe Morawski (unterstützt von Markus Kohm) +% Kapitel über scrpage2 in der KOMA-Script-Anleitung +% Verwaltet von Jens-Uwe Morawski (unterstützt von Markus Kohm) % % ============================================================================ -\ProvidesFile{scrpage2.tex}[2006/07/01 KOMA-Script guide (chapter:scrpage2)] -% date of translated german file: 2004/08/10 +\ProvidesFile{scrpage2.tex}[2007/09/27 KOMA-Script guide (chapter:scrpage2)] +\translator{Jens-Uwe Morawski\and Karl-Heinz Zimmer\and Christoph Bier\and + Gernot Hassenpflug\and Markus Kohm} -\chapter{Adapt Head and Foot with \Package{scrpage2}} +% date of translated german file: 2005/08/10 + +\chapter{Adapting Page Headers and Footers with \Package{scrpage2}} \labelbase{scrpage} % \BeginIndex{Package}{scrpage2}% -% -In \autoref{cha:typearea} this guide referenced a package -to customise the head and foot lines of a document. -This package \Package{scrpage2}, the successor of \Package{scrpage}, -enables the user to create versatile head and foot layouts with -less effort, due to a simple but powerful user interface. While -\Package{scrpage} is obsolete since 2001, this documentation only describes -\Package{scrpage2}. +As already mentioned in the two previous chapters, {\KOMAScript} +includes a package to customise the document page header and footer. +As of 2001, this package is no longer \Package{scrpage} but the much +improved and enhanced successor \Package{scrpage2}. Therefore, this +documentation describes only \Package{scrpage2}. The package +\Package{scrpage} is obsolete. \begin{Explain} - The package's focus is its good integration into the whole - \KOMAScript{}-bundle, thus it extents the base functionality of - \KOMAScript{} perfectly. It is very flexible in either its layout and - usage, compared to other packages often to be seen like - \Package{fancyhdr}\cite{package:fancyhdr}. You don't need to use - \Package{scrpage2} with \KOMAScript{}, the package can be used in any other - document-class environment. + In place of \Package{scrpage2} you can of course make use of + \Package{fancyhdr} (see \cite{package:fancyhdr}). However, + \Package{scrpage2} integrated markedly better with the {\KOMAScript} + bundle. For this reason, and because at the time the forerunner to + \Package{fancyhdr} was missing many features, \Package{scrpage2} was + developed. Naturally, \Package{scrpage2} is not limited to use only + with the {\KOMAScript} classes, but can just as easily be used with + other document classes. \end{Explain} +Included as part of the basic functionality of \Package{scrpage2} are +various predefined and configurable page styles. \section{Basic Functionality}\label{sec:scrpage.basics} \begin{Explain}% Introduction to headings - \LaTeX{}'s head and foot mechanism is a little complicated, thus a - brief view in its depth is needed. - Basically the \LaTeX{} kernel defines the chief page styles - \PValue{empty} and \PValue{plain}. - The latter writes only a page number in the foot, in contrast - using \PValue{empty} results in blank head and foot. - Besides, many document classes provide the style - \PValue{headings}, which allows more complex style settings. - The \PValue{headings} style often has a subvariant, the - \emph{my}-variant. In contrast to the \PValue{headings} style - the \PValue{myheadings} switches off the automatic update - of the running head, thus it is the users task keeping headings - in sync with the current document content. - A more detailed discription can be found in - \autoref{sec:maincls.pageStyle}. - - Another important note is that some \LaTeX{} commands - switch to the pagestyle \PValue{plain} for the current page, - independent from what pagestyle was choosen by the author, - consequently the document needs an appropriate - \PValue{plain} pagestyle. + To understand the following description, an overview of {\LaTeX}'s + fairly involved header and footer mechanism is needed. The {\LaTeX} + kernel defines the page styles \PValue{empty}, which produces a + completely empty header and footer, and \PValue{plain}, which + produces usually only a page number in the footer and an empty + header. Apart from these, many document classes provide the style + \PValue{headings}, which allows more complex style settings and + running headings. The \PValue{headings} style often has a related + variant, \PValue{myheadings}, which is similar except for switching + off the running headings and reverting them to manual control by the + user. A more detailed description is given in + \autoref{sec:maincls.pageStyle} where it is also noted that some + {\LaTeX} commands automatically switch to the page style + \PValue{plain} for the current page, independent of what page style + was chosen by the author, and consequently a document needs an + appropriate \PValue{plain} page style. - Therefore \Package{scrpage2} defines its own \PValue{plain} - and \PValue{headings} page styles, named \PValue{scrplain} - and \PValue{scrheadings}. - The manual activation of \PValue{scrplain} is not necessary, - since the activation of \PValue{scrheadings} takes care of it - automatically. - Only if one wants to use his own page style in combination - with \PValue{scrplain}, the page style \PValue{scrplain} has to - be activated first, i.e. \Macro{pagestyle}\Parameter{scrplain}% + Therefore \Package{scrpage2} defines its own \PValue{plain} and + \PValue{headings} page styles, named \PValue{scrplain} and + \PValue{scrheadings}. The manual activation of \PValue{scrplain} is + not necessary, since the activation of \PValue{scrheadings} takes + care of it automatically. Only if one wants to use one's own page + style in combination with \PValue{scrplain} must the page style + \PValue{scrplain} be activated first, i.\,e., with + \Macro{pagestyle}\Parameter{scrplain}% \Macro{pagestyle}\Parameter{personalPagestyle}. \end{Explain} -The original \PValue{headings} page style of the document class is available -as \PValue{useheadings}. This re-definition is required since -\Package{scrpage2} uses another way to deal with automatic and manual -headings. This way is more flexible and allows configurations usually -difficult to implement for unexperienced users. The required commands to work -with the \Package{scrpage2} implementation are introduced at the end of -\autoref{sec:scrpage.basics.buildIn} and the begin of +The original \PValue{headings} page style of the document class is +available as \PValue{useheadings}. This re-definition is required +since \Package{scrpage2} uses a different way to deal with automatic +and manual headings. This way is more flexible and allows +configurations which would usually prove difficult to implement for +inexperienced users. The required commands to work with the +\Package{scrpage2} implementation are introduced at the end of +\autoref{sec:scrpage.basics.buildIn} and the beginning of \autoref{sec:scrpage.basics.mark}. \subsection{Predefined Page Styles}\label{sec:scrpage.basics.buildIn} @@ -129,57 +128,57 @@ with the \Package{scrpage2} implementation are introduced at the end of \PValue{scrplain} \end{Declaration}% \BeginIndex{Pagestyle}{scrheadings}\BeginIndex{Pagestyle}{scrplain}% -\Index{page style}% +\Index{page>style}% % -Package \Package{scrpage2} delivers an own pagestyle, named -\PValue{scrheadings}. -The command \Macro{pagestyle}\PParameter{scrheadings} activates -this page style, likewise -after activation an appropriate \PValue{plain} pagestyle -is available. -In this case \emph{appropriate} meens that the \PValue{plain} -page style is also configureable by the commands introduced in -\autoref{sec:scrpage.basics.format}, which, for example, -configure the head and foot width. -Neither the activation of \PValue{scrheadings} nor \PValue{scrplain} -influences the mode of manual or automatic headings, -see \autoref{sec:scrpage.basics.mark}. +Package \Package{scrpage2} delivers its own page style, named +\PValue{scrheadings}, which can be activated with the +\Macro{pagestyle}\PParameter{scrheadings}. When this page style is in +use, an appropriate \PValue{scrplain} page style is used for the +\PValue{plain} page style. In this case \emph{appropriate} means that +this new \PValue{plain} page style is also configureable by the +commands introduced in \autoref{sec:scrpage.basics.format}, which, for +example, configure the header and footer width. Neither the +activation of \PValue{scrheadings} nor the attendant change to the +\PValue{plain} page style influences the mode of manual or automatic +headings (see \autoref{sec:scrpage.basics.mark}). The +\PValue{scrplain} page style can also be activated directly with +\Macro{pagestyle}. \begin{Declaration} \Macro{lehead}% \OParameter{scrplain-left-even}\Parameter{scrheadings-left-even}\\ \Macro{cehead}% - \OParameter{scrplain-concentric-even}\Parameter{scrheadings-concentric-even}\\ + \OParameter{scrplain-center-even}\Parameter{scrheadings-center-even}\\ \Macro{rehead}% \OParameter{scrplain-right-even}\Parameter{scrheadings-right-even}\\ \Macro{lefoot}% \OParameter{scrplain-left-even}\Parameter{scrheadings-left-even}\\ \Macro{cefoot}% - \OParameter{scrplain-concentric-even}\Parameter{scrheadings-concentric-even}\\ + \OParameter{scrplain-center-even}\Parameter{scrheadings-center-even}\\ \Macro{refoot}% \OParameter{scrplain-right-even}\Parameter{scrheadings-right-even}\\ \Macro{lohead}% \OParameter{scrplain-left-odd}\Parameter{scrheadings-left-odd}\\ \Macro{cohead}% - \OParameter{scrplain-concentric-odd}\Parameter{scrheadings-concentric-odd}\\ + \OParameter{scrplain-center-odd}\Parameter{scrheadings-center-odd}\\ \Macro{rohead}% \OParameter{scrplain-right-odd}\Parameter{scrheadings-right-odd}\\ \Macro{lofoot}% \OParameter{scrplain-left-odd}\Parameter{scrheadings-left-odd}\\ \Macro{cofoot}% - \OParameter{scrplain-concentric-odd}\Parameter{scrheadings-concentric-odd}\\ + \OParameter{scrplain-center-odd}\Parameter{scrheadings-center-odd}\\ \Macro{rofoot}% \OParameter{scrplain-right-odd}\Parameter{scrheadings-right-odd}\\ \Macro{ihead}% \OParameter{scrplain-inside}\Parameter{scrheadings-inside}\\ \Macro{chead}% - \OParameter{scrplain-concentric}\Parameter{scrheadings-concentric}\\ + \OParameter{scrplain-centered}\Parameter{scrheadings-centered}\\ \Macro{ohead}% \OParameter{scrplain-outside}\Parameter{scrheadings-outside}\\ \Macro{ifoot}% \OParameter{scrplain-inside}\Parameter{scrheadings-inside}\\ \Macro{cfoot}% - \OParameter{scrplain-concentric}\Parameter{scrheadings-concentric}\\ + \OParameter{scrplain-centered}\Parameter{scrheadings-centered}\\ \Macro{ofoot}% \OParameter{scrplain-outside}\Parameter{scrheadings-outside} \end{Declaration}% @@ -190,11 +189,10 @@ see \autoref{sec:scrpage.basics.mark}. \BeginIndex{Cmd}{ifoot}\BeginIndex{Cmd}{cfoot}\BeginIndex{Cmd}{rfoot}% \BeginIndex{Cmd}{lofoot}\BeginIndex{Cmd}{cofoot}\BeginIndex{Cmd}{rofoot}% % -The page styles include three boxes either in head and foot. -The commands modifying the content of these boxes can be seen -in \autoref{fig:scrpage.leheadetall}. -Commands in the middle column modify the boxes content on both the odd -and even pages. +The page styles include three boxes in both the header and the footer. +The commands modifying the content of these boxes can be seen in +\autoref{fig:scrpage.leheadetall}. Commands in the middle column +modify the box contents on both odd and even pages. \begin{figure} \centering @@ -254,38 +252,39 @@ and even pages. \put(80,11){\makebox(0,0)[t]{\Macro{cofoot}}} \put(95,11){\makebox(0,0)[t]{\Macro{rofoot}}} \end{picture} - \caption[Commands for modification of - \Package{scrpage2}-pagestyles elements]% - {Commands for modification of pagestyles \PValue{scrheadings} and - \PValue{scrplain} and their association to head and foot elements} + \caption[Commands for modification of \Package{scrpage2} page styles + elements]% + {Commands for modification of page styles \PValue{scrheadings} and + \PValue{scrplain} and their relationship to header and footer + elements} \label{fig:scrpage.leheadetall} \end{figure} \begin{Example} If one wants the page number be placed in the middle of the -foot, then following can be used: +footer, then following can be used: \begin{lstlisting} \cfoot{\pagemark} \end{lstlisting} -The next example shows how to place both running head and -page number in the head; the running head inside and the page number -outside. +The next example shows how to place both running heading and page +number in the header; the running heading inside and the page number +outside: \begin{lstlisting} \ohead{\pagemark} \ihead{\headmark} \cfoot{} \end{lstlisting} -The command \Macro{cfoot}\PParameter{} is only required in order -to empty the item in middle of the foot, -which normally contains the page number. +The command \Macro{cfoot}\PParameter{} is only required in order to +empty the item in the middle of the footer, which normally contains +the page number. \end{Example} -Using the commands which are associated with only one item -allows more advanced settings. +The commands which are associated with only one item can be used for +more advanced settings. \begin{Example} -Assuming one has the order to write an annual report for his -company, he could use commands like this: +Assuming one has the order to write an annual report for one's +company, one could use commands like this: \begin{lstlisting} \ohead{\pagemark} \rehead{Annual Report 2001} @@ -293,26 +292,27 @@ company, he could use commands like this: \cefoot{TheCompanyName Inc.} \cofoot{Department: Development} \end{lstlisting} -In order to keep in sync the data in the foot with the content -of the document, the foot has to be updated using \Macro{cofoot} +In order to keep the data in the footer synchronized with the content +of the document, the footer has to be updated using \Macro{cofoot} when a new department is discussed in the report. \end{Example} -As mentioned above, there is an \PValue{plain}-pagestyle which corresponds to -\PValue{scrheadings}. Since it should also be possible to adapt this style, -the commands support an optional argument. Thus the contents of the -appropriate field of the \PValue{plain}-pagestyle can be modified. +As mentioned above, there is a new \PValue{plain} page style which +corresponds to \PValue{scrheadings}. Since it should also be possible +to customize this style, the commands support an optional argument +with which the contents of the appropriate fields of this +\PValue{plain} page style can be modified. \begin{Example} -The position of the page number for the pagestyle \PValue{scrheadings} +The position of the page number for the page style \PValue{scrheadings} can be declared as follows: \begin{lstlisting} \cfoot[\pagemark]{} \ohead[]{\pagemark} \end{lstlisting} -When now the command \Macro{chapter}, after it has started a new page, -switches to the \PValue{plain}-pagestyle, then the page number -is centered in the foot. +When the command \Macro{chapter}, after it has started a new page, now +switches to the \PValue{plain} page style, then the page number is +centered in the footer. \end{Example} % \EndIndex{Pagestyle}{scrheadings}\EndIndex{Pagestyle}{scrplain}% @@ -325,30 +325,29 @@ is centered in the foot. \BeginIndex{Cmd}{clearscrheadings}% \BeginIndex{Cmd}{clearscrplain}% \BeginIndex{Cmd}{clearscrheadfoot}% -If one wants to redefine both the page style \PValue{scrheadings} -and the \PValue{plain} page style, frequently one must delete -some already occupied page items. Since one fills all items -rarely with new contents, in most cases several -instruction with empty parameters are necessary. -With the help of these three instructions the deletion is fast and -thoroughly possible. -While \Macro{clearscrheadings} only deletes all fields of the -page style \PValue{scrheadings} and \Macro{clearscrplain} deletes -all fields of the appropriate \PValue{plain} page style, -\Macro{clearscrheadfoot} sets all fields of both page styles on -empty contents. +If one wants to redefine both the page style \PValue{scrheadings} and +the corresponding \PValue{plain} page style, frequently one must empty +some already occupied page elements. Since one rarely fills all items +with new content, in most cases several instructions with empty +parameters are necessary. With the help of these three instructions +the quick and thorough deletion is possible. While +\Macro{clearscrheadings} only deletes all fields of the page style +\PValue{scrheadings}, and \Macro{clearscrplain} deletes all fields of +the corresponding \PValue{plain} page style, \Macro{clearscrheadfoot} +sets all fields of both page styles to empty. \begin{Example} - If one wants to reset the page style to the default \KOMAScript{} settings, - independent from the actual configuration, only these three commands are - sufficient. + If one wants to reset the page style to the default {\KOMAScript} + settings, independent of the actual configuration, only these three + commands are sufficient: \begin{lstlisting} \clearscrheadfoot \ohead{\headmark} \ofoot[\pagemark]{\pagemark} \end{lstlisting} - Without the commands \Macro{clearscrheadfoot}, \Macro{clearscrheadings} and - \Macro{clearscrplain} 6 commands with 9 empty arguments are required. +Without the commands \Macro{clearscrheadfoot}, +\Macro{clearscrheadings} and \Macro{clearscrplain}, 6 commands with 9 +empty arguments would be required: \begin{lstlisting} \ihead[]{} \chead[]{} @@ -357,8 +356,8 @@ empty contents. \cfoot[]{} \ofoot[\pagemark]{\pagemark} \end{lstlisting} - Of course, assuming a special configuration some of them can - be dropped.% +Of course, for a specific configuration, some of them could be +dropped.% \end{Example}% % \EndIndex{Cmd}{clearscrheadings}% @@ -372,22 +371,21 @@ empty contents. \EndIndex{Cmd}{ifoot}\EndIndex{Cmd}{cfoot}\EndIndex{Cmd}{rfoot}% \EndIndex{Cmd}{lofoot}\EndIndex{Cmd}{cofoot}\EndIndex{Cmd}{rofoot}% -In previous examples two commands already have been used, which -haven't been introduced yet. Now, the description of these -commands shall follow. +In the previous examples two commands were used which have not been +introduced yet. The description of these commands follows. \begin{Declaration} \Macro{leftmark}\\ \Macro{rightmark} \end{Declaration}% \BeginIndex{Cmd}{leftmark}\BeginIndex{Cmd}{rightmark}% -These two instructions make it possible to access the running headlines, -which are normally meant for the left or for the right page. These two -instruction are not made available by scrpage or scrpage2, but directly -by the \LaTeX{} kernel. If in this section running headline of the -left side or the right page are mentioned, -then the contents of \Macro{leftmark} or \Macro{rightmark} -is meant. +These two instructions make it possible to access the running +headings, which are normally meant for the left or for the right +page. These two instruction are not made available by +\Package{scrpage2}, but directly by the {\LaTeX} kernel. When in this +section running headings of the left page or the right page are +mentioned, this refers to the contents of \Macro{leftmark} or +\Macro{rightmark}, respectively. % \EndIndex{Cmd}{leftmark}\EndIndex{Cmd}{rightmark}% @@ -395,9 +393,9 @@ is meant. \begin{Declaration} \Macro{headmark} \end{Declaration}% -This command gives access to the content of running heads. -In contrast to \Macro{leftmark} and \Macro{rightmark}, one -need not regard the proper assignment to left or right page. +This command gives access to the content of running headings. In +contrast to \Macro{leftmark} and \Macro{rightmark}, one need not +regard the proper assignment to left or right page. \EndIndex{Cmd}{headmark} \BeginIndex{Cmd}{pagemark} @@ -405,10 +403,11 @@ need not regard the proper assignment to left or right page. \Macro{pagemark} \end{Declaration}% This command returns the formatted page number. The formatting can be -controlled by \Macro{pnumfont} introduced in -\autoref{sec:scrpage.basics.format}, \autopageref{desc:scrpage.macro.pnumfont} -or by \Macro{setkomafont} if a newer version \KOMAScript{} is used, see -\autoref{sec:maincls.font}. +controlled by \Macro{pnumfont}, introduced in +\autoref{sec:scrpage.basics.format}, +\autopageref{desc:scrpage.macro.pnumfont}, which \Macro{pagemark} +heeds automatically. Alternatively, \Macro{setkomafont} can be used if +a {\KOMAScript} class is used (see \autoref{sec:maincls.font}). % the last describtion \setkomafont ... is only fill-text \EndIndex{Cmd}{pagemark} @@ -417,121 +416,119 @@ or by \Macro{setkomafont} if a newer version \KOMAScript{} is used, see \Option{useheadings} \end{Declaration}% \phantomsection\label{desc:scrpage.pagestyle.useheadings}% -The package \Package{scrpage2} is meant primarily for the fact that the -supplied styles are used or own styles are defined. However it can be -necessary to shift back also to the style provided by the document class. It -would be obvious to do this with \Macro{pagestyle}\PParameter{headings}, but -this has however the disadvantage that commands \Macro{automark} and -\Macro{manualmark} discussed in the following do not function as expected. -For this reason one should shift back to the original styles using -\Macro{pagestyle}\PParameter{useheadings}. Such a switching has then no -effect on it whether one operates with manual or automatic running headlines. +The package \Package{scrpage2} is meant primarily for use of the +supplied styles or for defining one's own styles. However, it may be +necessary to shift back also to a style provided by the document +class. It might appear that this should be done with \Macro{page + style}\PParameter{headings}, but this has the disadvantage that +commands \Macro{automark} and \Macro{manualmark}, to be discussed +shortly, do not function as expected. For this reason one should +shift back to the original styles using \Macro{page + style}\PParameter{useheadings}, which chooses the correct page +styles automatically for both manual and automatic running headings. % \EndIndex{Cmd}{pagestyle}\EndIndex{Pagestyle}{useheadings} -\subsection{Manual and Automatic Headings} +\subsection{Manual and Running Headings} \label{sec:scrpage.basics.mark} % \automark \manualmark % -Usually there is a \emph{my}-version of the \PValue{headings}-style. If such -a style is active, then the running headlines are updated no longer -automatically. With \Package{scrpage2} another path is taken. Whether the -running headlines are living or not, determines the instructions -\Macro{automark} and \Macro{manualmark}. The default can be also already -influenced while the loading of the package with the options \Option{automark} -and \Option{manualmark}, see \autoref{sec:scrpage.basics.options}, -\autopageref{desc:scrpage.option.automark}. +Usually there is a \emph{my}-version of the \PValue{headings} +page style. If such a page style is active, then the running headings +are no longer updated no longer automatically and become manual +headings. With \Package{scrpage2} a different path is taken. Whether +the headings are running or manual is determined by the instructions +\Macro{automark} and \Macro{manualmark}, respectively. The default +can be set already while loading of the package, with the options +\Option{automark} and \Option{manualmark} (see +\autoref{sec:scrpage.basics.options}, +\autopageref{desc:scrpage.option.automark}). \BeginIndex{Cmd}{manualmark} \begin{Declaration} \Macro{manualmark} \end{Declaration}% -As the name already clarifies, \Macro{manualmark} switches off the updating -of the running headlines. It is left to the user to provide for -updating or for contents of the running headlines. -For that purpose the instructions \Macro{markboth}\IndexCmd{markboth} -und \Macro{markright}\IndexCmd{markright} are available. +As the name suggests, \Macro{manualmark} switches off the updating of +the running headings and makes them manual. It is left to the user to +update and provide contents for the headings. For that purpose the +instructions \Macro{markboth}\IndexCmd{markboth} and +\Macro{markright}\IndexCmd{markright} are available. \EndIndex{Cmd}{manualmark} \BeginIndex{Cmd}{automark} \begin{Declaration} \Macro{automark}\OParameter{right page}\Parameter{left page} \end{Declaration}% -The macro \Macro{automark} however activates the automatic updating. -For the two parameters the designations of the document level -are to be used, whose title in appropriate place is to appear. -Valid values for the parameters are: +The macro \Macro{automark} activates the automatic updating, that is, +running headings. For the two parameters the designations of the +document sectioning level whose title is to appear in appropriate +place are to be used. Valid values for the parameters are: \PValue{part}\ChangedAt{2.2}{\Package{scrpage2}}, \PValue{chapter}, \PValue{section}, \PValue{subsection}, \PValue{subsubsection}, -\PValue{paragraph}, \PValue{subparagraph}. -For most of the classes usage of \PValue{part} will not produce -the expected results. So far only \KOMAScript\ classes from version~2.9s -up are known to support this value. - -The optional argument \PName{right page} is meant understandably only for -two-sided documents. -In the one-sided case you should normally not use it. -With the help of the option \Option{autooneside} one can also adjust -that the optional argument in one-sided mode is ignored automatically, -see \autoref{sec:scrpage.basics.options}, -\autopageref{desc:scrpage.option.autooneside}. +\PValue{paragraph}, and \PValue{subparagraph}. For most of the +classes use of \PValue{part} will not produce the expected result. So +far only {\KOMAScript} classes from version~2.9s up are known to +support this value. + +The optional argument \PName{right page} is understandably meant only +for two-sided documents. In the one-sided case one should normally not +use it. With the help of the option \Option{autooneside} one can also +set that the optional argument in one-sided mode is ignored +automatically (see \autoref{sec:scrpage.basics.options}, +\autopageref{desc:scrpage.option.autooneside}). % \begin{Example} -Assuming that the document uses a \emph{book} class, -which topmost section level is \emph{chapter}, -then after a preceding \Macro{manualmark} + Assuming that the document uses a \emph{book} class, whose topmost + section level is \emph{chapter}, then after a preceding + \Macro{manualmark} \begin{lstlisting} \automark[section]{chapter} \end{lstlisting} -restores the original behaviour. -If one prefers one of the lower section levels in running head -following can be used. +restores the original behaviour. If one prefers lower section levels +in running headings, the following can be used: \begin{lstlisting} \automark[subsection]{section} \end{lstlisting} How useful the last declaration is, everybody has to decide -for oneself. +for themselves. \end{Example} \begin{Explain} -The data of the headings is set by the command -\Macro{markboth}\IndexCmd{markboth} for the top-most -section levels, for the lower levels -\Macro{markright}\IndexCmd{markright} or -\Macro{markleft}\IndexCmd{markleft} are used. -These commands are called indirectly by the sectioning commands. -The macro \Macro{markleft} is provided by the package -\Package{scrpage2}. -Its definition is similar to \Macro{markright} originating from -the \LaTeX{} kernel. -Although \Macro{markleft} is not defined as an internal command, -the direct use is not recommended. + For the upper section level, the data of the headings is set by the + command \Macro{markboth}\IndexCmd{markboth}, while that for the + lower section level by \Macro{markright}\IndexCmd{markright} or + \Macro{markleft}\IndexCmd{markleft}. These commands are called + indirectly by the sectioning commands. The macro \Macro{markleft} + is provided by the package \Package{scrpage2} and is defined + similarly to \Macro{markright} in the {\LaTeX} kernel. Although + \Macro{markleft} is not defined as an internal command, the direct + use is not recommended. \end{Explain} \EndIndex{Cmd}{automark} -\subsection{Formatting of Heading and Footing} +\subsection{Formatting of Header and Footer} \label{sec:scrpage.basics.format} % \headfont \pnumfont % \setheadwidth \setfootwidth % \set(head|foot)(top|sep|bot)line -In the previous paragraph it concerned mainly contentwise things. Is -not sufficient naturally, in order to satisfy the formative -ambitions. Therefore it is to turn in this paragraph exclusive therefore. +The previous section concerned itself mainly with the contents of the +header and footer. This is of course not sufficient to satisfy +formative ambitions. Therefore we devote this section exclusively to +this topic. % \BeginIndex{Cmd}{headfont}\BeginIndex{Cmd}{pnumfont} \begin{Declaration} \Macro{headfont}\\ \Macro{pnumfont} \end{Declaration}% -The command \Macro{headfont} contains the commands -which determine the formatting of head and foot lines. -The style of the page number defines the command -\Macro{pnumfont}. +The command \Macro{headfont} contains the commands which determine the +font of header and footer lines. The style of the page number is +defined by the command \Macro{pnumfont}. \begin{Example} -If, for example, one wants the head and foot to be typeset in bold -sans-serif and the page number in a slanted style, then it can be -used the configuration: + If, for example, one wants the header and footer to be typeset in + bold sans serif, and the page number in a slanted serif style, then + one can use the following definitions: \begin{lstlisting} \renewcommand{\headfont}{\normalfont\sffamily\bfseries} \renewcommand{\pnumfont}{\normalfont\rmfamily\slshape} @@ -539,15 +536,15 @@ used the configuration: \end{Example} \EndIndex{Cmd}{headfont}\EndIndex{Cmd}{pnumfont} % -Since version 2.8p of the \KOMAScript{} classes a new -configuration scheme is implemented. -If \Package{scrpage2} is used together with these classes then -it is recommended to setup font attributes the way described -in \autoref{sec:maincls.font}. +From version 2.8p of the {\KOMAScript} classes a new unified user +interface scheme is implemented for font attributes. If +\Package{scrpage2} is used together with one of these classes, then it +is recommended to set up font attributes in the manner described in +\autoref{sec:maincls.font}. \begin{Example} -This interfaces implements the command \Macro{setkomafont} -in order to configure the font attributes. -The previous definition can then be written as: + Instead of \Macro{renewcommand} the command \Macro{setkomafont} + should be used to configure the font attributes. The previous + definitions can then be written as: \begin{lstlisting} \setkomafont{pagehead}\normalfont\sffamily\bfseries} \setkomafont{pagenumber}{\normalfont\rmfamily\slshape} @@ -559,14 +556,13 @@ The previous definition can then be written as: \Macro{setheadwidth}\OParameter{shift}\Parameter{width}\\ \Macro{setfootwidth}\OParameter{shift}\Parameter{width} \end{Declaration}% -Normally the widths of heading and footing line -correspond to the width of the text body. -The commands \Macro{setheadwidth} and \Macro{setfootwidth} enable the -user to adapt in a simple manner the widths to his needs. -The mandatory argument \PName{width} takes up the value for the width -of the page head or foot, -\PName{shift} is a longitudinal dimension for the shift of the -appropriate item toward the outside page edge. +Normally the widths of header and footer lines correspond to the width +of the text body. The commands \Macro{setheadwidth} and +\Macro{setfootwidth} enable the user to adapt in a simple manner the +widths to his needs. The mandatory argument \PName{width} takes the +value of the desired width of the page header or footer, while +\PName{shift} is a length parameter by which amount the appropriate +item is shifted toward the outside page edge. For the most common situations the mandatory argument \PName{width} accepts the following symbolic values: @@ -574,24 +570,25 @@ accepts the following symbolic values: \item[\PValue{paper}] the width of the paper \item[\PValue{page}] the width of the page \item[\PValue{text}] the width of the text body -\item[\PValue{textwithmarginpar}] the width of the text body including margin. -\item[\PValue{head}] the current head width -\item[\PValue{foot}] the current foot width +\item[\PValue{textwithmarginpar}] the width of the text body including margin +\item[\PValue{head}] the current header width +\item[\PValue{foot}] the current footer width \end{labeling} -The difference between \PValue{paper} and \PValue{page} is, that -\PValue{page} means the width of the paper less the binding correction. -This only applies if the package \Package{typearea}\IndexPackage{typearea} -is used (see \autoref{cha:typearea}). -Without \Package{typearea} both values are equal. +The difference between \PValue{paper} and \PValue{page} is that +\PValue{page} means the width of the paper less the binding correction +if the package \Package{typearea}\IndexPackage{typearea} is used (see +\autoref{cha:typearea}). Without \Package{typearea} both values are +identical. \begin{Example} -The layout of the \emph{\LaTeX\,Companion}, the head-line projects -into the margin, can be obtained with: + Assume that one wants a layout like that of \emph{The + {\LaTeX}\,Companion}, where the header projects into the + margin. This can be obtained with: \begin{lstlisting} \setheadwidth[0pt]{textwithmarginpar} \end{lstlisting} % -and looks on an odd page like this: +which appears like this on an odd page: % \begin{XmpTopPage} \XmpHeading{10,25}{85} @@ -600,33 +597,33 @@ and looks on an odd page like this: \XmpMarginNote{83,11.8} \end{XmpTopPage} % -If the foot-line shall have the same width and alignment, then -two ways are possible. The first simply repeats the settings -for the foot-line: +If the footer line should have the same width and alignment, then two +ways to set this up are possible. The first way simply repeats the +settings for the case of the footer line: \begin{lstlisting} \setfootwidth[0pt]{textwithmarginpar} \end{lstlisting} % In the second way the symbolic value \PValue{head} is used, since the -head has already the desired settings. +header already has the desired settings. \begin{lstlisting} \setfootwidth[0pt]{head} \end{lstlisting} \end{Example} -If no \PName{shift} is indicated, -i.e. without the optional argument, then -the heading or the foot appears symmetrically on the page arranged. -A value for the \PName{shift} is determined automatically, which -corresponds to the current page shape. +If no \PName{shift} is indicated, i.\,e., without the optional argument, +then the header or footer appears arranged symmetrically on the page. +In other words, a value for the \PName{shift} is determined +automatically to correspond to the current page shape. % \begin{Example} -According to the previous example the optional argument is abandoned: + Continuing with the previous example, we remove the optional + argument: \begin{lstlisting} \setheadwidth{textwithmarginpar} \end{lstlisting} % -and looks on an odd page like this: +which appears like this on an odd page: % \begin{XmpTopPage} \XmpHeading{5,25}{85} @@ -636,10 +633,9 @@ and looks on an odd page like this: \end{XmpTopPage} \end{Example} -As to be seen, the heading is now shifted inward, while the -heading width has not changed. -The shift is calculated in a way that the configuration of the typearea -become visible also here. +As can be seen, the header is now shifted inward, while the header +width has not changed. The shift is calculated in a way that the +configuration of the typearea become visible also here. % \EndIndex{Cmd}{setheadwidth}\EndIndex{Cmd}{setfootwidth} @@ -651,66 +647,66 @@ become visible also here. \Macro{setfootsepline}\OParameter{length}\Parameter{thickness}\OParameter{commands}\\ \Macro{setfootbotline}\OParameter{length}\Parameter{thickness}\OParameter{commands} \end{Declaration}% -According to the configuration of head and foot there are -commands to modify the lines above and below the head and foot. +Corresponding to the size configuration parameters of header and +footer there are commands to modify the lines above and below the +header and footer. \begin{labeling}[\,--]{\Macro{setfootsepline}} -\item[\Macro{setheadtopline}] configures the line above the head -\item[\Macro{setheadsepline}] configures the line below the head -\item[\Macro{setfootsepline}] configures the line above the foot -\item[\Macro{setfootbotline}] configures the line below the foot +\item[\Macro{setheadtopline}] configures the line above the header +\item[\Macro{setheadsepline}] configures the line below the header +\item[\Macro{setfootsepline}] configures the line above the footer +\item[\Macro{setfootbotline}] configures the line below the footer \end{labeling} -The mandatory argument \PName{thickness} determines, -how strongly the line is drawn. -The optional argument \PName{length} accepts the same symbolic values as -\PName{width} with \Macro{setheadwidth}, as also a normal length expression. -As long as in the document \PName{length} value was not assigned to the -optional argument, the appropriate line length adapts automatically -the width of the heading or the foot. - -Use \PValue{auto} in the length argument to restore this -automatism for the length of a line. - -The\ChangedAt{2.2}{\Package{scrpage2}} -optional argument \PName{commands} may be used to specify additional commands -to be executed before the respective line is drawn. -For example such commands could be used for changing the +The mandatory argument \PName{thickness} determines how strongly the +line is drawn. The optional argument \PName{length} accepts the same +symbolic values as \PName{width} for \Macro{setheadwidth}, as well as +also a normal length expression. As long as the optional argument +\PName{length} is not assigned a value, the appropriate line length +adapts automatically the width of the header or the footer. + +Use \PValue{auto} in the length argument to restore this automation +for the length of a line. + +The\ChangedAt{2.2}{\Package{scrpage2}} optional argument +\PName{commands} may be used to specify additional commands to be +executed before the respective line is drawn. For example, such +commands could be used for changing the color\Index{header>color}\Index{footer>color}\Index{color>in - header}\Index{color>in footer} of that line. -When using a \KOMAScript\ class you could also use -\Macro{setkomafont}\IndexCmd{setkomafont} to specify commands -for one of the elements + header}\Index{color>in footer} of the line. When using a +{\KOMAScript} class you could also use +\Macro{setkomafont}\IndexCmd{setkomafont} to specify commands for one +of the elements \FontElement{headtopline}\IndexFontElement{headtopline}, \FontElement{headsepline}\IndexFontElement{headsepline}, \FontElement{footsepline}\IndexFontElement{footsepline}, -\FontElement{footbottomline}\IndexFontElement{footbottomline}, -\FontElement{footbotline}\IndexFontElement{footbotline}. -These could be extended by adding \Macro{addtokomafont}\IndexCmd{addtokomafont}. -See \autoref{sec:maincls.font} for details on the \Macro{setkomafont} and -\Macro{addkomafont} commands. +\FontElement{footbottomline}\IndexFontElement{footbottomline}, or +\FontElement{footbotline}\IndexFontElement{footbotline}. These can +then be extended via \Macro{addtokomafont}\IndexCmd{addtokomafont}. +See \autoref{sec:maincls.font} for details on the \Macro{setkomafont} +and \Macro{addkomafont} commands. \begin{Declaration} \XMacro{setheadtopline}\OParameter{\upshape\PValue{auto}}\Parameter{\upshape\PValue{current}}\\ \XMacro{setheadtopline}\OParameter{\upshape\PValue{auto}}\Parameter{}\\ \XMacro{setheadtopline}\OParameter{\upshape\PValue{auto}}\Parameter{}\OParameter{} \end{Declaration}% -The arguments shown here for the command \Macro{setheadtopline}, -are of course valid for the other three configuration commands, too. +The arguments shown here for the command \Macro{setheadtopline} are of +course valid for the other three configuration commands too. If the mandatory parameter has the value \PValue{current} or has been -left empty then the line height is not changed. -This may be used to modify the length of the line without changing its height. +left empty, then the line thickness is not changed. This may be used +to modify the length of the line without changing its thickness. -\PName{commands} is an optional argument, if omitted all command setting -will remain active that might have been specified before, while using -an empty \PName{commands} argument will revoke any previously valid -commands. +If the optional argument \PName{commands} is omitted, then all command +settings that might have been specified before will remain active, +while an empty \PName{commands} argument will revoke any previously +valid commands. \begin{Example} -If the head for example is to be contrasted by a strong line of 2\,pt -above and a normal line of 0.4\,pt between head and body, it can be -achieved with: + If the header, for example, is to be contrasted by a strong line of + 2\,pt above and a normal line of 0.4\,pt between header and body, + one can achieve this with: \begin{lstlisting} \setheadtopline{2pt} \setheadsepline{.4pt} @@ -724,19 +720,19 @@ achieved with: \XmpMarginNote{83,11.8} \end{XmpTopPage} -To specify that this line is to be drawn also e.\,g. in red color you +To specify that this line is to be drawn also, e.\,g., in red color, you would change the commands like this: \begin{lstlisting} \setheadtopline{2pt}[\color{red}] \setheadsepline{.4pt}[\color{red}] \end{lstlisting} -In this sample as well as in the following one line color is activated -by applying the syntax of the \Package{color}\IndexPackage{color} package, -so this package must be loaded of course. Since \Package{scrpage2} comes -without built-in color handling any package providing color support -may be used. +In this example, as well as in the following one, line color is +activated by applying the syntax of the +\Package{color}\IndexPackage{color} package, so this package must of +course be loaded. Since \Package{scrpage2} comes without built-in +color handling, any package providing color support may be used. -\KOMAScript\ classes also support the following way of color specification: +{\KOMAScript} classes also support the following way of color specification: \begin{lstlisting} \setheadtopline{2pt} \setheadsepline{.4pt} @@ -744,7 +740,7 @@ may be used. \setkomafont{headsepline}[\color{red}] \end{lstlisting} -The automatic adjustment of the head and foot width is illustrated +The automatic adjustment to the header and footer width is illustrated in the following example: \begin{lstlisting} \setfootbotline{2pt} @@ -763,11 +759,11 @@ in the following example: \end{XmpBotPage} \end{Example} -Now not everybody will like the alignment of the line above -the foot, instead one will expect the line left-aligned. -This can only be achieved with a global package option, which -will be described together with other package option -in the next \autoref{sec:scrpage.basics.options}. +Now not everyone will like the alignment of the line above the footer; +instead, one would expect the line to be left-aligned. This can only +be achieved with a global package option, which will be described +together with other package options in the next +\autoref{sec:scrpage.basics.options}. \EndIndex{Cmd}{setheadtopline}\EndIndex{Cmd}{setheadsepline} \EndIndex{Cmd}{setfootseptline}\EndIndex{Cmd}{setfootbotline} @@ -786,15 +782,14 @@ in the next \autoref{sec:scrpage.basics.options}. \Option{footinclude}\\ \Option{footexclude} \end{Declaration}% -These options intend whether the page-header or that page-footing -are reckoned in with the page-body for the calculation of the type-area. -The adjustments necessary by the use of these parameters -are made by the package -\Package{typearea} (see \autoref{sec:typearea.options}), if this -package is loaded after \Package{scrpage2}. -Important is here that on use of a \KOMAScript{} class -these options must be indicated for the document class and not -for \Package{scrpage2}, in order to obtain an effect. +These options determine whether the page header or the page footer are +considered as part of the page body for the calculation of the type +area. The adjustments necessary by the use of these parameters are +made by the package \Package{typearea} (see +\autoref{sec:typearea.options}), if this package is loaded after +\Package{scrpage2}. Important here is that when using a {\KOMAScript} +class, these options must be given for the document class and not for +the package \Package{scrpage2}, in order to be effective. % \EndIndex{Option}{headinclude}\EndIndex{Option}{footinclude} \EndIndex{Option}{headexclude}\EndIndex{Option}{footexclude} @@ -804,40 +799,38 @@ for \Package{scrpage2}, in order to obtain an effect. \BeginIndex{Option}{footsepline}\BeginIndex{Option}{plainfootsepline} \BeginIndex{Option}{footbotline}\BeginIndex{Option}{plainfootbotline} \begin{Declaration} -\Option{headtopline} und \Option{plainheadtopline}\\ -\Option{headsepline} und \Option{plainheadsepline}\\ -\Option{footsepline} und \Option{plainfootsepline}\\ -\Option{footbotline} und \Option{plainfootbotline} +\Option{headtopline} and \Option{plainheadtopline}\\ +\Option{headsepline} and \Option{plainheadsepline}\\ +\Option{footsepline} and \Option{plainfootsepline}\\ +\Option{footbotline} and \Option{plainfootbotline} \end{Declaration}% -A basic adjustment for the lines under and over heading and footing -can be made with these options. -These adjustments are considered then as default to all -page styles defined with \Package{scrpage2}. -If one of these options is used, then a line thickness -is used by 0.4\,pt. - -Since there is an appropriate \PValue{plain}-style to the page style -\PValue{scrheadings}, with the \Option{plain\dots}-options also the -appropriate line of the plain style can be configured. -These \Option{plain}-options work however only, even if the -corresponding option without plain are activated. -Thus \Option{plainheadtopline} shows no effect without the +Basic adjustment of the lines under and over header and footer can be +made with these options. These adjustments are then considered the +default for all page styles defined with \Package{scrpage2}. If one +of these options is used, then a line thickness 0.4\,pt is set. + +Since there is a corresponding \PValue{plain} page style to the +page style \PValue{scrheadings}, the corresponding line in the plain +style can also be configured with the \Option{plain\dots} options. +These \Option{plain} options do however work only if the corresponding +options without \Option{plain} are activated. Thus, +\Option{plainheadtopline} shows no effect without the \Option{headtopline} option set. -With these options it is to be noted that the appropriate page part, -heading or footing, is reckoned in with the text-area -for the calculation of the type-area in case a line has been activated. -This means, if with \Option{headsepline} the separation-line -between heading and text is activated, then the packge \Package{typearea} -calculates the type-area in such a way that the page-header -is part of the text block automatically. - -The conditions for the options of the preceding paragraph, apply also to -this automatism. That means that the package \Package{typearea} -must be loaded to scrpage2, or that on use of a \KOMAScript{} class, -the options \Option{headinclude} and \Option{footinclude} -must be set explicitly with \Macro{documentclass} in order to -transfer heading or footing line in the text-area. +With these options, it is to be noted that the appropriate page part, +header or footer, is considered as a part of the text area for the +calculation of the type area in case a line has been activated. This +means that, if the separation line between header and text is +activated with \Option{headsepline}, then the package +\Package{typearea} calculates the type area in such a way that the +page header is part of the text block automatically. + +The conditions for the options of the preceding paragraph apply also +to this automation. That means that the package \Package{typearea} +must be loaded after \Package{scrpage2}, or that on use of a +{\KOMAScript} class, the options \Option{headinclude} and +\Option{footinclude} must be set explicitly with \Macro{documentclass} +in order to transfer header or footer line in the text area. % \EndIndex{Option}{headtopline}\EndIndex{Option}{plainheadtopline} \EndIndex{Option}{headsepline}\EndIndex{Option}{plainheadsepline} @@ -854,15 +847,14 @@ transfer heading or footing line in the text-area. \Option{olines} \end{Declaration}% % -The definition of the line lengths can lead to an -undesired adjustment, since -the line is centered in the heading or footing area. -With the package options presented here, this specification can be -modified for all page styles defined with \Package{scrpage2}. -The option \Option{ilines} sets the adjustment in such a -way that the lines align to the inside edge. -The option \Option{clines} behaves like the standard adjustment and -\Option{olines} aligns at the outside edge. +With the definition of the line lengths the case can arise where the +lengths are set correctly, but the justification is not as desired +because the line will be centered in the header or footer area. With +the package options presented here, this specification can be modified +for all page styles defined with \Package{scrpage2}. The option +\Option{ilines} sets the justification in such a way that the lines +align to the inside edge. The option \Option{clines} behaves like the +default justification, and \Option{olines} aligns at the outside edge. \begin{Example} The next example illustrates the influence of the @@ -875,8 +867,8 @@ The option \Option{clines} behaves like the standard adjustment and \setfootwidth[0pt]{textwithmarginpar} \end{lstlisting} - Only the use of the option \Option{ilines} leads to the different - result shown below: +The mere use of the option \Option{ilines} leads to the different +result shown below: \begin{XmpBotPage} \XmpHeading{10,18}{85} \thinlines\XmpRule{10,21}{70} @@ -884,8 +876,8 @@ The option \Option{clines} behaves like the standard adjustment and \XmpSetText[\XmpBotText]{10,33} \XmpMarginNote{83,24} \end{XmpBotPage} - In contrast to the default configuration the separation line - between text and foot is now left-aligned not centered.% +In contrast to the default configuration, the separation line between +text and footer is now left-aligned, not centered.% \end{Example}% \EndIndex{Option}{ilines}\EndIndex{Option}{clines}\EndIndex{Option}{olines}% @@ -896,51 +888,48 @@ The option \Option{clines} behaves like the standard adjustment and \Option{automark}\\ \Option{manualmark} \end{Declaration}% -These options set the adjustment at the beginning of the document -whether automatic updating of the running headlines takes place. -The option \Option{automark} switches the automatic updating on, -\Option{manualmark} deactivates it. -Without use of one of the two options the adjustment is preserved, -which was valid while the loading of the package. +These options set at the beginning of the document whether to use +running headings or manual ones. The option \Option{automark} +switches the automatic updating on, \Option{manualmark} deactivates +it. Without the use of one of the two options, the setting which was +valid when the package was loaded is preserved, . % \begin{Example} - One loads the package \Package{scrpage2} directly after the document class - \Class{scrreprt} without any package options. + You load the package \Package{scrpage2} directly after the document class + \Class{scrreprt} without any package options: \begin{lstlisting} \documentclass{scrreprt} \usepackage{scrpage2} \end{lstlisting} - Since the default page style of \Class{scrreprt} is \PValue{plain}, - this page style is also active yet. - Futhermore \PValue{plain} means manual headings. - If one now activates the page style \PValue{scrheadings} with +Since the default page style of \Class{scrreprt} is \PValue{plain}, +this page style is also now still active. Futhermore, \PValue{plain} +means manual headings. If one now activates the page style +\PValue{scrheadings} with \begin{lstlisting} \pagestyle{scrheadings} \end{lstlisting} - then the manual headings are always active. +then the manual headings are nevertheless still active. - If one uses the document class \Class{scrbook} instead, then after: +If you instead use the document class \Class{scrbook}, then after \begin{lstlisting} \documentclass{scrbook} \usepackage{scrpage2} \end{lstlisting} - the page style \PValue{headings} is active and the running headings - are updated automatically. - Switching to the page style \PValue{scrheadings} keeps this - setting present. - The marking-commands of \Class{scrbook} continue to be used. +the page style \PValue{headings} is active and the running headings are +updated automatically. Switching to the page style +\PValue{scrheadings} keeps this setting active. The marking commands +of \Class{scrbook} continue to be used. - However, the use of +However, the use of \begin{lstlisting} \usepackage[automark]{scrpage2} \end{lstlisting} - activates the automatic update of the running heading independent - from the used document class. - The option does not effect the used page style \PValue{plain} of - the class \Class{scrreprt}. - The headings are not visible until the page style has been changed to - \PValue{scrheadings}\IndexPagestyle{scrheadings}, - \PValue{useheadings} or another self-defined page style with headings.% +activates running headings independently of the used document class. +The option does not of course affect the used page style \PValue{plain} +of the class \Class{scrreprt}. The headings are not visible until the +page style is changed to +\PValue{scrheadings}\IndexPagestyle{scrheadings}, \PValue{useheadings} +or another user-defined page style with headings.% \end{Example}% \EndIndex{Option}{automark}\EndIndex{Option}{manualmark}% @@ -949,8 +938,8 @@ which was valid while the loading of the package. \Option{autooneside} \end{Declaration}% This option ensures that the optional parameter of -\Macro{automark}\IndexCmd{automark} will be ignored automatically -in one-side mode. See the explanation of the command +\Macro{automark}\IndexCmd{automark} will be ignored automatically in +one-sided mode. See also the explanation of the command \Macro{automark} in \autoref{sec:scrpage.basics.mark}, \autopageref{desc:scrpage.macro.automark}. \EndIndex{Option}{autooneside} @@ -960,17 +949,16 @@ in one-side mode. See the explanation of the command \Option{komastyle}\\ \Option{standardstyle} \end{Declaration}% -These options determine the kind of the pre-defined page style -\PValue{scrheadings}. -The option \Option{komastyle} takes up a configuration like -the \KOMAScript{} classes. -This is the default for \KOMAScript{} classes and can this way -also be set for other classes. - -A configuration expected from the standard classes can be -defined using option \Option{standardstyle}. -Automatically the option \Option{markuppercase} will be -activated, but only if option \Option{markusedcase} is not given. +These options determine the look of the predefined page style +\PValue{scrheadings}. The option \Option{komastyle} configures a look +like that of the {\KOMAScript} classes. This is the default for +{\KOMAScript} classes and can in this way also be set for other +classes. + +The option \Option{standardstyle} configures a page style as it is +expected by the standard classes. Furthermore, the option +\Option{markuppercase} will be activated automatically, but only if +option \Option{markusedcase} is not given. \EndIndex{Option}{komastyle}\EndIndex{Option}{standardstyle} \BeginIndex{Option}{markuppercase}\BeginIndex{Option}{markusedcase} @@ -978,48 +966,44 @@ activated, but only if option \Option{markusedcase} is not given. \Option{markuppercase}\\ \Option{markusedcase} \end{Declaration}% -The package \Package{scrpage2} has -to modify internal commands, which are used by document structuring -commands, in order to get the function of \Macro{automark} working. -Since some classes, in contrast to the \KOMAScript{} classes, -write the headings in uppercase letters, \Package{scrpage2} -has to know how the used document class represents the headings. - -Option \Option{markuppercase} shows \Package{scrpage2} that -the document class uses uppercase letters. -If the document class does not represent the headings in -uppercase letters the option \Option{markusedcase} should -be given. -These options are not suitable to force a representation, thus -unexpected effects may occur, if the given option does not match -the behaviour of the document class. +In order to achieve the functionality of \Macro{automark}, the package +\Package{scrpage2} modifies internal commands which are used by the +document structuring commands to set the running headings. Since some +classes, in contrast to the {\KOMAScript} classes, write the headings +in uppercase letters, \Package{scrpage2} has to know how the used +document class sets the headings. + +Option \Option{markuppercase} shows \Package{scrpage2} that the +document class uses uppercase letters. If the document class does not +set the headings in uppercase letters, then the option +\Option{markusedcase} should be given. These options are not suitable +to force a representation; thus, unexpected effects may occur if the +given option does not match the actual behaviour of the document +class. \EndIndex{Option}{markuppercase}\EndIndex{Option}{markusedcase} \begin{Declaration} \Option{nouppercase} \end{Declaration}% \BeginIndex{Option}{nouppercase}% -In the previous paragraph about \Option{markuppercase} and -\Option{markusedcase} it has been already stated that some -document classes represent the running headings\Index{heading} in -uppercase letters using the commands -\Macro{MakeUppercase} or \Macro{uppercase}. -Setting the option \Option{nouppercase} allows to disable these -both commands. -The option \Option{nouppercase} only is valid as long page styles -defined by \Package{scrpage2} are used, including -\PValue{scrheadings} and its appropriate \PValue{plain} page style. - -The applicated method is very brutal and can cause that desired -changes of normal letters to uppercase letters -\Index{uppercase letters} do not occur. -Since these cases appear not frequently the option \Option{nouppercase} -is a useful solution. +In the previous paragraph dealing with \Option{markuppercase} and +\Option{markusedcase}, it has been already stated that some document +classes set the running headings\Index{heading} in uppercase letters +using the commands \Macro{MakeUppercase} or \Macro{uppercase}. +Setting the option \Option{nouppercase} allows disabling both these +commands in the headers and footers. However, this is valid only for +page styles defined by \Package{scrpage2}, including +\PValue{scrheadings} and its corresponding \PValue{plain} page style. + +The applied method is very brutal and can cause that desired changes +of normal letters to uppercase letters \Index{uppercase letters} do +not occur. Since these cases do not occur frequently, the option +\Option{nouppercase} usually affords a useful solution. \begin{Example} -If a document uses the standard class \Class{book}\IndexClass{book}, -but the uppercase headings are not desired, then the preamble of -the document could start with: + Your document uses the standard class \Class{book}\IndexClass{book}, + but you do not want the uppercase headings but mixed case + headings. Then the preamble of your document could start with: \begin{lstlisting} \documentclass{book} \usepackage[nouppercase]{scrpage2} @@ -1033,7 +1017,7 @@ the document could start with: In some cases not only classes but also packages set the running headings in uppercase letters. Also in these cases the option \Option{nouppercase} should be able -to switch back to the normal non-uppercase headings. +to switch back to the normal mixed case headings. \EndIndex{Option}{nouppercase} \section{Defining Own Page Styles}\label{sec:scrpage.UI} @@ -1041,62 +1025,62 @@ to switch back to the normal non-uppercase headings. % \subsection{The Interface for Beginners}\label{sec:scrpage.UI.user} % \deftripstyle -\BeginIndex{Cmd}{deftripstyle}\Index{page style} +\BeginIndex{Cmd}{deftripstyle}\Index{page>style} -Now one would not always be bound only to the provided page styles, -but moreover there will be the wish to define own page styles. -Sometimes there will be a special need, since a specific -\emph{Corporate Identity} requires the declaration of own page styles. -The easiest way to deal with is: +Now one would not like to remain bound to only the provided page +styles, but may wish to define one's own page styles. Sometimes there +will be a special need, since a specific \emph{Corporate Identity} may +require the declaration of its own page styles. The easiest way to +deal with this is: \begin{Declaration} \Macro{deftripstyle}\Parameter{name}% \OParameter{LO}\OParameter{LI}% \Parameter{HI}\Parameter{HC}\Parameter{HO}% \Parameter{FI}\Parameter{FC}\Parameter{FO} \end{Declaration}% -The parameters have the following meaning: +The individual parameters have the following meanings: \begin{labeling}[\,--]{\PName{Name}} -\item[\PName{name}] the name of the page style, in order to activate them +\item[\PName{name}] the name of the page style, in order to activate it using the command \Macro{pagestyle}\Parameter{name} \item[\PName{LO}] the thickness of the outside lines, - i.e. the line above the head - and the line below the foot (optional) + i.\,e., the line above the header + and the line below the footer (optional) \item[\PName{LI}] the thickness of the separation lines, - i.e. the line below the head + i.\,e., the line below the header and the line above the foot (optional) -\item[\PName{HI}] contents of the inside box in the page head for two-side - layout or left for one-side layout -\item[\PName{HC}] contents of the centered box in the page head -\item[\PName{HO}] contents of the outside box in the page head for two-side - layout or right for one-side layout -\item[\PName{FI}] contents of the inside box in the page foot for two-side - layout or left for one-side layout -\item[\PName{FC}] contents of the centered box in the page foot -\item[\PName{FO}] contents of the outside box in the page foot for two-side - layout or right for one-side layout +\item[\PName{HI}] contents of the inside box in the page header for two-sided + layout or left for one-sided layout +\item[\PName{HC}] contents of the centered box in the page header +\item[\PName{HO}] contents of the outside box in the page header for two-sided + layout or right for one-sided layout +\item[\PName{FI}] contents of the inside box in the page footer for two-sided + layout or left for one-sided layout +\item[\PName{FC}] contents of the centered box in the page footer +\item[\PName{FO}] contents of the outside box in the page footer for two-sided + layout or right for one-sided layout \end{labeling} -The command \Macro{deftripstyle} surely represents the simplest -possibility of defining page styles. -Unfortunately also restrictions are connected with since in a -page range with one via deftripstyle defined page style -no modification of the lines above and below heading and footing -can take place. +The command \Macro{deftripstyle} definitely represents the simplest +possibility of defining page styles. Unfortunately, there are also +restrictions connected with this, since in a page range using a page +style defined via deftripstyle, no modification of the lines above and +below header and footer can take place. \begin{Example} -Assuming a two-side layout, where the running headings are placed inside. -Furthermore the document title, here "`Report"`, shall be placed outside -in the head, the page number is centered in the foot. + Assume a two-sided layout, where the running headings are placed on + the inside. Furthermore, the document title, here ``Report'', shall + be placed outside in the header, the page number shall be centered + in the footer. \begin{lstlisting} \deftripstyle{TheReport}% {\headmark}{}{Report}% {}{\pagemark}{} \end{lstlisting} -Shall moreover the lines above the head and below the foot be -drawn with a thickness of 2\,pt and the text body be separated ->from head and foot with 0.4\,pt lines, then the definition has to -be extended. +If moreover the lines above the header and below the footer shall be +drawn with a thickness of 2\,pt, and the text body be separated from +header and footer with 0.4\,pt lines, then the definition has to be +extended: \begin{lstlisting} \deftripstyle{TheReport}[2pt][.4pt]% {\headmark}{}{Report}% @@ -1142,110 +1126,107 @@ be extended. % \defpagestyle \newpagestyle \providepagestyle \renewpagestyle \BeginIndex{Cmd}{defpagestyle}\BeginIndex{Cmd}{newpagestyle} \BeginIndex{Cmd}{renewpagestyle}\BeginIndex{Cmd}{providepagestyle} -\Index{page style} -Simple page styles, how they can be defined with \Macro{deftripstyle}, -are rare according to experience. -Either a professor requires that the thesis looks in -such a way like its own, and who wants to contradict -it seriously, or a company would like that the half -financial department emerges in the page footing. -No problem, the solution is: +\Index{page>style} +Simple page styles, as they can be defined with \Macro{deftripstyle}, +are fairly rare according to experience. Either a professor requires +that the thesis looks like his or her own\,---\,and who seriously wants +to argue against such a wish?\,---\,or a company would like that half the +financial accounting emerges in the page footer. No problem, the +solution is: % \begin{Declaration} -\Macro{defpagestyle}\Parameter{name}\Parameter{head-definition}\Parameter{foot-definition}\\ -\Macro{newpagestyle}\Parameter{name}\Parameter{head-definition}\Parameter{foot-definition}\\ -\Macro{renewpagestyle}\Parameter{name}\Parameter{head-definition}\Parameter{foot-definition}\\ -\Macro{providepagestyle}\Parameter{name}\Parameter{head-definition}\Parameter{foot-definition} +\Macro{defpagestyle}\Parameter{name}\Parameter{header definition}\Parameter{footer definition}\\ +\Macro{newpagestyle}\Parameter{name}\Parameter{header definition}\Parameter{footer definition}\\ +\Macro{renewpagestyle}\Parameter{name}\Parameter{header definition}\Parameter{footer definition}\\ +\Macro{providepagestyle}\Parameter{name}\Parameter{header definition}\Parameter{footer definition} \end{Declaration}% These four commands give full access to the capabilities of -\Package{scrpage2} according to define page styles. -Their structure is indentical, they differ only the manner of working. +\Package{scrpage2} to define page styles. Their structure is +indentical, they differ only in the manner of working. \begin{labeling}[\,--]{\Macro{providepagestyle}} -\item[\Macro{defpagestyle}] defines always a new pagestyle. +\item[\Macro{defpagestyle}] defines a new page style. If a page style with this name already exists it will be overwritten. -\item[\Macro{newpagestyle}] defines a new pagestyle. +\item[\Macro{newpagestyle}] defines a new page style. If a page style with this name already exists a error message will be given. -\item[\Macro{renewpagestyle}] redefines a pagestyle. -If apage style with this name does not exist a error message will be given. -\item[\Macro{providepagestyle}] defines a new pagestyle, -but only if there is no page style with that name already present. +\item[\Macro{renewpagestyle}] redefines a page style. +If a page style with this name does not exist a error message will be given. +\item[\Macro{providepagestyle}] defines a new page style only if there is no page style with that name already present. \end{labeling} -The syntax of the four commands is explained on command -\Macro{defpagestyle} examplary. +Using \Macro{defpagestyle} as an example, the syntax of the four +commands is explained below. \begin{labeling}[\,--]{\PName{head definition}} \item[\PName{name}] the name of the page style for \Macro{pagestyle}\Parameter{name} -\item[\PName{head-definition}] the declaration of the heading consisting +\item[\PName{header definition}] the declaration of the header, consisting of five element; elements in round parenthesis are optional:\\ \AParameter{ALL,ALT}\Parameter{EP}\Parameter{OP}\Parameter{OS}\AParameter{BLL,BLT} -\item[\PName{foot-definition}] the declaration of the footing consisting +\item[\PName{footer definition}] the declaration of the footer, consisting of five element; elements in round parenthesis are optional:\\ \AParameter{ALL,ALT}\Parameter{EP}\Parameter{OP}\Parameter{OS}\AParameter{BLL,BLT} \end{labeling} -It can be seen, that head and foot declaration are identical. -The parameters have the following meaning: +As can be seen, header and footer declaration have identical +structure. The individual parameters have the following meanings: \begin{labeling}[\,--]{\PName{OLD}} -\item[\PName{ALL}] above line length: (head = outside, foot = separation line) +\item[\PName{ALL}] above line length: (header = outside, footer = separation line) \item[\PName{ALT}] above line thickness \item[\PName{EP}] definition for \emph{even} pages \item[\PName{OP}] definition for \emph{odd} pages -\item[\PName{OS}] definition for \emph{one-side} layout -\item[\PName{BLL}] below line length: (head = separation line, foot = outside) +\item[\PName{OS}] definition for \emph{one-sided} layout +\item[\PName{BLL}] below line length: (header = separation line, footer = outside) \item[\PName{BLT}] below line thickness \end{labeling} -If the optional line-parameters are omitted, then the line behaviour keeps -configurable by the commands introduced in +If the optional line-parameters are omitted, then the line behaviour +remains configurable by the commands introduced in \autoref{sec:scrpage.basics.format}, \autopageref{desc:scrpage.macro.setheadtopline}. -The three elements \PName{EP}, \PName{OP} and \PName{OS} are boxes with -the width of page head or foot respectively. -The definition occur on the left side in the box, thus the space between -two text elements has to be stretched using \Macro{hfill}, in order to -write the first text element on the left edge \emph{and} the second text -element on the right edge. +The three elements \PName{EP}, \PName{OP} and \PName{OS} are boxes +with the width of page header or footer, as appropriate. The +corresponding definitions are set left-justified in the boxes. To set +something left- and right-justified into the boxes, the space between +two text elements can be stretched using \Macro{hfill}, in order to +write the first text element on the left edge \emph{and}: % \begin{lstlisting} {\headmark\hfill\pagemark} \end{lstlisting} If one would like a third text-element centered in the box, then an -extended definition must be used. -The commands \Macro{rlap} and \Macro{llap} simply write the given -arguments, but for \LaTeX{} they take no horizontal space. -Only this way the middle text is really centered. +extended definition must be used. The commands \Macro{rlap} and +\Macro{llap} simply write the given arguments, but for {\LaTeX} they +take up no horizontal space. Only in this way is the middle text +really centered. % \begin{lstlisting} {\rlap{\headmark}\hfill centered text\hfill\llap{\pagemark}} \end{lstlisting} -This and more examples of the expert's interface and other commands -provided by \Package{scpage2} follow now in the final example. +This and the use of the expert interface in connection with other +commands provided by \Package{scpage2} follows now in the final +example. \begin{Example} -This examples uses the document class \Class{scrbook}, which -means that the default page layout is two-side. -While the loading of the package \Package{scrpage2} the -options \Option{automark} and \Option{headsepline} are -given. -The first switches on the automatic update of running -headings, the second determines that a separation line between -head and text-body is drawn in the \PValue{scrheadings} page style. + This examples uses the document class \Class{scrbook}, which means + that the default page layout is two-sided. The package + \Package{scrpage2} is loaded with options \Option{automark} and + \Option{headsepline}. The first switches on the automatic update of + running headings, the second determines that a separation line + between header and text body is drawn in the \PValue{scrheadings} + page style. \begin{lstlisting} \documentclass{scrbook} \usepackage[automark,headsepline]{scrpage2} \end{lstlisting} -The expert's interface is used to define two page styles. -The page style \PValue{withoutLines} does not define any -line parameters. -The second page style \PValue{withLines} defines -a line thicknes of 1\,pt for the line above the head -and 0\,pt for the separation-line between head and text. +The expert interface is used to define two page styles. The page +style \PValue{withoutLines} does not define any line parameters. The +second page style \PValue{withLines} defines a line thicknes of 1\,pt +for the line above the header and 0\,pt for the separation line +between header and text. \begin{lstlisting} \defpagestyle{withoutLines}{% @@ -1273,24 +1254,22 @@ and 0\,pt for the separation-line between head and text. } \end{lstlisting} -At the document's begin the page style \PValue{scrheadings} -is choosen. -The command \Macro{chapter} starts a new chapter and sets -automatically the page style for this page to \PValue{plain}. - -The command \Macro{chead} shows how running headings can -be represented even on a \PValue{plain} page. -Running headings on chapter start-pages are not usual, -since in this case the page looses its emphasis-character. -Basically it is more important to show that a new -chapter starts here than that a section of this page has -a special title. +Right at the beginning of the document the page style +\PValue{scrheadings} is activated. The command \Macro{chapter} starts +a new chapter and automatically sets the page rstyle for this page to +\PValue{plain}. Even though not a prime example, the command +\Macro{chead} shows how running headings can be created even on a +\PValue{plain} page. However, in principle running headings on +chapter start-pages are to be avoided, since otherwise the special +character of the \PValue{plain} page style is lost. It is more +important to indicate that a new chapter starts here than that a +section of this page has a special title. \begin{Explain}% not important, only to enhance the paragraph breaking Instead of \Macro{leftmark} one would expect the use of \Macro{rightmark} in the parameter of \Macro{chead}, since the chapter starts on an even -page. But, because of internal \LaTeX{} definitions, +page. But, because of internal {\LaTeX} definitions, this does not work. It only returns an empty string. \end{Explain} \begin{lstlisting} @@ -1301,7 +1280,7 @@ this does not work. It only returns an empty string. \chead[\leftmark]{} \section{Main Laws} - Every system has an extensive condition unit called + Every system has an extensive state quantity called Energy. In a closed system the energy is constant. \end{lstlisting} @@ -1310,39 +1289,37 @@ this does not work. It only returns an empty string. \put(10,17){\normalsize\textbf{\sffamily 1.Thermodynamics}} \put(10,12){\textbf{\sffamily 1.1 Main Laws}} \XmpSetText[% - Every System has an extensive condition unit]{10,9} + Every System has an extensive state quantity]{10,9} \end{XmpTopPage} -After starting a new page the page style \PValue{scrheadings} -is active and thus the separation line below the heading is -visible. +After starting a new page the page style \PValue{scrheadings} is +active and thus the separation line below the header is visible. \begin{lstlisting} - There is a condition unit of a system, called entropy, - which temporal alteration consits of entropy stream - and entropy generation. + There is a state quatity of a system, called entropy, whose temporal + change consists of entropy flow and entropy generation. \end{lstlisting} \begin{XmpTopPage} \XmpHeading[\textsl{1. Thermodynamics}\hfill]{20,27}{70} \thinlines\XmpRule{20,25}{70} \XmpSetText[% There is a condition unit of a system, called entropy, - which temporal alteration consits of entropy stream + whose temporal change consists of entropy flow and entropy generation.]{20,20} \end{XmpTopPage} -After switching to the next page, the automatic update of the -running headings is disabled using \Macro{manualmark}. -The page style \PValue{withoutLines} becomes active. -Since no line parameters are given in the definition of this -page style, the default configuration is used, which draws -a separation line between head and text-body. +After switching to the next page, the automatic update of the running +headings is disabled using \Macro{manualmark}, and the page style +\PValue{withoutLines} becomes active. Since no line parameters are +given in the definition of this page style, the default configuration +is used, which draws a separation line between header and text body +because \Package{scrpage2} was called with \Option{headsepline}. \begin{XmpTopPage} \XmpHeading[\slshape Energy Conversion\hfill without lines]{10,27}{70} \thinlines\XmpRule{10,25}{70} \XmpSetText[% \textbf{\sffamily 1.2 Exergy and Anergy}\\ - While the transition of a system to an equilibrium state - with its environment the maximum work gainable is called + During the transition of a system to an equilibrium state + with its environment, the maximum work gainable is called exergy.]{10,21} \end{XmpTopPage} @@ -1350,19 +1327,18 @@ a separation line between head and text-body. \manualmark \pagestyle{withoutLines} \section{Exergy and Anergy}\markright{Energy Conversion} - While the transition of a system to an equilibrium state - with its environment the maximum work gainable is called + During the transition of a system to an equilibrium state + with its environment, the maximum work gainable is called exergy. \end{lstlisting} -At the next page of the document the page style \PValue{withLines} -is activated. -The line settings of its definition are taken in account and the -lines are drawn accordingly. +At the next page of the document, the page style \PValue{withLines} is +activated. The line settings of its definition are taken in account +and the lines are drawn accordingly. \begin{lstlisting} \pagestyle{mitLinien} \renewcommand{\headfont}{\itshape\bfseries} - The portion of an energy not conversable in exergie + The portion of an energy not convertible in exergy is named anergy \Var{B}. \[ B = U + T (S_1 - S_u) - p (V_1 - V_u)\] \end{document} @@ -1371,7 +1347,7 @@ lines are drawn accordingly. \XmpHeading[\itshape\bfseries with lines\hfill 1. Thermodynamics]{20,27}{70} \thicklines\XmpRule{20,29}{70} \XmpSetText[% - The portion of an energy not conversable in exergie + The portion of an energy not convertible in exergy is named anergy $B$. \[ B = U + T (S_1 - S_u) - p (V_1 - V_u)\] ]{20,20} \end{XmpTopPage} @@ -1383,14 +1359,17 @@ lines are drawn accordingly. % scrpage.cfg \BeginIndex{File}{scrpage.cfg} Before long the work with different page styles will establish a -common set of employed page styles, depending on taste and tasks. -In order to make the management of page styles easier, -\Package{scrpage2} reads after initialisation the file \File{scrpage.cfg}. -This file can contain a set of user-defined page styles, which -many projects can share. +common set of employed page styles, depending on taste and tasks. In +order to make the management of page styles easier and avoid +time-consuming copy operations each time a new project is started, +\Package{scrpage2} reads the file \File{scrpage.cfg} after +initialisation. This file can contain a set of user-defined page +styles which many projects can share. \EndIndex{File}{scrpage.cfg} \EndIndex{Package}{scrpage2} + %%% Local Variables: %%% mode: latex +%%% coding: iso-latin-1 %%% TeX-master: ../guide" %%% End: diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex index f4588061bca..3c61c55140a 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/typearea.tex @@ -45,11 +45,10 @@ % % ====================================================================== -\ProvidesFile{typearea.tex}[2006/09/12 KOMA-Script guide (chapter: typearea)] -% Date of translated german file: 2006-09-12 +\ProvidesFile{typearea.tex}[2007/09/27 KOMA-Script guide (chapter: typearea)] +\translator{Markus Kohm\and Gernot Hassenpflug} -% TODO: Translation of the changed equation array at 2.1, "Fundamentals of -% Page Layout". +% Date of translated german file: 2006-11-29 \chapter{Construction of the Page Layout with \Package{typearea}} \labelbase{typearea} @@ -57,51 +56,51 @@ \section{Fundamentals of Page Layout} \begin{Explain} - If you look at a single page of a book or other prints, you will see - that it consists of top, foot, left and right margins, a (running) - head area, the text block and a (running) foot area. Looking - closer, there is space between the head area and the text block - and between the text block and the foot area. The relations - between these areas are called \emph{page layout}. + If you look at a single page of a book or other printed materials, + you will see that it consists of top, foot, left and right margins, + a (running) head area, the text block and a (running) foot area. + Looking closer, there is space between the head area and the text + block and between the text block and the foot area. The relations + between these areas are called the \emph{page layout}. The literature offers and discusses different algorithms and heuristic approaches for constructing a good page layout. Often, - they are mentioning an approach which involves diagonals and their + mentioned is an approach which involves diagonals and their intersections. The result is a page where the text block - proportions relate to the proportions of the \emph{page}. In a + proportions are related to the proportions of the \emph{page}. In a single-sided document, the left and the right margin should have equal widths. The relation of the upper margin to the lower margin should be 1\(:\)2. In a double-sided document (e.\,g. a book) however, - the inner margin (the margin at the spine) should be the same as + the complete inner margin (the margin at the spine) should be the same as each of the two outer margins. In the previous paragraph, we mentioned and emphasized the - \emph{page}. Erroneously, often it is thought that the format of - the page would be the format of the paper. However, if you look at + \emph{page}. Erroneously, it is often thought that the format of + the page means the format of the paper. However, if you look at a bound document, it is obvious that part of the paper vanishes in - the binding and is not part of the visible page. But the format of - the paper is not important for the layout of a page, it is the + the binding and that is not part of the visible page. It is not the format of + the paper which is important in the layout of a page, it is the impression of the visible page to the reader. Therefore, it is - clear that the calculation if the page layout must account for the + clear that the calculation of the page layout must account for the ``lost'' paper in the binding and add this amount to the width of - the inner margin. This is called \emph{binding correction}. + the inner margin. This is called the \emph{binding correction}. The binding correction depends on the process of actually - producing the document and thus can not be calculated in general. + producing the document and thus cannot be calculated in general. Every production process needs its own parameter. In professional binding, this parameter is not too important since the printing is done on oversized paper which is then cropped to the right size. The cropping is done in a way so that the relations for the visible double-sided page are as explained above. - Now we know about the relation of the individual parts of a page. - However, we do not know about the width and the height of the - text block yet. Once we know one of these values, we can calculate + Now we know about the relations of the individual parts of a page. + However, we do not yet know about the width and the height of the + text block. Once we know one of these values, we can calculate all the other values from the paper format and the page format or the binding correction. \begin{eqnarray*} - \Var{textblock~heigth} : \Var{textblock~width} &=& + \Var{textblock~height} : \Var{textblock~width} &=& \Var{page~height} : \Var{page~width}\\ % \Var{page~width} &=& \Var{paper~width} - \Var{binding~correction}\\ @@ -116,9 +115,9 @@ \Var{half~inner~margin} &=& \frac{1}{2}\Var{outer~margin} + \Var{binding~correction} \\ \end{eqnarray*} - The values \Var{left~margin} and \Var{right~margin} are only - existent in a single-sided document while \Var{inner~margin} and - \Var{outer~margin} are only existent in a double-sided document. In + The values \Var{left~margin} and \Var{right~margin} only + exist in a single-sided document while \Var{inner~margin} and + \Var{outer~margin} only exist in a double-sided document. In these equations, we work with \Var{half~inner~margin} since the full inner margin belongs to a double-page. Thus, one page has half of the inner margin. @@ -133,17 +132,17 @@ \end{itemize} The importance of the font becomes clear once you think about serifs. Serifs are fine lines % !!! - finishing off the letters. Letters whose main strokes are running - orthogonal to the text line are disturbing the flow more than they - are leading the eye along the line. These letters have serifs at - the end of the vertical strokes, however, so the horizontal serifs + finishing off the letters. Letters whose main strokes run + orthogonal to the text line disturb the flow more than they + lead the eye along the line. Those letters have serifs at + the ends of the vertical strokes, however, so the horizontal serifs lead the eye horizontally too. In addition, it helps the eye to find the beginning of the next line. Thus, the line length for a - serif font can be slightly longer than for a non-serif font. + serif font can be slightly longer than for a sans serif font. - In \LaTeX{}, the line spacing is about 20\% of the font + In {\LaTeX}, the line spacing is about 20\% of the font size. With commands like \Macro{linespread} or, better, packages like - \Package{setspace} the line spacing can be changed. A wider line + \Package{setspace}, the line spacing can be changed. A wider line spacing helps the eye to follow the line. A very wide line spacing, on the other hand, disturbs reading because the eye has to move a wide distance between lines. Also, the reader gets @@ -151,34 +150,34 @@ gray value of the page gets spoiled. Still, with a wider line spacing, the lines can be longer. - Literature gives different values for good line lengths, depending + The literature gives different values for good line lengths, depending on the author. To some extent, this is due to the native language of the author. Since the eye jumps from word to word, short words make this task easier. Not considering language and font, a line - length of 60 to 70 letters including spaces and - punctuation is a usable compromise. This requires well-chosen line - spacing, but \LaTeX{}'s default is usually good enough. + length of 60 to 70 letters, including spaces and + punctuation, is a usable compromise. This requires well-chosen line + spacing, but {\LaTeX}'s default is usually good enough. Before looking at the actual construction of the page layout, - there are some minor things to know. \LaTeX{} doesn't start the + there are some minor things to know. {\LaTeX} doesn't start the first line of the text block at the upper edge of the text block, - but with a defined distance. Also, \LaTeX{} knows the commands + but with a defined distance from it. Also, {\LaTeX} knows the commands \Macro{raggedbottom} and \Macro{flushbottom}. \Macro{raggedbottom} specifies that the last line of a page should be positioned wherever it was calculated. This means that the position of this line can be different on each page, up to the height of one line. - In double-sided documents this is usually unwanted. + In double-sided documents this is usually undesirable. \Macro{flushbottom} makes sure that the last line is always at the - lower edge of the text block. To achieve this, \LaTeX{} sometimes + lower edge of the text block. To achieve this, {\LaTeX} sometimes needs to stretch vertical glue more than allowed. Paragraph skip is such a stretchable, vertical glue, even when set to zero. In - order not to stretch the paragraph skip on normal pages where it + order to not stretch the paragraph skip on normal pages where it is the only stretchable glue, the height of the text block should be a multiple of the height of the text line, including the distance from the upper edge of the text block to the first line. This concludes the introduction to page layout as handled by - \KOMAScript. Now, we can begin with the actual construction.\par + {\KOMAScript}. Now, we can begin with the actual construction.\par \end{Explain} @@ -200,9 +199,12 @@ the page is the text area. The width and the height of the text area result automatically from the number of rows and columns \Var{DIV}. Since the margins always need three rows/columns, \Var{DIV} must - be necessarily greater than three. + be necessarily greater than three. In order that the text area occupy at + least twice as much space as the margins, \Var{DIV} should really be equal + to or greater than 9. With this value, the construction is known as the + \emph{classical division factor of 9}. - In \KOMAScript, this kind of construction is implemented in the + In {\KOMAScript}, this kind of construction is implemented in the \Package{typearea} package. For A4 paper, \Var{DIV} is predefined according to the font size (see \autoref{tab:typearea.div}). If there is no binding correction (\(\Var{BCOR} = 0\Unit{pt}\)), the results @@ -224,20 +226,20 @@ \label{sec:typearea.circleConstruction} \begin{Explain} - In addition to the construction method previously described, a somewhat - more classical method can be found in the literature. Aim of this method is + In addition to the construction method previously described, a somewhat more + classical method can be found in the literature. The aim of this method is not only identical ratios in the page proportions, but it is considered - optimal when the height of the text block is the same a the width of the + optimal when the height of the text block is the same the width of the page. The exact method is described in \cite{JTsch87}. - A disadvantage of this late dark age method is that the width of - the text area is not dependent on the font anymore. Thus, one + A disadvantage of this late Dark Ages method is that the width of + the text area is no longer dependent on the font. Thus, one doesn't choose the text area to match the font, but the author or typesetter has to choose the font according to the text area. This can be considered a ``must''. In the \Package{typearea} package this construction is changed - slightly. By using a special (normally senseless) \Var{DIV} value + slightly. By using a special (normally meaningless) \Var{DIV} value or a special package option, a \Var{DIV} value is chosen to match the perfect values as closely as possible. See also \autoref{sec:typearea.options}.\par @@ -250,10 +252,10 @@ The package \Package{typearea} offers two different user interfaces to influence type area construction. The first method is to load the package with options. For information on how to load packages and to -give package options, please refer to the \LaTeX{} literature, e.g. +give package options, please refer to the {\LaTeX} literature, e.\,g. \cite{lshort} and \cite{latex:usrguide}, or the examples given here. Since the \Package{typearea} package is loaded automatically when -using the \KOMAScript{} main classes, the package options can be given +using the {\KOMAScript} main classes, the package options can be given as class options (see \autoref{sec:maincls.options}). \begin{Declaration} @@ -261,30 +263,30 @@ as class options (see \autoref{sec:maincls.options}). \end{Declaration}% \BeginIndex{Option}{BCOR}% With the \Option{BCOR}\PName{Correction} option you specify the -absolute value of the binding correction, i.e., the width of the area +absolute value of the binding correction, i.\,e., the width of the area that is used for the binding, thus ``lost'' from the paper width. This value will be used in the layout calculation automatically and will be added to the inner or left margin respectively. You can use -any valid \TeX{} unit for \PName{Correction}. +any valid {\TeX} unit for \PName{Correction}. \begin{Example} Assume you want to produce a financial report, which is to be printed on A4 paper and bound in a folder. The rim of the folder covers - \(7{,}5\Unit{mm}\). Since the report is thin, only an additional - \(0{,}75\Unit{mm}\) are lost by folding when leafing through the pages. You + \(7.5\Unit{mm}\). Since the report is thin, only an additional + \(0.75\Unit{mm}\) are lost by folding when leafing through the pages. You would use the following commands: \begin{lstlisting} \documentclass[a4paper]{report} \usepackage[BCOR8.25mm]{typearea} \end{lstlisting} - or, using a \KOMAScript-class: + or, using a {\KOMAScript} class: \begin{lstlisting} \documentclass[a4paper,BCOR8.25mm]{scrreprt} \end{lstlisting} \end{Example} -Please note: if you use one of the \KOMAScript{} classes, this option +Please note: if you use one of the {\KOMAScript} classes, this option must be given as a class option. If you use another class, this only works if the class has explicit support for typearea. So when using the standard classes, you need to give the option when you load @@ -301,11 +303,11 @@ the standard classes, you need to give the option when you load \Option{DIV}\PName{Factor} defines the number of stripes the page is split into when the page layout is constructed. The exact method can be found in \autoref{sec:typearea.divConstruction}, -but the most important thing is: the higher \PName{Factor}, the +but the most important thing is this: the higher \PName{Factor}, the bigger the resulting text area, and the smaller the margins. For \PName{Factor}, you can use any integer value larger than 4. Please note that depending on your other options a very high value -for \PName{Factor} can result in problems: For instance, in +for \PName{Factor} can result in problems: for instance, in extreme cases, the running title might be outside the actual page area. So if you use \Option{DIV}\PName{Factor}, it is your own responsibility to choose a typographically acceptable line length @@ -323,16 +325,16 @@ varying \Var{DIV} factors. Font size is not taken into account. & \multicolumn{2}{c|}{Text area} & \multicolumn{2}{c}{Margins}\\ \emph{DIV}& Width [mm] & Height [mm] & upper [mm] & inner [mm] \\ \midrule - 6 & 105,00 & 148,50 & 49,50 & 35,00 \\ - 7 & 120,00 & 169,71 & 42,43 & 30,00 \\ - 8 & 131,25 & 185,63 & 37,13 & 26,25 \\ - 9 & 140,00 & 198,00 & 33,00 & 23,33 \\ - 10 & 147,00 & 207,90 & 29,70 & 21,00 \\ - 11 & 152,73 & 216,00 & 27,00 & 19,09 \\ - 12 & 157,50 & 222,75 & 24,75 & 17,50 \\ - 13 & 161,54 & 228,46 & 22,85 & 16,15 \\ - 14 & 165,00 & 233,36 & 21,21 & 15,00 \\ - 15 & 168,00 & 237,60 & 19,80 & 14,00 \\ + 6 & 105.00 & 148.50 & 49.50 & 35.00 \\ + 7 & 120.00 & 169.71 & 42.43 & 30.00 \\ + 8 & 131.25 & 185.63 & 37.13 & 26.25 \\ + 9 & 140.00 & 198.00 & 33.00 & 23.33 \\ + 10 & 147.00 & 207.90 & 29.70 & 21.00 \\ + 11 & 152.73 & 216.00 & 27.00 & 19.09 \\ + 12 & 157.50 & 222.75 & 24.75 & 17.50 \\ + 13 & 161.54 & 228.46 & 22.85 & 16.15 \\ + 14 & 165.00 & 233.36 & 21.21 & 15.00 \\ + 15 & 168.00 & 237.60 & 19.80 & 14.00 \\ \bottomrule \end{tabular} \label{tab:typearea.typearea} @@ -342,8 +344,8 @@ varying \Var{DIV} factors. Font size is not taken into account. Imagine you are writing meeting minutes with the \Class{protocol}\footnote{The class \Class{protocol} is hypothetical. This manual considers the ideal case where you have - a special class for every use.}-class. The whole thing is supposed to - be double sided. In your company, the Bookman font in 12\Unit{pt} + a special class for every use.} class. The whole thing is supposed to + be double-sided. In your company, the Bookman font in 12\Unit{pt} is used. This standard PostScript font is activated in {\LaTeX} with the command \Macro{usepackage}\Parameter{bookman}. Bookman runs very wide, that means, the characters are wide in relation to its @@ -356,27 +358,27 @@ varying \Var{DIV} factors. Font size is not taken into account. \usepackage{bookman} \usepackage[DIV15]{typearea} \end{lstlisting} - After you are done you get told that the minutes are collected and - bound as a book by the end of the year. The binding is done as a - simple glue binding in a copy shop, since it is done just for ISO\,9000 - anyway and nobody will ever bother to look at the minutes again. For - binding you need \(12\Unit{mm}\) in average. So you change the options - for \Package{typearea} accordingly and use the ISO\,9000 document class: +After you are done you are told that the minutes will be collected and bound +as a book at the end of the year. The binding will be a simple glue binding +carried out in a copy shop, since it is done just for ISO\,9000 anyway and +nobody will ever bother to look at the minutes again. For binding you need +\(12\Unit{mm}\) in average. So you change the options for \Package{typearea} +accordingly and use the ISO\,9000 document class: \begin{lstlisting} \documentclass[a4paper,twoside]{iso9000p} \usepackage{bookman} \usepackage[DIV15,BCOR12mm]{typearea} \end{lstlisting} - Of course, you can also use a \KOMAScript{} class here: + Of course, you can also use a {\KOMAScript} class here: \begin{lstlisting} \documentclass[twoside,DIV15,BCOR12mm]{scrartcl} \usepackage{bookman} \end{lstlisting} The option \Option{a4paper} was omitted using class \Class{scrartcl}, - because it's the default at all \KOMAScript{} classes. + because it is the default for all {\KOMAScript} classes. \end{Example} % -Please note: if you use one of the \KOMAScript{} classes, \Option{BCOR} must +Please note: if you use one of the {\KOMAScript} classes, \Option{BCOR} must be given as a class option. If you use another class, this only works if the class has explicit support for typearea. So when using the standard classes, you need to give \Option{BCOR} when you load \Package{typearea}. You can use @@ -439,12 +441,12 @@ this case, instead of \Option{DIV}\PName{Factor} or \BeginIndex{Cmd}{typearea}% If you followed the examples till here, you'll ask yourself how one can make the calculation of \Var{DIV} depend on the selected -font when one uses one of the \KOMAScript{} classes. Then the +font when one uses one of the {\KOMAScript} classes. In that case the options to \Package{typearea} would have to be made before loading -the e.g. \Package{bookman} package. In this case, +the e.\,g. \Package{bookman} package. So \Package{typearea} could only calculate the page layout for the standard font, but not for the Bookman font which is really -used. After evaluating the options, \Package{typearea} +to be used. Therefore, after evaluating the options, \Package{typearea} calculates the page layout by using the \Macro{typearea}\OParameter{BCOR}\Parameter{DIV} command. Here, the chosen \Var{BCOR} value is given as an optional parameter and @@ -455,23 +457,23 @@ also call \Macro{typearea} explicitly in the preamble. \begin{Example} Let us assume again that we want to calculate a good page layout for the - Bookman font. We also want to use a \KOMAScript{} class. This is possible - using the \Macro{typearea}-command with \Option{DIVcalc} = 1 as - \PName{DIV}-parameter: + Bookman font. We also want to use a {\KOMAScript} class. This is possible + using the \Macro{typearea} command with \Option{DIVcalc} = 1 as + \PName{DIV} parameter: \begin{lstlisting} \documentclass[BCOR12mm,DIVcalc,twoside]{scrartcl} \usepackage{bookman} \typearea[12mm]{1}% same as class options above \end{lstlisting} Again option \Option{a4paper} was not used explicitly, because it's the - default of the \KOMAScript{} class \Class{scrartcl}. + default of the {\KOMAScript} class \Class{scrartcl}. \end{Example} It would be ridiculous if one had to use the -\Macro{typearea}-command with some pseudo-values, while the -\Option{DIV}-Option allows the use of \Option{DIVcalc} and +\Macro{typearea} command with some pseudo-values, while the +\Option{DIV} option allows the use of \Option{DIVcalc} and \Option{DIVclassic}. Thus the \Macro{typearea} also accepts -symbolic values for the parameter \PName{DIV} are listed at +symbolic values for the parameter \PName{DIV} which are listed in \autoref{tab:symbolicDIV}. \begin{table} @@ -486,10 +488,10 @@ symbolic values for the parameter \PName{DIV} are listed at \pventry{current}{re-calculate page layout with current value of \Var{DIV}.}% \pventry{default}{re-calculate page layout with default values for the - current page- and font size. If no default values exist, apply + current page and font size. If no default values exist, apply \PValue{calc}.}% \pventry{last}{re-calculate page layout using the same - \PName{DIV}-argument, which was set last time.}% + \PName{DIV} argument, which was set last time.}% \end{desctabular} \end{table} @@ -510,7 +512,7 @@ re-enter the current value. \begin{Example} Thus calculating a good page layout for the Bookman font and a - \KOMAScript-class is easy when we use symbolic parameter values for + {\KOMAScript} class is easy when we use symbolic parameter values for \PName{BCOR} and \PName{DIV}: \begin{lstlisting} \documentclass[BCOR12mm,DIVcalc,twoside]{scrartcl} @@ -529,7 +531,7 @@ re-enter the current value. \usepackage{bookman} \typearea[12mm]{11} \end{lstlisting} - In the end it is a matter of personal taste which of these solution you want + In the end it is a matter of personal taste which of these solutions you want to use. \end{Example} @@ -541,9 +543,9 @@ line spacing requires a re-calculation of page layout. \begin{Example} Assume you want to write a thesis and university regulations require a font size of 10\Unit{pt} with one and a half line spacing. {\LaTeX} uses by - default a line spacing of 2\Unit{pt} at font size 10\Unit{pt}. Thus a - stretch-factor of 1.25 is required. Let us also assume that binding - correction needs 12\Unit{mm}. Then you might use: + default a line spacing of 2\Unit{pt} at font size 10\Unit{pt} (a line + spacing of 1.2). Thus a stretch-factor of 1.25 is required. Let us also + assume that binding correction needs 12\Unit{mm}. Then you might use: \begin{lstlisting} \documentclass[10pt,twoside,% BCOR12mm,DIVcalc]{scrreprt} @@ -552,7 +554,7 @@ line spacing requires a re-calculation of page layout. \end{lstlisting}\IndexCmd{linespread} \Macro{typearea} automaticly calls \Macro{normalsize}. So it is not neccessary to use \Macro{selectfont} after \Macro{linespread} to activate - the changed line spacing before re-calclulation of the page layout. + the changed line spacing before re-calculation of the page layout. The same example again, using the \Package{setspace} package (see \cite{package:setspace}): @@ -563,7 +565,7 @@ line spacing requires a re-calculation of page layout. \onehalfspacing \typearea[current]{last} \end{lstlisting} - Using the \Package{setspace}-package simplifies things, because you no + Using the \Package{setspace} package simplifies things, because you no longer need to calculate the correct stretch-factor, and you no longer need the \Macro{selectfont} macro. @@ -592,12 +594,12 @@ line spacing requires a re-calculation of page layout. \begin{Explain} The command \Macro{typearea} is currently defined in such a way that it is possible to change the page layout in the middle of a text. This however - makes assumptions about the inner workings of the \LaTeX-kernel and changes + makes assumptions about the inner workings of the {\LaTeX} kernel and changes some internal values and definitions of that kernel. There is some probability, but no guarantee that this will also work in future versions of - \LaTeX. It must be assumed that this method will not give correct results - in \LaTeX3. However, as author of \KOMAScript{} I expect considerable - incompatibilities when we change to \LaTeX3.% + {\LaTeX}. It must be assumed that this method will not give correct results + in {\LaTeX}3. However, as author of {\KOMAScript} I expect considerable + incompatibilities when we change to {\LaTeX}3.% \end{Explain}% \EndIndex{Cmd}{typearea}% \EndIndex{Option}{DIVclassic}% @@ -640,8 +642,8 @@ notice, it will optically appear more like a part of the text body. This needs to be taken into account when calculating text layout. For the header this is even more complicated. The header frequently -contains running heads \Index[indexmain]{running head}. In case of -running heads with long chapter and section titles the header lines +contains running headings \Index[indexother]{running heading}. In case of +running headings with long chapter and section titles the header lines will be very long and appear to be part of the text body. This effect becomes even more significant when the header contains not only the chapter or section title but also the page number. With material on @@ -660,7 +662,7 @@ separation of text and header or footer, important is only the appearance when viewed out of focus. \end{Explain} -The \Package{typearea}-package can not make the decision whether +The \Package{typearea} package can not make the decision whether or not to count headers and footers to the text body or the border. Options \Option{headinclude} and \Option{footinclude} cause the header or footer to be counted as text, options @@ -668,7 +670,7 @@ cause the header or footer to be counted as text, options counted as border. If you are unsure about the correct setting, re-read above explanations. Default is usually \Option{headexclude} and \Option{footexclude}., but this can -change depending on \KOMAScript-class and \KOMAScript-packages used +change depending on {\KOMAScript} class and {\KOMAScript} packages used (see \autoref{sec:maincls.options} and \autoref{cha:scrpage}). % \EndIndex{Option}{headinclude}% @@ -686,10 +688,10 @@ Besides\ChangedAt{v2.8q}{\Class{scrbook}\and \Class{scrreprt}\and \Class{scrartcl}} documents where the head and foot is part of the text area, there are also documents where the margin-note area must be counted to the text body as well. The option \Option{mpinclude} does exactly this. The -effect is that one width-unit of the text-body is taken for the margin-note +effect is that one width-unit of the text body is taken for the margin-note area. Using option \Option{mpexclude}, the default setting, then the normal margin is used for the margin-note area. The width of that area is one or one -and a half width-unit, depending on whether one-side or two-side page layout +and a half width-unit, depending on whether one-sided or double-sided page layout has been chosen. The option \Option{mpinclude} is mainly for experts and so not recommended. @@ -701,7 +703,7 @@ not recommended. side where the text body is. Since ragged text gives no homogeneous optical impression the long lines can reach right into the normal margin. This can be done using option \Option{mpinclude} and by an enlargement of length - \Length{marginparwidth} after the type-area has been setup. The length can + \Length{marginparwidth} after the type area has been setup. The length can be easily enlarged with the command \Macro{addtolength}. How much the the length has to be enlarged depends on the special situation and it requires some flair. Therefore the option is primarily for experts. Of course one @@ -714,7 +716,7 @@ not recommended. Currently there is no option to enlarge the margin by a given amount. The only solution is that the option \Option{mpinclude} is not used, but after - the type-area has been calculated one reduces the width of the text-body + the type area has been calculated one reduces the width of the text body \Length{textwidth} and enlarges the margin width \Length{marginparwidth} by the same amount. Unfortunately, this can not be attended when automatic calculation of the \PName{DIV} value is used. In contrast @@ -737,21 +739,21 @@ particular of the header. This is achieved with the option the header. \Package{typearea} uses a default of 1.25. This is a compromise, large enough for underlined headers (see \autoref{sec:maincls.options}) and small enough that the -relative weight of the top border is not affected to much when +relative weight of the top border is not affected too much when the header is not underlined. Thus in most cases you may leave \Option{headlines} at its default value and adapt it only in special cases. \begin{Example} Assume that you want to use a header with two lines. Normally this would - result in a "`\texttt{overfull} \Macro{vbox}"' warning for each page. To - prevent this from hapening, the \Package{typearea}-package is told to + result in a ``\texttt{overfull} \Macro{vbox}'' warning for each page. To + prevent this from happening, the \Package{typearea} package is told to calculate an appropriate page layout: \begin{lstlisting} \documentclass[a4paper]{article} \usepackage[2.1headlines]{typearea} \end{lstlisting} - If you use a \KOMAScript{} class this must be given as a class option: + If you use a {\KOMAScript} class this must be given as a class option: \begin{lstlisting} \documentclass[a4paper,2.1headlines]{scrartcl} \end{lstlisting} @@ -759,7 +761,7 @@ special cases. lines is described in \autoref{cha:scrpage}. \end{Example} -If you use a \KOMAScript{} class, this option must be given as +If you use a {\KOMAScript} class, this option must be given as class option. With other classes this works only, if these classes explicitly supports \Package{typearea}. If you use the standard classes, the option must be given when loading \Package{typearea}. \Macro{PassOptionsToPackage} will @@ -772,12 +774,12 @@ work in both cases (see also \cite{latex:clsguide}). \end{Declaration}% \BeginIndex{Cmd}{areaset}% So far we have seen how a good or even very good page layout is -calculated and how the \Package{typearea}-package can support these +calculated and how the \Package{typearea} package can support these calculations, giving you at the same time the freedom to adapt the layout to your needs. However, there are cases where the text body has to fit exactly into specified dimensions. At the same time the borders should be well spaced and a binding correction should be -possible. The \Package{typearea}-package offers the command +possible. The \Package{typearea} package offers the command \Macro{areaset} for this purpose. As parameters this command accepts the binding correction and the width and height of the text body. Width and position of the borders will then be calculated @@ -787,7 +789,7 @@ where needed. \begin{Example} Assume a text, printed on A4 paper, should have a width of exactly 60 - characters of typewriter-font and a height of exactly 30 lines. This could + characters of typewriter font and a height of exactly 30 lines. This could be achieved as follows: \begin{lstlisting} \documentclass[a4paper,11pt]{article} @@ -823,7 +825,7 @@ values. If you have to do so you may use package \Package{geometry} (see \label{sec:typearea.paperTypes} \Index{paper format}% -The \LaTeX standard classes support the options \Option{a4paper}, +The {\LaTeX} standard classes support the options \Option{a4paper}, \Option{a5paper}, \Option{b5paper}, \Option{letterpaper}, \Option{legalpaper} and \Option{executivepaper}. \begin{Declaration} @@ -847,11 +849,11 @@ The \LaTeX standard classes support the options \Option{a4paper}, \BeginIndex{Option}{landscape} \BeginIndex{Cmd}{isopaper}% The three American formats are supported by \Package{typearea} -in the same way. In addition, all ISO-A-, ISO-B-, ISO-C- and -ISO-D-formats are supported and derived from their basic sizes A0, B0, +in the same way. In addition, all ISO A-, ISO B-, ISO C- and +ISO D-formats are supported and derived from their basic sizes A0, B0, C0 and D0. They may be selected directly with options \Option{a0paper}, \Option{a1paper} and so on. Landscape orientation is -selected with the \Option{landscape}-option just as in the standard +selected with the \Option{landscape} option just as in the standard classes. Alternatively the paper size can be adjusted with the macro @@ -860,7 +862,7 @@ text layout with \Macro{typearea} or \Macro{areaset}. I do not recommend the use of \Macro{isopaper}. \begin{Example} - Assume you want to print on ISO-A8 file cards in landscape + Assume you want to print on ISO A8 file cards in landscape orientation. Borders should be very small, no header or footer will be used. \begin{lstlisting} @@ -878,11 +880,11 @@ recommend the use of \Macro{isopaper}. \end{lstlisting} \end{Example} -All \Option{a\Var{X}paper}-, \Option{b\Var{X}paper}-, -\Option{c\Var{X}paper}- and \Option{d\Var{X}paper}-options need -to be given as class options when \KOMAScript{} classes are used. +All \Option{a\Var{X}paper}, \Option{b\Var{X}paper}, +\Option{c\Var{X}paper} and \Option{d\Var{X}paper} options need +to be given as class options when {\KOMAScript} classes are used. For other classes this works only if they support -\Package{typearea}. For the standard \LaTeX-classes these options +\Package{typearea}. For the standard {\LaTeX} classes these options need to be declared when \Package{typearea} is loaded. \Macro{PassOptionsToPackage} (see \cite{latex:clsguide}) works in both cases. @@ -933,33 +935,33 @@ define it befor calculating the text layout: \BeginIndex{Option}{dvips}% \BeginIndex{Option}{pdftex}% \BeginIndex{Option}{pagesize}% - These mechanisms will set internal \LaTeX{} dimensions to values that + These mechanisms will set internal {\LaTeX} dimensions to values that header, text body and footer can be printed on paper of the given - size. However, the specifications of the DVI-format\index{DVI} do + size. However, the specifications of the DVI format\index{DVI} do not allow the paper format to be specified. If DVI is translated directly into a low level printer language like PCL (Hewlett-Packard printers) or Esc-P (Epson), this is usually not important, because in all these cases the origin is the upper left corner. If however - the DVI-source is translated into languages like + the DVI source is translated into languages like PostScript\Index{PostScript} or PDF\Index{PDF}, that have an origin in a different position and also contain the paper size explicitly, - the required information is not available in the DVI-file. To solve - this problem the DVI-driver will use the default paper size, which - the user may set per option or in the \TeX-source. In case of the - DVI-driver \File{dvips} this can be done with a - \Macro{special}-command. For {pdf\TeX} two dimensions are set + the required information is not available in the DVI file. To solve + this problem the DVI driver will use the default paper size, which + the user may set per option or in the {\TeX} source. In case of the + DVI driver \File{dvips} this can be done with a + \Macro{special} command. For pdf{\TeX} two dimensions are set instead. \end{Explain} The option \Option{dvips} writes the paper size as a \Macro{special} -into the DVI-file. This macro is then evaluated by \File{dvips}. +into the DVI file. This macro is then evaluated by \File{dvips}. \Option{pdftex} on the other hand writes the paper size into the -pdf\TeX{} page register at the beginning of the document, so that the -correct paper size is used when the resulting PDF-file is viewed or +pdf{\TeX} page register at the beginning of the document, so that the +correct paper size is used when the resulting PDF file is viewed or printed. The option \Option{pagesize} is more flexible and uses the -correct mechanism if either a PDF- or DVI-file is produced. +correct mechanism if either a PDF or DVI file is produced. % \begin{Example} - Assume you want to create a DVI-file from a document and an + Assume you want to create a DVI file from a document and an online version in PDF. Then the preamble could look like this: \begin{lstlisting} \documentclass{article} @@ -967,8 +969,8 @@ correct mechanism if either a PDF- or DVI-file is produced. \end{lstlisting} If the file is run through {pdf\TeX} then the lengths \Macro{pdfpagewidth} and \Macro{pdfpageheight} will be set to - appropriate values. If on the other hand you create a DVI-file -- - either with {\LaTeX} or {pdf\LaTeX} -- a \Macro{special} will be + appropriate values. If on the other hand you create a DVI file\,---\, + either with {\LaTeX} or pdf{\LaTeX}\,---\,a \Macro{special} will be written to the beginning of the file. \end{Example}\IndexCmd{pdfpagewidth}\IndexCmd{pdfpageheight} \EndIndex{Option}{dvips}% @@ -983,27 +985,27 @@ correct mechanism if either a PDF- or DVI-file is produced. \end{Declaration}% \BeginIndex{Cmd}{ifpdfoutput}% Sometimes it would be nice if certain things would be done -differently in a file, depending on output format. \TeX{} normally -uses DVI as output format. With {pdf\TeX} however we now have the -option to create PDF-files directly. The command -\Macro{ifpdfoutput} is a branching command. If PDF-output is -active, the \PName{then} branch will be executed, if PDF-output +differently in a file, depending on output format. {\TeX} normally +uses DVI as output format. With pdf{\TeX} however we now have the +option to create PDF files directly. The command +\Macro{ifpdfoutput} is a branching command. If PDF output is +active, the \PName{then} branch will be executed, if PDF output is inactive or {pdf\TeX} is not used at all, the \PName{else} branch. \begin{Example} - As you may know {pdf\LaTeX} will produce a DVI-file instead of a - PDF-file, if the counter \Macro{pdfoutput} is assigned the value 0. + As you may know pdf{\LaTeX} will produce a DVI file instead of a + PDF file, if the counter \Macro{pdfoutput} is assigned the value 0. Only is the counter is assigned a value different from 0 output is switched to PDF. Since \Macro{pdfoutput} is unknown when {\LaTeX} is - used instead of {pdf\LaTeX}, \Macro{pdfoutput} can not be set to 0 - generally, if you want DVI-output. A simple solution to this problem + used instead of pdf{\LaTeX}, \Macro{pdfoutput} can not be set to 0 + generally, if you want DVI output. A simple solution to this problem is to execute following command: \begin{lstlisting} \ifpdfoutput{\pdfoutput=0}{} \end{lstlisting} This only works after loading \Package{typearea} package. If you - want the line above to be executed after af package, which set's - \Macro{pdfoutput} to 1 whenever the counter exist, you may combine + want the line above to be executed after a package, which sets + \Macro{pdfoutput} to 1 whenever the counter exists, you may combine it with the \Macro{AfterPackage}\IndexCmd{AfterPackage} command from \Package{scrlfile} package (see \autoref{cha:scrlfile}). \end{Example}\IndexCmd{pdfoutput} @@ -1014,7 +1016,7 @@ is inactive or {pdf\TeX} is not used at all, the Even before the packet options are used, \Package{typearea} will check for the presence of the file \File{typearea.cfg}\IndexFile{typearea.cfg} and, if found, load it. -Thus it is possble to define in this file the parameters for +Thus it is possible to define in this file the parameters for additional paper sizes. \begin{Declaration} @@ -1022,11 +1024,11 @@ additional paper sizes. \end{Declaration}% \BeginIndex{Cmd}{SetDIVList}% \begin{Explain}% - The \Macro{SetDIVList}-parameter was also intended for use in this - file. Befor the option \Option{DIVcalc} was introduced this was the - only possibility to define \Var{DIV}-values for different paper and + The \Macro{SetDIVList} parameter was also intended for use in this + file. Before the option \Option{DIVcalc} was introduced this was the + only possibility to define \Var{DIV} values for different paper and font sizes. This list consists of a number of values in curly - parenthesis. The leftmost value is the font size, \(10\Unit{pt}\), + parentheses. The leftmost value is the font size, \(10\Unit{pt}\), the next for \(11\Unit{pt}\), the third for \(12\Unit{pt}\) and so on. If you don't use \Macro{SetDIVList} the predefined \Macro{SetDIVList}% @@ -1044,7 +1046,7 @@ layout is recommended instead (see \section{Hints} \label{sec:typearea.tips} \begin{Explain} - In particular for thesis many rules exist that violate even the most + In particular for theses many rules exist that violate even the most elementary rules of typography. The reasons for such rules include typographical incompetence of those making them, but also the fact that they were originally meant for mechanical typewriters. With a typewriter or a @@ -1075,77 +1077,76 @@ layout is recommended instead (see {\LaTeX}. A fixed number of characters per line can be kept only when a non-proportional font is used. There are very few good non-proportional fonts around. Hardly a text typeset in this way looks really good. In many - cases font designers try to increase the serifes on the `i' or `l' to + cases font designers try to increase the serifs on the `i' or `l' to compensate for the different character width. This can not work and results - in a fragmented and agitated looking text. If you use {\LaTeX} for your + in a fragmented and agitated-looking text. If you use {\LaTeX} for your paper, some of these rules have to be either ignored or at least interpreted generously. For example you may interpret ``60 characters per line'' not as a fixed, but average or maximal value.% \end{Explain} -As executed, record regulations are usually meant to obtaining an -useful result even if the author does not know, what to be consider -thereby. Usefully means frequently: readable and correctable. In my -opinion the type-area of a text set with \LaTeX{} and the -\Package{typearea} package becomes well done from the beginning fair. -Thus if you are confronted with regulations, which deviate obviously -substantially from it, then I recommend to submit a text single dump -to the responsible person and inquire whether it is permitted to -supply the work despite the deviations in this form. If necessary the -type-area can be moderately adapted by modification of option -\Option{DIV}. I advise against use of \Macro{areaset} for this -purpose however. At worst you may use geometry package (see -\cite{package:geometry}), which is not part of \KOMAScript{}, or -change the type-area parameters of \LaTeX. You may find the values -determined by \Package{typearea} at the log file of your document. -Thus moderate adjustments should be possible. However absolutely make -sure that the proportions of the text area correspond approximate with -those the page with consideration of the binding correction. - -If it should be absolutely necessary to set the text -one-and-a-half-lined then you should not redefine -\Macro{baselinestretch} under any circumstances. Although this -procedure is recommended very frequently, it is however obsolet since -the introduction of \LaTeXe{} in 1994. Use at least the instruction +As executed, record regulations are usually intended to obtain a useable +result even if the author does not know what needs to be considered. Useable +means frequently: readable and correctable. In my opinion the type area of a +text set with {\LaTeX} and the \Package{typearea} package meets these criteria +well right from the beginning. Thus if you are confronted with regulations +which deviate obviously substantially from it, then I recommend to submit a +text single dump to the responsible person and inquire whether it is permitted +to supply the work despite the deviations in this form. If necessary the +type area can be moderately adapted by modification of option \Option{DIV}. I +advise against use of \Macro{areaset} for this purpose however. At worst you +may use geometry package (see \cite{package:geometry}), which is not part of +{\KOMAScript}, or change the type area parameters of {\LaTeX}. You may find the +values determined by \Package{typearea} in the log file of your document. +Thus moderate adjustments should be possible. However, make absolutely sure +that the proportions of the text area correspond approximately to those of the +page including consideration of the binding correction. + +If it should be absolutely necessary to set the text one-and-a-half-lined then +you should not redefine \Macro{baselinestretch} under any circumstances. +Although this procedure was recommended very frequently, it is obsolete since +the introduction of {\LaTeXe} in 1994. Use at least the instruction \Macro{linespread}. I recommend package \Package{setspace} (see -\cite{package:setspace}), which is not part of \KOMAScript. Also you -should use \Package{typearea} to calculate a new type-area after the -conversion of the line space. However you should switch back to the -normal line space for the title, better also for the -directories\,---\,as well as the bibliography and the index. The -\Package{setspace} package offers for this a special environment and -own instructions. +\cite{package:setspace}), which is not part of {\KOMAScript}. Also you should +use \Package{typearea} to calculate a new type area after the conversion of +the line spacing. However, you should switch back to the normal line spacing +for the title, preferably also for the table contents and various +listings\,---\,as well as the bibliography and the index. The +\Package{setspace} package offers for this a special environment and its own +instructions. The \Package{typearea} package even with option \Option{DIVcalc} calculates a very generous text area. Many conservative typographers will state that the resulting line length is still excessive. The -calculated \Var{DIV}-value may be found in the \File{log} file to the +calculated \Var{DIV} value may be found in the \File{log} file to the respective document. Thus you can select a smaller value easily after -the first \LaTeX{} run. - -The question is asked to me not rarely, why I actually talk section by -section about a type-area calculation, while it would be very many -simpler, only to give you a package, with which one can adjust the -edges as during a text processing. Often also one states, such a -package would be anyway the better solution, since everyone knew, how -good edges are to be selected, and the edges from {\KOMAScript} anyway -would not be well. I take the liberty of translating a suitable -quotation from \cite{TYPO:ErsteHilfe}. You may find the original -german words at the german scrguide. +the first {\LaTeX} run. + +The question is put to me not infrequently, why I actually talk +section after section about type area calculations, when it would be +very much simpler to merely give you a package with which one can +adjust the edges like during a text processing. Often also it is +stated that such a package would be anyway the better solution, since +everyone can judge how good edges are to be selected, and that the +edges calculated by {\KOMAScript} are anyway not that great. I take +the liberty of translating a suitable quotation from +\cite{TYPO:ErsteHilfe}. You may find the original German words in the +German scrguide. \begin{quote} \phantomsection\label{sec:typearea.tips.cite}% - \textit{The making by oneself is long usually, the results are often - doubtful, because layman typographers do not see, what is correct - and cannot not know, on what it important. Thus one gets - accustomed to false and bad typography.} [\dots] \textit{Now the - objection could come, typography is nevertheless taste thing. If - it concerned decoration, perhaps one could let apply the argument, - since it concerns however primarily information with typography, - errors cannot only disturb, but even cause damage.} + \textit{The making by oneself is quite widespread, the results are often + doubtful, because layman typographers do not see what is incorrect + and cannot not know what it important. Thus one gets + accustomed to wrong and poor typography.} [\dots] \textit{Now the + objection could be made that typography is nevertheless a taste thing. If + it concerned decoration, perhaps one could let that argument apply, + however, since it concerns primarily information with typography, + errors cannot only disturb, but may even cause damage.} \end{quote} %%% Local Variables: %%% mode: latex +%%% coding: iso-latin-1 %%% TeX-master: "../guide" %%% End: diff --git a/Master/texmf-dist/source/latex/koma-script/doc/german/guide-ngerman.tex b/Master/texmf-dist/source/latex/koma-script/doc/german/guide-ngerman.tex index 58a76d789cd..290fae9b95e 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/german/guide-ngerman.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/german/guide-ngerman.tex @@ -45,7 +45,7 @@ % % ====================================================================== % -\ProvidesFile{guide-ngerman.tex}[{2006/05/10 +\ProvidesFile{guide-ngerman.tex}[{2007/09/18 KOMA-Script guide language dependencies}] % % \section{Title} @@ -54,6 +54,7 @@ % \begin{macro}{\GuideTitle} % \begin{macro}{\GuideSubTitle} % \begin{macro}{\GuideAuthorHeadline} +% \begin{macro}{\GuideTranslatorHeadline} % \begin{macro}{\GuideWarrantyHeadline} % \begin{macro}{\GuideWarranty} % \begin{macro}{\GuideCopyright} @@ -64,6 +65,8 @@ \newcommand*{\GuideTitle}{\KOMAScript}% \newcommand*{\GuideSubTitle}{ein wandelbares \LaTeXe-Paket}% \newcommand*{\GuideAuthorHeadline}{Autoren des \KOMAScript-Pakets}% +\newcommand*{\GuideTranslatorHeadline}{An der deutschen Übersetzung dieser + Anleitung haben mitgewirkt: } \newcommand*{\GuideWarrantyHeadline}{Rechtliche Hinweise:}% \newcommand*{\GuideWarranty}{Die Autoren dieser Anleitung sind in ihrer Eigenschaft als Autoren dieser Anleitung nicht verantwortlich für die @@ -216,12 +219,26 @@ % \end{macro} % % \begin{macro}{\GuideVariable} -% The termo »variable«. +% The term »variable«. % \begin{macrocode} \newcommand*{\GuideVariable}{Variable} % \end{macrocode} % \end{macro} % +% \begin{macro}{\GuideAnd} +% The ``and'' at a list of two. +% \begin{macrocode} +\newcommand*{\GuideList}{ und } +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GuideListAnd} +% The ``and'' at a list of more than two. +% \begin{macrocode} +\newcommand*{\GuideListAnd}{ und } +% \end{macrocode} +% \end{macro} +% % % \section{Index} % @@ -426,9 +443,12 @@ % This is not realy a good place to put them~-- but better late than never: % \begin{macrocode} \hyphenation{% - Stan-dard-an-wei-sung Stan-dard-an-wei-sung-en + Back-slash + Brief-um-ge-bung Brief-um-ge-bun-gen Da-tei-na-me Da-tei-na-men Da-tei-na-mens Pa-pier-rand Pa-pier-ran-des + Stan-dard-an-wei-sung Stan-dard-an-wei-sun-gen + Unix Zei-len-um-bruch Zei-len-um-bruchs Zei-len-um-brü-che Zei-len-um-brü-chen } @@ -439,5 +459,5 @@ \endinput %%% Local Variables: %%% mode: doctex -%%% TeX-master: "guide" +%%% TeX-master: "../guide.tex" %%% End: diff --git a/Master/texmf-dist/source/latex/koma-script/doc/german/scrbookreportarticle.tex b/Master/texmf-dist/source/latex/koma-script/doc/german/scrbookreportarticle.tex index 0ea79bf083f..59261b7dd1a 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/german/scrbookreportarticle.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/german/scrbookreportarticle.tex @@ -45,7 +45,7 @@ % % ============================================================================ -\ProvidesFile{scrbookreportarticle.tex}[2007/03/02 KOMA-Script guide (chapter: +\ProvidesFile{scrbookreportarticle.tex}[2007/09/04 KOMA-Script guide (chapter: scrbook, scrreprt, scrartcl)] \chapter{Die Hauptklassen \Class{scrbook}, \Class{scrreprt}, \Class{scrartcl}} @@ -92,7 +92,7 @@ Optionen werden von den \KOMAScript-Klassen zusätzlich geboten. \Class{article} & \Class{scrartcl} \\%& \File{script\textunderscore s} \\ \Class{report} & \Class{scrreprt} \\%& \File{script} \\ \Class{book} & \Class{scrbook} \\%& \File{script} \\ - \Class{letter} & \Class{scrlettr} \\%& \File{script\textunderscore l} \\ + \Class{letter} & \Class{scrlttr2} \\%& \File{script\textunderscore l} \\ \bottomrule \end{tabular} \label{tab:maincls.overview} @@ -1027,7 +1027,7 @@ verwendet man die Form ohne Angabe eines Wertes, so wird statt des Abstandes der Kapiteleintrag selbst in die Verzeichnisse eingetragen. Diese Option kann per \Macro{KOMAoptions}\Parameter{chapteratlists} oder -\Macro{KOMAoption}\Parameter{chapteratlists=\PName{Wert}} auch innerhalb des +\Macro{KOMAoptions}\Parameter{chapteratlists=\PName{Wert}} auch innerhalb des Dokuments verändert werden. Sie hat dann Auswirkungen ab der nächsten Überschrift. Änderungen der Option werden jedoch erst nach dem übernächsten \LaTeX-Lauf in den Verzeichnissen sichtbar. @@ -1987,14 +1987,14 @@ jedoch nicht ausgegeben, sondern beeinflusst lediglich die Zählung. Sie sollten hier unbedingt eine ungerade Zahl wählen, da sonst die gesamte Zählung durcheinander gerät. Meiner Auf"|fassung nach gibt es nur zwei sinnvolle Anwendungen für das optionale Argument. Zum einen könnte man dem -Schmutztitel\Index[indexmain]{Schmutztitel} die logische Seitenzahl -1 geben, -um so die Seitenzählung erst ab der Haupttitelseite mit 1 zu beginnen. Zum -anderen könnte man mit einer höhere Seitenzahl beginnen, beispielsweise 3, 5 -oder 7, um so weitere Titelseiten zu berücksichtigen, die erst vom Verlag -hinzugefügt werden. Wird eine \emph{in-page}-Titelei verwendet, wird das -optionale Argument ignoriert. Dafür kann der Seitenstil einer solchen Titelei -durch Umdefinierung des Makros \Macro{titlepagestyle} verändert werden. Siehe -hierzu \autoref{sec:maincls.pageStyle}, +Schmutztitel\Index[indexmain]{Schmutztitel} die logische Seitenzahl \(-\)1 +geben, um so die Seitenzählung erst ab der Haupttitelseite mit 1 zu +beginnen. Zum anderen könnte man mit einer höhere Seitenzahl beginnen, +beispielsweise 3, 5 oder 7, um so weitere Titelseiten zu berücksichtigen, die +erst vom Verlag hinzugefügt werden. Wird eine \emph{in-page}-Titelei +verwendet, wird das optionale Argument ignoriert. Dafür kann der Seitenstil +einer solchen Titelei durch Umdefinierung des Makros \Macro{titlepagestyle} +verändert werden. Siehe hierzu \autoref{sec:maincls.pageStyle}, \autopageref{desc:maincls.macro.titlepagestyle}. Die folgenden Anweisungen führen nicht unmittelbar zum Setzen der @@ -2355,7 +2355,7 @@ und reicht für etwas mehr als 1,5 Stellen je Gliederungsebene. Sollte dies zu einem Problem werden, lässt sich über die Option \Option{tocleft} ein Verhalten einstellen, bei dem alle Einträge des Inhaltsverzeichnisses linksbündig untereinander gesetzt werden. Wie in -\autoref{sec:maincls.tocOptions}, \autopageref{desc:maincls.option.tocleft}) +\autoref{sec:maincls.tocOptions}, \autopageref{desc:maincls.option.tocleft} erläutert wird, werden dafür mehrere \LaTeX{}-Durchläufe benötigt. \begin{Explain} @@ -2377,18 +2377,15 @@ Anleitung ist mit den Voreinstellungen gesetzt und dient als Beispiel. \Counter{tocdepth} \end{Declaration}% \BeginIndex{Counter}{tocdepth}% -Normalerweise werden bei den Klassen \Class{scrbook} und -\Class{scrreprt} die Gliederungsebenen \Macro{part} bis -\Macro{subsection} und bei der Klasse \Class{scrartcl} die Ebenen -\Macro{part} bis \Macro{subsubsection} in das Inhaltsverzeichnis -aufgenommen. Gesteuert wird dies über den Zähler \Counter{tocdepth}. -Dabei steht der Wert -1 für \Macro{part}, 0 für -\Macro{chapter} und so weiter. Da bei \Class{scrartcl} die Ebene -\Macro{chapter} nicht existiert, beginnt bei dieser Klasse die Zählung -mit \Macro{part} bei 0. Durch Setzen oder Erhöhen oder Verringern des -Zählers kann bestimmt werden, bis zu welcher Gliederungsebene Einträge -in das Inhaltsverzeichnis erfolgen sollen. Dies ist übrigens bei den -Standardklassen ganz genauso. +Normalerweise werden bei den Klassen \Class{scrbook} und \Class{scrreprt} die +Gliederungsebenen \Macro{part} bis \Macro{subsection} und bei der Klasse +\Class{scrartcl} die Ebenen \Macro{part} bis \Macro{subsubsection} in das +Inhaltsverzeichnis aufgenommen. Gesteuert wird dies über den Zähler +\Counter{tocdepth}. Dabei steht der Wert \(-\)1 für \Macro{part}, 0 für +\Macro{chapter} und so weiter. Durch Setzen oder Erhöhen oder Verringern des +Zählers kann bestimmt werden, bis zu welcher Gliederungsebene Einträge in das +Inhaltsverzeichnis erfolgen sollen. Dies ist übrigens bei den Standardklassen +ganz genauso. Bei Verwendung des \Package{scrpage2}-Pakets\IndexPackage{scrpage2} (siehe \autoref{cha:scrpage}) muss man sich nicht die nummerischen @@ -2824,7 +2821,7 @@ nicht Varianten, sondern Gliederungsebenen bezeichnen. \iffalse Bei den Standardklassen gibt es keine weiteren Gliederungsbefehle. Es -existiert also insbesondere keine Anweisungen, mit denen man nicht +existieren also insbesondere keine Anweisungen, mit denen man nicht nummerierte Kapitel oder nicht nummerierte Abschnitte erzeugen kann, die ins Inhaltsverzeichnis aufgenommen werden und bei denen ein automatischer Kolumentitel erzeugt wird. @@ -2844,18 +2841,20 @@ automatischer Kolumentitel erzeugt wird. \BeginIndex{Cmd}{addsec}% \BeginIndex{Cmd}{addsec*}% {\KOMAScript} bietet über die Gliederungsbefehle der Standardklassen hinaus -die Anweisungen \Macro{addchap} und \Macro{addsec}. Diese ähneln bis auf die -fehlende Nummerierung sehr den Standardanweisungen \Macro{part}, -\Macro{chapter} und \Macro{section}. Sie erzeugen also sowohl einen -automatischen Kolumnentitel als auch einen Eintrag ins Inhaltsverzeichnis. Die -Sternvarianten \Macro{addchap*} und \Macro{addsec*} gleichen hingegen den +die Anweisungen \Macro{addpart}, \Macro{addchap} und \Macro{addsec}. Diese +ähneln bis auf die fehlende Nummerierung sehr den Standardanweisungen +\Macro{part}, \Macro{chapter} und \Macro{section}. Sie erzeugen also sowohl +einen automatischen Kolumnentitel als auch einen Eintrag ins +Inhaltsverzeichnis. + +Die Sternvarianten \Macro{addchap*} und \Macro{addsec*} gleichen hingegen den Standardanweisungen \Macro{chapter*} und \Macro{section*} mit einem winzigen aber wichtigen Unterschied: Die Kolumnentitel werden gelöscht. Dadurch wird der oben erwähnte Effekt veralteter Kolumnentitel ausgeschlossen. Stattdessen bleibt der Kolumnentitel auf Folgeseiten leer. \OnlyAt{\Class{scrartcl}}\Macro{addchap} und \Macro{addchap*} existieren -selbstverständlich nur bei Buch- und Berichtklassen, also bei \Class{scrbook} und \Class{scrreport}, nicht jedoch bei der -Artikelklasse \Class{scrartcl}. +selbstverständlich nur bei Buch- und Berichtklassen, also bei \Class{scrbook} +und \Class{scrreport}, nicht jedoch bei der Artikelklasse \Class{scrartcl}. Die Anweisung \Macro{addpart} erstellt entsprechend einen nicht nummerierten Dokumentteil mit einem Eintrag ins Inhaltsverzeichnis. Da @@ -2902,7 +2901,7 @@ Diese Überschrift ist keiner Gliederungsebene zugeordnet. Eine solche und erhält auch keine Nummerierung. \begin{Example} Sie haben einen Bausatz für eine Mausefalle entwickelt und wollen - diesen getrennt nach den benötigen Materialien und der Anleitung für + diesen getrennt nach den benötigten Materialien und der Anleitung für die Montage beschreiben. Das könnte so gemacht werden: \begin{lstlisting} \minisec{Bauteile} @@ -2979,7 +2978,7 @@ Die Schriftart des Gliederungsbefehls \Macro{minisec} kann über die Elemente \FontElement{minisec}\IndexFontElement{minisec}\ChangedAt{v2.96a}{% \Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} beeinflusst werden (siehe \autoref{tab:maincls.elementsWithoutText}, -\autopageref{tab:maincls.elementsWithoutText}). Die Voreinstellung für das +ab \autopageref{tab:maincls.elementsWithoutText}). Die Voreinstellung für das Element \FontElement{minisec} ist leer, so dass in der Voreinstellung direkt das Element \FontElement{disposition} wirkt. % @@ -3239,14 +3238,13 @@ Normalerweise werden bei den Klassen \Class{scrbook}\IndexClass{scrbook} und \Macro{subsection}\IndexCmd{subsection} und bei der Klasse \Class{scrartcl}\IndexClass{scrartcl} die Ebenen \Macro{part} bis \Macro{subsubsection}\IndexCmd{subsubsection} nummeriert. Gesteuert wird dies -über den \LaTeX-Zähler \Counter{secnumdepth}. Dabei steht der Wert -1 für -\Macro{part}, 0 für \Macro{chapter} und so weiter. Da bei \Class{scrartcl} die -Ebene \Macro{chapter} nicht existiert, beginnt bei dieser Klasse die Zählung -mit \Macro{part} bei 0. Durch Setzen oder Erhöhen oder Verringern des Zählers -kann bestimmt werden, bis zu welcher Gliederungsebene eine Nummerierung -erfolgen soll. Dies ist übrigens bei den Standardklassen ganz genauso. -Vergleichen Sie hierzu auch die Erklärung zum Zähler \Counter{tocdepth} in -\autoref{sec:maincls.toc}, \autopageref{desc:maincls.counter.tocdepth}. +über den \LaTeX-Zähler \Counter{secnumdepth}. Dabei steht der Wert \(-\)1 für +\Macro{part}, 0 für \Macro{chapter} und so weiter. Durch Setzen oder Erhöhen +oder Verringern des Zählers kann bestimmt werden, bis zu welcher +Gliederungsebene eine Nummerierung erfolgen soll. Dies ist übrigens bei den +Standardklassen ganz genauso. Vergleichen Sie hierzu auch die Erklärung zum +Zähler \Counter{tocdepth} in \autoref{sec:maincls.toc}, +\autopageref{desc:maincls.counter.tocdepth}. % \EndIndex{Counter}{secnumdepth}\EndIndex{}{Nummerierung} @@ -3632,7 +3630,8 @@ Anweisungen aus \autoref{sec:maincls.font} jedoch geändert werden. ebenfalls um 1\Unit{em} eingezogen. Eine weitere, oft gefragte Formatierung sind linksbündige - Fußnoten. Diese können mit folgender Definition erhalten werden: + Fußnotenmarkierungen in der Fußnote. Diese können mit folgender Definition + erhalten werden: \begin{lstlisting} \deffootnote{1.5em}{1em}{% \makebox[1.5em][l]{\thefootnotemark}} @@ -4183,7 +4182,8 @@ Rand\Index{Rand} verändert. Im Unterschied zu den beiden erstgenannten Umgebungen kann der Anwender jedoch bei \Environment{addmargin} wählen, um welchen Wert der Rand verändert werden kann. Des Weiteren verändert die Umgebung den Absatzeinzug und -den Absatzabstand nicht. +den Absatzabstand nicht. Es wird auch kein zusätzlicher vertikaler Abstand vor +und nach der Umgebung eingefügt. Ist nur das obligatorische Argument \PName{Einzug} angegeben, so wird der Inhalt der Umgebung rechts und links um diesen @@ -4204,10 +4204,10 @@ Bei beiden Varianten der Umgebung sind für alle Parameter auch negative Werte erlaubt. Damit kann man erreichen, dass die Umgebung in den Rand hineinragt. \begin{Example} - Angenommen, Sie schreiben eine Anleitung, mit kurzen Quellcode-Beispiele. Um - diese sehr stark hervorzuheben, sollen sie mit horizontalen Linien vom Text - abgesetzt und leicht in den äußeren Rand verschoben werden. Sie definieren - sich dafür zunächst eine Umgebung: + Angenommen, Sie schreiben eine Anleitung, mit kurzen + Quellcode-Beispielen. Um diese sehr stark hervorzuheben, sollen sie mit + horizontalen Linien vom Text abgesetzt und leicht in den äußeren Rand + verschoben werden. Sie definieren sich dafür zunächst eine Umgebung: \begin{lstlisting} \newenvironment{QuellcodeRahmen}{% \begin{addmargin*}[1em]{-1em}% @@ -4807,7 +4807,7 @@ Anweisung: \Macro{setcapindent*}. Mit einem negativen \PName{Einzug} erreicht man hingegen, dass vor der Beschreibung ebenfalls ein Umbruch erfolgt und nur die erste Zeile der -Beschreibung, nicht jedoch die folgenden, um -\PName{Einzug} +Beschreibung, nicht jedoch die folgenden, um den Betrag von \PName{Einzug} eingerückt werden. Ob einzeilige Beschreibungen wie mehrzeilige Beschreibungen gesetzt werden @@ -5276,11 +5276,11 @@ es zu merken. \Package{ifthen}-Paket\IndexPackage{ifthen} (siehe \cite{package:ifthen}). - Die Erklärung zu den umdefinierten Anweisungen finden Sie in + Die Erklärungen zu den umdefinierten Anweisungen finden Sie in \autoref{sec:maincls.structure}, - \autopageref{desc:maincls.macro.partformat} und - \autopageref{desc:maincls.macro.chaptermark}. -\end{Example} + \autopageref{desc:maincls.macro.chapterformat} und + \autopageref{desc:maincls.macro.chaptermarkformat}. +\end{Example}% % \EndIndex{Cmd}{appendixmore}% diff --git a/Master/texmf-dist/source/latex/koma-script/doc/german/scrlfile.tex b/Master/texmf-dist/source/latex/koma-script/doc/german/scrlfile.tex index f610a13b7eb..59f5453c536 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/german/scrlfile.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/german/scrlfile.tex @@ -45,7 +45,7 @@ % % ============================================================================ -\ProvidesFile{scrlfile.tex}[2005/08/10 KOMA-Script guide (chapter: scrlfile)] +\ProvidesFile{scrlfile.tex}[2007/08/07 KOMA-Script guide (chapter: scrlfile)] \chapter{Paketabhängigkeiten mit \Package{scrlfile} beherrschen} @@ -293,7 +293,10 @@ nicht nach dem nächsten Laden, sondern unmittelbar ausgeführt. Egal, ob nun der \Package{hyperref}-Treiber \Option{hypertex} oder \Option{dvips} zu Anwendung kommt, wird die dann nützliche Einstellung \Option{linktocpage} verwendet. Wenn Sie jedoch mit - pdf\LaTeX{} eine PDF-Datei erstellen, wird darauf verzichtet. + pdf\LaTeX{} eine PDF-Datei erstellen, wird darauf verzichtet, da in diesem + Fall der \Package{hyperref}-Treiber \File{hpdftex.def} verwendet wird. Das + bedeutet, dass weder \File{hdvips.def} noch \File{hypertex.def} geladen + wird. \end{Example} \begin{Explain} diff --git a/Master/texmf-dist/source/latex/koma-script/doc/german/scrlttr2.tex b/Master/texmf-dist/source/latex/koma-script/doc/german/scrlttr2.tex index 4a8fbc7b3b0..959ed2d71d7 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/german/scrlttr2.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/german/scrlttr2.tex @@ -45,7 +45,7 @@ % % ============================================================================ -\ProvidesFile{scrlttr2.tex}[2006/12/12 KOMA-Script guide (chapter: scrlttr2)] +\ProvidesFile{scrlttr2.tex}[2007/09/17 KOMA-Script guide (chapter: scrlttr2)] \chapter{Die neue Briefklasse \Class{scrlttr2}} \labelbase{scrlttr2} @@ -636,7 +636,7 @@ Die Option versteht die Werte aus \autoref{tab:scrlttr2.fromrule}. Voreingestellt ist der Wert \PValue{false}. Es können nicht gleichzeitig mehrere Linien aktiviert werden. Bezüglich der Länge der Linie siehe \autoref{sec:scrlttr2.other}, -\autopageref{desc:scrlttr2.plength.fromrulewidth}). +\autopageref{desc:scrlttr2.plength.fromrulewidth}. \begin{table} \caption[{Mögliche Werte für Option \Option{fromrule} bei @@ -1019,7 +1019,7 @@ der \File{lco}-Datei wird dieser ebenfalls ohne Endung als Parameter erreichen das so: \begin{lstlisting} \begin{letter}{Markus Kohm\\ - Fichtenstraße 63\\68535 Edingen-Neckarhausen} + Freiherr-von-Drais-Straße 66\\68535 Edingen-Neckarhausen} \LoadLetterOption{DINmtext} \opening{Hallo,} \end{lstlisting} @@ -1053,7 +1053,7 @@ gegebenenfalls die entsprechende Option zusätzlich angeben. \ProvidesFile{mkohm.lco} [2002/02/25 letter class option] \setkomavar{fromname}{Markus Kohm} - \setkomavar{fromaddress}{Fichtenstra\ss e 63\\ + \setkomavar{fromaddress}{Freiherr-von-Drais-Stra\ss e 66\\ 68535 Edingen-Neckarhausen} \end{lstlisting} Die dabei verwendete Anweisung \Macro{setkomavar} und das Prinzip der @@ -1078,7 +1078,7 @@ gegebenenfalls die entsprechende Option zusätzlich angeben. [2002/02/25 letter class option] \RequirePackage[latin1]{inputenc} \setkomavar{fromname}{Markus Kohm} - \setkomavar{fromaddress}{Fichtenstraße 63\\ + \setkomavar{fromaddress}{Freiherr-von-Drais-Straße 66\\ 68535 Edingen-Neckarhausen} \end{lstlisting} Dieses Vorgehen hat aber den entscheidenden Nachteil, dass die @@ -1794,7 +1794,7 @@ den einzelnen Abschnitten dieses Kapitels. Papierkante, falls der Wert negativ ist (\autoref{sec:scrlttr2.addressee}, \autopageref{desc:scrlttr2.plength.toaddrhpos})}% \pentry{toaddrindent}{% - linker Einzug der Anschrift innerhalb des Anschriftfeldes + linker und rechter Einzug der Anschrift innerhalb des Anschriftfeldes (\autoref{sec:scrlttr2.addressee}, \autopageref{desc:scrlttr2.plength.toaddrindent})}% \pentry{toaddrwidth}{% @@ -2417,7 +2417,7 @@ Abschnitt beschrieben ist, angepasst werden. \end{Example} Im letzten Beispiel wurde ein mehrzeiliger Fuß gesetzt. Bei einer -Kompatibilitätseinstellung aber Version 2.9u (siehe \Option{version} in +Kompatibilitätseinstellung ab Version 2.9u (siehe \Option{version} in \autoref{sec:scrlttr2.compatibilityOptions}, \autopageref{desc:scrlttr2.option.version}) reicht der Platz dafür in der Regel nicht aus. Sie sollten dann \PLength{firstfootvpos} (siehe @@ -2511,9 +2511,10 @@ liegen zwischen 70\Unit{mm} und 100\Unit{mm}. \end{Declaration} \BeginIndex{PLength}{toaddrindent}% Manchmal will man, dass die Anschrift nicht am linken Rand des -Anschriftfensters beginnt, sondern ein wenig eingezogen wird. Der Wert -dieses Einzugs kann über die Pseudolänge \PLength{toaddrindent} -festgelegt werden. Typischerweise ist dieser Wert jedoch 0\Unit{pt}. +Anschriftfensters beginnt und bis zum rechten Rand des Fensters reicht, +sondern ein wenig eingezogen wird. Der Wert dieses Einzugs kann über die +Pseudolänge \PLength{toaddrindent} festgelegt werden. Typischerweise ist +dieser Wert jedoch 0\Unit{pt}. % \EndIndex{PLength}{toaddrindent}% @@ -2542,7 +2543,7 @@ Pseudolänge \PLength{backaddrheight} abgelegt. Der Wert wird in den vordefinierten \File{lco}-Dateien typischerweise auf 5\Unit{mm} eingestellt. Ob die Rücksendeadresse überhaupt gesetzt wird, bestimmt der Anwender mit den Optionen \Option{addrfield} (siehe \autoref{sec:scrlttr2.headoptions}, -\autopageref{desc:scrlttr2.option.addrfield} und \Option{backaddress} (siehe +\autopageref{desc:scrlttr2.option.addrfield}) und \Option{backaddress} (siehe \autoref{sec:scrlttr2.headoptions}, \autopageref{desc:scrlttr2.option.backaddress}). % @@ -3533,6 +3534,8 @@ entnommen werden. \caption{Sprachabhängige Ausgabeformate für das Datum} \begin{tabular}{ll} \toprule + Anweisung & Ausgabebeispiel \\ + \midrule \Macro{dateenglish} & 1/12/1993\\ \Macro{dateUSenglish} & 12/1/1993\\ \Macro{dateamerican} & 12/1/1993\\ @@ -3890,7 +3893,8 @@ Datenbanksysteme möglich, solche Massenpostsendungen zu erstellen. Natürlich kann der Brief"|inhalt auch von den Adressatenmerkmalen abhängig gemacht werden. Als Bedingungsfelder können die frei -bestimmbaren Elemente fünf oder sechs eines \Macro{adrentry}-Eintrages +bestimmbaren Elemente fünf oder sechs eines \Macro{adrentry}-Eintrages oder +die frei bestimmbaren Elemente fünf bis acht eines \Macro{addrentry}-Eintrags genutzt werden. \begin{Example} Angenommen, Sie verwenden das Element fünf, um das Geschlecht eines @@ -3944,7 +3948,7 @@ Damit die Listen alphabetisch sortiert ausgegeben werden, muss bereits die Adressdatei sortiert gewesen sein. Es empfiehlt sich dabei, vor jedem neuen Anfangsbuchstaben eine Anweisung \Macro{adrchar} mit diesem Buchstaben als Argument einzufügen. \Class{scrlttr2} selbst -ignoriert diese Anweisung. +ignoriert diese Anweisung ebenso wie \Macro{addrchar}. % \begin{Example} Sie haben folgende, winzige Adressdatei: @@ -3967,7 +3971,7 @@ ignoriert diese Anweisung. {RAPHAEL} \adrchar{K} \adrentry{Kohm}{Markus} - {Fichtenstra\ss e 63\\ + {Freiherr-von-Drais-Stra\ss e 66\\ 68535 Edingen-Neckarhausen} {+49~62\,03~1\,??\,??}{}{} {\"Uberhaupt kein Engel} @@ -4135,5 +4139,6 @@ Grußfloskel ist.% %%% Local Variables: %%% mode: latex +%%% coding: iso-latin-1 %%% TeX-master: "../guide.tex" %%% End: diff --git a/Master/texmf-dist/source/latex/koma-script/doc/guide.tex b/Master/texmf-dist/source/latex/koma-script/doc/guide.tex index c4f2a1f1d91..8e280a2c180 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/guide.tex +++ b/Master/texmf-dist/source/latex/koma-script/doc/guide.tex @@ -57,9 +57,12 @@ \author{Markus Kohm\and Jens-Uwe-Morawski} \publishers{\small\GuideAuthorHeadline: Frank Neukam, Markus Kohm, Axel Kielhorn} -\uppertitleback{\GuideWarrantyHeadline\\[.5\baselineskip] +\uppertitleback{% + \GuideWarrantyHeadline\\[.5\baselineskip] \GuideWarranty} -\lowertitleback{\GuideCopyright} +\lowertitleback{% + \settranslator{\GuideTranslatorHeadline}{.\par\bigskip}% + \GuideCopyright} \dedication{\GuideDedication} \pdfbookmark{\KOMAScript}{title}\maketitle diff --git a/Master/texmf-dist/source/latex/koma-script/doc/plength.dtx b/Master/texmf-dist/source/latex/koma-script/doc/plength.dtx index 9cee29f088f..dca308351ab 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/plength.dtx +++ b/Master/texmf-dist/source/latex/koma-script/doc/plength.dtx @@ -83,7 +83,7 @@ % %<*driver> % \begin{macrocode} -\ProvidesFile{plength.drv}[2005/08/30 plength MetaPost graphics] +\ProvidesFile{plength.drv}[2007/09/02 plength MetaPost graphics] \documentclass{ltxdoc} \usepackage{ngerman} \usepackage[utf8]{inputenc} @@ -287,12 +287,12 @@ enddef; def defdescriptionen = begingroup - description[1]=btex \descr{}letter-head etex; - description[2]=btex \descr{}letter foot etex; + description[1]=btex \descr{}letterhead etex; + description[2]=btex \descr{}letter footer etex; description[3]=btex \descr{}return address etex; - description[4]=btex \descr{}special mail etex; + description[4]=btex \descr{}mode of dispatch etex; description[5]=btex \descr{}addressee etex; - description[6]=btex \descr{}business line etex; + description[6]=btex \descr{}reference fields line etex; description[7]=btex \descr{}title etex; description[8]=btex \descr{}subject etex; description[9]=btex \descr{}opening etex; diff --git a/Master/texmf-dist/source/latex/koma-script/doc/scrguide.cls b/Master/texmf-dist/source/latex/koma-script/doc/scrguide.cls index e62edb734cb..4a9c8228925 100644 --- a/Master/texmf-dist/source/latex/koma-script/doc/scrguide.cls +++ b/Master/texmf-dist/source/latex/koma-script/doc/scrguide.cls @@ -38,7 +38,7 @@ % \section{Identification} % % \begin{macrocode} -\ProvidesClass{scrguide}[2007/01/06 v0.9c internal KOMA-Script guide class] +\ProvidesClass{scrguide}[2007/09/18 v0.9d internal KOMA-Script guide class] % \end{macrocode} % % @@ -335,6 +335,92 @@ % \end{macrocode} % % +% \section{Collect All Translators} +% +% At the translated guides, the translators should also be shown somewhere at +% the title. +% +% \begin{macro}{\translator} +% \changes{v0.9d}{2007/09/18}{new} +% This macro is used, so save one or more translators into the aux file. +% \begin{macrocode} +\newcommand*{\translator}[1]{% + \protected@write\@auxout{\def\and{,}}{% + \protect\@addtranslators{#1}% + }% +} +% \end{macrocode} +% \begin{macro}{\@translator} +% \begin{macro}{\@addtranslator} +% And we need macros so store the translators +% \begin{macrocode} +\newcommand*{\@translator}{} +% \end{macrocode} +% and to read the translators from the aux file. +% \begin{macrocode} +\newcommand*{\@addtranslators}[1]{% + \ifx\@translator\@empty\else\g@addto@macro\@translator{,}\fi + \g@addto@macro\@translator{#1}% +} +% \end{macrocode} +% \end{macro} +% \end{macro} +% \end{macro} +% +% +% \begin{macro}{\settranslator} +% \changes{v0.9d}{2007/09/18}{new} +% Last but not least, we need a macro to set the list of translators. +% \begin{macrocode} +\newcommand{\settranslator}[2]{% + \ifx\@translator\@empty\else + #1% + \begingroup +% \end{macrocode} +% Run through all translators, but store each once only. + \let\@tempb\@empty + \@tempcnta=\z@ + \expandafter\@for \expandafter\@tempa\expandafter:\expandafter=% + \@translator\do {% + \ifx\@tempa\@empty\else + \typeout{Test: `,\@tempa,' at `,\@tempb,'}% + \@expandtwoargs\in@{,\@tempa,}{,\@tempb,}% + \ifin@\else + \edef\@tempb{\@tempb\@tempa,}% + \advance\@tempcnta by 1\relax + \fi + \fi + }% +% \end{macrocode} +% Set each of the stored translators. +% \begin{macrocode} + \@tempcntb=\z@ + \expandafter\@for \expandafter\@tempa\expandafter:\expandafter=% + \@tempb\do {% + \ifx\@tempa\@empty\else + \advance\@tempcntb by 1\relax + \typeout{Translator \the\@tempcntb: \@tempa}% + \ifnum\@tempcntb >\@ne\relax + \ifnum\@tempcntb=\@tempcnta\relax + \ifnum\@tempcntb=\tw@\relax + \GuideAnd\ % + \else + \GuideListAnd\ % + \fi + \else + , + \fi + \fi + \@tempa + \fi + }% + \endgroup + #2% + \fi +} +% \end{macrocode} +% \end{macro} +% % \section{Emphasization and Fonts} % % The \KOMAScript{} guide uses a lot of emphasizations. Most of them are @@ -576,8 +662,8 @@ % This environment is used for all examples at the \KOMAScript{} guide. % \begin{macrocode} \newenvironment{Example}{% - \labeling{{\usekomafont{sectioning}\GuideExample:\ }} - \item[{\usekomafont{sectioning}\GuideExample:\ }]% + \labeling{{\usekomafont{disposition}\GuideExample:\ }} + \item[{\usekomafont{disposition}\GuideExample:\ }]% }{% \endlabeling } @@ -1124,7 +1210,7 @@ KOMAScript \endcsname % \begin{macrocode} \newcommand*{\indexsection}[1]{% \ifx\empty#1\empty\else - \hspace{0pt plus 2fil}{{\usekomafont{sectioning} #1}}\hspace{0pt plus + \hspace{0pt plus 2fil}{{\usekomafont{disposition} #1}}\hspace{0pt plus 1fil}\nopagebreak \fi } diff --git a/Master/texmf-dist/source/latex/koma-script/scrbeta.dtx b/Master/texmf-dist/source/latex/koma-script/scrbeta.dtx index a8c8a83bb6a..ceecb19a8d8 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrbeta.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrbeta.dtx @@ -58,7 +58,7 @@ %%% From File: scrbeta.dtx %<*driver> % \fi -\ProvidesFile{scrbeta.dtx}[2006/03/29 v1.0 KOMA-Script (beta warning)] +\ProvidesFile{scrbeta.dtx}[2007/09/25 v1.1 KOMA-Script (beta warning)] % \iffalse \documentclass[halfparskip-]{scrdoc} \usepackage[english]{babel} @@ -129,6 +129,7 @@ %<Swissleft> SNleft% %<KOMAold> KOMAold% %<scrxfloat> scrxfloat% +%<tocstyle> tocstyle% }{% THIS IS A BETA VERSION!\MessageBreak YOU SHOULD NOT USE THIS VERSION!\MessageBreak diff --git a/Master/texmf-dist/source/latex/koma-script/scrkbase.dtx b/Master/texmf-dist/source/latex/koma-script/scrkbase.dtx index 7affc521318..16c56b0e857 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrkbase.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrkbase.dtx @@ -1,4 +1,4 @@ -% \CheckSum{710} +% \CheckSum{985} % \iffalse meta-comment % ====================================================================== % scrkbase.dtx @@ -58,7 +58,7 @@ %%% From File: scrkbase.dtx %<*driver> % \fi -\ProvidesFile{scrkbase.dtx}[2006/08/20 v2.96 KOMA-Script (basics)] +\ProvidesFile{scrkbase.dtx}[2007/09/17 v2.97c KOMA-Script (basics)] % \iffalse %</driver> %<package&option>\ProvidesPackage{scrkbase}[% @@ -135,23 +135,18 @@ % % \subsection{Anweisungen zur Abarbeitung von Optionen} % -% \begin{macro}{\scr@ifundefined} +% \begin{macro}{\scr@ifundefinedorrelax} % \changes{v2.95c}{2006/08/12}{neu (intern)} +% \changes{v2.97b}{2007/03/08}{vermurkste Logik korrigiert} +% \changes{v2.97c}{2007/04/18}{vermurkste Funktion korrigiert} +% \changes{v2.97c}{2007/04/18}{von \cs{scr@ifundefined} umbenannt} % Dieses Makro arbeitet wie \cs{@ifundefined}, definiert dabei aber % ein undefiniertes Makro nicht als \cs{relax}. Es muss bereits hier definiert % werden, weil es gleich verwendet wird. % \begin{macrocode} \begingroup\expandafter\expandafter\expandafter\endgroup -\expandafter\ifx\csname ifcsname\endcsname - \newcommand{\scr@ifundefined}[1]{% - \ifcsname #1\endcsname - \expandafter\@secondoftwo - \else - \expandafter\@firstoftwo - \fi - } -\else - \newcommand{\scr@ifundefined}[1]{% +\expandafter\ifx\csname ifcsname\endcsname\relax + \newcommand{\scr@ifundefinedorrelax}[1]{% \begingroup\expandafter\expandafter\expandafter\endgroup \expandafter\ifx\csname #1\endcsname\relax \expandafter\@firstoftwo @@ -159,33 +154,22 @@ \expandafter\@secondoftwo \fi } +\else + \newcommand{\scr@ifundefinedorrelax}[1]{% + \ifcsname #1\endcsname + \expandafter\ifx\csname #1\endcsname\relax + \expandafter\expandafter\expandafter\@firstoftwo + \else + \expandafter\expandafter\expandafter\@secondoftwo + \fi + \else + \expandafter\@firstoftwo + \fi + } \fi % \end{macrocode} % \end{macro} % -% \begin{macro}{\DeclareKeyValOption} -% Dieses Makro deklariert alle bisher definierten Schlüssel eines -% Bereichs (erste Argument) als Optionen. Das optionale Argument -% erlaubt außerdem die Deklaration einer -% \cs{DeclareOption*}-Auswertung. \cs{DeclareOption*} darf nicht -% zusammen mit dieser Anweisung verwendet werden. Diese Anweisung darf -% je Paket oder Klasse nur einmal verwendet werden. -% \begin{macrocode} -\newcommand*{\DeclareKeyValOption}[2][% - \ifx\@currext\@clsextension\OptionNotUsed\else\@unkownoptionerror\fi -]{% - \DeclareOption*{% - \def\@tempa##1=##2=##3\@nil{% - \scr@ifundefined{KV@#2@##1}{#1}{% - \@expandtwoargs\setkeys{#2}\CurrentOption - }% - }% - \expandafter\@tempa\CurrentOption==\@nil - }% -} -% \end{macrocode} -% \end{macro} -% % % \subsection{Definition von KOMA-\textsf{keyval}-Schlüsseln (Basis)} % @@ -196,39 +180,31 @@ % Schlüssel jedes anderen Teils ausführen kann -- sobald sie definiert % sind. % -% \begin{macro}{\KOMA@key} -% Einzig, um etwas Tipparbeit zu sparen, wird ein abkürzendes Makro -% definiert: +% \begin{macro}{\KOMA@key} +% \changes{v2.97c}{2007/04/19}{neues optionales Argument} +% \begin{macro}{\KOMA@key@familylist} +% \textsf{keyval}-Schlüssel für \KOMAScript{} werden mit \cs{KOMAkey} +% definiert, damit auch die Familie korrekt gesetzt und ggf. der Liste der +% Familien (\cs{KOMA@key@familylist}) hinzugefügt wird. % \begin{macrocode} -\newcommand*{\KOMA@key}{\define@key{KOMA}} -% \end{macrocode} -% \end{macro} -% -% \subsection{Optionen} -% -% \begin{option}{internalonly} -% \changes{v2.96}{2006/11/26}{neu} -% \begin{macro}{\dont@let@as@internal@defined} -% \changes{2.96}{2006/11/26}{neu (intern)} -% Anweisungen, die mit einem internen und einem Anwendername vorhanden sind, -% können vor dem Anwender optional verborgen werden. -% \begin{macrocode} -\newcommand*{\dont@let@as@internal@defined}{/} -\KOMA@key{internalonly}{% - \begingroup - \@expandtwoargs\in@{#1}\dont@let@as@internal@defined - \expandafter\endgroup - \ifin@\else\g@addto@macro\dont@let@as@internal@defined{#1/}\fi +\newcommand*{\KOMA@key}[1][.\@currname.\@currext]{% + \edef\reserved@a{\noexpand\in@{KOMA#1,}{\KOMA@key@familylist}}\reserved@a + \ifin@\else\xdef\KOMA@key@familylist{\KOMA@key@familylist KOMA#1,}\fi + \define@key{KOMA#1}% } -\DeclareKeyValOption{KOMA} +\newcommand*{\KOMA@key@familylist}{} % \end{macrocode} % \end{macro} -% \end{option} +% \end{macro} % -% \changes{v2.96}{2006/08/20}{Optionen werden abgearbeitet} -% \begin{macrocode} -\ProcessOptions\relax -% \end{macrocode} +% \subsection{Optionen} +% +% Ab Version 2.97c sollen sowohl globale KOMA-Optionen als auch die +% KOMA-Optionen der jeweiligen Datei als auch die normalen Optionen in der +% Reihenfolge ausgeführt werden, in der sie angegeben wurden -- zuerst die +% globalen Optionen, dann die lokalen. Dabei werden nur die Optionen +% verwendet, die auch für das jeweilige Paket bzw. die jeweilige Klasse +% definiert wurden. % % \begin{macro}{\@globaloptionslist} % \changes{v2.96}{2006/11/26}{new} @@ -241,30 +217,145 @@ % Makro definiert. % \begin{macrocode} \newcommand*{\@globaloptionslist}{} -\scr@ifundefined{XKV@classooptionslist}{% - \let\@globaloptionslist\@classoptionslist -}{% - \let\@globaloptionslist\XKV@classoptionslist +\let\@globaloptionslist\@classoptionslist +\scr@ifundefinedorrelax{XKV@classoptionslist}{}{% + \ifx\XKV@classoptionslist\@empty\else + \let\@globaloptionslist\XKV@classoptionslist + \fi } -\@expandtwoargs\in@{,internalonly=}{,\@globaloptionslist} -\ifin@ - \begingroup - \catcode`\=12\catcode`\:=12 - \def\@do@internalonly #1internalonly=#2\@nil{% - \ifx\relax#1\relax\setkeys{KOMA}{internalonly=#2}\fi - \@expandtwoargs\@removeelement{internalonly=#2}\@unusedoptionlist - \@unusedoptionlist +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\KOMAProcessOptions} +% \changes{v2.97c}{2007/04/18}{neu} +% Diese Anweisung führt alle Optionen, sowohl normal deklarierte als auch +% keyval-Optionen eines Pakets bzw. einer Klasse in der Reihenfolge, in der +% sie verwendet wurden aus -- zuerst gloable Optionen, dann lokale +% Optionen. Das entspricht der Verwendung von \cs{ProcessOptions*} mit dem +% Unterschied, dass eben auch die keyval-Optionen abgearbeitet +% werden. keyval-Optionen, die keiner einzelnen Klasse und keinem einzelnen +% Paket zugeordnet werden, werden dabei vor gleichnamigen eigenen +% keyval-Optionen ausgeführt. +% \begin{macrocode} +\newcommand*{\KOMAProcessOptions}[1][KOMA]{% + \let\ds@\@empty + \edef\@curroptions{\@ptionlist{\@currname.\@currext}}% + \ifx\@currext\@clsextension\else + \@for\CurrentOption:=\@globaloptionslist\do{% + \ifx\CurrentOption\@empty\else + \@expandtwoargs\in@{,\CurrentOption,}{,\@declaredoptions,}% + \ifin@ + \@use@ption + \expandafter\let\csname ds@\CurrentOption\endcsname\@empty + \else + \KOMA@optiontest{#1}\CurrentOption{}{% + \@use@ption + \@expandtwoargs\setkeys{#1}% + \CurrentOption + }% + \KOMA@optiontest{#1.\@currname.\@currext}\CurrentOption{}{% + \@use@ption + \@expandtwoargs\setkeys{#1.\@currname.\@currext}% + \CurrentOption + }% + \fi + \fi }% - \expandafter\@for\expandafter\@tempa\expandafter:\expandafter=% - \@globaloptionslist\do{% - \expandafter\@do@internalonly\@tempa\@nil + \fi + \@for\CurrentOption:=\@curroptions\do{% + \@use@ption + \scr@ifundefinedorrelax{ds@\CurrentOption}{% + \KOMA@optiontest{#1}\CurrentOption{% + \KOMA@optiontest{#1.\@currname.\@currext}\CurrentOption{% + \default@ds + }{% + \let\scr@sr@co\CurrentOption + \@expandtwoargs\setkeys{#1.\@currname.\@currext}% + \CurrentOption + \let\CurrentOption\scr@sr@co + }% + }{% + \@expandtwoargs\setkeys{#1}% + \CurrentOption + \KOMA@optiontest{#1.\@currname.\@currext}\CurrentOption{}{% + \@expandtwoargs\setkeys{#1.\@currname.\@currext}% + \CurrentOption + }% + }% + }{% }% - \global\let\@unusedoptionlist\@unusedoptionlist - \endgroup -\fi + }% + \@for\CurrentOption:=\@declaredoptions\do{% + \expandafter\let\csname ds@\CurrentOption\endcsname\relax}% + \let\CurrentOption\@empty + \let\@fileswith@pti@ns\@@fileswith@pti@ns + \AtEndOfPackage{\let\@unprocessedoptions\relax}% +} +\@onlypreamble\KOMA@process@options +\@onlypreamble\KOMAProcessOptions % \end{macrocode} +% \begin{macro}{\KOMA@optiontest} +% \changes{v2.97c}{2007/04/18}{neu (intern)} +% \begin{macro}{\KOMA@pti@ntest} +% \changes{v2.97c}{2007/04/18}{neu (intern)} +% Es werden zwei interne Makros benötigt, um zu testen, ob eine entsprechende +% keyval-Option definiert ist. Grund der Übung ist, dass sowohl das +% Familienargument als auch die Options selbst expandiert werden muss. +% \begin{macrocode} +\newcommand*{\KOMA@optiontest}[2]{% + \edef\reserved@a{\noexpand\KOMA@pti@ntest{#1}#2=\noexpand\@nil}% + \reserved@a +} +\newcommand*{\KOMA@pti@ntest}{} +\def\KOMA@pti@ntest#1#2=#3\@nil{\scr@ifundefinedorrelax{KV@#1@#2}} +% \end{macrocode} +% \end{macro} +% \end{macro} +% \begin{macro}{\scr@sr@co} +% \changes{v2.96}{2006/08/20}{neu (intern)} +% Da das \texttt{xkeyval}-Paket leider \cs{CurrentOption} vernichtet, das aber +% innerhalb von \cs{ProcessOptions} und \cs{KOMAProcessOptions} nach dem +% Ausführen der Option noch benötigt wird, muss die Anweisung gesichert +% werden. Dafür wird ein Hilfsmakro benötigt. +% \begin{macrocode} +\newcommand*{\scr@sr@co}{} +% \end{macrocode} +% \end{macro} % \end{macro} % +% \begin{option}{internalonly} +% \changes{v2.96}{2006/11/26}{neu} +% \changes{v2.97c}{2007/06/20}{geht auch ohne Argument} +% \begin{macro}{\dont@let@as@internal@defined} +% \changes{2.96}{2006/11/26}{neu (intern)} +% Anweisungen, die mit einem internen und einem Anwendername vorhanden sind, +% können vor dem Anwender optional verborgen werden. Wird kein Argument +% angegeben, so werden alle Anweisungen verborgen. +% \begin{macrocode} +\newcommand*{\dont@let@as@internal@defined}{/} +\newif\if@let@as@internalonly@defined\@let@as@internalonly@definedfalse +\KOMA@key{internalonly}[\relax]{% + \ifx\relax#1\relax + \@let@as@internalonly@definedtrue + \else + \@let@as@internalonly@definedfalse + \begingroup + \@expandtwoargs\in@{#1}\dont@let@as@internal@defined + \expandafter\endgroup + \ifin@\else\g@addto@macro\dont@let@as@internal@defined{#1/}\fi + \fi +} +% \end{macrocode} +% \end{macro} +% \end{option} +% +% \changes{v2.96}{2006/08/20}{Optionen werden abgearbeitet} +% \changes{v2.97c}{2007/04/18}{Optionen werden mit \cs{KOMAProcessOptions} +% abgearbeitet} +% \begin{macrocode} +\KOMAProcessOptions\relax +% \end{macrocode} +% % \iffalse %</option> %<*body> @@ -290,11 +381,13 @@ % \end{macro} % \end{macro} % -% \begin{macro}{\let@as@internal@defined} -% \changes{v2.95}{2002/08/19}{neu (intern)} -% \changes{v2.95c}{2006/08/12}{Warnung bei Umdefinierung} -% \changes{v2.96}{2006/11/26}{Herausreichen von internen Makros als -% Benutzermakros kann verhindert werden} +% \begin{macro}{\let@as@internal@defined} +% \changes{v2.95}{2002/08/19}{neu (intern)} +% \changes{v2.95c}{2006/08/12}{Warnung bei Umdefinierung} +% \changes{v2.96}{2006/11/26}{Herausreichen von internen Makros als +% Benutzermakros kann verhindert werden} +% \changes{v2.97c}{2007/06/20}{Herausreichen von internen Makros kann +% generell verhindert werden} % Dieses Makro wird intern verwendet, um dokumentierte Makros mit der % Definition von internen Makros zu versehen, falls sie nicht bereits % definiert oder als nicht zu definieren markiert sind. Der Name des @@ -303,7 +396,11 @@ % \begin{macrocode} \newcommand*{\let@as@internal@defined}[1]{% \begingroup - \@expandtwoargs\in@{/#1/}\dont@let@as@internal@defined + \if@let@as@internalonly@defined + \in@true + \else + \@expandtwoargs\in@{/#1/}\dont@let@as@internal@defined + \fi \expandafter\endgroup \ifin@ \PackageInfo{% @@ -356,13 +453,14 @@ % \end{macrocode} % \end{macro} % -% \begin{macro}{\ifundefined} +% \begin{macro}{\ifundefinedorrelax} % \changes{v2.95}{2002/08/21}{neu} % \changes{v2.95c}{2006/08/12}{über interne Anweisung definiert} +% \changes{v2.97c}{2007/06/20}{umbenannt von \cs{ifundefined}} % Dieses Makro arbeitet wie \cs{@ifundefined}, definiert dabei aber % ein undefiniertes Makro nicht als \cs{relax}. % \begin{macrocode} -\let@as@internal@defined{ifundefined} +\let@as@internal@defined{ifundefinedorrelax} % \end{macrocode} % \end{macro} % @@ -373,7 +471,7 @@ % ist es ganz nützlich, auch das zu haben. Dieses Makro heißt nicht % \cs{ifdefined}, weil \eTeX\ bereits ein solches Primitiv bietet. % \begin{macrocode} -\scr@ifundefined{ifcsname}{% +\scr@ifundefinedorrelax{ifcsname}{% \newcommand{\ifnotundefined}[1]{% \begingroup\expandafter\expandafter\expandafter\endgroup \expandafter\ifx\csname #1\endcsname\relax @@ -574,15 +672,17 @@ % \end{macrocode} % \end{macro} % \end{macro} -% -% \begin{macro}{\ifvtex} -% \changes{v2.95}{2002/08/19}{neu} -% \begin{macro}{\scr@ifvtex} -% \changes{v2.95}{2002/08/19}{neu} +% +% \begin{macro}{\ifVTeX} +% \changes{v2.95}{2002/08/19}{neu} +% \changes{v2.97c}{2007/06/20}{umdefiniert von \cs{ifvtex}} +% \begin{macro}{\scr@ifVTeX} +% \changes{v2.95}{2002/08/19}{neu} +% \changes{v2.97c}{2007/06/20}{umdefiniert von \cs{scr@ifvtex}} % If-then-else-Konstrukt, um zu testen, ob V\TeX{} verwendet wird. % \begin{macrocode} -\newcommand{\scr@ifvtex}{\ifnotundefined{VTeXversion}} -\let@as@internal@defined{ifvtex} +\newcommand{\scr@ifVTeX}{\ifnotundefined{VTeXversion}} +\let@as@internal@defined{ifVTeX} % \end{macrocode} % \end{macro} % \end{macro} @@ -603,8 +703,8 @@ % für die Deklaration der Option \texttt{pagesize} benötigt. % \begin{macrocode} \newcommand{\scr@ifpdfoutput}{% - \scr@ifundefined{pdfoutput}{% - \scr@ifundefined{OpMode}{% + \scr@ifundefinedorrelax{pdfoutput}{% + \scr@ifundefinedorrelax{OpMode}{% \expandafter\@secondoftwo% }{% \ifnum\OpMode=1 @@ -667,8 +767,8 @@ % ausgegeben wird oder nicht, Befehle auszuführen. % \begin{macrocode} \newcommand*{\scr@ifdvioutput}{% - \scr@ifundefined{pdfoutput}{% - \scr@ifundefined{OpMode}{% + \scr@ifundefinedorrelax{pdfoutput}{% + \scr@ifundefinedorrelax{OpMode}{% \expandafter\@firstoftwo }{% \ifnum\OpMode=0 @@ -690,22 +790,145 @@ % \end{macro} % \end{macro} % +% \begin{macro}{\scr@smashdp} +% \changes{v2.97c}{2007/09/17}{neu (intern)} +% Gibt Material aus, erzeugt dabei aber nur Höhe und Breite, jedoch keine +% Tiefe. +% \begin{macrocode} +\newcommand*{\scr@smashdp}[1]{% + \begingroup + \def\finsm@sh{\dp\z@\z@\box\z@}% + \smash{#1}% + \endgroup +} +% \end{macrocode} +% \end{macro} +% +% % % \subsection{Definition von KOMA-\textsf{keyval}-Schlüsseln (Hauptteil)} % -% \begin{macro}{\KOMAoptions} -% \changes{v2.96}{2006/08/20}{Neuer Hook nach den Optionen} -% \begin{macro}{\post@kopt@hook} -% \changes{v2.96}{2006/08/20}{Neuer Hook nach den Optionen} -% \begin{macro}{\AfterKOMAoptions} -% \changes{v2.96}{2006/08/20}{Neuer Hook nach den Optionen} +% \begin{macro}{\KOMAExecuteOptions} +% \changes{v2.97c}{2007/04/19}{neu (nur für Klassen- und Paketautoren)} +% Liste von Optionen ausführen +% \begin{macrocode} +\newcommand*{\KOMAExecuteOptions}[2][KOMA]{% + \def\reserved@a##1\@nil{% + \@for\KOMA@key@atlist:=#2\do{% + \expandafter\KOMA@key@split@name@value\KOMA@key@atlist==\@nil + \scr@ifundefinedorrelax{KV@#1@\KOMA@key@name}{}{% + \edef\reserved@a{\noexpand\setkeys{#1}{\KOMA@key@atlist}% + }% + \reserved@a + }% + \scr@ifundefinedorrelax{KV@#1.\@currname.\@currext @\KOMA@key@name}{}{% + \edef\reserved@a{% + \noexpand\setkeys{#1.\@currname.\@currext}{\KOMA@key@atlist}% + }% + \reserved@a + }% + \let\CurrentOption\KOMA@key@atlist + \csname ds@\CurrentOption\endcsname + }% + \edef\CurrentOption{##1}% + }% + \expandafter\reserved@a\CurrentOption\@nil +} +\@onlypreamble\KOMAExecuteOptions +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\KOMAoptions} +% \changes{v2.96}{2006/08/20}{Neuer Hook nach den Optionen} +% \changes{v2.97c}{2007/04/19}{Optionen aller KOMA-Familien abarbeiten} +% \begin{macro}{\post@kopt@hook} +% \changes{v2.96}{2006/08/20}{Neuer Hook nach den Optionen} +% \begin{macro}{\AfterKOMAoptions} +% \changes{v2.96}{2006/08/20}{Neuer Hook nach den Optionen} % Es werden Schlüssel verwendet und ggf. danach noch Dinge ausgeführt. % \begin{macrocode} \newcommand*{\KOMAoptions}[1]{% \let\post@kopt@hook\@empty - \setkeys{KOMA}{#1}% + \KOMA@options{#1}{% +% Wenn der Schlüssel für keine der bekannten Familien definiert ist, wird ein +% Fehler ausgegeben. +% \begin{macrocode} + \PackageError{scrkbase}{% + unknown KOMA option `\KOMA@key@name'% + }{% + You have used \string\KOMAoptions\space to set + `\KOMA@key@atlist',\MessageBreak + but KOMA-Script does not know any option named + `\KOMA@key@name'.\MessageBreak + See the KOMA-Script manual for more informations about options + and\MessageBreak + their values.% + }% + }% \post@kopt@hook\let\post@kopt@hook\relax } +% \end{macrocode} +% \begin{macro}{\KOMA@options} +% \changes{v2.97c}{2007/04/19}{Neues Makro (intern)} +% Das interne Macro \cs{KOMA@options} macht die eigentliche Arbeit. Das erste +% Argument ist dabei die Liste der Optionen, das zweite Code, der im +% Fehlerfall ausgeführt werden soll. Dabei sind die Makros +% \cs{KOMA@key@atlist}, \cs{KOMA@key@name} und \cs{KOMA@key@value} gültig und +% können verwendet werden. +% +% Anmerkung: Es wird nicht auf \textsf{ykeyval} und den dortigen Befehl +% \cs{setkeys+} gesetzt, weil dieser die Optionen nicht in der Reihenfolge der +% Optionen, sondern in der Reihenfolge der Familien ausführt. Das passt mir +% aber hier gar nicht. +% +% In einer Schleife über alle Optionen werden die Optionen zunächst in Option +% und Wert aufgespaltet. +% \begin{macrocode} +\newcommand*{\KOMA@options}[2]{% + \@for\KOMA@key@atlist:=#1\do{% + \expandafter\KOMA@key@split@name@value\KOMA@key@atlist==\@nil +% \end{macrocode} +% Dann wird in einer Schleife über alle Familien festgestellt, ob die Option +% in einer Familie bekannt ist und ggf. ausgeführt. +% \begin{macrocode} + \KOMA@key@found@false + \@for\@tempa:=\KOMA@key@familylist\do{% + \scr@ifundefinedorrelax{KV@\@tempa @\KOMA@key@name}{}{% + \KOMA@key@found@true + \edef\reserved@a{\noexpand\setkeys{\@tempa}{\KOMA@key@atlist}% + \noexpand\edef\noexpand\@tempa{\@tempa}% + \noexpand\edef\noexpand\KOMA@key@atlist{\KOMA@key@atlist}% + \noexpand\edef\noexpand\KOMA@key@name{\KOMA@key@name}% + \noexpand\edef\noexpand\KOMA@key@value{\KOMA@key@value}% + }% + \reserved@a + }% + }% + \ifKOMA@key@found@\else#2\fi + }% +} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\ifKOMA@key@found@} +% \changes{v2.97c}{2007/04/19}{Neuer Schalter (intern)} +% \begin{macro}{\KOMA@key@atlist} +% \changes{v2.97c}{2007/04/19}{Neues Makro (intern)} +% \begin{macro}{\KOMA@key@name} +% \changes{v2.97c}{2007/04/19}{Neues Makro (intern)} +% \begin{macro}{\KOMA@key@value} +% \changes{v2.97c}{2007/04/19}{Neues Makro (intern)} +% \begin{macro}{\KOMA@key@split@name@value} +% \changes{v2.97c}{2007/04/19}{Neues Makro (intern)} +% \begin{macrocode} +\newif\ifKOMA@key@found@ +\newcommand*{\KOMA@key@atlist}{} +\newcommand*{\KOMA@key@name}{} +\newcommand*{\KOMA@key@value}{} +\newcommand*{\KOMA@key@split@name@value}{} +\def\KOMA@key@split@name@value#1=#2=#3\@nil{% + \def\KOMA@key@name{#1}% + \def\KOMA@key@value{#2}% +} \newcommand*{\post@kopt@hook}{} \let\post@kopt@hook\relax \newcommand*{\AfterKOMAoptions}{% @@ -722,53 +945,38 @@ \post@kopt@hook } % \end{macrocode} -% \end{macro} -% \end{macro} -% \end{macro} -% -% \begin{option}{nokey} -% Dies ist in Wirklichkeit kein Schlüssel, sondern eine Fehlermeldung -% für nicht definierte Schlüssel. Er kann jedoch wie ein Schlüssel -% definiert und auch so verwendet werden. +% \begin{macro}{\l@addto@macro} +% \changes{v2.8p}{2001/09/22}{neu (intern)} +% Damit \cs{AfterKOMAoptions} lokal möglich ist, wird eine lokal arbeitende +% Variante von \cs{g@addto@macro} benötigt, wie sie hier vorgestellt wird. +% \changes{v2.95}{2006/06/02}{korrigiert, damit es sich bezüglich +% Erweiterung um Makrodefinitonen mit Argumenten wie \cs{g@addto@macro} +% verhält} % \begin{macrocode} -\KOMA@key{nokey}{% - \PackageError{% - scrkeyval% - }{% - unknown KOMA option `#1'% - }{% - You've tried to use the KOMA option `#1'.\MessageBreak - But there is no KOMA option with that name.\MessageBreak - See the manual of KOMA-Script for information about known KOMA - options.% +\scr@ifundefinedorrelax{unexpanded}{% + \newcommand*{\g@addto@macro@temp}{}% + \newcommand{\l@addto@macro}[2]{% + \begingroup% + \toks@\expandafter{#1#2}% + \xdef\g@addto@macro@temp{\the\toks@}% + \endgroup + \let#1\g@addto@macro@temp }% -}% -% \end{macrocode} -% \end{option} -% -% \begin{option}{noval} -% Dies ist in Wirklichkeit kein Schlüssel, sondern eine Fehlermeldung -% für das Fehlen eines Wertes bei der Verwendung eines Schlüssels ohne -% Defaultwert. Er kann jedoch wie ein Schlüssel definiert und auch so -% verwendet werden. -% \begin{macrocode} -\KOMA@key{noval}{% - \PackageError{% - scrkbase% - }{% - KOMA option `#1' needs a value% - }{% - You've tried to use the KOMA option `#1' without a - value.\MessageBreak - But this option has no default value, so you have to set a - value.\MessageBreak - See the manual of KOMA-Script for information about the option and - all known\MessageBreak - values.% +}{% + \newcommand{\l@addto@macro}[2]{% + \edef#1{\unexpanded\expandafter{#1#2}}% }% -}% +} % \end{macrocode} -% \end{option} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} % % \begin{macro}{\KOMA@unknown@keyval} % Dieses Makro berichtet über Fehler wegen unbekannter Wertübergabe an @@ -901,50 +1109,41 @@ % \end{macro} % \end{macro} % -% \begin{macro}{\KOMA@DeclareObsoleteOption} -% \changes{v2.96}{2006/08/20}{\cs{CurrentOption wir geschützt}} +% \begin{macro}{\KOMA@DeclareObsoleteOption} +% \changes{v2.96}{2006/08/20}{\cs{CurrentOption wir geschützt}} % Mit Hilfe dieses Makros kann eine Option definiert werden, die % eigentlich obsolete ist. Statt dieser Option wird dann ein Schlüssel % verwendet. Das erste Argument ist optional und muss dann entweder % \cs{PackageInfo}, \cs{PackageInfoNoLine}, \cs{PackageWarning} oder % \cs{PackageWarningNoLine} sein. Das zweite Argument ist der Name der % Option. Das dritte Argument ist das Setzen des gewünschten Schlüssels. -% \begin{macro}{\scr@sr@co} -% \changes{v2.96}{2006/08/20}{neu (intern)} -% Da das \texttt{xkeyval}-Paket leider \cs{CurrentOption} vernichtet, das aber -% innerhalb von \cs{ProcessOptions} nach dem Ausführen der Option noch -% benötigt wird, muss die Anweisung gesichert werden. % \begin{macrocode} -\newcommand*{\scr@sr@co}{} \newcommand*{\KOMA@DeclareObsoleteOption}[3][\@gobbletwo]{% - \DeclareOption{#2}{% - \let\scr@sr@co\CurrentOption - \KOMA@UseObsolete{option}{#1}{#2}{#3}% - \let\CurrentOption\scr@sr@co - }% + \DeclareOption{#2}{\KOMA@UseObsoleteOption{#1}{#2}{#3}}% } % \end{macrocode} -% \end{macro} -% \begin{macro}{\KOMA@UseObsolete} -% Die eigentliche Arbeit wird von diesem Makro erledigt. Ob es sich um -% eine Option oder eine Anweisung handelt wird in Argument 1 -% übergeben. Alle anderen Argumente schließen sich daran an. +% \begin{macro}{\KOMA@UseObsoleteOption} +% \changes{v2.97c}{2007/04/19}{neu (intern)} +% Die eigentliche Arbeit wird von diesem Makro erledigt. Die Argumente sind +% dieselben. % \begin{macrocode} -\newcommand*{\KOMA@UseObsolete}[4]{% - #2{% - scrkbase% - }{% - You've used the obsolete #1 `#3'.\MessageBreak - \protect\KOMAoptions{#4} will be used instead.\MessageBreak - You should do this change too% +\newcommand*{\KOMA@UseObsoleteOption}[3]{% + \let\scr@sr@co\CurrentOption + #1{scrkbase}{% + You've used obsolete option `#2'.\MessageBreak + \protect\KOMAExecuteOptions{#3} will be\MessageBreak + used instead.\MessageBreak + You may simply replace `#2'\MessageBreak + by `#3'% }% - \KOMAoptions{#4}% + \KOMAExecuteOptions{#3}% + \let\CurrentOption\scr@sr@co } % \end{macrocode} -% \end{macro} -% \end{macro} +% \end{macro} +% \end{macro} % -% \begin{macro}{\KOMA@newobsoletecommand} +% \begin{macro}{\KOMA@newobsoletecommand} % Mit Hilfe dieses Makros kann ein Makro definiert werden, das % eigentlich obsolete ist. Das Makro verwendet dann schlicht einen % Schlüssel. Das erste Argument ist optional und muss dann entweder @@ -955,10 +1154,27 @@ % \cs{long} und versteht auch keine Argumente. % \begin{macrocode} \newcommand*{\KOMA@newobsoletecommand}[3][\@gobbletwo]{% - \newcommand*{#2}{\KOMA@UseObsolete{command}{#1}{\string#2}{#3}}% + \newcommand*{#2}{\KOMA@UseObsoleteCommand{#1}{\string#2}{#3}}% } % \end{macrocode} -% \end{macro} +% \begin{macro}{\KOMA@UseObsoleteCommand} +% \changes{v2.97c}{2007/04/19}{neu (intern)} +% Die eigentliche Arbeit wird von diesem Makro erledigt. Die Argumente sind +% dieselben. +% \begin{macrocode} +\newcommand*{\KOMA@UseObsoleteCommand}[3]{% + #1{% + scrkbase% + }{% + You've used the obsolete command `#2'.\MessageBreak + \protect\KOMAoptions{#3} will be used instead.\MessageBreak + You should also replace `#2' by `\protect\KOMAoptions{#3}'% + }% + \KOMAoptions{#3}% +} +% \end{macrocode} +% \end{macro} +% \end{macro} % % % \iffalse diff --git a/Master/texmf-dist/source/latex/koma-script/scrkcomp.dtx b/Master/texmf-dist/source/latex/koma-script/scrkcomp.dtx index 6c2e75a3000..71277a5d2b6 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrkcomp.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrkcomp.dtx @@ -1,4 +1,4 @@ -% \CheckSum{54} +% \CheckSum{56} % \iffalse meta-comment % ====================================================================== % scrkcomp.dtx @@ -58,7 +58,7 @@ %%% From File: scrkcomp.dtx %<*driver> % \fi -\ProvidesFile{scrkcomp.dtx}[2007/03/07 v2.97a KOMA-Script (compatibility)] +\ProvidesFile{scrkcomp.dtx}[2007/06/20 v2.97c KOMA-Script (compatibility)] % \iffalse \documentclass{scrdoc} \usepackage[english,ngerman]{babel} @@ -121,7 +121,7 @@ % \begin{macrocode} \newcommand*{\scr@compatibility}{0} \KOMA@key{version}[last]{% - \scr@ifundefined{scr@v@#1}{% + \scr@ifundefinedorrelax{scr@v@#1}{% \def\scr@compatibility{0}% \ClassWarningNoLine{\KOMAClassName}{% You have set option `version' to value `#1', but\MessageBreak @@ -168,6 +168,10 @@ % \changes{v2.97}{2007/03/02}{Neues Macro} % \begin{macro}{\scr@v@2.97a} % \changes{v2.97a}{2007/03/07}{Neues Macro} +% \begin{macro}{\scr@v@2.97b} +% \changes{v2.97b}{2007/03/25}{Neues Macro} +% \begin{macro}{\scr@v@2.97c} +% \changes{v2.97c}{2007/05/12}{Neues Macro} % \begin{macro}{\scr@v@last} % \changes{v2.9u}{2005/03/05}{Neues Macro} % Nun die unterschiedlichen möglichen Werte (|\scr@v@last| ist jeweils die @@ -184,8 +188,12 @@ \@namedef{scr@v@2.96a}{3} \@namedef{scr@v@2.97}{3} \@namedef{scr@v@2.97a}{3} +\@namedef{scr@v@2.97b}{3} +\@namedef{scr@v@2.97c}{3} \@namedef{scr@v@last}{3} -% \end{macrocode} +% \end{macrocode} +% \end{macro} +% \end{macro} % \end{macro} % \end{macro} % \end{macro} diff --git a/Master/texmf-dist/source/latex/koma-script/scrkfloa.dtx b/Master/texmf-dist/source/latex/koma-script/scrkfloa.dtx index f2bf1f99d7e..c58c1674c62 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrkfloa.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrkfloa.dtx @@ -1,4 +1,4 @@ -% \CheckSum{1052} +% \CheckSum{1064} % \iffalse meta-comment % ====================================================================== % scrkfloa.dtx @@ -58,7 +58,7 @@ %%% From File: scrkfloa.dtx %<*driver> % \fi -\ProvidesFile{scrkfloa.dtx}[2007/02/27 v2.97 KOMA-Script (floats)] +\ProvidesFile{scrkfloa.dtx}[2007/09/17 v2.97c KOMA-Script (floats)] % \iffalse \documentclass[halfparskip-]{scrdoc} \usepackage[english,ngerman]{babel} @@ -923,6 +923,9 @@ % \textsl{float}-Paket} % \changes{v2.95a}{2006/07/13}{diverse Korrekturen für den vertikalen % Abstand u.\,a. bei Verwendung des \textsl{color}-Pakets} +% \changes{v2.97c}{2007/06/06}{\cs{unskip}\cs{strut} eingefügt, um die +% vertikale Ausrichtung im \emph{above}-Fall in eingen Fällen zu +% verbessern} % \begin{macrocode} \newcommand{\@@makecaption}[3]{% \cap@margin @@ -933,7 +936,7 @@ \sbox\@tempboxa{% {\capfont\strut\ignorespaces #1{{\caplabelfont#2\captionformat}}% - #3}% + #3\unskip\strut}% }% \let\@footnotetext=\scr@tmp@footnotetext \let\scr@tmp@footnotetext=\undefined @@ -954,11 +957,12 @@ % wird der \cs{capfont} früher aktiviert, damit darin auch globale % Größsenänderungen für den Titel Platz finden. Außerdem wird die % geänderte Parameterübergabe berücksichtigt. +% \changes{v2.97c}{2007/09/17}{\cs{scr@smashdp} eingefügt} % \begin{macrocode} \ifdofullc@p - {\capfont\@hangfrom{\strut\ignorespaces - #1{{\caplabelfont#2\captionformat}}}% - {#3\par}}% + {\capfont\@hangfrom{\scr@smashdp{\strut\ignorespaces + #1{{\caplabelfont#2\captionformat}}}}% + {#3\unskip\strut\par}}% % \end{macrocode} % Im zweiten Fall ist nun zu unterscheiden, ob nach dem Label ein % Umbruch erfolgen soll oder nicht. Dabei ist der Einzug zu beachten. @@ -969,16 +973,16 @@ \ifdim\cap@indent<\z@ {\capfont\strut\ignorespaces #1{{\caplabelfont #2\captionformat\par}}% - \noindent\hspace*{-\cap@indent}#3\par}% + \noindent\hspace*{-\cap@indent}#3\unskip\strut\par}% \else% \if@capbreak {\capfont\strut\ignorespaces #1{{\caplabelfont #2\captionformat\par}}% \noindent\@hangfrom{\hspace*{\cap@indent}}{#3\par}}% \else - {\capfont\@hangfrom{\strut\hspace*{\cap@indent}}% - {\hspace{-\cap@indent}\ignorespaces#1% - {{\caplabelfont#2\captionformat}}#3\par}}% + {\capfont\@hangfrom{\scr@smashdp\strut\hspace*{\cap@indent}}% + {\hspace{-\cap@indent}\scr@smashdp{\ignorespaces#1% + {{\caplabelfont#2\captionformat}}}#3\unskip\strut\par}}% \fi \fi \fi @@ -999,8 +1003,8 @@ % gesetzt. Im Prinzip ginge das auch direkt ohne erst eine Box zu erzeugen. % \begin{macrocode} \sbox\@tempboxa{% - {\capfont\strut\ignorespaces - #1{{\caplabelfont#2\captionformat}}% + {\capfont\scr@smashdp{\strut\ignorespaces + #1{{\caplabelfont#2\captionformat}}}% #3}% }% \hb@xt@\hsize{\strut\cap@left\box\@tempboxa\cap@right\strut}% diff --git a/Master/texmf-dist/source/latex/koma-script/scrkfont.dtx b/Master/texmf-dist/source/latex/koma-script/scrkfont.dtx index d02a5dea111..aa50fce7b5e 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrkfont.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrkfont.dtx @@ -1,4 +1,4 @@ -% \CheckSum{953} +% \CheckSum{963} % \iffalse meta-comment % ====================================================================== % scrkfont.dtx @@ -58,7 +58,7 @@ %%% From File: scrkfont.dtx %<*driver> % \fi -\ProvidesFile{scrkfont.dtx}[2006/08/18 v2.96 KOMA-Script (font selection)] +\ProvidesFile{scrkfont.dtx}[2007/09/17 v2.97c KOMA-Script (font selection)] % \iffalse \documentclass[halfparskip-]{scrdoc} \usepackage[english,ngerman]{babel} @@ -129,6 +129,8 @@ % \changes{v2.6}{2000/01/04}{neu (intern)} % \begin{macro}{\@pt@@scan} % \changes{v2.6}{2000/01/04}{neu (intern)} +% \changes{v2.97c}{2007/05/12}{\cs{KOMA@UseObsolete} durch +% \cs{KOMA@UseObsoleteOption} ersetzt} % Das Macro \cs{@pt@scan} wird benötigt, um die Schriftgröße nach der alten % Methode zu erkennen. % \begin{macrocode} @@ -139,7 +141,7 @@ \def\@pt@@scan #1pt#2\@pt@@scan{% \ifstr{#2}{pt}{% \ifnumber{#1}{% - \KOMA@UseObsolete{option}{\PackageInfo}{#1#2}{fontsize=#1#2}% + \KOMA@UseObsoleteOption{\PackageInfo}{#1#2}{fontsize=#1#2}% }{\@headlines}% }{\@headlines}% } @@ -154,7 +156,7 @@ % wären. % \begin{macrocode} \KOMA@key{fontsize}{% - \scr@ifundefined{changefontsizes}{% + \scr@ifundefinedorrelax{changefontsizes}{% \@defaultunits\@tempdima#1pt\relax\@nnil \edef\@ptsize{#1}% }{% @@ -186,228 +188,254 @@ \ClassWarning{\KOMAClassName}{% Using fallback calculation to setup font sizes\MessageBreak for basic size `#2'}% - \@defaultunits\@tempdima#2pt\relax\@nnil - \setlength{\@tempdimc}{\@tempdima}% - \addtolength{\@tempdimc}{-10\p@}% - \edef\@ptsize{\strip@pt\@tempdimc}% - \@defaultunits\@tempdimb#1pt\relax\@nnil - \setlength{\@tempdimc}{\dimexpr (100\@tempdimb / \@tempdima * \p@)}% - \edef\@tempb{\the\@tempdimc}% - \setlength{\@tempdimc}{\@tempdima}% - \def\@tempa##1##2##3##4##5\@nnil{\def##1{##2.##3##4}}% - \expandafter\@tempa\expandafter\@tempb\@tempb\@nnil% - \setlength{\abovedisplayskip}{% - \@tempdima \@plus .25\@tempdima \@minus .58\@tempdima}% - \setlength{\abovedisplayshortskip}{\z@ \@plus .25\@tempdima}% - \setlength{\belowdisplayskip}{\abovedisplayskip}% - \setlength{\belowdisplayshortskip}{% - .55\@tempdima \@plus .3\@tempdima \@minus .25\@tempdima}% - \edef\normalsize{% - \noexpand\@setfontsize\noexpand\normalsize + \scr@ifundefinedorrelax{dimexpr}{% + \ClassError{\KOMAClassName}{% + feature only allowed using e-TeX% + }{% + The fallback calculation to setup font sizes was implemented + using e-TeX.\MessageBreak + You should not continue, because the fallback calculation would fail% + } + }{% + \@defaultunits\@tempdima#2pt\relax\@nnil + \setlength{\@tempdimc}{\@tempdima}% + \addtolength{\@tempdimc}{-10\p@}% + \edef\@ptsize{\strip@pt\@tempdimc}% + \@defaultunits\@tempdimb#1pt\relax\@nnil + \setlength{\@tempdimc}{\dimexpr (100\@tempdimb / \@tempdima * \p@)}% + \edef\@tempb{\the\@tempdimc}% + \setlength{\@tempdimc}{\@tempdima}% + \def\@tempa##1##2##3##4##5\@nnil{\def##1{##2.##3##4}}% + \expandafter\@tempa\expandafter\@tempb\@tempb\@nnil% +% \end{macrocode} +% Ab hier ist \cs{@tempdimc} die gewünschte Grundschriftgröße in pt und +% \cs{@tempb} der Faktor für den Grundlinienabstand auf 2 Stellen hinter dem +% Komma. +% \begin{macrocode} + \setlength{\abovedisplayskip}{% + \@tempdima \@plus .25\@tempdima \@minus .58\@tempdima}% + \setlength{\abovedisplayshortskip}{\z@ \@plus .25\@tempdima}% + \setlength{\belowdisplayskip}{\abovedisplayskip}% + \setlength{\belowdisplayshortskip}{% + .55\@tempdima \@plus .3\@tempdima \@minus .25\@tempdima}% + \edef\normalsize{% + \noexpand\@setfontsize\noexpand\normalsize {\the\@tempdima}{\the\@tempdimb}% - \abovedisplayskip \the\abovedisplayskip - \abovedisplayshortskip \the\abovedisplayshortskip - \belowdisplayskip \the\belowdisplayskip - \belowdisplayshortskip \the\belowdisplayshortskip - \let\noexpand\@listi\noexpand\@listI - }% - \setlength{\@tempdima}{0.9125\@tempdimc}% - \setlength{\@tempdimb}{\@tempb\@tempdima}% - \setlength{\abovedisplayskip}{% - \@tempdima \@plus .25\@tempdima \@minus .58\@tempdima}% - \setlength{\abovedisplayshortskip}{\z@ \@plus .25\@tempdima}% - \setlength{\belowdisplayskip}{\abovedisplayskip}% - \setlength{\belowdisplayshortskip}{% - .55\@tempdima \@plus .3\@tempdima \@minus .25\@tempdima}% - \edef\small{% - \noexpand\@setfontsize\noexpand\small + \abovedisplayskip \the\abovedisplayskip + \abovedisplayshortskip \the\abovedisplayshortskip + \belowdisplayskip \the\belowdisplayskip + \belowdisplayshortskip \the\belowdisplayshortskip + \let\noexpand\@listi\noexpand\@listI + }% + \setlength{\@tempdima}{0.9125\@tempdimc}% + \setlength{\@tempdimb}{\@tempb\@tempdima}% + \setlength{\abovedisplayskip}{% + \@tempdima \@plus .25\@tempdima \@minus .58\@tempdima}% + \setlength{\abovedisplayshortskip}{\z@ \@plus .25\@tempdima}% + \setlength{\belowdisplayskip}{\abovedisplayskip}% + \setlength{\belowdisplayshortskip}{% + .55\@tempdima \@plus .3\@tempdima \@minus .25\@tempdima}% + \edef\small{% + \noexpand\@setfontsize\noexpand\small {\the\@tempdima}{\the\@tempdimb}% - \abovedisplayskip \the\abovedisplayskip - \abovedisplayshortskip \the\abovedisplayshortskip - \belowdisplayskip \the\belowdisplayskip - \belowdisplayshortskip \the\belowdisplayshortskip - \let\noexpand\@listi\noexpand\@listi@small - }% - \setlength{\@tempdima}{.83334\@tempdimc}% - \setlength{\@tempdimb}{\@tempb\@tempdima}% - \setlength{\abovedisplayskip}{% - \@tempdima \@plus .25\@tempdima \@minus .58\@tempdima}% - \setlength{\abovedisplayshortskip}{\z@ \@plus .25\@tempdima}% - \setlength{\belowdisplayskip}{\abovedisplayskip}% - \setlength{\belowdisplayshortskip}{% - .55\@tempdima \@plus .3\@tempdima \@minus .25\@tempdima}% - \edef\footnotesize{% - \noexpand\@setfontsize\noexpand\footnotesize + \abovedisplayskip \the\abovedisplayskip + \abovedisplayshortskip \the\abovedisplayshortskip + \belowdisplayskip \the\belowdisplayskip + \belowdisplayshortskip \the\belowdisplayshortskip + \let\noexpand\@listi\noexpand\@listi@small + }% + \setlength{\@tempdima}{.83334\@tempdimc}% + \setlength{\@tempdimb}{\@tempb\@tempdima}% + \setlength{\abovedisplayskip}{% + \@tempdima \@plus .25\@tempdima \@minus .58\@tempdima}% + \setlength{\abovedisplayshortskip}{\z@ \@plus .25\@tempdima}% + \setlength{\belowdisplayskip}{\abovedisplayskip}% + \setlength{\belowdisplayshortskip}{% + .55\@tempdima \@plus .3\@tempdima \@minus .25\@tempdima}% + \edef\footnotesize{% + \noexpand\@setfontsize\noexpand\footnotesize {\the\@tempdima}{\the\@tempdimb}% - \abovedisplayskip \the\abovedisplayskip - \abovedisplayshortskip \the\abovedisplayshortskip - \belowdisplayskip \the\belowdisplayskip - \belowdisplayshortskip \the\belowdisplayshortskip - \let\noexpand\@listi\noexpand\@listi@footnotesize - }% - \setlength{\@tempdima}{.66667\@tempdimc}% - \setlength{\@tempdimb}{\@tempb\@tempdima}% - \edef\scriptsize{% - \noexpand\@setfontsize\noexpand\scriptsize + \abovedisplayskip \the\abovedisplayskip + \abovedisplayshortskip \the\abovedisplayshortskip + \belowdisplayskip \the\belowdisplayskip + \belowdisplayshortskip \the\belowdisplayshortskip + \let\noexpand\@listi\noexpand\@listi@footnotesize + }% + \setlength{\@tempdima}{.66667\@tempdimc}% + \setlength{\@tempdimb}{\@tempb\@tempdima}% + \edef\scriptsize{% + \noexpand\@setfontsize\noexpand\scriptsize {\the\@tempdima}{\the\@tempdimb}% - }% - \setlength{\@tempdima}{.5\@tempdimc}% - \setlength{\@tempdimb}{\@tempb\@tempdima}% - \edef\tiny{% - \noexpand\@setfontsize\noexpand\tiny + }% + \setlength{\@tempdima}{.5\@tempdimc}% + \setlength{\@tempdimb}{\@tempb\@tempdima}% + \edef\tiny{% + \noexpand\@setfontsize\noexpand\tiny {\the\@tempdima}{\the\@tempdimb}% - }% - \setlength{\@tempdima}{1.2\@tempdimc}% - \setlength{\@tempdimb}{\@tempb\@tempdima}% - \edef\large{% - \noexpand\@setfontsize\noexpand\large + }% + \setlength{\@tempdima}{1.2\@tempdimc}% + \setlength{\@tempdimb}{\@tempb\@tempdima}% + \edef\large{% + \noexpand\@setfontsize\noexpand\large {\the\@tempdima}{\the\@tempdimb}% - }% - \setlength{\@tempdima}{1.44\@tempdimc}% - \setlength{\@tempdimb}{\@tempb\@tempdima}% - \edef\Large{% - \noexpand\@setfontsize\noexpand\Large + }% + \setlength{\@tempdima}{1.44\@tempdimc}% + \setlength{\@tempdimb}{\@tempb\@tempdima}% + \edef\Large{% + \noexpand\@setfontsize\noexpand\Large {\the\@tempdima}{\the\@tempdimb}% - }% - \setlength{\@tempdima}{1.728\@tempdimc}% - \setlength{\@tempdimb}{\@tempb\@tempdima}% - \edef\LARGE{% - \noexpand\@setfontsize\noexpand\LARGE + }% + \setlength{\@tempdima}{1.728\@tempdimc}% + \setlength{\@tempdimb}{\@tempb\@tempdima}% + \edef\LARGE{% + \noexpand\@setfontsize\noexpand\LARGE {\the\@tempdima}{\the\@tempdimb}% - }% - \setlength{\@tempdima}{2.074\@tempdimc}% - \setlength{\@tempdimb}{\@tempb\@tempdima}% - \edef\huge{% - \noexpand\@setfontsize\noexpand\huge + }% + \setlength{\@tempdima}{2.074\@tempdimc}% + \setlength{\@tempdimb}{\@tempb\@tempdima}% + \edef\huge{% + \noexpand\@setfontsize\noexpand\huge {\the\@tempdima}{\the\@tempdimb}% - }% - \setlength{\@tempdima}{2.488\@tempdimc}% - \setlength{\@tempdimb}{\@tempb\@tempdima}% - \edef\Huge{% - \noexpand\@setfontsize\noexpand\Huge + }% + \setlength{\@tempdima}{2.488\@tempdimc}% + \setlength{\@tempdimb}{\@tempb\@tempdima}% + \edef\Huge{% + \noexpand\@setfontsize\noexpand\Huge {\the\@tempdima}{\the\@tempdimb}% + }% + \normalsize + \setlength{\footnotesep}{.7\@tempdimc}% + \setlength{\skip\footins}{.9\@tempdimc \@plus .3333\@tempdimc \@minus + .6\@tempdimc}% + \setlength{\floatsep}{\@tempdimc \@plus .1667\@tempdimc \@minus + .3333\@tempdimc}% + \setlength{\textfloatsep}{1.6667\@tempdimc \@plus .1667\@tempdimc \@minus + .3333\@tempdimc}% + \setlength{\intextsep}{\@tempb\@tempdimc \@plus .3333\@tempdimc \@minus + .3333\@tempdimc}% + \setlength{\dblfloatsep}{\@tempb\@tempdimc \@plus .1667\@tempdimc \@minus + .3333\@tempdimc}% + \setlength{\dbltextfloatsep}{\textfloatsep}% + \setlength{\@fptop}{0\p@ \@plus 1fil}% + \setlength{\@fpsep}{.8333\@tempdimc \@plus 2fil}% + \setlength{\@fpbot}{\@fptop}% + \setlength{\@dblfptop}{0\p@ \@plus 1fil}% + \setlength{\@dblfpsep}{.8333\@tempdimc \@plus 2fil}% + \setlength{\@dblfpbot}{\@fptop}% + \setlength{\partopsep}{.25\@tempdimc \@plus .16667\@tempdimc \@minus + .16667\@tempdimc}% + \setlength{\topsep}{.8333\@tempdimc \@plus .3333\@tempdimc \@minus + .5\@tempdimc}% + \setlength{\parsep}{.4167\@tempdimc \@plus .2083\@tempdimc \@minus \p@}% + \@tempswafalse + \begingroup + \def\@list@extra{\aftergroup\@tempswatrue}% + \csname @listi\endcsname + \endgroup + \edef\@listi{\leftmargin\leftmargini + \topsep \the\topsep + \parsep \the\parsep + \itemsep \parsep + \if@tempswa\noexpand\@list@extra\fi + }% + \let\@listI\@listi + \setlength{\topsep}{.75\@tempdimc \@plus .25\@tempdimc \@minus + .41667\@tempdimc}% + \setlength{\parsep}{.375\@tempdimc \@plus .16667\@tempdimc \@minus \p@}% + \@tempswafalse + \begingroup + \def\@list@extra{\aftergroup\@tempswatrue}% + \csname @listi\endcsname + \endgroup + \edef\@listi@small{\leftmargin\leftmargini + \topsep \the\topsep + \parsep \the\parsep + \itemsep \parsep + \if@tempswa\noexpand\@list@extra\fi + }% + \setlength{\topsep}{.5\@tempdimc \@plus .16667\@tempdimc \@minus + .16667\@tempdimc}% + \setlength{\parsep}{.25\@tempdimc \@plus .16667\@tempdimc \@minus \p@}% + \@tempswafalse + \begingroup + \def\@list@extra{\aftergroup\@tempswatrue}% + \csname @listi\endcsname + \endgroup + \edef\@listi@footnotesize{\leftmargin\leftmargini + \topsep \the\topsep + \parsep \the\parsep + \itemsep \parsep + \if@tempswa\noexpand\@list@extra\fi + }% + \setlength{\topsep}{.4167\@tempdimc \@plus .2083\@tempdimc \@minus \p@}% + \setlength{\parsep}{.2083\@tempdimc \@plus \p@ \@minus \p@}% + \@tempswafalse + \begingroup + \def\@list@extra{\aftergroup\@tempswatrue}% + \csname @listii\endcsname + \endgroup + \edef\@listii{\leftmargin\leftmarginii + \labelwidth=\dimexpr \leftmargin-\labelsep + \topsep \the\topsep + \parsep \the\parsep + \itemsep \parsep + \if@tempswa\noexpand\@list@extra\fi + }% + \setlength{\topsep}{.2083\@tempdimc \@plus \p@ \@minus \p@}% + \setlength{\parsep}{\p@ \@plus\z@ \@minus\p@}% + \@tempswafalse + \begingroup + \def\@list@extra{\aftergroup\@tempswatrue}% + \csname @listiii\endcsname + \endgroup + \edef\@listiii{\leftmargin\leftmarginiii + \labelwidth=\dimexpr \leftmargin-\labelsep + \topsep \the\topsep + \parsep \z@ + \partopsep \the\parsep + \itemsep \topsep + \if@tempswa\noexpand\@list@extra\fi + }% + \@tempswafalse + \begingroup + \def\@list@extra{\aftergroup\@tempswatrue}% + \csname @listiv\endcsname + \endgroup + \def\@listiv{\leftmargin\leftmarginiv + \labelwidth=\dimexpr \leftmargin-\labelsep + \if@tempswa\noexpand\@list@extra\fi + }% + \@tempswafalse + \begingroup + \def\@list@extra{\aftergroup\@tempswatrue}% + \csname @listv\endcsname + \endgroup + \def\@listv{\leftmargin\leftmarginv + \labelwidth=\dimexpr \leftmargin-\labelsep + \if@tempswa\noexpand\@list@extra\fi + }% + \@tempswafalse + \begingroup + \def\@list@extra{\aftergroup\@tempswatrue}% + \csname @listvi\endcsname + \endgroup + \def\@listvi{\leftmargin\leftmarginvi + \labelwidth=\dimexpr \leftmargin-\labelsep + \if@tempswa\noexpand\@list@extra\fi + }% + \@listi +% \end{macrocode} +% Einige Platzierungsabstände sind ebenfalls schriftgrößenabhängig: +% \changes{v2.97c}{2007/07/04}{\cs{intextsep} setzen} +% \changes{v2.97c}{2007/07/04}{\cs{dblfloatsep} setzen} +% \changes{v2.97c}{2007/07/04}{\cs{partopsep} setzen} +% \begin{macrocode} + \setlength{\@tempdimb}{\@tempb\@tempdima}% + \setlength{\@tempdima}{\dimexpr \@tempdimb-\@tempdimc}% + \setlength\intextsep{\@tempdimb \@plus.2\@tempdima \@minus.2\@tempdima}% + \setlength\dblfloatsep\intextsep + \setlength\partopsep{.2\@tempdimc \@plus.1\@tempdimc \@minus.1\@tempdimc}% }% - \normalsize - \setlength{\footnotesep}{.7\@tempdimc}% - \setlength{\skip\footins}{.9\@tempdimc \@plus .3333\@tempdimc \@minus - .6\@tempdimc}% - \setlength{\floatsep}{\@tempdimc \@plus .1667\@tempdimc \@minus - .3333\@tempdimc}% - \setlength{\textfloatsep}{1.6667\@tempdimc \@plus .1667\@tempdimc \@minus - .3333\@tempdimc}% - \setlength{\intextsep}{\@tempb\@tempdimc \@plus .3333\@tempdimc \@minus - .3333\@tempdimc}% - \setlength{\dblfloatsep}{\@tempb\@tempdimc \@plus .1667\@tempdimc \@minus - .3333\@tempdimc}% - \setlength{\dbltextfloatsep}{\textfloatsep}% - \setlength{\@fptop}{0\p@ \@plus 1fil}% - \setlength{\@fpsep}{.8333\@tempdimc \@plus 2fil}% - \setlength{\@fpbot}{\@fptop}% - \setlength{\@dblfptop}{0\p@ \@plus 1fil}% - \setlength{\@dblfpsep}{.8333\@tempdimc \@plus 2fil}% - \setlength{\@dblfpbot}{\@fptop}% - \setlength{\partopsep}{.25\@tempdimc \@plus .16667\@tempdimc \@minus - .16667\@tempdimc}% - \setlength{\topsep}{.8333\@tempdimc \@plus .3333\@tempdimc \@minus - .5\@tempdimc}% - \setlength{\parsep}{.4167\@tempdimc \@plus .2083\@tempdimc \@minus \p@}% - \@tempswafalse - \begingroup - \def\@list@extra{\aftergroup\@tempswatrue}% - \csname @listi\endcsname - \endgroup - \edef\@listi{\leftmargin\leftmargini - \topsep \the\topsep - \parsep \the\parsep - \itemsep \parsep - \if@tempswa\noexpand\@list@extra\fi - }% - \let\@listI\@listi - \setlength{\topsep}{.75\@tempdimc \@plus .25\@tempdimc \@minus - .41667\@tempdimc}% - \setlength{\parsep}{.375\@tempdimc \@plus .16667\@tempdimc \@minus \p@}% - \@tempswafalse - \begingroup - \def\@list@extra{\aftergroup\@tempswatrue}% - \csname @listi\endcsname - \endgroup - \edef\@listi@small{\leftmargin\leftmargini - \topsep \the\topsep - \parsep \the\parsep - \itemsep \parsep - \if@tempswa\noexpand\@list@extra\fi - }% - \setlength{\topsep}{.5\@tempdimc \@plus .16667\@tempdimc \@minus - .16667\@tempdimc}% - \setlength{\parsep}{.25\@tempdimc \@plus .16667\@tempdimc \@minus \p@}% - \@tempswafalse - \begingroup - \def\@list@extra{\aftergroup\@tempswatrue}% - \csname @listi\endcsname - \endgroup - \edef\@listi@footnotesize{\leftmargin\leftmargini - \topsep \the\topsep - \parsep \the\parsep - \itemsep \parsep - \if@tempswa\noexpand\@list@extra\fi - }% - \setlength{\topsep}{.4167\@tempdimc \@plus .2083\@tempdimc \@minus \p@}% - \setlength{\parsep}{.2083\@tempdimc \@plus \p@ \@minus \p@}% - \@tempswafalse - \begingroup - \def\@list@extra{\aftergroup\@tempswatrue}% - \csname @listii\endcsname - \endgroup - \edef\@listii{\leftmargin\leftmarginii - \labelwidth=\dimexpr \leftmargin-\labelsep - \topsep \the\topsep - \parsep \the\parsep - \itemsep \parsep - \if@tempswa\noexpand\@list@extra\fi - }% - \setlength{\topsep}{.2083\@tempdimc \@plus \p@ \@minus \p@}% - \setlength{\parsep}{\p@ \@plus\z@ \@minus\p@}% - \@tempswafalse - \begingroup - \def\@list@extra{\aftergroup\@tempswatrue}% - \csname @listiii\endcsname - \endgroup - \edef\@listiii{\leftmargin\leftmarginiii - \labelwidth=\dimexpr \leftmargin-\labelsep - \topsep \the\topsep - \parsep \z@ - \partopsep \the\parsep - \itemsep \topsep - \if@tempswa\noexpand\@list@extra\fi - }% - \@tempswafalse - \begingroup - \def\@list@extra{\aftergroup\@tempswatrue}% - \csname @listiv\endcsname - \endgroup - \def\@listiv{\leftmargin\leftmarginiv - \labelwidth=\dimexpr \leftmargin-\labelsep - \if@tempswa\noexpand\@list@extra\fi - }% - \@tempswafalse - \begingroup - \def\@list@extra{\aftergroup\@tempswatrue}% - \csname @listv\endcsname - \endgroup - \def\@listv{\leftmargin\leftmarginv - \labelwidth=\dimexpr \leftmargin-\labelsep - \if@tempswa\noexpand\@list@extra\fi - }% - \@tempswafalse - \begingroup - \def\@list@extra{\aftergroup\@tempswatrue}% - \csname @listvi\endcsname - \endgroup - \def\@listvi{\leftmargin\leftmarginvi - \labelwidth=\dimexpr \leftmargin-\labelsep - \if@tempswa\noexpand\@list@extra\fi - }% - \@listi } % \end{macrocode} % \end{macro} @@ -590,31 +618,8 @@ % \begin{macro}{\addtokomafont} % \changes{v2.8p}{2001/09/22}{neu} % Dieses Makro funktioniert fast wie obiges, allerdings fügt es der -% vorhandenen Definition etwas an. -% \begin{macro}{\l@addto@macro} -% \changes{v2.8p}{2001/09/22}{neu (intern)} -% Damit dies lokal möglich ist, wird eine lokal arbeitende Variante -% von \cs{g@addto@macro} benötigt, wie sie hier vorgestellt wird. -% \changes{v2.95}{2006/06/02}{korrigiert, damit es sich bezüglich -% Erweiterung um Makrodefinitonen mit Argumenten wie \cs{g@addto@macro} -% verhält} -% \begin{macrocode} -\scr@ifundefined{unexpanded}{% - \newcommand*{\g@addto@macro@temp}{}% - \newcommand{\l@addto@macro}[2]{% - \begingroup% - \toks@\expandafter{#1#2}% - \xdef\g@addto@macro@temp{\the\toks@}% - \endgroup - \let#1\g@addto@macro@temp - }% -}{% - \newcommand{\l@addto@macro}[2]{% - \edef#1{\unexpanded\expandafter{#1#2}}% - }% -} -% \end{macrocode} -% \end{macro} +% vorhandenen Definition etwas an. Dazu wird \cs{l@addto@macro} aus +% \textsf{scrkbase} verwendet. % \begin{macrocode} \newcommand*{\addtokomafont}[2]{% \@ifundefined{scr@fnt@#1}{% diff --git a/Master/texmf-dist/source/latex/koma-script/scrklang.dtx b/Master/texmf-dist/source/latex/koma-script/scrklang.dtx index 4ed360f31c5..857b73c03fc 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrklang.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrklang.dtx @@ -58,7 +58,7 @@ %%% From File: scrklang.dtx %<*driver> % \fi -\ProvidesFile{scrklang.dtx}[2006/06/01 v2.95 KOMA-Script (language)] +\ProvidesFile{scrklang.dtx}[2007/08/10 v2.97c KOMA-Script (language)] % \iffalse \documentclass[halfparskip-]{scrdoc} \usepackage[english,ngerman]{babel} @@ -691,6 +691,7 @@ % \end{macrocode} % \changes{v2.9i}{2002/09/04}{Workaround für den % \texttt{hyphen.cfg}-Bug von Babel} +% \changes{v2.97c}{2007/08/10}{Text einer Warnung geändert} % Wird die \texttt{hyphen.cfg} von Babel verwendet, wird aber das % \textsl{babel}-Paket nicht geladen, so ist \cs{languagename} häufig % nicht korrekt, so dass dann \cs{selectlanguage} mit @@ -707,7 +708,7 @@ but \expandafter\string\csname date\languagename\endcsname\space not defined!\MessageBreak This seems to be a bug at you're `hyphen.cfg'.\MessageBreak - I'l undefine \string\languagename\space to avoid errors% + Undefining macro \string\languagename\space to avoid errors% }% \let\languagename=\undefined \fi diff --git a/Master/texmf-dist/source/latex/koma-script/scrklco.dtx b/Master/texmf-dist/source/latex/koma-script/scrklco.dtx index d493c955334..3ac4aeae269 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrklco.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrklco.dtx @@ -1,4 +1,4 @@ -% \CheckSum{491} +% \CheckSum{499} % \iffalse meta-comment % ====================================================================== % scrklco.dtx @@ -58,7 +58,7 @@ %%% From File: scrklco.dtx %<*driver> % \fi -\ProvidesFile{scrklco.dtx}[2006/03/28 v2.95 KOMA-Script (letter class options)] +\ProvidesFile{scrklco.dtx}[2007/09/12 v2.97c KOMA-Script (letter class options)] % \iffalse \documentclass{scrdoc} \usepackage[english,ngerman]{babel} @@ -106,6 +106,7 @@ % % \begin{macro}{\lco@test} % \changes{v2.95}{2006/03/22}{Neu} +% \changes{v2.97c}{2007/09/12}{an neue Optionenabarbeitung angepasst} % Letter-Class-Optionen können auch für jede per |\documentclass| angegebene % keyval-Option oder sonstige scan-Option (das sind Optionen, die nicht per % |\DeclareOption| definiert wurden) geladen werden. Dabei wird die @@ -114,10 +115,15 @@ % \begin{macrocode} \newcommand*{\lco@test}{% \IfFileExists{\CurrentOption.lco}{% - \let\scr@pti@nerr@r\@gobble - \expandafter\AtEndOfClass\expandafter{\expandafter\LoadLetterOption - \expandafter{\CurrentOption}}% - }% + \expandafter\AtEndOfClass\expandafter{% + \expandafter\LoadLetterOption\expandafter{\CurrentOption}% + }% + \expandafter\def\expandafter\scr@pti@nerr@r\expandafter{% + \expandafter\def\expandafter\scr@pti@nerr@r\expandafter{% + \scr@pti@nerr@r + }% + }% + }{}% } % \end{macrocode} % \end{macro} diff --git a/Master/texmf-dist/source/latex/koma-script/scrkmisc.dtx b/Master/texmf-dist/source/latex/koma-script/scrkmisc.dtx index 173f30c9caf..4ee0c83cfef 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrkmisc.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrkmisc.dtx @@ -1,4 +1,4 @@ -% \CheckSum{181} +% \CheckSum{174} % \iffalse meta-comment % ====================================================================== % scrkmisc.dtx @@ -58,7 +58,7 @@ %%% From File: scrkmisc.dtx %<*driver> % \fi -\ProvidesFile{scrkmisc.dtx}[2006/07/28 v2.95b KOMA-Script (misc)] +\ProvidesFile{scrkmisc.dtx}[2007/07/18 v2.97c KOMA-Script (misc)] % \iffalse \documentclass[halfparskip-]{scrdoc} \usepackage[english,ngerman]{babel} @@ -187,23 +187,6 @@ %<*execoption> % \fi % -% \subsubsection{Keyval-Optionen aktivieren} -% -% Die Behandlung für \textsf{keyval}-Optionen sowie -% \texttt{BCOR\emph{Wert}}, \texttt{DIV\emph{Wert}} und -% \texttt{a\emph{Wert}paper}, \texttt{b\emph{Wert}paper}, -% \texttt{c\emph{Wert}paper} sowie \texttt{d\emph{Wert}paper} und -% \texttt{\emph{Wert}headlines}. -% \begin{macrocode} -\DeclareKeyValOption[% - \let\scr@pti@nerr@r -%<class> \OptionNotUsed -%<package> \@unknownoptionerror -%<letter> \lco@test - \x@paper -]{KOMA} -% \end{macrocode} -% % % \subsection{Standardeinstellungen für die Optionen} % @@ -213,13 +196,18 @@ % % Es müssen die Standardoptionen festgelegt und alle Optionen % ausgewählt werden. +% \changes{v2.97c}{2007/04/19}{Verwendung von \cs{KOMAExecuteOptions} an +% Stelle von \cs{KOMAoptions} und \cs{KOMAProcessOptions} an Stelle von +% \cs{ProcessOptions}} +% \changes{v2.97c}{2007/04/19}{Optionen, die der Voreinstellung ohnehin +% entsprechen, werden nicht explizit gesetzt} +% \changes{v2.97c}{2007/07/18}{Option \texttt{twoside} bei den +% Voreinstellungen rausgenommen} % \begin{macrocode} -\KOMAoptions{% - draft=false,headsepline=false,footsepline=false,parskip=false% -%<article|report|letter> ,twoside=false% -%<book> ,twoside% +\KOMAExecuteOptions{% + parskip=false% } -\ProcessOptions\relax +\KOMAProcessOptions\relax % \end{macrocode} % % diff --git a/Master/texmf-dist/source/latex/koma-script/scrknpap.dtx b/Master/texmf-dist/source/latex/koma-script/scrknpap.dtx index 9738ada9edf..c9a515f9c59 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrknpap.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrknpap.dtx @@ -1,4 +1,4 @@ -% \CheckSum{1716} +% \CheckSum{1848} % \iffalse meta-comment % ====================================================================== % scrknpap.dtx @@ -58,7 +58,7 @@ %%% From File: scrknpap.dtx %<*driver> % \fi -\ProvidesFile{scrknpap.dtx}[2006/12/07 v2.96a KOMA-Script (note-paper)] +\ProvidesFile{scrknpap.dtx}[2007/07/06 v2.97c KOMA-Script (note-paper)] % \iffalse \documentclass{scrdoc} \usepackage[english,ngerman]{babel} @@ -348,6 +348,7 @@ % % \begin{option}{locfield} % \changes{v2.8q}{2001/10/09}{Neu} +% \changes{v2.97c}{2007/03/30}{vertauschte Bedeutung korrigiert} % Mit Hilfe der Optione \texttt{locfield} kann der Platz neben dem Adressfeld % groß oder klein gewählt werden. % \begin{macro}{\if@bigloc} @@ -366,10 +367,10 @@ \KOMA@set@ncmdkey{locfield}{@tempa}{{wide}{0},{narrow}{1}}{#1}% \ifcase\@tempa \endgroup - \@biglocfalse + \@bigloctrue \else \endgroup - \@bigloctrue + \@biglocfalse \fi } \DeclareOption{wlocfield}{\@ObsoleteOption{locfield=wide}} @@ -444,6 +445,19 @@ % verkneifen.}. % Deshalb kann alternativ zum Einschalten des Betreff-Titels hier auch % dies aktiviert werden. +% \begin{macro}{\subject@format} +% \changes{v2.97c}{2007/07/06}{neu (intern)} +% Das Format des Betreffs kann geändert werden. +% \begin{macrocode} +\newcommand{\subject@format}[1]{#1} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\raggedsubject} +% \changes{v2.97c}{2007/07/06}{neu (intern)} +% \begin{macrocode} +\newcommand*{\raggedsubject}{} +% \end{macrocode} +% \end{macro} % \begin{macro}{\if@subj} % \begin{macro}{\@subjtrue} % \begin{macro}{\@subjfalse} @@ -456,25 +470,34 @@ \newif\if@subjafter \KOMA@key{subject}{% \begingroup - \KOMA@set@ncmdkey{locfield}{@tempa}{% + \KOMA@set@ncmdkey{subject}{@tempa}{% {titled}{0},% {untitled}{1},% {afteropening}{2},% - {beforeopening}{3}% + {beforeopening}{3},% + {underlined}{4},% + {left}{5},% + {right}{6},% + {centered}{7}% }{#1}% \ifcase\@tempa - \endgroup - \@subjtrue + \aftergroup\@subjtrue \or - \endgroup - \@subjfalse + \aftergroup\@subjfalse \or - \endgroup - \@subjaftertrue - \else - \endgroup - \@subjafterfalse + \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 + \endgroup } % \end{macrocode} % \end{macro} @@ -601,6 +624,8 @@ % \begin{macro}{\@firsthead} % \begin{macro}{\@gen@firsthead} % \changes{v2.8q}{2002/01/28}{Neu} +% \changes{v2.97c}{2007/05/08}{Dicke der Linie konfigurierbar} +% \changes{v2.97c}{2007/05/08}{Schrift (Farbe) der Linie konfigurierbar} % Bei \texttt{scrlttr2} gibt es die üblichen Seitenstile, allerdings % ist deren Verhalten etwas anders als gewohnt. Dies ist in den % Besonderheiten für Briefen begründet. Zunächst die Voreinstellung für @@ -643,23 +668,26 @@ % \end{macrocode} % Hat \verb|\@rulefrom| den nummerischen Wert 1, so soll direkt auf den % Absender eine Linie folgen. Die Länge dieser Linie kann vom Anwender -% bestimmt oder automatisch gewählt werden. Es wird dabei die -% Pseudo-Länge \texttt{fromrulewidth} verwendet. Ist diese negativ, -% so wird sie automatisch bestimmt. Bei der automatischen -% Längenbestimmung wird dafür gesorgt, dass die Linie nicht bis in das -% Logo ragt, das eventuell rechtsbündig neben dem Absender steht: +% bestimmt oder automatisch gewählt werden. Es werden dabei die +% Pseudo-Längen \texttt{fromrulewidth} und \texttt{fromrulethickness} +% verwendet. Ist \texttt{fromrulewidth} negativ, so wird sie automatisch +% bestimmt. Bei der automatischen Längenbestimmung wird dafür gesorgt, dass +% die Linie nicht bis in das Logo ragt, das eventuell rechtsbündig neben dem +% Absender steht: % \begin{macrocode} {% \ifnum\@rulefrom=1\\[-.5\baselineskip]% - \setlength{\@tempdima}{\useplength{fromrulewidth}}% - \ifdim\@tempdima=\z@ - \setlength{\@tempdima}{\textwidth}% - \if@logo - \settowidth{\@tempdimb}{\usekomavar{fromlogo}}% - \addtolength{\@tempdima}{-\@tempdimb}% + \usekomafont{fromrule}{% + \setlength{\@tempdima}{\useplength{fromrulewidth}}% + \ifdim\@tempdima=\z@ + \setlength{\@tempdima}{\textwidth}% + \if@logo + \settowidth{\@tempdimb}{\usekomavar{fromlogo}}% + \addtolength{\@tempdima}{-\@tempdimb}% + \fi \fi - \fi - \expandafter\rule\expandafter{\the\@tempdima}{.4pt}% + \expandafter\rule\expandafter{\the\@tempdima}{% + \useplength{fromrulethickness}}}% \fi }% \\ @@ -684,11 +712,13 @@ % stehen hat. Die entsprechende Berechnung kann also entfallen. % \begin{macrocode} \ifnum\@rulefrom=2\\[-.5\baselineskip]% - \setlength{\@tempdima}{\useplength{fromrulewidth}}% - \ifdim\@tempdima=\z@ - \setlength{\@tempdima}{\textwidth}% - \fi - \expandafter\rule\expandafter{\the\@tempdima}{.4pt}% + \usekomafont{fromrule}{% + \setlength{\@tempdima}{\useplength{fromrulewidth}}% + \ifdim\@tempdima=\z@ + \setlength{\@tempdima}{\textwidth}% + \fi + \expandafter\rule\expandafter{\the\@tempdima}{% + \useplength{fromrulethickness}}}% \fi \\ }% @@ -716,11 +746,13 @@ \usekomavar{fromname}% {% \ifnum\@rulefrom=1\\[-.5\baselineskip]% - \setlength{\@tempdima}{\useplength{fromrulewidth}}% - \ifdim\@tempdima=\z@ - \setlength{\@tempdima}{\textwidth}% - \fi - \expandafter\rule\expandafter{\the\@tempdima}{.4pt}% + \usekomafont{fromrule}{% + \setlength{\@tempdima}{\useplength{fromrulewidth}}% + \ifdim\@tempdima=\z@ + \setlength{\@tempdima}{\textwidth}% + \fi + \expandafter\rule\expandafter{\the\@tempdima}{% + \useplength{fromrulethickness}}}% \fi }% \\ @@ -732,11 +764,13 @@ \if@email\\\usekomavar*{fromemail}\usekomavar{fromemail}\fi% \if@www\\\usekomavar*{fromurl}\usekomavar{fromurl}\fi% \ifnum\@rulefrom=2\\[-.5\baselineskip]% - \setlength{\@tempdima}{\useplength{fromrulewidth}}% - \ifdim\@tempdima=\z@ - \setlength{\@tempdima}{\textwidth}% - \fi - \expandafter\rule\expandafter{\the\@tempdima}{.4pt}% + \usekomafont{fromrule}{% + \setlength{\@tempdima}{\useplength{fromrulewidth}}% + \ifdim\@tempdima=\z@ + \setlength{\@tempdima}{\textwidth}% + \fi + \expandafter\rule\expandafter{\the\@tempdima}{% + \useplength{fromrulethickness}}}% \fi \\ }% @@ -757,15 +791,17 @@ \usekomavar{fromname}% {% \ifnum\@rulefrom=1\\[-.5\baselineskip]% - \setlength{\@tempdima}{\useplength{fromrulewidth}}% - \ifdim\@tempdima=\z@ - \setlength{\@tempdima}{\textwidth}% - \if@logo - \settowidth{\@tempdimb}{\usekomavar{fromlogo}}% - \addtolength{\@tempdima}{-\@tempdimb}% + \usekomafont{fromrule}{% + \setlength{\@tempdima}{\useplength{fromrulewidth}}% + \ifdim\@tempdima=\z@ + \setlength{\@tempdima}{\textwidth}% + \if@logo + \settowidth{\@tempdimb}{\usekomavar{fromlogo}}% + \addtolength{\@tempdima}{-\@tempdimb}% + \fi \fi - \fi - \expandafter\rule\expandafter{\the\@tempdima}{.4pt}% + \expandafter\rule\expandafter{\the\@tempdima}{% + \useplength{fromrulethickness}}}% \fi }% \\ @@ -777,11 +813,13 @@ \if@email\\\usekomavar*{fromemail}\usekomavar{fromemail}\fi% \if@www\\\usekomavar*{fromurl}\usekomavar{fromurl}\fi% \ifnum\@rulefrom=2\\[-.5\baselineskip]% - \setlength{\@tempdima}{\useplength{fromrulewidth}}% - \ifdim\@tempdima=\z@ - \setlength{\@tempdima}{\textwidth}% - \fi - \expandafter\rule\expandafter{\the\@tempdima}{.4pt}% + \usekomafont{fromrule}{% + \setlength{\@tempdima}{\useplength{fromrulewidth}}% + \ifdim\@tempdima=\z@ + \setlength{\@tempdima}{\textwidth}% + \fi + \expandafter\rule\expandafter{\the\@tempdima}{% + \useplength{fromrulethickness}}}% \fi \\ }% @@ -808,6 +846,14 @@ % % \subsubsection{Schrifteinstellungen für den Briefbogen} % +% \begin{KOMAfont}{foldmark} +% \changes{v2.97c}{2007/05/08}{Neu} +% Die Schrift (hier ist die Farbe der entscheidende Faktor) der Faltmarken. +% \begin{macrocode} +\newkomafont{foldmark}{} +% \end{macrocode} +% \end{KOMAfont} +% % \begin{KOMAfont}{fromname} % \changes{v2.95}{2006/03/23}{jetzt mit \cs{newkomafont}} % Der Absendername im Briefkopf. @@ -824,6 +870,15 @@ % \end{macrocode} % \end{KOMAfont} % +% \begin{KOMAfont}{fromrule} +% \changes{v2.97c}{2007/05/08}{Neu} +% Die Schrift (hier ist die Farbe der entscheidende Faktor) der Linie im +% Absender. +% \begin{macrocode} +\newkomafont{fromrule}{} +% \end{macrocode} +% \end{KOMAfont} +% % \begin{KOMAfont}{backaddress} % \changes{v2.95}{2006/03/23}{jetzt mit \cs{newkomafont}} % Die Rücksendeadresse. @@ -832,6 +887,54 @@ % \end{macrocode} % \end{KOMAfont} % +% \begin{KOMAfont}{specialmail} +% \changes{v2.97c}{2007/07/06}{Neues Font-Element} +% Die Versandart. +% \begin{macrocode} +\newkomafont{specialmail}{} +% \end{macrocode} +% \end{KOMAfont} +% +% \begin{KOMAfont}{addressee} +% \changes{v2.97c}{2007/07/06}{Neues Font-Element} +% Die komplette Anschrift. +% \begin{macrocode} +\newkomafont{addressee}{} +% \end{macrocode} +% \end{KOMAfont} +% +% \begin{KOMAfont}{toname} +% \changes{v2.97c}{2007/07/06}{Neues Font-Element} +% Der Name des Empfängers in der Anschrift. +% \begin{macrocode} +\newkomafont{toname}{} +% \end{macrocode} +% \end{KOMAfont} +% +% \begin{KOMAfont}{toaddress} +% \changes{v2.97c}{2007/07/06}{Neues Font-Element} +% Die Adresse des Empfängers in der Anschrift. +% \begin{macrocode} +\newkomafont{toaddress}{} +% \end{macrocode} +% \end{KOMAfont} +% +% \begin{KOMAfont}{refname} +% \changes{v2.97c}{2007/05/14}{Neues Font-Element} +% Die Feldnamen in der Geschäftszeile. +% \begin{macrocode} +\newkomafont{refname}{\sffamily\scriptsize} +% \end{macrocode} +% \end{KOMAfont} +% +% \begin{KOMAfont}{refvalue} +% \changes{v2.97c}{2007/05/14}{Neues Font-Element} +% Die Feldwerte in der Geschäftszeile. +% \begin{macrocode} +\newkomafont{refvalue}{\sffamily\scriptsize} +% \end{macrocode} +% \end{KOMAfont} +% % \begin{KOMAfont}{title} % \changes{v2.95}{2006/03/23}{jetzt mit \cs{newkomafont}} % Der Brieftitel. @@ -868,6 +971,14 @@ % \end{macrocode} % \end{macro} % \end{macro} +% \begin{macro}{\ltr@len@foldmarkthickness} +% \changes{2.97c}{2007/05/08}{Neu} +% Dicke der Faltmarken. +% \begin{macrocode} +\@newplength{foldmarkthickness} +\@setplength{foldmarkthickness}{.2pt} +% \end{macrocode} +% \end{macro} % \begin{macro}{\ltr@len@toaddrvpos} % \changes{v2.8q}{2001/10/06}{Neu} % Abstand des Adressfensters von der oberen Papierkante. @@ -1006,8 +1117,18 @@ % \changes{v2.8q}{2002/01/28}{Neu} % Die Länge einer eventuell gesetzten Linie im Absender. Negative % Werte bedeuten, dass die Länge automtaisch bestimmt wird. +% \begin{macrocode} \@newplength{fromrulewidth} \@setplength{fromrulewidth}{0pt} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\ltr@len@fromrulethickness} +% \changes{v2.97c}{2007/05/08}{Neue Pseudolänge \texttt{fromrulewidth}} +% Die Dicke einer eventuell gesetzte Linie im Absender. +% \begin{macrocode} +\@newplength{fromrulethickness} +\@setplength{fromrulethickness}{.4pt} +% \end{macrocode} % \end{macro} % % @@ -1111,6 +1232,8 @@ % \changes{v2.8n}{2001/09/07}{Neu} % \changes{v2.95}{2006/06/06}{\cs{vskip} in \cs{vb@t@z} verschoben, damit es % vom Satzspiegel unabhängig wird} +% \changes{v2.97c}{2007/05/08}{Dicke konfigurierbar} +% \changes{v2.97c}{2007/05/08}{Schrift (Farbe) konfigurierbar} % Das geht am einfachsten, wenn wir auch einen Befehl haben, mit dem man eine % einzelne Faltmarke relativ zur aktuellen Position setzen kann. Dies % geschieht mit Hilfe von |\rlap|, damit die horizontale Position unverändert @@ -1118,9 +1241,12 @@ % und die Länder der Marke übergeben. % \begin{macrocode} \newcommand*{\@foldmark}[2]{% - \vb@t@z{\vskip #1% + \vb@t@z{\setlength{\@tempdima}{#1}% + \addtolengthplength[-.5]{\@tempdima}{foldmarkthickness}% + \vskip \@tempdima \rlap{\move@topl\hskip\useplength{foldmarkhpos}% - \rule{#2}{.2pt}}}% + \usekomafont{foldmark}{% + \rule{#2}{\useplength{foldmarkthickness}}}}}% \ignorespaces% } \newcommand*{\@foldmarks}{% @@ -1310,15 +1436,18 @@ \ifkomavarempty{specialmail}{}{% \vbox{\hsize\useplength{toaddrwidth}% \noindent\hspace*{\useplength{specialmailindent}}% - \underline{\usekomavar{specialmail}}% + \specialmail@format{% + \usekomafont{specialmail}\usekomavar{specialmail}}% \hspace*{\useplength{specialmailrightindent}}}% }% \vfil% \noindent\hskip\useplength{toaddrindent}% \setlength{\@tempdima}{\useplength{toaddrwidth}}% \addtolengthplength[-2]{\@tempdima}{toaddrindent}% - \vbox{\hsize\@tempdima% - \noindent\usekomavar{toname}\\\usekomavar{toaddress}}% + \vbox{\hsize\@tempdima\raggedright + \usekomafont{addressee}{% + \usekomafont{toname}{\usekomavar{toname}\\}% + \usekomafont{toaddress}{\usekomavar{toaddress}}}}% \vfil\null}% {address field}{toaddrheight}% {\begin{letter} or you\MessageBreak @@ -1331,6 +1460,15 @@ \fi } % \end{macrocode} +% \begin{macro}{\specialmail@format} +% \changes{v2.97c}{2007/07/06}{neu (intern)} +% Die Anweisung, die für das Aussehen der Versandart zuständig ist. +% \begin{macrocode} +\newcommand*{\specialmail@format}[1]{} +\let\specialmail@format\underline +% \end{macrocode} +% \end{macro} +% % \begin{macro}{\@ogobble} % \changes{v2.8q}{2002/01/22}{Neu} % In obiger Definition wird das Makro \cs{@ogobble} verwendet, um @@ -1406,6 +1544,7 @@ % \begin{macro}{\@datefield} % \changes{v2.8q}{2002/01/14}{Schalter \cs{if@tempwa} wird bereits hier auf % \texttt{true} gesetzt} +% \changes{v2.97c}{2007/05/14}{Neue Fontelemente} % Je nachdem, welche Felder definiert sind, muss eine geschäftsmäßiger % Standardbrief oder ein eher persönliches Aussehen gewählt werden. % \begin{macro}{\@set@reffield} @@ -1417,12 +1556,12 @@ % \begin{macrocode} \newcommand*{\@set@reffield}[1]{% \ifkomavarempty{#1}{}{% - \settowidth{\@tempdima}{\strut\usekomavar{#1}}% - \setbox0\hbox{\strut\scriptsize\sffamily\usekomavar*{#1}}% + \settowidth{\@tempdima}{\strut\usekomafont{refvalue}\usekomavar{#1}}% + \setbox0\hbox{\strut\usekomafont{refname}\usekomavar*{#1}}% \ifdim \@tempdima<\wd0\setlength{\@tempdima}{\wd0}\fi \if@tempswa\enskip\hfill\fi \parbox[t]{\@tempdima}{\noindent\raggedright - \strut\box0\\\strut\usekomavar{#1}}% + \strut\box0\\\usekomafont{refvalue}\strut\usekomavar{#1}}% \@tempswatrue }% } @@ -1487,6 +1626,7 @@ % Dokumentation angepasst} % \changes{v2.9l}{2003/01/28}{Berechnung von \texttt{refhpos} hinzugefügt} % \changes{v2.95}{2006/03/23}{Absatzeinzug mit \cs{setparsizes} abschalten} +% \changes{v2.97c}{2007/05/14}{Neue Font-Elemente} % \begin{macrocode} \newcommand*{\@datefield}{{% \setparsizes{\z@}{\z@}{\z@ plus 1fil}\par@updaterelative @@ -1546,7 +1686,25 @@ % \begin{macrocode} \rlap{\noindent\move@topl\hskip\useplength{refhpos}% \vbox{\hsize\useplength{refwidth}% - \noindent\@set@reffields + \noindent\@set@reffields% +% \end{macrocode} +% Seit Version~2.97c wird hier auch noch getestet, ob die Geschäftszeile +% möglicherweise mit zu großer Schrift gesetzt wird. +% \begin{macrocode} + \if@tempswa + \setbox0\hbox{\usekomafont{refname}\strutbox}% + \ifdim\ht0>\ht\strutbox + \ClassWarningNoLine{scrlttr}{% + Font element `refname' should not be larger than + \string\normalsize!}% + \fi + \setbox0\hbox{\usekomafont{refvalue}\strutbox}% + \ifdim\ht0>\ht\strutbox + \ClassWarningNoLine{scrlttr}{% + Font element `refvalue' should not be larger than + \string\normalsize!}% + \fi + \fi \ifkomavarempty{date}{% \if@tempswa \typeout{Reference line(s): with fields but without date}% @@ -1557,12 +1715,13 @@ }{% \if@tempswa \typeout{Reference line(s): with fields and date}% - \settowidth{\@tempdima}{\strut\usekomavar{date}}% - \setbox0\hbox{\scriptsize\sffamily\usekomavar*{date}}% + \settowidth{\@tempdima}{\strut + \usekomafont{refvalue}\usekomavar{date}}% + \setbox0\hbox{\usekomafont{refname}\usekomavar*{date}}% \ifdim \@tempdima<\wd0\setlength{\@tempdima}{\wd0}\fi \enskip\hfill \parbox[t]{\@tempdima}{\noindent\raggedright% - \strut\box0\\\strut\usekomavar{date}}% + \strut\box0\\\strut\usekomafont{refvalue}\usekomavar{date}}% \else \typeout{Reference line: only place and date}% \enskip\hfill @@ -1612,15 +1771,22 @@ \ifkomavarempty{subject}{% \typeout{Subject: no}% }{% - \if@subjafter% - \typeout{Subject: after opening}% - \centering% - \else% - \typeout{Subject: before opening}% - \noindent% - \fi% - {\usekomafont{subject}\if@subj\@hangfrom{\usekomavar*{subject}}\fi% - {\usekomavar{subject}}\par}\vskip2\baselineskip% + \ifx\raggedsubject\@empty + \if@subjafter% + \typeout{Subject: after opening}% + \let\raggedsubject\centering% + \else% + \typeout{Subject: before opening}% + \def\raggedsubject{\noindent\@hangfrom}% + \fi% + \fi + {% + \usekomafont{subject}% + \show\raggedsubject + \raggedsubject{\if@subj \subject@format{\strut\ignorespaces + \usekomavar*{subject}}\fi}% + \subject@format{\strut\ignorespaces\usekomavar{subject}}\par + }\vskip2\baselineskip% }% }% } @@ -1716,12 +1882,6 @@ % viele Briefe erzeugt werden. Eine der Abweichungen von der % Standardklasse besteht darin, dass als optionales Argument Optionen % gesetzt werden können. -% \begin{macro}{\stopletter} -% \begin{macro}{\@processto} -% \changes{v2.9r}{2004/06/16}{robust gegen leeren Empfänger} -% \begin{macro}{\@xproc} -% Die Adresse, die als Argument der Briefumgebung übergeben wird, muss in Name -% und Adresse zerlegt werden. % \begin{macrocode} \newenvironment{letter}[2][]{% % \end{macrocode} @@ -1746,6 +1906,15 @@ }{% \stopletter\@@par\pagebreak\@@par% } +% \end{macrocode} +% \begin{macro}{\stopletter} +% Damit man Material am Ende des Briefes einschleusen kann. +% \begin{macro}{\@processto} +% \changes{v2.9r}{2004/06/16}{robust gegen leeren Empfänger} +% \begin{macro}{\@xproc} +% Die Adresse, die als Argument der Briefumgebung übergeben wird, muss in Name +% und Adresse zerlegt werden. +% \begin{macrocode} \newcommand*{\stopletter}{} \newcommand{\@processto}[1]{% \ifx\relax#1\relax\else @@ -1760,6 +1929,16 @@ % \end{macro} % \end{macro} % \end{macro} +% \begin{macro}{\flushbottom} +% \changes{v2.97c}{2007/05/17}{neue Erweiterung} +% Das Verhalten muss auf der letzten Briefseite wieder \cs{raggedbottom} +% ähneln. Das wird über \cs{stopletter} erreicht. +% \begin{macrocode} +\g@addto@macro\flushbottom{% + \g@addto@macro\stopletter{\vskip \z@\@plus.0001fil\relax}% +} +% \end{macrocode} +% \end{macro} % \end{environment} % % \begin{macro}{\AtBeginLetter} diff --git a/Master/texmf-dist/source/latex/koma-script/scrkpage.dtx b/Master/texmf-dist/source/latex/koma-script/scrkpage.dtx index 17db19b8eac..4e6162c07e9 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrkpage.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrkpage.dtx @@ -1,4 +1,4 @@ -% \CheckSum{592} +% \CheckSum{511} % \iffalse meta-comment % ====================================================================== % scrkpage.dtx @@ -58,7 +58,7 @@ %%% From File: scrkpage.dtx %<*driver> % \fi -\ProvidesFile{scrkpage.dtx}[2007/01/03 v2.96a KOMA-Script (page style)] +\ProvidesFile{scrkpage.dtx}[2007/09/25 v2.97c KOMA-Script (page style)] % \iffalse \documentclass[halfparskip-]{scrdoc} \usepackage[english,ngerman]{babel} @@ -103,6 +103,8 @@ % \begin{option}{headsepline} % \changes{v2.95c}{2006/08/11}{BugFix: Argument bei % \cs{PassOptionsToPackage} vertauscht} +% \changes{v2.97c}{2007/04/19}{Option \texttt{headinclude} wird nicht +% mehr an \textsf{typearea} geschickt} % \begin{option}{headnosepline} % Der Kopfteil kann mit einer Linie vom Textbereich getrennt werden. % \begin{macro}{\if@hsl} @@ -124,9 +126,7 @@ \KOMA@set@ifkey{headsepline}{@hsl}{#1}% \@ifpackageloaded{typearea}{% \KOMAoptions{headinclude=#1}% - }{% - \PassOptionsToPackage{headinclude=#1}{typearea}% - }% + }{}% } \KOMA@DeclareObsoleteOption[\PackageInfo]{headnosepline}{headsepline=false} % \end{macrocode} @@ -139,6 +139,8 @@ % die Paket-Angabe} % \changes{v2.95c}{2006/08/11}{BugFix: Argument bei % \cs{PassOptionsToPackage} vertauscht} +% \changes{v2.97c}{2007/04/19}{Option \texttt{footinclude} wird nicht +% mehr an \textsf{typearea} geschickt} % \begin{option}{footnosepline} % Der Fußteil kann mit einer Linie vom Textbereich getrennt werden. % \begin{macro}{\if@fsl} @@ -160,9 +162,7 @@ \KOMA@set@ifkey{footsepline}{@fsl}{#1}% \@ifpackageloaded{typearea}{% \KOMAoptions{footinclude=#1}% - }{% - \PassOptionsToPackage{footinclude=#1}{typearea}% - }% + }{}% } \KOMA@DeclareObsoleteOption[\PackageInfo]{footnosepline}{footsepline=false} % \end{macrocode} @@ -179,6 +179,15 @@ % % \subsection{Optionen und Anweisungen für leere Seiten} % +% \begin{macro}{\if@twoside} +% \changes{v2.97c}{2007/07/18}{Schalter passend setzen} +% Die Voreinstellung wird direkt passend gesetzt. +% \begin{macrocode} +%<article|report|letter>\@twosidefalse +%<book>\@twosidetrue +% \end{macrocode} +% \end{macro} +% % \begin{option}{cleardoublepage} % \changes{v2.95}{2004/08/24}{neuer Schalter} % \changes{v2.96a}{2007/01/03}{Wert \texttt{current} sollte nun @@ -374,6 +383,7 @@ % \changes{v2.8o}{2001/09/14}{neues Element \texttt{pagehead}} % \begin{macro}{\scr@fnt@wrn@pagehead} % \changes{v2.8o}{2001/09/14}{neue Warnung für Element \texttt{pagehead}} +% \changes{v2.97c}{2007/09/25}{Warnung geändert} % \begin{KOMAfont}{pagefoot} % \changes{v2.8o}{2001/09/14}{neues Element \texttt{pagefoot}} % Hier werden die Elemente definiert, deren Schriftart dann geändert @@ -383,8 +393,8 @@ \aliaskomafont{pagination}{pagenumber} \newcommand*{\scr@fnt@pagehead}{\headfont} \newcommand*{\scr@fnt@wrn@pagehead}[1]{% - font selection of elements `pagehead' and `pagefoot'\MessageBreak - changed, because they are same% + `pagehead' and `pagefoot' are aliases for the same¸\MessageBreak + font element, changed% } \aliaskomafont{pagefoot}{pagehead} % \end{macrocode} @@ -408,219 +418,176 @@ % Zurück zur Definition der Seitenstile. Hier gibt es erhebliche Unterschiede % zwischen der Briefklasse und den anderen Klassen. Das beginnt schon damit, % dass es spezielle Stile für doppelseitige Briefe nicht gibt. +% \changes{v2.1b}{1994/12/31}{im einseitigen Seitenstil \cs{markboth} durch +% \cs{markright} ersetzt} +% \changes{v2.2a}{1995/02/07}{im einseitigen Seitenstil bei \textsf{scrartcl} +% und \texttt{oneside} \cs{subsectionmark} eingefügt} +% \changes{v2.2a}{1995/02/07}{im einseitigen Seitenstil bei \textsf{scrreprt} +% und \texttt{oneside} \cs{sectionmark} eingefügt} +% \changes{v2.0e}{1994/08/17}{im einseitigen Seitenstil \cs{markboth} durch +% \cs{markright} ersetzt} +% \changes{v2.97c}{2007/07/18}{Unterscheidung auf \texttt{twoside} so spät wie +% möglich} +% Hinweis: Die \emph{even}-Varianten werden im einseitigen Satz vom +% \LaTeX-Kern selbst nicht verwendet. Es schadet also nicht, sie trotzdem +% identisch zum doppelseitigen Satz zu definieren. % \begin{macrocode} %<*!letter> -\if@twoside - \renewcommand*{\ps@plain}{% - \renewcommand*{\@evenhead}{}% - \renewcommand*{\@oddhead}{}% - \renewcommand*{\@evenfoot}{% - \set@tempdima@hw\hss\hb@xt@ \@tempdima{\vbox{% - \if@fsl \hrule \vskip 3\p@ \fi - \hb@xt@ \@tempdima{{\pagemark\hfil}}}}}% - \renewcommand*{\@oddfoot}{% - \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% - \if@fsl \hrule \vskip 3\p@ \fi - \hb@xt@ \@tempdima{{\hfil\pagemark}}}}\hss}% - }% - \newcommand*{\ps@headings}{\let\@mkboth\markboth - \renewcommand*{\@evenhead}{% - \set@tempdima@hw\hss\hb@xt@ \@tempdima{\vbox{% - \hb@xt@ \@tempdima{{\headfont\strut\leftmark\hfil}}% - \if@hsl \vskip 1.5\p@ \hrule \fi}}}% - \renewcommand*{\@oddhead}{% - \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% - \hb@xt@ \@tempdima{{\headfont\hfil\strut\rightmark}}% - \if@hsl \vskip 1.5\p@ \hrule \fi}}\hss}% - \renewcommand*{\@evenfoot}{% - \set@tempdima@hw\hss\hb@xt@ \@tempdima{\vbox{% - \if@fsl \hrule \vskip 3\p@ \fi - \hb@xt@ \@tempdima{{\pagemark\hfil}}}}}% - \renewcommand*{\@oddfoot}{% - \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% - \if@fsl \hrule \vskip 3\p@ \fi - \hb@xt@ \@tempdima{{\hfil\pagemark}}}}\hss}% +\renewcommand*{\ps@plain}{% + \renewcommand*{\@oddhead}{}% + \let\@evenhead\@oddhead + \renewcommand*{\@evenfoot}{% + \set@tempdima@hw\hss\hb@xt@ \@tempdima{\vbox{% + \if@fsl \hrule \vskip 3\p@ \fi + \hb@xt@ \@tempdima{{\pagemark\hfil}}}}}% + \renewcommand*{\@oddfoot}{% + \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% + \if@fsl \hrule \vskip 3\p@ \fi + \hb@xt@ \@tempdima{{\hfil\pagemark + \if@twoside\else\hfil\fi}}}}\hss}% +}% +\newcommand*{\ps@headings}{\let\@mkboth\markboth + \renewcommand*{\@evenhead}{% + \set@tempdima@hw\hss\hb@xt@ \@tempdima{\vbox{% + \hb@xt@ \@tempdima{{\headfont\strut\leftmark\hfil}}% + \if@hsl \vskip 1.5\p@ \hrule \fi}}}% + \renewcommand*{\@oddhead}{% + \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% + \hb@xt@ \@tempdima{{\headfont\hfil\strut\rightmark + \if@twoside\else\hfil\fi}}% + \if@hsl \vskip 1.5\p@ \hrule \fi}}\hss}% + \renewcommand*{\@evenfoot}{% + \set@tempdima@hw\hss\hb@xt@ \@tempdima{\vbox{% + \if@fsl \hrule \vskip 3\p@ \fi + \hb@xt@ \@tempdima{{\pagemark\hfil}}}}}% + \renewcommand*{\@oddfoot}{% + \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% + \if@fsl \hrule \vskip 3\p@ \fi + \hb@xt@ \@tempdima{{\hfil\pagemark + \if@twoside\else\hfil\fi}}}}\hss}% %<*article> - \renewcommand*{\sectionmark}[1]{% - \markboth{\ifnum \c@secnumdepth >\z@% - \sectionmarkformat\fi ##1}{}}% - \renewcommand*{\subsectionmark}[1]{% + \renewcommand*{\sectionmark}[1]{% + \if@twoside\expandafter\markboth\else\expandafter\markright\fi + {\ifnum \c@secnumdepth >\z@% + \sectionmarkformat\fi ##1}{}}% + \renewcommand*{\subsectionmark}[1]{% + \if@twoside \markright{\ifnum \c@secnumdepth >\@ne% - \subsectionmarkformat\fi ##1}}% + \subsectionmarkformat\fi ##1}% + \fi + }% %</article> %<*report|book> - \renewcommand*{\chaptermark}[1]{% - \markboth{\ifnum \c@secnumdepth >\m@ne -%<book> \if@mainmatter - \chaptermarkformat -%<book> \fi - \fi - ##1}{}% - }% - \renewcommand*{\sectionmark}[1]{% + \renewcommand*{\chaptermark}[1]{% + \if@twoside\expandafter\markboth\else\expandafter\markright\fi + {\ifnum \c@secnumdepth >\m@ne +%<book> \if@mainmatter + \chaptermarkformat +%<book> \fi + \fi + ##1}{}% + }% + \renewcommand*{\sectionmark}[1]{% + \if@twoside \markright{\ifnum \c@secnumdepth >\z@ - \sectionmarkformat\fi - ##1}}% -%</report|book> + \sectionmarkformat\fi + ##1}% + \fi }% - \newcommand*{\ps@myheadings}{\let\@mkboth\@gobbletwo - \renewcommand*{\@evenhead}{% - \set@tempdima@hw\hss\hb@xt@ \@tempdima{\vbox{% - \hb@xt@ \@tempdima{{\headfont\strut\leftmark\hfil}}% - \if@hsl \vskip 1.5\p@ \hrule \fi}}}% - \renewcommand*{\@oddhead}{% - \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% - \hb@xt@ \@tempdima{{\headfont\hfil\strut\rightmark}}% - \if@hsl \vskip 1.5\p@ \hrule \fi}}\hss}% - \renewcommand*{\@evenfoot}{% - \set@tempdima@hw\hss\hb@xt@ \@tempdima{\vbox{% - \if@fsl \hrule \vskip 3\p@ \fi - \hb@xt@ \@tempdima{{\pagemark\hfil}}}}}% - \renewcommand*{\@oddfoot}{% - \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% - \if@fsl \hrule \vskip 3\p@ \fi - \hb@xt@ \@tempdima{{\hfil\pagemark}}}}\hss}% -%<!article> \renewcommand*{\chaptermark}[1]{}% -%<article> \renewcommand*{\subsectionmark}[1]{}% - \renewcommand*{\sectionmark}[1]{}% - } -\else +%</report|book> +}% +\newcommand*{\ps@myheadings}{\let\@mkboth\@gobbletwo + \renewcommand*{\@evenhead}{% + \set@tempdima@hw\hss\hb@xt@ \@tempdima{\vbox{% + \hb@xt@ \@tempdima{{\headfont\strut\leftmark\hfil}}% + \if@hsl \vskip 1.5\p@ \hrule \fi}}}% + \renewcommand*{\@oddhead}{% + \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% + \hb@xt@ \@tempdima{{\headfont\hfil\strut\rightmark + \if@twoside\else\hfil\fi}}% + \if@hsl \vskip 1.5\p@ \hrule \fi}}\hss}% + \renewcommand*{\@evenfoot}{% + \set@tempdima@hw\hss\hb@xt@ \@tempdima{\vbox{% + \if@fsl \hrule \vskip 3\p@ \fi + \hb@xt@ \@tempdima{{\pagemark\hfil}}}}}% + \renewcommand*{\@oddfoot}{% + \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% + \if@fsl \hrule \vskip 3\p@ \fi + \hb@xt@ \@tempdima{{\hfil\pagemark + \if@twoside\else\hfil\fi}}}}\hss}% +%<!article> \renewcommand*{\chaptermark}[1]{}% +%<article> \renewcommand*{\subsectionmark}[1]{}% + \renewcommand*{\sectionmark}[1]{}% +} %</!letter> - \renewcommand*{\ps@plain}{% - \renewcommand*{\@oddhead}{% %<*letter> - \vbox{\vbox{\hsize=\textwidth\hbox to\textwidth{% - \parbox[b]{\textwidth}{\strut - \ifnum\@pageat>-1 - \ifnum\@pageat<3 - \ifcase\@pageat\raggedright\or\centering\or\raggedleft\fi - \pagemark - \else - \hfill - \fi +\renewcommand*{\ps@plain}{% + \renewcommand*{\@oddhead}{% + \vbox{\vbox{\hsize=\textwidth\hbox to\textwidth{% + \parbox[b]{\textwidth}{\strut + \ifnum\@pageat>-1 + \ifnum\@pageat<3 + \ifcase\@pageat\raggedright\or\centering\or\raggedleft\fi + \pagemark \else \hfill \fi - }% + \else + \hfill + \fi }% - \if@hsl\kern1pt\rule{\textwidth}{.4pt}\fi }% + \if@hsl\kern1pt\rule{\textwidth}{.4pt}\fi }% -%</letter> }% - \let\@evenhead\@oddhead% - \renewcommand*{\@oddfoot}{% -%<*letter> - \parbox[t]{\textwidth}{% - \if@fsl - {% - \raggedright% - \vskip-\baselineskip\vskip.4pt - \hrulefill\\ - }% - \fi - \ifnum\@pageat>2 - \ifcase\@pageat\or\or\or\raggedright\or\centering\or\raggedleft\fi - \strut\pagemark - \else - \hfill - \fi - }% -%</letter> -%<*!letter> - \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% - \if@fsl \hrule \vskip 3\p@ \fi - \hb@xt@ \@tempdima{{\hfil\pagemark\hfil}}}}\hss -%</!letter> + }% + \let\@evenhead\@oddhead% + \renewcommand*{\@oddfoot}{% + \parbox[t]{\textwidth}{% + \if@fsl + {% + \raggedright% + \vskip-\baselineskip\vskip.4pt + \hrulefill\\ + }% + \fi + \ifnum\@pageat>2 + \ifcase\@pageat\or\or\or\raggedright\or\centering\or\raggedleft\fi + \strut\pagemark + \else + \hfill + \fi }% - \let\@evenfoot\@oddfoot - } - \newcommand*{\ps@headings}{\let\@mkboth\markboth - \renewcommand*{\@oddhead}{% -%<*letter> - \vbox{% - \vbox{\hsize=\textwidth\hbox to\textwidth{\headfont\@nexthead}}% - \if@hsl\kern1pt\rule{\textwidth}{.4pt}\fi% - }% -%</letter> -%<*!letter> - \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% - \hb@xt@ \@tempdima{{\headfont\hfil\strut\rightmark\hfil}} - \if@hsl \vskip 1.5\p@ \hrule \fi}}\hss -%</!letter> + }% + \let\@evenfoot\@oddfoot +} +\newcommand*{\ps@headings}{\let\@mkboth\markboth + \renewcommand*{\@oddhead}{% + \vbox{% + \vbox{\hsize=\textwidth\hbox to\textwidth{\headfont\@nexthead}}% + \if@hsl\kern1pt\rule{\textwidth}{.4pt}\fi% }% - \let\@evenhead\@oddhead - \renewcommand*{\@oddfoot}{% -%<*letter> - \parbox[t]{\textwidth}{% - \if@fsl - {% - \raggedright% - \vskip-\baselineskip\vskip.4pt - \hrulefill\\ - }% - \fi - \vbox{\hsize=\textwidth\hbox to\textwidth{\headfont\@nextfoot}}% - }% + }% + \let\@evenhead\@oddhead + \renewcommand*{\@oddfoot}{% + \parbox[t]{\textwidth}{% + \if@fsl + {% + \raggedright% + \vskip-\baselineskip\vskip.4pt + \hrulefill\\ + }% + \fi + \vbox{\hsize=\textwidth\hbox to\textwidth{\headfont\@nextfoot}}% }% + }% + \let\@evenfoot\@oddfoot +} +\newcommand*{\ps@myheadings}{% + \ps@headings + \let\@mkboth\@gobbletwo +} %</letter> -%<*!letter> - \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% - \if@fsl \hrule \vskip 3\p@ \fi - \hb@xt@ \@tempdima{{\hfil\pagemark\hfil}}}\hss}}% -%<*article> -% \end{macrocode} -% \changes{v2.1b}{1994/12/31}{im einseitigen Seitenstil -% \cs{markboth} durch \cs{markright} ersetzt} -% \changes{v2.2a}{1995/02/07}{im einseitigen Seitenstil -% bei \textsf{scrartcl} und \texttt{oneside} \cs{subsectionmark} -% eingefügt} -% \changes{v2.2a}{1995/02/07}{im einseitigen Seitenstil bei -% \textsf{scrreprt} und \texttt{oneside} \cs{sectionmark} -% eingefügt} -% \begin{macrocode} - \renewcommand*{\subsectionmark}[1]{}% - \renewcommand*{\sectionmark}[1]{% - \markright{\ifnum \c@secnumdepth >\z@\sectionmarkformat\fi - ##1}}% -%</article> -% \end{macrocode} -% \changes{v2.0e}{1994/08/17}{im einseitigen Seitenstil -% \cs{markboth} durch \cs{markright} ersetzt} -% \begin{macrocode} -%<*report|book> - \renewcommand*{\sectionmark}[1]{}% - \renewcommand*{\chaptermark}[1]{% - \markright{\ifnum \c@secnumdepth >\m@ne -%<book> \if@mainmatter - \chaptermarkformat -%<book> \fi - \fi - ##1}}% -%</report|book> -%</!letter> - \let\@evenfoot\@oddfoot - } - \newcommand*{\ps@myheadings}{% -%<letter> \ps@headings - \let\@mkboth\@gobbletwo -%<*!letter> - \renewcommand*{\@evenhead}{}% - \renewcommand*{\@oddhead}{% - \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% - \hb@xt@ \@tempdima{{\headfont\hfil\strut\rightmark\hfil}}% - \if@hsl \vskip 1.5\p@ \hrule \fi}}\hss}% - \renewcommand*{\@evenfoot}{}% - \renewcommand*{\@oddfoot}{% - \set@tempdima@hw\hb@xt@ \@tempdima{\vbox{% - \if@fsl \hrule \vskip 3\p@ \fi - \hb@xt@ \@tempdima{{\hfil\pagemark\hfil}}}}\hss}% -%<article> \renewcommand*{\subsectionmark}[1]{}% -%<!article> \renewcommand*{\chaptermark}[1]{}% - \renewcommand*{\sectionmark}[1]{}% -%</!letter> - } -%<!letter>\fi % \end{macrocode} % \end{macro} % \end{macro} diff --git a/Master/texmf-dist/source/latex/koma-script/scrkplen.dtx b/Master/texmf-dist/source/latex/koma-script/scrkplen.dtx index 675124c30c1..f667167e0dc 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrkplen.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrkplen.dtx @@ -1,4 +1,4 @@ -% \CheckSum{94} +% \CheckSum{100} % \iffalse meta-comment % ====================================================================== % scrkplen.dtx @@ -58,7 +58,7 @@ %%% From File: scrkplen.dtx %<*driver> % \fi -\ProvidesFile{scrkplen.dtx}[2006/03/28 v2.95 KOMA-Script (pseudo length)] +\ProvidesFile{scrkplen.dtx}[2007/09/17 v2.97c KOMA-Script (pseudo length)] % \iffalse \documentclass{scrdoc} \usepackage[english,ngerman]{babel} @@ -145,13 +145,20 @@ % % \begin{macro}{\useplength} % \changes{v2.8q}{2001/10/06}{Neu} +% \changes{v2.97c}{2007/09/17}{\cs{dimexpr} statt \cs{number} verwendet, +% wenn \eTeX{} verwendet wird} % Natürlich muss auf eine solche Pseudo-Länge auch wieder lesend % zugeriffen werden können. Wir definieren dies hier so, dass es -% außerdem möglich ist, ein Vorzeichen zu verwenden. Ein Faktor ist -% allerdings nicht möglich. +% außerdem möglich ist, ein Vorzeichen oder einen Faktor zu verwenden. Dafür +% wird allerdings \eTeX{} benötigt. % \begin{macrocode} -\newcommand*{\useplength}[1]{% - \expandafter\number\expandafter\csname ltr@len@#1\endcsname} +\scr@ifundefinedorrelax{dimexpr}{% + \newcommand*{\useplength}[1]{% + \number \csname ltx@len@#1\endcsname\relax}% +}{% + \newcommand*{\useplength}[1]{% + \dimexpr \csname ltr@len@#1\endcsname\relax}% +} % \end{macrocode} % \end{macro} % diff --git a/Master/texmf-dist/source/latex/koma-script/scrksect.dtx b/Master/texmf-dist/source/latex/koma-script/scrksect.dtx index 8682751b8a2..9c6db67c1d3 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrksect.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrksect.dtx @@ -1,4 +1,4 @@ -% \CheckSum{1642} +% \CheckSum{1681} % \iffalse meta-comment % ====================================================================== % scrksect.dtx @@ -58,7 +58,7 @@ %%% From File: scrksect.dtx %<*driver> % \fi -\ProvidesFile{scrksect.dtx}[2007/01/24 v2.97 KOMA-Script (disposition)] +\ProvidesFile{scrksect.dtx}[2007/07/23 v2.97c KOMA-Script (disposition)] % \iffalse \documentclass[halfparskip-]{scrdoc} \usepackage[english,ngerman]{babel} @@ -1303,11 +1303,12 @@ % \end{macrocode} % \changes{v2.96a}{2006/12/02}{Abstand nach der Präfixzeile nur, wenn eines % Präfixzeile ausgegeben wurde} +% \changes{v2.97b}{2007/03/09}{\cs{endgraf} korrigiert} % \begin{macrocode} \newcommand*{\@@makechapterhead}[1]{\chapterheadstartvskip {% \setlength{\parindent}{\z@}\setlength{\parfillskip}{\fill}% - \normalfont\sectfont\size@chapter{}% + \normalfont\sectfont\nobreak\size@chapter{}% \if@chapterprefix \let\@tempa\raggedsection \else @@ -1322,7 +1323,7 @@ \fi {\chapterformat}% \if@chapterprefix - \size@chapterprefix{}\endgraph\nobreak\vskip.5\baselineskip + \size@chapterprefix{}\endgraf\nobreak\vskip.5\baselineskip \fi %<book> \fi \fi @@ -1360,7 +1361,7 @@ } \newcommand*{\@@makeschapterhead}[1]{% \chapterheadstartvskip% - {\normalfont\sectfont\size@chapter{}% + {\normalfont\sectfont\nobreak\size@chapter{}% \setlength{\parindent}{\z@}\setlength{\parfillskip}{\fill}% \raggedsection \interlinepenalty \@M \size@chapter{#1}\par}% \nobreak\chapterheadendvskip% @@ -1590,14 +1591,14 @@ {2.3ex \@plus.2ex}% {\ifnum \scr@compatibility>\@nameuse{scr@v@2.96}\setlength{\parfillskip}{\z@ plus 1fil}\fi - \raggedsection\normalfont\sectfont\size@section}% + \raggedsection\normalfont\sectfont\nobreak\size@section}% } \newcommand\subsection{\@startsection{subsection}{2}{\z@}% {-3.25ex\@plus -1ex \@minus -.2ex}% {1.5ex \@plus .2ex}% {\ifnum \scr@compatibility>\@nameuse{scr@v@2.96}\setlength{\parfillskip}{\z@ plus 1fil}\fi - \raggedsection\normalfont\sectfont\size@subsection + \raggedsection\normalfont\sectfont\nobreak\size@subsection }% } \newcommand\subsubsection{\@startsection{subsubsection}{3}{\z@}% @@ -1605,18 +1606,18 @@ {1.5ex \@plus .2ex}% {\ifnum \scr@compatibility>\@nameuse{scr@v@2.96}\setlength{\parfillskip}{\z@ plus 1fil}\fi - \raggedsection\normalfont\sectfont\size@subsubsection + \raggedsection\normalfont\sectfont\nobreak\size@subsubsection }% } \newcommand\paragraph{\@startsection{paragraph}{4}{\z@}% {3.25ex \@plus1ex \@minus.2ex}% {-1em}% - {\raggedsection\normalfont\sectfont\size@paragraph}% + {\raggedsection\normalfont\sectfont\nobreak\size@paragraph}% } \newcommand\subparagraph{\@startsection{subparagraph}{5}{\parindent}% {3.25ex \@plus1ex \@minus .2ex}% {-1em}% - {\raggedsection\normalfont\sectfont\size@subparagraph}% + {\raggedsection\normalfont\sectfont\nobreak\size@subparagraph}% } % \end{macrocode} % \end{macro} @@ -1643,7 +1644,7 @@ {\parindent \z@ \ifnum \scr@compatibility>\@nameuse{scr@v@2.96}\relax \setlength{\parfillskip}{\z@ plus 1fil}\fi - \raggedsection\normalfont\sectfont + \raggedsection\normalfont\sectfont\nobreak \usekomafont{minisec}#1\par\nobreak}\nobreak% \@afterheading } @@ -1689,6 +1690,61 @@ % \end{macrocode} % \end{macro} % +% \begin{KOMAfont}{partentry} +% \changes{v2.97c}{2007/06/21}{neues Font-Element} +% Schrift für den \cs{part}-Eintrag im Inhaltsverzeichnis. +% \begin{macrocode} +\newkomafont{partentry}{\usekomafont{sectioning}\large} +% \end{macrocode} +% \end{KOMAfont} +% +% \begin{KOMAfont}{partentrypagenumber} +% \changes{v2.97c}{2007/06/21}{neues Font-Element} +% Schrift für die Seitenzahl des \cs{part}-Eintrags im Inhaltsverzeichnis +% abweichend von \texttt{partentry}. +% \begin{macrocode} +\newkomafont{partentrypagenumber}{} +% \end{macrocode} +% \end{KOMAfont} +% +% \begin{KOMAfont}{chapterentry} +% \changes{v2.97c}{2007/06/21}{neues Font-Element} +% Schrift für den \cs{chapter}-Eintrag im Inhaltsverzeichnis. +% \begin{macrocode} +%<*book|report> +\newkomafont{chapterentry}{\usekomafont{sectioning}} +% \end{macrocode} +% \end{KOMAfont} +% +% \begin{KOMAfont}{chapterentrypagenumber} +% \changes{v2.97c}{2007/06/21}{neues Font-Element} +% Schrift für die Seitenzahl des \cs{chapter}-Eintrags im Inhaltsverzeichnis +% abweichend von \texttt{chapterentry}. +% \begin{macrocode} +\newkomafont{chapterentrypagenumber}{} +%</book|report> +% \end{macrocode} +% \end{KOMAfont} +% +% \begin{KOMAfont}{sectionentry} +% \changes{v2.97c}{2007/06/21}{neues Font-Element} +% Schrift für den \cs{section}-Eintrag im Inhaltsverzeichnis. +% \begin{macrocode} +%<*article> +\newkomafont{sectionentry}{\usekomafont{sectioning}} +% \end{macrocode} +% \end{KOMAfont} +% +% \begin{KOMAfont}{sectionentrypagenumber} +% \changes{v2.97c}{2007/06/21}{neues Font-Element} +% Schrift für die Seitenzahl des \cs{section}-Eintrags im Inhaltsverzeichnis +% abweichend von \texttt{sectionentry}. +% \begin{macrocode} +\newkomafont{sectionentrypagenumber}{} +%</article> +% \end{macrocode} +% \end{KOMAfont} +% % \begin{macro}{\size@part} % \changes{v2.8o}{2001/09/14}{neu (intern)} % \changes{v2.96a}{2006/12/02}{letztes Element darf ein Argument erwarten, @@ -2050,11 +2106,16 @@ % Die Gliederungsbefehle schreiben auch Einträge ins % Inhaltsverzeichnis, die dort ebenfalls formatiert werden müssen. % -% \begin{macro}{\l@part} +% \begin{macro}{\l@part} +% \changes{v2.97c}{2007/06/21}{\cs{sectfont}\cs{large} durch Verwendung von +% Element \texttt{partentry} ersetzt} +% \changes{v2.97c}{2007/06/21}{Element \texttt{partentrypagenumber} wird +% verwendet} % Der Eintrag für \cs{part}: % \begin{macrocode} \newcommand*\l@part[2]{% - \ifnum \c@tocdepth >-2\relax +%<article> \ifnum \c@tocdepth >\m@ne\relax +%<book|report> \ifnum \c@tocdepth >-2\relax %<article> \addpenalty{\@secpenalty}% %<book|report> \addpenalty{-\@highpenalty}% \addvspace{2.25em \@plus\p@}% @@ -2078,10 +2139,12 @@ % \changes{v2.5e}{1998/07/17}{beinhaltet \cs{sectfont} eine % Größenangabe, so wird diese überschrieben} % \begin{macrocode} - \leavevmode\sectfont\large + \leavevmode \advance\leftskip\@tempdima \hskip -\leftskip - #1\nobreak\hfil \nobreak\hb@xt@\@pnumwidth{\hss #2}\par + \usekomafont{partentry}{#1\nobreak + \usekomafont{partentrypagenumber}{\hfil\nobreak + \hb@xt@\@pnumwidth{\hss#2}}}\par % \end{macrocode} % \changes{v2.96b}{2006/11/30}{Umbruch zwischen \cs{part}-Eintrag im % Inhaltsverzeichnis und untergeordneten Einträgen verhindern} @@ -2117,6 +2180,12 @@ % Inhaltsverzeichnis und übergeordneten Einträgen verhindern} % \changes{v2.96b}{2006/11/30}{Umbruch zwischen \cs{chapter}-Eintrag im % Inhaltsverzeichnis und untergeordneten Einträgen verhindern} +% \changes{v2.97c}{2007/06/21}{\cs{sectfont} durch Verwendung von +% Element \texttt{chapterentry} ersetzt} +% \changes{v2.97c}{2007/06/21}{Element \texttt{chapterentrypagenumber} wird +% verwendet} +% \changes{v2.97c}{2007/06/21}{weitgehend umgeschrieben, um linksbündige +% Einträge zu ermöglichen} % \iffalse %<*report|book> % \fi @@ -2135,12 +2204,26 @@ \fi \fi \begingroup - \parindent \z@ \rightskip \@pnumwidth + \raggedchapterentry + \parindent \z@ \advance\rightskip \@pnumwidth \parfillskip -\@pnumwidth - \leavevmode \sectfont - \advance\leftskip\@tempdima - \hskip -\leftskip - #1\nobreak\hfil \nobreak\hb@xt@\@pnumwidth{\hss #2}\par + \interlinepenalty\@M + \leavevmode + \advance\leftskip \@tempdima \null\nobreak\hskip -\leftskip + \usekomafont{chapterentry}{#1\nobreak + \usekomafont{chapterentrypagenumber}{% +% \end{macrocode} +% Und dann könnte man noch folgendes machen: +% \begin{verbatim} +% \if@chapterentrywithdots +% \leaders\hbox{$\m@th +% \mkern \@dotsep mu\hbox{.}\mkern \@dotsep +% mu$}% +% \fi +% \end{verbatim} +% \begin{macrocode} + \hfill\nobreak + \hb@xt@\@pnumwidth{\hss#2}}}\par \ifnum \scr@compatibility>\@nameuse{scr@v@2.96} \endgroup \penalty20009 @@ -2151,6 +2234,13 @@ \fi } % \end{macrocode} +% \begin{macro}{\raggedchapterentry} +% \changes{v2.97c}{2007/06/21}{neue Anweisung} +% Ausrichtung des Textes der Kapiteleinträge im Inhaltsverzeichnis. +% \begin{macrocode} +\newcommand*{\raggedchapterentry}{} +% \end{macrocode} +% \end{macro} % % \begin{macro}{\l@chapteratlist} % \changes{v2.96a}{2006/12/03}{neues Macro} @@ -2172,6 +2262,12 @@ % Inhaltsverzeichnis und übergeordneten Einträgen verhindern} % \changes{v2.96b}{2006/11/30}{Umbruch zwischen \cs{section}-Eintrag im % Inhaltsverzeichnis und untergeordneten Einträgen verhindern} +% \changes{v2.97c}{2007/06/21}{\cs{sectfont} durch Verwendung von +% Element \texttt{sectionentry} ersetzt} +% \changes{v2.97c}{2007/06/21}{Element \texttt{sectionentrypagenumber} wird +% verwendet} +% \changes{v2.97c}{2007/06/21}{weitgehend umgeschrieben, um linksbündige +% Einträge zu ermöglichen} % Bei der Artikel-Klasse folgt die Formatierung für % \cs{section}-Einträge, an Stelle der Einträge für \cs{chapter} % der Buch- oder der Bericht-Klasse. Bei diesen handelt es sich hier @@ -2191,18 +2287,42 @@ \fi \fi \begingroup - \parindent \z@ \rightskip \@pnumwidth + \raggedsectionentry + \parindent \z@ \advance\rightskip \@pnumwidth \parfillskip -\@pnumwidth - \leavevmode \sectfont - \advance\leftskip\@tempdima - \hskip -\leftskip - #1\nobreak\hfil \nobreak\hb@xt@\@pnumwidth{\hss #2}\par\nobreak + \interlinepenalty\@M + \leavevmode + \advance\leftskip \@tempdima \null\nobreak\hskip -\leftskip + \usekomafont{sectionentry}{#1\nobreak + \usekomafont{sectionentrypagenumber}{% +% \end{macrocode} +% Und dann könnte man noch folgendes machen: +% \begin{verbatim} +% \if@sectionentrywithdots +% \leaders\hbox{$\m@th +% \mkern \@dotsep mu\hbox{.}\mkern \@dotsep +% mu$}% +% \fi +% \end{verbatim} +% \begin{macrocode} + \hfill\nobreak + \hb@xt@\@pnumwidth{\hss#2}}}\par \endgroup \ifnum \scr@compatibility>\@nameuse{scr@v@2.96} \penalty20008 \fi \fi } +% \end{macrocode} +% \begin{macro}{\raggedsectionentry} +% \changes{v2.97c}{2007/06/21}{neue Anweisung} +% Ausrichtung des Textes der Abschnittseinträge im Inhaltsverzeichnis. +% \begin{macrocode} +\newcommand*{\raggedsectionentry}{} +% \end{macrocode} +% \end{macro} +% +% \begin{macrocode} %</article> %<*report|book> \newcommand*\l@section{\bprot@dottedtocline{1}{1.5em}{2.3em}} diff --git a/Master/texmf-dist/source/latex/koma-script/scrktare.dtx b/Master/texmf-dist/source/latex/koma-script/scrktare.dtx index fe8d27e3838..3e5e611c76f 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrktare.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrktare.dtx @@ -1,4 +1,4 @@ -% \CheckSum{1624} +% \CheckSum{1642} % \iffalse meta-comment % ====================================================================== % scrktare.dtx @@ -58,7 +58,7 @@ %%% From File: scrktare.dtx %<*driver> % \fi -\ProvidesFile{scrktare.dtx}[2006/11/29 v2.96a KOMA-Script (type area)] +\ProvidesFile{scrktare.dtx}[2007/09/12 v2.97c KOMA-Script (type area)] % \iffalse %</driver> %<package&identify>\ProvidesPackage{typearea}[% @@ -177,7 +177,7 @@ % \end{macrocode} % \end{macro} % -% Ab hier nun wieder Teile für Klassen und Paket: +% Ab hier nun Teile für Klassen und Paket: % \begin{macrocode} %</package> %<*class|package> @@ -469,6 +469,11 @@ % \end{macrocode} % \end{macro} % +% Jetzt wieder nur für Pakete: +% \begin{macrocode} +%</class|package> +%<*package> +% \end{macrocode} % % \subsection{Optionen mit \textsf{keyval}} % @@ -481,13 +486,10 @@ % definiert, die bevorzugt zu verwenden ist. % \begin{macrocode} \KOMA@key{headlines}{% -%<*package> \begingroup \setlength{\@tempdima}{#1\baselineskip}% \endgroup \def\ta@hh{#1\baselineskip}% -%</package> -%<class> \PassOptionsToPackage{headlines=#1}{typearea}% } % \end{macrocode} % \end{option} @@ -500,19 +502,17 @@ % gehört. % \begin{macro}{\if@hincl} % \changes{v2.95}{2002/07/08}{Verwendung von \textsf{scrkeyvl}} +% \changes{v2.97c}{2007/04/19}{direkte Initialisierung über \cs{if@hsl}, +% falls definiert} % \begin{macro}{\@hincltrue} % \begin{macro}{\@hinclfalse} % Der Zustand selbst wird in einem Schalter gespeichert. % \begin{macrocode} -%<*package> +\newif\if@hincl\@ifundefined{if@hsl}{}{\let\if@hincl\if@hsl} \KOMA@ifkey{headinclude}{@hincl} \KOMA@DeclareObsoleteOption[\PackageInfo]{headexclude}{% headinclude=false% } -%</package> -%<*class> -\KOMA@key{headinclude}[true]{\PassOptionsToPackage{headinclude=#1}{typearea}} -%</class> % \end{macrocode} % \end{macro} % \end{macro} @@ -526,21 +526,19 @@ % \changes{v2.95}{2002/07/08}{Verwendung von \textsf{scrkeyvl}} % Diese Optionen bestimmen, ob die Fußzeilen noch zum Textbereich % gehören. -% \begin{macro}{\if@incl} +% \begin{macro}{\if@fincl} % \changes{v2.95}{2002/07/08}{Verwendung von \textsf{scrkeyvl}} +% \changes{v2.97c}{2007/04/19}{direkte Initialisierung über \cs{if@fsl}, +% falls definiert} % \begin{macro}{\@fincltrue} % \begin{macro}{\@finclfalse} % Der Zustand selbst wird in einem Schalter gespeichert. % \begin{macrocode} -%<*package> +\newif\if@fincl\@ifundefined{if@fsl}{}{\let\if@fincl\if@fsl} \KOMA@ifkey{footinclude}{@fincl} \KOMA@DeclareObsoleteOption[\PackageInfo]{footexclude}{% footinclude=false% } -%</package> -%<*class> -\KOMA@key{footinclude}[true]{\PassOptionsToPackage{footinclude=#1}{typearea}} -%</class> % \end{macrocode} % \end{macro} % \end{macro} @@ -566,15 +564,10 @@ % Bei Verwendung dieser Option müssen größere DIV-Werte verwendet % werden. Siehe dazu weiter unten. % \begin{macrocode} -%<*package> \KOMA@ifkey{mpinclude}{@mincl} \KOMA@DeclareObsoleteOption[\PackageInfo]{mpexclude}{% mpinclude=false% } -%</package> -%<*class> -\KOMA@key{mpinclude}[true]{\PassOptionsToPackage{mpinclude=#1}{typearea}} -%</class> % \end{macrocode} % \end{macro} % \end{macro} @@ -591,18 +584,15 @@ % Laden des Pakets absolut keinen Sinn ergeben! % \begin{macrocode} \KOMA@key{BCOR}{% -%<*package> \edef\@tempa{#1}\edef\@tempb{current}\ifx\@tempa\@tempb\else \setlength{\ta@bcor}{#1}% \fi -%</package> -%<class> \PassOptionsToPackage{BCOR=#1}{typearea}% } % \end{macrocode} % Wenn allerdings der Satzspiegel bereits berechnet ist, dann muss er % hier stattdessen neu berechnet werden. % \begin{macrocode} -%<package>\AtEndOfPackage{\KOMA@key{BCOR}{\typearea[{#1}]{last}}} +\AtEndOfPackage{\KOMA@key{BCOR}{\typearea[{#1}]{last}}} % \end{macrocode} % \end{option} % @@ -616,7 +606,6 @@ % wenn diese beim Laden des Pakets absolut keinen Sinn ergeben! % \begin{macrocode} \KOMA@key{DIV}[calc]{% -%<*package> \edef\@tempa{#1}% \def\@tempb{last}\ifx\@tempa\@tempb\let\@tempa=\@lastdiv\fi \def\@tempb{current}\ifx\@tempa\@tempb\else @@ -628,14 +617,12 @@ \fi \fi \fi -%</package> -%<class> \PassOptionsToPackage{DIV=#1}{typearea}% } % \end{macrocode} % Wenn allerdings der Satzspiegel bereits berechnet ist, dann muss er % hier stattdessen neu berechnet werden. % \begin{macrocode} -%<package>\AtEndOfPackage{\KOMA@key{DIV}{\typearea[current]{#1}}} +\AtEndOfPackage{\KOMA@key{DIV}{\typearea[current]{#1}}} % \end{macrocode} % \end{option} % @@ -649,10 +636,8 @@ % reimplementiert} % Dann gibt es da noch zwei alte Sonderfälle. % \begin{macrocode} -%<*package> \KOMA@DeclareObsoleteOption[\PackageInfo]{DIVcalc}{DIV=calc} \KOMA@DeclareObsoleteOption[\PackageInfo]{DIVclassic}{DIV=classic} -%</package> % \end{macrocode} % \end{option} % \end{option} @@ -665,11 +650,12 @@ % Einseitiger oder zweiseitiger Satzspiegel? % \begin{macrocode} \KOMA@key{twoside}[true]{% + \if@atdocument\if@twoside\cleardoublepage\else\clearpage\fi\fi \KOMA@set@ifkey{twoside}{@twoside}{#1}% \if@twoside\@mparswitchtrue\else\@mparswitchfalse\fi% -%<package> \csname recalctypearea\endcsname + \csname recalctypearea\endcsname } -%<package>\KOMA@DeclareObsoleteOption[\PackageInfo]{oneside}{twoside=false} +\KOMA@DeclareObsoleteOption[\PackageInfo]{oneside}{twoside=false} % \end{macrocode} % \end{option} % \end{option} @@ -683,10 +669,11 @@ % Einspaltiger oder zweispaltiger Satz? % \begin{macrocode} \KOMA@key{twocolumn}[true]{% + \if@atdocument\clearpage\fi \KOMA@set@ifkey{twocolumn}{@twocolumn}{#1}% -%<package> \csname recalctypearea\endcsname + \csname recalctypearea\endcsname } -%<package>\KOMA@DeclareObsoleteOption[\PackageInfo]{onecolumn}{twocolumn=false} +\KOMA@DeclareObsoleteOption[\PackageInfo]{onecolumn}{twocolumn=false} % \end{macrocode} % \end{option} % \end{option} @@ -717,7 +704,6 @@ % \end{labeling} % \begin{macrocode} \KOMA@key{pagesize}[auto]{% -%<*package> \begingroup \KOMA@set@ncmdkey{pagesize}{@tempa}{% {auto}{0},{automedia}{1},{dvips}{2},{pdftex}{3}% @@ -739,8 +725,6 @@ \set@pdftexpagesize \fi \edef\@pagesizelast{#1}% -%</package> -%<class> \PassOptionsToPackage{pagesize=#1}{typearea}% } % \end{macrocode} % @@ -760,7 +744,6 @@ % \texttt{\cs{begin}\{document\}}. % \end{description} % \begin{macrocode}+ -%<*package> \newcommand{\set@pdftexpagesize}{% \AtBeginDocument{% \ifnotundefined{pdfpagewidth}{\pdfpagewidth=\paperwidth}{}% @@ -815,7 +798,6 @@ \ifnotundefined{mediaheight}{\mediaheight=\paperheight}{}% }% } -%</package> % \end{macrocode} % \end{macro} % \end{macro} @@ -832,11 +814,9 @@ % verwendet, weil die Verwendung von \texttt{pagesize=dvips} selbst % ebenfalls zu einer Warnung führen kann. % \begin{macrocode} -%<*package> \KOMA@DeclareObsoleteOption[\PackageWarning]{dvips}{% pagesize=dvips% } -%</package> % \end{macrocode} % \end{option} % @@ -846,11 +826,9 @@ % Die Option ist obsolete und wird nun über die Option % \texttt{pagesize} implementiert. % \begin{macrocode} -%<*package> \KOMA@DeclareObsoleteOption[\PackageInfo]{pdftex}{% pagesize=pdftex% } -%</package> % \end{macrocode} % \end{option} % @@ -879,7 +857,6 @@ % die übrigen Papiergrößenoptionen später noch per Mustererkennung % verarbeitet. % \begin{macrocode} -%<*package> \KOMA@DeclareObsoleteOption[\PackageInfo]{a4paper}{paper=a4} \KOMA@DeclareObsoleteOption[\PackageInfo]{a5paper}{paper=a5} \KOMA@DeclareObsoleteOption[\PackageInfo]{b5paper}{paper=b5} @@ -888,7 +865,6 @@ \KOMA@DeclareObsoleteOption[\PackageInfo]{executivepaper}{paper=executive} \KOMA@DeclareObsoleteOption[\PackageInfo]{landscape}{paper=landscape} \KOMA@DeclareObsoleteOption[\PackageInfo]{portrait}{paper=portrait} -%</package> % \end{macrocode} % \end{option} % \end{option} @@ -908,7 +884,6 @@ % "`\texttt{portrait}"' und "`\texttt{landscape}"' erlaubt. % \begin{macrocode} \KOMA@key{paper}{% -%<*package> \ifstr{#1}{landscape}{% \if@landscape\else \setlength{\@tempdima}{\paperwidth}% @@ -961,8 +936,6 @@ \fi }% }% -%</package> -%<class> \PassOptionsToPackage{paper=#1}{typearea}% } % \end{macrocode} % \begin{macro}{\if@landscape} @@ -971,7 +944,7 @@ % In diesem Schalter wird gespeichert, ob Hoch- oder Breitformat % verwendet wird. % \begin{macrocode} -%<package>\newif\if@landscape +\newif\if@landscape % \end{macrocode} % \end{macro} % \end{macro} @@ -985,26 +958,40 @@ % Wenn ja, wird \cs{@tempa} mit dem ersten und \cs{@tempb} mit dem % zweiten Argument definiert. % \begin{macrocode} -%<*package> \newcommand*{\maybe@pair}{% \@ifnextchar (% {\@tempswatrue\maybe@@pair}{\@tempswafalse\gobble@till@scr@next}% } \newcommand*{\maybe@@pair}{} \def\@maybepair(#1,#2)\scr@next{\def\@tempa{#1}\def\@tempb{#2}}% -%</package> % \end{macrocode} % \end{macro} % \end{macro} % \end{option} % % \begin{macrocode} -%</class|package> +%</package> % \end{macrocode} % % +% \subsubsection{Geparste Optionen} +% +% Die Behandlung für \texttt{BCOR\emph{Wert}}, \texttt{DIV\emph{Wert}} und +% \texttt{a\emph{Wert}paper}, \texttt{b\emph{Wert}paper}, +% \texttt{c\emph{Wert}paper} sowie \texttt{d\emph{Wert}paper} und +% \texttt{\emph{Wert}headlines}. +% \changes{v2.97c}{2007/09/12}{\cs{lco@test} bei den geparsten Optionen +% eingefügt} +% \begin{macrocode} +%<*class|package> +\DeclareOption*{% +%<letter> \lco@test + \x@paper} +%</class|package> +% \end{macrocode} +% % \iffalse -% Aber das gehört nicht mehr zu den Optionen. +% Der Rest gehört nicht mehr zu den Optionen. %</option> %<*body> %<*package> @@ -1029,18 +1016,6 @@ % \end{macrocode} % % -% \subsubsection{Keyval-Optionen aktivieren} -% -% Die Behandlung für \textsf{keyval}-Optionen sowie -% \texttt{BCOR\emph{Wert}}, \texttt{DIV\emph{Wert}} und -% \texttt{a\emph{Wert}paper}, \texttt{b\emph{Wert}paper}, -% \texttt{c\emph{Wert}paper} sowie \texttt{d\emph{Wert}paper} und -% \texttt{\emph{Wert}headlines}. -% \begin{macrocode} -\DeclareKeyValOption[\x@paper]{KOMA} -% \end{macrocode} -% -% % \subsubsection{Standardoptionen} % % Als Standardoptionen sind \texttt{headinclude=false}, @@ -1051,9 +1026,21 @@ % ergänzt.} % \changes{v2.96}{2006/08/18}{Optionen werden in Reihenfolge der Angabe statt % in Reihenfolge der Deklaration abgearbeitet.} +% \changes{v2.97c}{2007/04/19}{Verwendung von \cs{KOMAExecuteOptions} an +% Stelle von \cs{KOMAoptions} und \cs{KOMAProcessOptions} an Stelle von +% \cs{ProcessOptions}} +% \changes{v2.97c}{2007/04/19}{Optionen, die der Voreinstellung ohnehin +% entsprechen, werden nicht explizit gesetzt} +% \changes{v2.97c}{2007/07/18}{Option \texttt{twoside} wird explizit passend +% gesetzt} % \begin{macrocode} -\KOMAoptions{headinclude=false,footinclude=false,paper=A4} -\ProcessOptions*\relax +\KOMAExecuteOptions{paper=A4} +\if@twoside + \KOMAExecuteOptions{twoside} +\else + \KOMAExecuteOptions{twoside=false} +\fi +\KOMAProcessOptions % \end{macrocode} % % @@ -1288,13 +1275,15 @@ % Als Sonderbedingung ist dann noch zu beachten, dass die Größse des % Textbereichs nicht zu einer vertikalen Aufweitung führt. % \changes{v2.96}{2006/09/12}{\cs{topskip} wird gesetzt} +% \changes{v2.97c}{2007/07/04}{\cs{maxdepth} wird gesetzt} % \begin{macrocode} - \scr@ifundefined{@ptsize}{% + \scr@ifundefinedorrelax{@ptsize}{% \topskip=\f@size\p@ }{% \topskip=\@ptsize\p@ \advance\topskip by 10\p@ }% + \maxdepth=.5\topskip \textheight=\topskip \@whiledim\textheight <\ta@temp \do{\advance\textheight by\baselineskip}% @@ -1428,7 +1417,7 @@ \fi \hsize=\columnwidth \linewidth\hsize - \scr@ifundefined{@pagesizelast}{}{\KOMAoptions{pagesize=\@pagesizelast}}% + \scr@ifundefinedorrelax{@pagesizelast}{}{\KOMAoptions{pagesize=\@pagesizelast}}% \fi } % \end{macrocode} @@ -1528,7 +1517,7 @@ % \texttt{current}. % \begin{macrocode} \newcommand*\typearea[2][\z@]{% - \scr@ifundefined{currentgrouptype}{}{% + \scr@ifundefinedorrelax{currentgrouptype}{}{% \ifcase\currentgrouptype\else \PackageWarning{typearea}{% \string\typearea\space used at group level @@ -1953,7 +1942,7 @@ \advance\oddsidemargin by\ta@bcor \evensidemargin\oddsidemargin \fi - \scr@ifundefined{@ptsize}{% + \scr@ifundefinedorrelax{@ptsize}{% \topskip=\f@size\p@ }{% \topskip=\@ptsize\p@ diff --git a/Master/texmf-dist/source/latex/koma-script/scrktitl.dtx b/Master/texmf-dist/source/latex/koma-script/scrktitl.dtx index b724f667484..0e3288236a9 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrktitl.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrktitl.dtx @@ -1,4 +1,4 @@ -% \CheckSum{588} +% \CheckSum{623} % \iffalse meta-comment % ====================================================================== % scrktitl.dtx @@ -58,7 +58,7 @@ %%% From File: scrktitl.dtx %<*driver> % \fi -\ProvidesFile{scrktitl.dtx}[2006/08/21 v2.95c KOMA-Script (title pages)] +\ProvidesFile{scrktitl.dtx}[2007/08/31 v2.97c KOMA-Script (title pages)] % \iffalse \documentclass[halfparskip-]{scrdoc} \usepackage[english,ngerman]{babel} @@ -182,20 +182,24 @@ % % \subsection{Definitionen der Titelei} % -% \begin{macro}{\extratitle} -% \begin{macro}{\@extratitle} -% \begin{macro}{\titlehead} -% \begin{macro}{\@titlehead} -% \begin{macro}{\subject} -% \begin{macro}{\@subject} -% \begin{macro}{\publishers} -% \begin{macro}{\@publishers} -% \begin{macro}{\uppertitleback} -% \begin{macro}{\@uppertitleback} -% \begin{macro}{\lowertitleback} -% \begin{macro}{\@lowertitleback} -% \begin{macro}{\dedication} -% \begin{macro}{\@dedication} +% \begin{macro}{\extratitle} +% \begin{macro}{\@extratitle} +% \begin{macro}{\titlehead} +% \begin{macro}{\@titlehead} +% \begin{macro}{\subject} +% \begin{macro}{\@subject} +% \begin{macro}{\subtitle} +% \changes{v2.97c}{2007/06/20}{neue Möglichkeit} +% \begin{macro}{\@subtitle} +% \changes{v2.97c}{2007/06/20}{neu (intern)} +% \begin{macro}{\publishers} +% \begin{macro}{\@publishers} +% \begin{macro}{\uppertitleback} +% \begin{macro}{\@uppertitleback} +% \begin{macro}{\lowertitleback} +% \begin{macro}{\@lowertitleback} +% \begin{macro}{\dedication} +% \begin{macro}{\@dedication} % Da der Titel im \KOMAScript{} Paket wesentlich mehr Angaben erlaubt % als bei den Standardklassen, gibt es natürlich auch einige Befehle, % mit denen diese gesetzt werden können. Alle zusätzlichen Angaben @@ -210,6 +214,8 @@ \newcommand{\titlehead}[1]{\gdef\@titlehead{#1}} \newcommand*{\@subject}{} \newcommand*{\subject}[1]{\gdef\@subject{#1}} +\newcommand*{\subtitle}[1]{\gdef\@subtitle{#1}} +\newcommand*{\@subtitle}{} \newcommand*{\@publishers}{} \newcommand{\publishers}[1]{\gdef\@publishers{#1}} \newcommand*{\@uppertitleback}{} @@ -233,6 +239,8 @@ % \end{macro} % \end{macro} % \end{macro} +% \end{macro} +% \end{macro} % % \begin{macro}{\next@tpage} % \changes{v2.3b}{1995/07/24}{\cs{null} entfernt.} @@ -275,6 +283,8 @@ % \changes{v2.8p}{2001/09/22}{\cs{titlefont} an Stelle von % \cs{sectfont}} % \changes{v2.95c}{2006/08/21}{Absatzgrundeinstellungen} +% \changes{v2.97c}{2007/08/31}{Vakatseiten in der Titelei immer im +% Seitenstil \texttt{empty}} % \begin{macrocode} \if@titlepage \newcommand*\maketitle[1][1]{% @@ -287,7 +297,7 @@ \let\@oldmakefnmark\@makefnmark \renewcommand*{\@makefnmark}{\rlap\@oldmakefnmark}% \ifx\@extratitle\@empty \else - \noindent\@extratitle\next@tpage\cleardoublepage + \noindent\@extratitle\next@tpage\cleardoubleemptypage \thispagestyle{empty}% \fi \setparsizes{\z@}{\z@}{\z@\@plus 1fil}\par@updaterelative @@ -303,7 +313,9 @@ \vskip 3em \fi {\titlefont\huge \@title\par}% - \vskip 3em + \vskip 1em + {\ifx\@subtitle\@empty\else\usekomafont{subtitle}\@subtitle\par\fi}% + \vskip 2em {\Large \lineskip 0.75em \begin{tabular}[t]{c} \@author @@ -330,7 +342,7 @@ \next@tpage\null\vfill {\centering \Large \@dedication \par}% \vskip \z@ \@plus3fill - \if@twoside \next@tpage\cleardoublepage \fi + \if@twoside \next@tpage\cleardoubleemptypage \fi \fi \end{titlepage} \setcounter{footnote}{0}% @@ -346,6 +358,7 @@ \global\let\@author\@empty \global\let\@date\@empty \global\let\@title\@empty + \global\let\@subtitle\@empty \global\let\@extratitle\@empty \global\let\@titlehead\@empty \global\let\@subject\@empty @@ -420,6 +433,7 @@ \global\let\@author\@empty \global\let\@date\@empty \global\let\@title\@empty + \global\let\@subtitle\@empty \global\let\@extratitle\@empty \global\let\@titlehead\@empty \global\let\@subject\@empty @@ -465,7 +479,9 @@ \vskip 1.5em \fi {\titlefont\huge \@title \par}% - \vskip 1.5em% + \vskip .5em + {\ifx\@subtitle\@empty\else\usekomafont{subtitle}\@subtitle\par\fi}% + \vskip 1em {\Large \lineskip .5em% \begin{tabular}[t]{c} @@ -507,6 +523,13 @@ % \end{macro} % \end{macro} % +% \begin{KOMAfont}{subtitle} +% \changes{v2.97c}{2007/06/20}{neu (intern)} +% \begin{macrocode} +\newkomafont{subtitle}{\usekomafont{title}\large} +% \end{macrocode} +% \end{KOMAfont} +% % % \begin{macro}{\scr@fnt@title} % \changes{v2.8o}{2001/09/14}{neues Element \texttt{title}} diff --git a/Master/texmf-dist/source/latex/koma-script/scrkvers.dtx b/Master/texmf-dist/source/latex/koma-script/scrkvers.dtx index 853d81e84b5..8c115393e77 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrkvers.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrkvers.dtx @@ -112,7 +112,7 @@ \fi } \fi - \@CheckKOMAScriptVersion{2007/03/07 v2.97a KOMA-Script}% + \@CheckKOMAScriptVersion{2007/09/28 v2.97c KOMA-Script}% \endgroup % \end{macrocode} % \end{macro} diff --git a/Master/texmf-dist/source/latex/koma-script/scrmain.ins b/Master/texmf-dist/source/latex/koma-script/scrmain.ins index 8144c3e93db..ae4a46132cd 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrmain.ins +++ b/Master/texmf-dist/source/latex/koma-script/scrmain.ins @@ -205,31 +205,26 @@ \ifbeta\from{scrbeta.dtx}{KOMAold,lco}\fi \from{scrklco.dtx}{lco,KOMAold,body}% \from{scrknpap.dtx}{lco,KOMAold,body}% - \from{scrlogo.dtx}{logo}% }% \file{DIN.lco}{% \from{scrklco.dtx}{lco,DIN,head}% \ifbeta\from{scrbeta.dtx}{DIN,lco}\fi \from{scrklco.dtx}{lco,DIN,body}% - \from{scrlogo.dtx}{logo}% }% \file{DINmtext.lco}{% \from{scrklco.dtx}{lco,DINmoretext,head}% \ifbeta\from{scrbeta.dtx}{DINmoretext,lco}\fi \from{scrklco.dtx}{lco,DINmoretext,body}% - \from{scrlogo.dtx}{logo}% }% \file{SN.lco}{% \from{scrklco.dtx}{lco,SN,head}% \ifbeta\from{scrbeta.dtx}{SN,lco}\fi \from{scrklco.dtx}{lco,SN,body}% - \from{scrlogo.dtx}{logo}% }% \file{SNleft.lco}{% \from{scrklco.dtx}{lco,SwissLeft,head}% \ifbeta\from{scrbeta.dtx}{SwissLeft,lco}\fi \from{scrklco.dtx}{lco,SwissLeft,body}% - \from{scrlogo.dtx}{logo}% }% } diff --git a/Master/texmf-dist/source/latex/koma-script/scrpage.dtx b/Master/texmf-dist/source/latex/koma-script/scrpage.dtx index e97a680aa1f..c639f994906 100644 --- a/Master/texmf-dist/source/latex/koma-script/scrpage.dtx +++ b/Master/texmf-dist/source/latex/koma-script/scrpage.dtx @@ -1,4 +1,4 @@ -% \CheckSum{2537} +% \CheckSum{2553} % \iffalse % ====================================================================== % scrpage.dtx @@ -65,7 +65,7 @@ %<v1>\ProvidesPackage{scrpage}[2006/03/29 v1.3d KOMA-Script %<v2>\ProvidesPackage{scrpage2} %<*!v1> - [2006/03/29 v2.2c LaTeX2e KOMA-Script + [2007/07/23 v2.2e LaTeX2e KOMA-Script %</!v1> %<scrpage> package] %<*driver> @@ -327,6 +327,7 @@ %<*scrpage> % \end{macrocode} % \changes{v1.1}{1995/06/27}{\cs{hbox to} changed into \cs{hb@xt@}.} +% \changes{v2.2c}{2007/07/23}{a lot of \% added and removed} % % \subsection{Options} % \texttt{scrpage} knows some options. They are similar to the @@ -633,11 +634,27 @@ % \begin{macro}{\if@mainmatter} % \changes{v1.2}{1995/07/08}{Definition changed} % \changes{v2.1b}{2003/05/31}{more save test} +% \changes{v2.2d}{2007/03/13}{additional \cs{if@mainmatter} test} % Next distinguish between matter- and nomatter-classes. % \begin{macrocode} \def\@tempa{\newif\if@mainmatter\@mainmattertrue} \begingroup\expandafter\expandafter\expandafter\endgroup -\expandafter\ifx\csname mainmatter\endcsname\relax\else\let\@tempa\relax\fi +\expandafter\ifx\csname mainmatter\endcsname\relax +\else +%<*v2> + \@ifundefined{@mainmattertrue}{% + \PackageWarningNoLine{scrpage2}{% + \string\mainmatter\space defined without + \string\if@mainmatter!\MessageBreak + This switch is obligatory for scrpage2 to omit\MessageBreak + running head chapter numbers in front and\MessageBreak + back matter and will be defined now% + }% + }{% +%</v2> + \let\@tempa\relax +%<v2> }% +\fi \@tempa % \end{macrocode} % \end{macro} @@ -696,13 +713,14 @@ % \end{macrocode} % Now the we can define the head and the foot. First at twoside-mode: % \changes{v1.0b}{1995/05/25}{Dot deleted after number at -% chapter- and sectionmark} +% chapter- and sectionmark} % \changes{v1.0b}{1995/05/25}{Use CJK at \cs{chaptermark}, -% \cs{sectionmark} and \cs{subsectionmark}} +% \cs{sectionmark} and \cs{subsectionmark}} % \changes{v2.0}{2001/04/20}{Version 2 uses \cs{automark} and -% \cs{manualmark}, so star and non-star -% version are same} +% \cs{manualmark}, so star and non-star version are same} % \changes{v2.1a}{2002/10/30}{Use \cs{if@automark}} +% \changes{v2.2d}{2007/06/14}{Support of article-classes with +% \cs{if@mainmatter}} % \begin{macrocode} \if@twoside \def\@defpagestyle[#1]#2#3#4{% @@ -720,25 +738,25 @@ \if@mainmatter\chaptermarkformat\fi\fi ####1}}% \def\sectionmark####1{% \markright {\ifnum \c@secnumdepth >\z@% - \sectionmarkformat\fi ####1}} + \sectionmarkformat\fi ####1}}% \else \def\sectionmark####1{% \markboth {\ifnum \c@secnumdepth >\z@% - \sectionmarkformat\fi ####1}{% + \if@mainmatter\sectionmarkformat\fi\fi ####1}{% \ifnum \c@secnumdepth >\z@% - \sectionmarkformat\fi ####1}} + \ifmainmatter\sectionmarkformat\fi\fi ####1}}% \def\subsectionmark####1{% \markright {\ifnum \c@secnumdepth >\@ne% - \subsectionmarkformat\fi ####1}} + \subsectionmarkformat\fi ####1}}% \fi \else \let\@mkboth\@gobbletwo \if@chapter - \def\chaptermark####1{} + \def\chaptermark####1{}% \else - \def\subsectionmark####1{} + \def\subsectionmark####1{}% \fi - \def\sectionmark####1{} + \def\sectionmark####1{}% \fi %</v1> %<!v1> \if@automark\let\@mkboth\markboth\else\let\@mkboth\@gobbletwo\fi @@ -761,21 +779,21 @@ \def\chaptermark####1{% \markright {\ifnum \c@secnumdepth >\m@ne% \if@mainmatter\chaptermarkformat\fi\fi ####1}}% - \def\sectionmark####1{} + \def\sectionmark####1{}% \else \def\sectionmark####1{% \markright{\ifnum \c@secnumdepth >\z@% - \sectionmarkformat\fi ####1}} - \def\subsectionmark####1{} + \if@mainmatter\sectionmarkformat\fi\fi ####1}}% + \def\subsectionmark####1{}% \fi \else \let\@mkboth\@gobbletwo \if@chapter - \def\chaptermark####1{} + \def\chaptermark####1{}% \else - \def\subsectionmark####1{} + \def\subsectionmark####1{}% \fi - \def\sectionmark####1{} + \def\sectionmark####1{}% \fi %</v1> %<!v1> \if@automark\let\@mkboth\markboth\else\let\@mkboth\@gobbletwo\fi @@ -796,43 +814,43 @@ % \begin{macrocode} %<*v2> \def\def@twosidehead{% - \@ifnextchar( - {\def@@twosidehead} + \@ifnextchar(%) + {\def@@twosidehead}% {\def@@twosidehead(\scr@headabove@linelength,% \scr@headabove@linethickness)}} \def\def@@twosidehead(#1,#2)#3#4#5{% - \@ifnextchar( - {\def@@@twosidehead({#1},{#2}){#3}{#4}{#5}} + \@ifnextchar(%) + {\def@@@twosidehead({#1},{#2}){#3}{#4}{#5}}% {\def@@@twosidehead({#1},{#2}){#3}{#4}{#5}% (\scr@headbelow@linelength,% \scr@headbelow@linethickness)}} \def\def@@@twosidehead(#1,#2)#3#4#5(#6,#7){% %</v2> -%<v1>\def\def@twosidehead(#1,#2)#3#4#5(#6,#7){ +%<v1>\def\def@twosidehead(#1,#2)#3#4#5(#6,#7){% \def\@evenhead{\let\headmark\leftmark% \hss\hskip\@evenheadshift\vbox{\hsize=\@headwidth\relax% \hf@rule{#1}{#2}{\@headwidth}% %<v2> {headabove}% \vskip#2 - \vskip\baselineskip% + \vskip\baselineskip \hb@xt@\@headwidth{{% -%<v2> \scr@nouppercase% +%<v2> \scr@nouppercase \headfont\strut #3}}% \hf@rule{#6}{#7}{\@headwidth}% %<v2> {headbelow}% - }\hskip\@oddheadshift\hss} - \def\@oddhead{\let\headmark\rightmark% - \hss\hskip\@oddheadshift\vbox{\hsize=\@headwidth\relax% + }\hskip\@oddheadshift\hss}% + \def\@oddhead{\let\headmark\rightmark + \hss\hskip\@oddheadshift\vbox{\hsize=\@headwidth\relax \hf@rule{#1}{#2}{\@headwidth}% %<v2> {headabove}% - \vskip#2 - \vskip\baselineskip% + \vskip#2% + \vskip\baselineskip \hb@xt@\@headwidth{{% -%<v2> \scr@nouppercase% +%<v2> \scr@nouppercase \headfont\strut #4}}% \hf@rule{#6}{#7}{\@headwidth}% %<v2> {headbelow}% - }\hskip\@evenheadshift\hss} + }\hskip\@evenheadshift\hss}% } % \end{macrocode} % \end{macro} @@ -850,32 +868,32 @@ % \begin{macrocode} %<*v2> \def\def@onesidehead{% - \@ifnextchar( - {\def@@onesidehead} + \@ifnextchar(%) + {\def@@onesidehead}% {\def@@onesidehead(\scr@headabove@linelength,% \scr@headabove@linethickness)}} \def\def@@onesidehead(#1,#2)#3#4#5{% - \@ifnextchar( - {\def@@@onesidehead({#1},{#2}){#3}{#4}{#5}} + \@ifnextchar(%) + {\def@@@onesidehead({#1},{#2}){#3}{#4}{#5}}% {\def@@@onesidehead({#1},{#2}){#3}{#4}{#5}% (\scr@headbelow@linelength,% \scr@headbelow@linethickness)}} \def\def@@@onesidehead(#1,#2)#3#4#5(#6,#7){% %</v2> -%<v1>\def\def@onesidehead(#1,#2)#3#4#5(#6,#7){ - \def\@evenhead{} - \def\@oddhead{\let\headmark\rightmark% - \hss\hskip\@oddheadshift\vbox{\hsize=\@headwidth\relax% +%<v1>\def\def@onesidehead(#1,#2)#3#4#5(#6,#7){% + \def\@evenhead{}% + \def\@oddhead{\let\headmark\rightmark + \hss\hskip\@oddheadshift\vbox{\hsize=\@headwidth\relax \hf@rule{#1}{#2}{\@headwidth}% %<v2> {headabove}% \vskip#2% - \vskip\baselineskip% + \vskip\baselineskip \hb@xt@\@headwidth{{% -%<v2> \scr@nouppercase% - \headfont\strut #5}} +%<v2> \scr@nouppercase + \headfont\strut #5}}% \hf@rule{#6}{#7}{\@headwidth}% %<v2> {headbelow}% - }\hskip\@evenheadshift\hss} + }\hskip\@evenheadshift\hss}% } % \end{macrocode} % \end{macro} @@ -891,31 +909,31 @@ % \begin{macrocode} %<*v2> \def\def@twosidefoot{% - \@ifnextchar( + \@ifnextchar(%) {\def@@twosidefoot} {\def@@twosidefoot(\scr@footabove@linelength,% \scr@footabove@linethickness)}} \def\def@@twosidefoot(#1,#2)#3#4#5{% - \@ifnextchar( - {\def@@@twosidefoot({#1},{#2}){#3}{#4}{#5}} + \@ifnextchar(%) + {\def@@@twosidefoot({#1},{#2}){#3}{#4}{#5}}% {\def@@@twosidefoot({#1},{#2}){#3}{#4}{#5}% (\scr@footbelow@linelength,% \scr@footbelow@linethickness)}} \def\def@@@twosidefoot(#1,#2)#3#4#5(#6,#7){% %</v2> -%<v1>\def\def@twosidefoot(#1,#2)#3#4#5(#6,#7){ - \def\@evenfoot{\let\headmark\leftmark% - \hss\hskip\@evenfootshift\vbox{\hsize=\@footwidth\relax% +%<v1>\def\def@twosidefoot(#1,#2)#3#4#5(#6,#7){% + \def\@evenfoot{\let\headmark\leftmark + \hss\hskip\@evenfootshift\vbox{\hsize=\@footwidth\relax \topfoot@rule{#1}{#2}\hb@xt@\@footwidth{{% -%<v2> \scr@nouppercase% +%<v2> \scr@nouppercase \headfont\strut #3}}% - \botfoot@rule{#6}{#7}}\hskip\@oddfootshift\hss} - \def\@oddfoot{\let\headmark\rightmark% - \hss\hskip\@oddfootshift\vbox{\hsize=\@footwidth\relax% + \botfoot@rule{#6}{#7}}\hskip\@oddfootshift\hss}% + \def\@oddfoot{\let\headmark\rightmark + \hss\hskip\@oddfootshift\vbox{\hsize=\@footwidth\relax \topfoot@rule{#1}{#2}\hb@xt@\@footwidth{{% -%<v2> \scr@nouppercase% +%<v2> \scr@nouppercase \headfont\strut #4}}% - \botfoot@rule{#6}{#7}}\hskip\@evenfootshift\hss} + \botfoot@rule{#6}{#7}}\hskip\@evenfootshift\hss}% } % \end{macrocode} % \end{macro} @@ -931,26 +949,26 @@ % \begin{macrocode} %<*v2> \def\def@onesidefoot{% - \@ifnextchar( - {\def@@onesidefoot} + \@ifnextchar(%) + {\def@@onesidefoot}% {\def@@onesidefoot(\scr@footabove@linelength,% \scr@footabove@linethickness)}} \def\def@@onesidefoot(#1,#2)#3#4#5{% - \@ifnextchar( - {\def@@@onesidefoot({#1},{#2}){#3}{#4}{#5}} + \@ifnextchar(%) + {\def@@@onesidefoot({#1},{#2}){#3}{#4}{#5}}% {\def@@@onesidefoot({#1},{#2}){#3}{#4}{#5}% (\scr@footbelow@linelength,% \scr@footbelow@linethickness)}} \def\def@@@onesidefoot(#1,#2)#3#4#5(#6,#7){% %</v2> -%<v1>\def\def@onesidefoot(#1,#2)#3#4#5(#6,#7){ - \def\@evenfoot{} - \def\@oddfoot{\let\headmark\rightmark% - \hss\hskip\@oddfootshift\vbox{\hsize=\@footwidth\relax% +%<v1>\def\def@onesidefoot(#1,#2)#3#4#5(#6,#7){% + \def\@evenfoot{}% + \def\@oddfoot{\let\headmark\rightmark + \hss\hskip\@oddfootshift\vbox{\hsize=\@footwidth\relax \topfoot@rule{#1}{#2}\hb@xt@\@footwidth{{% -%<v2> \scr@nouppercase% +%<v2> \scr@nouppercase \headfont\strut #5}} - \botfoot@rule{#6}{#7}}\hskip\@evenfootshift\hss} + \botfoot@rule{#6}{#7}}\hskip\@evenfootshift\hss}% } % \end{macrocode} % \end{macro} @@ -1007,7 +1025,7 @@ \fi \ifnum\@tempa=1 %</v2> - \setlength{\@tempdimb}{.5\@tempdimb} + \setlength{\@tempdimb}{.5\@tempdimb}% %<v2> \fi \hb@xt@#3{% %<v2> \ifnum\@tempa>0 @@ -1081,20 +1099,20 @@ % There we have to distinguish, whether the pagestyle is already % defined or not. % \begin{macrocode} -\def\@newpagestyle[#1]#2#3#4{ +\def\@newpagestyle[#1]#2#3#4{% \expandafter\ifx\csname ps@#2\endcsname\relax % \end{macrocode} % Then we can use the already defined |\@defpagestyle|. % \begin{macrocode} - \@defpagestyle[#1]{#2}{#3}{#4} + \@defpagestyle[#1]{#2}{#3}{#4}% \else \PackageError -%<v1> {scrpage} -%<v2> {scrpage2} +%<v1> {scrpage}% +%<v2> {scrpage2}% {Your command was ignored}% {There is already a pagestyle named ``#1''.\MessageBreak% Use \protect\defpagestyle\space, \protect\renewpagestyle or - \protect\providepagestyle.} + \protect\providepagestyle.}% \fi } % \end{macrocode} @@ -1118,21 +1136,21 @@ % There we have to distinguish, whether the pagestyle is already % defined or not. % \begin{macrocode} -\def\@renewpagestyle[#1]#2#3#4{ +\def\@renewpagestyle[#1]#2#3#4{% \begingroup\expandafter\expandafter\expandafter\endgroup \expandafter\ifx\csname ps@#2\endcsname\relax \PackageError -%<v1> {scrpage} -%<v2> {scrpage2} +%<v1> {scrpage}% +%<v2> {scrpage2}% {Your command was ignored}% {There is no pagestyle named ``#1''.\MessageBreak% Use \protect\defpagestyle, \protect\newpagestyle or - \protect\providepagestyle.} + \protect\providepagestyle.}% \else % \end{macrocode} % Then we can use the already defined |\@defpagestyle|. % \begin{macrocode} - \@defpagestyle[#1]{#2}{#3}{#4} + \@defpagestyle[#1]{#2}{#3}{#4}% \fi } % \end{macrocode} @@ -1154,17 +1172,17 @@ % There we have to distinguish, whether the pagestyle is already % defined or not. % \begin{macrocode} -\def\@providepagestyle[#1]#2#3#4{ +\def\@providepagestyle[#1]#2#3#4{% \expandafter\ifx\csname ps@#2\endcsname\relax % \end{macrocode} % Then we can use the already defined |\@defpagestyle|. % \begin{macrocode} - \@defpagestyle[#1]{#2}{#3}{#4} + \@defpagestyle[#1]{#2}{#3}{#4}% \else \PackageInfo -%<v1> {scrpage} -%<v2> {scrpage2} - {\protect\providepagestyle\protect{#1\protect} ignored.} +%<v1> {scrpage}% +%<v2> {scrpage2}% + {\protect\providepagestyle\protect{#1\protect} ignored.}% \fi } % \end{macrocode} @@ -1191,7 +1209,7 @@ % \begin{macro}{\@deftripstyle} % \begin{macrocode} \def\@deftripstyle[#1]#2{% - \@ifnextchar[ + \@ifnextchar[%] {\@@deftripstyle[#1]{#2}}% {\@@deftripstyle[#1]{#2}[\z@]}} % \end{macrocode} @@ -1199,13 +1217,13 @@ % or perhaps two optional arguments: % \begin{macro}{\@@deftripstyle} % \begin{macrocode} -\def\@@deftripstyle[#1]#2[#3]{ +\def\@@deftripstyle[#1]#2[#3]{% % \end{macrocode} % Ok, now we have the problem, that there can be only 9 arguments. So we % have to distinguish the star-versions by a macro: % \begin{macrocode} - \def\@tempa{#1} - \@ifnextchar[ + \def\@tempa{#1}% + \@ifnextchar[%] {\@@@deftripstyle#2[#3]}% {\@@@deftripstyle#2[\z@][#3]}} % \end{macrocode} @@ -1214,31 +1232,31 @@ % \begin{macro}{\@@@deftripstyle} % \begin{macrocode} \def\@@@deftripstyle#1[#2][#3]#4#5#6#7#8#9{% - \def\@tempb{+} - \ifx\@tempa\@tempb% + \def\@tempb{+}% + \ifx\@tempa\@tempb \defpagestyle{#1}% {(\@headwidth,#2)% {\rlap{#6}\hfill{#5}\hfill\llap{#4}}% {\rlap{#4}\hfill{#5}\hfill\llap{#6}}% {\rlap{#4}\hfill{#5}\hfill\llap{#6}}% - (\@headwidth,#3)} + (\@headwidth,#3)}% {(\@footwidth,#3)% {\rlap{#9}\hfill{#8}\hfill\llap{#7}}% {\rlap{#7}\hfill{#8}\hfill\llap{#9}}% {\rlap{#7}\hfill{#8}\hfill\llap{#9}}% - (\@footwidth,#2)} + (\@footwidth,#2)}% \else \defpagestyle*{#1}% {(\@headwidth,#2)% {\rlap{#6}\hfill{#5}\hfill\llap{#4}}% {\rlap{#4}\hfill{#5}\hfill\llap{#6}}% {\rlap{#4}\hfill{#5}\hfill\llap{#6}}% - (\@headwidth,#3)} + (\@headwidth,#3)}% {(\@footwidth,#3)% {\rlap{#9}\hfill{#8}\hfill\llap{#7}}% {\rlap{#7}\hfill{#8}\hfill\llap{#9}}% {\rlap{#7}\hfill{#8}\hfill\llap{#9}}% - (\@footwidth,#2)} + (\@footwidth,#2)}% \fi } % \end{macrocode} @@ -1275,13 +1293,13 @@ % \cs{@markright} at \LaTeX{} kernel. % \begin{macrocode} \newcommand*{\@iflevelok}[4]{% - \begingroup% - \edef\@tempa{#1}\ifx\@tempa\@empty\def\@tempa{\endgroup #3}\else% + \begingroup + \edef\@tempa{#1}\ifx\@tempa\@empty\def\@tempa{\endgroup #3}\else \def\@tempa{\csname #1level\endcsname}% \def\@tempb{\csname #2level\endcsname}% - \ifnum \@tempa>\@tempb% + \ifnum \@tempa>\@tempb \def\@tempa{\endgroup#3}% - \else% + \else \def\@tempa{\endgroup#4}% \fi\fi\@tempa} \providecommand{\markleft}[1]{% @@ -1307,13 +1325,13 @@ \begingroup \edef\@tempa{#2}\ifx\@tempa\@empty \endgroup - \PackageWarning{scrpage2} - {\string\automark\space with empty obligatory argument} + \PackageWarning{scrpage2}% + {\string\automark\space with empty obligatory argument}% \else \endgroup \expandafter\def\csname #2mark\endcsname##1{% \begingroup - \def\@tempa{\csname #2level\endcsname} + \def\@tempa{\csname #2level\endcsname}% \@tempswafalse \ifnum \c@secnumdepth <\@tempa\else\if@mainmatter \@tempswatrue @@ -1322,7 +1340,7 @@ \if@twoside\edef\@tempb{#2}\else\let\@tempb\@tempa\fi \ifx\@tempa\@tempb \if@tempswa - \@mkboth{\MakeMarkcase{\csname #2markformat\endcsname ##1}} + \@mkboth{\MakeMarkcase{\csname #2markformat\endcsname ##1}}% {\MakeMarkcase{\csname #2markformat\endcsname ##1}}% \else% \@mkboth{\MakeMarkcase{##1}}{\MakeMarkcase{##1}}% @@ -1338,14 +1356,14 @@ \else \@iflevelok{#1}{#2}{% \@mkboth{\MakeMarkcase{##1}}{}}{% - \ifx\@mkboth\markboth\markleft{\MakeMarkcase{##1}}\fi} + \ifx\@mkboth\markboth\markleft{\MakeMarkcase{##1}}\fi}% \fi \fi \endgroup } \fi \begingroup - \edef\@tempa{#1}\edef\@tempb{#2} + \edef\@tempa{#1}\edef\@tempb{#2}% \if@autooneside\if@twoside\else\let\@tempa\@empty\fi\fi \ifx\@tempa\@empty \endgroup @@ -1356,7 +1374,7 @@ \endgroup \expandafter\def\csname #1mark\endcsname##1{% \begingroup - \def\@tempa{\csname #1level\endcsname} + \def\@tempa{\csname #1level\endcsname}% \@tempswafalse \ifnum \c@secnumdepth <\@tempa\else\if@mainmatter \@tempswatrue @@ -1368,13 +1386,13 @@ ##1}}% \fi}{% \@mkboth{}{\MakeMarkcase{\csname #1markformat\endcsname - ##1}}} + ##1}}}% \else \@iflevelok{#1}{#2}{% \ifx\@mkboth\markboth \markright{\MakeMarkcase{##1}}% \fi}{% - \@mkboth{}{\MakeMarkcase{##1}}} + \@mkboth{}{\MakeMarkcase{##1}}}% \fi \endgroup } @@ -1448,7 +1466,7 @@ % \cs{MakeUppercase} at the head-marks. We set this macro to % \cs{MakeUppercase} if one of the standard-classes was loaded: % \begin{macrocode} -\@ifundefined{MakeMarkcase}{ +\@ifundefined{MakeMarkcase}{% \@ifclassloaded{scrbook}{\let\MakeMarkcase\relax}{% \@ifclassloaded{scrreprt}{\let\MakeMarkcase\relax}{% \@ifclassloaded{scrartcl}{\let\MakeMarkcase\relax}{% @@ -1460,7 +1478,7 @@ use of scrpage2 with unknown class.\MessageBreak Please mail to markus.kohm@gmx.de, if headmarks\MessageBreak - are lower case without use of scrpage2}}}} + are lower case without use of scrpage2}}}}% \let\MakeMarkcase\MakeUppercase}}}}}{} % \end{macrocode} % \end{macro} @@ -1472,7 +1490,7 @@ % This macro defines, which style for scrheadings should be used. If % it is not defined, we have to define it in a propper way. % \begin{macrocode} -\@ifundefined{scrheadings@style}{ +\@ifundefined{scrheadings@style}{% \@ifclassloaded{scrbook}{\def\scrheadings@style{koma}}{% \@ifclassloaded{scrreprt}{\def\scrheadings@style{koma}}{% \@ifclassloaded{scrartcl}{\def\scrheadings@style{koma}}{% @@ -1520,35 +1538,35 @@ % is \cs{deftowidthof}. % \begin{macrocode} \newcommand*{\settowidthof}[2]{% - \edef\@tempa{#2} + \edef\@tempa{#2}% \edef\@tempb{paper}\ifx\@tempa\@tempb - \setlength{#1}{\paperwidth} + \setlength{#1}{\paperwidth}% \else\edef\@tempb{text}\ifx\@tempa\@tempb - \setlength{#1}{\textwidth} + \setlength{#1}{\textwidth}% \else\edef\@tempb{textwithmarginpar}\ifx\@tempa\@tempb - \setlength{#1}{\textwidth} - \addtolength{#1}{\marginparwidth} - \addtolength{#1}{\marginparsep} + \setlength{#1}{\textwidth}% + \addtolength{#1}{\marginparwidth}% + \addtolength{#1}{\marginparsep}% \else\edef\@tempb{head}\ifx\@tempa\@tempb - \setlength{#1}{\@headwidth} + \setlength{#1}{\@headwidth}% \else\edef\@tempb{foot}\ifx\@tempa\@tempb - \setlength{#1}{\@footwidth} + \setlength{#1}{\@footwidth}% \else\edef\@tempb{headtopline}\ifx\@tempa\@tempb - \setlength{#1}{\scr@headabove@linelength} + \setlength{#1}{\scr@headabove@linelength}% \else\edef\@tempb{headsepline}\ifx\@tempa\@tempb - \setlength{#1}{\scr@headbelow@linelength} + \setlength{#1}{\scr@headbelow@linelength}% \else\edef\@tempb{footsepline}\ifx\@tempa\@tempb - \setlength{#1}{\scr@footabove@linelength} + \setlength{#1}{\scr@footabove@linelength}% \else\edef\@tempb{footbotline}\ifx\@tempa\@tempb - \setlength{#1}{\scr@footbelow@linelength} + \setlength{#1}{\scr@footbelow@linelength}% \else\edef\@tempb{page}\ifx\@tempa\@tempb - \setlength{#1}{\paperwidth} + \setlength{#1}{\paperwidth}% \begingroup\expandafter\expandafter\expandafter\endgroup \expandafter\ifx\csname ta@bcor\endcsname\relax\else - \addtolength{#1}{-\ta@bcor} + \addtolength{#1}{-\ta@bcor}% \fi \else - \setlength{#1}{#2} + \setlength{#1}{#2}% \fi \fi \fi @@ -1562,66 +1580,66 @@ } \newcommand*{\deftowidthof}[2]{% \edef\@tempa{#2}\edef\@tempb{autohead}\ifx\@tempa\@tempb - \expandafter\def\csname #1\endcsname{\@headwidth} + \expandafter\def\csname #1\endcsname{\@headwidth}% \else\edef\@tempb{autofoot}\ifx\@tempa\@tempb - \expandafter\def\csname #1\endcsname{\@footwidth} + \expandafter\def\csname #1\endcsname{\@footwidth}% \else - \settowidthof{\@tempdima}{#2} - \expandafter\edef\csname #1\endcsname{\the\@tempdima} + \settowidthof{\@tempdima}{#2}% + \expandafter\edef\csname #1\endcsname{\the\@tempdima}% \fi \fi } \newcommand*{\setheadwidth}[2][\@empty]{% - \set@hf@width{head}{#1}{#2} + \set@hf@width{head}{#1}{#2} % } \newcommand*{\setfootwidth}[2][\@empty]{% - \set@hf@width{foot}{#1}{#2} + \set@hf@width{foot}{#1}{#2}% } \newcommand*{\set@hf@width}[3]{% - \settowidthof{\@tempdima}{#3} + \settowidthof{\@tempdima}{#3}% \ifdim\@tempdima>\paperwidth \PackageWarning -%<v1> {scrpage} -%<v2> {scrpage2} +%<v1> {scrpage}% +%<v2> {scrpage2}% {You've set width of #1 to a value\MessageBreak greater than width of page!\MessageBreak% - I`ll reduce width of #1 to width of page} - \setlength{\@tempdima}{\paperwidth} + I`ll reduce width of #1 to width of page}% + \setlength{\@tempdima}{\paperwidth}% \else \ifdim\@tempdima<\z@ \PackageWarning -%<v1> {scrpage} -%<v2> {scrpage2} +%<v1> {scrpage}% +%<v2> {scrpage2}% {You've set width of #1 to negative value!\MessageBreak% - I'll set it to 0pt} - \setlength{\@tempdima}{\z@} + I'll set it to 0pt}% + \setlength{\@tempdima}{\z@}% \fi \fi - \expandafter\edef\csname @#1width\endcsname{\the\@tempdima} - \edef\@tempa{#2} - \setlength{\@tempdima}{\textwidth} - \addtolength{\@tempdima}{-\csname @#1width\endcsname} + \expandafter\edef\csname @#1width\endcsname{\the\@tempdima}% + \edef\@tempa{#2}% + \setlength{\@tempdima}{\textwidth}% + \addtolength{\@tempdima}{-\csname @#1width\endcsname}% \ifx\@tempa\@empty \if@twoside - \setlength{\@tempdimb}{.3333333333\@tempdima} + \setlength{\@tempdimb}{.3333333333\@tempdima}% \else - \setlength{\@tempdimb}{.5\@tempdima} + \setlength{\@tempdimb}{.5\@tempdima}% \fi \else - \setlength{\@tempdimb}{#2} + \setlength{\@tempdimb}{#2}% \fi - \addtolength{\@tempdima}{-\@tempdimb} + \addtolength{\@tempdima}{-\@tempdimb}% \ifdim\@tempdimb<\z@ - \setlength{\@tempdimb}{-\@tempdimb} - \expandafter\edef\csname @odd#1shift\endcsname{-\the\@tempdimb} + \setlength{\@tempdimb}{-\@tempdimb}% + \expandafter\edef\csname @odd#1shift\endcsname{-\the\@tempdimb}% \else - \expandafter\edef\csname @odd#1shift\endcsname{\the\@tempdimb} + \expandafter\edef\csname @odd#1shift\endcsname{\the\@tempdimb}% \fi \ifdim\@tempdima<\z@ - \setlength{\@tempdima}{-\@tempdima} - \expandafter\edef\csname @even#1shift\endcsname{-\the\@tempdima} + \setlength{\@tempdima}{-\@tempdima}% + \expandafter\edef\csname @even#1shift\endcsname{-\the\@tempdima}% \else - \expandafter\edef\csname @even#1shift\endcsname{\the\@tempdima} + \expandafter\edef\csname @even#1shift\endcsname{\the\@tempdima}% \fi } % \end{macrocode} @@ -1648,26 +1666,26 @@ % The values of width and shift of head and foot are saved at internal % macros. % \begin{macrocode} -\newcommand*{\@headwidth}{\textwidth} -\newcommand*{\@oddheadshift}{\z@} -\newcommand*{\@evenheadshift}{\z@} -\newcommand*{\@footwidth}{\textwidth} -\newcommand*{\@oddfootshift}{\z@} -\newcommand*{\@evenfootshift}{\z@} +\newcommand*{\@headwidth}{\textwidth}% +\newcommand*{\@oddheadshift}{\z@}% +\newcommand*{\@evenheadshift}{\z@}% +\newcommand*{\@footwidth}{\textwidth}% +\newcommand*{\@oddfootshift}{\z@}% +\newcommand*{\@evenfootshift}{\z@}% % \end{macrocode} % If option \texttt{mpinclude} was used, we use a special trick to set % width of head and foot but only if the user doesn't: % \begin{macrocode} %<*v2> \if@mincl - \renewcommand*{\@headwidth}{} - \renewcommand*{\@footwidth}{} + \renewcommand*{\@headwidth}{}% + \renewcommand*{\@footwidth}{}% \AtBeginDocument{% \ifx\@headwidth\@empty - \setheadwidth[0pt]{textwithmarginpar} + \setheadwidth[0pt]{textwithmarginpar}% \fi \ifx\@footwidth\@empty - \setfootwidth[0pt]{textwithmarginpar} + \setfootwidth[0pt]{textwithmarginpar}% \fi } \fi @@ -1882,7 +1900,7 @@ \newcommand*{\ps@save@myheadings}{} \let\ps@save@myheadings\ps@myheadings \def\ps@headings{% - \PackageWarning{scrpage2} + \PackageWarning{scrpage2}% {you've used pagestyle ``headings''.\MessageBreak You should not use this pagestyle with a\MessageBreak scrpage2-pagestyle!\MessageBreak @@ -1890,7 +1908,7 @@ \let\ps@plain\ps@save@plain% \ps@save@headings\@automarktrue} \def\ps@myheadings{% - \PackageWarning{scrpage2} + \PackageWarning{scrpage2}% {you've used pagestyle ``myheadings''.\MessageBreak You should not use this pagestyle with a\MessageBreak scrpage2-pagestyle!\MessageBreak @@ -1918,16 +1936,16 @@ % \begin{macrocode} \newcommand*{\ps@useheadings}{% \if@automark\let\@mkboth\markboth\else\let\@mkboth\@gobbletwo\fi - \let\ps@plain\ps@use@plain% - \let\save@@mkboth\@mkboth% - \let\save@chaptermark\chaptermark% - \let\save@sectionmark\sectionmark% - \let\save@subsectionmark\subsectionmark% - \ifx\@mkboth\markboth\ps@save@headings\else\ps@save@myheadings\fi% - \let\@mkboth\save@@mkboth% - \let\chaptermark\save@chaptermark% - \let\sectionmark\save@sectionmark% - \let\subsectionmark\save@subsectionmark% + \let\ps@plain\ps@use@plain + \let\save@@mkboth\@mkboth + \let\save@chaptermark\chaptermark + \let\save@sectionmark\sectionmark + \let\save@subsectionmark\subsectionmark + \ifx\@mkboth\markboth\ps@save@headings\else\ps@save@myheadings\fi + \let\@mkboth\save@@mkboth + \let\chaptermark\save@chaptermark + \let\sectionmark\save@sectionmark + \let\subsectionmark\save@subsectionmark } % \end{macrocode} % Note: Because of saving \cs{@mkboth}, \cs{chaptermark}, @@ -1975,64 +1993,64 @@ \newcommand*{\ps@scrplain}{\let\ps@plain\ps@@scrplain\ps@plain} \newpagestyle{@scrplain} {% - (\scrplain@headabove@linelength,\scr@headabove@linethickness) + (\scrplain@headabove@linelength,\scr@headabove@linethickness)% {% - \rlap{\parbox{\@headwidth}{\raggedright% + \rlap{\parbox{\@headwidth}{\raggedright \strut\scrplain@even@left@head\strut}}% - \hfill% - \parbox{\@headwidth}{\centering\strut% + \hfill + \parbox{\@headwidth}{\centering\strut \scrplain@even@middle@head\strut}% - \hfill% - \llap{\parbox{\@headwidth}{\raggedleft% - \strut\scrplain@even@right@head\strut}}} + \hfill + \llap{\parbox{\@headwidth}{\raggedleft + \strut\scrplain@even@right@head\strut}}}% {% - \rlap{\parbox{\@headwidth}{\raggedright% + \rlap{\parbox{\@headwidth}{\raggedright \strut\scrplain@odd@left@head\strut}}% - \hfill% - \parbox{\@headwidth}{\centering% + \hfill + \parbox{\@headwidth}{\centering \strut\scrplain@odd@middle@head\strut}% - \hfill% - \llap{\parbox{\@headwidth}{\raggedleft% - \strut\scrplain@odd@right@head\strut}}} + \hfill + \llap{\parbox{\@headwidth}{\raggedleft + \strut\scrplain@odd@right@head\strut}}}% {% - \rlap{\parbox{\@headwidth}{\raggedright% + \rlap{\parbox{\@headwidth}{\raggedright \strut\scrplain@odd@left@head\strut}}% - \hfill% - \parbox{\@headwidth}{\centering% + \hfill + \parbox{\@headwidth}{\centering \strut\scrplain@odd@middle@head\strut}% - \hfill% - \llap{\parbox{\@headwidth}{\raggedleft% - \strut\scrplain@odd@right@head\strut}}} + \hfill + \llap{\parbox{\@headwidth}{\raggedleft + \strut\scrplain@odd@right@head\strut}}}% (\scrplain@headbelow@linelength,\scr@headbelow@linethickness) }{% (\scrplain@footabove@linelength,\scr@footabove@linethickness) {% - \rlap{\parbox{\@footwidth}{\raggedright% + \rlap{\parbox{\@footwidth}{\raggedright \strut\scrplain@even@left@foot\strut}}% - \hfill% - \parbox{\@footwidth}{\centering% + \hfill + \parbox{\@footwidth}{\centering \strut\scrplain@even@middle@foot\strut}% - \hfill% - \llap{\parbox{\@footwidth}{\raggedleft% - \strut\scrplain@even@right@foot\strut}}} + \hfill + \llap{\parbox{\@footwidth}{\raggedleft + \strut\scrplain@even@right@foot\strut}}}% {% - \rlap{\parbox{\@footwidth}{\raggedright% + \rlap{\parbox{\@footwidth}{\raggedright \strut\scrplain@odd@left@foot\strut}}% - \hfill% - \parbox{\@footwidth}{\centering% + \hfill + \parbox{\@footwidth}{\centering \strut\scrplain@odd@middle@foot\strut}% - \hfill% - \llap{\parbox{\@footwidth}{\raggedleft% - \strut\scrplain@odd@right@foot\strut}}} + \hfill + \llap{\parbox{\@footwidth}{\raggedleft + \strut\scrplain@odd@right@foot\strut}}}% {% - \rlap{\parbox{\@footwidth}{\raggedright% + \rlap{\parbox{\@footwidth}{\raggedright \strut\scrplain@odd@left@foot\strut}}% - \hfill% - \parbox{\@footwidth}{\centering% + \hfill + \parbox{\@footwidth}{\centering \strut\scrplain@odd@middle@foot\strut}% - \hfill% - \llap{\parbox{\@footwidth}{\raggedleft% - \strut\scrplain@odd@right@foot\strut}}} + \hfill + \llap{\parbox{\@footwidth}{\raggedleft + \strut\scrplain@odd@right@foot\strut}}}% (\scrplain@footbelow@linelength,\scr@footbelow@linethickness) } \newcommand*{\scrplain@even@left@head}{} @@ -2099,60 +2117,62 @@ \newpagestyle{@scrheadings} {% {% - \rlap{\parbox{\@headwidth}{\raggedright% + \rlap{\parbox{\@headwidth}{\raggedright \strut\scrheadings@even@left@head\strut}}% - \hfill% - \parbox{\@headwidth}{\centering% + \hfill + \parbox{\@headwidth}{\centering \strut\scrheadings@even@middle@head\strut}% - \hfill% + \hfill \llap{\parbox{\@headwidth}{\raggedleft% - \strut\scrheadings@even@right@head\strut}}} + \strut\scrheadings@even@right@head\strut}}}% {% - \rlap{\parbox{\@headwidth}{\raggedright% + \rlap{\parbox{\@headwidth}{\raggedright \strut\scrheadings@odd@left@head\strut}}% - \hfill% - \parbox{\@headwidth}{\centering% + \hfill + \parbox{\@headwidth}{\centering \strut\scrheadings@odd@middle@head\strut}% - \hfill% + \hfill \llap{\parbox{\@headwidth}{\raggedleft% - \strut\scrheadings@odd@right@head\strut}}} + \strut\scrheadings@odd@right@head\strut}}}% {% - \rlap{\parbox{\@headwidth}{\raggedright% + \rlap{\parbox{\@headwidth}{\raggedright \strut\scrheadings@odd@left@head\strut}}% - \hfill% - \parbox{\@headwidth}{\centering% + \hfill + \parbox{\@headwidth}{\centering \strut\scrheadings@odd@middle@head\strut}% - \hfill% - \llap{\parbox{\@headwidth}{\raggedleft% - \strut\scrheadings@odd@right@head\strut}}}} + \hfill + \llap{\parbox{\@headwidth}{\raggedleft + \strut\scrheadings@odd@right@head\strut}}}}% {% {% - \rlap{\parbox{\@footwidth}{\raggedright% + \rlap{\parbox{\@footwidth}{\raggedright \strut\scrheadings@even@left@foot\strut}}% - \hfill% - \parbox{\@footwidth}{\centering% + \hfill + \parbox{\@footwidth}{\centering \strut\scrheadings@even@middle@foot\strut}% - \hfill% - \llap{\parbox{\@footwidth}{\raggedleft% - \strut\scrheadings@even@right@foot\strut}}} + \hfill + \llap{\parbox{\@footwidth}{\raggedleft + \strut\scrheadings@even@right@foot\strut}}}% {% - \rlap{\parbox{\@footwidth}{\raggedright% + \rlap{\parbox{\@footwidth}{\raggedright \strut\scrheadings@odd@left@foot\strut}}% - \hfill% - \parbox{\@footwidth}{\centering% + \hfill + \parbox{\@footwidth}{\centering \strut\scrheadings@odd@middle@foot\strut}% - \hfill% - \llap{\parbox{\@footwidth}{\raggedleft% - \strut\scrheadings@odd@right@foot\strut}}} + \hfill + \llap{\parbox{\@footwidth}{\raggedleft + \strut\scrheadings@odd@right@foot\strut}}}% {% - \rlap{\parbox{\@footwidth}{\raggedright% + \rlap{\parbox{\@footwidth}{\raggedright \strut\scrheadings@odd@left@foot\strut}}% - \hfill% - \parbox{\@footwidth}{\centering% + \hfill + \parbox{\@footwidth}{\centering \strut\scrheadings@odd@middle@foot\strut}% - \hfill% - \llap{\parbox{\@footwidth}{\raggedleft% - \strut\scrheadings@odd@right@foot\strut}}}} + \hfill + \llap{\parbox{\@footwidth}{\raggedleft + \strut\scrheadings@odd@right@foot\strut}}% + }% +} \newcommand*{\scrheadings@even@left@head}{} \newcommand*{\scrheadings@even@middle@head}{} \newcommand*{\scrheadings@even@right@head}{} @@ -2342,18 +2362,18 @@ % redefinition directly: % \begin{macrocode} \newcommand*{\clearscrplain}{% - \renewcommand*{\scrplain@even@left@head}{} - \renewcommand*{\scrplain@even@middle@head}{} - \renewcommand*{\scrplain@even@right@head}{} - \renewcommand*{\scrplain@odd@left@head}{} - \renewcommand*{\scrplain@odd@middle@head}{} - \renewcommand*{\scrplain@odd@right@head}{} - \renewcommand*{\scrplain@even@left@foot}{} - \renewcommand*{\scrplain@even@middle@foot}{} - \renewcommand*{\scrplain@even@right@foot}{} - \renewcommand*{\scrplain@odd@left@foot}{} - \renewcommand*{\scrplain@odd@middle@foot}{} - \renewcommand*{\scrplain@odd@right@foot}{} + \renewcommand*{\scrplain@even@left@head}{}% + \renewcommand*{\scrplain@even@middle@head}{}% + \renewcommand*{\scrplain@even@right@head}{}% + \renewcommand*{\scrplain@odd@left@head}{}% + \renewcommand*{\scrplain@odd@middle@head}{}% + \renewcommand*{\scrplain@odd@right@head}{}% + \renewcommand*{\scrplain@even@left@foot}{}% + \renewcommand*{\scrplain@even@middle@foot}{}% + \renewcommand*{\scrplain@even@right@foot}{}% + \renewcommand*{\scrplain@odd@left@foot}{}% + \renewcommand*{\scrplain@odd@middle@foot}{}% + \renewcommand*{\scrplain@odd@right@foot}{}% } % \end{macrocode} % \end{macro} @@ -2403,7 +2423,7 @@ \ihead{\headmark} \ohead{\pagemark} \cfoot[\pagemark]{} - \else\PackageErrorNoLine{scrpage2}{unknown scrheadings style} + \else\PackageErrorNoLine{scrpage2}{unknown scrheadings style}% {Somehow \string\scrheadings@style was defined\MessageBreak as ``\scrheadings@style''.\MessageBreak @@ -2449,9 +2469,9 @@ % increased. % \begin{macrocode} %<*v2> -\AtBeginDocument{ +\AtBeginDocument{% \ifdim\headheight=12pt - \PackageWarningNoLine{scrpage2} + \PackageWarningNoLine{scrpage2}% {seems you are using a constant headheight.\MessageBreak If you get overfull \string\vbox\space warnings at almost every% \MessageBreak @@ -2459,9 +2479,9 @@ \space\string\setlength{\string\headheight}{% 1.1\string\baselineskip}\MessageBreak into the preamble of your document.\MessageBreak - A better solution would be to use typearea package} + A better solution would be to use typearea package}% \else\ifdim\headheight<1.07\baselineskip - \PackageWarningNoLine{scrpage2} + \PackageWarningNoLine{scrpage2}% {seems you are using a very small headheight.\MessageBreak If you get overfull \string\vbox\space warnings at almost every% \MessageBreak @@ -2469,7 +2489,7 @@ \space\string\setlength{\string\headheight}{% 1.1\string\baselineskip}\MessageBreak into the preamble of your document.\MessageBreak - A better solution would be to use typearea package} + A better solution would be to use typearea package}% \fi\fi} %</v2> % \end{macrocode} |