summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/scrguide.cls
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/scrguide.cls')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/scrguide.cls162
1 files changed, 94 insertions, 68 deletions
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 1e397e31138..e4d540c3ffb 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/scrguide.cls
+++ b/Master/texmf-dist/source/latex/koma-script/doc/scrguide.cls
@@ -1,6 +1,6 @@
% ======================================================================
% scrguide.cls
-% Copyright (c) Markus Kohm, 2005-2012
+% Copyright (c) Markus Kohm, 2005-2013
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrguide.cls
-% Copyright (c) Markus Kohm, 2005-2012
+% Copyright (c) Markus Kohm, 2005-2013
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -38,7 +38,7 @@
% \section{Identification}
%
% \begin{macrocode}
-\ProvidesClass{scrguide}[2011/10/18 v1.6 internal KOMA-Script guide class]
+\ProvidesClass{scrguide}[2013/10/13 v1.7c internal KOMA-Script guide class]
% \end{macrocode}
%
%
@@ -92,8 +92,32 @@
%
% \section{Load the Base Class and Packages}
%
+% \begin{macro}{\KOMAProvidesFile}
+% \begin{macro}{\@KOMAProvidesFile}
+% Extended version of |\ProvidesFile|, that uses the date from the
+% repository.
+% \begin{macrocode}
+\newcommand*{\KOMAProvidesFile}{}
+\def\KOMAProvidesFile#1{%
+ \@ifnextchar [%]
+ {\@KOMAProvidesFile{#1}}{\ProvidesFile{#1}\relax}%
+}
+\newcommand*{\@KOMAProvidesFile}{}
+\def\@KOMAProvidesFile#1[$#2: #3-#4-#5 #6$#7]{%
+ \ifstr{#2}{Date}{%
+ \ProvidesFile{#1}[#3/#4/#5 #6 #7]\relax
+ }{%
+ \ClassError{scrguide}{missmatch repository date string}{%
+ It seams, that you haven't used $%
+ Date: YYYY-MM-DD $ for the date of \string\KOMAProvidesFile.}%
+ \ProvidesFile{#1}[$#2: #3/#4/#5 #6$#7]\relax
+ }%
+}
+% \end{macrocode}
+% \end{macro}
+% \end{macro}
% NOTE: I use \texttt{latin1} instead of the prefered \texttt{utf8} because of
-% problems of package \textsf{listings}.
+% problems of early versions of package \textsf{listings}.
% \begin{macrocode}
\LoadClassWithOptions{scrbook}
\RequirePackage[latin1]{inputenc}
@@ -112,6 +136,7 @@
\RequirePackage{makeidx}
\RequirePackage{scrdate}
\RequirePackage{scrtime}
+\RequirePackage{picture}
\RequirePackage{graphicx}
\RequirePackage{booktabs}
\RequirePackage{longtable}
@@ -119,6 +144,7 @@
\RequirePackage{listings}
\RequirePackage{multicol}
\RequirePackage{marginnote}
+\RequirePackage{tabularx}
\RequirePackage{xcolor,tocstyle}% hyperref needs xcolor with tocstyle
\RequirePackage[\uselanguage]{hyperref}
\RequirePackage[open,openlevel=0]{bookmark}% improved pdf bookmarks
@@ -658,6 +684,9 @@
% This may already be defined.
% \begin{macrocode}
\providecommand*{\eTeX}{\ensuremath{\varepsilon}-\TeX}
+\providecommand*{\NTS}{%
+ \leavevmode\hbox{$\cal N\kern-0.35em\lower0.5ex\hbox{$\cal T$}%
+ \kern-0.2emS$}}
% \end{macrocode}
% \end{macro}
%
@@ -1027,6 +1056,8 @@
% to allow page breaks.
% \begin{macrocode}
\newenvironment{desctable}[1][\descdefaultindent]{%
+ \ClassError{scrguide}{deprecated environment}{%
+ please replace desctable by desclist}%
\onelinecaptionsfalse
\start@desctab{#1}%
\newcommand{\Endfirsthead}{\toprule\endfirsthead}%
@@ -1046,6 +1077,8 @@
% \end{environment}
%
% \begin{macro}{\start@desctab}
+% \changes{v1.7c}{2013/10/13}{\cs{leavevmode}\cs{ignorespaces} added to
+% \cs{nentry}}
% This is the \emph{worker} macro of \texttt{desctable} and
% \texttt{desctabular}. It does the complete calculations and definition of
% the entry (something like |\item|) commands.
@@ -1058,7 +1091,7 @@
\addtolength{\labelwidth}{-2\tabcolsep}%
\newcommand{\nentry}[2]{%
\multicolumn{2}{p{\labelwidth}}{\raggedright##1}\tabularnewline*%
- \hspace*{#1} & ##2\tabularnewline%
+ \hspace*{#1} & \leavevmode\ignorespaces ##2\tabularnewline%
}%
\newcommand{\entry}[2]{\nentry{##1}{##2}[.5\baselineskip]}%
\newcommand*{\pentry}[1]{%
@@ -1105,8 +1138,11 @@
\setbox\desccaptionb@xfirst\vbox{%
\tabular{p{\labelwidth}}%
\multicolumn{1}{@{}p{\dimexpr\labelwidth+2\tabcolsep}@{}}{%
- \captionaboveof{table}[##1]{##2}%
- }\tabularnewline[\dimexpr \abovecaptionskip\abovecaptionskipcorrection\relax]
+ \captionaboveof{table}[##1]{##2\unskip\strut}%
+ }\tabularnewline[%
+ \dimexpr \abovecaptionskip-\normalbaselineskip\relax
+% \dimexpr \abovecaptionskip-\abovecaptionskipcorrection\relax
+ ]
\toprule\tabularnewline
\endtabular
\vskip -\baselineskip
@@ -1135,21 +1171,35 @@
\ifx\relax##1\relax\else\vskip##1\relax\fi
}%
\renewcommand{\nentry}[2]{%
+ \typeout{TRACE: Generate entry}%
\setbox\descentryb@x\vbox{%
\ifx\desccaptionb@xnext\desccaptionb@xfirst\copy\desccaptionb@xnext\fi
- \tabular{lp{\descwidth}}%
+ \makebox[\linewidth][l]{\begin{tabular}{lp{\descwidth}}%
\multicolumn{2}{p{\labelwidth}}{\raggedright##1}\tabularnewline
\hspace*{#1} & ##2\tabularnewline
- \endtabular
+ \end{tabular}}%
}%
+ \typeout{TRACE: entry done}%
\begingroup
- \dimen@ \ht\descentryb@x \advance \dimen@ \dp\descentryb@x
- \advance \dimen@ \ht\descfootb@x \advance \dimen@ \dp\descfootb@x
+ \dimen@ \ht\descentryb@x
+ \advance \dimen@ \dp\descentryb@x
+ \ifdim \ht\descfootb@x>\ht\strutbox
+ \advance \dimen@ \ht\descfootb@x
+ \else
+ \advance \dimen@ \ht\strutbox
+ \fi
+ \ifdim \dp\descfootb@x>\dp\strutbox
+ \advance \dimen@ \dp\descfootb@x
+ \else
+ \advance \dimen@ \dp\strutbox
+ \fi
\advance \dimen@ \baselineskip
\dimen@ii \pagegoal \advance \dimen@ii -\pagetotal
- \typeout{TRACE: \the\dimen@>\the\dimen@ii?}%
+ \typeout{TRACE: \the\dimen@>\the\dimen@ii\space (footbox
+ ht=\the\ht\descfootb@x, dp=\the\dp\descfootb@x; strutbox
+ ht=\the\ht\strutbox, dp=\the\dp\strutbox)?}%
\ifdim \dimen@>\dimen@ii
- \typeout{TRACE: Break table}%
+ \typeout{TRACE: Break table \thetable}%
\ifx\desccaptionb@xnext\@empty
\csname @desclistentryhook\endcsname
{\copy\descfootb@x}%
@@ -1186,7 +1236,7 @@
}%
\csname @desclistentryhook\endcsname
{\copy\descfootb@x}%
- \par
+ \par\nobreak
\vskip -\baselineskip \vskip \intextsep
}
% \end{macrocode}
@@ -1207,72 +1257,54 @@
columns=fullflexible,keepspaces,%
aboveskip=.4\baselineskip,%
belowskip=0pt%
-}
-\lstdefinestyle{code}{%
+} \lstdefinestyle{code}{%
style=basics,%
language=[LaTeX]TeX,%
moretexcs={%
- @auxout,
- @currext,
- @empty,
- @float,
- @ifpackagelater,
- @ifundefined,
- @rightmark,
- @secondoftwo,
- @tempswafalse,@tempswatrue,
- @undefined,
- AtBeginDocument,AtEndDocument,
- appendix,
- ClassWarningNoLine,CurrentOption,
- DeclareOption,DeclareRobustCommand,dimexpr,
- end@float,
- ExecuteOptions,
- if@filesw,if@tempswa,if@twoside,
- includegraphics,
- MessageBreak,
+ @auxout, @currext, @empty, @float, @ifpackagelater, @ifundefined,
+ @rightmark, @secondoftwo, @tempswafalse,@tempswatrue, @undefined,
+ AtBeginDocument,AtEndDocument, appendix, ClassWarningNoLine,CurrentOption,
+ DeclareOption,DeclareRobustCommand,dimexpr, end@float, ExecuteOptions,
+ if@filesw,if@tempswa,if@twoside, includegraphics, MessageBreak,
onehalfspacing,
PackageError,PackageInfo,PackageWarning,PassOptionsToPackage,
ProcessOptions,protected@write,ProvidesFile,ProvidesPackage,
- RequirePackage,RequirePackageWithOptions,
- setkey,setlength,
+ RequirePackage,RequirePackageWithOptions,setkey,setlength,
+ SelectInputMappings,
textsuperscript}%
-}
-\lstdefinestyle{output}{%
+} \lstdefinestyle{output}{%
style=basics,breaklines,prebreak=\mbox{$\hookleftarrow$}%
-}
-\lstdefinestyle{KOMA}{%
+} \lstdefinestyle{KOMA}{%
style=code,%
moretexcs={%
- @addtoplength,@setplength,@newplength,
- activateareas,
+ @addtoplength,@setplength,@newplength, activateareas,
addchap,addrentry,Address,addcontentslinetoeachtocfile,addsec,
addtoeachtocfile,
addtokomafont,addtolengthplength,addtoreffields,addtotoclist,
adrchar,adrentry,AfterBibliographyPreamble,AfterCalculatingTypearea,
- AfterFile,AfterPackage,AfterStartingTOC,
+ AfterFile,AfterPackage,AfterStartingTOC,AfterTOCHead,
appendixmore,appendixname,areaset,autodot,automark,AtAddToTocList,
AtBeginLetter,
BeforeClosingMainAux,BeforePackage,bib@beginhook,bib@endhook,
+ blinddocument,blindtext,Blinddocument,Blindtext,
cc,captionabove,captionaboveof,captionbelow,captionbelowof,captionformat,
- captionof,cefoot,cfoot,chapapp,
- chapappifchapterprefix,
+ captionof,cefoot,cfoot,chapapp, chapappifchapterprefix,
chapter,chapterformat,chaptermarkformat,chapterpagestyle,chead,
cleardoubleevenemptypage,clearscrheadfoot,closing,cofoot,Comment,
DeclareNewTOC,
dedication,deffootnote,deffootnotemark,DefineFamily,DefineFamilyKey,
DefineFamilyMember,defpagestyle,deftripstyle,
dictum,dictumauthorformat,dictumrule,dictumwidth,doforeachtocfile,
- encl,extratitle,
- FamilyBoolKey,FamilyExecuteOptions,FamilyNumericalKey,%
+ encl,extratitle, FamilyBoolKey,FamilyExecuteOptions,FamilyNumericalKey,%
FamilyOption,FamilyOptions,FamilyProcessOptions,FamilySetBool,
figureformat,figurename,firstfoot,firsthead,FirstName,footfont,footref,
FreeI,FreeII,FreeIII,FreeIV,
+ GenericMarkFormat,
headfont,headmark,
ifattoclist,ifoot,ihead,ifkomavarempty,ifstr,ifthispageodd,InputAddressFile,
- KOMAoption,KOMAoptions,KOMAScript,
- l@addto@macro,LastName,LetterOptionNeedsPapersize,listoffigures,
- listoftables,listoftoc,LoadLetterOption,lohead,lowertitleback,
+ KOMAoption,KOMAoptions,KOMAScript, l@addto@macro,
+ LastName,lefoot,lehead,LetterOptionNeedsPapersize,lipsum,listoffigures,
+ listoftables,listoftoc,LoadLetterOption,lofoot,lohead,lowertitleback,
MakeMarkcase,maketitle,manualmark,marginline,minisec,
multfootsep,multiplefootnoteseparator,
Name,nameday,newbibstyle,newcaptionname,newkomavar,nexthead,
@@ -1281,11 +1313,11 @@
part,partformat,partname,partpagestyle,pnumfont,
PreventPackageFromLoading,publishers,ps,
raggedsection,raggedpart,raggedsignature,recalctypearea,
- refL,refS,refN,refParagraph,refParagraphN,refPar,refParL,refParS,refParN,
- refSentence,refSentenceL,refSentenceS,refSentenceN,
- rehead,
+ refL,refS,refN,refoot,
+ refParagraph,refParagraphN,refPar,refParL,refParS,refParN,
+ refSentence,refSentenceL,refSentenceS,refSentenceN,rehead,
removereffields,ReplaceInput,ReplacePackage,ResetPreventPackageFromLoading,
- sectionmarkformat,Sentence,sentencename,sentenceshortname,
+ rohead, sectionmarkformat,Sentence,sentencename,sentenceshortname,
setbibpreamble,setcapindent,setcapwidth,
setchapterpreamble,setfootbotline,setfootsepline,setfootwidth,
setheadsepline,setheadtopline,setheadwidth,setindexpreamble,setkomafont,
@@ -1296,19 +1328,13 @@
tableformat,tablename,tableofcontents,textsubscript,thechapter,thefigure,
thefootnotemark,thepar,thepart,thesection,thesentence,thesubsection,
thetable,thistime,
- titlehead,tocbasic@extend@babel,TOCclone,todaysname,typearea,
- unitfactor,
- unsettoc,usekomafont,useplength,usekomavar,uppertitleback
- }%
-}
-\lstset{style=basics}
-\lstnewenvironment{lstoutput}[1][]{%
+ titlehead,tocbasic@extend@babel,TOCclone,todaysname,typearea, unitfactor,
+ unsettoc,usekomafont,useplength,usekomavar,uppertitleback }%
+} \lstset{style=basics} \lstnewenvironment{lstoutput}[1][]{%
\lstset{style=output,basicstyle=\ttfamily\small,#1}%
-}{}
-\lstnewenvironment{lstcode}[1][]{%
+}{} \lstnewenvironment{lstcode}[1][]{%
\lstset{style=KOMA,basicstyle=\ttfamily\small,#1}%
-}{}
-\newcommand*{\lstinputcode}[1][]{%
+}{} \newcommand*{\lstinputcode}[1][]{%
\lstinputlisting[style=KOMA,basicstyle=\ttfamily\small,#1]%
}
% \end{macrocode}
@@ -1332,12 +1358,12 @@ KOMAScript \endcsname
%
% \begin{macro}{\url@}
% Redefine to make \texttt{CTAN://} be an alias for
-% \texttt{ftp://|\GuideCTANserver|/tex-archive/}.
+% \texttt{http://|\GuideCTANserver|/tex-archive/}.
% \begin{macrocode}
\def\url@#1{\expandafter\url@@#1\@nil}
\def\url@@#1://#2\@nil{%
\def\@tempa{#1}\def\@tempb{CTAN}\ifx\@tempa\@tempb
- \hyper@linkurl{\Hurl{#1://#2}}{ftp://\GuideCTANserver/tex-archive/#2}%
+ \hyper@linkurl{\Hurl{#1://#2}}{http://\GuideCTANserver/tex-archive/#2}%
\else
\hyper@linkurl{\Hurl{#1://#2}}{#1://#2}%
\fi