| 1 |
% \CheckSum{0} |
| 2 |
% \iffalse |
| 3 |
% |
| 4 |
% skb.dtx |
| 5 |
%% Copyright (c) 2011 Sven van der Meer <[email protected]> |
| 6 |
%% |
| 7 |
%% This work may be distributed and/or modified under the conditions of the |
| 8 |
%% LaTeX Project Public License, either version 1.3 of this license or (at |
| 9 |
%% your option) any later version. |
| 10 |
%% The latest version of this license is in |
| 11 |
%% <http://www.latex-project.org/lppl.txt> |
| 12 |
%% and version 1.3 or later is part of all distributions of LaTeX version |
| 13 |
%% 2005/12/01 or later. |
| 14 |
%% |
| 15 |
%% This work has the LPPL maintenance status `author-maintained'. |
| 16 |
%% |
| 17 |
%% The Current Maintainer of this work is |
| 18 |
%% Sven van der Meer <[email protected]> |
| 19 |
%% |
| 20 |
%% This software is provided 'as is', without warranty of any kind, either |
| 21 |
%% expressed or implied, including, but not limited to, the implied |
| 22 |
%% warranties of merchantability and fitness for a particular purpose. |
| 23 |
%% |
| 24 |
%% This work consists of all files listed in MANIFEST.TXT. |
| 25 |
%% |
| 26 |
%<*driver> |
| 27 |
\documentclass{ltxdoc} |
| 28 |
\usepackage{skb} |
| 29 |
\usepackage{dirtree} |
| 30 |
\usepackage{etoolbox} |
| 31 |
\usepackage{textcomp} |
| 32 |
\usepackage{gensymb} |
| 33 |
\usepackage{wasysym} |
| 34 |
\usepackage{units} |
| 35 |
\usepackage{float} |
| 36 |
\usepackage{comment} |
| 37 |
\usepackage{booktabs} |
| 38 |
\usepackage{graphicx} |
| 39 |
\usepackage{longtable} |
| 40 |
\usepackage{colortbl} |
| 41 |
\usepackage{biblatex} |
| 42 |
\usepackage[x11names]{xcolor} |
| 43 |
\usepackage[colorlinks,linkcolor=Brown4,citecolor=SeaGreen4,urlcolor=RoyalBlue3]{hyperref} |
| 44 |
\usepackage[printonlyused]{acronym} |
| 45 |
|
| 46 |
\RecordChanges |
| 47 |
\makeindex |
| 48 |
\GetFileInfo{skb.sty} |
| 49 |
|
| 50 |
\IfFileExists{user-guide/user-guide.tex}{\skbconfig[root=user-guide/]{skb.dtx}} |
| 51 |
{\IfFileExists{../doc/user-guide/user-guide.tex}{\skbconfig[root=../doc/user-guide/]{skb.dtx}} |
| 52 |
{\IfFileExists{../doc/latex/skb/user-guide/user-guide.tex}{\skbconfig[root=../doc/latex/skb/user-guide/]{skb.dtx}}{} |
| 53 |
} |
| 54 |
} |
| 55 |
\skbconfig[pub=,acr=database,bib=database]{skb.dtx} |
| 56 |
\skbbibtex |
| 57 |
|
| 58 |
\begin{document} |
| 59 |
\IfFileExists{skb.dtx}{\DocInput{skb.dtx}} |
| 60 |
{\IfFileExists{../source/skb.dtx}{\DocInput{../source/skb.dtx}} |
| 61 |
{\IfFileExists{../../source/latex/skb/skb.dtx}{\DocInput{../../source/latex/skb/skb.dtx}}{} |
| 62 |
} |
| 63 |
} |
| 64 |
\end{document} |
| 65 |
%</driver> |
| 66 |
% \fi |
| 67 |
% |
| 68 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 69 |
% |
| 70 |
%^^A For Changes please see PDF (heading History) or HISTORY.TXT |
| 71 |
% |
| 72 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 73 |
% |
| 74 |
% |
| 75 |
%\title{The SKB package - Create and maintain% |
| 76 |
% a repository for long-living documents} |
| 77 |
% |
| 78 |
%\author{Sven van der Meer} |
| 79 |
% |
| 80 |
%\date{2011-06-03 v0.52} |
| 81 |
% |
| 82 |
%\maketitle |
| 83 |
% |
| 84 |
%\begin{abstract} |
| 85 |
% This package provides macros that help to build a repository for |
| 86 |
% long living documents. It focuses on structure and re-use of text, code, |
| 87 |
% figures etc. The basic concept is to first separate structure from content |
| 88 |
% (i.e. text about a topic from the structure it is presented by) and then |
| 89 |
% separating the content from the actual published document, thus enabling |
| 90 |
% easy re-use of text blocks in different publications (i.e. text about a |
| 91 |
% protocol in a short article about this protocol as well as in a book about |
| 92 |
% many protocols); all without constantly copying or changing text. As a side |
| 93 |
% effect, using the document classes provided, it hides a lot of \LaTeX~from |
| 94 |
% someone who just wants to write articles and books. |
| 95 |
%\end{abstract} |
| 96 |
% |
| 97 |
%\tableofcontents |
| 98 |
% |
| 99 |
%\skbtitle{The SKB package - Create and maintain% |
| 100 |
% a repository for long-living documents} |
| 101 |
%\skbauthor{Sven van der Meer, [email protected]} |
| 102 |
%\skbsubject{LaTeX SKB} |
| 103 |
%\skbkeywords{SKB;LaTeX;Package} |
| 104 |
% |
| 105 |
% |
| 106 |
%\IfFileExists{user-guide/user-guide.tex}{\skbinput[from=pub]{user-guide-load}} |
| 107 |
% {\IfFileExists{../doc/user-guide/user-guide.tex}{\skbinput[from=pub]{user-guide-load}} |
| 108 |
% {\IfFileExists{../doc/latex/skb/user-guide/user-guide.tex}{\skbinput[from=pub]{user-guide-load}}{ |
| 109 |
% \section*{About this Document} |
| 110 |
% \textbf{Note:} This PDF file was generated without the user guide. |
| 111 |
% } |
| 112 |
% } |
| 113 |
%} |
| 114 |
% |
| 115 |
% |
| 116 |
% \StopEventually{} |
| 117 |
% |
| 118 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 119 |
% |
| 120 |
% \setlength{\parindent}{0cm} |
| 121 |
% |
| 122 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 123 |
% |
| 124 |
% \section{Implementation: Kernel} |
| 125 |
% |
| 126 |
% First we do announce the package. |
| 127 |
% \begin{macrocode} |
| 128 |
%<*skbpackage> |
| 129 |
\NeedsTeXFormat{LaTeX2e} |
| 130 |
\ProvidesPackage{skb}[2011/06/03 Sven's Knowledge Base - SKB for LaTeX v0.52] |
| 131 |
% \end{macrocode} |
| 132 |
% |
| 133 |
% Next we process the package's options. To do that, we define a new if |
| 134 |
% that indicates if we process slides with or without animation, |
| 135 |
% and then we set that new if accordingly. |
| 136 |
% \begin{macrocode} |
| 137 |
\newif\if@skbBeamerAnim |
| 138 |
\@skbBeamerAnimfalse |
| 139 |
\DeclareOption{beameranim}{\@skbBeamerAnimtrue} |
| 140 |
\DeclareOption{beamernoanim}{\@skbBeamerAnimfalse} |
| 141 |
\ProcessOptions\relax |
| 142 |
% \end{macrocode} |
| 143 |
% |
| 144 |
% \subsection{Required Packages} |
| 145 |
% Now we load a few packages that we need within the \skbacft{A3DS:SKB}. We use keyval |
| 146 |
% to allow for options in macros, the listings package for all listings, |
| 147 |
% dirtree to show tree structures similar to a directory tree, ifpdf |
| 148 |
% to establish whether we use \skbacft{ISO:PDF} or not, datetime to get the current date |
| 149 |
% and the versions package to allow for optional text. Note: some packages, |
| 150 |
% such as the package optional, are loaded at a later stage. |
| 151 |
% \begin{macrocode} |
| 152 |
\RequirePackage{keyval} |
| 153 |
\RequirePackage{listings} |
| 154 |
\RequirePackage{dirtree} |
| 155 |
\RequirePackage{ifpdf} |
| 156 |
\RequirePackage{datetime} |
| 157 |
\RequirePackage{versions} |
| 158 |
% \end{macrocode} |
| 159 |
% |
| 160 |
% \subsection{Conditiona/Optional Text Support} |
| 161 |
% Now we set everything that we need to provide optional text. Basically, we |
| 162 |
% want to distinguish between the following modes: text (normal text), slide |
| 163 |
% (for slides), note (for slite annotations), anim (for animated slides, |
| 164 |
% noanim (for non-animated slides) and memoir (if we use the memoir package). |
| 165 |
% |
| 166 |
% We start with the memoir package. First we define a configuration value |
| 167 |
% (used when loading the package optional) and a new if (telling us later |
| 168 |
% if memoir is loaded or not). |
| 169 |
% \begin{macrocode} |
| 170 |
\def\skb@cfg@memoir{} |
| 171 |
\newif\ifSkbMemoirLoaded |
| 172 |
% \end{macrocode} |
| 173 |
% |
| 174 |
% Now we test for the memoir package. Note, if this package is loaded after the |
| 175 |
% \skbacft{A3DS:SKB}, this test and all following actions will fail. If the package is loaded, |
| 176 |
% then we set the if to true, activate (include) the environment skbmodememoir |
| 177 |
% and set our configuration value to the string ", memoir". If the memoir |
| 178 |
% package is not loaded, then we set the if to false, deactivate (exclude) the |
| 179 |
% environment skbmodememoir and load the package booktabs (to provide the commands |
| 180 |
% \cmd{\toprule} and \cmd{\bottomrule}. |
| 181 |
% \begin{macrocode} |
| 182 |
\@ifclassloaded{memoir} |
| 183 |
{\SkbMemoirLoadedtrue |
| 184 |
\includeversion{skbmodememoir} |
| 185 |
\def\skb@cfg@memoir{,memoir}} |
| 186 |
{\SkbMemoirLoadedfalse |
| 187 |
\excludeversion{skbmodememoir} |
| 188 |
\RequirePackage{booktabs}} |
| 189 |
% \end{macrocode} |
| 190 |
% |
| 191 |
% Now we check for the style beamerarticle. We define an if, set its default value |
| 192 |
% to false and test for of the package is loaded (if so, we change the if to true). |
| 193 |
% \begin{macrocode} |
| 194 |
\newif\ifSkbBeamerArticleLoaded |
| 195 |
\SkbBeamerArticleLoadedfalse |
| 196 |
\@ifpackageloaded{beamerarticle}{\SkbBeamerArticleLoadedtrue}{} |
| 197 |
% \end{macrocode} |
| 198 |
% |
| 199 |
% Now we check for the beamer package. e define an if, set its default value |
| 200 |
% to false and test for of the package is loaded (if so, we change the if to true). |
| 201 |
% \begin{macrocode} |
| 202 |
\newif\ifSkbBeamerLoaded |
| 203 |
\SkbBeamerLoadedfalse |
| 204 |
\@ifclassloaded{beamer}{\SkbBeamerLoadedtrue}{} |
| 205 |
% \end{macrocode} |
| 206 |
% |
| 207 |
% Now we process the first optional text support. First, we define a configuration value |
| 208 |
% for beamer animations. If animations are requested (skb package option, see above), |
| 209 |
% we set that value to the string ",anim" and activate (include) the environment skbmodeanim |
| 210 |
% and deactivate (exclude) the environment skbmodenoanim. If no-animation is requested |
| 211 |
% (skb package option, see above) or as default we set the value to the string ",noanim" and |
| 212 |
% deactivate (exclude) the environment skbmodeanim and activate (include) the environment |
| 213 |
% skbmodenoanim. |
| 214 |
% \begin{macrocode} |
| 215 |
\def\skb@cfg@beameranim{} |
| 216 |
\if@skbBeamerAnim |
| 217 |
\def\skb@cfg@beameranim{,anim} |
| 218 |
\excludeversion{skbmodenoanim} |
| 219 |
\includeversion{skbmodeanim} |
| 220 |
\else |
| 221 |
\def\skb@cfg@beameranim{,noanim} |
| 222 |
\excludeversion{skbmodeanim} |
| 223 |
\includeversion{skbmodenoanim} |
| 224 |
\fi |
| 225 |
% \end{macrocode} |
| 226 |
% |
| 227 |
% Now we are ready to provide for all other optional text support. The code configures the environments |
| 228 |
% skbmodetext, skbmodenote and skbmodeslide and loads the optional package depending if we have the |
| 229 |
% beamer package loaded or have the package beamerarticle loaded or have none of the two packages loaded. |
| 230 |
% The environments (package versions) are excluded or included accordingly. The package optional is loaded |
| 231 |
% with the respective option activated (text, note or slide) and using the two configuration values we have |
| 232 |
% defined above (these values are either empty having no effect or contain the option to be included). |
| 233 |
% \begin{macrocode} |
| 234 |
\ifSkbBeamerLoaded |
| 235 |
\excludeversion{skbmodetext} |
| 236 |
\excludeversion{skbmodenote} |
| 237 |
\includeversion{skbmodeslide} |
| 238 |
\RequirePackage[slide\skb@cfg@memoir\skb@cfg@beameranim]{optional} |
| 239 |
\else\ifSkbBeamerArticleLoaded |
| 240 |
\excludeversion{skbmodetext} |
| 241 |
\includeversion{skbmodenote} |
| 242 |
\excludeversion{skbmodeslide} |
| 243 |
\RequirePackage[note\skb@cfg@memoir\skb@cfg@beameranim]{optional} |
| 244 |
\else |
| 245 |
\includeversion{skbmodetext} |
| 246 |
\excludeversion{skbmodenote} |
| 247 |
\excludeversion{skbmodeslide} |
| 248 |
\RequirePackage[text\skb@cfg@memoir\skb@cfg@beameranim]{optional} |
| 249 |
\fi\fi |
| 250 |
% \end{macrocode} |
| 251 |
% |
| 252 |
% |
| 253 |
% \subsection{Provide Command} |
| 254 |
% \DescribeMacro{\BibTeX} |
| 255 |
% \DescribeMacro{\DescribeMacro} |
| 256 |
% \DescribeMacro{\cmdprint} |
| 257 |
% \DescribeMacro{\cmd} |
| 258 |
% The \skbacft{A3DS:SKB} provides for a few commands that the documentation (and maybe your documents as well) |
| 259 |
% expect to be available. The first two are for typesetting SKB and BibTeX, the rest are simply |
| 260 |
% usefull. |
| 261 |
% \begin{macrocode} |
| 262 |
\providecommand{\BibTeX}{{\scshape Bib}\TeX} |
| 263 |
\providecommand{\DescribeMacro}[1]{\relax} |
| 264 |
\providecommand{\cmdprint}[1]{\texttt{\string#1}} |
| 265 |
\providecommand{\cmd}[1]{\cmdprint{#1}}% |
| 266 |
% \end{macrocode} |
| 267 |
% |
| 268 |
% |
| 269 |
% \subsection{Macro Redefinitions} |
| 270 |
% The \skbacft{A3DS:SKB} documentation uses the package dirtree and we want to have some of its default settings |
| 271 |
% changed. For the comments, the default configuration we want is an small, italic serif font in blue; and |
| 272 |
% for the style part we want a type writer font in black. |
| 273 |
% \begin{macrocode} |
| 274 |
\renewcommand*\DTstylecomment{\itshape\sffamily\color{blue}\small} |
| 275 |
\renewcommand*\DTstyle{\ttfamily\textcolor{black}} |
| 276 |
% \end{macrocode} |
| 277 |
% |
| 278 |
% |
| 279 |
% \subsection{At End of Document} |
| 280 |
% |
| 281 |
% Last not least, we define what should happen at the end of the processing of the input |
| 282 |
% document. At them moment, we call \cmd{\skbpdfinfo} to set \skbacft{ISO:PDF} meta information and |
| 283 |
% \cmd{\skboptionsused} to print out the change log and current set of \skbacft{A3DS:SKB} configuration |
| 284 |
% options. |
| 285 |
% \begin{macrocode} |
| 286 |
\AtEndDocument{ |
| 287 |
\skbpdfinfo |
| 288 |
\skboptionsused |
| 289 |
} |
| 290 |
% \end{macrocode} |
| 291 |
% |
| 292 |
% |
| 293 |
% \subsection{Package Configuration} |
| 294 |
% The basic idea of the \skbacft{A3DS:SKB} is that different parts of a document (figures, slides, |
| 295 |
% repository, published documents) reside in different folders. So the main configuration |
| 296 |
% of the \skbacft{A3DS:SKB} is to provide macros to set and get these folders and to load files from them. |
| 297 |
% |
| 298 |
% To simplify coding, we introduce some macros that handle configuration information. |
| 299 |
% These macros will be used by the \skbacft{A3DS:SKB} package to define, set and get configuration |
| 300 |
% information. The macros also store the origin of changes to the configuration information. |
| 301 |
% |
| 302 |
% \DescribeMacro{\skb@tmp} |
| 303 |
% This variable is used to temporarily store macros and strings. The value can change anytime |
| 304 |
% a new \skbacft{A3DS:SKB} macro is called. |
| 305 |
% \begin{macrocode} |
| 306 |
\newcommand{\skb@tmp}{} |
| 307 |
% \end{macrocode} |
| 308 |
% |
| 309 |
% \DescribeMacro{\skb@cfg@origlast} |
| 310 |
% Is used to store the last location (second argument of \cmd{\skbconfig}) were any configuration |
| 311 |
% information has been changed. The currently possible locations are \skbem[code]{skb.sty} |
| 312 |
% for default values, \skbem[code]{skb.cfg} for the general configuration file, |
| 313 |
% \skbem[code]{skblocal.cfg} for the local configuration file and \skbem[code]{skbconfig} |
| 314 |
% when the macro \cmd{\skbconfig} was called. |
| 315 |
% \begin{macrocode} |
| 316 |
\newcommand{\skb@cfg@origlast}{skb.sty} |
| 317 |
% \end{macrocode} |
| 318 |
% |
| 319 |
% \DescribeMacro{\skb@defCfgVars} |
| 320 |
% This macro is used to define new configuration information. It defines two new macros, one for the |
| 321 |
% name of the configuration information and one for storing a change log. The first argument is the |
| 322 |
% name to be used and the second argument the default initialisation. For instance, to add the |
| 323 |
% configuration information for the root path with the default value `/doc' call |
| 324 |
% \begin{lstlisting}[style=generic,language=TeX,gobble=2] |
| 325 |
% \skb@defCfgVars{root}{/doc} |
| 326 |
% \end{lstlisting} |
| 327 |
% \begin{macrocode} |
| 328 |
\newcommand{\skb@defCfgVars}[2]{ |
| 329 |
\@namedef{skb@cfg@var@#1}{#2} |
| 330 |
\@namedef{skb@cfg@orig@#1}{skb.sty} |
| 331 |
} |
| 332 |
% \end{macrocode} |
| 333 |
% |
| 334 |
% \DescribeMacro{\skb@setCfgVars} |
| 335 |
% Alter configuration information and append the location from where its called (second argument of \cmd{\skbconfig} |
| 336 |
% taken from \cmd{skb@cfg@origlast}) to the change log. |
| 337 |
% \begin{macrocode} |
| 338 |
\newcommand{\skb@setCfgVars}[2]{ |
| 339 |
\@namedef{skb@cfg@var@#1}{#2} |
| 340 |
\expandafter\protected@edef\csname skb@cfg@orig@#1\endcsname% |
| 341 |
{\csname skb@cfg@orig@#1\endcsname,\space \skb@cfg@origlast}% |
| 342 |
} |
| 343 |
% \end{macrocode} |
| 344 |
% |
| 345 |
% \DescribeMacro{\skb@getCfgVars} |
| 346 |
% This macro provides access to configuration values. It is used everywhere in the \skbacft{A3DS:SKB} to retrieve |
| 347 |
% configuration values. |
| 348 |
% \begin{macrocode} |
| 349 |
\newcommand{\skb@getCfgVars}[1]{% |
| 350 |
\csname skb@cfg@var@#1\endcsname% |
| 351 |
}% |
| 352 |
% \end{macrocode} |
| 353 |
% |
| 354 |
% Now we use \cmd{\skb@defCfgVars} to initialise all configuration values the \skbacft{A3DS:SKB} uses. |
| 355 |
% |
| 356 |
% \DescribeMacro{\skb@cfg@var@root} |
| 357 |
% The first one is the root directory. Everything that the \skbacft{A3DS:SKB} processes should be located |
| 358 |
% below the root. The \skbacft{A3DS:SKB} can currently not handle inputs from directories outside the root |
| 359 |
% hierarchy (Note: one can call \cmd{\skbconfig} anytime to change the root directory, but be carefull |
| 360 |
% with potential side effects!). The default value for the root directory is \skbem[code]{/doc}. |
| 361 |
% \begin{macrocode} |
| 362 |
\skb@defCfgVars{root}{/doc} |
| 363 |
% \end{macrocode} |
| 364 |
% |
| 365 |
% \DescribeMacro{\skb@cfg@var@acr} |
| 366 |
% \DescribeMacro{\skb@cfg@var@acrfile} |
| 367 |
% These two values define the directory and the file name for the acronym database. |
| 368 |
% The \skbacft{A3DS:SKB} uses the \skbem[code]{acronym} package and the two macros detail the directory |
| 369 |
% (\skbem[code]{acr}) and the file (\skbem[code]{acrfile}) where the acronyms can be found. |
| 370 |
% The default for the directory is \skbem[code]{database/latex} and the default |
| 371 |
% for the file is \skbem[code]{acronym}. |
| 372 |
% \begin{macrocode} |
| 373 |
\skb@defCfgVars{acr}{database/latex} |
| 374 |
\skb@defCfgVars{acrfile}{acronyms} |
| 375 |
% \end{macrocode} |
| 376 |
% |
| 377 |
% \DescribeMacro{\skb@cfg@var@bib} |
| 378 |
% \DescribeMacro{\skb@cfg@var@bibfile} |
| 379 |
% These two values define the directory and the file name for the \BibTeX~database. |
| 380 |
% The two macros detail the directory (\skbem[code]{bib}) and the main file (\skbem[code]{bibfile}) |
| 381 |
% where bibliographic information can be found. |
| 382 |
% The default for the directory is \skbem[code]{database/bibtex} and the default for the |
| 383 |
% file is \skbem[code]{bibliography.tex}. |
| 384 |
% \begin{macrocode} |
| 385 |
\skb@defCfgVars{bib}{database/bibtex} |
| 386 |
\skb@defCfgVars{bibfile}{bibliography.tex} |
| 387 |
% \end{macrocode} |
| 388 |
% |
| 389 |
% \DescribeMacro{\skb@cfg@var@rep} |
| 390 |
% This value points to the \skbem[code]{repository} directory. The default value is \skbem[code]{repository}. |
| 391 |
% \begin{macrocode} |
| 392 |
\skb@defCfgVars{rep}{repository} |
| 393 |
% \end{macrocode} |
| 394 |
% |
| 395 |
% \DescribeMacro{\skb@cfg@var@pub} |
| 396 |
% This value points to the folder with the published documents. The default value is \skbem[code]{publish}. |
| 397 |
% \begin{macrocode} |
| 398 |
\skb@defCfgVars{pub}{publish} |
| 399 |
% \end{macrocode} |
| 400 |
% |
| 401 |
% \DescribeMacro{\skb@cfg@var@fig} |
| 402 |
% This value points to the directory for figures. The default value is \skbem[code]{figures}. |
| 403 |
% \begin{macrocode} |
| 404 |
\skb@defCfgVars{fig}{figures} |
| 405 |
% \end{macrocode} |
| 406 |
% |
| 407 |
% \DescribeMacro{\skb@cfg@var@sli} |
| 408 |
% This value points to the directory for slides. The default value is \skbem[code]{transparencies}. |
| 409 |
% \begin{macrocode} |
| 410 |
\skb@defCfgVars{sli}{transparencies} |
| 411 |
% \end{macrocode} |
| 412 |
% |
| 413 |
% |
| 414 |
% \subsection{Generic Input Macro} |
| 415 |
% \DescribeMacro{\skb@input@doife} |
| 416 |
% \cmd{\skb@input@doife} is the generic input macro. It expects four arguments. |
| 417 |
% The first argument is the \skbacft{A3DS:SKB} macro that should be used to input a file. |
| 418 |
% The second argument is the actual file to be loaded, without file extension. |
| 419 |
% The third argument is the file extension to be used. |
| 420 |
% The fours argument is plain text that should be added to the help message in |
| 421 |
% case an arror occured while loading the file. |
| 422 |
% If the second and third argument are empty, we assume that the first argument |
| 423 |
% already contains directory and file and file extension information. |
| 424 |
% \begin{macrocode} |
| 425 |
\newcommand{\skb@input@doife}[4]{% |
| 426 |
\def\filearg{#2} |
| 427 |
\ifx\filearg\empty% |
| 428 |
\edef\intfile{\csname #1\endcsname}% |
| 429 |
\else% |
| 430 |
\edef\intfile{\csname #1\endcsname{#2}#3}% |
| 431 |
\fi% |
| 432 |
\InputIfFileExists{\intfile}{}% |
| 433 |
{\PackageError{skb}% |
| 434 |
{file not found: \intfile}% |
| 435 |
{I did not find the requested file #4,% |
| 436 |
\MessageBreak please check: \intfile% |
| 437 |
\MessageBreak <return> to continue, no file loaded}% |
| 438 |
}% |
| 439 |
} |
| 440 |
% \end{macrocode} |
| 441 |
% |
| 442 |
% |
| 443 |
% \subsection{Kernel support for skbinput} |
| 444 |
% This is the actual core functionality of the \skbacft{A3DS:SKB} package: flexibly load files from |
| 445 |
% various pre-defined locations (folders). We start with a few macros that we can use |
| 446 |
% later to test options using the package keyval. |
| 447 |
% |
| 448 |
% \DescribeMacro{\skb@input@var@rep} |
| 449 |
% This macro represents the string "rep", which will be later used to test for macro options, for instance in \cmd{\skbinput}. |
| 450 |
% \begin{macrocode} |
| 451 |
\def\skb@input@var@rep{rep} |
| 452 |
% \end{macrocode} |
| 453 |
% |
| 454 |
% \DescribeMacro{\skb@input@var@pub} |
| 455 |
% This macro represents the string "pub", which will be later used to test for macro options, for instance in \cmd{\skbinput}. |
| 456 |
% \begin{macrocode} |
| 457 |
\def\skb@input@var@pub{pub} |
| 458 |
% \end{macrocode} |
| 459 |
% |
| 460 |
% \DescribeMacro{\skb@input@var@fig} |
| 461 |
% This macro represents the string "fig", which will be later used to test for macro options, for instance in \cmd{\skbinput}. |
| 462 |
% \begin{macrocode} |
| 463 |
\def\skb@input@var@fig{fig} |
| 464 |
% \end{macrocode} |
| 465 |
% |
| 466 |
% \DescribeMacro{\skb@input@var@sli} |
| 467 |
% This macro represents the string "sli", which will be later used to test for macro options, for instance in \cmd{\skbinput}. |
| 468 |
% \begin{macrocode} |
| 469 |
\def\skb@input@var@sli{sli} |
| 470 |
% \end{macrocode} |
| 471 |
% |
| 472 |
% The next set of macros will load files from various supported folders. All of them behave identical: |
| 473 |
% they expect argument 1 being the reuqest file and use \cmd{\InputIfFileExists} to check whether this |
| 474 |
% file exists. If so, they simply input the file using \cmd{\input}. If not, they use \cmd{\PackageError} to |
| 475 |
% throw an error with a help message, showing the requested directory and file. |
| 476 |
% The extention .tex is automatically added to the argument, which in turn should only contain the path and the |
| 477 |
% basename of the file. |
| 478 |
% |
| 479 |
% \DescribeMacro{\skb@input@doroot} |
| 480 |
% Load a given .tex file from the root directory. |
| 481 |
% \begin{macrocode} |
| 482 |
\newcommand{\skb@input@doroot}[1]{% |
| 483 |
\def\intarg{#1} |
| 484 |
\skb@input@doife{skbfileroot}{\intarg}{.tex}{in given location} |
| 485 |
} |
| 486 |
% \end{macrocode} |
| 487 |
% |
| 488 |
% \DescribeMacro{\skb@input@dorep} |
| 489 |
% Load a given .tex file from the repository. |
| 490 |
% \begin{macrocode} |
| 491 |
\newcommand{\skb@input@dorep}[1]{% |
| 492 |
\def\intarg{#1} |
| 493 |
\skb@input@doife{skbfilerep}{\intarg}{.tex}{in the repository} |
| 494 |
} |
| 495 |
% \end{macrocode} |
| 496 |
% |
| 497 |
% \DescribeMacro{\skb@input@dopub} |
| 498 |
% Load a given .tex file from the directory with the published documents. |
| 499 |
% \begin{macrocode} |
| 500 |
\newcommand{\skb@input@dopub}[1]{% |
| 501 |
\def\intarg{#1} |
| 502 |
\skb@input@doife{skbfilepub}{\intarg}{.tex}{in the published document folder} |
| 503 |
} |
| 504 |
% \end{macrocode} |
| 505 |
% |
| 506 |
% \DescribeMacro{\skb@input@dofig} |
| 507 |
% Load a given .tex file from the figure directory. |
| 508 |
% \begin{macrocode} |
| 509 |
\newcommand{\skb@input@dofig}[1]{% |
| 510 |
\def\intarg{#1} |
| 511 |
\skb@input@doife{skbfilefig}{\intarg}{.tex}{in the figure folder} |
| 512 |
} |
| 513 |
% \end{macrocode} |
| 514 |
% |
| 515 |
% \DescribeMacro{\skb@input@dosli} |
| 516 |
% Load a given .tex file from the slide directory. |
| 517 |
% \begin{macrocode} |
| 518 |
\newcommand{\skb@input@dosli}[1]{% |
| 519 |
\def\intarg{#1} |
| 520 |
\skb@input@doife{skbfilesli}{\intarg}{.tex}{in the slide folder} |
| 521 |
} |
| 522 |
% \end{macrocode} |
| 523 |
% |
| 524 |
% |
| 525 |
% \DescribeMacro{\skb@input@call} |
| 526 |
% \DescribeMacro{\skb@input@set} |
| 527 |
% These two macros are used to load files. \cmd{\skb@input@call} will point to the currently requested |
| 528 |
% load macro (see above). |
| 529 |
% \cmd{\skb@input@set} sets the default load option in \cmd{\skb@input@call} to \cmd{\skb@input@doroot}. That |
| 530 |
% means if no option is given for an input directory, then the \skbacft{A3DS:SKB} root directory will be used. |
| 531 |
% \begin{macrocode} |
| 532 |
\def\skb@input@call{} |
| 533 |
\newcommand\skb@input@set{% |
| 534 |
\gdef\skb@input@call{\skb@input@doroot} |
| 535 |
} |
| 536 |
% \end{macrocode} |
| 537 |
% |
| 538 |
% |
| 539 |
% \section{Implementation: Configuring the \skbacft{A3DS:SKB}} |
| 540 |
% \subsection{Changing Configuration: skbconfig} |
| 541 |
% \subsubsection{The Macro Options} |
| 542 |
% The macro provides one option per \skbacft{A3DS:SKB} configuration value. Each option expects |
| 543 |
% one paramter; the new value. The options are |
| 544 |
% \skbem[code]{root} (for the root directory), |
| 545 |
% \skbem[code]{acr} (for the acronym directory), |
| 546 |
% \skbem[code]{acrfile} (for the acronym file), |
| 547 |
% \skbem[code]{bib} (for the bibtex directory), |
| 548 |
% \skbem[code]{bibfile} (for the bibtex file), |
| 549 |
% \skbem[code]{rep} (for the repository directory), |
| 550 |
% \skbem[code]{pub} (for the directory with the published documents) and |
| 551 |
% \skbem[code]{sli} (for the directory with slides). |
| 552 |
% \begin{macrocode} |
| 553 |
\define@key{skbconfig}{root}[]{\skb@setCfgVars{root}{#1}} |
| 554 |
\define@key{skbconfig}{acr}[]{\skb@setCfgVars{acr}{#1}} |
| 555 |
\define@key{skbconfig}{acrfile}[]{\skb@setCfgVars{acrfile}{#1}} |
| 556 |
\define@key{skbconfig}{bib}[]{\skb@setCfgVars{bib}{#1}} |
| 557 |
\define@key{skbconfig}{bibfile}[]{\skb@setCfgVars{bibfile}{#1}} |
| 558 |
\define@key{skbconfig}{rep}[]{\skb@setCfgVars{rep}{#1}} |
| 559 |
\define@key{skbconfig}{pub}[]{\skb@setCfgVars{pub}{#1}} |
| 560 |
\define@key{skbconfig}{fig}[]{\skb@setCfgVars{fig}{#1}} |
| 561 |
\define@key{skbconfig}{sli}[]{\skb@setCfgVars{sli}{#1}} |
| 562 |
% \end{macrocode} |
| 563 |
% |
| 564 |
% \subsubsection{The Macro} |
| 565 |
% \DescribeMacro{\skbconfig} |
| 566 |
% This macro allows to change the main directory and path information for the \skbacft{A3DS:SKB}. |
| 567 |
% It reads the provided options and changes the requested values in the \skbacft{A3DS:SKB}. |
| 568 |
% The macro takes one argument which will set the origin of the configuration change. If this |
| 569 |
% argument is empty, the origin will be set to \skbem[code]{skbconfig}. |
| 570 |
% \begin{macrocode} |
| 571 |
\newcommand{\skbconfig}[2][]{ |
| 572 |
\def\intarg{#2} |
| 573 |
% \end{macrocode} |
| 574 |
% If no second argument is given, then set \cmd{\skb@cfg@origlast} to the string |
| 575 |
% "skbconfig" (this macro's name) otherwise use the second argument to set |
| 576 |
% \cmd{\skb@cfg@origlast}. In both cases, print out a general warning about the change of |
| 577 |
% configuration values for later trace or debugging. |
| 578 |
% \begin{macrocode} |
| 579 |
\ifx\intarg\empty |
| 580 |
\renewcommand{\skb@cfg@origlast}{skbconfig} |
| 581 |
\PackageWarning{skb}{load options overwritten by skbconfig} |
| 582 |
\else |
| 583 |
\renewcommand{\skb@cfg@origlast}{#2} |
| 584 |
\PackageWarning{skb}{load options overwritten by #2} |
| 585 |
\fi |
| 586 |
% \end{macrocode} |
| 587 |
% Now use the keyval package to process the options. They will set the respective |
| 588 |
% configuration values, so there is nothing else to do here. |
| 589 |
% \begin{macrocode} |
| 590 |
\setkeys{skbconfig}{#1} |
| 591 |
} |
| 592 |
% \end{macrocode} |
| 593 |
% |
| 594 |
% |
| 595 |
% \subsection{Changing Configuration: skb.cfg and skblocal.cfg} |
| 596 |
% The \skbacft{A3DS:SKB} can also be configured using external configuration files. Two files will be loaded if they exist: |
| 597 |
% \begin{skbnotelist} |
| 598 |
% \item \skbem[code]{skb.cfg} -- Should be used with the installed package in your |
| 599 |
% \TeX/\LaTeX~distribution. If it exists, it will overwrite the default options |
| 600 |
% for directories and paths. |
| 601 |
% \item \skbem[code]{skblocal.cfg} -- Should be used in your local styles/template |
| 602 |
% directory. If it exsits, it will overwrite the default options as well as the |
| 603 |
% options loaded with \skbem[code]{skb.cfg}. |
| 604 |
% \end{skbnotelist} |
| 605 |
% We use \cmd{\InputIfFileExists} to test if the configuration file exist. If true, we load the |
| 606 |
% configuration file and print out a general warning for later trace or debugging. If not, we |
| 607 |
% simply do nothing. |
| 608 |
% \begin{macrocode} |
| 609 |
\InputIfFileExists{skb.cfg}{% |
| 610 |
\PackageWarning{skb}{load options from skb.cfg} |
| 611 |
}{} |
| 612 |
\InputIfFileExists{skblocal.cfg}{% |
| 613 |
\PackageWarning{skb}{load options from skblocal.cfg} |
| 614 |
}{} |
| 615 |
% \end{macrocode} |
| 616 |
% |
| 617 |
% |
| 618 |
% \subsection{Viewing Configuration: skboptionsused} |
| 619 |
% \DescribeMacro{\skboptionsused} |
| 620 |
% This macro can be used to print out a message (as package warning), which contains |
| 621 |
% the change log and the currently used value for all \skbacft{A3DS:SKB} configuration values. |
| 622 |
% \begin{macrocode} |
| 623 |
\newcommand{\skboptionsused}{ |
| 624 |
\PackageWarningNoLine{skb}{% |
| 625 |
Options last changed by: \skb@cfg@origlast \MessageBreak |
| 626 |
Change log: \MessageBreak |
| 627 |
- root = \skb@cfg@orig@root \MessageBreak |
| 628 |
- acr = \skb@cfg@orig@acr \MessageBreak |
| 629 |
- acrfile = \skb@cfg@orig@acrfile \MessageBreak |
| 630 |
- bib = \skb@cfg@orig@bib \MessageBreak |
| 631 |
- bibfile = \skb@cfg@orig@bibfile \MessageBreak |
| 632 |
- rep = \skb@cfg@orig@rep \MessageBreak |
| 633 |
- pub = \skb@cfg@orig@pub \MessageBreak |
| 634 |
- fig = \skb@cfg@orig@fig \MessageBreak |
| 635 |
- sli = \skb@cfg@orig@sli \MessageBreak |
| 636 |
Last set Path/File Options: \MessageBreak |
| 637 |
- file root = \skbfileroot{} \MessageBreak |
| 638 |
- path root = \skbpathroot \MessageBreak |
| 639 |
- file acr = \skbfileacr \MessageBreak |
| 640 |
- file bib = \skbfilebib \MessageBreak |
| 641 |
- path bib = \skbpathbib \MessageBreak |
| 642 |
- path rep = \skbfilerep{} \MessageBreak |
| 643 |
- path pub = \skbfilepub{} \MessageBreak |
| 644 |
- path fig = \skbfilefig{} \MessageBreak |
| 645 |
- path sli = \skbfilesli{} |
| 646 |
} |
| 647 |
} |
| 648 |
% \end{macrocode} |
| 649 |
% |
| 650 |
% |
| 651 |
% \section{Implementation: Files, Figures and Slides} |
| 652 |
% |
| 653 |
% \subsection{Declaring Headings: skbheading} |
| 654 |
% \DescribeMacro{\skbheading} |
| 655 |
% This macro can be used everywhere to declare a new heading and let the \skbacft{A3DS:SKB} decide which |
| 656 |
% document level to use. The actual document level must be declared in the loading file using |
| 657 |
% \cmd{\skbinput} with the option \skbem[code]{level}, otherwise this command will have no effect. |
| 658 |
% \begin{macrocode} |
| 659 |
\newcommand{\skbheading}[1]{ |
| 660 |
\ifx\empty\skb@inputLevel |
| 661 |
#1 |
| 662 |
\else% |
| 663 |
\skb@inputLevel{#1}% |
| 664 |
\fi |
| 665 |
} |
| 666 |
% \end{macrocode} |
| 667 |
% |
| 668 |
% \subsection{Loading \TeX~files: skbinput} |
| 669 |
% \subsubsection{Macro Options} |
| 670 |
% \DescribeMacro{skbinput: opt from} |
| 671 |
% The option \skbem[code]{from} is used to point to one of the following \skbacft{A3DS:SKB} directories: |
| 672 |
% the repository (\skbem[code]{from=rep}), |
| 673 |
% the folder with the published documents (\skbem[code]{from=pub}), |
| 674 |
% the figure folder (\skbem[code]{from=fig}) or |
| 675 |
% the slide folder (\skbem[code]{from=sli}). |
| 676 |
% The option is optional, but when used must give one of the those values. |
| 677 |
% The \skbacft{A3DS:SKB} will throw an error otherwise. The implementation works as follows: if the |
| 678 |
% option is used, its paramter is evaluated. Depending on which \skbacft{A3DS:SKB} directories is |
| 679 |
% requested, the value \cmd{\skb@input@call} is set to point to the respective load |
| 680 |
% load macro. For instance, if the requested directory is the repository (\skbem[code]{from=rep}) |
| 681 |
% then \cmd{\skb@input@call} will be pointed to \cmd{\skb@input@dorep}. |
| 682 |
% \begin{macrocode} |
| 683 |
\define@key{skbinput}{from}[]{% |
| 684 |
\def\intarg{#1} |
| 685 |
\ifx\skb@input@var@rep\intarg |
| 686 |
\gdef\skb@input@call{\skb@input@dorep} |
| 687 |
\else\ifx\skb@input@var@pub\intarg |
| 688 |
\gdef\skb@input@call{\skb@input@dopub} |
| 689 |
\else\ifx\skb@input@var@fig\intarg |
| 690 |
\gdef\skb@input@call{\skb@input@dofig} |
| 691 |
\else\ifx\skb@input@var@sli\intarg |
| 692 |
\gdef\skb@input@call{\skb@input@dosli} |
| 693 |
\else |
| 694 |
\PackageError{skb}% |
| 695 |
{Value for option \@tempa\space not supported: \intarg}% |
| 696 |
{I do not know the value \intarg\space for the option \@tempa.% |
| 697 |
\MessageBreak Please use either "rep", "pub", "fig" or "sli".% |
| 698 |
\MessageBreak <return> to continue, no file will be loaded} |
| 699 |
\fi\fi\fi\fi |
| 700 |
} |
| 701 |
% \end{macrocode} |
| 702 |
% |
| 703 |
% \DescribeMacro{skbinput: opt level} |
| 704 |
% The option \skbem[code]{level} is used to define the document level to |
| 705 |
% be used for the next occurance of \cmd{\skbheading}. Supported are all |
| 706 |
% document levels known to \LaTeX~and no check is done whether the currently |
| 707 |
% used document class supports them or not (for instance, the article class |
| 708 |
% does not support the document level chapter, however, memoir supports it even |
| 709 |
% in article mode). The supported paramters for this option are: |
| 710 |
% \skbem[code]{book} (memoir pacakge), |
| 711 |
% \skbem[code]{part} (memoir pacakge), |
| 712 |
% \skbem[code]{title} (base \LaTeX~classes), |
| 713 |
% \skbem[code]{chapter} (\LaTeX~book class), |
| 714 |
% \skbem[code]{section} (base \LaTeX~classes), |
| 715 |
% \skbem[code]{subsection} (base \LaTeX~classes) and |
| 716 |
% \skbem[code]{subsubsection} (base \LaTeX~classes). |
| 717 |
% |
| 718 |
% The option is optional, but when used must give one of the above described values. |
| 719 |
% The package will throw an error otherwise. |
| 720 |
% |
| 721 |
% We start be defining the macros we use later for testing the option. |
| 722 |
% This might be a slightly awkward way to do it, I am still looking into |
| 723 |
% optimising this code. Anyway, we define everything we need for book, part, title, |
| 724 |
% chapter, section, subsection and subsubsection. |
| 725 |
% \begin{macrocode} |
| 726 |
\def\skb@inputLevelBook{book} |
| 727 |
\def\skb@inputLevelPart{part} |
| 728 |
\def\skb@inputLevelTitle{title} |
| 729 |
\def\skb@inputLevelChapter{chapter} |
| 730 |
\def\skb@inputLevelSection{section} |
| 731 |
\def\skb@inputLevelSubSection{subsection} |
| 732 |
\def\skb@inputLevelSubSubSection{subsubsection} |
| 733 |
% \end{macrocode} |
| 734 |
% |
| 735 |
% Now we define a macro that will be used to point to the selected input level (\cmd{\skb@inputLevel}) |
| 736 |
% and a macro that will be used to set the default input level to be empty (i.e. do nothing, \cmd{\skb@SetInputLevel}). |
| 737 |
% \begin{macrocode} |
| 738 |
\def\skb@inputLevel{} |
| 739 |
\newcommand\skb@SetInputLevel{\gdef\skb@inputLevel{}} |
| 740 |
% \end{macrocode} |
| 741 |
% |
| 742 |
% And here is the actual definition of the option \skbem[code]{level}. For each supported parameter (introduced and defined |
| 743 |
% above) we test if it was provided calling the option (put into \cmd{\\intarg} on start) and if so we point \cmd{\skb@inputLevel} |
| 744 |
% to the \LaTeX~macro realising that document level. For instance, if the requested level is subsection we point \cmd{\skb@inputLevel} |
| 745 |
% to the \LaTeX~macro \cmd{\subsection}. That means we can later simply call \cmd{\skb@inputLevel} to instruct \LaTeX~to realise the |
| 746 |
% requested document level. In case the parameter is not supported, the option will throw an error along with a help message. |
| 747 |
% \begin{macrocode} |
| 748 |
\define@key{skbinput}{level}[]{% |
| 749 |
\def\intarg{#1} |
| 750 |
\ifx\skb@inputLevelBook\intarg |
| 751 |
\let\skb@inputLevel=\book |
| 752 |
\else\ifx\skb@inputLevelPart\intarg |
| 753 |
\let\skb@inputLevel=\part |
| 754 |
\else\ifx\skb@inputLevelTitle\intarg |
| 755 |
\let\skb@inputLevel=\title |
| 756 |
\else\ifx\skb@inputLevelChapter\intarg |
| 757 |
\let\skb@inputLevel=\chapter |
| 758 |
\else\ifx\skb@inputLevelSection\intarg |
| 759 |
\let\skb@inputLevel=\section |
| 760 |
\else\ifx\skb@inputLevelSubSection\intarg |
| 761 |
\let\skb@inputLevel=\subsection |
| 762 |
\else\ifx\skb@inputLevelSubSubSection\intarg |
| 763 |
\let\skb@inputLevel=\subsubsection |
| 764 |
\else |
| 765 |
\PackageError{skb}% |
| 766 |
{Value for option \@tempa\space not supported: \intarg}% |
| 767 |
{I do not know the value \intarg\space for the option \@tempa.% |
| 768 |
\MessageBreak Please use only: book, part, title, chapter,% |
| 769 |
\MessageBreak section, subsection or subsubsection.% |
| 770 |
\MessageBreak <return> to continue, no level will be set and heading is ignored} |
| 771 |
\fi\fi\fi\fi\fi\fi\fi |
| 772 |
} |
| 773 |
% \end{macrocode} |
| 774 |
% |
| 775 |
% \subsubsection{The Macro} |
| 776 |
% \DescribeMacro{\skbinput} |
| 777 |
% This macro will load a .tex file from the root directory or from an \skbacft{A3DS:SKB} known directory (if option \skbem[code]{from} is applied). |
| 778 |
% It will also configure the document level macro for the next use of \cmd{\skbjeading}, if the option \skbem[code]{level} is applied. |
| 779 |
% If \skbem[code]{level} is not used, then \cmd{\skbheading} will have no effect. The macro first sets the input level to be empty (\cmd{\skb@input@set}) |
| 780 |
% and the input macro to the default value (\cmd{\skb@input@set}). The it processes the options (using the keyval pacakge) and finally calls |
| 781 |
% \cmd{\skb@input@call} to realise the load of the requested file. |
| 782 |
% \begin{macrocode} |
| 783 |
\newcommand\skbinput[2][]{% |
| 784 |
\skb@input@set |
| 785 |
\skb@SetInputLevel |
| 786 |
\setkeys{skbinput}{#1} |
| 787 |
\skb@input@call{#2} |
| 788 |
} |
| 789 |
% \end{macrocode} |
| 790 |
% |
| 791 |
% |
| 792 |
% \subsection{Loading Figures: skbfigure} |
| 793 |
% \subsubsection{Macro Options} |
| 794 |
% This macro supportes a number of options. To be able to test for the applied options, we first define a few macros |
| 795 |
% that will be used by \cmd{\skbfigure} to realise the requested figure input. We define one macro per option supported. |
| 796 |
% \begin{macrocode} |
| 797 |
\def\skb@FigureOptWidth{} |
| 798 |
\def\skb@FigureOptHeight{} |
| 799 |
\def\skb@FigureOptCenter{} |
| 800 |
\def\skb@FigureOptFigure{} |
| 801 |
\def\skb@FigureOptPosition{} |
| 802 |
\def\skb@FigureOptCaption{} |
| 803 |
\def\skb@FigureOptLabel{} |
| 804 |
\def\skb@FigureOptMultiinclide{} |
| 805 |
% \end{macrocode} |
| 806 |
% |
| 807 |
% To be able to reset all of these macros before processing a figure, we define a reset macro. |
| 808 |
% \begin{macrocode} |
| 809 |
\newcommand{\skb@figureOptReset}{ |
| 810 |
\gdef\skb@FigureOptWidth{} |
| 811 |
\gdef\skb@FigureOptHeight{} |
| 812 |
\gdef\skb@FigureOptCenter{} |
| 813 |
\gdef\skb@FigureOptFigure{} |
| 814 |
\gdef\skb@FigureOptPosition{} |
| 815 |
\gdef\skb@FigureOptCaption{} |
| 816 |
\gdef\skb@FigureOptLabel{} |
| 817 |
\gdef\skb@FigureOptMultiinclide{} |
| 818 |
} |
| 819 |
% \end{macrocode} |
| 820 |
% |
| 821 |
% Now we define all options for \cmd{\skbfigure}. All options work the same way: they either take the parameter given and put it into |
| 822 |
% the corresponding macro we defined above or simply set the corresponding macro to true. This way we can test these corresponding macros |
| 823 |
% for being empty (default) or not and then decide how to process the figure input. |
| 824 |
% |
| 825 |
% \DescribeMacro{skbfigure opt width} |
| 826 |
% The first one is called \skbem[code]{width} used for the width of \cmd{\resizebox} and \cmd{includegraphics}. |
| 827 |
% \begin{macrocode} |
| 828 |
\define@key{skbfigures}{width}[]{% |
| 829 |
\gdef\skb@FigureOptWidth{#1} |
| 830 |
} |
| 831 |
% \end{macrocode} |
| 832 |
% |
| 833 |
% \DescribeMacro{skbfigure opt height} |
| 834 |
% The option height is used for the height of \cmd{\resizebox} and \cmd{includegraphics}. |
| 835 |
% \begin{macrocode} |
| 836 |
\define@key{skbfigures}{height}[]{% |
| 837 |
\gdef\skb@FigureOptHeight{#1} |
| 838 |
} |
| 839 |
% \end{macrocode} |
| 840 |
% |
| 841 |
% \DescribeMacro{skbfigure opt center} |
| 842 |
% The option center is used to trigger the center environment (so it only needs to set true). |
| 843 |
% \begin{macrocode} |
| 844 |
\define@key{skbfigures}{center}[true]{% |
| 845 |
\gdef\skb@FigureOptCenter{true} |
| 846 |
} |
| 847 |
% \end{macrocode} |
| 848 |
% |
| 849 |
% \DescribeMacro{skbfigure opt figure} |
| 850 |
% The option figure is used to trigger the figure environment (so it only needs to set true). |
| 851 |
% \begin{macrocode} |
| 852 |
\define@key{skbfigures}{figure}[true]{% |
| 853 |
\gdef\skb@FigureOptFigure{true} |
| 854 |
} |
| 855 |
% \end{macrocode} |
| 856 |
% |
| 857 |
% \DescribeMacro{skbfigure opt position} |
| 858 |
% The option position is used to fix the position when figure environment is used |
| 859 |
% \begin{macrocode} |
| 860 |
\define@key{skbfigures}{position}[]{% |
| 861 |
\gdef\skb@FigureOptPosition{\begin{figure}[#1]} |
| 862 |
} |
| 863 |
% \end{macrocode} |
| 864 |
% |
| 865 |
% \DescribeMacro{skbfigure opt caption} |
| 866 |
% The option caption is used to define the caption of the figure used as \cmd{\caption} |
| 867 |
% \begin{macrocode} |
| 868 |
\define@key{skbfigures}{caption}[]{% |
| 869 |
\gdef\skb@FigureOptCaption{\caption{#1}} |
| 870 |
} |
| 871 |
% \end{macrocode} |
| 872 |
% |
| 873 |
% \DescribeMacro{skbfigure opt label} |
| 874 |
% The option label is used to define the label of the figure used as \cmd{\label} |
| 875 |
% \begin{macrocode} |
| 876 |
\define@key{skbfigures}{label}[]{% |
| 877 |
\gdef\skb@FigureOptLabel{\label{fig:#1}} |
| 878 |
} |
| 879 |
% \end{macrocode} |
| 880 |
% |
| 881 |
% \DescribeMacro{skbfigure opt multiinclude} |
| 882 |
% The option multiinclude is a special option to use \cmd{\multiinclude}, automatically deactivates all other options |
| 883 |
% \begin{macrocode} |
| 884 |
\define@key{skbfigures}{multiinclude}[]{% |
| 885 |
\gdef\skb@FigureOptMultiinclide{#1} |
| 886 |
} |
| 887 |
% \end{macrocode} |
| 888 |
% |
| 889 |
% |
| 890 |
% \subsubsection{The Macro} |
| 891 |
% \DescribeMacro{\skbfigure} |
| 892 |
% \cmd{\skbfigure} itself expects options (processed using keyval) and the actual file to be included. |
| 893 |
% The file name should start at the figure root directory. |
| 894 |
% \begin{macrocode} |
| 895 |
\newcommand{\skbfigure}[2][]{ |
| 896 |
% \end{macrocode} |
| 897 |
% First, we call our reset function and then use keyval to process the options. |
| 898 |
% \begin{macrocode} |
| 899 |
\skb@figureOptReset |
| 900 |
\setkeys{skbfigures}{#1}% |
| 901 |
|
| 902 |
% \end{macrocode} |
| 903 |
% Now we process the options figure and position to decide if and how to use the figure environment. If the figure option has been used, we |
| 904 |
% test if the position option has been used as well. If figure and position have been used, we |
| 905 |
% call \cmd{\skb@FigureOptPosition}, which expands to \cmd{\begin{figure}[option]}. If only the figure |
| 906 |
% option was used, we directly invoke \cmd{\begin{figure}}. |
| 907 |
% \begin{macrocode} |
| 908 |
\ifx\skb@FigureOptFigure\empty\else |
| 909 |
\ifx\skb@FigureOptPosition\empty |
| 910 |
\begin{figure} |
| 911 |
\else |
| 912 |
\skb@FigureOptPosition |
| 913 |
\fi |
| 914 |
\fi |
| 915 |
% \end{macrocode} |
| 916 |
% Next is the center option. If it was used, we call \cmd{\begin{center}}. |
| 917 |
% \begin{macrocode} |
| 918 |
\ifx\skb@FigureOptCenter\empty\else\begin{center}\fi |
| 919 |
|
| 920 |
% \end{macrocode} |
| 921 |
% The core of the macro. If the option multiinclude was not used, we proceed load the figure |
| 922 |
% as we would usually do with \LaTeX. If multiinclude was used, then we simply call \cmd{\multiinclude} |
| 923 |
% with the given overlay information, starting at number 0, using \skbacft{ISO:PDF} format and scaling everything to \cmd{\textwidth}. |
| 924 |
% \begin{macrocode} |
| 925 |
\ifx\skb@FigureOptMultiinclide\empty |
| 926 |
\ifx\skb@FigureOptWidth\empty |
| 927 |
\ifx\skb@FigureOptHeight\empty |
| 928 |
\resizebox{!}{!}% |
| 929 |
{\includegraphics[]% |
| 930 |
{\skbfilefig{#2}}} |
| 931 |
\else |
| 932 |
\resizebox{!}{\skb@FigureOptHeight}% |
| 933 |
{\includegraphics[height=\skb@FigureOptHeight]% |
| 934 |
{\skbfilefig{#2}}} |
| 935 |
\fi |
| 936 |
\else |
| 937 |
\ifx\skb@FigureOptHeight\empty |
| 938 |
\resizebox{\skb@FigureOptWidth}{!}% |
| 939 |
{\includegraphics[width=\skb@FigureOptWidth]% |
| 940 |
{\skbfilefig{#2}}} |
| 941 |
\else |
| 942 |
\resizebox{\skb@FigureOptWidth}% |
| 943 |
{\skb@FigureOptHeight}% |
| 944 |
{\includegraphics[% |
| 945 |
width=\skb@FigureOptWidth,% |
| 946 |
height=\skb@FigureOptHeight%]% |
| 947 |
{\skbfilefig{#2}}} |
| 948 |
\fi |
| 949 |
\fi |
| 950 |
\else |
| 951 |
\resizebox{\textwidth}{!}% |
| 952 |
{\multiinclude[<\skb@FigureOptMultiinclide>]% |
| 953 |
[start=0,format=pdf,graphics={width=\textwidth}]% |
| 954 |
{\skbfilefig{#2}}} |
| 955 |
\fi |
| 956 |
|
| 957 |
% \end{macrocode} |
| 958 |
% If we did use the figure environment, then we check for given caption and label. |
| 959 |
% \begin{macrocode} |
| 960 |
\ifx\skb@FigureOptFigure\empty\else% |
| 961 |
\skb@FigureOptCaption |
| 962 |
\skb@FigureOptLabel |
| 963 |
\fi% |
| 964 |
|
| 965 |
% \end{macrocode} |
| 966 |
% And finally we close the figure and center environments if we did open them earlier. |
| 967 |
% \begin{macrocode} |
| 968 |
\ifx\skb@FigureOptCenter\empty\else\end{center}\fi |
| 969 |
\ifx\skb@FigureOptFigure\empty\else\end{figure}\fi |
| 970 |
} |
| 971 |
% \end{macrocode} |
| 972 |
% |
| 973 |
% |
| 974 |
% \subsection{Loading Slides: skbslide} |
| 975 |
% This macro allows to load a (configurable) combination of \skbacft{ISO:PDF} slide and \LaTeX~ |
| 976 |
% annotation to be loaded in a single call. |
| 977 |
% |
| 978 |
% \subsubsection{Some Extentions} |
| 979 |
% \DescribeMacro{\skb@slides@callpath} |
| 980 |
% The first is a macro that will maintain the current path and file for loading slides. |
| 981 |
% \begin{macrocode} |
| 982 |
\def\skb@slides@callpath{} |
| 983 |
% \end{macrocode} |
| 984 |
% \DescribeMacro{\skb@slides@doslinote} |
| 985 |
% The second is a macro to load annotations from the slide folder. |
| 986 |
% \begin{macrocode} |
| 987 |
\newcommand{\skb@slides@doslinote}[1]{% |
| 988 |
\def\intarg{#1} |
| 989 |
\skb@input@doife{skbfilesli}{\intarg}{.tex}{in the slides folder} |
| 990 |
} |
| 991 |
% \end{macrocode} |
| 992 |
% |
| 993 |
% \subsubsection{Macro Options} |
| 994 |
% \DescribeMacro{\skbslide opt slidefrom} |
| 995 |
% The option \skbem[code]{slidefrom} is used to point to one of the following \skbacft{A3DS:SKB} directories: |
| 996 |
% \skbem[code]{sli} (the folder for slides) or |
| 997 |
% \skbem[code]{pub} (the folder for published documents) or |
| 998 |
% \skbem[code]{rep} (the repository directory). |
| 999 |
% The option is optional, but when used must give one of the above described values. |
| 1000 |
% The \skbacft{A3DS:SKB} will throw an error otherwise. |
| 1001 |
% \begin{macrocode} |
| 1002 |
\define@key{skbslide}{slidefrom}[]{% |
| 1003 |
\def\intarg{#1} |
| 1004 |
\ifx\skb@input@var@sli\intarg |
| 1005 |
\let\skb@slides@callpath=\skbfilesli |
| 1006 |
\else\ifx\skb@input@var@pub\intarg |
| 1007 |
\let\skb@slides@callpath=\skbfilepub |
| 1008 |
\else\ifx\skb@input@var@rep\intarg |
| 1009 |
\let\skb@slides@callpath=\skbfilerep |
| 1010 |
\else |
| 1011 |
\PackageError{skb}% |
| 1012 |
{Value for option \@tempa\space not supported: \intarg}% |
| 1013 |
{I do not know the value \intarg\space for the option \@tempa.% |
| 1014 |
\MessageBreak Please use either "pub", "rep" or "sli".% |
| 1015 |
\MessageBreak <return> to continue, no file will be loaded} |
| 1016 |
\fi\fi\fi |
| 1017 |
} |
| 1018 |
% \end{macrocode} |
| 1019 |
% |
| 1020 |
% \DescribeMacro{\skbslide opt notefrom} |
| 1021 |
% The option \skbem[code]{notefrom} is used to point to one of the following \skbacft{A3DS:SKB} directories: |
| 1022 |
% \skbem[code]{sli} (the folder for slides) or |
| 1023 |
% \skbem[code]{pub} (the folder for published documents) or |
| 1024 |
% \skbem[code]{rep} (the repository directory). |
| 1025 |
% The option is optional, but when used must give one of the above described values. |
| 1026 |
% The \skbacft{A3DS:SKB} will throw an error otherwise. |
| 1027 |
% \begin{macrocode} |
| 1028 |
\define@key{skbslide}{notefrom}[]{% |
| 1029 |
\def\intarg{#1} |
| 1030 |
\ifx\skb@input@var@sli\intarg |
| 1031 |
\gdef\skb@input@call{\skb@slides@doslinote} |
| 1032 |
\else\ifx\skb@input@var@pub\intarg |
| 1033 |
\gdef\skb@input@call{\skb@input@dopub} |
| 1034 |
\else\ifx\skb@input@var@rep\intarg |
| 1035 |
\gdef\skb@input@call{\skb@input@dorep} |
| 1036 |
\else |
| 1037 |
\PackageError{skb}% |
| 1038 |
{Value for option \@tempa\space not supported: \intarg}% |
| 1039 |
{I do not know the value \intarg\space for the option \@tempa.% |
| 1040 |
\MessageBreak Please use either "pub", "rep" or "sli".% |
| 1041 |
\MessageBreak <return> to continue, no file will be loaded} |
| 1042 |
\fi\fi\fi |
| 1043 |
} |
| 1044 |
% \end{macrocode} |
| 1045 |
% |
| 1046 |
% \DescribeMacro{\skbslide opt annotate} |
| 1047 |
% The option \skbem[code]{annotate} requests to load annotations for the slide. If not given, no |
| 1048 |
% annotations will be loaded. |
| 1049 |
% \begin{macrocode} |
| 1050 |
\def\skb@slides@loadnote{} |
| 1051 |
\define@key{skbslide}{annotate}[true]{% |
| 1052 |
\gdef\skb@slides@loadnote{true} |
| 1053 |
} |
| 1054 |
% \end{macrocode} |
| 1055 |
% |
| 1056 |
% |
| 1057 |
% \subsubsection{The Macro} |
| 1058 |
% \DescribeMacro{\skbslide} |
| 1059 |
% This macro will load the slide and annotation, depending on the options provided. |
| 1060 |
% \begin{macrocode} |
| 1061 |
\newcommand\skbslide[3][]{% |
| 1062 |
\gdef\skb@slides@loadnote{} |
| 1063 |
\gdef\skb@input@call{\skb@slides@doslinote} |
| 1064 |
\let\skb@slides@callpath=\skbfilesli |
| 1065 |
\setkeys{skbslide}{#1} |
| 1066 |
|
| 1067 |
\def\sl{#2} |
| 1068 |
\def\an{#3} |
| 1069 |
|
| 1070 |
\ifx\sl\empty\else |
| 1071 |
\begin{figure}[!bh] |
| 1072 |
\resizebox{\textwidth}{!}{\includegraphics[width=\textwidth]{\skb@slides@callpath{#2}}} |
| 1073 |
\end{figure} |
| 1074 |
\fi |
| 1075 |
|
| 1076 |
\ifx\skb@slides@loadnote\empty\else |
| 1077 |
\ifx\an\empty |
| 1078 |
\skb@input@call{#2} |
| 1079 |
\clearpage |
| 1080 |
\else |
| 1081 |
\skb@input@call{#3} |
| 1082 |
\clearpage |
| 1083 |
\fi |
| 1084 |
\fi |
| 1085 |
} |
| 1086 |
% \end{macrocode} |
| 1087 |
% |
| 1088 |
% \DescribeMacro{\skbslide} |
| 1089 |
% This simple macro can help to provide standardised citations on annotation pages. |
| 1090 |
% \begin{macrocode} |
| 1091 |
\newcommand{\skbslidecite}[2]{\small Source \textit{#2}: \textit{#1} \normalsize} |
| 1092 |
% \end{macrocode} |
| 1093 |
% |
| 1094 |
% |
| 1095 |
% \section{Implementation: Filenames, Acronyms and References} |
| 1096 |
% \subsection{Path and File Names} |
| 1097 |
% These macros are used within the \skbacft{A3DS:SKB} to generate path and filenames for all known |
| 1098 |
% directories and files. They basically provide user-level access to kernel-level processed |
| 1099 |
% configuration date. |
| 1100 |
% All path names, except root, are fully qualified from root. |
| 1101 |
% All filenames are fully qualified from root. Macros that expect an argument use that |
| 1102 |
% very argument as the reuqested filename to provide path and filename. |
| 1103 |
% |
| 1104 |
% \DescribeMacro{\skbpathroot} |
| 1105 |
% This macro returns the currently set root path. |
| 1106 |
% \begin{macrocode} |
| 1107 |
\newcommand{\skbpathroot}{\skb@getCfgVars{root}} |
| 1108 |
% \end{macrocode} |
| 1109 |
% \DescribeMacro{\skbfileroot} |
| 1110 |
% This macro takes the given argument and prefixes the root path to it. |
| 1111 |
% \begin{macrocode} |
| 1112 |
\newcommand{\skbfileroot}[1]{\skb@getCfgVars{root}/#1} |
| 1113 |
% \end{macrocode} |
| 1114 |
% \DescribeMacro{\skbfileacr} |
| 1115 |
% This macro returns the file of the acronym database. |
| 1116 |
% \begin{macrocode} |
| 1117 |
\newcommand{\skbfileacr}{\skb@getCfgVars{root}/\skb@getCfgVars{acr}/\skb@getCfgVars{acrfile}} |
| 1118 |
% \end{macrocode} |
| 1119 |
% \DescribeMacro{\skbpathbib} |
| 1120 |
% This macro returns the path to the reference library. |
| 1121 |
% \begin{macrocode} |
| 1122 |
\newcommand{\skbpathbib}{\skb@getCfgVars{root}/\skb@getCfgVars{bib}} |
| 1123 |
% \end{macrocode} |
| 1124 |
% \DescribeMacro{\skbfilebib} |
| 1125 |
% This macro returns the file that is used to load the reference library. |
| 1126 |
% \begin{macrocode} |
| 1127 |
\newcommand{\skbfilebib}{\skb@getCfgVars{root}/\skb@getCfgVars{bib}/\skb@getCfgVars{bibfile}} |
| 1128 |
% \end{macrocode} |
| 1129 |
% \DescribeMacro{\skbfilerep} |
| 1130 |
% This macro takes the provided argument and prefixes the path to the repository to it. |
| 1131 |
% \begin{macrocode} |
| 1132 |
\newcommand{\skbfilerep}[1]{\skb@getCfgVars{root}/\skb@getCfgVars{rep}/#1} |
| 1133 |
% \end{macrocode} |
| 1134 |
% \DescribeMacro{\skbfilepub} |
| 1135 |
% This macro takes the provided argument and prefixes the path to the published documents to it. |
| 1136 |
% \begin{macrocode} |
| 1137 |
\newcommand{\skbfilepub}[1]{\skb@getCfgVars{root}/\skb@getCfgVars{pub}/#1} |
| 1138 |
% \end{macrocode} |
| 1139 |
% \DescribeMacro{\skbfilefig} |
| 1140 |
% This macro takes the provided argument and prefixes the path to the figures to it. |
| 1141 |
% \begin{macrocode} |
| 1142 |
\newcommand{\skbfilefig}[1]{\skb@getCfgVars{root}/\skb@getCfgVars{fig}/#1} |
| 1143 |
% \end{macrocode} |
| 1144 |
% \DescribeMacro{\skbfilesli} |
| 1145 |
% This macro takes the provided argument and prefixes the path to the slides to it. |
| 1146 |
% \begin{macrocode} |
| 1147 |
\newcommand{\skbfilesli}[1]{\skb@getCfgVars{root}/\skb@getCfgVars{sli}/#1} |
| 1148 |
% \end{macrocode} |
| 1149 |
% |
| 1150 |
% |
| 1151 |
% \subsection{Loading Acronyms} |
| 1152 |
% \DescribeMacro{\skbacronyms} |
| 1153 |
% This macro will load the acronym database. It should be used at the place in your document were you want |
| 1154 |
% the list of acronyms to appear. If the file is not found, an error is thrown. |
| 1155 |
% \begin{macrocode} |
| 1156 |
\newcommand{\skbacronyms}{% |
| 1157 |
\skb@input@doife{skbfileacr}{}{}{for acronym database} |
| 1158 |
} |
| 1159 |
% \end{macrocode} |
| 1160 |
% |
| 1161 |
% \subsection{Loading Reference Database} |
| 1162 |
% \DescribeMacro{\skbbibtex} |
| 1163 |
% This macro will load the reference database. It should be used before you start the actual document. |
| 1164 |
% If the file is not found, an error is thrown. |
| 1165 |
% \begin{macrocode} |
| 1166 |
\newcommand{\skbbibtex}{% |
| 1167 |
\skb@input@doife{skbfilebib}{}{}{for bibtex database} |
| 1168 |
} |
| 1169 |
% \end{macrocode} |
| 1170 |
% |
| 1171 |
% |
| 1172 |
% |
| 1173 |
% \section{Implementation: Other useful Macros} |
| 1174 |
% |
| 1175 |
% \subsection{Emphasising Text: skbem} |
| 1176 |
% \subsubsection{Macro Options} |
| 1177 |
% \DescribeMacro{skbem opt italic} |
| 1178 |
% This option will typset the given text for \cmd{\skbem} using italic font. |
| 1179 |
% \begin{macrocode} |
| 1180 |
\def\skb@emCmd{} |
| 1181 |
\define@key{skbem}{italic}[true]{% |
| 1182 |
\gdef\skb@emCmd{\textit}% |
| 1183 |
}% |
| 1184 |
% \end{macrocode} |
| 1185 |
% \DescribeMacro{skbem opt bold} |
| 1186 |
% This option will typset the given text for \cmd{\skbem} using bold font. |
| 1187 |
% \begin{macrocode} |
| 1188 |
\define@key{skbem}{bold}[true]{% |
| 1189 |
\gdef\skb@emCmd{\textbf}% |
| 1190 |
}% |
| 1191 |
% \end{macrocode} |
| 1192 |
% \DescribeMacro{skbem opt code} |
| 1193 |
% This option will typset the given text for \cmd{\skbem} using the command \cmd{\skbcode} (see below). |
| 1194 |
% \begin{macrocode} |
| 1195 |
\define@key{skbem}{code}[true]{% |
| 1196 |
\gdef\skb@emCmd{\skbcode}% |
| 1197 |
}% |
| 1198 |
% \end{macrocode} |
| 1199 |
% |
| 1200 |
% \subsubsection{The Macro} |
| 1201 |
% \DescribeMacro{\skbem} |
| 1202 |
% This macro helps to emphasise text in an explicit way (as compared to use font commands within |
| 1203 |
% the actual text). Simply call with the one of the option to emphasise text. |
| 1204 |
% \begin{macrocode} |
| 1205 |
\newcommand{\skbem}[2][]{% |
| 1206 |
\gdef\skb@emCmd{}% |
| 1207 |
\setkeys{skbem}{#1}% |
| 1208 |
\skb@emCmd{#2}% |
| 1209 |
}% |
| 1210 |
% \end{macrocode} |
| 1211 |
% |
| 1212 |
% \subsection{Emphasising Text: skbcode} |
| 1213 |
% \DescribeMacro{\skbcode} |
| 1214 |
% This macro is a facade for calling \cmd{\lstinline} with basicstyle set to type writer font. |
| 1215 |
% It is used by \skbem[code]{skbem} with the option \skbem[code]{code} to call |
| 1216 |
% \cmd{\lstinline} but can also be called directly. |
| 1217 |
% \begin{macrocode} |
| 1218 |
\newcommand{\skbcode}[1]{% |
| 1219 |
\lstinline[basicstyle=\ttfamily]{#1}% |
| 1220 |
}% |
| 1221 |
% \end{macrocode} |
| 1222 |
% |
| 1223 |
% \subsection{List Environments: skbnotelist and skbnoteenum} |
| 1224 |
% These environments simulate \cmd{\tightlist} from the memoir package. |
| 1225 |
% They work identical: call the environment itemize (for skbnotelist) or enumerate |
| 1226 |
% (for skbnoteenum) and set the two values to 0 (thus minimising the margin between items). |
| 1227 |
% |
| 1228 |
% \DescribeMacro{\skbnotelist} |
| 1229 |
% New Environment skbnotelist to minimise the margin between list items. |
| 1230 |
% \begin{macrocode} |
| 1231 |
\newenvironment{skbnotelist} |
| 1232 |
{\begin{itemize} |
| 1233 |
\ifSkbMemoirLoaded\else |
| 1234 |
\setlength{\parskip}{0cm}\setlength{\itemsep}{0cm} |
| 1235 |
\fi |
| 1236 |
} |
| 1237 |
{\end{itemize}} |
| 1238 |
% \end{macrocode} |
| 1239 |
% |
| 1240 |
% \DescribeMacro{\skbnoteenum} |
| 1241 |
% New Environment skbnotelist to minimise the margin between list items. |
| 1242 |
% \begin{macrocode} |
| 1243 |
\newenvironment{skbnoteenum}% |
| 1244 |
{\begin{enumerate} |
| 1245 |
\ifSkbMemoirLoaded\else |
| 1246 |
\setlength{\parskip}{0cm}\setlength{\itemsep}{0cm} |
| 1247 |
\fi |
| 1248 |
} |
| 1249 |
{\end{enumerate}} |
| 1250 |
% \end{macrocode} |
| 1251 |
% |
| 1252 |
% |
| 1253 |
% \subsection{Acronyms in Footnotes: skbacft} |
| 1254 |
% \DescribeMacro{\skbacft} |
| 1255 |
% This macro provides some functionality that the \skbem[code]{acronym} package does not offer: |
| 1256 |
% introducing acronyms in a footnote (if they are used the first time) or simply use the short |
| 1257 |
% form. I found this is useful when writing books, where sometimes introducing acronym in the |
| 1258 |
% normal text flow somehow disturbs that very flow. |
| 1259 |
% \begin{macrocode} |
| 1260 |
\newcommand{\skbacft}[1]{% |
| 1261 |
\ifAC@dua |
| 1262 |
\ifAC@starred\acl*{#1}\else\acl{#1}\fi% |
| 1263 |
\else |
| 1264 |
\expandafter\ifx\csname ac@#1\endcsname\AC@used% |
| 1265 |
\acs{#1}% |
| 1266 |
\else |
| 1267 |
\acs{#1}\footnote{\acf{#1}}% |
| 1268 |
\fi |
| 1269 |
\fi} |
| 1270 |
% \end{macrocode} |
| 1271 |
% |
| 1272 |
% |
| 1273 |
% \subsection{PDF Meta Information: skbpdfinfo and more} |
| 1274 |
% |
| 1275 |
% \DescribeMacro{\skbtitle} |
| 1276 |
% This macro allows to set text for the title of the generated \skbacft{ISO:PDF}. |
| 1277 |
% \begin{macrocode} |
| 1278 |
\def\skb@TitleText{} |
| 1279 |
\newcommand{\skbtitle}[1]{\gdef\skb@TitleText{#1}} |
| 1280 |
% \end{macrocode} |
| 1281 |
% \DescribeMacro{\skbauthor} |
| 1282 |
% This macro allows to set text for the author of the generated \skbacft{ISO:PDF}. |
| 1283 |
% \begin{macrocode} |
| 1284 |
\def\skb@AuthorText{} |
| 1285 |
\newcommand{\skbauthor}[1]{\gdef\skb@AuthorText{#1}} |
| 1286 |
% \end{macrocode} |
| 1287 |
% \DescribeMacro{\skbsubject} |
| 1288 |
% This macro allows to set text for the subject of the generated \skbacft{ISO:PDF}. |
| 1289 |
% \begin{macrocode} |
| 1290 |
\def\skb@SubjectText{} |
| 1291 |
\newcommand{\skbsubject}[1]{\gdef\skb@SubjectText{#1}} |
| 1292 |
% \end{macrocode} |
| 1293 |
% \DescribeMacro{\skbkeywords} |
| 1294 |
% This macro allows to set text for the keywords of the generated \skbacft{ISO:PDF}. |
| 1295 |
% \begin{macrocode} |
| 1296 |
\def\skb@KeywordsText{} |
| 1297 |
\newcommand{\skbkeywords}[1]{\gdef\skb@KeywordsText{#1}} |
| 1298 |
% \end{macrocode} |
| 1299 |
% \DescribeMacro{\skbpdfinfo} |
| 1300 |
% This macro will set the \skbacft{ISO:PDF} information in the generated \skbacft{ISO:PDF}. It first checks if |
| 1301 |
% we are in \skbacft{ISO:PDF} mode, and then uses the information from \cmd{\skb@AuthorText}, |
| 1302 |
% \cmd{\skb@TitleText} plus subject and keywords from above. |
| 1303 |
% \begin{macrocode} |
| 1304 |
\newcommand{\skbpdfinfo}{% |
| 1305 |
\ifpdf |
| 1306 |
\pdfinfo{ |
| 1307 |
/Author (\skb@AuthorText) |
| 1308 |
/Title (\skb@TitleText) |
| 1309 |
/ModDate (D:\pdfdate) |
| 1310 |
/Subject (\skb@SubjectText) |
| 1311 |
/Keywords (\skb@KeywordsText) |
| 1312 |
} |
| 1313 |
\fi |
| 1314 |
} |
| 1315 |
% \end{macrocode} |
| 1316 |
% |
| 1317 |
% |
| 1318 |
% \subsection{Listing Styles and Support} |
| 1319 |
% The \skbacft{A3DS:SKB} comes with a few pre-defined styles for the \skbem[code]{listing} package. |
| 1320 |
% Most of these predefined styles use type writer font in scriptsize, arrange a grey |
| 1321 |
% box around the listing and set the keywords to Blue4. |
| 1322 |
% |
| 1323 |
% The first style is the for any generic listing without specifying a language and no |
| 1324 |
% line numbers. |
| 1325 |
% \begin{macrocode} |
| 1326 |
\lstdefinestyle{generic} |
| 1327 |
{basicstyle=\scriptsize\ttfamily, backgroundcolor=\color[gray]{.9}, |
| 1328 |
frame=single, framerule=.5pt, numbers=none, |
| 1329 |
linewidth=0.99\textwidth, xleftmargin=3pt, |
| 1330 |
keywordstyle=\bfseries\color{Blue4}, |
| 1331 |
identifierstyle=\bfseries} |
| 1332 |
% \end{macrocode} |
| 1333 |
% |
| 1334 |
% This style is designed for listings within tables. It is similar to the generic one above, |
| 1335 |
% except that the definitions for frame and numbers are not used, which seem to collide |
| 1336 |
% with some table environments. |
| 1337 |
% \begin{macrocode} |
| 1338 |
\lstdefinestyle{gentab} |
| 1339 |
{basicstyle=\scriptsize\ttfamily, backgroundcolor=\color[gray]{.9}, |
| 1340 |
framerule=0pt, |
| 1341 |
linewidth=.86\textwidth, xleftmargin=3pt, |
| 1342 |
keywordstyle=\bfseries\color{Blue4}, |
| 1343 |
identifierstyle=\bfseries} |
| 1344 |
% \end{macrocode} |
| 1345 |
% |
| 1346 |
% This style is the same as the generic one above, except that it switches on line numbers |
| 1347 |
% and allows extra space for them within the grey box. |
| 1348 |
% \begin{macrocode} |
| 1349 |
\lstdefinestyle{genericLN} |
| 1350 |
{basicstyle=\scriptsize\ttfamily, backgroundcolor=\color[gray]{.9}, |
| 1351 |
frame=single, framerule=.5pt, numbers=left, |
| 1352 |
linewidth=0.99\textwidth, xleftmargin=20pt, |
| 1353 |
keywordstyle=\bfseries\color{Blue4}, |
| 1354 |
identifierstyle=\bfseries} |
| 1355 |
% \end{macrocode} |
| 1356 |
% |
| 1357 |
% This style is based on the style \skbem[code]{genricLN}, basically using a slightly brighter |
| 1358 |
% grey for the box. |
| 1359 |
% \begin{macrocode} |
| 1360 |
\lstdefinestyle{genericLNspecial} |
| 1361 |
{basicstyle=\small\ttfamily, backgroundcolor=\color[gray]{.97}, |
| 1362 |
frame=single, framerule=.5pt, numbers=left, |
| 1363 |
linewidth=0.99\textwidth, xleftmargin=20pt, |
| 1364 |
keywordstyle=\bfseries\color{Blue4}, |
| 1365 |
identifierstyle=\bfseries} |
| 1366 |
% \end{macrocode} |
| 1367 |
% |
| 1368 |
% This style is designed for examples within slides (frames) using the \skbem[code]{beamer} |
| 1369 |
% package. |
| 1370 |
% \begin{macrocode} |
| 1371 |
\lstdefinestyle{beamer-example} |
| 1372 |
{basicstyle=\scriptsize\ttfamily, |
| 1373 |
frame=single, framerule=0pt, numbers=none, |
| 1374 |
linewidth=0.99\textwidth, xleftmargin=3pt, |
| 1375 |
keywordstyle=\bfseries\color{Blue4}, |
| 1376 |
identifierstyle=\bfseries} |
| 1377 |
% \end{macrocode} |
| 1378 |
% |
| 1379 |
% This style is designed for examples within slides (frames) using the \skbem[code]{beamer} |
| 1380 |
% with added line numbers. |
| 1381 |
% \begin{macrocode} |
| 1382 |
\lstdefinestyle{beamer-exampleLN} |
| 1383 |
{basicstyle=\scriptsize\ttfamily, |
| 1384 |
frame=single, framerule=0pt, numbers=left, |
| 1385 |
linewidth=0.99\textwidth, xleftmargin=20pt, |
| 1386 |
keywordstyle=\bfseries\color{Blue4}, |
| 1387 |
identifierstyle=\bfseries} |
| 1388 |
% \end{macrocode} |
| 1389 |
% |
| 1390 |
% This style uses the definitions from the generic style above and set the language to Java. |
| 1391 |
% \begin{macrocode} |
| 1392 |
\lstdefinestyle{javaCode} |
| 1393 |
{basicstyle=\scriptsize\ttfamily, backgroundcolor=\color[gray]{.9}, |
| 1394 |
frame=single, framerule=0pt, language=JAVA, |
| 1395 |
numbers=none, |
| 1396 |
keywordstyle=\bfseries\color{Blue4}, |
| 1397 |
identifierstyle=, |
| 1398 |
linewidth=0.99\columnwidth} |
| 1399 |
% \end{macrocode} |
| 1400 |
% |
| 1401 |
% This style can be used to set `normal' style after changing it. |
| 1402 |
% \begin{macrocode} |
| 1403 |
\lstdefinestyle{inText} |
| 1404 |
{basicstyle=\ttfamily} |
| 1405 |
% \end{macrocode} |
| 1406 |
% |
| 1407 |
% |
| 1408 |
% \section{Experimental Macros} |
| 1409 |
% This part of the \skbacft{A3DS:SKB} is experimental. Please do not use it for production code or important |
| 1410 |
% documents. The macros in this section will be moved as soon as they are stable, or simply |
| 1411 |
% removed. They can, as long as they stay in this section, be changed at any time in future |
| 1412 |
% releases. |
| 1413 |
% |
| 1414 |
% \subsection{Defining new relative Headings: skbheadingudc} |
| 1415 |
% When we set the document level with \cmd{\skbheading}, it might be usefull to actually |
| 1416 |
% have a macro that allows to relatively change headings. This is usefull if we have more than |
| 1417 |
% one heading in a repository file, where the first one defines the heading and will get |
| 1418 |
% an associative document level from the calling document while any subsequent heading might |
| 1419 |
% need to go one level up or down. The macro here works as long as we don't need to |
| 1420 |
% recursively store document levels. So it is not stable right now and makes only sense if |
| 1421 |
% used for single headings. |
| 1422 |
% |
| 1423 |
% First, a macro that we use to point to the new heading (rather than the one used by \cmd{\skbinput}. |
| 1424 |
% \begin{macrocode} |
| 1425 |
\def\skb@newHeading{} |
| 1426 |
% \end{macrocode} |
| 1427 |
% |
| 1428 |
% \subsubsection{Macro Options} |
| 1429 |
% Now the option down, which indicates that this heading should be one level down from the previous one. |
| 1430 |
% \begin{macrocode} |
| 1431 |
\define@key{skbheadings}{down}[true]{% |
| 1432 |
\ifx\skb@inputLevel\part |
| 1433 |
\let\skb@newHeading=\chapter |
| 1434 |
\let\skb@inputLevel=\chapter |
| 1435 |
\else\ifx\skb@inputLevel\chapter |
| 1436 |
\let\skb@newHeading=\section |
| 1437 |
\let\skb@inputLevel=\section |
| 1438 |
\else\ifx\skb@inputLevel\section |
| 1439 |
\let\skb@newHeading=\subsection |
| 1440 |
\let\skb@inputLevel=\subsection |
| 1441 |
\else\ifx\skb@inputLevel\subsection |
| 1442 |
\let\skb@newHeading=\subsubsection |
| 1443 |
\let\skb@inputLevel=\subsubsection |
| 1444 |
\else |
| 1445 |
\KV@err{Invalid current level for SkbNewHeading(down), |
| 1446 |
please use: part, chapter, section or subsection} |
| 1447 |
\fi\fi\fi\fi |
| 1448 |
} |
| 1449 |
% \end{macrocode} |
| 1450 |
% |
| 1451 |
% Now the option up, which indicates that this heading should be one level up from the previous one. |
| 1452 |
% \begin{macrocode} |
| 1453 |
\define@key{skbheadings}{up}[true]{% |
| 1454 |
\ifx\skb@inputLevel\chapter |
| 1455 |
\let\skb@newHeading=\part |
| 1456 |
\let\skb@inputLevel=\part |
| 1457 |
\else\ifx\skb@inputLevel\section |
| 1458 |
\let\skb@newHeading=\chapter |
| 1459 |
\let\skb@inputLevel=\chapter |
| 1460 |
\else\ifx\skb@inputLevel\subsection |
| 1461 |
\let\skb@newHeading=\section |
| 1462 |
\let\skb@inputLevel=\section |
| 1463 |
\else\ifx\skb@inputLevel\subsubsection |
| 1464 |
\let\skb@newHeading=\subsection |
| 1465 |
\let\skb@inputLevel=\subsection |
| 1466 |
\else |
| 1467 |
\KV@err{Invalid current level for SkbNewHeading(up), |
| 1468 |
please use: chapter, section, subsection or subsubsection} |
| 1469 |
\fi\fi\fi\fi |
| 1470 |
} |
| 1471 |
% \end{macrocode} |
| 1472 |
% |
| 1473 |
% Now the option last, which indicates that this heading should be on the same level as the previous one. |
| 1474 |
% \begin{macrocode} |
| 1475 |
\define@key{skbheadings}{last}[true]{% |
| 1476 |
\let\skb@newHeading=\skb@inputLevel% |
| 1477 |
} |
| 1478 |
% \end{macrocode} |
| 1479 |
% |
| 1480 |
% \subsubsection{The Macro} |
| 1481 |
% |
| 1482 |
% \DescribeMacro{\skbheadingudc} |
| 1483 |
% \begin{macrocode} |
| 1484 |
\newcommand{\skbheadingudc}[2][]{% |
| 1485 |
\gdef\skb@newHeading{} |
| 1486 |
\setkeys{skbheadings}{#1}% |
| 1487 |
\ifx\empty\skb@newHeading\else% |
| 1488 |
\skb@newHeading{#2}% |
| 1489 |
\fi |
| 1490 |
} |
| 1491 |
% \end{macrocode} |
| 1492 |
% |
| 1493 |
% |
| 1494 |
% |
| 1495 |
% |
| 1496 |
% \begin{macrocode} |
| 1497 |
%</skbpackage> |
| 1498 |
% \end{macrocode} |
| 1499 |
% |
| 1500 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 1501 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 1502 |
% |
| 1503 |
% \section{The Configuration File skb.cfg} |
| 1504 |
% |
| 1505 |
% This file is used to overwrite the default values for the \skbacft{A3DS:SKB} configuration |
| 1506 |
% options. It calles the macro \cmd{\skbconfig} using all possible options |
| 1507 |
% of that very macro and providing usefull text as origin of the configuration change |
| 1508 |
% \skbem[code]{skb.cfg}. Use this as template for the local configuration file |
| 1509 |
% \skbem[code]{skblocal.cfg} if you need one. |
| 1510 |
% \begin{macrocode} |
| 1511 |
%<*skbcfg> |
| 1512 |
\skbconfig[root=/doc, |
| 1513 |
acr=database/latex, |
| 1514 |
acrfile=acronyms, |
| 1515 |
bib=database/bibtex, |
| 1516 |
bibfile=bibliography.tex, |
| 1517 |
rep=repository, |
| 1518 |
pub=publish, |
| 1519 |
fig=figures, |
| 1520 |
sli=slides |
| 1521 |
]{skb.cfg} |
| 1522 |
%</skbcfg> |
| 1523 |
% \end{macrocode} |
| 1524 |
% |
| 1525 |
% |
| 1526 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 1527 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 1528 |
% |
| 1529 |
% \section{The \skbacft{A3DS:SKB} Classes} |
| 1530 |
% |
| 1531 |
% |
| 1532 |
% \subsection{The Class skbarticle} |
| 1533 |
% |
| 1534 |
% This class is an example on how to use the \skbacft{A3DS:SKB} with memoir. I use skbarticle |
| 1535 |
% for my articles. Using this class as a template, one can easily write other |
| 1536 |
% classes or change/overwrite the settings done here. |
| 1537 |
% |
| 1538 |
% First, we announce the package and the font definition file. |
| 1539 |
% \begin{macrocode} |
| 1540 |
%<*skbarticle> |
| 1541 |
\NeedsTeXFormat{LaTeX2e} |
| 1542 |
\ProvidesClass{skbarticle}[2011/06/03 The SKB Article class v0.52] |
| 1543 |
% \end{macrocode} |
| 1544 |
% |
| 1545 |
% Now we load the memoir class with the following options: |
| 1546 |
% \begin{skbnotelist} |
| 1547 |
% \item 10pt - for 10 point font size |
| 1548 |
% \item a4paper - I am European, so A4 paper makes sense here |
| 1549 |
% \item extrafontsizes - tbd |
| 1550 |
% \item twoside - I want my articles to be set with different even/odd pages |
| 1551 |
% \item onecolumn - I don't necessarily like 2-columns for my articles |
| 1552 |
% \item openright - tbd |
| 1553 |
% \item article - use memoir as if it is an article |
| 1554 |
% \end{skbnotelist} |
| 1555 |
% \begin{macrocode} |
| 1556 |
\LoadClass[10pt,a4paper,extrafontsizes,twoside,onecolumn,openright,article]{memoir} |
| 1557 |
% \end{macrocode} |
| 1558 |
% |
| 1559 |
% Load the \skbacft{A3DS:SKB}. |
| 1560 |
% \begin{macrocode} |
| 1561 |
\RequirePackage{skb} |
| 1562 |
% \end{macrocode} |
| 1563 |
% |
| 1564 |
% |
| 1565 |
% \subsubsection{Loaded Packages} |
| 1566 |
% |
| 1567 |
% I prefer BibLaTeX over plain \BibTeX, and other parts of the \skbacft{A3DS:SKB} (such as the \skbacft{LAMP} |
| 1568 |
% server) produce BibLaTeX. The options are: |
| 1569 |
% \begin{skbnotelist} |
| 1570 |
% \item style - is set to alphanumeric, much better to find/remember references. |
| 1571 |
% If writing for IEEE or LNCS, numeric would be the prefered option. |
| 1572 |
% \item sorting - is set to none, not needed here. |
| 1573 |
% \item hyperref - I want to have hyperef with my citations |
| 1574 |
% \end{skbnotelist} |
| 1575 |
% \begin{macrocode} |
| 1576 |
\RequirePackage[style=alphabetic,sorting=none,hyperref]{biblatex} |
| 1577 |
% \end{macrocode} |
| 1578 |
% |
| 1579 |
% Load the acronym package and print only the acronyms actually used in the document. |
| 1580 |
% This might move into the \skbacft{A3DS:SKB} package later. |
| 1581 |
% \begin{macrocode} |
| 1582 |
\RequirePackage[printonlyused]{acronym} |
| 1583 |
% \end{macrocode} |
| 1584 |
% |
| 1585 |
% Load a view packages that I tend to use quite often: |
| 1586 |
% \begin{skbnotelist} |
| 1587 |
% \item etoolbox - etoolbox |
| 1588 |
% \item comment - Add comments to your \LaTeX~files |
| 1589 |
% \item graphicx - Enhanced graphic support, with key/value interface for include graphics |
| 1590 |
% \item longtable - Helps with tables that span multiple pages |
| 1591 |
% \item colortbl - Allows coloured cells in tables |
| 1592 |
% \end{skbnotelist} |
| 1593 |
% \begin{macrocode} |
| 1594 |
\RequirePackage{etoolbox,comment,graphicx,longtable,colortbl} |
| 1595 |
% \end{macrocode} |
| 1596 |
% |
| 1597 |
% And some more packages needed quite often: |
| 1598 |
% \begin{skbnotelist} |
| 1599 |
% \item textcomp - Special characters, such as \textregistered~and \textcopyright |
| 1600 |
% \item gensymb - Generic characters (math and text mode), such as \degree, \celsius, \perthousand, \micro~and \ohm |
| 1601 |
% \item wasysym - Adds characters from \textit{wasy} font, such as \smiley, \XBox~and \rightturn |
| 1602 |
% \item units - Typeset units correctly (and produce 'nice' fractions), such as \unitfrac[10]{m}{s} and \nicefrac[\texttt]{1}{2} |
| 1603 |
% \item float - Improves interface for floating environments (such as figures, tables) |
| 1604 |
% \item xmpmulti - tbd |
| 1605 |
% \end{skbnotelist} |
| 1606 |
% \begin{macrocode} |
| 1607 |
\RequirePackage{textcomp,gensymb,wasysym,units,xmpmulti,float} |
| 1608 |
% \end{macrocode} |
| 1609 |
% |
| 1610 |
% The xcolor package provides driver independent access to all sorts of colour tins, |
| 1611 |
% shades, tones and mixes. I like x11names, as you can tell. |
| 1612 |
% \begin{macrocode} |
| 1613 |
\RequirePackage[x11names]{xcolor} |
| 1614 |
% \end{macrocode} |
| 1615 |
% |
| 1616 |
% The hyperref package provides layout for hyper references, such as URLs and references within a document, |
| 1617 |
% such as acronyms, citations and the table of contents. We use the option colorlings and then provide |
| 1618 |
% the colors we prefer for links (linkcolor), citations (citecolor) and URLs (urlcolor). |
| 1619 |
% \begin{macrocode} |
| 1620 |
\RequirePackage[colorlinks,% |
| 1621 |
linkcolor=Brown4,% |
| 1622 |
citecolor=SeaGreen4,% |
| 1623 |
urlcolor=RoyalBlue3% |
| 1624 |
]{hyperref} |
| 1625 |
%\RequirePackage[colorlinks,linkcolor=blue]{hyperref} |
| 1626 |
% \end{macrocode} |
| 1627 |
% |
| 1628 |
% |
| 1629 |
% \subsubsection{Memoir Options} |
| 1630 |
% |
| 1631 |
% Not sure, but I don't think semi-iso-pages are good. So not used right now. |
| 1632 |
% \begin{macrocode} |
| 1633 |
%\semiisopage |
| 1634 |
% \end{macrocode} |
| 1635 |
% |
| 1636 |
% Change the margins for even and odd pages. Odd to 1cm and even to 1cm. |
| 1637 |
% \begin{macrocode} |
| 1638 |
\setlength{\oddsidemargin}{1cm} |
| 1639 |
\setlength{\evensidemargin}{0cm} |
| 1640 |
% \end{macrocode} |
| 1641 |
% |
| 1642 |
% Set width and height for the text. At the moment only the width, to 15cm |
| 1643 |
% \begin{macrocode} |
| 1644 |
\setlength{\textwidth}{15cm} |
| 1645 |
%\setlength{\textheight}{24cm} |
| 1646 |
% \end{macrocode} |
| 1647 |
% |
| 1648 |
% Don't use chapter numbers in sections, thus making them looking like sections |
| 1649 |
% in a classic article (1 instead of the default 0.1) |
| 1650 |
% \begin{macrocode} |
| 1651 |
\def\thesection{\arabic{section}} |
| 1652 |
% \end{macrocode} |
| 1653 |
% |
| 1654 |
% Allow table of contents to go up to sub-sections |
| 1655 |
% \begin{macrocode} |
| 1656 |
\settocdepth{subsection} |
| 1657 |
% \end{macrocode} |
| 1658 |
% |
| 1659 |
% And numbering up to subsubsections |
| 1660 |
% \begin{macrocode} |
| 1661 |
\setsecnumdepth{subsubsection} |
| 1662 |
% \end{macrocode} |
| 1663 |
% |
| 1664 |
% For lists, memoir provides different layouts. We use tightlists here, but can |
| 1665 |
% switch that to firmlists if needed |
| 1666 |
% \begin{macrocode} |
| 1667 |
\tightlists |
| 1668 |
%\firmlists |
| 1669 |
% \end{macrocode} |
| 1670 |
% |
| 1671 |
% What are these for? I forgot... |
| 1672 |
% \begin{macrocode} |
| 1673 |
\midsloppy |
| 1674 |
\raggedbottom |
| 1675 |
% \end{macrocode} |
| 1676 |
% |
| 1677 |
% |
| 1678 |
% \subsubsection{Misc Settings} |
| 1679 |
% |
| 1680 |
% Finally, we do set the sort option for the bibliography to anyt (biblatex) |
| 1681 |
% \begin{macrocode} |
| 1682 |
\ExecuteBibliographyOptions{sorting=anyt} |
| 1683 |
% \end{macrocode} |
| 1684 |
% |
| 1685 |
% There is no code for \cmd{\AtBeginDocument} and \cmd{\AtEndDocument}, so we are done now. |
| 1686 |
% \begin{macrocode} |
| 1687 |
%</skbarticle> |
| 1688 |
% \end{macrocode} |
| 1689 |
% |
| 1690 |
% |
| 1691 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 1692 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 1693 |
% |
| 1694 |
% \subsection{The Class skbbook} |
| 1695 |
% |
| 1696 |
% This class is an example on how to use the \skbacft{A3DS:SKB} with memoir. I use skbbook |
| 1697 |
% for my books. Using this class as a template, one can easily write other |
| 1698 |
% classes or change/overwrite the settings done here. |
| 1699 |
% |
| 1700 |
% First, we announce the package and the font definition file. |
| 1701 |
% \begin{macrocode} |
| 1702 |
%<*skbbook> |
| 1703 |
\NeedsTeXFormat{LaTeX2e} |
| 1704 |
\ProvidesClass{skbbook}[2011/06/03 The SKB Book class v0.52] |
| 1705 |
% \end{macrocode} |
| 1706 |
% |
| 1707 |
% Now we load the memoir class with the following options: |
| 1708 |
% \begin{skbnotelist} |
| 1709 |
% \item 11pt - for 11 point font size |
| 1710 |
% \item a4paper - I am European, so A4 paper makes sense here |
| 1711 |
% \item extrafontsizes - tbd |
| 1712 |
% \item twoside - I want my articles to be set with different even/odd pages |
| 1713 |
% \item onecolumn - I don't necessarily like 2-columns for my articles |
| 1714 |
% \item openright - tbd |
| 1715 |
% \end{skbnotelist} |
| 1716 |
% \begin{macrocode} |
| 1717 |
\LoadClass[11pt,a4paper,extrafontsizes,twoside,onecolumn,openright]{memoir} |
| 1718 |
% \end{macrocode} |
| 1719 |
% |
| 1720 |
% Load the \skbacft{A3DS:SKB}. |
| 1721 |
% \begin{macrocode} |
| 1722 |
\RequirePackage{skb} |
| 1723 |
% \end{macrocode} |
| 1724 |
% |
| 1725 |
% |
| 1726 |
% \subsubsection{Loaded Packages} |
| 1727 |
% |
| 1728 |
% I prefer BibLaTeX over plain \BibTeX, and other parts of the \skbacft{A3DS:SKB} (such as the \skbacft{LAMP} |
| 1729 |
% server) produce BibLaTeX. The options are: |
| 1730 |
% \begin{skbnotelist} |
| 1731 |
% \item style - is set to alphanumeric, much better to find/remember references. |
| 1732 |
% If writing for IEEE or LNCS, numeric would be the prefered option. |
| 1733 |
% \item sorting - is set to none, not needed here. |
| 1734 |
% \item hyperref - I want to have hyperef with my citations |
| 1735 |
% \end{skbnotelist} |
| 1736 |
% \begin{macrocode} |
| 1737 |
\RequirePackage[style=alphabetic,sorting=none,hyperref]{biblatex} |
| 1738 |
% \end{macrocode} |
| 1739 |
% |
| 1740 |
% Load the acronym package and print only the acronyms actually used in the document. |
| 1741 |
% This might move into the \skbacft{A3DS:SKB} package later |
| 1742 |
% \begin{macrocode} |
| 1743 |
\RequirePackage[printonlyused]{acronym} |
| 1744 |
% \end{macrocode} |
| 1745 |
% |
| 1746 |
% Load a view packages that I tend to use quite often: |
| 1747 |
% \begin{skbnotelist} |
| 1748 |
% \item etoolbox - etoolbox |
| 1749 |
% \item comment - Add comments to your \LaTeX~files |
| 1750 |
% \item graphicx - Enhanced graphic support, with key/value interface for include graphics |
| 1751 |
% \item longtable - Helps with tables that span multiple pages |
| 1752 |
% \item colortbl - Allows coloured cells in tables |
| 1753 |
% \end{skbnotelist} |
| 1754 |
% \begin{macrocode} |
| 1755 |
\RequirePackage{etoolbox,comment,graphicx,longtable,colortbl} |
| 1756 |
% \end{macrocode} |
| 1757 |
% |
| 1758 |
% And some more packages needed quite often: |
| 1759 |
% \begin{skbnotelist} |
| 1760 |
% \item textcomp - Special characters, such as \textregistered~and \textcopyright |
| 1761 |
% \item gensymb - Generic characters (math and text mode), such as \degree, \celsius, \perthousand, \micro~and \ohm |
| 1762 |
% \item wasysym - Adds characters from \textit{wasy} font, such as \smiley, \XBox~and \rightturn |
| 1763 |
% \item units - Typeset units correctly (and produce 'nice' fractions), such as \unitfrac[10]{m}{s} and \nicefrac[\texttt]{1}{2} |
| 1764 |
% \item float - Improves interface for floating environments (such as figures, tables) |
| 1765 |
% \item xmpmulti - tbd |
| 1766 |
% \end{skbnotelist} |
| 1767 |
% \begin{macrocode} |
| 1768 |
\RequirePackage{textcomp,gensymb,wasysym,units,xmpmulti,float} |
| 1769 |
% \end{macrocode} |
| 1770 |
% |
| 1771 |
% The xcolor package provides driver independent access to all sorts of colour tins, |
| 1772 |
% shades, tones and mixes. I like x11names, as you can tell. |
| 1773 |
% \begin{macrocode} |
| 1774 |
\RequirePackage[x11names]{xcolor} |
| 1775 |
% \end{macrocode} |
| 1776 |
% |
| 1777 |
% The hyperref package provides layout for hyper references, such as URLs and references within a document, |
| 1778 |
% such as acronyms, citations and the table of contents. We use the option colorlings and then provide |
| 1779 |
% the colors we prefer for links (linkcolor), citations (citecolor) and URLs (urlcolor). |
| 1780 |
% \begin{macrocode} |
| 1781 |
\RequirePackage[colorlinks,% |
| 1782 |
linkcolor=Brown4,% |
| 1783 |
citecolor=SeaGreen4,% |
| 1784 |
urlcolor=RoyalBlue3% |
| 1785 |
]{hyperref} |
| 1786 |
%\RequirePackage[colorlinks,linkcolor=blue]{hyperref} |
| 1787 |
% \end{macrocode} |
| 1788 |
% |
| 1789 |
% |
| 1790 |
% \subsubsection{Memoir Options} |
| 1791 |
% |
| 1792 |
% Not sure, but I don't think semi-iso-pages are good. So not used right now. |
| 1793 |
% \begin{macrocode} |
| 1794 |
%\semiisopage |
| 1795 |
% \end{macrocode} |
| 1796 |
% |
| 1797 |
% Set the head styles to komalike (the other nice style is memman). |
| 1798 |
% \begin{macrocode} |
| 1799 |
\headstyles{komalike} |
| 1800 |
% \end{macrocode} |
| 1801 |
% |
| 1802 |
% Change the margins for even and odd pages. Odd to .5cm and even to 0cm. |
| 1803 |
% \begin{macrocode} |
| 1804 |
\setlength{\oddsidemargin}{.5cm} |
| 1805 |
\setlength{\evensidemargin}{0cm} |
| 1806 |
% \end{macrocode} |
| 1807 |
% |
| 1808 |
% Set width and height for the text. Width to 15cm and length t0 22cm. |
| 1809 |
% \begin{macrocode} |
| 1810 |
\setlength{\textwidth}{15cm} |
| 1811 |
\setlength{\textheight}{22cm} |
| 1812 |
% \end{macrocode} |
| 1813 |
% |
| 1814 |
% Get half a centimeter back from the topmargin. |
| 1815 |
% \begin{macrocode} |
| 1816 |
\setlength{\topmargin}{-.5cm} |
| 1817 |
% \end{macrocode} |
| 1818 |
% |
| 1819 |
% Allow table of contents to go up to subsub-sections |
| 1820 |
% \begin{macrocode} |
| 1821 |
\settocdepth{subsubsection} |
| 1822 |
% \end{macrocode} |
| 1823 |
% |
| 1824 |
% And numbering up to subsubsections |
| 1825 |
% \begin{macrocode} |
| 1826 |
\setsecnumdepth{subsubsection} |
| 1827 |
% \end{macrocode} |
| 1828 |
% |
| 1829 |
% For lists, memoir provides different layouts. We use tightlists here, but can |
| 1830 |
% switch that to firmlists if needed |
| 1831 |
% \begin{macrocode} |
| 1832 |
\tightlists |
| 1833 |
%\firmlists |
| 1834 |
% \end{macrocode} |
| 1835 |
% |
| 1836 |
% What are these for? I forgot... |
| 1837 |
% \begin{macrocode} |
| 1838 |
\midsloppy |
| 1839 |
\raggedbottom |
| 1840 |
% \end{macrocode} |
| 1841 |
% |
| 1842 |
% Chapters shoud look like the memoir veelo style. |
| 1843 |
% \begin{macrocode} |
| 1844 |
\chapterstyle{veelo} |
| 1845 |
% \end{macrocode} |
| 1846 |
% |
| 1847 |
% |
| 1848 |
% \subsubsection{Misc Settings} |
| 1849 |
% |
| 1850 |
% Finally, we do set the sort option for the bibliography to anyt (biblatex) |
| 1851 |
% \begin{macrocode} |
| 1852 |
\ExecuteBibliographyOptions{sorting=anyt} |
| 1853 |
% \end{macrocode} |
| 1854 |
% |
| 1855 |
% There is no code for \cmd{\AtBeginDocument} and \cmd{\AtEndDocument}, so we are done now. |
| 1856 |
% \begin{macrocode} |
| 1857 |
%</skbbook> |
| 1858 |
% \end{macrocode} |
| 1859 |
% |
| 1860 |
% |
| 1861 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 1862 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 1863 |
% |
| 1864 |
% \subsection{The Class skbbeamer} |
| 1865 |
% |
| 1866 |
% This class is an example on how to use the \skbacft{A3DS:SKB} with memoir. I use skbbeamer |
| 1867 |
% for my beamer presentations. Using this class as a template, one can easily write other |
| 1868 |
% classes or change/overwrite the settings done here. |
| 1869 |
% |
| 1870 |
% First, we announce the package and the font definition file and process the options. |
| 1871 |
% \begin{macrocode} |
| 1872 |
%<*skbbeamer> |
| 1873 |
\NeedsTeXFormat{LaTeX2e} |
| 1874 |
\ProvidesClass{skbbeamer}[2011/06/03 The SKB Beamer class v0.52] |
| 1875 |
\DeclareOption{beameranim}{\PassOptionsToPackage{\CurrentOption}{skb}} |
| 1876 |
\DeclareOption{beamernoanim}{\PassOptionsToPackage{\CurrentOption}{skb}} |
| 1877 |
\ProcessOptions\relax |
| 1878 |
% \end{macrocode} |
| 1879 |
% |
| 1880 |
% Now we load the xcolor package and then the beamer class. That should load the x11names some |
| 1881 |
% of the \skbacft{A3DS:SKB} listing styles use while not creating any clash between the packages beamer and xcolor. |
| 1882 |
% \begin{macrocode} |
| 1883 |
\RequirePackage[x11names]{xcolor} |
| 1884 |
\LoadClass[x11names]{beamer} |
| 1885 |
% \end{macrocode} |
| 1886 |
% |
| 1887 |
% Load the \skbacft{A3DS:SKB}. |
| 1888 |
% \begin{macrocode} |
| 1889 |
\RequirePackage{skb} |
| 1890 |
% \end{macrocode} |
| 1891 |
% |
| 1892 |
% |
| 1893 |
% \subsubsection{Loaded Packages} |
| 1894 |
% |
| 1895 |
% I prefer BibLaTeX over plain \BibTeX, and other parts of the \skbacft{A3DS:SKB} (such as the \skbacft{LAMP} |
| 1896 |
% server) produce BibLaTeX. The options are: |
| 1897 |
% \begin{skbnotelist} |
| 1898 |
% \item style - is set to alphanumeric, much better to find/remember references. |
| 1899 |
% If writing for IEEE or LNCS, numeric would be the prefered option. |
| 1900 |
% \item sorting - is set to none, not needed here. |
| 1901 |
% \item hyperref - I want to have hyperef with my citations |
| 1902 |
% \end{skbnotelist} |
| 1903 |
% \begin{macrocode} |
| 1904 |
\RequirePackage[style=alphabetic,sorting=none,hyperref]{biblatex} |
| 1905 |
% \end{macrocode} |
| 1906 |
% |
| 1907 |
% Load the acronym package and print only the acronyms actually used in the document. |
| 1908 |
% This might move into the \skbacft{A3DS:SKB} package later |
| 1909 |
% \begin{macrocode} |
| 1910 |
\RequirePackage[printonlyused]{acronym} |
| 1911 |
% \end{macrocode} |
| 1912 |
% |
| 1913 |
% Load a view packages that I tend to use quite often: |
| 1914 |
% \begin{skbnotelist} |
| 1915 |
% \item etoolbox - etoolbox |
| 1916 |
% \item comment - Add comments to your \LaTeX~files |
| 1917 |
% \item graphicx - Enhanced graphic support, with key/value interface for include graphics |
| 1918 |
% \item longtable - Helps with tables that span multiple pages |
| 1919 |
% \item colortbl - Allows coloured cells in tables |
| 1920 |
% \end{skbnotelist} |
| 1921 |
% \begin{macrocode} |
| 1922 |
\RequirePackage{etoolbox,comment,graphicx,longtable,colortbl} |
| 1923 |
% \end{macrocode} |
| 1924 |
% |
| 1925 |
% And some more packages needed quite often: |
| 1926 |
% \begin{skbnotelist} |
| 1927 |
% \item textcomp - Special characters, such as \textregistered~and \textcopyright |
| 1928 |
% \item gensymb - Generic characters (math and text mode), such as \degree, \celsius, \perthousand, \micro~and \ohm |
| 1929 |
% \item wasysym - Adds characters from \textit{wasy} font, such as \smiley, \XBox~and \rightturn |
| 1930 |
% \item units - Typeset units correctly (and produce 'nice' fractions), such as \unitfrac[10]{m}{s} and \nicefrac[\texttt]{1}{2} |
| 1931 |
% \item float - Improves interface for floating environments (such as figures, tables) |
| 1932 |
% \item xmpmulti - tbd |
| 1933 |
% \end{skbnotelist} |
| 1934 |
% \begin{macrocode} |
| 1935 |
\RequirePackage{textcomp,gensymb,wasysym,units,xmpmulti,float} |
| 1936 |
% \end{macrocode} |
| 1937 |
% |
| 1938 |
% |
| 1939 |
% \subsubsection{Misc Settings} |
| 1940 |
% |
| 1941 |
% And some default settings for the dirtree package. |
| 1942 |
% \begin{macrocode} |
| 1943 |
\renewcommand*\DTstylecomment{\itshape\sffamily\color{blue}\scriptsize} |
| 1944 |
\setlength{\DTbaselineskip}{10pt} |
| 1945 |
\DTsetlength{0.2em}{1em}{0.2em}{0.4pt}{1.6pt} |
| 1946 |
\renewcommand*\DTstyle{\scriptsize\ttfamily\textcolor{black}} |
| 1947 |
% \end{macrocode} |
| 1948 |
% |
| 1949 |
% There is no code for \cmd{\AtBeginDocument} and \cmd{\AtEndDocument}, so we are done now. |
| 1950 |
% \begin{macrocode} |
| 1951 |
%</skbbeamer> |
| 1952 |
% \end{macrocode} |
| 1953 |
% |
| 1954 |
% |
| 1955 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 1956 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 1957 |
% |
| 1958 |
% \subsection{The Class skblncsbeamer} |
| 1959 |
% |
| 1960 |
% This class is an example on how to use the \skbacft{A3DS:SKB} with memoir. I use skblncsbeamer |
| 1961 |
% for my beamer based handouts. Using this class as a template, one can easily write other |
| 1962 |
% classes or change/overwrite the settings done here. |
| 1963 |
% |
| 1964 |
% First, we announce the package and the font definition file. |
| 1965 |
% \begin{macrocode} |
| 1966 |
%<*skblncsbeamer> |
| 1967 |
\NeedsTeXFormat{LaTeX2e} |
| 1968 |
\ProvidesClass{skblncsbeamer}[2011/06/03 The SKB LNCS Beamer class v0.52] |
| 1969 |
% \end{macrocode} |
| 1970 |
% |
| 1971 |
% Just in case there is no \cmd{\titlepage} declared, the beamerarticle wants that. |
| 1972 |
% \begin{macrocode} |
| 1973 |
\providecommand{\titlepage}{} |
| 1974 |
% \end{macrocode} |
| 1975 |
% |
| 1976 |
% Now we load the memoir class with the following options: |
| 1977 |
% \begin{skbnotelist} |
| 1978 |
% \item 9pt - for 9 point font size |
| 1979 |
% \item a4paper - I am European, so A4 paper makes sense here |
| 1980 |
% \item extrafontsizes - tbd |
| 1981 |
% \item twoside - I want my articles to be set with different even/odd pages |
| 1982 |
% \item onecolumn - I don't necessarily like 2-columns for my articles |
| 1983 |
% \item openright - tbd |
| 1984 |
% \item article - use memoir as if it is an article |
| 1985 |
% \item x11names - this option will be forwarded to the xcolor/graphics packages |
| 1986 |
% \end{skbnotelist} |
| 1987 |
% \begin{macrocode} |
| 1988 |
\LoadClass[9pt,a4paper,extrafontsizes,twoside,onecolumn,openright,article,x11names]{memoir} |
| 1989 |
% \end{macrocode} |
| 1990 |
% |
| 1991 |
% For Beamer handouts, we need the beamerarticle package to load the frame thumbnails. |
| 1992 |
% \begin{macrocode} |
| 1993 |
\RequirePackage{beamerarticle,pgf} |
| 1994 |
% \end{macrocode} |
| 1995 |
% |
| 1996 |
% Load the \skbacft{A3DS:SKB}. |
| 1997 |
% \begin{macrocode} |
| 1998 |
\RequirePackage{skb} |
| 1999 |
% \end{macrocode} |
| 2000 |
% |
| 2001 |
% |
| 2002 |
% \subsubsection{Loaded Packages} |
| 2003 |
% |
| 2004 |
% I prefer BibLaTeX over plain \BibTeX, and other parts of the \skbacft{A3DS:SKB} (such as the \skbacft{LAMP} |
| 2005 |
% server) produce BibLaTeX. The options are: |
| 2006 |
% \begin{skbnotelist} |
| 2007 |
% \item style - is set to alphanumeric, much better to find/remember references. |
| 2008 |
% If writing for IEEE or LNCS, numeric would be the prefered option. |
| 2009 |
% \item sorting - is set to none, not needed here. |
| 2010 |
% \item hyperref - I want to have hyperef with my citations |
| 2011 |
% \end{skbnotelist} |
| 2012 |
% \begin{macrocode} |
| 2013 |
\RequirePackage[style=alphabetic,sorting=none,hyperref]{biblatex} |
| 2014 |
% \end{macrocode} |
| 2015 |
% |
| 2016 |
% Load the acronym package and print only the acronyms actually used in the document. |
| 2017 |
% This might move into the \skbacft{A3DS:SKB} package later. |
| 2018 |
% \begin{macrocode} |
| 2019 |
\RequirePackage[printonlyused]{acronym} |
| 2020 |
% \end{macrocode} |
| 2021 |
% |
| 2022 |
% Load a view packages that I tend to use quite often: |
| 2023 |
% \begin{skbnotelist} |
| 2024 |
% \item etoolbox - etoolbox |
| 2025 |
% \item comment - Add comments to your \LaTeX~files |
| 2026 |
% \item graphicx - Enhanced graphic support, with key/value interface for include graphics |
| 2027 |
% \item longtable - Helps with tables that span multiple pages |
| 2028 |
% \item colortbl - Allows coloured cells in tables |
| 2029 |
% \end{skbnotelist} |
| 2030 |
% \begin{macrocode} |
| 2031 |
\RequirePackage{etoolbox,comment,graphicx,longtable,colortbl} |
| 2032 |
% \end{macrocode} |
| 2033 |
% |
| 2034 |
% And some more packages needed quite often: |
| 2035 |
% \begin{skbnotelist} |
| 2036 |
% \item textcomp - Special characters, such as \textregistered~and \textcopyright |
| 2037 |
% \item gensymb - Generic characters (math and text mode), such as \degree, \celsius, \perthousand, \micro~and \ohm |
| 2038 |
% \item wasysym - Adds characters from \textit{wasy} font, such as \smiley, \XBox~and \rightturn |
| 2039 |
% \item units - Typeset units correctly (and produce 'nice' fractions), such as \unitfrac[10]{m}{s} and \nicefrac[\texttt]{1}{2} |
| 2040 |
% \item float - Improves interface for floating environments (such as figures, tables) |
| 2041 |
% \item xmpmulti - tbd |
| 2042 |
% \end{skbnotelist} |
| 2043 |
% \begin{macrocode} |
| 2044 |
\RequirePackage{textcomp,gensymb,wasysym,units,xmpmulti} |
| 2045 |
% \end{macrocode} |
| 2046 |
% |
| 2047 |
% |
| 2048 |
% \subsubsection{Memoir Options} |
| 2049 |
% |
| 2050 |
% Not sure, but I don't think semi-iso-pages are good. So not used right now. |
| 2051 |
% \begin{macrocode} |
| 2052 |
%\semiisopage |
| 2053 |
% \end{macrocode} |
| 2054 |
% |
| 2055 |
% We do want to list files. |
| 2056 |
% \begin{macrocode} |
| 2057 |
\listfiles |
| 2058 |
% \end{macrocode} |
| 2059 |
% |
| 2060 |
% Change the margins for even and odd pages. Odd to 0cm and even to 1cm. |
| 2061 |
% \begin{macrocode} |
| 2062 |
\setlength{\oddsidemargin}{0cm} |
| 2063 |
\setlength{\evensidemargin}{0cm} |
| 2064 |
% \end{macrocode} |
| 2065 |
% |
| 2066 |
% Set width and height for the text. Width to 15cm and height to 24.5cm. |
| 2067 |
% \begin{macrocode} |
| 2068 |
\setlength{\textwidth}{15cm} |
| 2069 |
\setlength{\textheight}{24.5cm} |
| 2070 |
% \end{macrocode} |
| 2071 |
% |
| 2072 |
% Get half a centimeter back from the topmargin. |
| 2073 |
% \begin{macrocode} |
| 2074 |
\setlength{\topmargin}{-1.5cm} |
| 2075 |
% \end{macrocode} |
| 2076 |
% |
| 2077 |
% Don't use chapter numbers in sections, thus making them looking like sections |
| 2078 |
% in a classic article (1 instead of the default 0.1) |
| 2079 |
% \begin{macrocode} |
| 2080 |
\def\thesection{\arabic{section}} |
| 2081 |
% \end{macrocode} |
| 2082 |
% |
| 2083 |
% Allow table of contents to go up to sub-sections |
| 2084 |
% \begin{macrocode} |
| 2085 |
\settocdepth{subsection} |
| 2086 |
% \end{macrocode} |
| 2087 |
% |
| 2088 |
% And numbering up to subsubsections |
| 2089 |
% \begin{macrocode} |
| 2090 |
\setsecnumdepth{subsubsection} |
| 2091 |
% \end{macrocode} |
| 2092 |
% |
| 2093 |
% Set the head styles to komalike (the other nice style is memman). |
| 2094 |
% \begin{macrocode} |
| 2095 |
\headstyles{komalike} |
| 2096 |
% \end{macrocode} |
| 2097 |
% |
| 2098 |
% For lists, memoir provides different layouts. We use tightlists here, but can |
| 2099 |
% switch that to firmlists if needed |
| 2100 |
% \begin{macrocode} |
| 2101 |
\tightlists |
| 2102 |
%\firmlists |
| 2103 |
% \end{macrocode} |
| 2104 |
% |
| 2105 |
% What are these for? I forgot... |
| 2106 |
% \begin{macrocode} |
| 2107 |
\midsloppy |
| 2108 |
\raggedbottom |
| 2109 |
% \end{macrocode} |
| 2110 |
% |
| 2111 |
% Set parindent to 0pt and parskip to 0.2pt. |
| 2112 |
% \begin{macrocode} |
| 2113 |
\parindent0pt |
| 2114 |
\setlength{\parskip}{0.2cm} |
| 2115 |
% \end{macrocode} |
| 2116 |
% |
| 2117 |
% \subsubsection{Misc Settings} |
| 2118 |
% |
| 2119 |
% Do an index. |
| 2120 |
% \begin{macrocode} |
| 2121 |
\makeindex |
| 2122 |
% \end{macrocode} |
| 2123 |
% |
| 2124 |
% Before we start with the actual document, we want the title slide and |
| 2125 |
% the table of contents on the first page. |
| 2126 |
% \begin{macrocode} |
| 2127 |
\AtBeginDocument{ |
| 2128 |
\resizebox{\textwidth}{!}{\includeslide{title}} |
| 2129 |
\bigskip |
| 2130 |
\tableofcontents* |
| 2131 |
\bigskip |
| 2132 |
\newpage |
| 2133 |
} |
| 2134 |
% \end{macrocode} |
| 2135 |
% |
| 2136 |
% There is no code for \cmd{\AtEndDocument}, so we are done now. |
| 2137 |
% \begin{macrocode} |
| 2138 |
%</skblncsbeamer> |
| 2139 |
% \end{macrocode} |
| 2140 |
% |
| 2141 |
% |
| 2142 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2143 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2144 |
% |
| 2145 |
% \subsection{The Class skblncsppt} |
| 2146 |
% |
| 2147 |
% This class is an example on how to use the \skbacft{A3DS:SKB} with memoir. I use skblncsppt |
| 2148 |
% for handouts (anotated slides) based on Microsoft's PPT. Reason for that is |
| 2149 |
% that the \skbacft{ISO:PDF} export and print routines in Microsoft Office 2010 no longer |
| 2150 |
% support vector images for the slide thumbnails, which renders handouts almost |
| 2151 |
% useless. So I do print the PPT slides into \skbacft{ISO:PDF} (screen resolution, that way one |
| 2152 |
% avoids frames around the slides), and then \LaTeX~to generate handouts. |
| 2153 |
% Using this class as |
| 2154 |
% a template, one can easily write other |
| 2155 |
% classes or change/overwrite the settings done here. |
| 2156 |
% |
| 2157 |
% First, we announce the package and the font definition file. |
| 2158 |
% \begin{macrocode} |
| 2159 |
%<*skblncsppt> |
| 2160 |
\NeedsTeXFormat{LaTeX2e} |
| 2161 |
\ProvidesClass{skblncsppt}[2011/06/03 The SKB LNCS PPT class v0.52] |
| 2162 |
% \end{macrocode} |
| 2163 |
% |
| 2164 |
% Now we load the memoir class with the following options: |
| 2165 |
% \begin{skbnotelist} |
| 2166 |
% \item 9pt - for 9 point font size |
| 2167 |
% \item a4paper - I am European, so A4 paper makes sense here |
| 2168 |
% \item extrafontsizes - tbd |
| 2169 |
% \item twoside - I want my articles to be set with different even/odd pages |
| 2170 |
% \item onecolumn - I don't necessarily like 2-columns for my articles |
| 2171 |
% \item openright - tbd |
| 2172 |
% \item article - use memoir as if it is an article |
| 2173 |
% \end{skbnotelist} |
| 2174 |
% \begin{macrocode} |
| 2175 |
\LoadClass[9pt,a4paper,extrafontsizes,twoside,onecolumn,openright,article]{memoir} |
| 2176 |
% \end{macrocode} |
| 2177 |
% |
| 2178 |
% Load the \skbacft{A3DS:SKB}. |
| 2179 |
% \begin{macrocode} |
| 2180 |
\RequirePackage{skb} |
| 2181 |
% \end{macrocode} |
| 2182 |
% |
| 2183 |
% |
| 2184 |
% \subsubsection{Loaded Packages} |
| 2185 |
% |
| 2186 |
% I prefer BibLaTeX over plain \BibTeX, and other parts of the \skbacft{A3DS:SKB} (such as the \skbacft{LAMP} |
| 2187 |
% server) produce BibLaTeX. The options are: |
| 2188 |
% \begin{skbnotelist} |
| 2189 |
% \item style - is set to alphanumeric, much better to find/remember references. |
| 2190 |
% If writing for IEEE or LNCS, numeric would be the prefered option. |
| 2191 |
% \item sorting - is set to none, not needed here. |
| 2192 |
% \item hyperref - I want to have hyperef with my citations |
| 2193 |
% \end{skbnotelist} |
| 2194 |
% \begin{macrocode} |
| 2195 |
\RequirePackage[style=alphabetic,sorting=none,hyperref]{biblatex} |
| 2196 |
% \end{macrocode} |
| 2197 |
% |
| 2198 |
% Load the acronym package and print only the acronyms actually used in the document. |
| 2199 |
% This might move into the \skbacft{A3DS:SKB} package later. |
| 2200 |
% \begin{macrocode} |
| 2201 |
\RequirePackage[printonlyused]{acronym} |
| 2202 |
% \end{macrocode} |
| 2203 |
% |
| 2204 |
% Load a view packages that I tend to use quite often: |
| 2205 |
% \begin{skbnotelist} |
| 2206 |
% \item etoolbox - etoolbox |
| 2207 |
% \item comment - Add comments to your \LaTeX~files |
| 2208 |
% \item graphicx - Enhanced graphic support, with key/value interface for include graphics |
| 2209 |
% \item longtable - Helps with tables that span multiple pages |
| 2210 |
% \item colortbl - Allows coloured cells in tables |
| 2211 |
% \end{skbnotelist} |
| 2212 |
% \begin{macrocode} |
| 2213 |
\RequirePackage{etoolbox,comment,graphicx,longtable,colortbl} |
| 2214 |
% \end{macrocode} |
| 2215 |
% |
| 2216 |
% And some more packages needed quite often: |
| 2217 |
% \begin{skbnotelist} |
| 2218 |
% \item textcomp - Special characters, such as \textregistered~and \textcopyright |
| 2219 |
% \item gensymb - Generic characters (math and text mode), such as \degree, \celsius, \perthousand, \micro~and \ohm |
| 2220 |
% \item wasysym - Adds characters from \textit{wasy} font, such as \smiley, \XBox~and \rightturn |
| 2221 |
% \item units - Typeset units correctly (and produce 'nice' fractions), such as \unitfrac[10]{m}{s} and \nicefrac[\texttt]{1}{2} |
| 2222 |
% \item float - Improves interface for floating environments (such as figures, tables) |
| 2223 |
% \item xmpmulti - tbd |
| 2224 |
% \end{skbnotelist} |
| 2225 |
% \begin{macrocode} |
| 2226 |
\RequirePackage{textcomp,gensymb,wasysym,units,xmpmulti,float} |
| 2227 |
% \end{macrocode} |
| 2228 |
% |
| 2229 |
% The xcolor package provides driver independent access to all sorts of colour tins, |
| 2230 |
% shades, tones and mixes. I like x11names, as you can tell. |
| 2231 |
% \begin{macrocode} |
| 2232 |
\RequirePackage[x11names]{xcolor} |
| 2233 |
% \end{macrocode} |
| 2234 |
% |
| 2235 |
% The hyperref package provides layout for hyper references, such as URLs and references within a document, |
| 2236 |
% such as acronyms, citations and the table of contents. We use the option colorlings and then provide |
| 2237 |
% the colors we prefer for links (linkcolor), citations (citecolor) and URLs (urlcolor). |
| 2238 |
% \begin{macrocode} |
| 2239 |
\RequirePackage[colorlinks,% |
| 2240 |
linkcolor=Brown4,% |
| 2241 |
citecolor=SeaGreen4,% |
| 2242 |
urlcolor=RoyalBlue3% |
| 2243 |
]{hyperref} |
| 2244 |
%\RequirePackage[colorlinks,linkcolor=blue]{hyperref} |
| 2245 |
% \end{macrocode} |
| 2246 |
% |
| 2247 |
% |
| 2248 |
% \subsubsection{Memoir Options} |
| 2249 |
% |
| 2250 |
% Not sure, but I don't think semi-iso-pages are good. So not used right now. |
| 2251 |
% \begin{macrocode} |
| 2252 |
%\semiisopage |
| 2253 |
% \end{macrocode} |
| 2254 |
% |
| 2255 |
% We do want to list files. |
| 2256 |
% \begin{macrocode} |
| 2257 |
\listfiles |
| 2258 |
% \end{macrocode} |
| 2259 |
% |
| 2260 |
% Change the margins for even and odd pages. Odd to 0cm and even to 1cm. |
| 2261 |
% \begin{macrocode} |
| 2262 |
\setlength{\oddsidemargin}{0cm} |
| 2263 |
\setlength{\evensidemargin}{0cm} |
| 2264 |
% \end{macrocode} |
| 2265 |
% |
| 2266 |
% Set width and height for the text. Width to 15cm and height to 24.5cm. |
| 2267 |
% \begin{macrocode} |
| 2268 |
\setlength{\textwidth}{15cm} |
| 2269 |
\setlength{\textheight}{24.5cm} |
| 2270 |
% \end{macrocode} |
| 2271 |
% |
| 2272 |
% Get half a centimeter back from the topmargin. |
| 2273 |
% \begin{macrocode} |
| 2274 |
\setlength{\topmargin}{-1.5cm} |
| 2275 |
% \end{macrocode} |
| 2276 |
% |
| 2277 |
% Don't use chapter numbers in sections, thus making them looking like sections |
| 2278 |
% in a classic article (1 instead of the default 0.1) |
| 2279 |
% \begin{macrocode} |
| 2280 |
\def\thesection{\arabic{section}} |
| 2281 |
% \end{macrocode} |
| 2282 |
% |
| 2283 |
% Allow table of contents to go up to sub-sections |
| 2284 |
% \begin{macrocode} |
| 2285 |
\settocdepth{subsection} |
| 2286 |
% \end{macrocode} |
| 2287 |
% |
| 2288 |
% And numbering up to subsubsections |
| 2289 |
% \begin{macrocode} |
| 2290 |
\setsecnumdepth{subsubsection} |
| 2291 |
% \end{macrocode} |
| 2292 |
% |
| 2293 |
% Set the head styles to komalike (the other nice style is memman). |
| 2294 |
% \begin{macrocode} |
| 2295 |
\headstyles{komalike} |
| 2296 |
% \end{macrocode} |
| 2297 |
% |
| 2298 |
% For lists, memoir provides different layouts. We use tightlists here, but can |
| 2299 |
% switch that to firmlists if needed |
| 2300 |
% \begin{macrocode} |
| 2301 |
\tightlists |
| 2302 |
%\firmlists |
| 2303 |
% \end{macrocode} |
| 2304 |
% |
| 2305 |
% What are these for? I forgot... |
| 2306 |
% \begin{macrocode} |
| 2307 |
\midsloppy |
| 2308 |
\raggedbottom |
| 2309 |
% \end{macrocode} |
| 2310 |
% |
| 2311 |
% We want ruled pages and arabic page numbering. |
| 2312 |
% \begin{macrocode} |
| 2313 |
\pagestyle{ruled} |
| 2314 |
\pagenumbering{arabic} |
| 2315 |
% \end{macrocode} |
| 2316 |
% |
| 2317 |
% |
| 2318 |
% \subsubsection{Misc Settings} |
| 2319 |
% |
| 2320 |
% Do an index. |
| 2321 |
% \begin{macrocode} |
| 2322 |
\makeindex |
| 2323 |
% \end{macrocode} |
| 2324 |
% |
| 2325 |
% There is no code for \cmd{\AtBeginDocument} and \cmd{\AtEndDocument}, so we are done now. |
| 2326 |
% \begin{macrocode} |
| 2327 |
%</skblncsppt> |
| 2328 |
% \end{macrocode} |
| 2329 |
% |
| 2330 |
% |
| 2331 |
% |
| 2332 |
% |
| 2333 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2334 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2335 |
% |
| 2336 |
% \subsection{The Class skbmoderncv} |
| 2337 |
% |
| 2338 |
% This class integrates the moderncv package into the \skbacft{A3DS:SKB}. I use moderncv |
| 2339 |
% for my own CV and with the \skbacft{A3DS:SKB} I am able to maintain all information while |
| 2340 |
% producing different documents (i.e. one for a research proposal, for my website, for journals, etc.). |
| 2341 |
% This class provides some macros using biblatex to create several lists of publications, i.e. a different |
| 2342 |
% list for articles, proceedings, conference papers per year, etc. |
| 2343 |
% |
| 2344 |
% First, we announce the package and the font definition file and process the options. |
| 2345 |
% \begin{macrocode} |
| 2346 |
%<*skbmoderncv> |
| 2347 |
\NeedsTeXFormat{LaTeX2e} |
| 2348 |
\ProvidesClass{skbmoderncv}[2011/06/03 The SKB Modern CV class v0.52] |
| 2349 |
% \end{macrocode} |
| 2350 |
% |
| 2351 |
% Now we load the moderncv package. By default we use an 11 point font and A4 paper. Once can change these |
| 2352 |
% settings later in a CV document. |
| 2353 |
% \begin{macrocode} |
| 2354 |
\LoadClass[11pt,a4paper]{moderncv} |
| 2355 |
% \end{macrocode} |
| 2356 |
% |
| 2357 |
% Load the \skbacft{A3DS:SKB}. |
| 2358 |
% \begin{macrocode} |
| 2359 |
\RequirePackage{skb} |
| 2360 |
% \end{macrocode} |
| 2361 |
% |
| 2362 |
% |
| 2363 |
% \subsubsection{Loaded Packages} |
| 2364 |
% |
| 2365 |
% I prefer BibLaTeX over plain \BibTeX, and other parts of the \skbacft{A3DS:SKB} (such as the \skbacft{LAMP} |
| 2366 |
% server) produce BibLaTeX. The options are: |
| 2367 |
% \begin{skbnotelist} |
| 2368 |
% \item style - is set to alphabetic, much better to find/remember references. |
| 2369 |
% If writing for IEEE or LNCS, numeric would be the prefered option. |
| 2370 |
% \item sorting - is set to ynt, year first, then author name then title. |
| 2371 |
% \item bibstyle - is set to standard, which means there are no labels (we set labels as enumerate list later). |
| 2372 |
% \item hyperref - I want to have hyperef with my citations |
| 2373 |
% \end{skbnotelist} |
| 2374 |
% \begin{macrocode} |
| 2375 |
\RequirePackage[style=alphabetic,sorting=ynt,bibstyle=standard,hyperref]{biblatex} |
| 2376 |
% \end{macrocode} |
| 2377 |
% |
| 2378 |
% Load the eurofont package for the Euro sign. |
| 2379 |
% \begin{macrocode} |
| 2380 |
\RequirePackage{eurofont} |
| 2381 |
% \end{macrocode} |
| 2382 |
% |
| 2383 |
% Load the enumitem package, which is used later to change indents on the enumerate list for publication references. |
| 2384 |
% \begin{macrocode} |
| 2385 |
\RequirePackage{enumitem} |
| 2386 |
% \end{macrocode} |
| 2387 |
% |
| 2388 |
% Load the xcolor and hyperref packages to allow painting URLs in publication references. |
| 2389 |
% \begin{macrocode} |
| 2390 |
\RequirePackage[x11names]{xcolor} |
| 2391 |
\RequirePackage[colorlinks,% |
| 2392 |
linkcolor=Brown4,% |
| 2393 |
citecolor=SeaGreen4,% |
| 2394 |
urlcolor=RoyalBlue3,% |
| 2395 |
pdftex |
| 2396 |
]{hyperref} |
| 2397 |
% \end{macrocode} |
| 2398 |
% |
| 2399 |
% |
| 2400 |
% \subsubsection{Misc Settings} |
| 2401 |
% |
| 2402 |
% Configure moderncv to use the classic layout. |
| 2403 |
% \begin{macrocode} |
| 2404 |
\moderncvtheme{classic} |
| 2405 |
% \end{macrocode} |
| 2406 |
% |
| 2407 |
% Some definitions for list symbols. |
| 2408 |
% \begin{macrocode} |
| 2409 |
\newcommand{\up}[1]{\ensuremath{^\textrm{\scriptsize#1}}} |
| 2410 |
\renewcommand{\listitemsymbol}{\textendash} |
| 2411 |
% \end{macrocode} |
| 2412 |
% |
| 2413 |
% Define a new heading for BibLaTeX doing nothing, we want to set headings manually in the CV. |
| 2414 |
% \begin{macrocode} |
| 2415 |
\defbibheading{None}{} |
| 2416 |
% \end{macrocode} |
| 2417 |
% |
| 2418 |
% \subsection{Macros} |
| 2419 |
% |
| 2420 |
% \DescribeMacro{\skbcvrefplain} |
| 2421 |
% This macro prints a list of references without any labels. It expects a list of citation references, and empty list is valid and |
| 2422 |
% and will result in an empty reference list. The macro defines a new environment for the BibTeX list adding an indent to the list |
| 2423 |
% using moderncv counters. \cmd{\hintscolumnwidth} is the left column of an entry and \cmd{\separatorcolumnwidth} is the middle column |
| 2424 |
% providing a spacer between left and right. |
| 2425 |
% |
| 2426 |
% With the new environment defined, the macro then opens a new refsgment (BibLaTeX) to group all references without impacting the overall |
| 2427 |
% reference list. It uses \cmd{\nocite} to mark all references as being used without printing them, and then \cmd{\printbibliography} for |
| 2428 |
% printing the list. The options here are: |
| 2429 |
% \begin{skbnotelist} |
| 2430 |
% \item heading - refers to the new heading we have defined earlier, called None. |
| 2431 |
% \item segment - points to the current refsegment, so only references used here will be part of the list. |
| 2432 |
% \item maxnames - the maximum names shown per entry, we want to see as many as possible. |
| 2433 |
% \item minnames - the minimum names shown per entry, we want to see as many as possible. |
| 2434 |
% \end{skbnotelist} |
| 2435 |
% \begin{macrocode} |
| 2436 |
\newcommand{\skbcvrefplain}[1]{% |
| 2437 |
\defbibenvironment{bibliography} |
| 2438 |
{\list{}{% |
| 2439 |
\setlength{\parindent}{\hintscolumnwidth} |
| 2440 |
\addtolength{\parindent}{\separatorcolumnwidth} |
| 2441 |
\leftmargin\parindent |
| 2442 |
\setlength{\parindent}{0pt} |
| 2443 |
\itemindent\parindent |
| 2444 |
\itemsep\bibitemsep |
| 2445 |
\parsep\bibparsep |
| 2446 |
}} |
| 2447 |
{\endlist} |
| 2448 |
{\item} |
| 2449 |
|
| 2450 |
\begin{refsegment} |
| 2451 |
\nocite{#1} |
| 2452 |
\printbibliography[heading=None,segment=\therefsegment,maxnames=20,minnames=20] |
| 2453 |
\end{refsegment} |
| 2454 |
} |
| 2455 |
% \end{macrocode} |
| 2456 |
% |
| 2457 |
% \DescribeMacro{\skbcvrefenum} |
| 2458 |
% This macro prints a list of references as an enumerated list, which helps to see how many entries a list has and also makes it |
| 2459 |
% easier to read the list in the final CV. It expects a list of citation references, and empty list is valid and |
| 2460 |
% and will result in an empty reference list. The macro defines a new environment for the BibTeX list using an enumerate environment, which |
| 2461 |
% was of course alreadt changed loading the enumitem package. First, we calculate the length for \cmd{\parindent} by setting it to \cmd{hintscolumnwidth}, |
| 2462 |
% addint \cmd{separatorcolumnwidth} and finally adding another 1pt to it. This will make the items of the enumeration list appear within the left column of |
| 2463 |
% the CV. We then apply a few options to the enumerate environment: |
| 2464 |
% \begin{skbnotelist} |
| 2465 |
% \item leftmargin - set to the newly calculate \cmd{\parindent}. |
| 2466 |
% \item labelsep - set to the spacer defined in moderncv \cmd{\separatorcolumnwidth}. |
| 2467 |
% \item label - set to use arabic numbers without any trailing full stop. |
| 2468 |
% \item noitemsep - no vertical separation between items, we want a small list. |
| 2469 |
% \item topsep - finally add a top separator for the items of 1pt. |
| 2470 |
% \end{skbnotelist} |
| 2471 |
% To reset \cmd{\parindent}, we set it back to 0pt once the enumerate environment is closed. |
| 2472 |
% |
| 2473 |
% With the new environment defined, the macro then opens a new refsgment (BibLaTeX) to group all references without impacting the overall |
| 2474 |
% reference list. It uses \cmd{\nocite} to mark all references as being used without printing them, and then \cmd{\printbibliography} for |
| 2475 |
% printing the list. The options here are: |
| 2476 |
% \begin{skbnotelist} |
| 2477 |
% \item heading - refers to the new heading we have defined earlier, called None. |
| 2478 |
% \item segment - points to the current refsegment, so only references used here will be part of the list. |
| 2479 |
% \item maxnames - the maximum names shown per entry, we want to see as many as possible. |
| 2480 |
% \item minnames - the minimum names shown per entry, we want to see as many as possible. |
| 2481 |
% \end{skbnotelist} |
| 2482 |
% \begin{macrocode} |
| 2483 |
\newcommand{\skbcvrefenum}[1]{% |
| 2484 |
\defbibenvironment{bibliography} |
| 2485 |
{\setlength{\parindent}{\hintscolumnwidth} |
| 2486 |
\addtolength{\parindent}{\separatorcolumnwidth} |
| 2487 |
\addtolength{\parindent}{1pt} |
| 2488 |
\begin{enumerate}[leftmargin=\parindent,labelsep=\separatorcolumnwidth,label*=\arabic*,noitemsep,topsep=1pt]{% |
| 2489 |
}} |
| 2490 |
{\end{enumerate}% |
| 2491 |
\setlength{\parindent}{0pt} |
| 2492 |
} |
| 2493 |
{\item} |
| 2494 |
|
| 2495 |
\begin{refsegment} |
| 2496 |
\nocite{#1} |
| 2497 |
\printbibliography[heading=None,segment=\therefsegment,maxnames=20,minnames=20] |
| 2498 |
\end{refsegment} |
| 2499 |
} |
| 2500 |
% \end{macrocode} |
| 2501 |
% |
| 2502 |
% |
| 2503 |
% There is no code for \cmd{\AtBeginDocument} and \cmd{\AtEndDocument}, so we are done now. |
| 2504 |
% \begin{macrocode} |
| 2505 |
%</skbmoderncv> |
| 2506 |
% \end{macrocode} |
| 2507 |
% |
| 2508 |
% |
| 2509 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2510 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2511 |
% |
| 2512 |
% |
| 2513 |
%^^A \skbinput[from=rep,level=section]{history} |
| 2514 |
% |
| 2515 |
%\section{History and Change Log} |
| 2516 |
% |
| 2517 |
%\subsection{v0.10 from 06-Jul-2010} |
| 2518 |
% |
| 2519 |
%\begin{skbnotelist} |
| 2520 |
% \item first source forge release of the skb |
| 2521 |
% \item at this stage a collection of .sty and .tex files |
| 2522 |
% \item documentation in a separate pdf file |
| 2523 |
% \item included acronym list |
| 2524 |
%\end{skbnotelist} |
| 2525 |
% |
| 2526 |
% |
| 2527 |
%\subsection{v0.20 from 08-Jul-2010} |
| 2528 |
% |
| 2529 |
%\begin{skbnotelist} |
| 2530 |
% \item first \LaTeX~package version of the skb |
| 2531 |
% \item no changes in the documentation and no change in commands |
| 2532 |
% \item removed acronym list |
| 2533 |
%\end{skbnotelist} |
| 2534 |
% |
| 2535 |
% |
| 2536 |
%\subsection{v0.30 from 14-Jul-2010} |
| 2537 |
% |
| 2538 |
%\begin{skbnotelist} |
| 2539 |
% \item First dtx release of the skb, including the package and all classes introduced in v0.2 |
| 2540 |
% \item Integrated parts of the v0.1 pdf as documentation and added documentation for many commands (not finished though) |
| 2541 |
% \item Re-write of all load commands (publish, repository, figures, acronyms, bib) and rename of all old load commands, new command names use only lowercases in their names |
| 2542 |
% \item In rewrite, many commands could be removed w/o losing their functionality |
| 2543 |
% \item New Commands: |
| 2544 |
% \begin{skbnotelist} |
| 2545 |
% \item \lstinline[basicstyle=\ttfamily]{\skbfigure} -- load figures with some options |
| 2546 |
% \item \lstinline[basicstyle=\ttfamily]{\skbinput} -- load files with some options |
| 2547 |
% \item \lstinline[basicstyle=\ttfamily]{\skbheading} -- set heading text in a file loaded |
| 2548 |
% \item \lstinline[basicstyle=\ttfamily]{\skbheadingudc} -- set heading relatively to the last heading level (up, down, current) (experimental) |
| 2549 |
% \item \lstinline[basicstyle=\ttfamily]{\skbem} -- emphasise code using options |
| 2550 |
% \item \lstinline[basicstyle=\ttfamily]{\skbacft} -- rename of \lstinline[basicstyle=\ttfamily]{\SkbAcFT} |
| 2551 |
% \item \lstinline[basicstyle=\ttfamily]{\skbacronyms} -- rename of \lstinline[basicstyle=\ttfamily]{\SkbLoadAcronyms} |
| 2552 |
% \item \lstinline[basicstyle=\ttfamily]{\skbbibtex} -- rename of \lstinline[basicstyle=\ttfamily]{\SkbLoadBibtex} |
| 2553 |
% \item environment \lstinline[basicstyle=\ttfamily]{skbnotelist} -- itemize list with \lstinline[basicstyle=\ttfamily]{\parskip 0} and \lstinline[basicstyle=\ttfamily]{\itemskip 0} |
| 2554 |
% \item environment \lstinline[basicstyle=\ttfamily]{skbnoteenum} -- enumerate list with \lstinline[basicstyle=\ttfamily]{\parskip 0} and \lstinline[basicstyle=\ttfamily]{\itemskip 0} |
| 2555 |
% \end{skbnotelist} |
| 2556 |
% \item Replaced Commands: |
| 2557 |
% \begin{skbnotelist} |
| 2558 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbSetTitle} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbheading} |
| 2559 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbFigure} $\mapsto$ removed, closest is \lstinline[basicstyle=\ttfamily]{\skbfigure} (but changed behaviour!) |
| 2560 |
% \item \lstinline[basicstyle=\ttfamily]{\listingInline} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbem[code]} |
| 2561 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbEmIT} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbem[italic]} |
| 2562 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbEmBF} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbem[bold]} |
| 2563 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbAcFT} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbacft} |
| 2564 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbLoadAcronyms} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbacronyms} |
| 2565 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbLoadBibtex} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbbibtex} |
| 2566 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbLoadRepository} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbinput[from=rep]} |
| 2567 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbLoadPublish} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbinput[from=pub]} |
| 2568 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbItemizeBegin} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\begin{skbnotelist} |
| 2569 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbItemizeEnd} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\end{skbnotelist} |
| 2570 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbEnumerateBegin} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\begin{skbnoteenum} |
| 2571 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbEnumerateEnd} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\end{skbnoteenum} |
| 2572 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbFigureBeamerTextWidth} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbfigure[width=##]} |
| 2573 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbFigureBeamerTextHeight} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbfigure[height=##]} |
| 2574 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbFigureBeamerNoResize} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbfigure[]} |
| 2575 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbFigureBeamerTextWidthPDFMulti} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbfigure[multiinclude=##]} |
| 2576 |
% \end{skbnotelist} |
| 2577 |
%\end{skbnotelist} |
| 2578 |
% |
| 2579 |
% |
| 2580 |
%\subsection{v0.31 from 20-Jul-2010} |
| 2581 |
% |
| 2582 |
%\begin{skbnotelist} |
| 2583 |
% \item fixed space problem in \cmd{\skbem} |
| 2584 |
% \item added error handling to the options skbconfig and skbheading |
| 2585 |
% \item added error handling for skbinput related macros |
| 2586 |
% \item separated documentation, skb.dtx is now using itself to create the documentation |
| 2587 |
% \item removed old code: DeclareOptions (none declared) |
| 2588 |
% \item changed a lot in the documentation |
| 2589 |
% \item prepare for CTAN submission, i.e. adding README and other things |
| 2590 |
% |
| 2591 |
% \item New Commands: |
| 2592 |
% \begin{skbnotelist} |
| 2593 |
% \item \lstinline[basicstyle=\ttfamily]{\skbconfig} -- change the path/file options |
| 2594 |
% \item \lstinline[basicstyle=\ttfamily]{\skbsubject} -- add subject information for PDF |
| 2595 |
% \item \lstinline[basicstyle=\ttfamily]{\subkeywords} -- add keyword information for PDF |
| 2596 |
% \item \lstinline[basicstyle=\ttfamily]{\skbpdfinfo} -- generate PDF information |
| 2597 |
% \end{skbnotelist} |
| 2598 |
% |
| 2599 |
% \item Changed Commands: |
| 2600 |
% \begin{skbnotelist} |
| 2601 |
% \item \lstinline[basicstyle=\ttfamily]{\skbfigure} -- added option for position, moved caption/label from argument to option |
| 2602 |
% \item \lstinline[basicstyle=\ttfamily]{\title} -- re-newed to store PDF info information (experimental) |
| 2603 |
% \item \lstinline[basicstyle=\ttfamily]{\author} -- re-newed to store PDF info information (experimental) |
| 2604 |
% \end{skbnotelist} |
| 2605 |
% |
| 2606 |
% \item Replaced Commands: |
| 2607 |
% \begin{skbnotelist} |
| 2608 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbCodeInline} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbcode} |
| 2609 |
% \end{skbnotelist} |
| 2610 |
% |
| 2611 |
%\end{skbnotelist} |
| 2612 |
% |
| 2613 |
% |
| 2614 |
%\subsection{v0.32 from 20-Jul-2010} |
| 2615 |
% |
| 2616 |
%\begin{skbnotelist} |
| 2617 |
% \item fastest re-release, I had built-in some problems and excluded important code in v0.31, fixed now |
| 2618 |
%\end{skbnotelist} |
| 2619 |
% |
| 2620 |
% |
| 2621 |
%\subsection{v0.4 from 21-Jul-2010} |
| 2622 |
% |
| 2623 |
%\begin{skbnotelist} |
| 2624 |
% \item major re-write of the kernel subsequently the documentation. Most internal macros will have been |
| 2625 |
% changed or removed, some are added. Also re-arranged the macros in the dtx file to (hopefully) |
| 2626 |
% optimise the documentation |
| 2627 |
% \item added input for skb.cfg and skblocal.cfg to overwrite package options with configuration files |
| 2628 |
% \item added skb.cfg to the distribution |
| 2629 |
% |
| 2630 |
% \item New Commands: |
| 2631 |
% \begin{skbnotelist} |
| 2632 |
% \item \lstinline[basicstyle=\ttfamily]{\skbpathroot} -- returns current root path |
| 2633 |
% \item \lstinline[basicstyle=\ttfamily]{\skbfileroot} -- returns root/\#1 |
| 2634 |
% \item \lstinline[basicstyle=\ttfamily]{\skbfileacr} -- returns current acronym path and file |
| 2635 |
% \item \lstinline[basicstyle=\ttfamily]{\skbfilebib} -- returns current bibtex path and file |
| 2636 |
% \item \lstinline[basicstyle=\ttfamily]{\skbpathbib} -- returns current bibtex path |
| 2637 |
% \item \lstinline[basicstyle=\ttfamily]{\skbfilerep} -- returns rep/\#1 |
| 2638 |
% \item \lstinline[basicstyle=\ttfamily]{\skbfilepub} -- returns pub/\#1 |
| 2639 |
% \item \lstinline[basicstyle=\ttfamily]{\skbfilefig} -- returns fig/\#1 |
| 2640 |
% \item \lstinline[basicstyle=\ttfamily]{\skbfilesli} -- returns sli/\#1 |
| 2641 |
% \item \lstinline[basicstyle=\ttfamily]{\skboptionsused} -- prints a warning with change log of otptions and current values |
| 2642 |
% \end{skbnotelist} |
| 2643 |
% |
| 2644 |
% \item Changed Commands: |
| 2645 |
% \begin{skbnotelist} |
| 2646 |
% \item \lstinline[basicstyle=\ttfamily]{\skbconfig} -- added parameter to identify origin of the configuration change |
| 2647 |
% \end{skbnotelist} |
| 2648 |
% |
| 2649 |
% \item Replaced Commands: |
| 2650 |
% \begin{skbnotelist} |
| 2651 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbPathBib} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbpathbib} |
| 2652 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbPathFig} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbfilefig} |
| 2653 |
% \end{skbnotelist} |
| 2654 |
% |
| 2655 |
%\end{skbnotelist} |
| 2656 |
% |
| 2657 |
% |
| 2658 |
%\subsection{v0.5 from 04-Aug-2010} |
| 2659 |
% |
| 2660 |
%\begin{skbnotelist} |
| 2661 |
% \item this is the first version on CTAN: http://www.ctan.org/tex-archive/macros/latex/contrib/skb/ |
| 2662 |
% \item added example describing how the SKB uses itself to create parts of its documentation |
| 2663 |
% \item removed the redefinition of \cmd{\title} and \cmd{\author}, since they intererred with the beamer package definitions of these macros. |
| 2664 |
% added \cmd{\skbtitle} and \cmd{\skbauthor} instead. |
| 2665 |
% \item added RequiredPackage in the class skbbeamer before loading beamer to load xcolors with x11names |
| 2666 |
% \item added test for nemoir class: if loaded, then skbnotelist and skbnoteenum will have no effect; if not loaded, then the package |
| 2667 |
% booktabs will be loaded (for top/mid/bottomrule |
| 2668 |
% \item added test for beamer package: depending if beamer or beamerarticle are loaded, the SKB will initialise a few newe ifs |
| 2669 |
% \item added required package dirtree, and redefinition of some dirtree styles |
| 2670 |
% \item added two options to the SKB package: beameranim and beamernoanim |
| 2671 |
% \item added the package versions with the environments: skbmodetext, skbmodenote and skbmodeslide |
| 2672 |
% \item added the package optional with the options: text, note, slide, anim and noanim |
| 2673 |
% \item internally, the package optional also provides memoir |
| 2674 |
% \item changed the documentation, moved manual description to user guide in folder /doc, moved history.tex into the dtx file and |
| 2675 |
% changed most of the actual documentation (still not finished though) |
| 2676 |
% \item skbbeamer: corrected load of beamer package |
| 2677 |
% \item skblncsbeamer: moved load of skb after beamerarticle to allow skb to create proper options |
| 2678 |
% \item added \cmd{\providecommand} for \cmd{DescribeMacro} and \cmd{\cmd}, so that we can use the user-guide in the dtx and stand-alone |
| 2679 |
% \item added conditional load of skb.dtx in the driver |
| 2680 |
% \item changed the sequence of definitions in the dtx file, again, hopefully the last time |
| 2681 |
% |
| 2682 |
% \item Bug Fixes (SF=sourceforge): |
| 2683 |
% \begin{skbnotelist} |
| 2684 |
% \item SF\#3032749 (skboptionsused doesn't work) -- fixed, changed \lstinline[basicstyle=\ttfamily]{\skb@setCfgVars} |
| 2685 |
% \item SF\#3032752 (history section for v0.4 has wrong date) -- fixed, changed the heading |
| 2686 |
% \item SF\#3032754 (skb.cfg missing/empty) -- fixed, changed the installer (skb.ins) to generate it and my local scripts to put it into /run |
| 2687 |
% \item SF\#3033124 (renewcommand title/author doesn't work) -- fixed, no renewcommand anymore, two new commands to set author/title for pdfinfo |
| 2688 |
% \item SF\#3038935 (skbinput not working w/o from) -- fixed, can load from root directory now |
| 2689 |
% \end{skbnotelist} |
| 2690 |
% |
| 2691 |
% \item New Commands: |
| 2692 |
% \begin{skbnotelist} |
| 2693 |
% \item \lstinline[basicstyle=\ttfamily]{\skbtitle} -- title for PDF info |
| 2694 |
% \item \lstinline[basicstyle=\ttfamily]{\skbauthor} -- author for PDF info |
| 2695 |
% \item \lstinline[basicstyle=\ttfamily]{\skbslide} -- load slides and annotations |
| 2696 |
% \item \lstinline[basicstyle=\ttfamily]{\skbslidecite} -- for citations on slide annotation pages |
| 2697 |
% \end{skbnotelist} |
| 2698 |
% |
| 2699 |
% \item Changed Commands: |
| 2700 |
% \begin{skbnotelist} |
| 2701 |
% \item \lstinline[basicstyle=\ttfamily]{\skbinput} -- added option to load tex files from figures directory (option fig) |
| 2702 |
% \end{skbnotelist} |
| 2703 |
% |
| 2704 |
% \item Replaced Commands: |
| 2705 |
% \begin{skbnotelist} |
| 2706 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbLoadSlideNotes} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbslide} with option annotate and first argument only |
| 2707 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbLoadSlideNotesDifferent} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbslide} with option annotate and both arguments |
| 2708 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbLoadSlideNotesExtern} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbslide} with option annotate and both arguments and option notefrom set |
| 2709 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbLoadSlideNotes} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbslide} without annotate and first argument only |
| 2710 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbLoadSlideOnlyNotes} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbslide} with option annotate and second argument only |
| 2711 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbSlideSource} $\mapsto$ replaced by \lstinline[basicstyle=\ttfamily]{\skbslidecite} |
| 2712 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbBeamerAnimtrue} $\mapsto$ replaced by options beameranim and beamernoanim for skbbeamer |
| 2713 |
% \item \lstinline[basicstyle=\ttfamily]{\SkbBeamerAnimtrue} $\mapsto$ usage of this if replaced by \cmd{\opt} with anim and noanim |
| 2714 |
% \end{skbnotelist} |
| 2715 |
% |
| 2716 |
%\end{skbnotelist} |
| 2717 |
% |
| 2718 |
% |
| 2719 |
%\subsection{v0.51 from 12-May-2011} |
| 2720 |
% |
| 2721 |
%\begin{skbnotelist} |
| 2722 |
% \item worked on the documentation, lots of changes |
| 2723 |
% \item fixed a typo in skb.cfg, which made the bibliography file unloadable |
| 2724 |
% \item changed linkcolor from AntiqueWhite4 to Brown4 |
| 2725 |
% \item added acronym database (short version of the automatically generated) and acronym handling in the documentation |
| 2726 |
% \item removed \cmd{\SKB}, appropriately it's now an acronym rather than a special type setting |
| 2727 |
% \item added bibtex load to the documentation |
| 2728 |
% \item removed call to \cmd{\skbbibtex} from class files, users need to call that now manually. reason is that otherwise |
| 2729 |
% configuration changes for bib/bibfile have no effect |
| 2730 |
% \item changed load mechanism for the user guide, due to bibtex load problems |
| 2731 |
% \item changed the two skbnote environments (list/enum), removed unnecessary temp storage |
| 2732 |
% \item changed default acronym file name to acronyms, note the added 's' |
| 2733 |
% \item added skbmoderncv class using the moderncv package and adding some macros for reference lists using biblatex |
| 2734 |
%\end{skbnotelist} |
| 2735 |
% |
| 2736 |
% |
| 2737 |
%\subsection{v0.52 from 03-Jun-2011} |
| 2738 |
% |
| 2739 |
%\begin{skbnotelist} |
| 2740 |
% \item changed directory and package structure to be CTAN conform |
| 2741 |
% \item re-worked README to reflect new package structure, and added information on generating files from the source |
| 2742 |
%\end{skbnotelist} |
| 2743 |
% |
| 2744 |
% |
| 2745 |
% |
| 2746 |
% |
| 2747 |
%\section*{Acronyms} |
| 2748 |
% \skbacronyms |
| 2749 |
% |
| 2750 |
%\printbibliography |
| 2751 |
% |
| 2752 |
% |
| 2753 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2754 |
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2755 |
% |
| 2756 |
% |
| 2757 |
% \Finale |
| 2758 |
\endinput |
| 2759 |
% |
| 2760 |
%% \CharacterTable |
| 2761 |
%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z |
| 2762 |
%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z |
| 2763 |
%% Digits \0\1\2\3\4\5\6\7\8\9 |
| 2764 |
%% Exclamation \! Double quote \" Hash (number) \# |
| 2765 |
%% Dollar \$ Percent \% Ampersand \& |
| 2766 |
%% Acute accent \' Left paren \( Right paren \) |
| 2767 |
%% Asterisk \* Plus \+ Comma \, |
| 2768 |
%% Minus \- Point \. Solidus \/ |
| 2769 |
%% Colon \: Semicolon \; Less than \< |
| 2770 |
%% Equals \= Greater than \> Question mark \? |
| 2771 |
%% Commercial at \@ Left bracket \[ Backslash \\ |
| 2772 |
%% Right bracket \] Circumflex \^ Underscore \_ |
| 2773 |
%% Grave accent \` Left brace \{ Vertical bar \| |
| 2774 |
%% Right brace \} Tilde \~} |
| 2775 |
|