diff options
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.cls | 298 |
1 files changed, 187 insertions, 111 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 5abd1e630aa..1929f7493db 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-2017 +% Copyright (c) Markus Kohm, 2005-2018 % % 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-2017 +% Copyright (c) Markus Kohm, 2005-2018 % % Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, % Version 1.3c, verteilt und/oder veraendert werden. @@ -145,14 +145,8 @@ \RequirePackage{multicol} \RequirePackage{marginnote} \RequirePackage{tabularx} -\RequirePackage[svgnames]{xcolor} -\RequirePackage{tocstyle}% hyperref needs xcolor with tocstyle -\RequirePackage{tikz} -\usetikzlibrary{calc} -\RequirePackage[\uselanguage]{hyperref} -\RequirePackage[open,openlevel=0]{bookmark}% improved pdf bookmarks -\RequirePackage{scrhack} -\RequirePackage{mparhack} +\RequirePackage{scrhack}% +\RequirePackage{mparhack}% % \end{macrocode} % % \section{Dependence from \KOMAScript{} Version} @@ -169,84 +163,88 @@ % % \begin{macrocode} \newif\ifshortversion\shortversionfalse -\AtEndOfClass{% - \InputIfFileExists{scrnonfree.tex}{}{% - \typeout{^^J - ----------------------------------------------------------------------^^J - FREE VERSION OF THE KOMA-SCRIPT GUIDE.^^J - NOTE THAT THIS VERSION MAY BE FULL OF UGLY PARAGRAPH AND PAGE BREAKS.^^J - THIS IS BECAUSE THIS VERSION OF THE KOMA-SCRIPT GUIDE IS UNDER^^J - CONSTRUCTION FOREVER.^^J - ----------------------------------------------------------------------^^J - ^^J% - }% - \newcommand*{\iffree}{\@firstoftwo}% - \newcommand*{\important}[2][]{}% - \newcommand*{\textnote}[2][]{}% - \shortversiontrue - \newcommand*{\LoadNonFree}[2]{\par\GuideLoadNonFree\par}% - \AtBeginDocument{\InputIfFileExists{linkalias.tex}{}{}}% - \usepackage{lmodern}% - \@twosidefalse\@openrightfalse\@mparswitchfalse - \RequirePackage{geometry}% - \geometry{papersize={180mm,210mm},% - includehead,includemp,reversemp,marginparwidth=4em,% - vmargin={1.5mm,3mm},hmargin=1.75mm}% - \RequirePackage{scrlayer-scrpage}% - \clearpairofpagestyles - \ihead{% - \smash{% - \hspace*{.5em}\rule[-\dp\strutbox]{0pt}{\headheight}\headmark - }% - }% - \ohead*{\smash{\pagemark\hspace{2mm}}}% - \colorlet{headbackground}{DarkBlue}% - \colorlet{headline}{white}% - \setkomafont{pageheadfoot}{\small\sffamily\bfseries\color{headline}}% - \setkomafont{pagenumber}{}% - \DeclareNewLayer[head,background, - hoffset=0pt, - width=\paperwidth, - addheight=\dimexpr \topmargin+1in+\dp\strutbox\relax, - addvoffset=2\dp\strutbox, - contents={% - \color{headbackground}\rule{\layerwidth}{\layerheight}}] - {headbackground}% - \AddLayersAtBeginOfPageStyle{scrheadings}{headbackground}% - \renewcommand*{\chaptermark}[1]{% - \@mkdouble{\ifnumbered{chapter}{\chaptermarkformat}{}##1}% +\InputIfFileExists{scrnonfree.tex}{}{% + \RequirePackage[svgnames]{xcolor}% + \RequirePackage{tocstyle}% hyperref needs xcolor with tocstyle + \RequirePackage{tikz}% + \usetikzlibrary{calc}% + \RequirePackage[\uselanguage]{hyperref}% + \RequirePackage[open,openlevel=0]{bookmark}% improved pdf bookmarks + \typeout{^^J + ----------------------------------------------------------------------^^J + FREE VERSION OF THE KOMA-SCRIPT GUIDE.^^J + NOTE THAT THIS VERSION MAY BE FULL OF UGLY PARAGRAPH AND PAGE BREAKS.^^J + THIS IS BECAUSE THIS VERSION OF THE KOMA-SCRIPT GUIDE IS UNDER^^J + CONSTRUCTION FOREVER.^^J + ----------------------------------------------------------------------^^J + ^^J% + }% + \newcommand*{\iffree}{\@firstoftwo}% + \newcommand*{\important}[2][]{}% + \newcommand*{\textnote}[2][]{}% + \shortversiontrue + \newcommand*{\LoadNonFree}[2]{\par\GuideLoadNonFree\par}% + \AtBeginDocument{\InputIfFileExists{linkalias.tex}{}{}}% + \usepackage{lmodern}% + \@twosidefalse\@openrightfalse\@mparswitchfalse + \RequirePackage{geometry}% + \geometry{papersize={180mm,210mm},% + includehead,includemp,reversemp,marginparwidth=4em,% + vmargin={1.5mm,3mm},hmargin=1.75mm}% + \RequirePackage{scrlayer-scrpage}% + \clearpairofpagestyles + \ihead{% + \smash{% + \hspace*{.5em}\rule[-\dp\strutbox]{0pt}{\headheight}\headmark }% - \renewcommand*{\chaptermarkformat}{% - \makebox[\dimexpr \oddsidemargin+1in-.5em][r]{% - \chapapp~\thechapter:~% - }% + }% + \ohead*{\smash{\pagemark\hspace{2mm}}}% + \colorlet{headbackground}{DarkBlue}% + \colorlet{headline}{white}% + \setkomafont{pageheadfoot}{\small\sffamily\bfseries\color{headline}}% + \setkomafont{pagenumber}{}% + \DeclareNewLayer[head,background, + hoffset=0pt, + width=\paperwidth, + addheight=\dimexpr \topmargin+1in+\dp\strutbox\relax, + addvoffset=2\dp\strutbox, + contents={% + \color{headbackground}\rule{\layerwidth}{\layerheight}}] + {headbackground}% + \AddLayersAtBeginOfPageStyle{scrheadings}{headbackground}% + \renewcommand*{\chaptermark}[1]{% + \@mkdouble{\ifnumbered{chapter}{\chaptermarkformat}{}##1}% + }% + \renewcommand*{\chaptermarkformat}{% + \makebox[\dimexpr \oddsidemargin+1in-.5em][r]{% + \chapapp~\thechapter:~% }% - \renewcommand*{\chapterformat}{}% - \renewcommand*{\chapterpagestyle}{scrheadings}% - \setlength{\@tempdimc}{\oddsidemargin}% - \addtolength{\@tempdimc}{1in}% - \setheadwidth[-\@tempdimc]{paper}% - % Entweder: - \hypersetup{colorlinks}% - % oder: + }% + \renewcommand*{\chapterformat}{}% + \renewcommand*{\chapterpagestyle}{scrheadings}% + \setlength{\@tempdimc}{\oddsidemargin}% + \addtolength{\@tempdimc}{1in}% + \setheadwidth[-\@tempdimc]{paper}% + % Entweder: + \hypersetup{colorlinks,citecolor=Green,linkcolor=Crimson,urlcolor=Blue}% + % oder: % \hypersetup{pdfborderstyle={/S/U/W 1}}% - \let\orig@maketitle\maketitle - \def\maketitle{% - \begingroup - \@twosidetrue - \let\cleardoublepage\clearpage - \addtolength{\oddsidemargin}{\evensidemargin}% - \setlength{\evensidemargin}{.5\oddsidemargin}% - \setlength{\oddsidemargin}{\evensidemargin}% - \orig@maketitle\relax - \endgroup - }% - \renewcommand*{\chapterheadstartvskip}{}% - \raggedbottom - \sloppy - \lstset{breaklines,prebreak=\mbox{$\hookleftarrow$}}% + \let\orig@maketitle\maketitle + \def\maketitle{% + \begingroup + \@twosidetrue + \let\cleardoublepage\clearpage + \addtolength{\oddsidemargin}{\evensidemargin}% + \setlength{\evensidemargin}{.5\oddsidemargin}% + \setlength{\oddsidemargin}{\evensidemargin}% + \orig@maketitle\relax + \endgroup }% -} + \renewcommand*{\chapterheadstartvskip}{}% + \raggedbottom + \sloppy + \lstset{breaklines,prebreak=\mbox{$\hookleftarrow$}}% +}% % \end{macrocode} % % Now loading the last package (better do it late than never): @@ -576,6 +574,14 @@ % The \KOMAScript{} guide uses a lot of emphasizations. Most of them are % declared robustly to avoid problems at index, change log etc. % +% We need some colors for emphasizing in images: +% \begin{macrocode} +\colorlet{ImageRed}{Crimson}% +\colorlet{ImageBlue}{Blue}% +\colorlet{ImageGreen}{Green}% +\colorlet{ImageYellow}{Yellow}% +% \end{macrocode} +% % \begin{macro}{\textsfrm} % Something like |\emph| using |\textsf| and |\textrm| instead of |\textit| % and |\textup|. @@ -725,7 +731,9 @@ \LabelOption{#1}% \textOption{#1}% } -\DeclareSpecialMarkup{\KOption}{\mbox{\textOption{#1=}}\linebreak[0]}{% +\DeclareSpecialMarkup{\KOption}{% + \mbox{\textOption{#1=}}\linebreak[0]% +}{% \ClassWarning{scrguide}{You should replace \string\KOption{#1}\string\PName{...}\MessageBreak by \string\OptionVName{#1}{...}}% @@ -845,6 +853,35 @@ \label{\label@desc@prefix\label@base.option.#2=#3#1}% \endgroup } +% \end{macrocode} +% \begin{macro}{\OptionVNameRef} +% \cs{OptionVName} by reference. Use it like +% |\OptionVNameRef[suffix]{maincls}{version}{value}|. +% \begin{macrocode} +\newcommand*{\OptionVNameRef}{% + \kernel@ifstar {\@RefOptionVName0}{\@RefOptionVName1}% +} +\newcommand*{\@RefOptionVName}[1]{% + \kernel@ifnextchar [%] + {\@@RefOptionVName#1}{\@@RefOptionVName#1[]}% +} +\newcommand*{\@@RefOptionVName}{} +\def\@@RefOptionVName#1[#2]#3#4#5{% + \scr@ifundefinedorrelax{r@\label@desc@prefix#3.option.#4=#5#2}{% + \ifcase #1 + \expandafter\scr@no@hyperref + \else + \expandafter\hyperref + \fi + [\label@desc@prefix#3.option.#4#2]% + {\OptionVName{\ref*{\label@desc@prefix#3.option.#4#2}}{#5}}% + }{% + \expandafter\ref\ifcase #1 *\fi{\label@desc@prefix#3.option.#4=#5#2}% + }% +} +% \end{macrocode} +% \end{macro} +% \begin{macrocode} \newcommand*{\DescOptionVName}[2]{% \par \leftskip\z@ @@ -872,7 +909,7 @@ } \newcommand*{\LabelPageStyle}[2][\label@suffix]{% \begingroup - \protected@edef\@currentlabel{\FloatStyle{#2}}% + \protected@edef\@currentlabel{\PageStyle{#2}}% \label@sanitize \Hy@MakeCurrentHref{\label@desc@prefix\label@base.pagestyle.#2#1}% \ClassInfo{scrguide}{Anchor: `\@currentHref'}% @@ -1848,16 +1885,22 @@ \lstdefinestyle{code}{% language=[LaTeX]TeX,% moretexcs={% - @auxout, @currext, @dottedtocline, @empty, @float, @ifpackagelater, + @auxout,@currext,@dottedtocline,@empty,@float,@hangfrom,@ifpackagelater, @ifundefined, - @rightmark, @secondoftwo, @tempswafalse,@tempswatrue, @undefined, + @rightmark,@secondoftwo, + @tempskipa,@tempdima,@tempswafalse,@tempswatrue, + @undefined, AtBeginDocument,AtEndDocument, appendix, ClassWarningNoLine,CurrentOption, color,colorbox, - DeclareOption,DeclareRobustCommand,dimexpr, end@float, ExecuteOptions, - if@filesw,if@tempswa,if@twoside, includegraphics, MessageBreak, + DeclareOption,DeclareRobustCommand,dimexpr,end@float,ExecuteOptions, + gluexpr, + if@filesw,if@tempswa,if@twoside,includegraphics, + MessageBreak, + numexpr, onehalfspacing, PackageError,PackageInfo,PackageWarning,PassOptionsToPackage, - ProcessOptions,protected@write,ProvidesFile,ProvidesPackage, + ProcessOptions,protected@edef,protected@write, + ProvidesFile,ProvidesPackage, providecommand, RequirePackage,RequirePackageWithOptions,setkey,setlength, SelectInputMappings,setkeys, @@ -1885,11 +1928,15 @@ blinddocument,blindtext,Blinddocument,Blindtext, cc,captionabove,captionaboveof,captionbelow,captionbelowof,captionformat, captionof,cefoot,cfoot,chapapp, chapappifchapterprefix, + chapterheadstartvskip,chapterheadmidvskip,chapterheadendvskip, chapter,chapterlinesformat,chapterlineswithprefixformat, - chapterformat,chaptermarkformat,chapterpagestyle,chead, + chapterformat,chaptermarkformat,chapternumdepth,chaptertocdepth, + chapterpagestyle,chead, Clause, - cleardoubleevenemptypage,clearscrheadfoot,closing,cofoot,Comment, + cleardoubleevenemptypage,cleardoubleoddpage, + clearscrheadfoot,closing,cofoot,Comment, CloneTOCEntryStyle, + DeclareNewJuraEnvironment, DeclareLayer,DeclareNewLayer,DeclareNewPageStyleByLayers, DeclarePageStyleByLayers, DeclareTOCStyleEntry,DeclareTOCEntryStyle, @@ -1897,8 +1944,11 @@ DeclareNewTOC,DeclareSectionCommand,DeclareNewSectionCommand, RedeclareSectionCommand,ProvideSectionCommand, dedication,defcaptionname,deffootnote,deffootnotemark, - DefineFamily,DefineFamilyKey, - DefineFamilyMember,DestroyLayer,defpagestyle,deftripstyle, + DefineFamily,DefineFamilyKey,DefineFamilyMember, + DefineTOCEntryOption,DefineTOCEntryBooleanOption, + DefineTOCEntryCommandOption,DefintTOCEntryIfOption, + DefineTOCEntryLengthOption,DefineTOCEntryNumberOption, + DestroyLayer,defpagestyle,deftripstyle, dictum,dictumauthorformat,dictumrule,dictumwidth,doforeachtocfile, ellipsispar, encl,extratitle,FamilyBoolKey,FamilyExecuteOptions, @@ -1906,7 +1956,7 @@ FamilyKeyStateUnknownValue,FamilyKeyStateNeedValue, FamilyNumericalKey,% FamilyOption,FamilyOptions,FamilyProcessOptions,FamilySetBool, - FamilyStringKey, + FamilyStringKey,FamilyUnknownKeyValue, figureformat,figurename,firstfoot,firsthead,FirstName,footfont,footref, ForEachLayerOfPageStyle, FreeI,FreeII,FreeIII,FreeIV, @@ -1915,7 +1965,8 @@ ifundefinedorrelax, ifattoclist,ifoot,ihead,ifkomavarempty,ifstr,ifthispageodd,InputAddressFile, KOMAoption,KOMAoptions,KOMAScript, l@addto@macro, - LastName,layerwidth,layerheight,lefoot,lehead,LetterOptionNeedsPapersize, + LastName,layerwidth,layerheight,lefoot,lefttopmark,leftbotmark, + leftfirstmark,lehead,LetterOptionNeedsPapersize, LenToUnit, lipsum,listoffigures, listoftables,listoftoc,LoadLetterOption,lofoot,lohead,lowertitleback, @@ -1924,23 +1975,34 @@ Name,nameday,newbibstyle,newcaptionname,newkomavar,nexthead, ofoot,ohead,opening,othersectionlevelsformat, p@section,pagemark,paragraphformat,subparagraphformat, + paragraphnumdepth,paragraphtocdepth, + subparagraphnumdepth,subparagraphtocdepth, parellipsis,parformat,parname,parshortname, - part,partformat,partname,partpagestyle,pnumfont, + part,partformat,partlineswithprefixformat, + partname,partnumdepth,partpagestyle,partnumdepth, + partheadstartvskip,partheadmidvskip,partheadendvskip, + pnumfont, PreventPackageFromLoading,providecaptionname,publishers,ps, putLL,putLR,putUL,putUR,putC, - raggedsection,raggedpart,raggedsignature,recalctypearea, + raggedcaption,raggedchapter,raggedfootnote,raggedsection,raggedpart, + raggedsignature, + recalctypearea, refL,refS,refN,refoot, refParagraph,refParagraphN,refPar,refParL,refParS,refParN, refSentence,refSentenceL,refSentenceS,refSentenceN,rehead, RelaxFamilyKey, removereffields,renewcaptionname, - RedeclarePageStyleAlias, + RedeclarePageStyleAlias,RedeclareTOCStyleEntry, ReplaceInput,ReplacePackage,ResetPreventPackageFromLoading, + rightbotmark,righttopmark,rightfirstmark, rohead, sectionformat,subsectionformat,subsubsectionformat, + sectionnumdepth,sectiontocdepth, + subsectionnumdepth,subsectiontocdepth, + subsubsectionnumdepth,subsubsectiontocdepth, sectionmarkformat,sectioncatchphraseformat,sectionlinesformat, Sentence,sentencename,sentenceshortname, - setbibpreamble,setcapindent,setcapwidth, + setbibpreamble,setcapindent,setcapwidth,setcaptionalignment, setchapterpreamble,setfootbotline,setfootsepline,setfootwidth, setheadsepline,setheadtopline,setheadwidth,setindexpreamble,setkomafont, setkomavar,setlengthtoplength,setparsizes,setpartpreamble,setuptoc, @@ -2004,16 +2066,18 @@ KOMAScript \endcsname % We have to setup \textsf{hyperref}: % \begin{macrocode} \AtBeginDocument{% - \hypersetup{% - plainpages=false, - pdftitle={\GuideTitle}, - pdfauthor={Markus Kohm, Jens-Uwe Morawski}, - pdfsubject={\GuideSubject}, - pdfkeywords={\KOMAScript, scrbook, scrreprt, scrartcl, - typearea, scrlfile, - scrpage, scrpage2, scrlettr, scrlttr2, scraddr, scrtime, scrdate}, - pdfcreator={\KOMAScript, hyperref} - }% + \iffree{% + \hypersetup{% + plainpages=false, + pdftitle={\GuideTitle}, + pdfauthor={Markus Kohm}, + pdfsubject={\GuideSubject}, + pdfkeywords={\KOMAScript, scrbook, scrreprt, scrartcl, + typearea, scrlfile, scrlayer, scrlayer-scrpage, scrlayer-notecolumn, + scrletter, scrlttr2, scraddr, scrtime, scrdate, scrwfile}, + pdfcreator={\KOMAScript, hyperref} + }% + }{}% } % \end{macrocode} % @@ -2092,6 +2156,18 @@ KOMAScript \endcsname % \end{macrocode} % % +% \section{Logos} +% +% I don't want to use package \textsf{hologo} for only one logo: +% \begin{macrocode} +\DeclareRobustCommand{\XeTeX}{% + X\kern-.125em\lower.5ex\hbox{\reflectbox{E}}\kern-.10em\TeX% +}% +\DeclareRobustCommand{\XeLaTeX}{% + X\kern-.125em\lower.5ex\hbox{\reflectbox{E}}\kern-.10em\LaTeX% +}% +% \end{macrocode} +% % \section{Appendix} % % \begin{macro}{\appendix} |