diff options
| author | Karl Berry <karl@freefriends.org> | 2007-12-26 22:26:13 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2007-12-26 22:26:13 +0000 |
| commit | d892fc1b7f46275b1e5c291db0305eac83abe9e3 (patch) | |
| tree | 50dac7763bbe931304c867a5da111a3f324b0a89 /Master/texmf-dist/source/latex/koma-script/doc/english | |
| parent | adb11f7c6718f766a22dbb2ce1b196a36acc197d (diff) | |
koma-script update (25dec07)
git-svn-id: svn://tug.org/texlive/trunk@5924 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english')
4 files changed, 1242 insertions, 251 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex new file mode 100644 index 00000000000..0f1769b4aae --- /dev/null +++ b/Master/texmf-dist/source/latex/koma-script/doc/english/japanlco.tex @@ -0,0 +1,603 @@ +% ====================================================================== +% japanlco.tex +% Copyright (c) Gernot Hassenpflug and Markus Kohm, 2001-2007 +% +% This file is part of the LaTeX2e KOMA-Script bundle. +% +% This work may be distributed and/or modified under the conditions of +% the LaTeX Project Public License, version 1.3b of the license. +% The latest version of this license is in +% http://www.latex-project.org/lppl.txt +% and version 1.3b or later is part of all distributions of LaTeX +% version 2005/12/01 or later and of this work. +% +% This work has the LPPL maintenance status "author-maintained". +% +% The Current Maintainer and author of this work is Markus Kohm. +% +% This work consists of all files listed in manifest.txt. +% ---------------------------------------------------------------------- +% japanlco.tex +% Copyright (c) Gernot Hassenpflug und Markus Kohm, 2001-2007 +% +% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, +% Version 1.3b, verteilt und/oder veraendert werden. +% Die neuste Version dieser Lizenz ist +% http://www.latex-project.org/lppl.txt +% und Version 1.3b ist Teil aller Verteilungen von LaTeX +% Version 2005/12/01 oder spaeter und dieses Werks. +% +% Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained" +% (allein durch den Autor verwaltet). +% +% Der Aktuelle Verwalter und Autor dieses Werkes ist Markus Kohm. +% +% Dieses Werk besteht aus den in manifest.txt aufgefuehrten Dateien. +% ====================================================================== +% +% Chapter about Japanise paper size, envelopes and letters +% Maintained by Gernot Hassenplug (with help from Markus Kohm) +% +% ---------------------------------------------------------------------- +% +% Kapitel ueber japanische Papierformate, Umschläge und Briefe +% Verwaltet von Gernot Hassenplug (mit Unterstuetzung von Markus Kohm) +% +% ====================================================================== +% +% Special Note: Originally in English by Gernot Hassenpflug as part of +% KOMA-Script bundle. +% + +\ProvidesFile{japanlco.tex}[2007/12/17 KOMA-Script guide (appendix: japanlco)] + +\appendix + +\chapter[{Japanese Letter Support for \Class{scrlttr2}}] +{Japanese Letter Support for \Class{scrlttr2}\footnote{This chapter has been + written originally by Gernot Hassenpflug.}} +\labelbase{japanlco} +\Index{letter>Japanese} + +Since version~2.97e \Class{scrlttr2} provides support not only for European +ISO~envelope sizes and window envelopes, but also for Japanese envelopes, in +the form of \File{lco} files which set the layout of the paper. This chapter +documents the support, and provides a few examples of using the provided +\File{lco} files for printing letters intended for Japanese envelopes. + +\section{Japanese standard paper and envelope sizes} +\label{sec:japanlco.PaperEnvelope} + +The Japan Industrial Standard (JIS) defines paper sizes and envelope sizes for +national use, which both overlap with the ISO and US sizes and include some +metricated traditional Japanese sizes. Envelope window size and position have +not been defined internationally as yet; hence, there exists a plethora of +envelopes with differing window sizes and positions. The below subsections +give some background on Japanese paper sizes and envelopes. + +\subsection{Japanese paper sizes} +\label{sec:japanlco.Paper} + +The JIS defines two main series of paper sizes: +\begin{enumerate} +\item the JIS A-series, which is identical to the ISO A-series, but + with slightly different tolerances; and +\item the JIS B-series, which is not identical to the ISO/DIN + B-series. Instead, the JIS B-series paper has an area 1.5 times that + of the corresponding A-series paper, so that the length ratio is + approximately 1.22 times the length of the corresponding A-series + paper. The aspect ratio of the paper is the same as for A-series + paper. +\end{enumerate} + +Both JIS A-series and B-series paper is widely available in Japan and most +photocopiers and printers are loaded with at least A4 and B4 paper. The +ISO/JIS~A-series, and the different ISO and JIS~B-series sizes are listed in +\autoref{tab:japanlco.jpapersizes1}. + +%% ISO/JIS standard comparison +\begin{table} +\begin{minipage}{\textwidth}\renewcommand*{\footnoterule}{}% +\centering +\caption[{ISO and JIS standard paper sizes}] +{ISO and JIS standard paper sizes}%; trim sizes are given with width +% preceding height, both in millimeters} +\begin{tabular}{lr@{$\times$}llr@{$\times$}llr@{$\times$}l}\toprule +ISO/JIS\,A & \multicolumn2l{W$\times$H in mm} & ISO\,B & +\multicolumn2l{W$\times$H in mm} & JIS\,B & \multicolumn2l{W$\times$H + in mm} \\ \midrule +A0 & 841 & 1189 & B0 & 1000 & 1414 & B0 & 1030 & 1456 \\ +A1 & 594 & 841 & B1 & 707 & 1000 & B1 & 728 & 1030 \\ +A2 & 420 & 594 & B2 & 500 & 707 & B2 & 515 & 728 \\ +A3 & 297 & 420 & B3 & 353 & 500 & B3 & 364 & 515 \\ +A4 & 210 & 297 & B4 & 250 & 353 & B4 & 257 & 364 \\ +A5 & 148 & 210 & B5 & 176 & 250 & B5 & 182 & 257 \\ +A6 & 105 & 148\footnotemark[1] & B6 & 125 & 176 & B6 & 128 & 182 \\ +A7 & 74 & 105 & B7 & 88 & 125 & B7 & 91 & 128 \\ +A8 & 52 & 74 & B8 & 62 & 88 & B8 & 64 & 91 \\ +A9 & 37 & 52 & B9 & 44 & 62 & B9 & 45 & 64 \\ +A10 & 26 & 37 & B10 & 31 & 44 & B10 & 32 & 45 \\ +A11 & 18 & 26 & & \multicolumn2l{} & B11 & 22 & 32 \\ +A12 & 13 & 18 & & \multicolumn2l{} & B12 & 16 & 22 \\ +\bottomrule +\end{tabular} +\label{tab:japanlco.jpapersizes1} +\footnotetext[1]{Although Japan's official postcard size + appears to be A6, it is actually 100$\times$148\Unit{mm}, 5 millimeters + narrower than A6.} +\end{minipage} +\end{table} + +There are also a number of traditional paper sizes, which are now used +mostly only by printers. The most common of these old series are the +Shiroku-ban and the Kiku paper sizes. The difference of these types compared +to the JIS~B-series are shown in \autoref{tab:japanlco.jpapersizes2}. +Finally, there are some common stationary sizes, listed in +\autoref{tab:japanlco.jpapersizes3}. You may come across these when buying +stationary. + +%% JIS B-series variants +\begin{table} +\centering +\caption[{Japanese B-series variants}] +{Japanese B-series variants}%; trim sizes are given with width +% preceding height, both in millimeters} +\begin{tabular}{lr@{$\times$}lr@{$\times$}lr@{$\times$}l}\toprule +Format & \multicolumn{2}{l}{JIS B-series} & \multicolumn{2}{l}{Shiroku-ban} & +\multicolumn{2}{l}{Kiku} \\ +Size & \multicolumn{2}{l}{W$\times$H in mm} & \multicolumn{2}{l}{W$\times$H in mm} & \multicolumn{2}{l}{W$\times$H in mm} \\ \midrule +4 & 257 & 364 & 264 & 379 & 227 & 306 \\ +5 & 182 & 257 & 189 & 262 & 151 & 227 \\ +6 & 128 & 182 & 189 & 262 & \multicolumn2l{} \\ +7 & 91 & 128 & 127 & 188 & \multicolumn2l{} \\ +\bottomrule +\end{tabular} +\label{tab:japanlco.jpapersizes2} +\end{table} + +%% Japanese contemporary sizes +\begin{table} +\centering +\caption[{Main Japanese contemporary stationary}] +{Main Japanese contemporary stationary}%; trim sizes are given with width +% preceding height, both in millimeters} +\begin{tabular}{lr@{$\times$}ll}\toprule +Name & \multicolumn{2}{l}{W$\times$H in mm} & Usage and Comments \\ \midrule +Kokusai-ban & 216 & 280 & ``international size'' \\ + & \multicolumn2l{} & i.\,e., US letter size \\ +Semi B5 or & 177 & 250 & ``standard size'' \\ +Hyoujun-gata & \multicolumn2l{} & (formerly called ``Hyoujun-gata''),\\ + & \multicolumn2l{} & semi B5 is almost identical to ISO B5 \\ +Oo-gata & 177 & 230 & ``large size'' \\ +Chuu-gata & 162 & 210 & ``medium size'' \\ +Ko-gata & 148 & 210 & ``small size'' \\ +Ippitsu sen & 82 & 185 & ``note paper'' \\ +\bottomrule +\end{tabular} +\label{tab:japanlco.jpapersizes3} +\end{table} + +The ISO~C-series is not a paper size as such, but is a standard +developed for envelopes, intended for the corresponding A-series +paper, and is discussed in the next subsection. + +%\clearpage +\subsection{Japanese envelope sizes} +\label{sec:japanlco.envelope} + +ISO (International Organization for Standardization) envelope sizes +are the official international metric envelope sizes; however, Japan +uses also JIS and metricated traditional envelope sizes. Sizes +identified as nonstandard do not conform to Universal Postal Union +requirements for correspondence envelopes. + +\subsubsection{ISO envelope sizes} +The ISO C-series envelope sizes, and possibly B-series envelope sizes, +are available in Japan. C-series envelopes can hold the corresponding +A-series paper, while B-series envelopes can hold either the +corresponding A-series paper or the corresponding C-series +envelope. The ISO envelope sizes commonly for Japan are listed in +\autoref{tab:japanlco.jenvsizes1}, with the corresponding paper they +are intended for, and the folding required. + +%%%%%% JIS Japanese Envelopes + +%% ISO envelope sizes +%{\onelinecaptionsfalse +%\begin{longtable}{lr@{$\times$}ll} +\begin{table} +\begin{minipage}{\textwidth}\renewcommand*{\footnoterule}{} +\caption[{Japanese ISO envelope sizes}] +{Japanese ISO envelope sizes}%; trim sizes are given with width +% preceding height, both in millimeters% +\label{tab:japanlco.jenvsizes1}% +%}\\ +\begin{tabular}{lr@{$\times$}ll} +\toprule +Name & \multicolumn2l{W$\times$H in mm} & Usage and Comments \\ +%\endfirsthead +%\caption[]{Japanese envelope sizes (\emph{continued})}\\ +%\toprule +%Name & \multicolumn2l{W$\times$H in mm} & Usage and Comments \\ +%\midrule +%\endhead +%\midrule +%\multicolumn{4}{r@{}}{\dots}\\ +%\endfoot +%\bottomrule +%\endlastfoot +\midrule +C0 & 917 & 1297 & for flat A0 sheet; \\* + & \multicolumn2l{} & nonstandard \\ +C1 & 648 & 917 & for flat A1 sheet; \\* + & \multicolumn2l{} & nonstandard \\ +C2 & 458 & 648 & for flat A2 sheet, A1 sheet folded in half; \\* + & \multicolumn2l{} & nonstandard \\ +C3 & 324 & 458 & for flat A3 sheet, A2 sheet folded in half; \\* + & \multicolumn2l{} & nonstandard \\ +B4 & 250 & 353 & C4 envelope \\ +C4 & 229 & 324 & for flat A4 sheet, A3 sheet folded in half; \\* + & \multicolumn2l{} & very common; nonstandard \\ +B5 & 176 & 250 & C5 envelope \\ +C5 & 162 & 229 & for flat A5 sheet, A4 sheet folded in half; \\* + & \multicolumn2l{} & very common; nonstandard \\ +B6 & 125 & 176 & C6 envelope; A4 folded in quarters; \\* + & \multicolumn2l{} & very common \\ +C6 & 114 & 162 & for A5 sheet folded in half, \\* + & \multicolumn2l{} & A4 sheet folded in quarters; \\* + & \multicolumn2l{} & very common \\ +C6/C5 & 114 & 229 & A4 sheet folded in thirds; \\* + & \multicolumn2l{} & very common \\ +C7/6 & 81 & 162 & for A5 sheet folded in thirds; uncommon; \\* + & \multicolumn2l{} & nonstandard \\ +C7 & 81 & 114 & for A5 sheet folded in quarters; uncommon; \\* + & \multicolumn2l{} & nonstandard \\ +C8 & 57 & 81 & \\ +C9 & 40 & 57 & \\ +C10 & 28 & 40 & \\ +DL\footnotemark[1] & 110 & 220 & for A4 sheet folded in thirds, \\* + & \multicolumn2l{} & A5 sheet folded in half lengthwise; \\* + & \multicolumn2l{} & very common \\ +%\end{longtable}}\vspace{-\baselineskip} +\bottomrule +\end{tabular} +%\noindent\begin{minipage}{\textwidth} +%\renewcommand*{\footnoterule}{} +\footnotetext[1]{Although DL is not part of the + ISO C-series, it is a very widely used standard size. DL, probably + at one time the abbreviation of DIN Lang (Deutsche Industrie Norm, + long), is now identified as ``Dimension Lengthwise'' by ISO 269.} +\end{minipage} +\end{table} + +\subsubsection{JIS and traditional envelope sizes} +The JIS classifies envelopes into three categories based on the +general shape of the envelope, and where the flap is located: + +\begin{description} +\item[You:] these envelopes are of the `commercial' type, rectangular, + and correspond largely to Western envelope sizes, and also have the + flap on the long dimension (`Open Side') in `commercial' or `square' + style. `You-kei' means Western-style. +\item[Chou:] these are also `commercial' type envelopes, with the same + shape as the corresponding `You' type, but with the flap on the + short dimension (`Open End') in `wallet' style. `Chou-kei' means + long-style. +\item[Kaku:] these envelopes are more square in appearance and are + made for special use, and correspond to `announcement' + envelopes. The flap is on the long side, in the `square' style. They + generally do not fall under the ordinary envelope postage + rates. `Kaku-kei' means square-style. +\end{description} + +The main JIS and traditional envelope sizes and the corresponding +paper and its required folding are listed in +\autoref{tab:japanlco.jenvsizes2}. + +%% JIS and other envelope sizes +%\begin{table} +%\begin{minipage}{\textwidth}\renewcommand*{\footnoterule}{}% +%\centering +{\onelinecaptionsfalse +\begin{longtable}{llr@{$\times$}ll} +\caption[{Japanese envelope sizes 3}] +{Japanese JIS and other envelope sizes\label{tab:japanlco.jenvsizes2}}% +%; trim sizes are given with width preceding height, both in millimeters}% +\\ +%\begin{tabular}{llr@{$\times$}ll} +\toprule +JIS & Name & \multicolumn2l{W$\times$ in mm} & Usage and Comments \\ +\endfirsthead +\caption[]{Japanese JIS and other envelope sizes (\emph{continued})}\\ +\toprule +JIS & Name & \multicolumn2l{W$\times$ in mm} & Usage and Comments \\ +\midrule +\endhead +\midrule +\multicolumn{5}{r@{}}{\dots}\\ +\endfoot +\bottomrule +\endlastfoot +\midrule + & Chou 1 & 142 & 332 & for A4 folded in half lengthwise;\\* + & & \multicolumn2l{} & nonstandard \\ +Yes & Chou 2 & 119 & 277 & for B5 folded in half lengthwise;\\* + & & \multicolumn2l{} & nonstandard \\ +Yes & Chou 3 & 120 & 235 & for A4 folded in thirds;\\* + & & \multicolumn2l{} & very common \\ + & Chou 31 & 105 & 235 & for A4 folded in thirds \\ + & Chou 30 & 92 & 235 & for A4 folded in fourths\footnotemark[3] \\ + & Chou 40 & 90 & 225 & for A4 folded in fourths\footnotemark[3] \\ +Yes & Chou 4 & 90 & 205 & for JIS B5 folded in fourths\footnotemark[3];\\* + & & \multicolumn2l{} & very common \\ + & Kaku A3 & 320 & 440 & for A3 flat, A2 folded in half\\* + & & \multicolumn2l{} &; nonstandard \\ + & Kaku 0 & 287 & 382 & for B4 flat, B3 folded in half;\\* + & & \multicolumn2l{} & nonstandard \\ + & Kaku 1 & 270 & 382 & for B4 flat, B3 folded in half;\\* + & & \multicolumn2l{} & nonstandard \\ +Yes & Kaku 2 & 240 & 332 & for A4 flat, A3 folded in half;\\* + & & \multicolumn2l{} & nonstandard \\ + & Kaku & 229 & 324 & for A4 flat, A3 folded in half;\\* + & Kokusai A4 & \multicolumn2l{} & same size as ISO C4;\\* + & & \multicolumn2l{} & nonstandard \\ +Yes & Kaku 3 & 216 & 277 & for B5 flat, B4 folded in half;\\* + & & \multicolumn2l{} & nonstandard \\ +Yes & Kaku 4 & 197 & 267 & for B5 flat, B4 folded in half;\\* + & & \multicolumn2l{} & nonstandard \\ +Yes & Kaku 5 & 190 & 240 & for A5 flat, A4 folded in half\\* + & & \multicolumn2l{} &; nonstandard \\ +Yes & Kaku 6 & 162 & 229 & for A5 flat, A4 folded in half;\\* + & & \multicolumn2l{} & same size as ISO C5;\\* + & & \multicolumn2l{} & nonstandard \\ +Yes & Kaku 7 & 142 & 205 & for B6 flat, B5 folded in half;\\* + & & \multicolumn2l{} & nonstandard \\ +Yes & Kaku 8 & 119 & 197 & pay envelope (for salaries, wages)\\* + & & \multicolumn2l{} &; common for direct mail \\ +Yes & You 0\footnotemark[1] & 235 & 120 & for A4 folded in thirds;\\* + & or Furusu 10 & \multicolumn2l{} & same size as Chou 3 but with \\* + & & \multicolumn2l{} & `Open Side' style flap \\ + & You 0\footnotemark[1] & 197 & 136 & for kyabine\footnotemark[1] (cabinet) size photos \\* + & & \multicolumn2l{} & (165\Unit{mm}$\times$120\Unit{mm});\\* + & & \multicolumn2l{} & nonstandard \\ + & You 1\footnotemark[2] & 176 & 120 & for B5 folded in quarters \\ + & You 1\footnotemark[2] & 173 & 118 & for B5 folded in quarters \\ +Yes & You 2 & 162 & 114 & for A5 folded in half,\\* + & & \multicolumn2l{} & A4 folded in quarters;\\* + & & \multicolumn2l{} & same size as ISO C6 \\ +Yes & You 3 & 148 & 98 & for B6 folded in half \\ +Yes & You 4 & 235 & 105 & for A4 folded in thirds \\ +Yes & You 5 & 217 & 95 & for A4 folded in fourths\footnotemark[3] \\ +Yes & You 6 & 190 & 98 & for B5 folded in thirds \\ +Yes & You 7 & 165 & 92 & for A4 folded in quarters,\\* + & & \multicolumn2l{} & B4 folded in quarters \\ +%\bottomrule +%\end{tabular}% +\end{longtable}}\vskip-\baselineskip +\noindent\begin{minipage}{\textwidth}\renewcommand*{\footnoterule}{}% + \footnotetext[1]{Because two different sizes are called You~0, the + JIS You~0 is normally called Furusu~10; Furusu (`fools') derives + from `foolscap'; Kyabine is a metricated traditional Japanese + size.}% + \footnotetext[2]{Two slightly different sizes are sold as You~1; the + smaller size (173\Unit{mm}$\times$118\Unit{mm}) is the + paper-industry standard size.}% + \footnotetext[3]{Twice in the same direction.}% +\end{minipage} +%\end{table} + + +\subsubsection{Window variants} +There are a large number of window subtypes existing within the +framework explained in the previous subsection. The most common window +sizes and locations are listed in \autoref{tab:japanlco.jwinsizes1}. + +%% my table of windows +\begin{table} +\begin{minipage}{\textwidth}\renewcommand*{\footnoterule}{} +\centering +\caption[{Supported Japanese envelope types and the window sizes and + locations}] {Supported Japanese envelope types and the window sizes and + locations.} +\begin{tabular}{lllll} +\toprule +Envelope type & Window name\footnotemark[1] & - size\footnotemark[2] & - location\footnotemark[3] & \File{lco} file\footnotemark[4] \\ +\midrule +Chou 3 & A & 90$\times$45 & l 23, t 13 & \Option{NipponEL} \\ +Chou 3 & F & 90$\times$55 & l 23, t 13 & \Option{NipponEH} \\ +Chou 3 & Hisago & 90$\times$45 & l 23, t 12 & \Option{NipponEL} \\ +Chou 3 & Mutoh 1 & 90$\times$45 & l 20, t 11 & \Option{NipponEL} \\ +Chou 3 & Mutoh 101 & 90$\times$55 & l 20, t 11 & \Option{NipponEH} \\ +Chou 3 & Mutoh 2 & 80$\times$45 & l 20, t 11 & \Option{NipponEL} \\ +Chou 3 & Mutoh 3 & 90$\times$45 & l 25, t 11 & \Option{NipponLL} \\ +Chou 3 & Mutoh 301 & 90$\times$55 & l 25, t 11 & \Option{NipponLH} \\ +Chou 3 & Mutoh 6 & 100$\times$45 & l 20, t 11 & \Option{NipponEL} \\ +Chou 3 & v.2\footnotemark[5] & 90$\times$45 & l 24, t 12 & \Option{NipponLL} \\ +Chou 40 & A & 90$\times$45 & l 23, t 13 & \Option{NipponEL} \\ +Chou 4 & A & 90$\times$45 & l 23, t 13 & \Option{NipponEL} \\ +Chou 4 & B & 80$\times$45 & l 98, t 28 & \Option{NipponRL} \\ +Chou 4 & C & 80$\times$45 & l 21, t 13 & \Option{NipponEL} \\ +Chou 4 & K & 80$\times$45 & l 22, t 13 & \Option{NipponEL} \\ +Chou 4 & Mutoh 1 & 80$\times$45 & l 40, b 11 & --- \\ +Chou 4 & Mutoh 2 & 80$\times$45 & l 20, t 11 & \Option{NipponEL} \\ +Chou 4 & Mutoh 3 & 90$\times$45 & l 20, t 11 & \Option{NipponEL} \\ +Chou 4 & Mutoh 6 & 100$\times$45 & l 20, t 11 & \Option{NipponEL} \\ +Chou 4 & v.2\footnotemark[5] & 80$\times$45 & l 20, t 12 & \Option{NipponEL} \\ +Chou 4 & v.3\footnotemark[5] & 90$\times$45 & l 20, t 12 & \Option{NipponEL} \\ +Kaku A4 & v.1\footnotemark[6] & 95$\times$45 & l 20, t 24 & \Option{KakuLL} \\ +You 0 & Cruise 6 & 90$\times$45 & l 20, t 12 & \Option{NipponEL} \\ +You 0 & Cruise 601 & 90$\times$55 & l 20, t 12 & \Option{NipponEH} \\ +You 0 & Cruise 7 & 90$\times$45 & l 20, b 12 & \Option{NipponEL} \\ +You 0 & Cruise 8 & 90$\times$45 & l 24, t 12 & \Option{NipponLL} \\ +You 0 & v.2\footnotemark[5] & 90$\times$45 & l 24, t 12 & \Option{NipponEL} \\ +You 0 & v.3\footnotemark[5] & 90$\times$45 & l 23, t 13 & \Option{NipponEL} \\ +You 4 & A & 90$\times$45 & l 23, t 13 & \Option{NipponEL} \\ +\bottomrule +\end{tabular}% +\footnotetext[1]{Names (acting as subtype information) are taken from + the manufacturer catalog.}% +\footnotetext[2]{Given as width by height in millimeters.}% +\footnotetext[3]{Given as offset from left (l) or right (r), followed by + offset from bottom (b) or top (t).}% +\footnotetext[4]{The \File{lco} file, which provides support (see + \autoref{tab:japanlco.lcolist}).}% +\footnotetext[5]{In the absence of any other information, a numerical + variation number for the subtype name is provided.}% +\footnotetext[6]{Dimensions apply when envelope is held in portrait mode.}% +\label{tab:japanlco.jwinsizes1}% +\end{minipage} +\end{table} + +\section{Provided \File{lco} files} +In \Class{scrlttr2} support is provided for Japanese envelope and +window sizes through a number of \File{lco} files which customize the +foldmarks required for different envelope sizes and subvariants with +different window positions and sizes. + +The provided \File{lco} files together with the envelope types for +which they provide support are listed at +\autoref{tab:japanlco.lcolist}. See \autoref{tab:japanlco.jenvsizes1} +for the full list of Japanese envelopes and the paper they take, and +\autoref{tab:japanlco.jwinsizes1} for the common window sizes and +locations. The rightmost column indicates which \File{lco} file +provides the support. + +The tolerances for location is about 2\Unit{mm}, so it is possible to +accommodate all the envelope and window variants of +\autoref{tab:japanlco.jwinsizes1} with just a small number of \File{lco} +files. The difference between Chou/You~3 and Chou/You~4 is determined +by paper size. + +\begin{table} +\begin{minipage}{\textwidth}\renewcommand*{\footnoterule}{} +\centering +\caption{\File{lco} files provided by \Class{scrlttr2} for Japanese window + envelopes} +\begin{tabular}{llll} +\toprule +\File{lco} file & Supported & Window size\footnotemark[1] & Window +location\footnotemark[1] \\ +\midrule +\Option{NipponEL} & Chou/You 3 and 4 & 90$\times$45 & l 22, t 12 \\ +\Option{NipponEH} & Chou/You 3 and 4 & 90$\times$55 & l 22, t 12 \\ +\Option{NipponLL} & Chou/You 3 and 4 & 90$\times$45 & l 25, t 12 \\ +\Option{NipponLH} & Chou/You 3 and 4 & 90$\times$55 & l 25, t 12 \\ +\Option{NipponRL} & Chou/You 3 and 4 & 90$\times$45 & l 98, t 28 \\ +\Option{KakuLL} & Kaku A4 & 90$\times$45 & l 25, t 24 \\ +\bottomrule +\end{tabular}% +\label{tab:japanlco.lcolist}% +\footnotetext[1]{Window size is given in width by height, location as + offset from left (l) or right (r), followed by offset from bottom (b) or top + (t). All Values in millimeters.}% +\end{minipage} +\end{table} + +\section{Examples of Japanese letter usage} +Assume you want to write a letter on A4 size paper and will post it in +a Japanese envelope. If the envelope has no window, then it is enough +to determine whether the envelope dimensions match a European +one\,---\,the standard \File{DIN.lco} style may suffice for many such +cases. + +If you wish to use a windowed envelope, please note that owing to the +large variety, not all existing subvariants are currently +supported. If you should note that you particular windowed envelope +has its window dimensions and positions significantly (more than +approximately 2\Unit{mm}) different from any of the supported subvariants, +please contact the author of {\KOMAScript} to obtain support as soon as +possible, and in the meanwhile create a customized \File{lco} file for your +own use, using one of the existing ones as a template and reading the +{\KOMAScript} documentation attentively. + +If your window envelope subvariant is supported, this is how you would +go about using it: simply select the required \File{lco} file and +activate the horizontal and vertical foldmarks as required. Another, +independent, mark is the punching mark which divides a sheet in two +horizontally for easy punching and filing. + +\subsection{Example 1:} +Your favourite envelope happens to be a You~3 with window subvariant +Mutoh~3, left over from when the company had its previous name, and +you do not wish them to go to waste. Thus, you write your letter with +the following starting code placed before the letter environment: + +\begin{lstlisting} +\LoadLetterOption{NipponLL}\setkomavar{myref}{NipponLL} +\begin{letter}{Martina Muster\\Address} +... +\end{letter} +\end{lstlisting} + +\subsection{Example 2:} +You originally designed your letter for a You~3 envelope, but suddenly +you get handed a used electrical company envelope with cute manga +characters on it which you simply cannot pass up. Surprisingly, you +find it conforms fairly closely to the Chou~4 size and C window +subvariant, such that you realize you can alter the following in your +document preamble: + +\begin{lstlisting} +\LoadLetterOption{NipponEL}\setkomavar{myref}{NipponEL} +\begin{letter}{Martina Muster\\Address} +... +\end{letter} +\end{lstlisting} + +Now, \Class{scrlttr2} automatically reformats the letter for you to +fit the required envelope. + +% \LoadLetterOption{NipponEL}\setkomavar{myref}{NipponEL} +% \begin{letter}{Martina Muster\\at and\\there\\and one\\more} +% \opening{Dear Martina,} +% \lipsum[1-2] +% \closing{Regards} +% \ps{PS: Forgotten to say.} +% \encl{Something} +% \cc{Somebody\\Someone} +% \end{letter} + +% \LoadLetterOption{NipponEH}\setkomavar{myref}{NipponEH} +% \begin{letter}{Martina Muster\\at and\\there\\and one\\more} +% \opening{Dear Martina,} +% \lipsum[1-2] +% \closing{Regards} +% \end{letter} + +% \LoadLetterOption{NipponLL}\setkomavar{myref}{NipponLL} +% \begin{letter}{Martina Muster\\at and\\there\\and one\\more} +% \opening{Dear Martina,} +% \lipsum[1-2] +% \closing{Regards} +% \end{letter} + +% \LoadLetterOption{NipponLH}\setkomavar{myref}{NipponLH} +% \begin{letter}{Martina Muster\\at and\\there\\and one\\more} +% \opening{Dear Martina,} +% \lipsum[1-2] +% \closing{Regards} +% \end{letter} + +%% comparison of US common paper sizes, wider and shorter +% Millimetres Inches Points +% Height Width Height Width Height Width +% Letter 279.4 215.9 11.00 8.50 792 612 +% Legal 355.6 215.9 14.00 8.50 1008 612 +% Ledger 431.8 279.4 17.00 11.00 1224 792 +% Tabloid 279.4 431.8 11.00 17.00 792 1224 +% Executive 266.7 184.1 10.55 7.25 756 522 + +%% English foolscap is here for reference +% Millimetres Inches Points +% Height Width Height Width Height Width +%Foolscap 419 336 16.50 13.25 1188 954 +% + +%% nice reference on envelope types and windows in the US +%http://www.belightsoft.com/products/companion/paper/envelopes.php + +%%% Local Variables: +%%% mode: latex +%%% coding: iso-latin-1 +%%% TeX-master: t +%%% 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 38ce28879ab..14653ea8f5c 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 @@ -45,7 +45,7 @@ % % ============================================================================ -\ProvidesFile{scrbookreportarticle.tex}[2007/10/12 KOMA-Script guide (chapter: +\ProvidesFile{scrbookreportarticle.tex}[2007/12/15 KOMA-Script guide (chapter: scrbook, scrreprt, scrartcl)] \translator{Jens-Uwe Morawski\and Gernot Hassenpflug\and Markus Kohm} @@ -1257,22 +1257,28 @@ specification to the one currently used with the specified \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{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{chapterentry}{% + Table of contents entry of the sectional unit \Macro{chapter}}% + \feentry{chapterentrypagenumber}{% + Page number of the table of contents entry of the sectional unit + \Macro{chapter}, variation on the element + \FontElement{chapterentry}}% \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{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 - \Macro{part} down to \Macro{subparagraph} and \Macro{minisec}, including - the title of the abstract; used before the element of the corresponding - unit}% + \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}% \feentry{footnote}{Footnote text and marker}% - \feentry{footnotelabel}{Mark of a footnote; used according to the element - \FontElement{footnote}}% + \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{pagefoot}{The foot of a page, but also the head of a page}% @@ -1280,18 +1286,39 @@ specification to the one currently used with the specified \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 - containing the part number}% - \feentry{partnumber}{Line containing the part number in a title of the - sectional unit \Macro{part}}% + \feentry{part}{Title of the \Macro{part} sectional unit, without the + line containing the part number}% + \feentry{partentry}{% + Table of contents entry of the secitonal unit \Macro{part}}% + \feentry{partentrypagenumber}{% + Page number of the table of contents entry of the sectional unit + \Macro{part} variation on the element \FontElement{partentry}}% + \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{sectionentry}{% + Table of contents entry of sectional unit \Macro{section} (only + available in \Class{scrartcl})}% + \feentry{sectionentrypagenumber}{% + Page number of the table of contents entry of the sectional unit + \Macro{section}, variation on element \FontElement{sectionentry} + (only available in \Class{scrartcl})}% \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{subject}{% + Categorization of the document, i.\,e., the argument of + \Macro{subject} on the main title page}% + \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{subtitle}{% + Subtitle of the document, i.\,e., the argument of \Macro{subtitle} on + the main title page}% \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})}% + \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}% @@ -1909,6 +1936,7 @@ takes place as part of the titles produced by \Macro{maketitle}. \Macro{titlehead}\Parameter{Titlehead}\\ \Macro{subject}\Parameter{Subject}\\ \Macro{title}\Parameter{Title}\\ + \Macro{subtitle}\Parameter{Subtitle}\\ \Macro{author}\Parameter{Author}\\ \Macro{date}\Parameter{Date}\\ \Macro{publishers}\Parameter{Publisher}\\ @@ -1918,12 +1946,13 @@ takes place as part of the titles produced by \Macro{maketitle}. \BeginIndex{Cmd}{titlehead}% \BeginIndex{Cmd}{subject}% \BeginIndex{Cmd}{title}% +\BeginIndex{Cmd}{subtitle}% \BeginIndex{Cmd}{author}% \BeginIndex{Cmd}{date}% \BeginIndex{Cmd}{publishers}% \BeginIndex{Cmd}{and}% \BeginIndex{Cmd}{thanks}% -The contents of the full title page are defined by six elements. The +The contents of the full title page are defined by seven elements. 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 @@ -1947,7 +1976,32 @@ not affected (see \autoref{tab:maincls.elementsWithoutText}, default settings can be changed with the commands of \autoref{sec:maincls.font}. -Below the \PName{Title} appears the +The +\PName{Subtitle}\ChangedAt{v2.97c}{\Class{scrbook}\and\Class{scrreprt}\and\Class{scrartcl}} +is set just below the title, in a font determined by the element +\FontElement{subtitle}\IndexFontElement{subtitle}. The default, seen +in \autoref{tab:maincls.titlefonts} can be changed with the help of +the commands in \autoref{sec:maincls.font}. + + +\begin{table} + \centering + \caption{Font defaults for the elements of the title} + \begin{tabular}{ll} + \toprule + Element name & Default \\ + \midrule + \FontElement{subject} & + \Macro{normalfont}\Macro{normalcolor}\Macro{bfseries}\Macro{Large} \\ + \FontElement{title} & \Macro{usekomafont}\PParameter{disposition} \\ + \FontElement{subtitle} & + \Macro{usekomafont}\PParameter{title}\Macro{large} \\ + \bottomrule + \end{tabular} + \label{tab:maincls.titlefonts} +\end{table} + +Below the \PName{Subtitle} appears the \PName{Author}\Index[indexmain]{author}. Several authors can be specified in the argument of \Macro{author}. They should be separated by \Macro{and}. @@ -1983,8 +2037,9 @@ the items are centered horizontally. The information is summarised in Element & Command & Font & Justification \\ \midrule Title head & \Macro{titlehead} & \Macro{normalsize} & Regular paragraph \\ - Subject & \Macro{subject} & \Macro{Large} & centered \\ - Title & \Macro{title} & \Macro{huge} & centered \\ + Subject & \Macro{subject} & \Macro{usekomafont}\PParameter{subject} & centered \\ + Title & \Macro{title} & \Macro{huge}\Macro{usekomafont}\PParameter{title} & centered \\ + Subtitle & \Macro{subtitle} & \Macro{usekomafont}\PParameter{subtitle} & centered \\ Authors & \Macro{author} & \Macro{Large} & centered \\ Date & \Macro{date} & \Macro{Large} & centered \\ Publishers & \Macro{publishers} & \Macro{Large} & centered \\ @@ -2011,6 +2066,7 @@ the items are centered horizontally. The information is summarised in 34567 Etherworld} \subject{Dissertation} \title{Digital space simulation with the DSP\,56004} + \subtitle{short but sweet?} \author{Fuzzy George} \date{30. February 2002} \publishers{Adviser Prof. John Eccentric Doe} @@ -2042,6 +2098,7 @@ another printer. \EndIndex{Cmd}{titlehead}% \EndIndex{Cmd}{subject}% \EndIndex{Cmd}{title}% +\EndIndex{Cmd}{subtitle}% \EndIndex{Cmd}{author}% \EndIndex{Cmd}{date}% \EndIndex{Cmd}{publishers}% @@ -2320,12 +2377,12 @@ information as well. \subsection[{Separation}]{Separation\protect\OnlyAt{\Class{scrbook}}} \label{sec:maincls.separation} -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. +Before 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}\\ @@ -2346,6 +2403,30 @@ 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. +In case the user sees things differently and wishes to use numbered +sections\Index{section>number} in the chapters of the front matter, +as of version~2.97e\ChangedAt{v2.97e}{\Class{scrbook}} the section +numbering no longer contains the chapter number. This change only +takes effect when the compatibility option is set to at least +version~2.97e (see option \Option{version}, +\autoref{sec:maincls.compatibilityOptions}, +\autopageref{desc:maincls.option.version}). It is explicity noted that +this creates a confusion with chapter numbers! The use of +\Macro{addsec} and \Macro{section*} (see +\autoref{sec:maincls.structure}, +\autopageref{desc:maincls.macro.section*} and +\autopageref{desc:maincls.macro.addsec}) are thus, in the author's +opinion, far more preferable. + +As of version~2.97e\ChangedAt{v2.97e}{\Class{scrbook}} the numbering +of float environments, such as tables\Index{table>number} and +figures\Index{figure>number}, and equation +numbers\Index{equation>number} in the front matter also contain no +chapter number part. To take effect this too requires the +corresponding compatibility setting (see option \Option{version}, +\autoref{sec:maincls.compatibilityOptions}, +\autopageref{desc:maincls.option.version}). + \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 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 3c876d38fe3..07ae5818839 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 @@ -37,23 +37,19 @@ % % Chapter about scrlttr2 of the KOMA-Script guide % Maintained by Markus Kohm -% Translation: Harald Bongartz, Georg Grandke, Raimund Kohl, -% Jens-Uwe Morawski, Markus Kohm. Stephan Hennig % % ---------------------------------------------------------------------- % % Kapitel über scrlttr2 in der KOMA-Script-Anleitung % Verwaltet von Markus Kohm -% Übersetzung: Harald Bongartz, Georg Grandke, Raimund Kohl, -% Jens-Uwe Morawski, Markus Kohm, Stephan Hennig % % ============================================================================ -\ProvidesFile{scrlttr2.tex}[2007/09/27 KOMA-Script guide (chapter: scrlttr2)] +\ProvidesFile{scrlttr2.tex}[2007/12/17 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 +% Date of translated german file: < 2007-09-17 \chapter{The New Letter Class \Class{scrlttr2}} \labelbase{scrlttr2} @@ -554,15 +550,32 @@ these features could already be found in the now obsolete \Class{scrlettr} class. \begin{Declaration} + \Option{firsthead} +\end{Declaration} +\BeginIndex{Option}{firsthead}% +This\ChangedAt{v2.97e}{\Class{scrlttr2}} option determines whether the +letterhead will be typeset at all. The option undestands the standard +values for simple keys, given +in \autoref{tab:scrlttr2.simpleSwitchValues}, +\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is for the +letterhead to be set. +\EndIndex{Option}{firsthead}% + +\begin{Declaration} \Option{fromalign} \end{Declaration} \BeginIndex{Option}{fromalign}% -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 +This option defines the placement of the return address in the +letterhead of the first page. Apart from the various options for +positioning the return address in the letterhead, there is also the +option\ChangedAt{v2.97e}{\Class{scrlttr2}} of adding the return +address to the sender's +extension\Index{sender's extension}. 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} @@ -582,6 +595,17 @@ options. Possible values for \Option{fromalign} are shown in \entry{\PValue{left}}{% left-justified return address; an optional logo will be right justified; letterhead extensions will be activated}% + \entry{\PValue{locationleft}, \PValue{leftlocation}}{% + return address is set left-justified in the sender's extension; + a logo, if applicable, will be placed above it; the letterhead + is automatically deactivated but can be reactivated using option + \Option{firsthead}.}% + \entry{\PValue{locationright}, \PValue{rightlocation}, + \PValue{location}}{% + return address is set right-justified in the sender's extension; + a logo, if applicable, will be placed above it; the letterhead + is automatically deactivated but can be reactivated using option + \Option{firsthead}.}% \entry{\PValue{right}}{% right-justified return address; an optional logo will be left justified; letterhead extensions will be activated}% @@ -721,14 +745,16 @@ 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 -\autoref{tab:scrlttr2.subjectTerm}, +This option serves two purposes: first, you can choose if your +subject\Index{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 in \autoref{tab:scrlttr2.subject}. Defaults are -\PValue{beforeopening} and \PValue{untitled}. - +subject should be set before or after the opening. Furthermore, the +formatting\ChangedAt{v2.97c}{\Class{scrlttr2}} of the subject can be +modified. Possible values for this option are shown in +\autoref{tab:scrlttr2.subject}. It is expressly noted that when using +the setting \PValue{underlined}, the subject must fit on one line! +Defaults are \PValue{beforeopening} and \PValue{untitled}. \begin{table} \caption[{Possible values of option \Option{subject} with \Class{scrlttr2}}]{Possible values of option \Option{subject} for the @@ -738,7 +764,11 @@ this option are shown in \autoref{tab:scrlttr2.subject}. Defaults are \begin{desctabular} \pventry{afteropening}{set subject after opening}% \pventry{beforeopening}{set subject before opening}% + \pventry{centered}{set subject centered}% + \pventry{left}{set subject left-justified}% + \pventry{right}{set subject right-justified}% \pventry{titled}{add title to subject}% + \pventry{underlined}{set subject underlined (see note in text)}% \pventry{untitled}{do not add title to subject}% \end{desctabular} \end{table} @@ -780,15 +810,70 @@ option are shown in \autoref{tab:scrlttr2.locfield}. Default is \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 folding depends on user settings or the \File{lco} file (see +This option activates or deactivates foldmarks\Index{foldmark} for +vertical two-, three- or four-panel folding, and a single horizontal +folding, of the letter, whereby the folding need not result in +equal-sized parts. The position of the four horizontal and the single +vertical marks are configurable via pseudo-lengths (see +\autoref{sec:scrlttr2.foldmarks} from +\autopageref{sec:scrlttr2.foldmarks} onwards). + +The user has a choice: Either one may use the standard values for +simple switches, as described in +\autoref{tab:scrlttr2.simpleSwitchValues}, +\autopageref{tab:scrlttr2.simpleSwitchValues}, to activate or +deactivate at once all configured foldmarks on the left and upper +edges of the paper; or\ChangedAt{v2.97e}{\Class{scrlttr2}} one may +specify by one or more letters, as listed in +\autoref{tab:scrlttr2.foldmark}, the use of the individual foldmarks +independently. Also in the latter case the foldmarks will only be +shown if they have not been switched off generally with one of +\PValue{false}, \PValue{off} or \PValue{no}. The exact positioning of +the foldmarks is specified in the user settings, that is, the +\File{lco} files (see \autoref{sec:scrlttr2.lcoFile}) chosen for a +letter. Default values are \PValue{true} and \PValue{TBMPL}. + +The exact placement of the fold marks for three-panel letter folding +depends on user settings, that is, the \File{lco} files (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. -% +\begin{table} + \centering + \caption{Combined values for the configuration of foldmarks with the + option \Option{foldmarks}} + \label{tab:scrlttr2.foldmark} + \begin{desctabular} + \pventry{B}{activate upper horizontal foldmark on left paper edge}% + \pventry{b}{deactivate upper horizontal foldmark on left paper edge}% + \pventry{H}{activate all horizontal foldmarks on left paper edge}% + \pventry{h}{deactivate all horizontal foldmarks on left paper edge}% + \pventry{L}{activate left vertical foldmark on upper paper edge}% + \pventry{l}{deactivate left vertical foldmark on upper paper edge}% + \pventry{M}{activate middle horizontal foldmark on left paper edge}% + \pventry{m}{deactivate middle horizontal foldmark on left paper edge}% + \pventry{P}{activate punch or center mark on left paper edge}% + \pventry{p}{deactivate punch or center mark on left paper edge}% + \pventry{T}{activate lower horizontal foldmark on left paper edge}% + \pventry{t}{deactivate lower horizontal foldmark on left paper edge}% + \pventry{V}{activate all vertical foldmarks on upper paper edge}% + \pventry{v}{deactivate all vertical foldmarks on upper paper edge}% + \end{desctabular} +\end{table} +\begin{Example} + Assume that you would like to deactivate all foldmarks exept the punching + mark. This you can accomplish with, for example: + \begin{lstlisting} + \KOMAoption{foldmarks=blmt} + \end{lstlisting} + as long as the defaults have not been changed previously. If some changes + might have been made before, then for added safety you may use: + \begin{lstlisting} + \KOMAoption{foldmarks=true,foldmarks=blmtP} + \end{lstlisting} +\end{Example}% \EndIndex{Option}{foldmarks}% \begin{Declaration} @@ -841,6 +926,41 @@ values for this option are shown in % \EndIndex{}{letter>head}\EndIndex{}{address}% +\subsection{Options for the Letterfoot} +\label{sec:scrlttr2.footoptions} +\BeginIndex{}{letter>footer} + +The letterfoot is the footer of the first page of the letter. There +exist some special rules for its placement, which are given in the +description of the option +\Option{enlargefirstpage}\IndexOption{enlargefirstpage} (see +\autoref{sec:scrlttr2.typeareaOptions}, +\autopageref{desc:scrlttr2.option.enlargefirstpage}) and the +pseudo-length \PLength{firstfootvpos}\IndexPLength{firstfootvpos} +(siehe \autoref{sec:scrlttr2.firstFoot}, +\autopageref{desc:scrlttr2.plength.firstfootvpos}). + +\begin{Declaration} + \Option{firstfoot} +\end{Declaration} +\BeginIndex{Option}{firstfoot}% +This\ChangedAt{v2.97e}{\Class{scrlttr2}} option determines whether the +letterfoot is set or not. If the letterfoot is not set then the +pseudo-length \PLength{firstfootvpos} is also ignored, and instead +\Class{scrlttr2} assumes that the value is equal to +\Length{paperheight}. This has an effect when the option +\Option{enlargefirstpage} (see \autoref{sec:scrlttr2.firstFoot}, +\autopageref{desc:scrlttr2.plength.firstfootvpos}) is used +concurrently. + +The option understands the standard values for simple switches, as +given in \autoref{tab:scrlttr2.simpleSwitchValues}, +\autopageref{tab:scrlttr2.simpleSwitchValues}. Default is the setting +of the letterfoot. +\EndIndex{Option}{firstfoot}% + +\EndIndex{}{letter>footer} + \subsection{Formatting Options} \label{sec:scrlttr2.formatingOptions} @@ -947,17 +1067,9 @@ 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. 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. + If\ChangedAt{v2.97}{\Class{scrlttr2}} an \File{lco} file is loaded + via \Macro{documentclass}, then it may no longer have the same name + as an option. \end{Explain} \begin{Example} @@ -1016,7 +1128,7 @@ 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 +standard SN~101\,130 defines the address field to be placed 8\Unit{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 @@ -1031,49 +1143,74 @@ value. Additionally, also reduce \PLength{toaddrwidth} accordingly. % \EndIndex{Cmd}{LoadLetterOption}% -\begin{table} -\centering -\caption{The predefined \File{lco} files} -\begin{tabular}{lp{.7\textwidth}} - \toprule - \File{lco} file & Description and features \\ - \midrule - \Option{DIN}\IndexOption[indexmain]{DIN}% - & 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, - 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 - 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); - some additional commands to improve compatibility with - obsolete \Class{scrlettr} commands are defined; - \Class{scrlttr2} may behave slightly different when - used with this \File{lco} file than with the other - \File{lco} files.\\ - \Option{SN}\IndexOption[indexmain]{SN}% - & parameter set for Swiss letters with address field on - the right side, according to SN~010\,130; suitable for - Swiss window envelopes in the sizes C4, C5, C6, and - C6/5 (C6 long).\\ - \Option{SNleft}\IndexOption[indexmain]{SNleft}% - & parameter set for Swiss letters with address field on - the left side; - suitable for Swiss window envelopes with window on the - left side in the sizes C4, C5, C6, and C6/5 (C6 long). - \\ - \bottomrule -\end{tabular} -\label{tab:lcoFiles} -\end{table} +\begin{desctable} + \caption{The predefined \File{lco} files\label{tab:lcoFiles}}\\ + \Endfirsthead% + \caption[]{The predefined \File{lco} files (\emph{continuation})}\\ + \Endhead% + \standardfoot% + \oentry{DIN}{% + 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).}% + \oentry{DINmtext}{% + 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).}% + \oentry{KOMAold}{% + 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); some + additional commands to improve compatibility with obsolete + \Class{scrlettr} commands are defined; \Class{scrlttr2} may behave + slightly different when used with this \File{lco} file than with + the other \File{lco} files.}% + \oentry{NipponEL}{% + parameter set for Japanese letters in A4 format; suitable for + Japanese window envelopes of types Chou or You 3 or 4, in which + the windows is approximately 90\Unit{mm} wide, 45\Unit{mm} high, + and positioned 22\Unit{mm} from the left and 12\Unit{mm} from the + top edge (see \autoref{cha:japanlco}).}% + \oentry{NipponEH}{% + parameter set for Japanese letters in A4 format; suitable for + Japanese window envelopes of types Chou or You 3 or 4, in which + the windows is approximately 90\Unit{mm} wide, 55\Unit{mm} high, + and positioned 22\Unit{mm} from the left and 12\Unit{mm} from the + top edge (see \autoref{cha:japanlco}).}% + \oentry{NipponLL}{% + parameter set for Japanese letters in A4 format; suitable for + Japanese window envelopes of types Chou or You 3 or 4, in which + the windows is approximately 90\Unit{mm} wide, 45\Unit{mm} high, + and positioned 25\Unit{mm} from the left and 12\Unit{mm} from the + top edge (see \autoref{cha:japanlco}).}% + \oentry{NipponLH}{% + parameter set for Japanese letters in A4 format; suitable for + Japanese window envelopes of types Chou or You 3 or 4, in which + the windows is approximately 90\Unit{mm} wide, 55\Unit{mm} high, + and positioned 25\Unit{mm} from the left and 12\Unit{mm} from the + top edge (see \autoref{cha:japanlco}).}% + \oentry{NipponRL}{% + parameter set for Japanese letters in A4 format; suitable for + Japanese window envelopes of types Chou or You 3 or 4, in which + the windows is approximately 90\Unit{mm} wide, 45\Unit{mm} high, + and positioned 25\Unit{mm} from the left and 24\Unit{mm} from the + top edge (see \autoref{cha:japanlco}).}% + \oentry{KakuLL}{% + parameter set for Japanese letters in A4 format; suitable for + Japanese window envelopes of type Kaku A4, in which the windows is + approximately 90\Unit{mm} wide, 45\Unit{mm} high, and positioned + 25\Unit{mm} from the left and 24\Unit{mm} from the top edge (see + \autoref{cha:japanlco}).}% + \oentry{SN}{% + parameter set for Swiss letters with address field on the right + side, according to SN~010\,130; suitable for Swiss window + envelopes in the sizes C4, C5, C6, and C6/5 (C6 long).}% + \oentry{SNleft}{% + parameter set for Swiss letters with address field on the left + side; suitable for Swiss window envelopes with window on the left + side in the sizes C4, C5, C6, and C6/5 (C6 long).}% +\end{desctable} \begin{Explain} \begin{Declaration} @@ -1152,27 +1289,36 @@ these properties have already been mentioned or explained in \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 -the same in \Class{scrlttr2}. The elements which can be influenced in -this way are listed in \autoref{tab:scrlttr2.elementsWithoutText}. -% -\begin{table} - \centering% - \caption{Alphabetical list of elements whose font can be - changed in \Class{scrlttr2} using the commands \Macro{setkomafont} and - \Macro{addtokomafont}} - \begin{desctabular} + Commands for defining, extending and querying the font of a specific + element can be found in \autoref{sec:maincls.font}. These commands + work exactly the same in \Class{scrlttr2}. The elements which can be + influenced in this way are listed in + \autoref{tab:scrlttr2.elementsWithoutText}. + % + \begin{desctable} + \caption{Alphabetical list of elements whose font can be changed in + \Class{scrlttr2} using the commands \Macro{setkomafont} and + \Macro{addtokomafont}\label{tab:scrlttr2.elementsWithoutText}}\\ + \Endfirsthead + \caption[]{Elements whose font can be changed + (\emph{continuation})}\\ + \Endhead% + \standardfoot% + \feentry{addressee}{name und address in address field}% \feentry{backaddress}{% return address for a window envelope}% \feentry{descriptionlabel}{% label, i.\,e., the optional argument of \Macro{item}, in a \Environment{description} environment}% + \feentry{foldmark}{foldmark on the letter page; intended for color + settings}% \feentry{fromaddress}{% sender's address in the letterhead}% \feentry{fromname}{% sender's address in the letterhead if different from \FontElement{fromaddress}}% + \feentry{fromrule}{line in return address field in letterhead; + intended for color settings}% \feentry{pagefoot}{% in most cases the footer, sometimes the header of a page}% \feentry{pagehead}{% @@ -1180,15 +1326,19 @@ this way are listed in \autoref{tab:scrlttr2.elementsWithoutText}. \feentry{pagenumber}{% page number in the footer or header, inserted with \Macro{pagemark}}% + \feentry{specialmail}{mode of dispatch in address field}% \feentry{subject}{% subject in the opening of the letter}% \feentry{title}{% title in the opening of the letter}% - \end{desctabular} - \label{tab:scrlttr2.elementsWithoutText} -\end{table} + \feentry{toaddress}{variation of the element + \FontElement{addressee} for setting the adressee address (less + the name) in the adress field}% + \feentry{toname}{variation of the element \FontElement{addressee} + for the name (only) of the addressee in the address field}% + \end{desctable} \end{Explain} -% +% \EndIndex{}{font>style}\EndIndex{}{font>size}% @@ -1660,85 +1810,64 @@ individual sections of this chapter. (\emph{continued})}\\% \Endhead% \standardfoot% - \pentry{foldmarkhpos}{% - horizontal distance of all foldmarks from left paper edge - (\autoref{sec:scrlttr2.other}, - \autopageref{desc:scrlttr2.plength.foldmarkhpos})}% - \pentry{tfoldmarkvpos}{% - vertical distance of upper foldmark from top paper edge - (\autoref{sec:scrlttr2.other}, - \autopageref{desc:scrlttr2.plength.tfoldmarkvpos})}% + \pentry{backaddrheight}{% + height of the return address at the upper edge of the address + field (\autoref{sec:scrlttr2.addressee}, + \autopageref{desc:scrlttr2.plength.backaddrheight})}% \pentry{bfoldmarkvpos}{% vertical distance of lower foldmark from top paper edge (\autoref{sec:scrlttr2.other}, \autopageref{desc:scrlttr2.plength.bfoldmarkvpos})}% + \pentry{firstfootvpos}{% + vertical distance of letterfoot from top paper edge + (\autoref{sec:scrlttr2.firstFoot}, + \autopageref{desc:scrlttr2.plength.firstfootvpos})}% + \pentry{firstfootwidth}{% + width of letterfoot; letterfoot is centered horizontally on letter + paper (\autoref{sec:scrlttr2.firstFoot}, + \autopageref{desc:scrlttr2.plength.firstfootwidth})}% \pentry{firstheadvpos}{% - vertical distance of letter-head from top paper edge + vertical distance of letterhead from top paper edge (\autoref{sec:scrlttr2.firstHead}, \autopageref{desc:scrlttr2.plength.firstheadvpos})}% \pentry{firstheadwidth}{% - width of letter-head; letter-head is centered horizontally - on letter paper (\autoref{sec:scrlttr2.firstHead}, + width of letter head; letterhead is centered horizontally on + letter paper (\autoref{sec:scrlttr2.firstHead}, \autopageref{desc:scrlttr2.plength.firstheadwidth})}% + \pentry{foldmarkhpos}{% + horizontal distance of all foldmarks from left paper edge + (\autoref{sec:scrlttr2.other}, + \autopageref{desc:scrlttr2.plength.foldmarkhpos})}% + \pentry{fromrulethickness}{% + Thickness of an optional horizontal line in the letterhead + (\autoref{sec:scrlttr2.firstHead}, + \autopageref{desc:scrlttr2.plength.fromrulethickness})}% \pentry{fromrulewidth}{% - length of an optional horizontal rule in letter-head + length of an optional horizontal rule in letterhead (\autoref{sec:scrlttr2.firstHead}, \autopageref{desc:scrlttr2.plength.fromrulewidth})}% - \pentry{toaddrvpos}{% - vertical distance of address field from top paper edge - (\autoref{sec:scrlttr2.addressee}, - \autopageref{desc:scrlttr2.plength.toaddrvpos})}% - \pentry{toaddrhpos}{% - horizontal distance of address field from left paper edge - -- for positive values -- or negative horizontal distance of address - field from right paper edge -- for negative values -- - (\autoref{sec:scrlttr2.addressee}, - \autopageref{desc:scrlttr2.plength.toaddrhpos})}% - \pentry{toaddrindent}{% - left and right indentation of address within address field - (\autoref{sec:scrlttr2.addressee}, - \autopageref{desc:scrlttr2.plength.toaddrindent})}% - \pentry{toaddrwidth}{% - width of address field (\autoref{sec:scrlttr2.addressee}, - \autopageref{desc:scrlttr2.plength.toaddrwidth})}% - \pentry{toaddrheight}{% - height of address field (\autoref{sec:scrlttr2.addressee}, - \autopageref{desc:scrlttr2.plength.toaddrheight})}% - \pentry{backaddrheight}{% - height of return address field on top of address field - (\autoref{sec:scrlttr2.addressee}, - \autopageref{desc:scrlttr2.plength.backaddrheight})}% - \pentry{specialmailindent}{% - left indentation of mode of dispatch within address field - (\autoref{sec:scrlttr2.addressee}, - \autopageref{desc:scrlttr2.plength.specialmailindent})}% - \pentry{specialmailrightindent}{% - right indentation of mode of dispatch within address field - (\autoref{sec:scrlttr2.addressee}, - \autopageref{desc:scrlttr2.plength.specialmailrightindent})}% \pentry{locwidth}{% width of supplemental data field; for zero value width is calculated automatically with respect to option \Option{locfield} that is described in \autoref{sec:scrlttr2.headoptions} (\autoref{sec:scrlttr2.locationField}, \autopageref{desc:scrlttr2.plength.locwidth})}% + \pentry{refaftervskip}{% + vertical skip below reference fields line + (\autoref{sec:scrlttr2.refLine}, + \autopageref{desc:scrlttr2.plength.refaftervskip})}% + \pentry{refhpos}{% + 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{refvpos}{% vertical distance of reference fields line from top paper edge (\autoref{sec:scrlttr2.refLine}, \autopageref{desc:scrlttr2.plength.refvpos})}% \pentry{refwidth}{% - width of reference fields line - (\autoref{sec:scrlttr2.refLine}, + width of reference fields line (\autoref{sec:scrlttr2.refLine}, \autopageref{desc:scrlttr2.plength.refwidth})}% - \pentry{refhpos}{% - 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 reference fields line - (\autoref{sec:scrlttr2.refLine}, - \autopageref{desc:scrlttr2.plength.refaftervskip})}% \pentry{sigbeforevskip}{% vertical skip between closing and signature (\autoref{sec:scrlttr2.closing}, @@ -1747,15 +1876,38 @@ individual sections of this chapter. indentation of signature with respect to text body (\autoref{sec:scrlttr2.closing}, \autopageref{desc:scrlttr2.plength.sigindent})}% - \pentry{firstfootvpos}{% - vertical distance of letter foot from top paper edge - (\autoref{sec:scrlttr2.firstFoot}, - \autopageref{desc:scrlttr2.plength.firstfootvpos})}% - \pentry{firstfootwidth}{% - width of letter foot; letter foot is centered horizontally - on letter paper - (\autoref{sec:scrlttr2.firstFoot}, - \autopageref{desc:scrlttr2.plength.firstfootwidth})}% + \pentry{specialmailindent}{% + left indentation of mode of dispatch within address field + (\autoref{sec:scrlttr2.addressee}, + \autopageref{desc:scrlttr2.plength.specialmailindent})}% + \pentry{specialmailrightindent}{% + right indentation of mode of dispatch within address field + (\autoref{sec:scrlttr2.addressee}, + \autopageref{desc:scrlttr2.plength.specialmailrightindent})}% + \pentry{tfoldmarkvpos}{% + vertical distance of upper foldmark from top paper edge + (\autoref{sec:scrlttr2.other}, + \autopageref{desc:scrlttr2.plength.tfoldmarkvpos})}% + \pentry{toaddrheight}{% + height of address field (\autoref{sec:scrlttr2.addressee}, + \autopageref{desc:scrlttr2.plength.toaddrheight})}% + \pentry{toaddrhpos}{% + horizontal distance of address field from left paper edge, for + positive values; or negative horizontal distance of address field + from right paper edge, for negative values + (\autoref{sec:scrlttr2.addressee}, + \autopageref{desc:scrlttr2.plength.toaddrhpos})}% + \pentry{toaddrindent}{% + left and right indentation of address within address field + (\autoref{sec:scrlttr2.addressee}, + \autopageref{desc:scrlttr2.plength.toaddrindent})}% + \pentry{toaddrvpos}{% + vertical distance of address field from top paper edge + (\autoref{sec:scrlttr2.addressee}, + \autopageref{desc:scrlttr2.plength.toaddrvpos})}% + \pentry{toaddrwidth}{% + width of address field (\autoref{sec:scrlttr2.addressee}, + \autopageref{desc:scrlttr2.plength.toaddrwidth})}% \end{desctable} \begin{Declaration} @@ -1959,6 +2111,168 @@ 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{Foldmarks} +\label{sec:scrlttr2.foldmarks} +\BeginIndex{}{foldmark}% + +Foldmarks\Index{foldmark} are short horizontal lines at the left edge, +and short vertical lines at the upper edge of the paper. \KOMAScript{} +at present supports three configurable horizontal and one configurable +vertical foldmarks. In addition, there is support for a punchmark or +center mark which cannot be shifted in the vertical direction. + +\begin{Declaration} + \PLength{tfoldmarkvpos}\\ + \PLength{mfoldmarkvpos}\\ + \PLength{bfoldmarkvpos} +\end{Declaration} +\BeginIndex{PLength}{tfoldmarkvpos}% +\BeginIndex{PLength}{bfoldmarkvpos}% +\BeginIndex{PLength}{mfoldmarkvpos}% +The letter class \Class{scrlttr2} knows a total of three +vertically-placed configurable foldmarks. The position of the upper +foldmark, taken from the upper edge of the paper, is governed by the +pseudo-length \PLength{tfoldmarkvpos}, that of the middle foldmark by +pseudo-length +\PLength{mfoldmarkvpos}\ChangedAt{v2.97e}{\Class{scrlttr2}}, and that +of the lower foldmark by pseudo-length \PLength{bfoldmarkvpos}. With +the addition of the punch\Index{punchmark} or +center\Index{center mark|see{punchmark}}% not sure of this construction +mark, there is still a fourth horizontal mark. This one is however +always placed at the vertical center of the paper. + +The upper and lower foldmarks do not serve to divide the paper into +exactly equal thirds. Instead, with their help, the paper should be +folded such that the address field appears correctly in the space +available in the chosen window envelope format, which is determined by +choice of \File{lco} file. Several such files are available offering +predefined formats. An anomaly is present with \Option{DINmtext}: for +this format, an envelope format of C6/5 (also known as ``C6 long'') is +assumed. Letters written with this option are not suited to envelopes +of formats C5 or C4. + +The middle foldmark is not normally required for Western letters. In +Japan, however, a larger number of envelope formats exists, requiring +one more foldmark (see the Japanese \File{lco} files). At this point +attention is drawn to the fact that reference to ``upper'', +``middle'', and ``lower'' foldmarks is simply a convenience. In fact, +it is not defined that \PLength{tfoldmarkvpos} must be smaller than +\PLength{mfoldmarkvpos}, which in turn must be smaller than +\PLength{bfoldmarkvpos}. If on the other hand one of the +pseudo-lengths is set to null, then the corresponding foldmark will +not be set even if the option \Option{foldmarks} (see +\autoref{sec:scrlttr2.headoptions}, +\autopageref{desc:scrlttr2.option.foldmarks}) is explicity activated. +% +\EndIndex{PLength}{tfoldmarkvpos}% +\EndIndex{PLength}{mfoldmarkvpos}% +\EndIndex{PLength}{bfoldmarkvpos}% + + +\begin{Declaration} + \PLength{tfoldmarklength}\\ + \PLength{mfoldmarklength}\\ + \PLength{bfoldmarklength}\\ + \PLength{pfoldmarklength} +\end{Declaration} +\BeginIndex{PLength}{tfoldmarklength}% +\BeginIndex{PLength}{mfoldmarklength}% +\BeginIndex{PLength}{bfoldmarklength}% +\BeginIndex{PLength}{pfoldmarklength}% +These\ChangedAt{v2.97e}{\Class{scrlttr2}} four pseudo-lengths +determine the lengths of the four horizontal foldmarks. One +exceptional behaviour exists. If the length is given as null, then the +three vertically-configurable pseudo-lengths +\PLength{tfoldmarklength}, \PLength{mfoldmarklength} and +\PLength{bfoldmarklength} are set to 2\Unit{mm} in length. The length of +the punchmark, \PLength{pfoldmarklength}, is instead set to 4\Unit{mm}. +\EndIndex{PLength}{tfoldmarklength}% +\EndIndex{PLength}{mfoldmarklength}% +\EndIndex{PLength}{bfoldmarklength}% +\EndIndex{PLength}{pfoldmarklength}% + + +\begin{Declaration} + \PLength{foldmarkhpos} +\end{Declaration} +\BeginIndex{PLength}{foldmarkhpos}% +This pseudo-length gives the distance of all horizontal foldmarks from +the left edge of the paper. Normally, this is 3.5\Unit{mm}. This value +can be changed in the user's own \File{lco} file, in case the user's +printer has a wider unprintable left margin. Whether the foldmarks are +typeset at all depends on the option \Option{foldmarks} (see +\autoref{sec:scrlttr2.headoptions}, +\autopageref{desc:scrlttr2.option.foldmarks}). +% +\EndIndex{PLength}{foldmarkhpos}% +\EndIndex{}{Faltmarke}% + + +\begin{Declaration} + \PLength{lfoldmarkhpos} +\end{Declaration} +\BeginIndex{PLength}{lfoldmarkhpos}% +Apart from\ChangedAt{v2.97e}{\Class{scrlttr2}} the horizontal +foldmarks there is also a vertical foldmark, whose position from the +left margin is set via the pseudo-length \PLength{lfoldmarkhpos}. This +foldmark is used, for example, in Japanese Chou- or You-format +envelopes, when one wishes to use A4 size sheets with them. This can +also be useful for envelopes in C6 format. +\EndIndex{PLength}{lfoldmarkhpos}% + + +\begin{Declaration} + \PLength{lfoldmarklength} +\end{Declaration} +\BeginIndex{PLength}{lfoldmarklength}% +The\ChangedAt{v2.97e}{\Class{scrlttr2}} length of the vertical +foldmark is set via the pseudo-length \PLength{lfoldmarklength}. Here +too there is an exceptional behaviour. When the length is set to null, +a length of 4\Unit{mm} is actually used. +\EndIndex{PLength}{lfoldmarklength}% + + +\begin{Declaration} + \PLength{foldmarkvpos} +\end{Declaration} +\BeginIndex{PLength}{foldmarkvpos}% +This\ChangedAt{v2.97e}{\Class{scrlttr2}} pseudo-length gives the +distance of all vertical foldmarks from teh upper edge of the +paper. Normally this is 3.5\Unit{mm}, but the value can be changed in the +user's personal \File{lco} file in case the user's printer has a wider +unprintable top margin. Whether the foldmarks are typeset at all +depends on the option \Option{foldmarks} (see +\autoref{sec:scrlttr2.headoptions}, +\autopageref{desc:scrlttr2.option.foldmarks}). At present there is +only one vertical foldmark, which is designated the left vertical +foldmark. +% +\EndIndex{PLength}{foldmarkvpos}% +\EndIndex{}{Faltmarke}% + + +\begin{Declaration} + \PLength{foldmarkthickness} +\end{Declaration} +\BeginIndex{PLength}{foldmarkthickness}% +This\ChangedAt{v2.97c}{\Class{scrlttr2}} pseudo-length determines the +thickness of all foldmarks. Default value is 0.2\Unit{pt}, in other words a +very thin hairline. In particular, if the color of the foldmarks is +changed, this can be too thin! +\EndIndex{PLength}{foldmarkthickness}% + + +\begin{Declaration} + \FontElement{foldmark} +\end{Declaration} +\BeginIndex{FontElement}{foldmark}% +Via\ChangedAt{v2.97c}{\Class{scrlttr2}} this element the color of the +foldmarks can be changed. To do so, the commands to change the font of +the element are usd, as described in \autoref{sec:scrlttr2.font}, +\autopageref{sec:scrlttr2.font}. The default setting is no change. +\EndIndex{FontElement}{foldmark}% + \subsection{The Letterhead} \label{sec:scrlttr2.firstHead} \BeginIndex{}{letter>head}% @@ -2077,8 +2391,10 @@ letter document (see \autoref{sec:scrlttr2.document}). \EndIndex{Variable}{fromlogo}% \begin{Declaration} + \PLength{fromrulethickness}\\ \PLength{fromrulewidth} \end{Declaration} +\BeginIndex{PLength}{fromrulethickness}% \BeginIndex{PLength}{fromrulewidth}% Depending on the class option \Option{fromrule} (see \autoref{sec:scrlttr2.headoptions}, @@ -2091,8 +2407,11 @@ 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}). +\autopageref{desc:scrlttr2.macro.@setplength}). The default +thickness of the line\ChangedAt{v2.97c}{\Class{scrlttr2}}, +\PLength{fromrulethickness}, is 0.4\Unit{pt}. % +\EndIndex{PLength}{fromrulethickness}% \EndIndex{PLength}{fromrulewidth}% \begin{Declaration} @@ -2159,7 +2478,7 @@ use variables with the help of \Macro{usekomavar}. % \EndIndex{}{letter>head}% -\subsection{The Footer} +\subsection{The Letterfoot} \label{sec:scrlttr2.firstFoot} \BeginIndex{}{letter>footer}% @@ -2172,14 +2491,14 @@ the page style settings, but directly with the use of \Macro{opening}. \end{Declaration} \BeginIndex{PLength}{firstfootvpos}% % -This pseudo-length gives the distance between the footer and the upper -edge of the paper. This value is set differently in the various +This pseudo-length gives the distance between the letterfoot 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 +way, the distance between text area and the first letterfoot can be reduced to the value \Length{footskip}. See also \autoref{sec:scrlttr2.typeareaOptions}, \autopageref{desc:scrlttr2.option.enlargefirstpage}. @@ -2194,6 +2513,15 @@ 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}. + +If the letterfoot be switched off using option +\Option{firstfoot}\IndexOption{firstfoot}\ChangedAt{v2.97e}{\Class{scrlttr2}} +(siehe \autoref{sec:scrlttr2.footoptions}, +\autopageref{desc:scrlttr2.option.firstfoot}), then the setting of +\PLength{firstfootvpos} is ignored, and instead +\Length{paperheight}\IndexLength{paperheight} is applied. Thus, there +remains a mimimum bottom margin of length +\Length{footskip}\IndexLength{footskip}. % \EndIndex{PLength}{firstfootvpos}% @@ -2517,6 +2845,7 @@ between macros \Macro{makeatletter} and \Macro{makeatother} (see \subsection{The Sender's Extensions} \label{sec:scrlttr2.locationField} +\BeginIndex{}{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 @@ -2526,21 +2855,39 @@ addressee's field is used. In this manual this field is called the \begin{Declaration} + \PLength{locheight}\\ + \PLength{lochpos}\\ + \PLength{locvpos}\\ \PLength{locwidth} \end{Declaration} \BeginIndex{PLength}{locwidth}% -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}, +\BeginIndex{PLength}{locheight}% +\BeginIndex{PLength}{lochpos}% +\BeginIndex{PLength}{locvpos}% +The pseudo-lengths \PLength{locwidth} and +\PLength{locheight}\ChangedAt{v2.97d}{\Class{scrlttr2}} set the width +and height of the sender's extension field. The pseudo-lengths +\PLength{lochpos} and \PLength{locvpos} determine the distances from +the right and upper paper edges. These value is typically set to +0\Unit{pt} in the predefined \File{lco} files. This does not mean that +the sender's extension has no width; instead, it means that the actual +width is set with \Macro{opening} when the paper width, address window +width, and the distance between the left and upper edges 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. +account. As is the case for \PLength{toaddrhpos}, negative values of +\PLength{lochpos} take on a special meaning. In that case, instead of +referring to a distance from the right edge of the paper, +\PLength{lochpos} now means a distance from the left edge of the +paper. The meaning is thus the opposite to that of +\PLength{toaddrhpos} (see \autoref{sec:scrlttr2.addressee}, +\autopageref{desc:scrlttr2.plength.toaddrhpos}). % \EndIndex{PLength}{locwidth} +\EndIndex{PLength}{locheight}% +\EndIndex{PLength}{lochpos}% +\EndIndex{PLength}{locvpos}% \begin{Declaration} @@ -2552,8 +2899,8 @@ 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}, +sender's extension may already be reserved for a logo or return +address (see \autoref{sec:scrlttr2.headoptions}, \autopageref{desc:scrlttr2.option.fromalign} and \autopageref{desc:scrlttr2.option.fromlogo}). % @@ -2580,6 +2927,7 @@ your own \File{lco} file. \end{Example} % \EndIndex{Variable}{location}% +\EndIndex{}{sender's extension}% \subsection{The Reference Fields Line} @@ -2834,47 +3182,6 @@ 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}\\ - \PLength{bfoldmarkvpos} -\end{Declaration} -\BeginIndex{PLength}{tfoldmarkvpos}% -\BeginIndex{PLength}{bfoldmarkvpos}% -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 are not -compatible with envelopes in either C5 or C4 formats. -% -\EndIndex{PLength}{tfoldmarkvpos}% -\EndIndex{PLength}{bfoldmarkvpos}% - - -\begin{Declaration} - \PLength{foldmarkhpos} -\end{Declaration} -\BeginIndex{PLength}{foldmarkhpos}% -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}% - \begin{Declaration} \Variable{frombank} @@ -3352,7 +3659,7 @@ in \autoref{tab:date}. \Macro{datespanish} & 1.\,12.\,1993\\ \Macro{datedutch} & 1.\,12.\,1993\\ \Macro{datecroatian} & 1.\,12.\,1993.\\ - \Macro{datefinnish } & 1.\,12.\,1993.\\ + \Macro{datefinnish } & 1.12.1993.\\ \bottomrule \end{tabular} \label{tab:date} @@ -3876,5 +4183,5 @@ width of the argument of \Macro{closing}. %%% TeX-master: "../guide" %%% End: -% LocalWords: scrlttr simpleSwitchValues afteropening beforeopening lcoFile +% LocalWords: scrlttr simpleSwitchValues afteropening beforeopening % LocalWords: locfield 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 cee23e6fe5f..2fc696e23e9 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 @@ -45,11 +45,11 @@ % % ============================================================================ -\ProvidesFile{scrpage2.tex}[2007/09/27 KOMA-Script guide (chapter:scrpage2)] +\ProvidesFile{scrpage2.tex}[2007/12/07 KOMA-Script guide (chapter:scrpage2)] \translator{Jens-Uwe Morawski\and Karl-Heinz Zimmer\and Christoph Bier\and Gernot Hassenpflug\and Markus Kohm} -% date of translated german file: 2005/08/10 +% date of translated german file: 2007/12/07 \chapter{Adapting Page Headers and Footers with \Package{scrpage2}} \labelbase{scrpage} @@ -463,7 +463,7 @@ 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{part}\ChangedAt{v2.2}{\Package{scrpage2}}, \PValue{chapter}, \PValue{section}, \PValue{subsection}, \PValue{subsubsection}, \PValue{paragraph}, and \PValue{subparagraph}. For most of the classes use of \PValue{part} will not produce the expected result. So @@ -668,7 +668,7 @@ 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 +The\ChangedAt{v2.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 @@ -1371,5 +1371,5 @@ styles which many projects can share. %%% Local Variables: %%% mode: latex %%% coding: iso-latin-1 -%%% TeX-master: ../guide" +%%% TeX-master: "../guide" %%% End: |