| 1 |
%%^^A%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2 |
%\iffalse |
| 3 |
%% Purpose: |
| 4 |
%% A package for typesetting Information Maps. |
| 5 |
%% |
| 6 |
%% Documentation: |
| 7 |
%% The documentation can be generated from the original file |
| 8 |
%% limap.dtx with the doc class/package. LaTeX the file limap.tex |
| 9 |
%% to get the full documentation in pdf format. |
| 10 |
%% |
| 11 |
%% Author: Gerd Neugebauer |
| 12 |
%% Brechklinge 10 |
| 13 |
%% 69256 Mauer (Germany) |
| 14 |
%% Mail: [email protected] |
| 15 |
%% |
| 16 |
%% Copyright (C) 1999-2026 Gerd Neugebauer |
| 17 |
%% |
| 18 |
%% limap.dtx may be distributed under the terms of the LaTeX Project |
| 19 |
%% Public License version 1.3c, as described in lppl.txt. |
| 20 |
%% |
| 21 |
%% This class is still under development and may be replaced with a |
| 22 |
%% new version which provides an enhanced functionality. |
| 23 |
%% |
| 24 |
%\fi |
| 25 |
%^^A%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 26 |
% |
| 27 |
% \title{\texttt{limap}: A \LaTeX\ Package and Class for Typesetting Information Maps} |
| 28 |
% \author{Gerd Neugebauer\\\normalsize |
| 29 |
% Net: \texttt{\href{mailto:[email protected]}{[email protected]}}} |
| 30 |
% \hypersetup{ |
| 31 |
% pdftitle = {limap}, |
| 32 |
% pdfsubject = {A LaTeX Package for Typesetting Information Maps}, |
| 33 |
% pdfauthor = {Gerd Neugebauer}, |
| 34 |
% } |
| 35 |
% |
| 36 |
% \date{This file documents \filename\ version \fileversion\ as of |
| 37 |
% \filedate.\\ Documentation date: \docdate} |
| 38 |
% |
| 39 |
% \maketitle |
| 40 |
% |
| 41 |
%^^A%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 42 |
% \changes{1.0}{2000/03/01}{First public release.} |
| 43 |
% \changes{2.0}{2016/04/16}{Fix in |MapTableofContents|: Trailing percent made unnecessary} |
| 44 |
% \changes{2.0}{2016/04/16}{Extensions integrated into the package. |
| 45 |
% Documentation improved.} |
| 46 |
% \changes{2.0}{2016/04/14}{Renamed |MapTOCemph| to |MapTOCheadfont|.} |
| 47 |
% \changes{2.0}{2016/04/15}{Renamed |MapTitleSize| to |MapTitleFont|.} |
| 48 |
% \changes{2.0}{2016/04/16}{Renamed |MapTitlefraction| to |MapTitleFraction|.} |
| 49 |
% \changes{2.0}{2016/04/16}{Environment |MapTabular| added} |
| 50 |
% \changes{2.0}{2016/04/16}{Renamed |MapTextfraction| to |MapTextFraction|.} |
| 51 |
% \changes{2.0}{2016/04/16}{Parameter |MapBlockLabelFont| introduced.} |
| 52 |
% \changes{2.0}{2016/04/16}{Parameter |MapBlockLabelFont| introduced.} |
| 53 |
% \changes{2.0}{2016/04/17}{Renamed |MapTitleContinuedSize| to |MapTitleContinuedFont|.} |
| 54 |
% \changes{2.0}{2016/05/22}{TOC Re-engineered to allow |
| 55 |
% interaction with hyperref.} |
| 56 |
% \changes{2.0}{2016/05/22}{Option |nolines| added.} |
| 57 |
% \changes{2.1}{2016/05/24}{|WideBlock| fixed and samples added.} |
| 58 |
% \changes{2.1}{2016/05/26}{|MapTabularFraction| added.} |
| 59 |
% \changes{2.2}{2026/05/17}{Contact updated.} |
| 60 |
% \changes{2.3}{2026/05/20}{Repository migrated.} |
| 61 |
%^^A%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 62 |
% |
| 63 |
% \DoNotIndex{\ ,\",\',\.,\[,\\,\],\^,\`,\~,\@,\@author,\@auxout} |
| 64 |
% \DoNotIndex{\@currentlabel,\@currenvir,\@date} |
| 65 |
% \DoNotIndex{\@dottedtocline,\@gobble,\@gobbletwo,\@highpenalty} |
| 66 |
% \DoNotIndex{\@ifnextchar,\@ifstar,\@ifundefined} |
| 67 |
% \DoNotIndex{\@namedef,\@nameuse,\@pnumwidth,\@startsection,\@starttoc} |
| 68 |
% \DoNotIndex{\@tempdima,\@title,\@thefnmark,\@undefined} |
| 69 |
% \DoNotIndex{\@ixpt,\@vpt,\@vipt,\@viipt,\@viiipt} |
| 70 |
% \DoNotIndex{\@xpt,\@xipt,\@xiipt,\@xivpt,\@xvii,\@xxpt,\@xxvpt} |
| 71 |
% \DoNotIndex{\AA,\AE,\CodelineIndex,\CurrentOption} |
| 72 |
% \DoNotIndex{\DescribeEnv,\DescribeMacro,\DeclareOption,\DeleteShortVerb,\DocInput} |
| 73 |
% \DoNotIndex{\EnableCrossrefs,\H,\InputIfFileExists} |
| 74 |
% \DoNotIndex{\L,\LARGE,\LaTeX,\Large} |
| 75 |
% \DoNotIndex{\LoadClass,\NeedsTeXFormat,\O,\OE,\OptionNotUsed} |
| 76 |
% \DoNotIndex{\PackageError,\PackageWarning,\PassOptionsToClass} |
| 77 |
% \DoNotIndex{\ProcessOptions,\ProvidesClass,\PrintDescribeEnv,\PrintDescribeMacro} |
| 78 |
% \DoNotIndex{\PrintChanges,\PrintIndex} |
| 79 |
% \DoNotIndex{\ProvidesPackage,\R,\RecordChanges,\RequirePackage,\TeX} |
| 80 |
% \DoNotIndex{\SpecialEnvIndex,\SpecialUsageIndex} |
| 81 |
% \DoNotIndex{\aa,\addcontentsline,\addpenalty,\addtolength,\advance} |
| 82 |
% \DoNotIndex{\addvspace,\ae,\ast,\arabic} |
| 83 |
% \DoNotIndex{\b,\baselineskip,\begin,\begingroup,\bfseries,\bgroup} |
| 84 |
% \DoNotIndex{\bigskip,\bottomrule,\box,\bullet} |
| 85 |
% \DoNotIndex{\c,\cal,\catcode,\centering,\chapter,\chardef,\circ} |
| 86 |
% \DoNotIndex{\cfoot,\clearpage,\closein,\closeout} |
| 87 |
% \DoNotIndex{\clubpenalty,\color,\csname} |
| 88 |
% \DoNotIndex{\d,\def,\dimen,\diamond,\divide,\documentclass,\dots,\dp} |
| 89 |
% \DoNotIndex{\definecolor} |
| 90 |
% \DoNotIndex{\edef,\egroup,\else,\em,\emph,\empty,\end,\endcsname} |
| 91 |
% \DoNotIndex{\endgroup,\endinput,\endlist} |
| 92 |
% \DoNotIndex{\expandafter,\fbox,\fi,\footnotesize,\footskip,\framebox} |
| 93 |
% \DoNotIndex{\frenchspacing,\futurelet,\gdef,\global,\gobble} |
| 94 |
% \DoNotIndex{\hangafter,\hangindent,\hbox,\headheight,\headsep,\hfil} |
| 95 |
% \DoNotIndex{\hfill,\hrule,\hskip,\hspace,\hss,\ht,\huge,\hypersetup} |
| 96 |
% \DoNotIndex{\ifcat,\ifeof} |
| 97 |
% \DoNotIndex{\ifdim,\ifnum,\iftrue,\ifx,\ignorespaces,\immediate,\index} |
| 98 |
% \DoNotIndex{\input,\it} |
| 99 |
% \DoNotIndex{\itemindent,\itemsep,\jobname,\kern,\l,\labelsep,\labelwidth} |
| 100 |
% \DoNotIndex{\large,\leavevmode,\leftmark,\leftskip,\let,\lhead,\list} |
| 101 |
% \DoNotIndex{\llap,\long,\lower} |
| 102 |
% \DoNotIndex{\makeatletter,\makeatother} |
| 103 |
% \DoNotIndex{\m@th,\makebox,\magstep,\makeindex,\markboth,\mbox,\medskip} |
| 104 |
% \DoNotIndex{\marginpar,\midrule,\multicolumn} |
| 105 |
% \DoNotIndex{\newblock,\newcommand,\newcount,\newenvironment,\newfont} |
| 106 |
% \DoNotIndex{\newif,\newlength,\newline,\newpage,\newread,\newwrite} |
| 107 |
% \DoNotIndex{\nobreak,\noindent,\normalsize,\null} |
| 108 |
% \DoNotIndex{\o,\oddsidemargin,\oe,\openin,\openout,\or} |
| 109 |
% \DoNotIndex{\pagestyle,\par,\paragraph,\parbox} |
| 110 |
% \DoNotIndex{\parfillskip,\parindent,\parsep,\parskip,\part,\partopsep} |
| 111 |
% \DoNotIndex{\penalty,\providecommand,\quad} |
| 112 |
% \DoNotIndex{\raggedbottom,\raggedright,\raise,\raisebox,\refstepcounter} |
| 113 |
% \DoNotIndex{\relax,\renewcommand,\renewenvironment,\rhead} |
| 114 |
% \DoNotIndex{\rightskip,\rm,\rule} |
| 115 |
% \DoNotIndex{\sbox,\sc,\section,\setcounter,\setlength,\settowidth} |
| 116 |
% \DoNotIndex{\sf,\sfcode,\sl} |
| 117 |
% \DoNotIndex{\sloppy,\small,\space,\ss,\string} |
| 118 |
% \DoNotIndex{\setsansfont,\setmonofont,\setmainfont} |
| 119 |
% \DoNotIndex{\subparagraph,\subsubparagraph} |
| 120 |
% \DoNotIndex{\subsection,\subsubsection,\symbol} |
| 121 |
% \DoNotIndex{\t,\tenex,\textheight,\textit,\textsf,\textstyle,\textwidth} |
| 122 |
% \DoNotIndex{\textrm,\the,\thepage,\thispagestyle,\textregistered} |
| 123 |
% \DoNotIndex{\topmargin,\toprule,\topsep,\tt,\typeout} |
| 124 |
% \DoNotIndex{\u,\unitlength,\usecounter,\usepackage,\usetikzlibrary} |
| 125 |
% \DoNotIndex{\v,\varepsilon,\vbox} |
| 126 |
% \DoNotIndex{\vfill,\vsize,\voffset,\vskip,\vspace,\vss} |
| 127 |
% \DoNotIndex{\wd,\widowpenalty,\write,\xdef,\z@,\(,\)} |
| 128 |
% |
| 129 |
%^^A%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 130 |
% \CheckSum{813} |
| 131 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 132 |
%% \CharacterTable |
| 133 |
%% {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 |
| 134 |
%% 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 |
| 135 |
%% Digits \0\1\2\3\4\5\6\7\8\9 |
| 136 |
%% Exclamation \! Double quote \" Hash (number) \# |
| 137 |
%% Dollar \$ Percent \% Ampersand \& |
| 138 |
%% Acute accent \' Left paren \( Right paren \) |
| 139 |
%% Asterisk \* Plus \+ Comma \, |
| 140 |
%% Minus \- Point \. Solidus \/ |
| 141 |
%% Colon \: Semicolon \; Less than \< |
| 142 |
%% Equals \= Greater than \> Question mark \? |
| 143 |
%% Commercial at \@ Left bracket \[ Backslash \\ |
| 144 |
%% Right bracket \] Circumflex \^ Underscore \_ |
| 145 |
%% Grave accent \` Left brace \{ Vertical bar \| |
| 146 |
%% Right brace \} Tilde \~} |
| 147 |
%% |
| 148 |
%^^A%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 149 |
% |
| 150 |
% \begin{Abstract} |
| 151 |
% The Information Mapping\R method provides a methodology for |
| 152 |
% structuring and presenting information. It claims to be useful |
| 153 |
% for readers who are more concerned about finding the right |
| 154 |
% information than reading the document as a whole. Thus short, |
| 155 |
% highly structured, and context free pieces of information are |
| 156 |
% used. |
| 157 |
% |
| 158 |
% \texttt{limap} provides a \LaTeX{} package and a \LaTeX{} |
| 159 |
% class. The package contains definitions to typeset maps and |
| 160 |
% blocks according to the Information Mapping\R method. The class |
| 161 |
% provides all definitions to typeset a whole document. |
| 162 |
% \end{Abstract} |
| 163 |
% |
| 164 |
% \newpage |
| 165 |
% \begin{Map}{} |
| 166 |
% \vspace*{-6ex}% |
| 167 |
% \Block{Copyright}% |
| 168 |
% Copyright \textcopyright\ 1999–2026 |
| 169 |
% \href{http://www.gerd-neugebauer.de}{Gerd Neugebauer} |
| 170 |
% |
| 171 |
% \Block{Licenses}% |
| 172 |
% The source files of |limap| and the derived files |
| 173 |
% \begin{itemize}\itemsep=0pt |
| 174 |
% \item |limap.dtx| |
| 175 |
% \item |limap.ins| |
| 176 |
% \item |README.md| |
| 177 |
% \item |Makefile| |
| 178 |
% \item |limap.sty| |
| 179 |
% \item |limap.cls| |
| 180 |
% \item |limap.pdf| |
| 181 |
% \end{itemize} |
| 182 |
% may be distributed under the terms of the \LaTeX\ Project |
| 183 |
% Public License version 1.3c, as described in the file |
| 184 |
% |lppl.txt|. |
| 185 |
% |
| 186 |
% The documentation can be used under the |
| 187 |
% \href{http://creativecommons.org/licenses/by-sa/4.0/}{Creative |
| 188 |
% Commons Attributation-Share Alike 4.0 License} (CC BY-SA 4.0). |
| 189 |
% |
| 190 |
% The files in the |samples| directory are distributed unter |
| 191 |
% \href{http://creativecommons/zero/1.0}{Creative Commons CC0 |
| 192 |
% 1.0 Universal}. |
| 193 |
% |
| 194 |
% \Block{Net}% |
| 195 |
% The sources of |limap| are hosted on Sourceforge as part of the |
| 196 |
% project \texttt{gene-tex-lib}. The sources can be found under |
| 197 |
% the URL |
| 198 |
% \url{https://sourceforge.net/p/gene-tex-lib/svn/HEAD/tree/limap/}. |
| 199 |
% |
| 200 |
% A bundled distribution can be obtained via CTAN under the |
| 201 |
% package URL |
| 202 |
% \url{https://www.ctan.org/pkg/limap} or from the package's home |
| 203 |
% page under \url{http://www.gerd-neugebauer.de/sowftware/TeX/limap}. |
| 204 |
% |
| 205 |
% \Block{Contact}% |
| 206 |
% The author can be contacted under the following coordinates: |
| 207 |
% |
| 208 |
% \begin{minipage}{.6\linewidth}\parindent=2em |
| 209 |
% Gerd Neugebauer \medskip\par |
| 210 |
% Brechklinge 10 \par |
| 211 |
% 69256 Mauer \par |
| 212 |
% Germany \medskip\par |
| 213 |
% \href{mailto:[email protected]}{[email protected]} |
| 214 |
% \end{minipage} |
| 215 |
% \end{Map} |
| 216 |
% \newpage |
| 217 |
% \tableofcontents |
| 218 |
% \newpage |
| 219 |
% |
| 220 |
% |
| 221 |
% \begin{Map}{Motivation} |
| 222 |
% |
| 223 |
% \Block{Methodology}% |
| 224 |
% The information mapping\R method provides a methodology to |
| 225 |
% structure information in a special way. The aim is to help a |
| 226 |
% reader who uses the document to search for relevant information |
| 227 |
% instead of consuming it from start to end. The information |
| 228 |
% mapping method also claims to raise the productivity of |
| 229 |
% writers. |
| 230 |
% |
| 231 |
% \Block{No tutorial}% |
| 232 |
% This document does not include an introduction to the |
| 233 |
% information mapping method itself. The reader is referred to |
| 234 |
% other documents. Maybe an accompanying document will be |
| 235 |
% distributed along with this package. |
| 236 |
% |
| 237 |
% Unfortunately the methodology – or the name – is protected by |
| 238 |
% a trademark. Thus the teaching of the methodology is restricted |
| 239 |
% to licensed institutions. |
| 240 |
% |
| 241 |
% \Block{Principles}% |
| 242 |
% \begin{center} |
| 243 |
% \begin{tikzpicture}[mindmap,concept color=blue!16]\bfseries\scriptsize |
| 244 |
% \node [concept,ball color=blue!8] {Information Mapping\R} |
| 245 |
% child[grow=150,concept color=blue!20!black] {% |
| 246 |
% node[concept,ball color=blue!20!black] {\color{white}Principles} |
| 247 |
% child[grow=30,concept color=blue!48] {% |
| 248 |
% node[concept,ball color=blue!48] {Chunking}} |
| 249 |
% child[grow=80,concept color=blue!48] {% |
| 250 |
% node[concept,ball color=blue!48] {Relevance}} |
| 251 |
% child[grow=130,concept color=blue!48] {% |
| 252 |
% node[concept,ball color=blue!48] {Labelling}} |
| 253 |
% child[grow=180,concept color=blue!48] {% |
| 254 |
% node[concept,ball color=blue!48] {Consistency}} |
| 255 |
% child[grow=230,concept color=blue!48] {% |
| 256 |
% node[concept,ball color=blue!48] {Accessible details}} |
| 257 |
% child[grow=280,concept color=blue!48] {% |
| 258 |
% node[concept,ball color=blue!48] {Integrated graphics}} |
| 259 |
% }; |
| 260 |
% \end{tikzpicture} |
| 261 |
% \end{center} |
| 262 |
% |
| 263 |
% \Block{Information Type}% |
| 264 |
% |
| 265 |
% \begin{center} |
| 266 |
% \begin{tikzpicture}[mindmap,concept color=blue!48]\bfseries\scriptsize |
| 267 |
% \node [concept,ball color=blue!8] {Information Mapping\R} |
| 268 |
% child[grow=-30,concept color=blue!20!black] {% |
| 269 |
% node[concept,ball color=blue!20!black] {\color{white}Infor-mation Type} |
| 270 |
% child[grow=100,concept color=blue!48] {% |
| 271 |
% node[concept,ball color=blue!48] {Procedure}} |
| 272 |
% child[grow=50,concept color=blue!48] {% |
| 273 |
% node[concept,ball color=blue!48] {Process}} |
| 274 |
% child[grow=0,concept color=blue!48] {% |
| 275 |
% node[concept,ball color=blue!48] {Principle}} |
| 276 |
% child[grow=-50,concept color=blue!48] {% |
| 277 |
% node[concept,ball color=blue!48] {Concept}} |
| 278 |
% child[grow=-110,concept color=blue!48] {% |
| 279 |
% node[concept,ball color=blue!48] {Structure}} |
| 280 |
% child[grow=-160,concept color=blue!48] {% |
| 281 |
% node[concept,ball color=blue!48] {Fact}} |
| 282 |
% }; |
| 283 |
% \end{tikzpicture} |
| 284 |
% \end{center} |
| 285 |
% |
| 286 |
% \Block{Problems of restructuring}% |
| 287 |
% You as \LaTeX\ user may have encountered the problem when |
| 288 |
% restructuring a document: The sections know exactly the level |
| 289 |
% they belong to. If you introduce a new section and put another |
| 290 |
% section into it you have to change all sectioning commands to |
| 291 |
% reflect the new level of the section and their subsections. |
| 292 |
% |
| 293 |
% The macros of |limap| abstract away the level of the document |
| 294 |
% structuring. Any structuring unit is a “Block”. It may contain |
| 295 |
% text or other blocks. Such blocks are the replacement or the |
| 296 |
% sectioning commands. When you restructure your document you |
| 297 |
% simply shift the block and anything it contains to the new |
| 298 |
% place and you are done. |
| 299 |
% |
| 300 |
% The same mechanism can help you to include the same material in |
| 301 |
% several documents – at different sectioning levels! |
| 302 |
% |
| 303 |
% \Block{Structure and constituents}% |
| 304 |
% The general approach focuses very much on the structure of |
| 305 |
% the document. The following diagram illustrates the terminology |
| 306 |
% used within this documentation. |
| 307 |
% |
| 308 |
% \begin{center}\small |
| 309 |
% \tikzstyle{class}=[rectangle, |
| 310 |
% text centered, |
| 311 |
% minimum width=6em, |
| 312 |
% minimum height=3em, |
| 313 |
% draw=black!60!red, |
| 314 |
% drop shadow, |
| 315 |
% top color=yellow!92!red!10!white, |
| 316 |
% bottom color=yellow!92!red!40!white] |
| 317 |
% \tikzstyle{arrow}=[draw=black!60!red, thick] |
| 318 |
% \begin{tikzpicture} |
| 319 |
% \path (3.75,6) node(doc) [class]{\bfseries Document} |
| 320 |
% (3.75,4) node(map) [class]{\bfseries Map} |
| 321 |
% (3.75,2) node(block) [class]{\bfseries Block} |
| 322 |
% (0,0) node(text) [class]{\bfseries Text} |
| 323 |
% (2.5,0) node(table) [class]{\bfseries Table} |
| 324 |
% (5,0) node(image) [class]{\bfseries Image} |
| 325 |
% (7.5,0) node(figure) [class]{\bfseries Diagram}; |
| 326 |
% \draw[arrow,very thick,->] (doc) -- (map); |
| 327 |
% \node[left] at ($(doc)!.6!(map)$) {\scriptsize 1..*}; |
| 328 |
% \draw[arrow,very thick,->] (map) -- (block); |
| 329 |
% \node[left] at ($(map)!.6!(block)$) {\scriptsize 1..9}; |
| 330 |
% \draw[arrow,very thick,->] (map) -- +(1.5,0) -- +(1.5,1) -- +(.75,1) -- (map); |
| 331 |
% \draw (4.75,4.75) node {\scriptsize 0..*}; |
| 332 |
% \draw[arrow,very thick,->] (block) -- (text); |
| 333 |
% \node[left] at ($(block)!.6!(text)$) {\scriptsize 0..*}; |
| 334 |
% \draw[arrow,very thick,->] (block) -- (table); |
| 335 |
% \node[left] at ($(block)!.6!(table)$) {\scriptsize 0..1}; |
| 336 |
% \draw[arrow,very thick,->] (block) -- (image); |
| 337 |
% \node[right] at ($(block)!.6!(image)$) {\scriptsize 0..1}; |
| 338 |
% \draw[arrow,very thick,->] (block) -- (figure); |
| 339 |
% \node[right] at ($(block)!.6!(figure)$) {\scriptsize 0..1}; |
| 340 |
% \end{tikzpicture} |
| 341 |
% \end{center} |
| 342 |
% |
| 343 |
% \Block{Class or package}% |
| 344 |
% To support the information mapping\R method several \LaTeX{} |
| 345 |
% macros and environments are provided which allow you to enter a |
| 346 |
% logical description of the relevant concepts. Those macros are |
| 347 |
% provided in the package and class file. It is up to you to |
| 348 |
% choose one of them. |
| 349 |
% |
| 350 |
% \Block{Interoperabilty with other classes and packages}% |
| 351 |
% The main part of the user interface is inherited from \LaTeX. |
| 352 |
% The major differences are the sectioning commands which are |
| 353 |
% made obsolete in parts by the information mapping\R method. |
| 354 |
% Thus most packages can be used to typeset contents of a block. |
| 355 |
% \end{Map} |
| 356 |
% |
| 357 |
% \begin{Map}{Getting Started} |
| 358 |
% |
| 359 |
% \Block{Introduction}% |
| 360 |
% If you are starting to use |limap| you should be vaguely |
| 361 |
% familiar with the underlying methodology. This documentation |
| 362 |
% does not provide an introduction. |
| 363 |
% |
| 364 |
% When you start using this class or package you should say |
| 365 |
% “Good bye” to the classical document structuring macros in |
| 366 |
% the \LaTeX\ standard classes. |
| 367 |
% |
| 368 |
% \Block{Class or package}% |
| 369 |
% First of all you should decide whether to use the |limap| class |
| 370 |
% or the |limap| package. The class is meant for a complete document. |
| 371 |
% The package allows to combine |limap| with arbitrary other |
| 372 |
% document classes. |
| 373 |
% |
| 374 |
% \Block{Contents}% |
| 375 |
% In the maps contained herein you will find an introduction on |
| 376 |
% the use of the |limap| macros and environments. They are |
| 377 |
% accompanied by illustrating sample code. |
| 378 |
% \MapTableOfContents |
| 379 |
% |
| 380 |
% \begin{Map}{Using the Document Class} |
| 381 |
% |
| 382 |
% \Block{Using the document class}% |
| 383 |
% This package provides both a class file as well as a package. |
| 384 |
% The package contains the definitions of maps, blocks, and |
| 385 |
% others. They can be used together with any base class. This |
| 386 |
% is illustrated in the following preamble: |
| 387 |
% \begin{verbatim} |
| 388 |
% \documentclass{book} |
| 389 |
% \usepackage{limap} |
| 390 |
% \begin{document} \end{verbatim} |
| 391 |
% |
| 392 |
% \Block{Suppressing the block lines}% |
| 393 |
% This class option |nolines| can be used to suppress the line |
| 394 |
% above and below block. This is illustrated in the following |
| 395 |
% preamble: |
| 396 |
% \begin{verbatim} |
| 397 |
% \documentclass[nolines]{limap} |
| 398 |
% \begin{document} \end{verbatim} |
| 399 |
% |
| 400 |
% \Block{Other options}% |
| 401 |
% Any option not processed by |limap.cls| is passed to the |
| 402 |
% underlying document class used. Thus it is possible to |
| 403 |
% customize the underlying class any further. |
| 404 |
% |
| 405 |
% \Block{Several types of options}% |
| 406 |
% In the maps contained herein you will find the supported |
| 407 |
% options for the document class |limap|. |
| 408 |
% \MapTableOfContents |
| 409 |
% |
| 410 |
% \begin{Map}{Document Class Options for Language Selection} |
| 411 |
% |
| 412 |
% \Block{Introduction}% |
| 413 |
% The document class |limap| inserts some words. Thus it has to |
| 414 |
% know the language it is supposed to use. Thus the language |
| 415 |
% has to be specified as one document class option. |
| 416 |
% \begin{verbatim} |
| 417 |
% \documentclass[german]{limap} |
| 418 |
% \begin{document} \end{verbatim} |
| 419 |
% |
| 420 |
% \Block{Supported languages}% |
| 421 |
% First, we describe the settings influencing the language |
| 422 |
% specific settings. They do not make provisions to use the |
| 423 |
% appropriate hyphenation patterns. They just arrange things |
| 424 |
% such that the internally used texts are displayed in the |
| 425 |
% chosen language. |
| 426 |
% |
| 427 |
% \begin{MapTabular}{@{\tt }lp{.75\linewidth}}\toprule |
| 428 |
% \rm Option & Description\\\midrule |
| 429 |
% austrian & Activate the language specific text |
| 430 |
% fragments for the Austrian language (in fact |
| 431 |
% German with one minor modification).\\ |
| 432 |
% english & Activate the language specific text fragments |
| 433 |
% for the English language.\\ |
| 434 |
% french & Activate the language specific text fragments |
| 435 |
% for the French language.\\ |
| 436 |
% german & Activate the language specific text fragments |
| 437 |
% for the German language.\\ |
| 438 |
% USenglish & Activate the language specific text |
| 439 |
% fragments for the American |
| 440 |
% English.\\\bottomrule |
| 441 |
% \end{MapTabular} |
| 442 |
% |
| 443 |
% \Block{Default language}% |
| 444 |
% The default language is |english|. It is used if no language |
| 445 |
% is set. |
| 446 |
% |
| 447 |
% \Block{Beware of hyphenation}% |
| 448 |
% Note that the hyphenation patterns are not loaded |
| 449 |
% automatically. You have to load the hyphenation patterns, |
| 450 |
% for instance with the |
| 451 |
% \href{https://www.ctan.org/pkg/babel}{babel} package. |
| 452 |
% |
| 453 |
% This behavior has been chosen to allow you to select the |
| 454 |
% language package of your choice. Also you can pass in |
| 455 |
% additional options to this package more easily. |
| 456 |
% \end{Map} |
| 457 |
% |
| 458 |
% \begin{Map}{Document Class Options for Variant Selection} |
| 459 |
% |
| 460 |
% \Block{Introduction}% |
| 461 |
% The document class |limap| is based on another document |
| 462 |
% class. Thus you can use the well-known macros and |
| 463 |
% environments defined there and take advantage of the |
| 464 |
% extensions provided by |limap|. |
| 465 |
% |
| 466 |
% \begin{verbatim} |
| 467 |
% \documentclass{limap} |
| 468 |
% \begin{document} \end{verbatim} |
| 469 |
% \Block{Variants}% |
| 470 |
% The class has two additional options to determine the base |
| 471 |
% class to be used. The first option is the variant. It can take |
| 472 |
% the following values: |
| 473 |
% |
| 474 |
% \begin{MapTabular}{@{\tt }ll}\toprule |
| 475 |
% \rm Option & Description\\\midrule |
| 476 |
% base & Use the base set of classes. This is the default.\\ |
| 477 |
% koma & Use the set of classes from |
| 478 |
% \href{https://www.ctan.org/pkg/koma-script}{koma-script}.\\\bottomrule |
| 479 |
% \end{MapTabular} |
| 480 |
% |
| 481 |
% \Block{Default variant}% |
| 482 |
% If no document class option is used then |base| is the |
| 483 |
% default variant. |
| 484 |
% \end{Map} |
| 485 |
% |
| 486 |
% \begin{Map}{Document Class Options for Base Class Selection} |
| 487 |
% |
| 488 |
% \Block{Introduction}% |
| 489 |
% The document class |limap| follows the logic introduced in |
| 490 |
% the \LaTeX\ standard document classes. The type of the base |
| 491 |
% document class can be given as argument to the |limap| class. |
| 492 |
% |
| 493 |
% \begin{verbatim} |
| 494 |
% \documentclass[book]{limap} |
| 495 |
% \begin{document} \end{verbatim} |
| 496 |
% |
| 497 |
% |
| 498 |
% \Block{Class type}% |
| 499 |
% The second option is the class type. It determines which kind of |
| 500 |
% document to typeset. It can take the following values: |
| 501 |
% |
| 502 |
% \begin{MapTabular}{@{\tt }ll}\toprule |
| 503 |
% \rm Option & Description\\\midrule |
| 504 |
% book & Typeset a book type document.\\ |
| 505 |
% report & Typeset a report type document.\\ |
| 506 |
% article & Typeset an article type document.\\ |
| 507 |
% letter & Typeset a letter type document.\\\bottomrule |
| 508 |
% \end{MapTabular} |
| 509 |
% |
| 510 |
% \Block{Mapping of variant and type}% |
| 511 |
% The following table shows which base classes are loaded according |
| 512 |
% to the given values: |
| 513 |
% |
| 514 |
% \begin{MapTabular}{@{\tt }lcc}\toprule |
| 515 |
% \rm Type /variant & \emph{base} & \emph{koma} \\\midrule |
| 516 |
% book & book & scrbook \\ |
| 517 |
% report & report & scrreprt \\ |
| 518 |
% article & article & scrartcl \\ |
| 519 |
% letter & letter & scrlettr \\\bottomrule |
| 520 |
% \end{MapTabular} |
| 521 |
% |
| 522 |
% \Block{Default type}% |
| 523 |
% The default type is |report|. It is used if no type is set. |
| 524 |
% \end{Map} |
| 525 |
% \end{Map} |
| 526 |
% |
| 527 |
% \begin{Map}{Using the Package} |
| 528 |
% \Block{Introduction}% |
| 529 |
% The package |limap| can be used together with most document |
| 530 |
% classes. An exception are classes for slides like the |
| 531 |
% \href{https://www.ctan.org/pkg/beamer}{beamer} class. |
| 532 |
% |
| 533 |
% As usual it is declared in the document preamble. |
| 534 |
% |
| 535 |
% \begin{verbatim} |
| 536 |
% \documentclass{report} |
| 537 |
% \usepackage{limap} |
| 538 |
% \begin{document} \end{verbatim} |
| 539 |
% \Block{Content}% |
| 540 |
% The following additional information is available. |
| 541 |
% \MapTableOfContents |
| 542 |
% |
| 543 |
% \begin{Map}{Package Options for Language Selection} |
| 544 |
% |
| 545 |
% \Block{Introduction}% |
| 546 |
% The package |limap| inserts some words. Thus it has to |
| 547 |
% know the language it is supposed to use. Thus the language |
| 548 |
% has to be specified as package option. |
| 549 |
% \begin{verbatim} |
| 550 |
% \usepackage[german]{limap} |
| 551 |
% \begin{document} \end{verbatim} |
| 552 |
% |
| 553 |
% \Block{Inheritance of document class options}% |
| 554 |
% Alternatively the language selecting option can be specified |
| 555 |
% as document class option. Thus several packages can share the |
| 556 |
% same setting. |
| 557 |
% \begin{verbatim} |
| 558 |
% \documentclass[german]{scrbook} |
| 559 |
% \documentclass{limap} |
| 560 |
% \begin{document} \end{verbatim} |
| 561 |
% |
| 562 |
% \Block{Supported languages}% |
| 563 |
% Here we describe the settings influencing the language |
| 564 |
% specific settings. They do not make provisions to use the |
| 565 |
% appropriate hyphenation patterns. They just arrange things |
| 566 |
% such that the internally used texts are displayed in the |
| 567 |
% chosen language. |
| 568 |
% |
| 569 |
% \begin{MapTabular}{@{\tt }lp{.75\linewidth}}\toprule |
| 570 |
% \rm Option & Description\\\midrule |
| 571 |
% austrian & Activate the language specific text |
| 572 |
% fragments for the Austrian language (in fact |
| 573 |
% German with one minor modification).\\ |
| 574 |
% english & Activate the language specific text fragments |
| 575 |
% for the English language.\\ |
| 576 |
% french & Activate the language specific text fragments |
| 577 |
% for the French language.\\ |
| 578 |
% german & Activate the language specific text fragments |
| 579 |
% for the German language.\\ |
| 580 |
% USenglish & Activate the language specific text |
| 581 |
% fragments for the American English.\\\bottomrule |
| 582 |
% \end{MapTabular} |
| 583 |
% |
| 584 |
% \Block{Default language}% |
| 585 |
% The default language is |english|. It is used if no language |
| 586 |
% is set. |
| 587 |
% |
| 588 |
% \Block{Beware of hyphenation}% |
| 589 |
% Note that the hyphenation patterns are not loaded |
| 590 |
% automatically. You have to load the hyphenation patterns, |
| 591 |
% for instance with the |
| 592 |
% \href{https://www.ctan.org/pkg/babel}{babel} package. |
| 593 |
% |
| 594 |
% This behavior has been chosen to allow you to select the |
| 595 |
% language package of your choice. Also you can pass in |
| 596 |
% additional options to this package more easily. |
| 597 |
% \end{Map} |
| 598 |
% \end{Map} |
| 599 |
% \end{Map} |
| 600 |
% |
| 601 |
% \begin{Map}{The Block}\label{map:block} |
| 602 |
% |
| 603 |
% \Block{Meaning}% |
| 604 |
% A “block” is the essential building units of the |limap| |
| 605 |
% package. You can think of it as paragraph with a title. |
| 606 |
% |
| 607 |
% \Block{Appearance}% |
| 608 |
% The blocks are usually typeset with the block label on the left |
| 609 |
% side and the contents to its right. They are surrounded by |
| 610 |
% white-space and a thin line above and below. |
| 611 |
% |
| 612 |
% \DescribeMacro{\Block} |
| 613 |
% The macro |\Block| can be used to typeset an block. It |
| 614 |
% takes one argument which is the block label. |
| 615 |
% |
| 616 |
% This is a shorthand for denoting a block. The end mark can be |
| 617 |
% omitted if you use the macro instead of the environment. |
| 618 |
% Nevertheless this is depreciated. |
| 619 |
% |
| 620 |
% \Block{Example}% |
| 621 |
% The following sample illustrates how to enter a block. |
| 622 |
% \begin{verbatim} |
| 623 |
% \Block{Block Label} |
| 624 |
% And now comes the block text. It can consist of one or more |
| 625 |
% classical paragraphs, or tables, or pictures, or something |
| 626 |
% else. \end{verbatim} |
| 627 |
% |
| 628 |
% \Block{Just in a map}% |
| 629 |
% Note that the macro |\Block| can be used inside a map only. If |
| 630 |
% you try to use it outside the scope of a map you will get an |
| 631 |
% error. |
| 632 |
% |
| 633 |
% \Block{More on blocks}% |
| 634 |
% Several more aspects of blocks are covered in the following |
| 635 |
% maps. |
| 636 |
% \MapTableOfContents |
| 637 |
% |
| 638 |
% \begin{Map}{Configuring Blocks} |
| 639 |
% |
| 640 |
% \DescribeMacro{\MapBlockLabelFont} |
| 641 |
% The macro |\MapBlockLabelFont| determines the font changing |
| 642 |
% command to be used for typesetting the block label. The |
| 643 |
% default is empty. |
| 644 |
% |
| 645 |
% \Block{Colored block labels}% |
| 646 |
% The macro |\MapBlockLabelFont| can for instance be used to achieve |
| 647 |
% colored block labels. For this purpose we can include the package |
| 648 |
% |xcolor| in the preamble and select for instance a named color |
| 649 |
% for the rule. |
| 650 |
% This is illustrated in the following example. |
| 651 |
% \begin{verbatim} |
| 652 |
% \usepackage[svgnames]{xcolor} |
| 653 |
% \renewcommand\MapBlockLabelFont{\color{Navy}} \end{verbatim} |
| 654 |
% \DescribeMacro{\MapParskip} |
| 655 |
% The macro |\MapParskip| determines the vertical distance of the |
| 656 |
% text from the separating rules. The default is \MapParskip. |
| 657 |
% \begin{verbatim} |
| 658 |
% \renewcommand\MapParskip{.25ex} \end{verbatim} |
| 659 |
% |
| 660 |
% \DescribeMacro{\MapTitleFraction} |
| 661 |
% The macro |\MapTitleFraction| determines the part of the page |
| 662 |
% width devoted to the block label area. It is a fraction in the |
| 663 |
% range from 0 to 1. The default value of |\MapTitleFraction| is |
| 664 |
% 0\MapTitleFraction. |
| 665 |
% \begin{verbatim} |
| 666 |
% \renewcommand\MapTitleFraction{.25} \end{verbatim} |
| 667 |
% |
| 668 |
% \DescribeMacro{\MapTextFraction} |
| 669 |
% This macro determines the part of the page width devoted to the |
| 670 |
% text area. It is a fraction in the range from 0 to 1. The |
| 671 |
% default value of |\MapTextFraction| is 0\MapTextFraction. |
| 672 |
% |
| 673 |
% |\MapTitleFraction| and |\MapTextFraction| should add up to |
| 674 |
% something less or equal to 1. Otherwise you will get some |
| 675 |
% “overfull hbox” messages. |
| 676 |
% \begin{verbatim} |
| 677 |
% \renewcommand\MapTextFraction{.8} \end{verbatim} |
| 678 |
% \vspace*{-\MapParskip} |
| 679 |
% \end{Map} |
| 680 |
% |
| 681 |
% \begin{Map}{Configuring the Rules of Blocks} |
| 682 |
% |
| 683 |
% \Block{Motivation}% |
| 684 |
% Blocks are usually surrounded by horizontal rules. The |
| 685 |
% appearance of these rules can be influenced by some macros. |
| 686 |
% |
| 687 |
% \DescribeMacro{\MapRuleWidth} The macro |\MapRuleWidth| |
| 688 |
% determines the width of the rules drawn between blocks. It is |
| 689 |
% defined as a macro containig a length. The default is |
| 690 |
% \MapRuleWidth. |
| 691 |
% |
| 692 |
% \begin{verbatim} |
| 693 |
% \setlength\MapRuleWidth{1mm} \end{verbatim} |
| 694 |
% |
| 695 |
% \Block{Suppress visible rules}% |
| 696 |
% For some people the rules are distracting since they emphasize |
| 697 |
% the structure too much. In such situations the rule width might |
| 698 |
% be reduced. In the extreme case it can even be set to 0pt to |
| 699 |
% suppress the lines at all as in the following example: |
| 700 |
% |
| 701 |
% \begin{verbatim} |
| 702 |
% \renewcommand\MapRuleWidth{0pt} \end{verbatim} |
| 703 |
% |
| 704 |
% \DescribeMacro{\MapRuleStart} |
| 705 |
% The macro |\MapRuleStart| is inserted before rules around |
| 706 |
% blocks. It can be used to inject some code before the rule is |
| 707 |
% typeset. Initially it is empty. |
| 708 |
% |
| 709 |
% \Block{Colored rules}% |
| 710 |
% The macro |\MapRuleStart| can for instance be used to achieve |
| 711 |
% colored rules. For this purpose we can include the package |
| 712 |
% |xcolor| in the preamble and select a named color for the rule. |
| 713 |
% This is illustrated in the following example. |
| 714 |
% \begin{verbatim} |
| 715 |
% \usepackage[svgnames]{xcolor} |
| 716 |
% \renewcommand\MapRuleStart{\color{Silver}} \end{verbatim} |
| 717 |
% \vspace*{-3ex} |
| 718 |
% \end{Map} |
| 719 |
% |
| 720 |
% \begin{Map}{A Wide Block} |
| 721 |
% |
| 722 |
% \Block{Motivation}% |
| 723 |
% Sometimes it is necessary to extend the content of a block to |
| 724 |
% the whole width of the page. This can be the case for |
| 725 |
% illustrations or large tables. |
| 726 |
% |
| 727 |
% \DescribeMacro{\WideBlock} |
| 728 |
% The macro |\WideBlock| can be used to typeset a piece of |
| 729 |
% information on the whole page width. It is normally used after an |
| 730 |
% initiating block containing the title of the whole construction. |
| 731 |
% |
| 732 |
% The macro |\WideBlock| takes one argument which contains the |
| 733 |
% material to span the whole page width. |
| 734 |
% |
| 735 |
% \Block{Example}% |
| 736 |
% The following sample illustrates how to enter a wide block. |
| 737 |
% \begin{verbatim} |
| 738 |
% \Block{Block Label} |
| 739 |
% And now comes the block text. |
| 740 |
% \WideBlock{\includegraphics{images/overview.svg}} \end{verbatim} |
| 741 |
% |
| 742 |
% \Block{Block Label} |
| 743 |
% And now comes the wide block produced with the help of |
| 744 |
% Ti\textit{kZ} and its decoration with random steps. |
| 745 |
% |
| 746 |
% \vspace*{-\MapParskip} |
| 747 |
% \WideBlock{\centering |
| 748 |
% \begin{tikzpicture} |
| 749 |
% \node [draw=black!50!white, |
| 750 |
% ball color=yellow!85!red!12!white,draw,thick, |
| 751 |
% minimum height=20mm, minimum width=147mm, |
| 752 |
% decorate, decoration={random steps, |
| 753 |
% segment length=5pt,amplitude=4pt}] |
| 754 |
% {\it A very, very, very, very, very, very, very, very, very, very, very, very, very |
| 755 |
% wide block content}; |
| 756 |
% \end{tikzpicture}}\\ |
| 757 |
% \vspace*{-\MapParskip} |
| 758 |
% \end{Map} |
| 759 |
% \end{Map} |
| 760 |
% |
| 761 |
% \begin{Map}{The Map}\label{map:map} |
| 762 |
% |
| 763 |
% \Block{Structuring documents}% |
| 764 |
% The maps are the structuring units of the |limap| package. Maps |
| 765 |
% may recursively contain maps and other material. The other |
| 766 |
% material is usually named a block. This recursive structure is |
| 767 |
% illustrated in the following figure. |
| 768 |
% |
| 769 |
% \newcount\picX |
| 770 |
% \newcount\picY |
| 771 |
% \newcount\picW |
| 772 |
% \picX=0 |
| 773 |
% \picY=0 |
| 774 |
% \picW=20 |
| 775 |
% \long\def\picMap(#1)#2{% |
| 776 |
% \put(\the\picX,\the\picY){\framebox(\the\picW,#1)[tl]{Map}} |
| 777 |
% \begingroup\advance\picW-2 |
| 778 |
% \advance\picY1 \advance\picX1 |
| 779 |
% #2 |
| 780 |
% \endgroup |
| 781 |
% \advance\picY#1 \advance\picY2 |
| 782 |
% }% |
| 783 |
% \def\picBlock{% |
| 784 |
% \put(\the\picX,\the\picY){\makebox(\the\picW,3)[tl]{\tiny Block}} |
| 785 |
% \put(\the\picX,\the\picY){\line(1,0){\the\picW}} |
| 786 |
% \begingroup \advance\picX6 |
| 787 |
% \advance\picY1 |
| 788 |
% \advance\picW-6 |
| 789 |
% \multiput(\the\picX,\the\picY)(0,.5){5}{\line(1,0){\the\picW}} |
| 790 |
% \endgroup |
| 791 |
% \advance\picY4 |
| 792 |
% \put(\the\picX,\the\picY){\line(1,0){\the\picW}} |
| 793 |
% }% |
| 794 |
% \begin{center}\unitlength=1mm |
| 795 |
% \begin{picture}(20,72)\sf\scriptsize |
| 796 |
% \picMap(71){ |
| 797 |
% \picMap(21){ |
| 798 |
% \picMap(16){ |
| 799 |
% \picBlock |
| 800 |
% \picBlock |
| 801 |
% \picBlock |
| 802 |
% } |
| 803 |
% } |
| 804 |
% \picMap(16){ |
| 805 |
% \picBlock |
| 806 |
% \picBlock |
| 807 |
% \picBlock |
| 808 |
% } |
| 809 |
% \picMap(16){ |
| 810 |
% \picBlock |
| 811 |
% \picBlock |
| 812 |
% \picBlock |
| 813 |
% } |
| 814 |
% \picBlock |
| 815 |
% \picBlock |
| 816 |
% } |
| 817 |
% \end{picture} |
| 818 |
% \end{center} |
| 819 |
% |
| 820 |
% \DescribeEnv{Map} |
| 821 |
% The environment |Map| can be used to typeset a map. It |
| 822 |
% takes a single argument which contains the map title. The map |
| 823 |
% title is typeset above the map and is repeated on each |
| 824 |
% continuation page. |
| 825 |
% |
| 826 |
% \Block{Example}% |
| 827 |
% |
| 828 |
% \begin{verbatim} |
| 829 |
% \begin{Map}{Map Title} |
| 830 |
% \Block{Block Label} |
| 831 |
% And now comes the block text. It can consist of |
| 832 |
% one or more classical paragraphs, or tables, or |
| 833 |
% pictures, or something else. |
| 834 |
% \end{Map} \end{verbatim} |
| 835 |
% |
| 836 |
% \Block{To at most 12~cascaded Maps} |
| 837 |
% There is a technical restriction in the current implementation |
| 838 |
% of Maps. This restriction does not allow more than 12 cascaded |
| 839 |
% Maps, i.e. Maps in Maps \ldots in Maps. |
| 840 |
% |
| 841 |
% According to the good old 7$\pm$2 rule a full populated |
| 842 |
% document of this level would contain 282\,429\,536\,481 Maps. I |
| 843 |
% think it should take some time until this limit is reached. |
| 844 |
% |
| 845 |
% \Block{More on maps}% |
| 846 |
% Some more aspects are covered in the following pages. |
| 847 |
% \MapTableOfContents |
| 848 |
% |
| 849 |
% \begin{Map}{Referencing Maps} |
| 850 |
% |
| 851 |
% \Block{Referencing maps}% |
| 852 |
% Maps can be referenced in the usual \LaTeX\ way. For this |
| 853 |
% purpose you place a macro invocation of |\label| right behind |
| 854 |
% the beginning of the |Map|. |
| 855 |
% |
| 856 |
% Then you can add references somewhere in the document with |
| 857 |
% |\ref| and |\pageref|. For backward references two \LaTeX\ runs |
| 858 |
% are required. |
| 859 |
% |
| 860 |
% \Block{Example}% |
| 861 |
% \begin{verbatim} |
| 862 |
% \begin{Map}{Map Title}\label{my.label} |
| 863 |
% \Block{Block Label} |
| 864 |
% As said on page~\pageref{my.label}... \end{verbatim} |
| 865 |
% \Block{Caveat emptor}% |
| 866 |
% |limap| automatically labels any map with a label of the form |
| 867 |
% \texttt{Map|@|}\textsl{n} where \textsl{n} is a |
| 868 |
% sequence number. Thus avoid to use such labels yourself. |
| 869 |
% \end{Map} |
| 870 |
% |
| 871 |
% \begin{Map}{Configuring Maps} |
| 872 |
% |
| 873 |
% \DescribeMacro{\MapFont} |
| 874 |
% The macro |\MapFont| determines the font changing command to be |
| 875 |
% used when starting a new map. |
| 876 |
% \begin{verbatim} |
| 877 |
% \renewcommand\MapFont{\tt} \end{verbatim} |
| 878 |
% |
| 879 |
% \DescribeMacro{\MapTitleFont} |
| 880 |
% The macro |\MapTitleFont| determines the font changing command to |
| 881 |
% be used when typesetting the title of a map. The default is |\Large|. |
| 882 |
% \begin{verbatim} |
| 883 |
% \renewcommand\MapTitleFont{\huge\bfseries} \end{verbatim} |
| 884 |
% |
| 885 |
% \DescribeMacro{\MapContinued} |
| 886 |
% The macro |\MapContinued| contains the text appearing at the end |
| 887 |
% of map which are continued on the next page. It is initiated |
| 888 |
% when the class or package is loaded. It can overwritten |
| 889 |
% afterwards – for instance in the preamble. |
| 890 |
% \begin{verbatim} |
| 891 |
% \renewcommand\MapContinued{} \end{verbatim} |
| 892 |
% |
| 893 |
% \DescribeMacro{\MapContinuing} |
| 894 |
% The macro |\MapContinuing| contains the text appearing at the |
| 895 |
% beginning of map which are continued from the previous page. It |
| 896 |
% is typeset after the map title. It is initiated |
| 897 |
% when the class or package is loaded. It can overwritten |
| 898 |
% afterwards – for instance in the preamble. |
| 899 |
% \begin{verbatim} |
| 900 |
% \renewcommand\MapContinuing{} \end{verbatim} |
| 901 |
% |
| 902 |
% \DescribeMacro{\MapTitleContinuedFont} |
| 903 |
% This macro determines the font changing command to be used for |
| 904 |
% typesetting the additional text after titles on followup pages of |
| 905 |
% multi-page maps. |
| 906 |
% |
| 907 |
% The default value is |\small|. |
| 908 |
% \begin{verbatim} |
| 909 |
% \renewcommand\MapTitleContinuedFont{\normalsize} \end{verbatim} |
| 910 |
% |
| 911 |
% \DescribeMacro{\MapNewpage} |
| 912 |
% The macro |\MapNewpage| is expanded whenever a new page is |
| 913 |
% required between maps. Thus it can be used to suppress the |
| 914 |
% newpages by |\let|ing it to |\relax|. Note that this is not in |
| 915 |
% the spirit of the Information Mapping\R method. |
| 916 |
% |
| 917 |
% \DescribeMacro{\MapTOC} |
| 918 |
% The macro |\MapTOC| is expanded to generate the entry in the |
| 919 |
% table of contents. It can be redefined to allow another |
| 920 |
% behavior. |
| 921 |
% \end{Map} |
| 922 |
% \end{Map} |
| 923 |
% |
| 924 |
% \begin{Map}{The Table of Contents} |
| 925 |
% |
| 926 |
% \Block{Everything is local}% |
| 927 |
% The concept of the underlying methodology is that everything |
| 928 |
% should be addressed relative to the current location. We see |
| 929 |
% this when dealing with maps (see page~\pageref{map:map}). The |
| 930 |
% same principle is applied to the table of contents. |
| 931 |
% |
| 932 |
% \Block{Direct children are included}% |
| 933 |
% The table of contents includes all maps contained in the map in |
| 934 |
% which it appears. This means the immediate children of the map |
| 935 |
% are shown. |
| 936 |
% |
| 937 |
% \Block{Block context required}% |
| 938 |
% The table of contents is typeset inside a block (see |
| 939 |
% page~\pageref{map:block}). |
| 940 |
% |
| 941 |
% \DescribeMacro{\MapTableOfContents} |
| 942 |
% The macro |\MapTableOfContents| can be used to typeset the table |
| 943 |
% of contents for a map. This table of contents includes all |
| 944 |
% sub-maps of the map it is contained in – not recursively but |
| 945 |
% only one level deeper. |
| 946 |
% |
| 947 |
% The macro |\MapTableOfContents| does not take any argument. |
| 948 |
% |
| 949 |
% \Block{Example}% |
| 950 |
% \begin{verbatim} |
| 951 |
% \Block{Contents} |
| 952 |
% And some wise words about the table of contents. |
| 953 |
% \MapTableOfContents \end{verbatim} |
| 954 |
% |
| 955 |
% \DescribeMacro{\MapTableOfContentsStyle} |
| 956 |
% The macro |\MapTableOfContentsStyle| can be used to determine |
| 957 |
% the style of the |\MapTableOfContents| The default style is an |
| 958 |
% open layout utilizing the package |
| 959 |
% \href{https://www.ctan.org/pkg/booktabs}{booktabs}. |
| 960 |
% |
| 961 |
% The macro |\MapTableOfContentsStyle| takes one argument. This |
| 962 |
% argument may have one of the following values: |
| 963 |
% |
| 964 |
% \begin{MapTabular}{ll}\toprule |
| 965 |
% Argument & Meaning \\\midrule |
| 966 |
% open & an open style for the TOC\\\hline |
| 967 |
% boxed & a boxed style for the TOC\\\bottomrule |
| 968 |
% \end{MapTabular}% |
| 969 |
% \vspace*{-5ex} |
| 970 |
% \begin{Map}{Blocks in the Table of Contents} |
| 971 |
% |
| 972 |
% \Block{Motivation}% |
| 973 |
% Sometimes it can be desirable to add the blocks to the global |
| 974 |
% table of contents. Here we will see how this can be achieved. |
| 975 |
% |
| 976 |
% \DescribeMacro{\MapBlockStartHook} |
| 977 |
% The macro |\MapBlockStartHook| is expanded at the beginning of |
| 978 |
% each block it if is defined. It takes a single argument which |
| 979 |
% is the title of the block. |
| 980 |
% |
| 981 |
% \DescribeMacro{\MapBlockTOC} |
| 982 |
% The macro |\MapBlockTOC| is a macro which adds one line to the |
| 983 |
% table of contents. It takes one argument which is the text to |
| 984 |
% be added. |
| 985 |
% |
| 986 |
% \Block{Example}% |
| 987 |
% Put the following code in the preamble to get the blocks into |
| 988 |
% the table of contents. |
| 989 |
% \begin{verbatim} |
| 990 |
% \let\MapBlockStartHook\MapBlockTOC \end{verbatim} |
| 991 |
% |
| 992 |
% %\vspace*{-5ex} |
| 993 |
% \end{Map} |
| 994 |
% \end{Map} |
| 995 |
% \begin{Map}{Tables} |
| 996 |
% |
| 997 |
% \Block{Introduction}% |
| 998 |
% Tables play an important role as part of maps. Usually they are |
| 999 |
% included into a block and preceded by some useful introduction. |
| 1000 |
% |
| 1001 |
% \Block{Combination with booktabs}% |
| 1002 |
% The document class |limap| and the package |limap| |
| 1003 |
% automatically include the package |
| 1004 |
% \href{https://www.ctan.org/pkg/booktabs}{booktabs}. This |
| 1005 |
% package contains some support for typesetting proper tables. |
| 1006 |
% You should have a look at the documentation of |booktabs| and |
| 1007 |
% follow the recommendations given there. |
| 1008 |
% |
| 1009 |
% |booktabs| is automatically loaded by |limap| upon start-up. |
| 1010 |
% |
| 1011 |
% \DescribeEnv{MapTabular} |
| 1012 |
% The environment |MapTabular| provides a convenient way to |
| 1013 |
% include a table into a block. It produces a |tabular*| |
| 1014 |
% environment and sets the width to the width of the text column |
| 1015 |
% of the block. |
| 1016 |
% |
| 1017 |
% \Block{Example}% |
| 1018 |
% \begin{verbatim} |
| 1019 |
% \Block{Table block} |
| 1020 |
% Sheding some insight on the following table. |
| 1021 |
% |
| 1022 |
% \begin{MapTabular}{lll}\toprule |
| 1023 |
% a & b & \\\midrule |
| 1024 |
% x & y & Z\\\hline |
| 1025 |
% X & Y & Z\\\bottomrule |
| 1026 |
% \end{MapTabular} \end{verbatim} |
| 1027 |
% \DescribeMacro{\MapTabularFraction} |
| 1028 |
% The tabular is always centered in the text column of the block. The |
| 1029 |
% macro |\MapTabularFraction| contains a factor for the line |
| 1030 |
% width occupied by the tabular. This value is used to determine |
| 1031 |
% the width of the tabular. The default value for the macro |
| 1032 |
% |\MapTabularFraction| is 0\MapTabularFraction. |
| 1033 |
% \begin{verbatim} |
| 1034 |
% \renewcommand\MapTabularFraction{.7} \end{verbatim} |
| 1035 |
% \vspace*{-4ex} |
| 1036 |
% \end{Map} |
| 1037 |
% |
| 1038 |
% \begin{Map}{Configuration} |
| 1039 |
% |
| 1040 |
% \Block{Introduction}% |
| 1041 |
% |limap| is designed with a set of extension points. Those are |
| 1042 |
% mainly definition which can be overwritten to achieve a certain |
| 1043 |
% effect. |
| 1044 |
% |
| 1045 |
% \Block{Configuration in the preamble}% |
| 1046 |
% Any configuration change performed in the preamble of a |
| 1047 |
% document is global. It lasts until oberwritten within the |
| 1048 |
% document. |
| 1049 |
% |
| 1050 |
% \Block{Configuration in the document}% |
| 1051 |
% The configuration parameters can be overwritten in the document |
| 1052 |
% just before they are needed. This is not recommended since it |
| 1053 |
% makes it harder to achieve consistency. |
| 1054 |
% |
| 1055 |
% \Block{External configuration}% |
| 1056 |
% The confiration can be externalised. For this purpose a special |
| 1057 |
% file |limap.cfg| is loaded with the class or package in case it |
| 1058 |
% exists. This file can contain configuration options for |
| 1059 |
% |limap|. Thus it is possible to share the same appearance |
| 1060 |
% among different documents. |
| 1061 |
% |
| 1062 |
% \Block{Contents}% |
| 1063 |
% The following maps contain the various aspects of the |
| 1064 |
% configuration of |limap|. |
| 1065 |
% \MapTableOfContents |
| 1066 |
% |
| 1067 |
% \begin{Map}{The Configuration File limap.cfg} |
| 1068 |
% |
| 1069 |
% \Block{Default configuration file}% |
| 1070 |
% When the class or package is loaded as a last action a |
| 1071 |
% configuration file is loaded if it can be found. The name of |
| 1072 |
% the configuration file is \texttt{limap.cfg}. This file can |
| 1073 |
% contain re-definitions of the several macros to adjust the |
| 1074 |
% behavior of |limap| on a per directory, per user or per |
| 1075 |
% installation base. |
| 1076 |
% |
| 1077 |
% \Block{Note}% |
| 1078 |
% Some settings are activated before the configuration file is |
| 1079 |
% loaded. Thus some settings may not have any effect at all. |
| 1080 |
% \end{Map} |
| 1081 |
% |
| 1082 |
% \begin{Map}{Changing or Adding Language Specific Settings} |
| 1083 |
% |
| 1084 |
% \Block{Overview}% |
| 1085 |
% Several strings are used automatically by the current class or |
| 1086 |
% package. Default values for several languages are hardwired in |
| 1087 |
% the implementation. Nevertheless it is possible to change those |
| 1088 |
% language specific settings. |
| 1089 |
% |
| 1090 |
% If you create settings for a new language it is highly |
| 1091 |
% recommended to contact the author to integrate them into the |
| 1092 |
% default distribution. |
| 1093 |
% |
| 1094 |
% The following macros can be redefined in the preamble after the |
| 1095 |
% package or class has been loaded to reset the language specific |
| 1096 |
% text. |
| 1097 |
% |
| 1098 |
% \DescribeMacro{\MapTOCname} |
| 1099 |
% The macro |\MapTOCname| contains the text of the heading in table |
| 1100 |
% of contents of maps for the column of map titles. It is initiated |
| 1101 |
% when the class or package is loaded. It can overwritten |
| 1102 |
% afterwards – for instance in the preamble. |
| 1103 |
% \begin{verbatim} |
| 1104 |
% \renewcommand\MapTOCname{Issue} \end{verbatim} |
| 1105 |
% |
| 1106 |
% \DescribeMacro{\MapTOCpage} |
| 1107 |
% The macro |\MapTOCpage| contains the text of the heading in table |
| 1108 |
% of contents of maps for the column of page numbers. It is initiated |
| 1109 |
% when the class or package is loaded. It can overwritten |
| 1110 |
% afterwards – for instance in the preamble. |
| 1111 |
% \begin{verbatim} |
| 1112 |
% \renewcommand\MapTOCname{Reference} \end{verbatim} |
| 1113 |
% |
| 1114 |
% \Block{Providing a new language}% |
| 1115 |
% If you want to provide a new language \textit{lang} you can |
| 1116 |
% define the macro |\LIMAP@SelectLanguage@|\textit{lang} which |
| 1117 |
% redefines the macros given above. This definition has to be |
| 1118 |
% present before the package is loaded. |
| 1119 |
% |
| 1120 |
% Note that the macro name contains the @ character. Thus the |
| 1121 |
% definition should be made in a package of its own. |
| 1122 |
% \end{Map} |
| 1123 |
% \end{Map} |
| 1124 |
% |
| 1125 |
% |
| 1126 |
%^^A%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 1127 |
% \StopEventually{} |
| 1128 |
% \newpage |
| 1129 |
% \if@undefined\environment |
| 1130 |
% \newenvironment{environment}[1]{}{} |
| 1131 |
% \fi |
| 1132 |
% |
| 1133 |
% \begin{Map}{The Implementation} |
| 1134 |
% \Block{Overview}% |
| 1135 |
% This part of the document describes the implementation. Usually |
| 1136 |
% it is not meant for the casual user. Nevertheless it might be |
| 1137 |
% fruitful for those searching for inspiration or for tricks when |
| 1138 |
% using this class or package. |
| 1139 |
% |
| 1140 |
% \Block{Contents}% |
| 1141 |
% \MapTableOfContents |
| 1142 |
% |
| 1143 |
% \begin{Map}{The Version Information} |
| 1144 |
% |
| 1145 |
% \Block{Purpose}% |
| 1146 |
% The version information is included for printing it on the |
| 1147 |
% documentation and at start-up when the class or package is |
| 1148 |
% loaded. It has to preceed the documentation driver to properly |
| 1149 |
% include this information into the printed manual. |
| 1150 |
% |
| 1151 |
% \Block{}% |
| 1152 |
% \begin{macro}{\filename} |
| 1153 |
% |\filename| is the name of the dtx file containing this class |
| 1154 |
% and package. |
| 1155 |
% \begin{macrocode} |
| 1156 |
\def\filename{limap.dtx} |
| 1157 |
% \end{macrocode} |
| 1158 |
% \end{macro} |
| 1159 |
% |
| 1160 |
% \Block{}% |
| 1161 |
% \begin{macro}{\fileversion} |
| 1162 |
% |\fileversion| is the version number of the |dtx| file. It is |
| 1163 |
% used as a version number for the class and package. |
| 1164 |
% \begin{macrocode} |
| 1165 |
\def\fileversion{2.3} |
| 1166 |
% \end{macrocode} |
| 1167 |
% \end{macro} |
| 1168 |
% |
| 1169 |
% \Block{}% |
| 1170 |
% \begin{macro}{\filedate} |
| 1171 |
% |\filedate| is the change date of the |dtx| file. It is used |
| 1172 |
% as a version date and documentation date. |
| 1173 |
% \begin{macrocode} |
| 1174 |
\def\filedate{2026/05/20} |
| 1175 |
% \end{macrocode} |
| 1176 |
% \end{macro} |
| 1177 |
% |
| 1178 |
% \Block{}% |
| 1179 |
% \begin{macro}{\docversion} |
| 1180 |
% |\docversion| is the version number of the documentation. It |
| 1181 |
% is identical to the version number of the |dtx| file. |
| 1182 |
% \begin{macrocode} |
| 1183 |
\let\docversion=\fileversion |
| 1184 |
% \end{macrocode} |
| 1185 |
% \end{macro} |
| 1186 |
% |
| 1187 |
% \Block{}% |
| 1188 |
% \begin{macro}{\docdate} |
| 1189 |
% |\docdate| is the change date of the documentation. It is |
| 1190 |
% identical to the change date of the |dtx| file. |
| 1191 |
% \begin{macrocode} |
| 1192 |
\let\docdate=\filedate |
| 1193 |
% \end{macrocode} |
| 1194 |
% \end{macro} |
| 1195 |
% \end{Map} |
| 1196 |
% |
| 1197 |
% \begin{Map}{The Documentation Driver} |
| 1198 |
% \Block{Purpose}% |
| 1199 |
% The documentation driver is necessary to provide a self |
| 1200 |
% documenting |dtx| file. With this construction the dtx file can |
| 1201 |
% be run through \LaTeX\ to produce the documentation. |
| 1202 |
% |
| 1203 |
% The driver section contains a complete \LaTeX\ document which |
| 1204 |
% loads the |dtx| file. The special class |ltxdoc| is used and |
| 1205 |
% some arrangements are made for this purpose. |
| 1206 |
% |
| 1207 |
% \Block{Driver code}% |
| 1208 |
% The driver code is not exported by the installer. |
| 1209 |
% |
| 1210 |
% \begin{macrocode} |
| 1211 |
%<*driver> |
| 1212 |
\documentclass[a4paper]{ltxdoc} |
| 1213 |
\RequirePackage{textcomp} |
| 1214 |
\usepackage{limap} |
| 1215 |
\let\LimapFilename\filename |
| 1216 |
\let\LimapFileversion\fileversion |
| 1217 |
\let\LimapFiledate\filedate |
| 1218 |
\let\LimapDocdate\docdate |
| 1219 |
% \end{macrocode} |
| 1220 |
% \Block{Page Layout}% |
| 1221 |
% \begin{macrocode} |
| 1222 |
\oddsidemargin=10pt |
| 1223 |
\evensidemargin=10pt |
| 1224 |
\textwidth=430pt |
| 1225 |
\textheight=650pt |
| 1226 |
\voffset=-12mm |
| 1227 |
% \end{macrocode} |
| 1228 |
% \Block{Headings}% |
| 1229 |
% \begin{macrocode} |
| 1230 |
\usepackage{fancyhdr} |
| 1231 |
\addtolength{\headheight}{2ex}% |
| 1232 |
\pagestyle{fancy}% |
| 1233 |
\cfoot{} |
| 1234 |
\rhead{\small\sf\thepage} |
| 1235 |
\lhead{\textit{\footnotesize limap} – Package and Class} |
| 1236 |
% \end{macrocode} |
| 1237 |
% \Block{Links and such}% |
| 1238 |
% \begin{macrocode} |
| 1239 |
\usepackage{hyperref} |
| 1240 |
% \end{macrocode} |
| 1241 |
% \Block{Fonts}% |
| 1242 |
% \begin{macrocode} |
| 1243 |
\usepackage{fontspec} |
| 1244 |
\setmainfont{TeX Gyre Heros} |
| 1245 |
\setsansfont{TeX Gyre Heros}%[Scale=MatchLowercase] |
| 1246 |
\setmonofont{Inconsolatazi4}%[Scale=MatchLowercase] |
| 1247 |
% \end{macrocode} |
| 1248 |
% \Block{Coloring}% |
| 1249 |
% \begin{macrocode} |
| 1250 |
\usepackage[svgnames]{xcolor} |
| 1251 |
\renewcommand\MapTitleFont{\Large\bfseries\color{Navy}} |
| 1252 |
\renewcommand\MapBlockLabelFont{\bfseries\color{Navy}} |
| 1253 |
\definecolor{linkColor}{rgb}{.66,.2,.2} |
| 1254 |
\hypersetup{colorlinks, |
| 1255 |
citecolor=linkColor, |
| 1256 |
filecolor=linkColor, |
| 1257 |
linkcolor=linkColor, |
| 1258 |
urlcolor=linkColor} |
| 1259 |
\renewcommand\MapRuleStart{\color{Navy}} |
| 1260 |
\renewcommand\MapRuleWidth{1pt} |
| 1261 |
% \end{macrocode} |
| 1262 |
% \Block{Graphics}% |
| 1263 |
% \begin{macrocode} |
| 1264 |
\usepackage{tikz} |
| 1265 |
\usetikzlibrary{decorations.pathmorphing} |
| 1266 |
\usetikzlibrary{shadows} |
| 1267 |
\usetikzlibrary{mindmap} |
| 1268 |
\usetikzlibrary{calc} |
| 1269 |
% \end{macrocode} |
| 1270 |
% \Block{Saving version}% |
| 1271 |
% \begin{macrocode} |
| 1272 |
\let\filename\LimapFilename |
| 1273 |
\let\fileversion\LimapFileversion |
| 1274 |
\let\filedate\LimapFiledate |
| 1275 |
\let\docdate\LimapDocdate |
| 1276 |
% \end{macrocode} |
| 1277 |
% \Block{Adapting doc.sty}% |
| 1278 |
% \begin{macrocode} |
| 1279 |
\def\theCodelineNo{\color{DarkGreen}\rmfamily\scriptsize\arabic{CodelineNo}}% |
| 1280 |
\makeatletter |
| 1281 |
\renewcommand\DescribeMacro{\catcode`\\=12\Describe@@Macro} |
| 1282 |
\def\Describe@@Macro#1{\Block{\PrintDescribeMacro{#1}}% |
| 1283 |
\SpecialUsageIndex{#1}\@esphack\ignorespaces} |
| 1284 |
\renewcommand\DescribeEnv{\catcode`\\=12\Describe@@Env} |
| 1285 |
\def\Describe@@Env#1{\Block{\PrintDescribeEnv{#1}}% |
| 1286 |
\SpecialEnvIndex{#1}\@esphack\ignorespaces} |
| 1287 |
\makeatother |
| 1288 |
\let\maketitle\MakeTitle |
| 1289 |
% \end{macrocode} |
| 1290 |
% \Block{Some additions}% |
| 1291 |
% \begin{macrocode} |
| 1292 |
\newcommand\R{\(^{\textrm{\footnotesize\textregistered}}\) } |
| 1293 |
\let\marginpar\Block |
| 1294 |
\InputIfFileExists{limap.dcf}{}{} |
| 1295 |
\RecordChanges |
| 1296 |
\EnableCrossrefs |
| 1297 |
\CodelineIndex |
| 1298 |
% \end{macrocode} |
| 1299 |
% \Block{The content}% |
| 1300 |
% Now everything is prepared. Let the show begin\ldots |
| 1301 |
% \begin{macrocode} |
| 1302 |
\begin{document} |
| 1303 |
\DeleteShortVerb{|} |
| 1304 |
\DocInput{\filename} |
| 1305 |
%\newpage |
| 1306 |
%\PrintChanges |
| 1307 |
\newpage |
| 1308 |
\setcounter{IndexColumns}{2} |
| 1309 |
\PrintIndex |
| 1310 |
\end{document} |
| 1311 |
%</driver> |
| 1312 |
% \end{macrocode} |
| 1313 |
% \end{Map} |
| 1314 |
% |
| 1315 |
% |
| 1316 |
% \begin{Map}{The \TeX\ Code} |
| 1317 |
% |
| 1318 |
% \Block{Overview}% |
| 1319 |
% The rest of the document describes the implementation. Usually |
| 1320 |
% it is not meant for the casual user. Nevertheless it might be |
| 1321 |
% fruitful for those searching for inspiration or for tricks when |
| 1322 |
% using this class or package. |
| 1323 |
% |
| 1324 |
% \Block{Contents}% |
| 1325 |
% \MapTableOfContents |
| 1326 |
% |
| 1327 |
% \begin{Map}{The Package and Class Declarations} |
| 1328 |
% |
| 1329 |
% \Block{Preliminaries}% |
| 1330 |
% First of all we request a descent version of \LaTeX\ to be |
| 1331 |
% used. I don't think it does have to be too new. |
| 1332 |
% |
| 1333 |
% \begin{macrocode} |
| 1334 |
\NeedsTeXFormat{LaTeX2e} |
| 1335 |
% \end{macrocode} |
| 1336 |
% |
| 1337 |
% \Block{Package identification}% |
| 1338 |
% When the package is generated, the package identification is |
| 1339 |
% included. |
| 1340 |
% \begin{macrocode} |
| 1341 |
%<*package> |
| 1342 |
\ProvidesPackage{limap}[\filedate\space Gerd Neugebauer] |
| 1343 |
%</package> |
| 1344 |
% \end{macrocode} |
| 1345 |
% |
| 1346 |
% \Block{Class identification}% |
| 1347 |
% When the class is generated, the class identification is |
| 1348 |
% included. |
| 1349 |
% \begin{macrocode} |
| 1350 |
%<*class> |
| 1351 |
\ProvidesClass{limap}[\filedate\space Gerd Neugebauer] |
| 1352 |
%</class> |
| 1353 |
% \end{macrocode} |
| 1354 |
% \end{Map} |
| 1355 |
% |
| 1356 |
% \begin{Map}{Language Specific Macros} |
| 1357 |
% |
| 1358 |
% \Block{Introduction}% |
| 1359 |
% This section contains internal macros used to implement the |
| 1360 |
% functionality. New languages can be easily be added. For this |
| 1361 |
% purpose only a new macro has to be defined and a package/class |
| 1362 |
% option for the convenience of the user. |
| 1363 |
% |
| 1364 |
% Consider you want to add a new language “latin” then you have |
| 1365 |
% to provide the command |\LIMAP@SelectLanguage@latin|. This |
| 1366 |
% macro should simply redefine the macros containing strings of |
| 1367 |
% the language specific texts. Examples for other languages are |
| 1368 |
% provided in this section. |
| 1369 |
% |
| 1370 |
% To enable the language settings for “latin” the macro |
| 1371 |
% |\LIMAP@Language| has to be defined to contain the value |
| 1372 |
% “latin”. Usually this is accomplished by providing a |
| 1373 |
% convenient option to the package or class. |
| 1374 |
% |
| 1375 |
% \Block{}% |
| 1376 |
% \begin{macro}{\defineLimapLanguage} |
| 1377 |
% Provide the definitions for a language. The different texts |
| 1378 |
% to be used are stored in a macro which defines the target |
| 1379 |
% macros when expanded. |
| 1380 |
% \begin{macrocode} |
| 1381 |
\def\defineLimapLanguage#1#2#3#4#5{% |
| 1382 |
\expandafter\def\csname LIMAP@SelectLanguage@#1\endcsname{% |
| 1383 |
\def\MapContinued{#2}% |
| 1384 |
\def\MapContinuing{#3}% |
| 1385 |
\def\MapTOCname{#4}% |
| 1386 |
\def\MapTOCpage{#5}% |
| 1387 |
}% |
| 1388 |
} |
| 1389 |
% \end{macrocode} |
| 1390 |
% \end{macro} |
| 1391 |
% |
| 1392 |
% \Block{Definitions for the language “austrian“}% |
| 1393 |
% \begin{macrocode} |
| 1394 |
\defineLimapLanguage{austrian}% |
| 1395 |
{ Fortsetzung}{Fortsetzung\dots}% |
| 1396 |
{Titel}{Seite} |
| 1397 |
% \end{macrocode} |
| 1398 |
% |
| 1399 |
% \Block{Definitions for the language “german“}% |
| 1400 |
% \begin{macrocode} |
| 1401 |
\defineLimapLanguage{german}% |
| 1402 |
{ Fortsetzung}{Fortsetzung\dots}% |
| 1403 |
{Titel}{Seite} |
| 1404 |
% \end{macrocode} |
| 1405 |
% |
| 1406 |
% \Block{Definitions for the language “english“}% |
| 1407 |
% \begin{macrocode} |
| 1408 |
\defineLimapLanguage{english}% |
| 1409 |
{ Continued}{Continuing\dots}% |
| 1410 |
{Title}{Page} |
| 1411 |
% \end{macrocode} |
| 1412 |
% |
| 1413 |
% \Block{Definitions for the language “USenglish“}% |
| 1414 |
% \begin{macrocode} |
| 1415 |
\defineLimapLanguage{USenglish}% |
| 1416 |
{ Continued}{Continuing\dots}% |
| 1417 |
{Title}{Page} |
| 1418 |
% \end{macrocode} |
| 1419 |
% |
| 1420 |
% \Block{Definitions for the language “french“}% |
| 1421 |
% \begin{macrocode} |
| 1422 |
\defineLimapLanguage{french}% |
| 1423 |
{ continuation}{continuation\dots}% |
| 1424 |
{Intitulé}{Page} |
| 1425 |
% \end{macrocode} |
| 1426 |
% |
| 1427 |
% \Block{}% |
| 1428 |
% \begin{macro}{\LIMAP@Language} |
| 1429 |
% The macro |\LIMAP@Language| determines the language to be |
| 1430 |
% used for several small text fragments to be inserted at |
| 1431 |
% certain places. It is redefined by package/class options and |
| 1432 |
% evaluated at the end to activate the selected settings. |
| 1433 |
% \begin{macrocode} |
| 1434 |
\providecommand\LIMAP@Language{english} |
| 1435 |
% \end{macrocode} |
| 1436 |
% \end{macro} |
| 1437 |
% |
| 1438 |
% \Block{}% |
| 1439 |
% \begin{macrocode} |
| 1440 |
\DeclareOption{austrian}{\renewcommand\LIMAP@Language{austrian}} |
| 1441 |
\DeclareOption{german}{\renewcommand\LIMAP@Language{german}} |
| 1442 |
\DeclareOption{french}{\renewcommand\LIMAP@Language{french}} |
| 1443 |
\DeclareOption{english}{\renewcommand\LIMAP@Language{english}} |
| 1444 |
\DeclareOption{USenglish}{\renewcommand\LIMAP@Language{USenglish}} |
| 1445 |
% \end{macrocode} |
| 1446 |
% |
| 1447 |
% \Block{}% |
| 1448 |
% \begin{macro}{\ifLIMAP@strict} |
| 1449 |
% The boolean |\ifLIMAP@strict| determines if the lower |
| 1450 |
% sectioning macros should be disabled in the class. |
| 1451 |
% \begin{macrocode} |
| 1452 |
\newif\ifLIMAP@strict \LIMAP@stricttrue |
| 1453 |
% \end{macrocode} |
| 1454 |
% \end{macro} |
| 1455 |
% |
| 1456 |
% \Block{}% |
| 1457 |
% \begin{macrocode} |
| 1458 |
\DeclareOption{nonstrict}{\LIMAP@strictfalse} |
| 1459 |
% \end{macrocode} |
| 1460 |
% |
| 1461 |
% \Block{}% |
| 1462 |
% \begin{macrocode} |
| 1463 |
\DeclareOption{nolines}{\def\MapRuleWidth{0pt}\ignorespaces} |
| 1464 |
% \end{macrocode} |
| 1465 |
% |
| 1466 |
% \begin{Map}{Determining the Appropriate Base Class} |
| 1467 |
% |
| 1468 |
% \Block{}% |
| 1469 |
% \begin{macrocode} |
| 1470 |
%<*class> |
| 1471 |
% \end{macrocode} |
| 1472 |
% |
| 1473 |
% \begin{macro}{\LIMAP@ClassType} |
| 1474 |
% The macro |\LIMAP@ClassType| determines the type of the class |
| 1475 |
% to be used. Usually it can take the values |book|, |report|, |
| 1476 |
% |article|, and |letter| (for completeness). This macro is |
| 1477 |
% redefined when the options of the class are evaluated. |
| 1478 |
% Finally this macro helps to select the appropriate base |
| 1479 |
% class. |
| 1480 |
% \begin{macrocode} |
| 1481 |
\providecommand\LIMAP@ClassType{report} |
| 1482 |
% \end{macrocode} |
| 1483 |
% \end{macro} |
| 1484 |
% |
| 1485 |
% \Block{}% |
| 1486 |
% \begin{macrocode} |
| 1487 |
\DeclareOption{book}{\renewcommand\LIMAP@ClassType{book}} |
| 1488 |
\DeclareOption{report}{\renewcommand\LIMAP@ClassType{report}} |
| 1489 |
\DeclareOption{article}{\renewcommand\LIMAP@ClassType{article}} |
| 1490 |
\DeclareOption{letter}{\renewcommand\LIMAP@ClassType{letter}} |
| 1491 |
% \end{macrocode} |
| 1492 |
% |
| 1493 |
% \Block{}% |
| 1494 |
% \begin{macro}{\LIMAP@Variant} |
| 1495 |
% The macro |\LIMAP@Variant| determines the variant of the |
| 1496 |
% class to be used. Usually it can take the values |base| and |
| 1497 |
% |koma|. This macro is redefined when the options of the class |
| 1498 |
% are evaluated. Finally this macro helps to select the |
| 1499 |
% appropriate base class. |
| 1500 |
% \begin{macrocode} |
| 1501 |
\providecommand\LIMAP@Variant{base} |
| 1502 |
% \end{macrocode} |
| 1503 |
% \end{macro} |
| 1504 |
% |
| 1505 |
% \Block{Options for selecting the variant}% |
| 1506 |
% \begin{macrocode} |
| 1507 |
\DeclareOption{koma}{\renewcommand\LIMAP@Variant{koma}} |
| 1508 |
\DeclareOption{base}{\renewcommand\LIMAP@Variant{base}} |
| 1509 |
% \end{macrocode} |
| 1510 |
% |
| 1511 |
% \Block{Mapping to document class}% |
| 1512 |
% Define a mapping between the variant and class type to the class |
| 1513 |
% name to be used. |
| 1514 |
% \begin{macrocode} |
| 1515 |
\newcommand\LIMAP@Class@base@article{article} |
| 1516 |
\newcommand\LIMAP@Class@base@report{report} |
| 1517 |
\newcommand\LIMAP@Class@base@book{book} |
| 1518 |
\newcommand\LIMAP@Class@base@letter{letter} |
| 1519 |
\newcommand\LIMAP@Class@koma@article{scrartcl} |
| 1520 |
\newcommand\LIMAP@Class@koma@report{scrreprt} |
| 1521 |
\newcommand\LIMAP@Class@koma@book{scrbook} |
| 1522 |
\newcommand\LIMAP@Class@koma@letter{scrlettr} |
| 1523 |
%</class> |
| 1524 |
% \end{macrocode} |
| 1525 |
% |
| 1526 |
% \Block{Pass on the unknown options}% |
| 1527 |
% \begin{macrocode} |
| 1528 |
%<*class> |
| 1529 |
\DeclareOption*{\PassOptionsToClass{\CurrentOption}{% |
| 1530 |
\csname LIMAP@Class@\LIMAP@Variant @\LIMAP@ClassType\endcsname}% |
| 1531 |
} |
| 1532 |
%</class> |
| 1533 |
% \end{macrocode} |
| 1534 |
% |
| 1535 |
% Thus the class specific options are completed. |
| 1536 |
% |
| 1537 |
% Now we can process all options. |
| 1538 |
% \begin{macrocode} |
| 1539 |
\ProcessOptions |
| 1540 |
% \end{macrocode} |
| 1541 |
% |
| 1542 |
% \Block{}% |
| 1543 |
% \begin{macrocode} |
| 1544 |
%<*class> |
| 1545 |
% \end{macrocode} |
| 1546 |
% The requested class is loaded and the options remaining are |
| 1547 |
% processed. |
| 1548 |
% \begin{macrocode} |
| 1549 |
\LoadClass{\csname |
| 1550 |
LIMAP@Class@\LIMAP@Variant @\LIMAP@ClassType\endcsname} |
| 1551 |
%</class> |
| 1552 |
% \end{macrocode} |
| 1553 |
% \end{Map} |
| 1554 |
% |
| 1555 |
% \begin{Map}{Loading Required Packages} |
| 1556 |
% |
| 1557 |
% \Block{longtable for breakable tables}% |
| 1558 |
% The package |
| 1559 |
% \href{https://www.ctan.org/pkg/longtable}{longtable} is used |
| 1560 |
% internally to implement a part of the required functionality. |
| 1561 |
% Thus we need to ensure that it is loaded. |
| 1562 |
% \begin{macrocode} |
| 1563 |
\RequirePackage{longtable} |
| 1564 |
% \end{macrocode} |
| 1565 |
% \Block{etoolbox}% |
| 1566 |
% \begin{macrocode} |
| 1567 |
\RequirePackage{etoolbox} |
| 1568 |
% \end{macrocode} |
| 1569 |
% |
| 1570 |
% \Block{booktabs for nice tables}% |
| 1571 |
% The package \href{https://www.ctan.org/pkg/booktabs}{booktabs} |
| 1572 |
% is used internally to implement a part of the required |
| 1573 |
% functionality. Thus we need to ensure that it is loaded. |
| 1574 |
% \begin{macrocode} |
| 1575 |
\RequirePackage{booktabs} |
| 1576 |
% \end{macrocode} |
| 1577 |
% |
| 1578 |
% \Block{fancyhdr for head and foot lines}% |
| 1579 |
% |
| 1580 |
% \begin{macrocode} |
| 1581 |
%<*class> |
| 1582 |
\RequirePackage{fancyhdr} |
| 1583 |
\addtolength{\headheight}{2ex}% |
| 1584 |
\pagestyle{fancy}% |
| 1585 |
\cfoot{} |
| 1586 |
\rhead{\small\thepage} |
| 1587 |
\lhead{\textit{\footnotesize\@title}} |
| 1588 |
\def\@title{} |
| 1589 |
%</class> |
| 1590 |
% \end{macrocode} |
| 1591 |
% |
| 1592 |
% \Block{No vertical adjustment of pages}% |
| 1593 |
% Since the blocks are not supposed to line up at the end of the |
| 1594 |
% page we declare |\raggedbottom|. |
| 1595 |
% \begin{macrocode} |
| 1596 |
\raggedbottom |
| 1597 |
% \end{macrocode} |
| 1598 |
% \end{Map} |
| 1599 |
% \end{Map} |
| 1600 |
% |
| 1601 |
% \begin{Map}{Layout Parameters} |
| 1602 |
% |
| 1603 |
% \Block{Overview}% |
| 1604 |
% The layout can be influenced by a large number of parameters. |
| 1605 |
% Thus the design decisions have been made transparent (to a |
| 1606 |
% certain degree at least). These options are not meant to be |
| 1607 |
% changed except when a new layout is being designed and |
| 1608 |
% implemented. |
| 1609 |
% |
| 1610 |
% \Block{}% |
| 1611 |
% \begin{macro}{\MapRuleWidth} |
| 1612 |
% The macro |\MapRuleWidth| determines the width of the rules |
| 1613 |
% drawn between blocks. |
| 1614 |
% \begin{macrocode} |
| 1615 |
\providecommand\MapRuleWidth{.25pt} |
| 1616 |
% \end{macrocode} |
| 1617 |
% \end{macro} |
| 1618 |
% |
| 1619 |
% \Block{}% |
| 1620 |
% \begin{macro}{\MapRuleStart} |
| 1621 |
% The macro |\MapRuleStart| is inserted before the rules |
| 1622 |
% drawn between blocks. |
| 1623 |
% \begin{macrocode} |
| 1624 |
\newcommand\MapRuleStart{} |
| 1625 |
% \end{macrocode} |
| 1626 |
% \end{macro} |
| 1627 |
% |
| 1628 |
% \Block{}% |
| 1629 |
% \begin{macro}{\MapContinued} |
| 1630 |
% This macro determines the text to be used in the title of |
| 1631 |
% continued maps. This macro is reset when the language |
| 1632 |
% specific initializations are performed. |
| 1633 |
% \begin{macrocode} |
| 1634 |
\newcommand\MapContinued{} |
| 1635 |
% \end{macrocode} |
| 1636 |
% \end{macro} |
| 1637 |
% |
| 1638 |
% \Block{}% |
| 1639 |
% \begin{macro}{\MapContinuing} |
| 1640 |
% The macro |\MapContinuing| determines the text to be used at |
| 1641 |
% the bottom of the map which is continued. This macro is reset |
| 1642 |
% when the language specific initializations are performed. |
| 1643 |
% \begin{macrocode} |
| 1644 |
\newcommand\MapContinuing{} |
| 1645 |
% \end{macrocode} |
| 1646 |
% \end{macro} |
| 1647 |
% |
| 1648 |
% \Block{}% |
| 1649 |
% \begin{macro}{\MapContinuingFormat} |
| 1650 |
% This macro determines the format of the bottom line on |
| 1651 |
% continued maps. I.e. it includes the text as well as font |
| 1652 |
% changing commands. The text is passed to this command as |
| 1653 |
% argument 1. |
| 1654 |
% \begin{macrocode} |
| 1655 |
\newcommand\MapContinuingFormat[1]{\textit{\footnotesize #1}} |
| 1656 |
% \end{macrocode} |
| 1657 |
% \end{macro} |
| 1658 |
% |
| 1659 |
% \Block{}% |
| 1660 |
% \begin{macro}{\MapContinuedFormat} |
| 1661 |
% This macro determines the format of the bottom line on |
| 1662 |
% continued maps. I.e. it includes the text passed to it as |
| 1663 |
% argument 1 as well as font changing commands. |
| 1664 |
% \begin{macrocode} |
| 1665 |
\newcommand\MapContinuedFormat[1]{, {\MapTitleContinuedFont #1}} |
| 1666 |
% \end{macrocode} |
| 1667 |
% \end{macro} |
| 1668 |
% |
| 1669 |
% \Block{}% |
| 1670 |
% \begin{macro}{\MapFont} |
| 1671 |
% The macro |\MapFont| determines the font changing command to |
| 1672 |
% be used when starting a new map. |
| 1673 |
% \begin{macrocode} |
| 1674 |
\let\MapFont\textsf |
| 1675 |
% \end{macrocode} |
| 1676 |
% \end{macro} |
| 1677 |
% |
| 1678 |
% \Block{}% |
| 1679 |
% \begin{macro}{\MapTitleFont} |
| 1680 |
% The macro |\MapTitleFont| determines the size changing |
| 1681 |
% command to be used when typesetting the title of a map. |
| 1682 |
% \begin{macrocode} |
| 1683 |
\let\MapTitleFont\Large |
| 1684 |
% \end{macrocode} |
| 1685 |
% \end{macro} |
| 1686 |
% |
| 1687 |
% \Block{}% |
| 1688 |
% \begin{macro}{\MapTitleContinuedFont} |
| 1689 |
% This macro determines the font changing command to be used |
| 1690 |
% for typesetting the additional text after titles on followup |
| 1691 |
% pages of multipage maps. |
| 1692 |
% \begin{macrocode} |
| 1693 |
\let\MapTitleContinuedFont\small |
| 1694 |
% \end{macrocode} |
| 1695 |
% \end{macro} |
| 1696 |
% |
| 1697 |
% \Block{}% |
| 1698 |
% \begin{macro}{\MapBlockLabelFont} |
| 1699 |
% This macro determines the font changing command to be used |
| 1700 |
% for typesetting the block label. |
| 1701 |
% \begin{macrocode} |
| 1702 |
\def\MapBlockLabelFont{} |
| 1703 |
% \end{macrocode} |
| 1704 |
% \end{macro} |
| 1705 |
% |
| 1706 |
% \Block{}% |
| 1707 |
% \begin{macro}{\MapParskip} |
| 1708 |
% The macro |\MapParskip| determines the distance of the text |
| 1709 |
% from the separating rules. |
| 1710 |
% \begin{macrocode} |
| 1711 |
\newcommand\MapParskip{2ex} |
| 1712 |
% \end{macrocode} |
| 1713 |
% \end{macro} |
| 1714 |
% |
| 1715 |
% \Block{}% |
| 1716 |
% \begin{macro}{\MapTitleFraction} |
| 1717 |
% The macro |\MapTitleFraction| determines the part of the page |
| 1718 |
% width devoted to the title area. It is a fraction in the |
| 1719 |
% range from 0 to 1. |
| 1720 |
% \begin{macrocode} |
| 1721 |
\newcommand\MapTitleFraction{.2} |
| 1722 |
% \end{macrocode} |
| 1723 |
% \end{macro} |
| 1724 |
% |
| 1725 |
% \Block{}% |
| 1726 |
% \begin{macro}{\MapTextFraction} |
| 1727 |
% This macro determines the part of the page width devoted to |
| 1728 |
% the text area. It is a fraction in the range from 0 to 1. |
| 1729 |
% |\MapTitleFraction| and |\MapTextFraction| should add up to |
| 1730 |
% something less or equal to 1. Otherwise you will get some |
| 1731 |
% “overfull hbox” messages. |
| 1732 |
% \begin{macrocode} |
| 1733 |
\newcommand\MapTextFraction{.75} |
| 1734 |
% \end{macrocode} |
| 1735 |
% \end{macro} |
| 1736 |
% \end{Map} |
| 1737 |
% |
| 1738 |
% \begin{Map}{Adaptable Macros} |
| 1739 |
% |
| 1740 |
% \Block{Overview}% |
| 1741 |
% |
| 1742 |
% \begin{macro}{\MapNewpage} |
| 1743 |
% The macro |\MapNewpage| is expanded whenever a new page is |
| 1744 |
% required between maps. Thus it can be used to suppress the |
| 1745 |
% newpages by |\let|ing it to |\relax|. |
| 1746 |
% \begin{macrocode} |
| 1747 |
\let\MapNewpage\newpage |
| 1748 |
% \end{macrocode} |
| 1749 |
% \end{macro} |
| 1750 |
% |
| 1751 |
% \Block{}% |
| 1752 |
% \begin{macro}{\MapTOC} |
| 1753 |
% The macro |\MapTOC| is expanded to generate the entry in the |
| 1754 |
% table of contents. It can be redefined to allow another |
| 1755 |
% behavior. |
| 1756 |
% \begin{macrocode} |
| 1757 |
\newcommand\MapTOC[1]{% |
| 1758 |
\refstepcounter{\@nameuse{Map@TOC@name\the\Map@level}}% |
| 1759 |
\addcontentsline{toc}{\@nameuse{Map@TOC@name\the\Map@level}}{#1}% |
| 1760 |
} |
| 1761 |
% \end{macrocode} |
| 1762 |
% \end{macro} |
| 1763 |
% |
| 1764 |
% \Block{}% |
| 1765 |
% \begin{macro}{\MapBlockTOC} |
| 1766 |
% The macro |\MapBlockTOC| can be used to add an entry for a |
| 1767 |
% block to the table of contents. |
| 1768 |
% \changes{2.2}{2017/07/20}{new} |
| 1769 |
% \begin{macrocode} |
| 1770 |
\newcommand\MapBlockTOC[1]{% |
| 1771 |
\begingroup\count0=\Map@level \advance\count0 1% |
| 1772 |
\addcontentsline{toc}{\@nameuse{Map@TOC@name\the\count0}}{#1}% |
| 1773 |
\endgroup |
| 1774 |
} |
| 1775 |
% \end{macrocode} |
| 1776 |
% \end{macro} |
| 1777 |
% |
| 1778 |
% \Block{}% |
| 1779 |
% \begin{macro}{\MapTOCname} |
| 1780 |
% The macro |\MapTOCname| contains the heading for the section |
| 1781 |
% title in contents blocks. This macro is reset when the |
| 1782 |
% language specific initializations are performed. |
| 1783 |
% \begin{macrocode} |
| 1784 |
\newcommand\MapTOCname{} |
| 1785 |
% \end{macrocode} |
| 1786 |
% \end{macro} |
| 1787 |
% |
| 1788 |
% \Block{}% |
| 1789 |
% \begin{macro}{\MapTOCpage} |
| 1790 |
% The macro |\MapTOCpage| contains the heading for the page |
| 1791 |
% number in contents blocks. This macro is reset when the |
| 1792 |
% language specific initializations are performed. |
| 1793 |
% \begin{macrocode} |
| 1794 |
\newcommand\MapTOCpage{} |
| 1795 |
% \end{macrocode} |
| 1796 |
% \end{macro} |
| 1797 |
% |
| 1798 |
% \Block{}% |
| 1799 |
% \begin{macro}{\MapTOCheadfont} |
| 1800 |
% The macro |\MapTOCheadfont| contains the font switching |
| 1801 |
% command for typesetting the head line of map table of |
| 1802 |
% contents. |
| 1803 |
% \begin{macrocode} |
| 1804 |
\newcommand\MapTOCheadfont{\scriptsize\emph} |
| 1805 |
% \end{macrocode} |
| 1806 |
% \end{macro} |
| 1807 |
% \end{Map} |
| 1808 |
% |
| 1809 |
% \begin{Map}{Internal Macros, Lengths, and Counters} |
| 1810 |
% |
| 1811 |
% \Block{}% |
| 1812 |
% This section contains internal macros used to implement the |
| 1813 |
% functionality. |
| 1814 |
% |
| 1815 |
% \Block{}% |
| 1816 |
% \begin{macro}{\Map@length} |
| 1817 |
% The length register |\Map@length| is allocated to store the |
| 1818 |
% width of the space between the columns of a block. |
| 1819 |
% \begin{macrocode} |
| 1820 |
\newlength{\Map@length} |
| 1821 |
% \end{macrocode} |
| 1822 |
% \end{macro} |
| 1823 |
% |
| 1824 |
% \Block{}% |
| 1825 |
% \begin{macro}{\Map@level} |
| 1826 |
% The macro |\Map@level| determines the level of inclusion of |
| 1827 |
% maps. It is used to determine the appearance in the table of |
| 1828 |
% contents. |
| 1829 |
% \begin{macrocode} |
| 1830 |
\newcount\Map@level |
| 1831 |
\Map@level=0 |
| 1832 |
% \end{macrocode} |
| 1833 |
% \end{macro} |
| 1834 |
% |
| 1835 |
% \Block{}% |
| 1836 |
% \begin{macro}{\Map@blockcount} |
| 1837 |
% The macro |\Map@blockcount| is used to count the blocks per |
| 1838 |
% map to issue a package warning if required. |
| 1839 |
% \begin{macrocode} |
| 1840 |
\newcount\Map@blockcount |
| 1841 |
% \end{macrocode} |
| 1842 |
% \end{macro} |
| 1843 |
% |
| 1844 |
% \Block{}% |
| 1845 |
% \begin{macro}{\LT@final@warn} |
| 1846 |
% The macro |\LT@final@warn| is defined in |longtable|. It is |
| 1847 |
% redefined to show |limap| are originator. |
| 1848 |
% \begin{macrocode} |
| 1849 |
\def\LT@final@warn{% |
| 1850 |
\AtEndDocument{% |
| 1851 |
\PackageWarning{limap}% |
| 1852 |
{Table \@width s have changed. Rerun LaTeX.\@gobbletwo}}% |
| 1853 |
\global\let\LT@final@warn\relax} |
| 1854 |
% \end{macrocode} |
| 1855 |
% \end{macro} |
| 1856 |
% \end{Map} |
| 1857 |
% |
| 1858 |
% \begin{Map}{Typesetting a Map} |
| 1859 |
% |
| 1860 |
% \Block{}% |
| 1861 |
% \begin{environment}{Map} |
| 1862 |
% The environment |Map|determines the appearance of a map. It is |
| 1863 |
% implemented as a |longtable| environment which takes care for |
| 1864 |
% the page breaks and inserts material at the end of the page |
| 1865 |
% and the beginning of the new page upon page break. |
| 1866 |
% \end{environment} |
| 1867 |
% \begin{macrocode} |
| 1868 |
\def\Map#1{% |
| 1869 |
% \end{macrocode} |
| 1870 |
% First the messages of |longtable| are modified to show this |
| 1871 |
% package name instead. |
| 1872 |
% \begin{macrocode} |
| 1873 |
\def\LT@err{\PackageError{limap}}% |
| 1874 |
\def\LT@warn{\PackageWarning{limap}}% |
| 1875 |
% \end{macrocode} |
| 1876 |
% \Block{}% |
| 1877 |
% The map local macro |\Block| is |
| 1878 |
% activated. The counter for blocks is reset. |
| 1879 |
% \begin{macrocode} |
| 1880 |
\let\Block\Map@Block |
| 1881 |
\let\endBlock\Map@endBlock |
| 1882 |
\Map@blockcount=0 |
| 1883 |
% \end{macrocode} |
| 1884 |
% \Block{}% |
| 1885 |
% The number of the map in the internal counting is set by |
| 1886 |
% incrementing the old value. |
| 1887 |
% \begin{macrocode} |
| 1888 |
\global\advance\Map@no1 |
| 1889 |
% \end{macrocode} |
| 1890 |
% \Block{}% |
| 1891 |
% |
| 1892 |
% \begin{macrocode} |
| 1893 |
\ifx\Map@UP\empty\else |
| 1894 |
\immediate\write\@auxout |
| 1895 |
{\string\expandafter\string\xdef\string\csname\space |
| 1896 |
Map@parts@\Map@UP\string\endcsname{\string\csname\space |
| 1897 |
Map@parts@\Map@UP\string\endcsname\the\Map@no:}}% |
| 1898 |
\fi |
| 1899 |
% \end{macrocode} |
| 1900 |
% \Block{}% |
| 1901 |
% |
| 1902 |
% \begin{macrocode} |
| 1903 |
\edef\Map@UP{\the\Map@no}% |
| 1904 |
\ifnum\Map@level>0 |
| 1905 |
\xdef\Map@@up{\Map@UP}% Just to save the value across blocks. |
| 1906 |
\endgroup |
| 1907 |
\Map@end |
| 1908 |
\begingroup |
| 1909 |
\edef\Map@UP{\Map@@up}% |
| 1910 |
\def\@currenvir{Map}% |
| 1911 |
\fi |
| 1912 |
\edef\Map@this{\the\Map@no}% |
| 1913 |
% \end{macrocode} |
| 1914 |
% \Block{}% |
| 1915 |
% The entries for future use of sub-maps are written to the |aux| file. |
| 1916 |
% \begin{macrocode} |
| 1917 |
\immediate\write\@auxout |
| 1918 |
{\string\global\string\@namedef{Map@parts@\the\Map@no}{}}% |
| 1919 |
% \end{macrocode} |
| 1920 |
% \Block{}% |
| 1921 |
% |
| 1922 |
% \begin{macrocode} |
| 1923 |
\global\advance\Map@level1 |
| 1924 |
\def\Map@TITLE{#1}% |
| 1925 |
\Map@start |
| 1926 |
} |
| 1927 |
% \end{macrocode} |
| 1928 |
% \Block{}% |
| 1929 |
% |
| 1930 |
% \begin{macrocode} |
| 1931 |
\def\endMap{% |
| 1932 |
\Map@end |
| 1933 |
\global\advance\Map@level-1 |
| 1934 |
\ignorespaces |
| 1935 |
} |
| 1936 |
% \end{macrocode} |
| 1937 |
% |
| 1938 |
% \Block{}% |
| 1939 |
% \begin{macro}{\ifMap@open@} |
| 1940 |
% The conditional |\ifMap@open@| is used to record the opening |
| 1941 |
% and closing of the |longtable| environment, since can not be |
| 1942 |
% used inside itself. Thus it can be closed before a new |
| 1943 |
% instance is opened. |
| 1944 |
% \begin{macrocode} |
| 1945 |
\newif\ifMap@open@ |
| 1946 |
\Map@open@false |
| 1947 |
% \end{macrocode} |
| 1948 |
% \end{macro} |
| 1949 |
% |
| 1950 |
% \Block{}% |
| 1951 |
% \begin{macro}{\Map@TOC@name} |
| 1952 |
% The macros |\Map@TOC@name|\dots provide a mapping between a |
| 1953 |
% number and a sectioning unit. This mapping is used when the |
| 1954 |
% entry in the table of contents is generated. |
| 1955 |
% \begin{macrocode} |
| 1956 |
\@namedef{Map@TOC@name0}{chapter} |
| 1957 |
\@namedef{Map@TOC@name1}{section} |
| 1958 |
\@namedef{Map@TOC@name2}{subsection} |
| 1959 |
\@namedef{Map@TOC@name3}{subsubsection} |
| 1960 |
\@namedef{Map@TOC@name4}{paragraph} |
| 1961 |
\@namedef{Map@TOC@name5}{subparagraph} |
| 1962 |
\@namedef{Map@TOC@name6}{subsubparagraph} |
| 1963 |
\@namedef{Map@TOC@name7}{subsubparagraph} |
| 1964 |
\@namedef{Map@TOC@name8}{subsubparagraph} |
| 1965 |
\@namedef{Map@TOC@name9}{subsubparagraph} |
| 1966 |
\@namedef{Map@TOC@name10}{subsubparagraph} |
| 1967 |
\@namedef{Map@TOC@name11}{subsubparagraph} |
| 1968 |
\@namedef{Map@TOC@name12}{subsubparagraph} |
| 1969 |
% \end{macrocode} |
| 1970 |
% \end{macro} |
| 1971 |
% |
| 1972 |
% \Block{}% |
| 1973 |
% \begin{macro}{\Map@start} |
| 1974 |
% The macro |\Map@start| is used to initiate the use of a map. |
| 1975 |
% It takes no arguments. The map title is passed in via the |
| 1976 |
% macro |\Map@TITLE|. |
| 1977 |
% |
| 1978 |
% It uses the |longtable| environment to perform the page |
| 1979 |
% breaking and marking of continued pages. |
| 1980 |
% \begin{macrocode} |
| 1981 |
\newcommand\Map@start{% |
| 1982 |
\advance\Map@counter1 |
| 1983 |
\setlength{\Map@length}{\textwidth}% |
| 1984 |
\addtolength{\Map@length}{-\MapTitleFraction\textwidth}% |
| 1985 |
\addtolength{\Map@length}{-\MapTextFraction\textwidth}% |
| 1986 |
\ifx\Map@TITLE\empty\else |
| 1987 |
\MapTOC{\Map@TITLE}% |
| 1988 |
\fi |
| 1989 |
\longtable |
| 1990 |
{@{}p{\MapTitleFraction\textwidth}@{\hspace{\Map@length}} |
| 1991 |
p{\MapTextFraction\textwidth}@{}}% |
| 1992 |
\multicolumn{2}{@{}p{\textwidth}@{}}{% |
| 1993 |
\MapFont{\MapTitleFont\rule{0pt}{3ex}% |
| 1994 |
\Map@TITLE}} |
| 1995 |
\endfirsthead |
| 1996 |
\multicolumn{2}{@{}p{\textwidth}@{}}{% |
| 1997 |
\MapFont{\MapTitleFont\rule{0pt}{3ex}% |
| 1998 |
\Map@TITLE\MapContinuedFormat{\MapContinued}}}% |
| 1999 |
\endhead |
| 2000 |
\\ |
| 2001 |
&\MapRuleStart |
| 2002 |
\rule{\MapTextFraction\textwidth}{\MapRuleWidth}\newline |
| 2003 |
\mbox{}\hfill |
| 2004 |
\raisebox{3pt}{\MapContinuingFormat{\MapContinuing}} |
| 2005 |
\endfoot |
| 2006 |
&\MapRuleStart |
| 2007 |
\rule{\MapTextFraction\textwidth}{\MapRuleWidth}% |
| 2008 |
\vspace{\MapParskip} |
| 2009 |
\endlastfoot |
| 2010 |
\xdef\@currentlabel{\Map@TITLE}% |
| 2011 |
\label{Map@\the\Map@no}% |
| 2012 |
\global\Map@open@true |
| 2013 |
} |
| 2014 |
% \end{macrocode} |
| 2015 |
% \end{macro} |
| 2016 |
% |
| 2017 |
% \Block{}% |
| 2018 |
% \begin{macro}{\Map@end} |
| 2019 |
% The macro |\Map@end| is expanded when the end of the end of |
| 2020 |
% the |longtable| environment might be needed. The boolean |
| 2021 |
% |\ifMap@open@| determines whether such an environment is |
| 2022 |
% really open. |
| 2023 |
% \begin{macrocode} |
| 2024 |
\newcommand\Map@end{% |
| 2025 |
\ifMap@open@\vspace*{1.5ex} |
| 2026 |
\global\Map@open@false |
| 2027 |
\endlongtable |
| 2028 |
\MapNewpage |
| 2029 |
\fi |
| 2030 |
\iftrue |
| 2031 |
\ifnum\Map@blockcount>9 |
| 2032 |
\PackageWarning{limap}% |
| 2033 |
{*** The current map contains too much blocks: |
| 2034 |
\the\Map@blockcount}% |
| 2035 |
\else\ifnum\Map@blockcount>7 |
| 2036 |
\PackageWarning{limap}% |
| 2037 |
{--- The current map contains \the\Map@blockcount blocks.}% |
| 2038 |
\fi\fi |
| 2039 |
\fi |
| 2040 |
} |
| 2041 |
% \end{macrocode} |
| 2042 |
% \end{macro} |
| 2043 |
% |
| 2044 |
% \Block{}% |
| 2045 |
% \begin{macro}{\Map@UP} |
| 2046 |
% The macro |\Map@UP| contains the number of the parent map or |
| 2047 |
% the empty string. |
| 2048 |
% \begin{macrocode} |
| 2049 |
\newcommand\Map@UP{} |
| 2050 |
% \end{macrocode} |
| 2051 |
% \end{macro} |
| 2052 |
% |
| 2053 |
% \Block{}% |
| 2054 |
% \begin{macro}{\Map@no} |
| 2055 |
% The counter |\Map@no| contains the sequence number for all |
| 2056 |
% maps. This value is used internally to reference single maps. |
| 2057 |
% \begin{macrocode} |
| 2058 |
\newcount\Map@no |
| 2059 |
% \end{macrocode} |
| 2060 |
% \end{macro} |
| 2061 |
% |
| 2062 |
% \Block{}% |
| 2063 |
% \begin{macro}{\Map@counter} |
| 2064 |
% The counter |\Map@counter| contains the number of a map in |
| 2065 |
% the context of the containing map . |
| 2066 |
% \begin{macrocode} |
| 2067 |
\newcount\Map@counter |
| 2068 |
\Map@counter=0 |
| 2069 |
% \end{macrocode} |
| 2070 |
% \end{macro} |
| 2071 |
% |
| 2072 |
% \Block{}% |
| 2073 |
% \begin{macro}{\Map@parts@} |
| 2074 |
% The macro |\Map@parts@| is used to store the parts of the |
| 2075 |
% top-level maps. This is the initialization of a feature |
| 2076 |
% otherwise used in the aux file. |
| 2077 |
% \begin{macrocode} |
| 2078 |
\@namedef{Map@parts@}{} |
| 2079 |
% \end{macrocode} |
| 2080 |
% \end{macro} |
| 2081 |
% \end{Map} |
| 2082 |
% |
| 2083 |
% \begin{Map}{Typesetting a Block} |
| 2084 |
% |
| 2085 |
% \Block{}% |
| 2086 |
% Blocks are the basic building unit of maps. Here the Block is |
| 2087 |
% defined in all it's beauty. |
| 2088 |
% |
| 2089 |
% \begin{environment}{Map@Block} |
| 2090 |
% This macro is used to typeset a block inside a Map. To avoid |
| 2091 |
% abuse outside of a map it is activated within a Map only. |
| 2092 |
% \changes{2.2}{2017/07/20}{|MapBlockStartHook| added.} |
| 2093 |
% \begin{macrocode} |
| 2094 |
\newenvironment{Map@Block}[1]{\par |
| 2095 |
\vspace*{-\parskip}\vspace*{-1ex}% |
| 2096 |
\\\null\par |
| 2097 |
\vspace*{\MapParskip}% |
| 2098 |
\raggedright\hspace{0pt}\MapFont{\MapBlockLabelFont{#1}}% |
| 2099 |
\gdef\@currentlabel{#1}% |
| 2100 |
&\parskip=\MapParskip |
| 2101 |
{\MapRuleStart |
| 2102 |
\rule{\MapTextFraction\textwidth}{\MapRuleWidth}}\par |
| 2103 |
\ifx\@undefined\MapBlockStartHook\else |
| 2104 |
\MapBlockStartHook{#1}% |
| 2105 |
\fi |
| 2106 |
% \end{macrocode} |
| 2107 |
% |
| 2108 |
% The final action is empty. Thus the block can be used as a simple |
| 2109 |
% macro as well. |
| 2110 |
% \begin{macrocode} |
| 2111 |
}{% |
| 2112 |
} |
| 2113 |
% \end{macrocode} |
| 2114 |
% \end{environment} |
| 2115 |
% |
| 2116 |
% \Block{}% |
| 2117 |
% \begin{macro}{\Block} |
| 2118 |
% The macro |\Block| issues an error when used outside of a Map |
| 2119 |
% environment. |
| 2120 |
% \begin{macrocode} |
| 2121 |
\newcommand\Block[1]{\PackageWarning{limap}{The sectioning command |
| 2122 |
`Block' has been encountered outside the scope of a Map |
| 2123 |
environment.}} |
| 2124 |
% \end{macrocode} |
| 2125 |
% \end{macro} |
| 2126 |
% |
| 2127 |
% \Block{}% |
| 2128 |
% \begin{macro}{\WideBlock} |
| 2129 |
% The macro |\WideBlock| takes one argument which is added to |
| 2130 |
% the current block where the whole width of the table is used. |
| 2131 |
% \begin{macrocode} |
| 2132 |
\newcommand\WideBlock{\\\multicolumn2{@{}l@{}}} |
| 2133 |
% \end{macrocode} |
| 2134 |
% \end{macro} |
| 2135 |
% \end{Map} |
| 2136 |
% |
| 2137 |
% \begin{Map}{Typesetting a Table of Contents} |
| 2138 |
% |
| 2139 |
% |
| 2140 |
% \Block{}% |
| 2141 |
% \begin{macrocode} |
| 2142 |
\newif\if@Map@toc@sep@ |
| 2143 |
% \end{macrocode} |
| 2144 |
% |
| 2145 |
% \Block{}% |
| 2146 |
% \begin{macro}{\MapTableOfContents@open} |
| 2147 |
% The macro |\MapTableOfContents@open| produces the table of |
| 2148 |
% contents for the current map. It produces a tabular |
| 2149 |
% containing the titles and pages of all maps directly |
| 2150 |
% contained in the current map. It utilizes a tabular |
| 2151 |
% environment and booktabs. |
| 2152 |
% \begin{macrocode} |
| 2153 |
\def\MapTableOfContents@open{% |
| 2154 |
\centering |
| 2155 |
\begin{tabular}{p{.6\textwidth}r}\toprule |
| 2156 |
\MapTOCheadfont{\MapTOCname}& |
| 2157 |
\MapTOCheadfont{\MapTOCpage}\\\midrule |
| 2158 |
\ifcsdef{Map@parts@\the\Map@no}{ |
| 2159 |
\edef\Map@tmp@{\csname Map@parts@\the\Map@no\endcsname:}% |
| 2160 |
\expandafter\Map@toc@loop\Map@tmp@ |
| 2161 |
\\\bottomrule |
| 2162 |
}{} |
| 2163 |
\end{tabular} |
| 2164 |
} |
| 2165 |
% \end{macrocode} |
| 2166 |
% \end{macro} |
| 2167 |
% |
| 2168 |
% \Block{}% |
| 2169 |
% \begin{macro}{\MapTableOfContents@boxed} |
| 2170 |
% The macro |MapTableOfContents@boxed| produces the table of |
| 2171 |
% contents for the current map. It produces a tabular |
| 2172 |
% containing the titles and pages of all maps directly |
| 2173 |
% contained in the current map. It utilizes a tabular |
| 2174 |
% environment and booktabs. |
| 2175 |
% \begin{macrocode} |
| 2176 |
\def\MapTableOfContents@boxed{% |
| 2177 |
\centering |
| 2178 |
\begin{tabular}{|p{.6\textwidth}|r|}\hline |
| 2179 |
\MapTOCheadfont{\MapTOCname}& |
| 2180 |
\MapTOCheadfont{\MapTOCpage}\\\hline |
| 2181 |
\ifcsdef{Map@parts@\the\Map@no}{ |
| 2182 |
\edef\Map@tmp@{\csname Map@parts@\the\Map@no\endcsname:}% |
| 2183 |
\expandafter\Map@toc@loop\Map@tmp@ |
| 2184 |
\\\hline |
| 2185 |
}{} |
| 2186 |
\end{tabular} |
| 2187 |
} |
| 2188 |
% \end{macrocode} |
| 2189 |
% \end{macro} |
| 2190 |
% |
| 2191 |
% \Block{}% |
| 2192 |
% \begin{macro}{\MapTableOfContentsStyle} |
| 2193 |
% The macro |MapTableOfContentsStyle| determines the style of |
| 2194 |
% the TOCs. It can take the values |open| or |boxed|. |
| 2195 |
% \begin{macrocode} |
| 2196 |
\newcommand\MapTableOfContentsStyle{open} |
| 2197 |
% \end{macrocode} |
| 2198 |
% \end{macro} |
| 2199 |
% |
| 2200 |
% \Block{}% |
| 2201 |
% \begin{macro}{\MapTableOfContents} |
| 2202 |
% The macro |MapTableOfContents| produces the table of |
| 2203 |
% contents for the current map. It produces a tabular |
| 2204 |
% containing the titles and pages of all maps directly |
| 2205 |
% contained in the current map. |
| 2206 |
% \begin{macrocode} |
| 2207 |
\newcommand\MapTableOfContents{\par |
| 2208 |
\global\@Map@toc@sep@false |
| 2209 |
\csname MapTableOfContents@\MapTableOfContentsStyle\endcsname |
| 2210 |
\vspace*{-1.5\parskip}\par\ignorespaces |
| 2211 |
} |
| 2212 |
% \end{macrocode} |
| 2213 |
% \end{macro} |
| 2214 |
% |
| 2215 |
% \Block{}% |
| 2216 |
% \begin{macro}{\Map@toc@loop} |
| 2217 |
% The macro |\Map@toc@loop| is a recursive solution to loop |
| 2218 |
% through all elements of a list of children. The argment is |
| 2219 |
% expected to be a colon separated list of numbers. The end is |
| 2220 |
% marked by two colons in row. |
| 2221 |
% |
| 2222 |
% Each number is a reference to a map. The respective line in |
| 2223 |
% the toc table is produced. |
| 2224 |
% \begin{macrocode} |
| 2225 |
\def\Map@toc@loop#1:{% |
| 2226 |
\def\Map@tmp@{#1}% |
| 2227 |
\ifx\Map@tmp@\empty |
| 2228 |
\global\let\Map@next@=\relax |
| 2229 |
\else |
| 2230 |
\if@Map@toc@sep@ |
| 2231 |
\gdef\Map@next@{\\ |
| 2232 |
\ref{Map@#1}&\pageref{Map@#1}% |
| 2233 |
\Map@toc@loop}% |
| 2234 |
\else |
| 2235 |
\gdef\Map@next@{% |
| 2236 |
\ref{Map@#1}&\pageref{Map@#1}% |
| 2237 |
\Map@toc@loop}% |
| 2238 |
\global\@Map@toc@sep@true |
| 2239 |
\fi |
| 2240 |
\fi |
| 2241 |
\Map@next@ |
| 2242 |
} |
| 2243 |
% \end{macrocode} |
| 2244 |
% \end{macro} |
| 2245 |
% \end{Map} |
| 2246 |
% |
| 2247 |
% \begin{Map}{Typesetting a Table} |
| 2248 |
% |
| 2249 |
% \Block{}% |
| 2250 |
% \begin{macro}{\MapTabularFraction} |
| 2251 |
% The macro |\MapTabularFraction| contains a factor for the line |
| 2252 |
% width. This is used to determine the width of the table. The |
| 2253 |
% tabular is centered in the text column. |
| 2254 |
% \begin{macrocode} |
| 2255 |
\newcommand\MapTabularFraction{.95} |
| 2256 |
% \end{macrocode} |
| 2257 |
% \end{macro} |
| 2258 |
% |
| 2259 |
% \Block{}% |
| 2260 |
% \begin{environment}{MapTabular} |
| 2261 |
% The environment |MapTabular| produces the |tabular| environment |
| 2262 |
% with the width of the text column. |
| 2263 |
% \begin{macrocode} |
| 2264 |
\newenvironment{MapTabular}{% |
| 2265 |
\begin{center} |
| 2266 |
\begin{tabular*}{\MapTabularFraction\linewidth}% |
| 2267 |
}{% |
| 2268 |
\end{tabular*} |
| 2269 |
\end{center}\ignorespaces |
| 2270 |
} |
| 2271 |
% \end{macrocode} |
| 2272 |
% \end{environment} |
| 2273 |
% \end{Map} |
| 2274 |
% |
| 2275 |
% \begin{Map}{Typesetting the Title Page} |
| 2276 |
% |
| 2277 |
% \Block{}% |
| 2278 |
% \begin{macro}{\MakeTitle} |
| 2279 |
% The macro |\MakeTitle| can be used as a replacement for the |
| 2280 |
% |\maketitle| macro. |
| 2281 |
% \begin{macrocode} |
| 2282 |
\newcommand\MakeTitle{\thispagestyle{empty} |
| 2283 |
\rule{0pt}{.25\textheight}\par |
| 2284 |
\mbox{}\hfill |
| 2285 |
\begin{minipage}{\MapTextFraction\textwidth} |
| 2286 |
\raggedright |
| 2287 |
\rule{\textwidth}{2pt}\par |
| 2288 |
\vspace*{2.5\MapParskip}% |
| 2289 |
\sf{\huge \@title\par}% |
| 2290 |
\vspace*{2.5\MapParskip}% |
| 2291 |
\rule{\textwidth}{2pt}\par |
| 2292 |
\vspace*{2.5\MapParskip}% |
| 2293 |
\MapFont{\large \@author} \par |
| 2294 |
\vspace*{2.5\MapParskip}% |
| 2295 |
\MapFont{\footnotesize \@date} |
| 2296 |
\vspace*{\MapParskip}% |
| 2297 |
\end{minipage}% |
| 2298 |
\vspace*{-22ex}% |
| 2299 |
\par |
| 2300 |
} |
| 2301 |
% \end{macrocode} |
| 2302 |
% \end{macro} |
| 2303 |
% |
| 2304 |
% \Block{}% |
| 2305 |
% \begin{environment}{Abstract} |
| 2306 |
% This macro is used to typeset the abstract. |
| 2307 |
% \begin{macrocode} |
| 2308 |
\newenvironment{Abstract}{\vfill |
| 2309 |
\par |
| 2310 |
\mbox{}\hfill |
| 2311 |
\begin{minipage}{\MapTextFraction\textwidth}\parskip=1ex |
| 2312 |
\rule{\textwidth}{1pt}\medskip\par |
| 2313 |
% \end{macrocode} |
| 2314 |
% |
| 2315 |
% \begin{macrocode} |
| 2316 |
}{\par\rule{\textwidth}{1pt} |
| 2317 |
\end{minipage}% |
| 2318 |
\par |
| 2319 |
} |
| 2320 |
% \end{macrocode} |
| 2321 |
% \end{environment} |
| 2322 |
% |
| 2323 |
% \Block{Use maketitle and abstract}% |
| 2324 |
% The new |\maketitle| macro is activated for the class. |
| 2325 |
% |
| 2326 |
% \begin{macrocode} |
| 2327 |
%<*class> |
| 2328 |
\let\maketitle\MakeTitle |
| 2329 |
\let\abstract\Abstract |
| 2330 |
\let\endabstract\endAbstract |
| 2331 |
%</class> |
| 2332 |
% \end{macrocode} |
| 2333 |
% \end{Map} |
| 2334 |
% |
| 2335 |
% \begin{Map}{Final Actions} |
| 2336 |
% |
| 2337 |
% \Block{Local configuration}% |
| 2338 |
% Load the configuration file at the end if it can be found. |
| 2339 |
% \begin{macrocode} |
| 2340 |
\InputIfFileExists{limap.cfg}{}{} |
| 2341 |
% \end{macrocode} |
| 2342 |
% |
| 2343 |
% \Block{}% |
| 2344 |
% Finally we have to activate the proper settings for the chosen |
| 2345 |
% language. |
| 2346 |
% \begin{macrocode} |
| 2347 |
\csname LIMAP@SelectLanguage@\LIMAP@Language\endcsname |
| 2348 |
% \end{macrocode} |
| 2349 |
% |
| 2350 |
% \begin{macrocode} |
| 2351 |
\ifLIMAP@strict |
| 2352 |
\def\chapter{\PackageWarning{limap}{The sectioning command |
| 2353 |
`chapter' is not available.}} |
| 2354 |
% \def\section{\PackageWarning{limap}{The sectioning command |
| 2355 |
% `section' is not available.}} |
| 2356 |
\def\subsection{\PackageWarning{limap}{The sectioning command |
| 2357 |
`subsection' is not available.}} |
| 2358 |
\def\subsubsection{\PackageWarning{limap}{The sectioning command |
| 2359 |
`subsubsection' is not available.}} |
| 2360 |
\def\paragraph{\PackageWarning{limap}{The sectioning command |
| 2361 |
`paragraph' is not available.}} |
| 2362 |
\def\subparagraph{\PackageWarning{limap}{The sectioning command |
| 2363 |
`subparagraph' is not available.}} |
| 2364 |
\def\subsubparagraph{\PackageWarning{limap}{The sectioning command |
| 2365 |
`subsubparagraph' is not available.}} |
| 2366 |
\fi |
| 2367 |
% \end{macrocode} |
| 2368 |
% |
| 2369 |
% \Block{Finale}% |
| 2370 |
% That's all for this time. |
| 2371 |
% \end{Map} |
| 2372 |
% \end{Map} |
| 2373 |
% \end{Map} |
| 2374 |
% |
| 2375 |
% \Finale |
| 2376 |
% |
| 2377 |
\endinput |
| 2378 |
% |
| 2379 |
% Local Variables: |
| 2380 |
% mode: latex |
| 2381 |
% TeX-master: "limap.dtx" |
| 2382 |
% End: |