| 1 |
%%% |
| 2 |
% driver file of changes package |
| 3 |
\newcommand{\docversion}{4.2.1} |
| 4 |
|
| 5 |
\documentclass[titlepage, parskip=half, toc=flat, cleardoublepage=empty, captions=nooneline, origlongtable, english]{scrartcl} |
| 6 |
|
| 7 |
% code definition and documentation |
| 8 |
\usepackage{doc} |
| 9 |
|
| 10 |
% basis layout |
| 11 |
\usepackage[font=charter, oneside]{basis} |
| 12 |
|
| 13 |
% listings |
| 14 |
\usepackage{listings} |
| 15 |
\lstset{ |
| 16 |
language=[AlLaTeX]TeX, |
| 17 |
float=hbp, |
| 18 |
numberstyle=\tiny\ttfamily, |
| 19 |
basicstyle=\ttfamily, |
| 20 |
identifierstyle=\color{DimGrey}, |
| 21 |
morekeywords={ |
| 22 |
}, |
| 23 |
keywordstyle=\color{SteelBlue}, |
| 24 |
commentstyle=\itshape\color{Thistle}, |
| 25 |
backgroundcolor=\color{PapayaWhip}, |
| 26 |
columns=fixed, |
| 27 |
tabsize=4, |
| 28 |
frame=single, |
| 29 |
extendedchars=true, |
| 30 |
showspaces=false, |
| 31 |
showstringspaces=false, |
| 32 |
numbers=none, |
| 33 |
breaklines=true, |
| 34 |
breakindent=3em, |
| 35 |
breakautoindent=true, |
| 36 |
captionpos=t, |
| 37 |
xleftmargin=1em, |
| 38 |
xrightmargin=1em, |
| 39 |
lineskip=0pt, |
| 40 |
numbersep=1em, |
| 41 |
classoffset=1, |
| 42 |
morekeywords={ |
| 43 |
added, |
| 44 |
changes, |
| 45 |
color, |
| 46 |
comment, |
| 47 |
deleted, |
| 48 |
definechangesauthor, |
| 49 |
highlight, |
| 50 |
listofchanges, |
| 51 |
replaced, |
| 52 |
style, |
| 53 |
% |
| 54 |
draft, |
| 55 |
final, |
| 56 |
markup, |
| 57 |
addedmarkup, |
| 58 |
deletedmarkup, |
| 59 |
highlightmarkup, |
| 60 |
commentmarkup, |
| 61 |
authormarkup, |
| 62 |
authormarkupposition, |
| 63 |
authormarkuptext, |
| 64 |
todonotes, |
| 65 |
truncate, |
| 66 |
ulem, |
| 67 |
xcolor, |
| 68 |
% |
| 69 |
default, |
| 70 |
underlined, |
| 71 |
bfit, |
| 72 |
nocolor, |
| 73 |
% |
| 74 |
colored, |
| 75 |
uline, |
| 76 |
uuline, |
| 77 |
uwave, |
| 78 |
dashuline, |
| 79 |
dotuline, |
| 80 |
bf, |
| 81 |
it, |
| 82 |
sl, |
| 83 |
em, |
| 84 |
% |
| 85 |
sout, |
| 86 |
xout, |
| 87 |
% |
| 88 |
background, |
| 89 |
% |
| 90 |
todo, |
| 91 |
margin, |
| 92 |
footnote, |
| 93 |
% |
| 94 |
superscript, |
| 95 |
subscript, |
| 96 |
brackets, |
| 97 |
none, |
| 98 |
% |
| 99 |
right, |
| 100 |
left, |
| 101 |
% |
| 102 |
id, |
| 103 |
name, |
| 104 |
% |
| 105 |
title, |
| 106 |
show, |
| 107 |
% |
| 108 |
list, |
| 109 |
summary, |
| 110 |
compactsummary, |
| 111 |
% |
| 112 |
setaddedmarkup, |
| 113 |
setdeletedmarkup, |
| 114 |
sethighlightmarkup, |
| 115 |
setcommentmarkup, |
| 116 |
setauthormarkup, |
| 117 |
setauthormarkupposition, |
| 118 |
setauthormarkuptext, |
| 119 |
settruncatewidth, |
| 120 |
setsummarywidth, |
| 121 |
setsummarytowidth, |
| 122 |
setsocextension, |
| 123 |
}, |
| 124 |
keywordstyle=\color{Peru}, |
| 125 |
moredelim=[s][\color{SlateGrey}]{<}{>}, |
| 126 |
classoffset=0, |
| 127 |
escapechar=! |
| 128 |
} |
| 129 |
|
| 130 |
% minitocs |
| 131 |
\usepackage{etoc} |
| 132 |
\etocsettocstyle{}{} |
| 133 |
|
| 134 |
% language selection |
| 135 |
\selectlanguage{english} |
| 136 |
|
| 137 |
% use change management ;) |
| 138 |
\usepackage{changes} |
| 139 |
\definechangesauthor[name={Ekkart Kleinod}, color=Sienna]{EK} |
| 140 |
\setcommentmarkup{% |
| 141 |
\IfIsColored% |
| 142 |
{% |
| 143 |
\IfIsAnonymous{#2}% |
| 144 |
{% |
| 145 |
\todo[color=authorcolor!10, bordercolor=authorcolor, linecolor=authorcolor!70, nolist]{\footnotesize\textbf{[\arabic{authorcommentcount}]} #1}% |
| 146 |
}{% |
| 147 |
\todo[color=authorcolor!10, bordercolor=authorcolor, linecolor=authorcolor!70, nolist]{\footnotesize\textbf{[#3~\arabic{authorcommentcount}]} #1}% |
| 148 |
}% |
| 149 |
}{% |
| 150 |
\IfIsAnonymous{#2}% |
| 151 |
{% |
| 152 |
\todo[color=black!0, bordercolor=black, linecolor=black!70, nolist]{\footnotesize\textbf{[\arabic{authorcommentcount}]} #1}% |
| 153 |
}{% |
| 154 |
\todo[color=black!0, bordercolor=black, linecolor=black!70, nolist]{\footnotesize\textbf{[#3~\arabic{authorcommentcount}]:} #1}% |
| 155 |
}% |
| 156 |
}% |
| 157 |
}% |
| 158 |
|
| 159 |
% full index |
| 160 |
\EnableCrossrefs |
| 161 |
|
| 162 |
% with line numbers |
| 163 |
\CodelineIndex |
| 164 |
|
| 165 |
% formatting |
| 166 |
\newcommand{\docpackage}[1]{\textsl{#1}} |
| 167 |
\newcommand{\docoption}[1]{\texttt{#1}} |
| 168 |
\newcommand{\doccommand}[1]{\texttt{\textbackslash{}#1}} |
| 169 |
|
| 170 |
% additional description list formatting |
| 171 |
\newlength{\mylabelwidth} |
| 172 |
\settowidth{\mylabelwidth}{\texttt{compactsummarym}} |
| 173 |
\setlist[description]{style=nextline, font=\normalfont, leftmargin=\mylabelwidth} |
| 174 |
|
| 175 |
% catchall - english |
| 176 |
\newif\ifENGLISH |
| 177 |
\ENGLISHtrue |
| 178 |
|
| 179 |
% german |
| 180 |
\newif\ifGERMAN |
| 181 |
\GERMANfalse |
| 182 |
\iflanguage{ngerman}{\GERMANtrue\ENGLISHfalse}{} |
| 183 |
\iflanguage{german}{\GERMANtrue\ENGLISHfalse}{} |
| 184 |
|
| 185 |
% example environment |
| 186 |
\newcommand{\chinputlisting}[2]{% |
| 187 |
\lstinputlisting[% |
| 188 |
backgroundcolor=\color{white},% |
| 189 |
xleftmargin=.5em,% |
| 190 |
xrightmargin=.5em,% |
| 191 |
frame=none,% |
| 192 |
belowskip=0pt% |
| 193 |
#1% |
| 194 |
]{#2}% |
| 195 |
} |
| 196 |
\newcommand{\chinline}[2][]{% |
| 197 |
\chinputlisting{#1}{userdoc/#2_in}% |
| 198 |
} |
| 199 |
\newcommand{\chexample}[1]{ |
| 200 |
\ifENGLISH |
| 201 |
\minisec{Examples} |
| 202 |
\fi |
| 203 |
\ifGERMAN |
| 204 |
\minisec{Beispiele} |
| 205 |
\fi |
| 206 |
\lstinputlisting{userdoc/#1_ex} |
| 207 |
} |
| 208 |
\newcommand{\chresult}[1]{ |
| 209 |
\ifENGLISH |
| 210 |
\minisec{Result} |
| 211 |
\fi |
| 212 |
\ifGERMAN |
| 213 |
\minisec{Resultat} |
| 214 |
\fi |
| 215 |
\begin{quote} |
| 216 |
\input{userdoc/#1_ex} |
| 217 |
\end{quote} |
| 218 |
} |
| 219 |
|
| 220 |
|
| 221 |
\newenvironment{chusage}{ |
| 222 |
\small |
| 223 |
\begin{tabbing} |
| 224 |
m\=m\=m\=\kill |
| 225 |
\usagecall |
| 226 |
}{% |
| 227 |
\end{tabbing} |
| 228 |
} |
| 229 |
\newcommand{\usagecall}{ |
| 230 |
\ifENGLISH |
| 231 |
\textsl{Call}\\ |
| 232 |
\fi |
| 233 |
\ifGERMAN |
| 234 |
\textsl{Aufruf}\\ |
| 235 |
\fi |
| 236 |
} |
| 237 |
\newcommand{\usageexample}{ |
| 238 |
\ifENGLISH |
| 239 |
\textsl{Examples}\\ |
| 240 |
\fi |
| 241 |
\ifGERMAN |
| 242 |
\textsl{Beispiele}\\ |
| 243 |
\fi |
| 244 |
} |
| 245 |
|
| 246 |
% important things |
| 247 |
\newcommand{\chimportant}[1]{% |
| 248 |
\begin{quote}% |
| 249 |
\color{Teal}% |
| 250 |
#1% |
| 251 |
\end{quote}% |
| 252 |
} |
| 253 |
|
| 254 |
% new commands |
| 255 |
\newcommand{\chnewcmd}[1]{ |
| 256 |
\subsubsection{\doccommand{#1}} |
| 257 |
\label{sec:ui:cmd:#1} |
| 258 |
} |
| 259 |
|
| 260 |
% document title |
| 261 |
\ifENGLISH |
| 262 |
\title{The \docpackage{changes}-package} |
| 263 |
\subtitle{Manual change markup --- version~\docversion} |
| 264 |
\fi |
| 265 |
\ifGERMAN |
| 266 |
\title{Das \docpackage{changes}-Paket} |
| 267 |
\subtitle{Manuelle Änderungsmarkierung -- Version~\docversion} |
| 268 |
\fi |
| 269 |
|
| 270 |
\author{Ekkart Kleinod} |
| 271 |
\email{[email protected]} |
| 272 |
|
| 273 |
% only description part? |
| 274 |
%\OnlyDescription |
| 275 |
|
| 276 |
% content |
| 277 |
\begin{document} |
| 278 |
|
| 279 |
\DocInput{changes.dtx} |
| 280 |
|
| 281 |
\end{document} |