| 1 |
% \footnoteplacement{m} |
| 2 |
% \columnratio{} |
| 3 |
% \section{Reference Manual} |
| 4 |
% \label{sec:ref} |
| 5 |
% \subsection{Environment \texttt{paracol}} |
| 6 |
% \label{sec:ref-paracol} |
| 7 |
% |
| 8 |
% \begin{description} |
| 9 |
% \item[\ENV{paracol}{\marg{num}\oarg{text}}]\mbox{}\par |
| 10 |
% The environment \env{paracol} contains \meta{body} typeset in \meta{num} |
| 11 |
% columns in parallel. The optional \meta{text} is put spanning all columns |
| 12 |
% prior to the multi-columned \meta{body}. |
| 13 |
% |
| 14 |
% \begin{itemize} |
| 15 |
% \item |
| 16 |
% \changes{v1.2-2}{2013/05/11} |
| 17 |
% {Add a footnote mentioning page-wise footnotes merged with |
| 18 |
% pre-environment staff.} |
| 19 |
% \changes{v1.35-4}{2018/12/31} |
| 20 |
% {Add description of \cs{belowfootnoteskip}.} |
| 21 |
% |
| 22 |
% The environment may start from \emph{any} vertical position in a page, |
| 23 |
% i.e., not necessary at the top of a page. The single-column |
| 24 |
% {\em\Uidx\preenv} of the {\em\Uidx\spage} in which \beginparacol{} lies |
| 25 |
% are naturally connected to the beginning part of \meta{body} in each |
| 26 |
% column, unless the page has footnotes\footnote{ |
| 27 |
% |
| 28 |
% With \Mgfnote{} layout shown in Section~\ref{sec:ref-scfnote}, the |
| 29 |
% footnotes in the single-column contents are merged with those in |
| 30 |
% \env{paracol} environment and are put at the bottom of the \spage{} |
| 31 |
% together as shown in this page.} |
| 32 |
% |
| 33 |
% or bottom floats. If these kinds of bottom stuff exist, they are |
| 34 |
% put above the multi-columned \meta{body}, or the spanning \meta{text} |
| 35 |
% |
| 36 |
% \UsageIndex{spanning text} |
| 37 |
% |
| 38 |
% if provided, with a vertical skip of \!\textfloatsep! separating them if |
| 39 |
% bottom floats exist, or of \!\belowfootnoteskip! described in |
| 40 |
% Section~\ref{sec:ref-scfnote} if only footnotes exist. The |
| 41 |
% \emph{deferred} floats which have not yet appeared in the starting page |
| 42 |
% and thus will appear in the next or succeeding pages are considered as |
| 43 |
% \pwise{} floats given in the environment. |
| 44 |
% |
| 45 |
% \item |
| 46 |
% \changes{v1.2-5}{2013/05/11} |
| 47 |
% {Add an item to show that \string\texttt{paracol} can be enclosed in |
| 48 |
% a \string\texttt{list}-like environment.} |
| 49 |
% |
| 50 |
% The environment can be enclosed in a \env{list}{\em-like environment} such |
| 51 |
% as \env{enumerate}, \env{itemize} and \env{description}. If so, \!\item!s |
| 52 |
% in each column are typeset using the parameters of the surrounding |
| 53 |
% environment such as \!\leftmargin! and \!\rightmargin!. For example, the |
| 54 |
% following short \env{paracol} environment is included in an \env{itemize} |
| 55 |
% for this and other \!\item!s in this page. |
| 56 |
% |
| 57 |
% \begin{paracol}{2} |
| 58 |
% \item |
| 59 |
% This is the first \!\item! in the left column. |
| 60 |
% |
| 61 |
% \item |
| 62 |
% This is the second \!\item! in the left column followed by a |
| 63 |
% \!\switchcolumn!\footnote{. |
| 64 |
% |
| 65 |
% This footnote is to show the footnotes in this page are merged.}. |
| 66 |
% \switchcolumn |
| 67 |
% |
| 68 |
% \item |
| 69 |
% This is the first \!\item! in the right column. |
| 70 |
% |
| 71 |
% \item |
| 72 |
% This is the second \!\item! in the right column. |
| 73 |
% |
| 74 |
% \item |
| 75 |
% This is the third and last \!\item! in the right column. |
| 76 |
% \end{paracol} |
| 77 |
% You are now seeing the switching to/from multi-columned and \env{itemize}d |
| 78 |
% texts are naturally connected with the last and this single-columned |
| 79 |
% sentences. You may feel the space between two columns above is too large |
| 80 |
% but it simply results from the large total \!\leftmargin!s of the outer |
| 81 |
% \env{description} and this \env{itemize}, which make the right column |
| 82 |
% shifted right. A simple remedy for this large space is to make |
| 83 |
% \!\columnsep! narrower, for example 0\,pt as shown below. |
| 84 |
% |
| 85 |
% \columnsep0pt |
| 86 |
% \begin{paracol}{2} |
| 87 |
% \item |
| 88 |
% This \!\item! is wider than the last \!\item! above because |
| 89 |
% \!\columnsep! is 0\,pt. |
| 90 |
% \switchcolumn |
| 91 |
% |
| 92 |
% \item |
| 93 |
% Therefore, this \!\item! is shifted left a little bit to make |
| 94 |
% inter-column space narrower. |
| 95 |
% \end{paracol} |
| 96 |
% |
| 97 |
% \item |
| 98 |
% All \Uidx\lcounter{}s in all columns are initialized to have the values at |
| 99 |
% \beginparacol{} on its first occurrence. On the second and succeeding |
| 100 |
% occurrences of \beginparacol, the \lcounter{}s in each column have the |
| 101 |
% value at the last \Endparacol, unless they are modified after the |
| 102 |
% \Endparacol. If a counter is modified (or declared by \!\newcounter!) |
| 103 |
% after the \Endparacol, the local versions of the counter in all columns |
| 104 |
% commonly have the value at \beginparacol. |
| 105 |
% |
| 106 |
% \item |
| 107 |
% \changes{v1.2-2}{2013/05/11} |
| 108 |
% {Add a footnote mentioning page-wise footnotes merged with |
| 109 |
% post-environment staff.} |
| 110 |
% |
| 111 |
% The environment may end at \emph{any} vertical position in a page, i.e., |
| 112 |
% the {\em\Uidx\postenv} being the single-column texts and others |
| 113 |
% following \Endparacol{} in the {\em\Uidx\lpage} of the environment may not |
| 114 |
% start from the top of a page. If any columns don't have deferred |
| 115 |
% \cwise{} floats and the most advanced {\em\Uidx\lcolumn} at |
| 116 |
% \Endparacol{} has neither of footnotes\footnote{ |
| 117 |
% |
| 118 |
% With \Mgfnote{} layout shown in Section~\ref{sec:ref-scfnote}, the |
| 119 |
% footnotes in the closing \env{paracol} environment are merged with those |
| 120 |
% in \postenv{} and are put at the bottom of the page{} together as shown in |
| 121 |
% this page.} |
| 122 |
% |
| 123 |
% nor bottom floats, its bottom is naturally connected to the \postenv{}. |
| 124 |
% If the \lcolumn{} has these kinds of bottom stuff, they are put above the |
| 125 |
% \postenv{}, with a vertical skip of \!\textfloatsep! separating them if |
| 126 |
% bottom floats exist. All deferred \cwise{} floats given in the |
| 127 |
% environment are flushed before the \postenv{} appears, possibly creating |
| 128 |
% {\em\Uidx\fcolumn{}s} only with floats. On the other hand, deferred |
| 129 |
% \pwise{} floats given in the environment are considered as deferred |
| 130 |
% (single-) \cwise{} floats given just after \Endparacol. |
| 131 |
% |
| 132 |
% \item |
| 133 |
% The values of all \lcounter{}s in the leftmost column are used as the |
| 134 |
% initial values of them in the \postenv. |
| 135 |
% |
| 136 |
% \item |
| 137 |
% The \env{paracol} environment cannot be nested, or you will have an error |
| 138 |
% message of illegal nesting. |
| 139 |
% |
| 140 |
% \item |
| 141 |
% The commands \!\switchcolumn!, \!\synccounter!, \!\syncallcounters! and |
| 142 |
% \!\flushpage!, and environments \env{column}(|*|), \env{nthcolumn}(|*|), |
| 143 |
% \env{leftcolumn}(|*|) and \env{rightcolumn}(|*|) are {\em local} to |
| 144 |
% \env{paracol} environment and thus undefined outside the |
| 145 |
% environment\footnote{ |
| 146 |
% |
| 147 |
% Unless you dare to define them.}. |
| 148 |
% |
| 149 |
% The command \!\clearpage! is of course usable outside and inside the |
| 150 |
% environment but its function inside is a little bit different from outside. |
| 151 |
% \end{itemize} |
| 152 |
% |
| 153 |
% |
| 154 |
% |
| 155 |
% \item[\ENV{paracol}{\oarg{numleft}\marg{num}\oarg{text}}]\mbox{} |
| 156 |
% \Item[\ENV{paracol}{\oarg{numleft}\texttt{*}\marg{num}\oarg{text}}] |
| 157 |
% \mbox{}\par |
| 158 |
% \changes{v1.3-2}{2013/09/17} |
| 159 |
% {Add description of parallel-paging.} |
| 160 |
% |
| 161 |
% If a \beginparacol{} has the optional \meta{numleft} argument to specify |
| 162 |
% the number of leading columns $n_l$ together with the total $n$ given by |
| 163 |
% \meta{num}, columns in the environment are laid out across two adjacent |
| 164 |
% pages. In this {\em\Uidx\parapag{}e} typesetting, the first $n_l$ columns |
| 165 |
% are placed in the {\em left} page while remaining $n_r=n-n_l$ columns go to |
| 166 |
% the next {\em right} page. The pair of left and right pages is |
| 167 |
% considered as comprising a virtual {\em\Uidx\paired} page and thus shares |
| 168 |
% a common page number, unless {\em\Uidx\npaired} typesetting is specified |
| 169 |
% by the optional `|*|' following the optional \meta{numleft} argument. In |
| 170 |
% the \npaired{} \parapag{}ing, when the leading $n_l$ columns are put in a |
| 171 |
% page $p$, the trailing $n_r$ columns are in the page $p+1$. |
| 172 |
% |
| 173 |
% \begin{itemize} |
| 174 |
% \item |
| 175 |
% All {\em\Uidx\pwstuff}, i.e., \Preenv{} and \postenv, \pwise{} floats, |
| 176 |
% \mctext{} and (\mgfnote{} or non-merged) \Scfnote{}s, are placed only in |
| 177 |
% left \parapag{}es leaving corresponding regions in right \parapag{}es |
| 178 |
% blank\footnote{ |
| 179 |
% |
| 180 |
% Someday the author could devise an advanced mechanism to exploit the space |
| 181 |
% in right \parapag{}es.}. |
| 182 |
% |
| 183 |
% \item |
| 184 |
% A \npaired{} left \parapag{}e is not necessary to be even-numbered, though |
| 185 |
% the printing tradition requires so if you naturally want to have a |
| 186 |
% \parapag{}e pair in a double spread. The page number given to the first |
| 187 |
% left \parapag{}e is simply the number of the page $p_1$ in which |
| 188 |
% \beginparacol{} reside, and that for the $k$-th left \parapag{}e is |
| 189 |
% $p_1+2(k-1)$\footnote{ |
| 190 |
% |
| 191 |
% Unless you make some change to \counter{page} counter.}. |
| 192 |
% |
| 193 |
% Therefore, to make it sure $p_1$ is even, you might need to have an |
| 194 |
% ordinary page of blank, a title, etc., or to let \counter{page} counter have |
| 195 |
% an even number by \!\setcounter!, etc., before starting a \env{paracol} |
| 196 |
% environment. |
| 197 |
% |
| 198 |
% \item |
| 199 |
% Section~\ref{sec:ppts} shows examples of \parapag{}ing together with |
| 200 |
% related issues on two-sided typesetting. |
| 201 |
% \end{itemize} |
| 202 |
% \end{description} |
| 203 |
% |
| 204 |
% |
| 205 |
% |
| 206 |
% \subsection{Column-Switching Command and Environments} |
| 207 |
% \label{sec:ref-switchcolumn} |
| 208 |
% |
| 209 |
% \begin{description} |
| 210 |
% \item[\Midx{\!\switchcolumn!}\oarg{col}]\mbox{} |
| 211 |
% \Item[\Midx{\!\switchcolumn!}\oarg{col}\texttt{*}\oarg{text}]\mbox{}\par |
| 212 |
% The command switches columns from $i$ to $j$ where $i$ and $j$ is the |
| 213 |
% zero-origin ordinals of the columns from/to which we are leaving\slash |
| 214 |
% visiting respectively. Without the optional \meta{col}, $j=i+1\bmod n$ |
| 215 |
% where $n$ is the number of columns given to \beginparacol, while |
| 216 |
% $j=\meta{col}$ with the optional argument. If the command (or |
| 217 |
% \oarg{col} if specified) is followed by a |*|, the \cswitch{} takes |
| 218 |
% place after \sync{}ation and, if specified, the optional spanning |
| 219 |
% \meta{text} is put. |
| 220 |
% |
| 221 |
% \Index{spanning text} |
| 222 |
% |
| 223 |
% \begin{itemize} |
| 224 |
% \item |
| 225 |
% Using \!\switchcolumn! in a \env{list}-like environment \emph{included} in |
| 226 |
% a \env{paracol} environment causes an ugly result without any error\slash |
| 227 |
% warning messages. This caution is effectual for all \csenv{}s too. |
| 228 |
% |
| 229 |
% \item |
| 230 |
% If $\meta{col}\notin\LBRP0n$, an error is reported and, if you dare to |
| 231 |
% continue, you will switch to the leftmost column 0. |
| 232 |
% |
| 233 |
% \item |
| 234 |
% The \sync{}ation point is set just below the last line of the \lcolumn{} |
| 235 |
% in a page $p$, partly taking deferred floats into account. That is, all |
| 236 |
% deferred floats are put in the pages up to $p-1$ and at the top of $p$ if |
| 237 |
% possible. Then, if a non-\lcolumn{} has footnotes and/or bottom floats |
| 238 |
% and they cannot be pushed down below the \sync{}ation point, the point is |
| 239 |
% moved to the next page top\footnote{ |
| 240 |
% |
| 241 |
% Or below top floats deferred to the page.}. |
| 242 |
% |
| 243 |
% \item |
| 244 |
% In a page having one or more \sync{}ation points, stretch and shrink |
| 245 |
% factors of all vertical spaces, such as those surrounding sectioning |
| 246 |
% commands, are ignored. Therefore, even if you specify \!\flushbottom!, |
| 247 |
% the page is typeset as if \!\raggedbottom! were specified. |
| 248 |
% |
| 249 |
% \item |
| 250 |
% After a \sync{}ation point is set, no top floats will be inserted in the page |
| 251 |
% having the point, thus they will be deferred to the next page or further one. |
| 252 |
% \end{itemize} |
| 253 |
% |
| 254 |
% |
| 255 |
% |
| 256 |
% \item[\ENV{column}{}]\mbox{} |
| 257 |
% \Item[\ENV{column*}{\oarg{text}}]\mbox{}\par |
| 258 |
% The environment \env{column} contains \meta{body} for the column next to |
| 259 |
% what we are in just before \!\begin!|{|\env{column}|}|. The starred |
| 260 |
% version \env{column*} does the same after \sync{}ation and, if specified, |
| 261 |
% the optional spanning \meta{text} is put. |
| 262 |
% |
| 263 |
% \Index{spanning text} |
| 264 |
% |
| 265 |
% \begin{itemize} |
| 266 |
% \item |
| 267 |
% The environments are almost equivalent to; |
| 268 |
% \begin{quote} |
| 269 |
% |{|\!\switchcolumn!\quad\meta{body}\quad\CSIndex{par}|}|\\ |
| 270 |
% |{|\!\switchcolumn!|*|\oarg{text}\quad\meta{body}\quad\CSIndex{par}|}| |
| 271 |
% \end{quote} |
| 272 |
% except for their first occurrences which don't switch to the column 1 |
| 273 |
% (i.e., right column if two-columned) but stay in the leftmost column 0. |
| 274 |
% More precisely, \!\begin!|{|\env{column}(|*|)|}| does not make \cswitch{} |
| 275 |
% if it is not preceded by \!\switchcolumn! nor other \csenv{}s. |
| 276 |
% |
| 277 |
% \item |
| 278 |
% The \meta{body} of the environments cannot have \!\switchcolumn! nor |
| 279 |
% \csenv{}s including \env{column}(|*|) themselves, or you will have an |
| 280 |
% error message of illegal use of command\slash environment. |
| 281 |
% |
| 282 |
% \item |
| 283 |
% Column-switching\index{column-switching} does not take place at |
| 284 |
% \!\end!|{|\env{column}(|*|)|}|. Therefore, texts following the |
| 285 |
% environments are put in the column in which \meta{body} resides until a |
| 286 |
% \cswitch{} command\slash environment is given. |
| 287 |
% \end{itemize} |
| 288 |
% |
| 289 |
% |
| 290 |
% |
| 291 |
% \item[\ENV{nthcolumn}{\marg{col}}]\mbox{} |
| 292 |
% \Item[\ENV{nthcolumn*}{\marg{col}\oarg{text}}]\mbox{}\par |
| 293 |
% The environment \env{nthcolumn} contains \meta{body} for the column |
| 294 |
% \meta{col}. The starred version \env{nthcolumn*} does the same after |
| 295 |
% \sync{}ation and, if specified, the optional spanning \meta{text} is put. |
| 296 |
% |
| 297 |
% \Index{spanning text} |
| 298 |
% |
| 299 |
% \begin{itemize} |
| 300 |
% \item |
| 301 |
% The environments are equivalent to; |
| 302 |
% |
| 303 |
% \begin{quote} |
| 304 |
% |{|\!\switchcolumn!\oarg{col}\quad\meta{body}\quad\CSIndex{par}|}|\\ |
| 305 |
% |{|\!\switchcolumn!\oarg{col}|*|\oarg{text}\quad |
| 306 |
% \meta{body}\quad\CSIndex{par}|}| |
| 307 |
% \end{quote} |
| 308 |
% |
| 309 |
% \item |
| 310 |
% The \meta{body} of the environments cannot have \!\switchcolumn! nor |
| 311 |
% \csenv{}s including \env{nthcolumn}(|*|) themselves, or you will have an |
| 312 |
% error message of illegal use of command\slash environment. |
| 313 |
% |
| 314 |
% \item |
| 315 |
% Column-switching\index{column-switching} does not take place at |
| 316 |
% \!\end!|{|\env{nthcolumn}(|*|)|}|. Therefore, texts following the |
| 317 |
% environments are put in the column in which \meta{body} resides until a |
| 318 |
% \cswitch{} command\slash environment is given. |
| 319 |
% \end{itemize} |
| 320 |
% |
| 321 |
% |
| 322 |
% |
| 323 |
% \KeepSpace{4} |
| 324 |
% \item[\ENV{leftcolumn}{}]\mbox{} |
| 325 |
% \Item[\ENV{leftcolumn*}{\oarg{text}}]\mbox{} |
| 326 |
% \Item[\ENV{rightcolumn}{}]\mbox{} |
| 327 |
% \Item[\ENV{rightcolumn*}{\oarg{text}}]\mbox{}\par\nobreak |
| 328 |
% The environment \env{leftcolumn} contains \meta{body} for the leftmost |
| 329 |
% column 0, while \env{rightcolumn} for the column 1 being the right column |
| 330 |
% in two-column typesetting. The starred versions \env{leftcolumn*} and |
| 331 |
% \env{rightcolumn*} do the same after \sync{}ation and, if specified, the |
| 332 |
% optional spanning \meta{text} is put. |
| 333 |
% |
| 334 |
% \Index{spanning text} |
| 335 |
% |
| 336 |
% \begin{itemize} |
| 337 |
% \item |
| 338 |
% The environments \env{leftcolumn}(|*|) are equivalent to; |
| 339 |
% |
| 340 |
% \begin{quote} |
| 341 |
% \Env{nthcolumn}{\Arg{\texttt{0}}}\\ |
| 342 |
% \Env{nthcolumn*}{\Arg{\texttt{0}}\oarg{text}} |
| 343 |
% \end{quote} |
| 344 |
% |
| 345 |
% while \env{rightcolumn}(|*|) are equivalent to; |
| 346 |
% |
| 347 |
% \begin{quote} |
| 348 |
% \Env{nthcolumn}{\Arg{\texttt{1}}}\\ |
| 349 |
% \Env{nthcolumn*}{\Arg{\texttt{1}}\oarg{text}} |
| 350 |
% \end{quote} |
| 351 |
% |
| 352 |
% \end{itemize} |
| 353 |
% |
| 354 |
% |
| 355 |
% |
| 356 |
% \item[\Midx{\!\thecolumn!}]\mbox{}\par |
| 357 |
% \changes{v1.3-5}{2013/09/17} |
| 358 |
% {Add description of \cs{thecolumn}.} |
| 359 |
% The command gives you the zero-origin ordinal of the column in which this |
| 360 |
% command appears. Therefore, the following code snip; |
| 361 |
% |
| 362 |
% \begin{itemize}\item[] |
| 363 |
% |\begin{paracol}{3}|\\ |
| 364 |
% |Column-\thecolumn.\switchcolumn| |
| 365 |
% |Column-\thecolumn.\switchcolumn| |
| 366 |
% |Column-\thecolumn.|\\ |
| 367 |
% |\end{paracol}| |
| 368 |
% \end{itemize} |
| 369 |
% |
| 370 |
% gives us the followings. |
| 371 |
% |
| 372 |
% \par\medskip |
| 373 |
% \begin{paracol}{3} |
| 374 |
% Column-\thecolumn.\switchcolumn |
| 375 |
% Column-\thecolumn.\switchcolumn |
| 376 |
% Column-\thecolumn. |
| 377 |
% \end{paracol} |
| 378 |
% |
| 379 |
% \begin{itemize} |
| 380 |
% \item |
| 381 |
% The command is {\em neither} a \LaTeX's counter nor \!\count! register of |
| 382 |
% native \TeX{}, and thus the value it keeps cannot be modified. However, |
| 383 |
% it can be used wherever an integer number is required or appropriate. |
| 384 |
% Therefore for example, \!\setcounter!|{mycounter}{|\!\thecolumn!|}| works |
| 385 |
% well to give the column ordinal to the counter |mycounter|. |
| 386 |
% \end{itemize} |
| 387 |
% |
| 388 |
% |
| 389 |
% |
| 390 |
% \item[\Midx{\!\definecolumnpreamble!}\marg{col}\marg{pream}]\mbox{}\par |
| 391 |
% \changes{v1.35-5}{2018/12/31} |
| 392 |
% {Add description of \cs{definecolumnpreamble}.} |
| 393 |
% The command is to define the {\Uidx\colpream} \meta{pream} for the column |
| 394 |
% \meta{col}, which is inserted at every \cswitch{} to the column. More |
| 395 |
% specifically, the command let \!\switchcolumn! to \meta{col} act as if you |
| 396 |
% specify; |
| 397 |
% |
| 398 |
% \begin{itemize}\item[] |
| 399 |
% \!\switchcolumn! $\arg{pream\ for\ col}$ |
| 400 |
% \end{itemize} |
| 401 |
% |
| 402 |
% and \csenv{}s such as \env{nthcolumn} act as if you specify; |
| 403 |
% |
| 404 |
% \begin{itemize}\item[] |
| 405 |
% |\begin{nthcolumn}{|\meta{col}|}| $\arg{pream\ for\ col}$ |
| 406 |
% |
| 407 |
% \end{itemize} |
| 408 |
% |
| 409 |
% \begin{itemize} |
| 410 |
% \item |
| 411 |
% \begingroup\hfuzz1.5pt |
| 412 |
% The optional \sptext{} of \!\switchcolumn!, \csenv{}s and \beginparacol{} |
| 413 |
% is considered to be in a virtual column $-1$, and thus if you need a |
| 414 |
% \Colpream{} for \sptext{}s do \!\definecolumnpreamble!|{-1}|\marg{pream}. |
| 415 |
% \par\endgroup |
| 416 |
% |
| 417 |
% \item |
| 418 |
% The command may appear in a \env{paracol} environment and, if so, |
| 419 |
% \meta{pream} is effective from the succeeding \cswitch{} to \meta{col}. |
| 420 |
% |
| 421 |
% \item |
| 422 |
% The definition of \meta{pream} is made globally. |
| 423 |
% \end{itemize} |
| 424 |
% |
| 425 |
% |
| 426 |
% |
| 427 |
% \item[\Midx{\!\ensurevspace!}\marg{len}]\mbox{}\par |
| 428 |
% \changes{v1.3-5}{2013/09/17} |
| 429 |
% {Add description of \cs{ensurevspace}.} |
| 430 |
% |
| 431 |
% The command tells the first \sync{}ing \cswitch{} command (i.e., |
| 432 |
% \!\switchcolumn!\oarg{col}|*|) or environment (i.e., \env{column*}, etc.\@) |
| 433 |
% following this command that the page must be broken before \sync{}ation |
| 434 |
% unless the \sync{}ation point has the space of \meta{len} or more below it |
| 435 |
% in the page. If a \sync{}ation does not have the command after the |
| 436 |
% previous \sync{}ation, it is assumed that |
| 437 |
% \!\ensurevspace!|{|\!\baselineskip!|}| is given. |
| 438 |
% |
| 439 |
% \begin{itemize} |
| 440 |
% \item |
| 441 |
% This command is to be used when a \sync{}ation point would be placed near |
| 442 |
% the bottom of a page $p$ and the space below it is not sufficient for a column |
| 443 |
% $c$ to put anything in the page, while another column $c'$ can have a few |
| 444 |
% lines in the page. If this happens, the first line after the \sync{}ation |
| 445 |
% should start at the top of the page $p+1$ in the column $c$, while that of |
| 446 |
% $c'$ is still in the page $p$, giving you an impression that the |
| 447 |
% \sync{}ation fails to align the top of all columns below it. The fact is, |
| 448 |
% however, the \sync{}ation point is properly established near at the bottom |
| 449 |
% of the page but the first line of $c$ needs some large space due to, for |
| 450 |
% example, the followings. |
| 451 |
% |
| 452 |
% \begin{itemize} |
| 453 |
% \item |
| 454 |
% The line has unusually tall stuff including larger font letters. |
| 455 |
% |
| 456 |
% \item |
| 457 |
% The line has a footnote reference which is hardly apart from the |
| 458 |
% footnote, and thus the line and the footnote go to the next page together. |
| 459 |
% |
| 460 |
% \item |
| 461 |
% The parameter \!\clubpenalty! is too large (e.g., 10000) to break the |
| 462 |
% first and second lines into separate pages. |
| 463 |
% |
| 464 |
% \item |
| 465 |
% The first line follows a vertical space. |
| 466 |
% \end{itemize} |
| 467 |
% |
| 468 |
% \item |
| 469 |
% This manual itself has some instances of \!\ensurevspace! command in the |
| 470 |
% page \pageref{page:bfreude} and \pageref{page:efreude} in which each German |
| 471 |
% stanza is enclosed in \env{verse} and then \env{leftcolumn*} environments |
| 472 |
% and has \!\ensurevspace!|{2|\!\baselineskip!|}| before the \!\begin!ing of |
| 473 |
% the outer \env{leftcolumn*} because the first line of the stanza is |
| 474 |
% preceded by a vertical space inserted by \!\begin!|{|\env{verse}|}|. In |
| 475 |
% fact without \!\ensurevspace!, the first two lines of the sixth English |
| 476 |
% stanza would be in the page \pageref{page:bfreude}, while corresponding |
| 477 |
% German stanza go to the next page \pageref{page:efreude} as a whole, due |
| 478 |
% to the difference of the height of footnotes in each column, i.e., German |
| 479 |
% ones are taller than English ones to narrow the space for the German |
| 480 |
% column. |
| 481 |
% |
| 482 |
% \item |
| 483 |
% As the author does in the ``An die Freude/To Joy'' example, it is a good |
| 484 |
% tactics to have an \!\ensurevspace! with some vertical space larger than the |
| 485 |
% default \!\baselineskip! if it is sure that a column has a feature shown |
| 486 |
% above regardless of the position of the \sync{}ation point in question, |
| 487 |
% because the point goes up or down with revisions of your document and |
| 488 |
% using an \!\ensurevspace! for a \sync{}ation far above the page bottom is |
| 489 |
% perfectly harmless. Similarly, if you find a problem in a \sync{}ation |
| 490 |
% and add an \!\ensurevspace! to solve it, keeping the command attached is |
| 491 |
% recommended even when the \sync{}ation point moves up or down to make the |
| 492 |
% command unnecessary. |
| 493 |
% \end{itemize} |
| 494 |
% \end{description} |
| 495 |
% |
| 496 |
% |
| 497 |
% |
| 498 |
% \subsection{Commands for Column and Gap Width} |
| 499 |
% \label{sec:ref-colwidth} |
| 500 |
% |
| 501 |
% \begin{description} |
| 502 |
% \item[\Midx{\!\columnratio!}\Arg{$r_0,r_1,\cdots,r_k$} |
| 503 |
% {|[|$r'_0,r'_1,\cdots,r'_{k'}$|]|}]\mbox{}\par |
| 504 |
% \changes{v1.1}{2012/05/11} |
| 505 |
% {Add description of \cs{columnratio}.} |
| 506 |
% \changes{v1.3-2}{2013/09/17} |
| 507 |
% {Add description of the optional argument of \cs{columnratio} for |
| 508 |
% parallel-paging.} |
| 509 |
% |
| 510 |
% The command defines the width of each column by the fraction $r_i$ to |
| 511 |
% specify the portion which $i$-th ($i=0$ for the leftmost) column |
| 512 |
% occupies. More specifically, the width $\Midx{\w}_i$ of the $i$-th column |
| 513 |
% is defined as follows, where $W$ is \!\textwidth!, $S$ is \!\columnsep!, |
| 514 |
% and $n$ is the number of columns given to \beginparacol. |
| 515 |
% |
| 516 |
% \begin{eqnarray*} |
| 517 |
% W'&=&W-(n-1)S\\ |
| 518 |
% w_i&=&\cases{ |
| 519 |
% r_iW' |
| 520 |
% \vrule height1.5\ht\strutbox depth1.5\dp\strutbox width0pt&$i\leq k$\cr |
| 521 |
% \displaystyle{(1-\sum_{j=0}^k r_j)W'\over n-(k+1)}&$i>k$} |
| 522 |
% \end{eqnarray*} |
| 523 |
% |
| 524 |
% For a \env{paracol} environment with \parapag{}ing, $n$ is replaced with |
| 525 |
% $n_l$ for the columns in left \parapag{}es, while $n$ and $w_i$ are |
| 526 |
% replaced with $n_r$ and $w_{n_r+i}$ for those in right \parapag{}es. |
| 527 |
% Moreover, if the optional argument having $r'_0,r'_1,\cdots,r'_{k'}$ is |
| 528 |
% provided, $w_{n_r+i}$ for a column in right \parapag{}es is determined |
| 529 |
% by $r'_i$ and $k'$ instead of $r_i$ and $k$. |
| 530 |
% |
| 531 |
% \begin{itemize} |
| 532 |
% \item |
| 533 |
% The equations above imply that $k<n-1$, $r_i>0$ and $\sum_{j=0}^k |
| 534 |
% r_j<1$. If $k\geq n-1$, $k$ is assumed to be $n-2$ and all $r_i$ such |
| 535 |
% that $i\geq n-1$ are ignored. If $r_i$ or its sum does not satisfy the |
| 536 |
% conditions, you will have an ugly result with ``Overfull'' messages. |
| 537 |
% |
| 538 |
% \item |
| 539 |
% The argument $r_0,r_1,\cdots,r_k$ can be empty to mean $k=-1$ to let all |
| 540 |
% column widths be $W'/n$ as default. |
| 541 |
% |
| 542 |
% \item |
| 543 |
% The setting of column width by the command takes effect in the |paracol| |
| 544 |
% environments following the command\footnote{ |
| 545 |
% |
| 546 |
% If the command is in a \texttt{paracol} environment, the command does not |
| 547 |
% affect the column widths of the environment but does the next ones, though |
| 548 |
% such usage is very unusual.}. |
| 549 |
% |
| 550 |
% Therefore, though placing the command in the preamble is the most natural |
| 551 |
% way\footnote{ |
| 552 |
% |
| 553 |
% Or second most to not using it at all, of course.}, |
| 554 |
% |
| 555 |
% you may place this command between two |paracol| environments to change |
| 556 |
% the column layout for the second one even when they appear in a page as |
| 557 |
% shown in Section~\ref{sec:man-close}. |
| 558 |
% |
| 559 |
% \item |
| 560 |
% \changes{v1.2-5}{2013/05/11} |
| 561 |
% {Modify the description about \cs{linewidth} reflecting the fact |
| 562 |
% that \string\texttt{paracol} may be included in a |
| 563 |
% \string\texttt{list}-like environment.} |
| 564 |
% |
| 565 |
% In the $i$-th column, \!\columnwidth! has $w_i$ and, for outermost |
| 566 |
% paragraphs in the column, \!\hsize! has $w_i$ as well. As for |
| 567 |
% \!\linewidth!, it has $w_i-(\!\textwidth!-l)$ where $l$ is what |
| 568 |
% \!\linewidth! had at \beginparacol{}, i.e., the \!\linewidth! for the |
| 569 |
% \env{list}-like environment surrounding \env{paracol} if any, or |
| 570 |
% \!\textwidth! otherwise. |
| 571 |
% |
| 572 |
% \item |
| 573 |
% You can specify width of each column and that of each {\em gap} between |
| 574 |
% two columns more detailedly by \!\setcolumnwidth! shown below. If your |
| 575 |
% document has both of \!\columnratio! and \!\setcolumnwidth! prior to a |
| 576 |
% \env{paracol} environment, the command given later is effective for the |
| 577 |
% environment. |
| 578 |
% \end{itemize} |
| 579 |
% |
| 580 |
% |
| 581 |
% |
| 582 |
% \item[\Midx{\!\setcolumnwidth!}\Arg{$s_0,s_1,\cdots,s_k$} |
| 583 |
% {|[|$s'_0,s'_1,\cdots,s'_{k'}$|]|}]\mbox{}\par |
| 584 |
% \changes{v1.3-2}{2013/09/17} |
| 585 |
% {Add description of \cs{setcolumnwidth}.} |
| 586 |
% |
| 587 |
% The command defines the width of each column and that of each {\em gap} |
| 588 |
% between two columns by the column/gap specification $s_i$ for the $i$-th |
| 589 |
% column and the gap between it and the $(i{+}1)$-th column. More |
| 590 |
% specifically, $s_i$ has the form of $\hat w_i$ or $\hat w_i\,|/|\,\hat g_i$ |
| 591 |
% where each of $\hat w_i$ and $\hat g_i$ is a proper glue including a |
| 592 |
% proper dimension, or an empty string to mean $\hat w_i=\!\fill!$ and $\hat |
| 593 |
% g_i=\!\columnsep!$, to determine the width of $i$-th column $\w_i$ and that |
| 594 |
% of $i$-th gap $\Midx{\gap}_i$ as follows, where $\mathit{nat}(x)$ is the |
| 595 |
% natural width of the glue $x$, $\mathit{str}(x)$ is the infinite stretch |
| 596 |
% factor of $x$, $W$ is \!\textwidth!, and $n$ is the number of columns |
| 597 |
% given to \beginparacol. |
| 598 |
% |
| 599 |
% \begin{eqnarray*} |
| 600 |
% W'&=&\sum_{i=0}^{n-2}\big(\mathit{nat}(\hat w_i)+\mathit{nat}(\hat g_i)\big)+ |
| 601 |
% \mathit{nat}(\hat w_{n-1})\\ |
| 602 |
% F&=&\sum_{i=0}^{n-2}\big(\mathit{str}(\hat g_i)+\mathit{str}(\hat g_i)\big)+ |
| 603 |
% \mathit{str}(\hat w_{n-1})\\ |
| 604 |
% x_i&=&\cases{(W/W')\mathit{nat}(\hat x_i)&$W'\geq W\;\lor\;F\leq0$\cr |
| 605 |
% \mathit{nat}(\hat x_i)+(\mathit{str}(\hat x_i)/F)(W-W')& |
| 606 |
% $W'< W\;\land\;F>0$} |
| 607 |
% \qquad(x\in\{w,g\}) |
| 608 |
% \end{eqnarray*} |
| 609 |
% That is, if the total of natural widths $W'$ is larger than \!\textwidth! |
| 610 |
% $W$ or there are no infinite stretch factors in the specification, given |
| 611 |
% widths are scaled down or up so that the scaled total is equal to $W$. |
| 612 |
% Otherwise, each width with an infinite stretch factor is extended |
| 613 |
% according to its ratio in the total stretch so that the stretched total is |
| 614 |
% equal to $W$. |
| 615 |
% |
| 616 |
% For a \env{paracol} environment with \parapag{}ing, $n$ is replaced with |
| 617 |
% $n_l$ for the columns in left \parapag{}es, while $n$, $w_i$ and $g_i$ are |
| 618 |
% replaced with $n_r$, $w_{n_r+i}$ and $g_{n_r+i}$ for those in right |
| 619 |
% \parapag{}es. Moreover, if the optional argument having |
| 620 |
% $s'_0,s'_1,\cdots,s'_{k'}$ is provided, $w_{n_r+i}$ and $g_{n_r+i}$ for a |
| 621 |
% column in right \parapag{}es are determined by $s'_i$ instead of $s_i$. |
| 622 |
% |
| 623 |
% \begin{itemize} |
| 624 |
% \item |
| 625 |
% In \env{paracol} environments having $n$ columns, $s_i$ s.t.\ $i\geq n$ |
| 626 |
% and $\hat g_{n-1}$ are ignored. On the other hand if $k<n-1$, it is |
| 627 |
% assumed $s_i$ is an empty string for all $i>k$. |
| 628 |
% |
| 629 |
% \item |
| 630 |
% Finite stretch factors and finite or infinite shrink factors in $\hat w_i$ |
| 631 |
% and $\hat g_i$ are ignored. |
| 632 |
% |
| 633 |
% \item |
| 634 |
% Unlike \TeX's genuine glue addition, all infinite unit |fil|, |fill| and |
| 635 |
% |filll| are not distinguished in the summation for $F$. Also unlike |
| 636 |
% \TeX's genuine scaling of a glue primitive, |
| 637 |
% $f\!\fill!$ means $0\,|pt|\ |plus|\ f\,|fill|$ for convenience\footnote{ |
| 638 |
% |
| 639 |
% In \TeX's grammar, $f\!\fill!$ means a dimension rather than a glue and is |
| 640 |
% $0\,|pt|$ because the natural component of \!\fill! is 0.}. |
| 641 |
% |
| 642 |
% \item |
| 643 |
% The division $W/W'$ and $\mathit{str}(\hat x_i)/F$ can have some |
| 644 |
% arithmetic errors and thus the total of $w_i$ and $g_i$ may not be equal to |
| 645 |
% $W$ exactly but can be a little bit less than $W$. This small error is, |
| 646 |
% however, equally distributed to $g_i$ in typesetting of a page to make the |
| 647 |
% total width of columns and gaps is exactly $W$\footnote{ |
| 648 |
% |
| 649 |
% If we may ignore the arithmetic error inherent in \TeX.}. |
| 650 |
% |
| 651 |
% \item |
| 652 |
% All the specifications shown in the table below give us same results for a |
| 653 |
% \env{paracol} environment having three columns, providing |
| 654 |
% $\!\textwidth!=360\,|pt|$ and $\!\columnsep!=S=20\,|pt|$. |
| 655 |
% |
| 656 |
% \par\hbox to\textwidth\bgroup\hfil |
| 657 |
% \nosv \def\|{\verb|}\small\arraycolsep0pt\def\arraystretch{1.1} |
| 658 |
% $\begin{array}[b]{l|ccccc} |
| 659 |
% s_0,s_1,s_2&w_0&g_0&w_1&g_1&w_2\rlap{ (in \texttt{pt})}\\\hline |
| 660 |
% \|50pt/20pt,100pt/40pt,150pt|&50&20&100&40&150\\ |
| 661 |
% \|50pt,100pt/2\columnsep,150pt|&50&S& |
| 662 |
% 100&2S&150\\ |
| 663 |
% \|50pt/\fill,100pt/2\fill,150pt|&50&(1/3)\cdot60&100&(2/3)\cdot60&150\\ |
| 664 |
% \|,2\fill/2\columnsep,3\fill|&\ (1/6)\cdot300&S& |
| 665 |
% (2/6)\cdot300&2S& |
| 666 |
% (3/6)\cdot300\\ |
| 667 |
% \|50pt/20,50pt plus 1fil/40pt,50pt plus 2fil |& |
| 668 |
% 50&20&50+(1/3)\cdot150&40& |
| 669 |
% 50+(2/3)\cdot150\\ |
| 670 |
% \|5pt/2pt,10pt/4pt,15pt|&10\cdot5&10\cdot2&10\cdot10&10\cdot4& |
| 671 |
% 10\cdot15\\ |
| 672 |
% \|100pt/40pt,200pt/80pt,300pt|&0.5\cdot100&0.5\cdot40& |
| 673 |
% 0.5\cdot200&0.5\cdot80& |
| 674 |
% 0.5\cdot300 |
| 675 |
% \end{array}$\hfil\egroup |
| 676 |
% |
| 677 |
% \item |
| 678 |
% If your document has both of \!\columnratio! and \!\setcolumnwidth! prior |
| 679 |
% to a \env{paracol} environment, the command given later is effective for |
| 680 |
% the environment. |
| 681 |
% \end{itemize} |
| 682 |
% \end{description} |
| 683 |
% |
| 684 |
% |
| 685 |
% |
| 686 |
% \subsection{Commands for Two-Sided Typesetting and Marginal Note Placement} |
| 687 |
% \label{sec:ref-twoside} |
| 688 |
% \changes{v1.3-3}{2013/09/17} |
| 689 |
% {Add the sub-section ``Commands for Two-Sided Typesetting and Marginal |
| 690 |
% Note Placement''.} |
| 691 |
% \changes{v1.3-4}{2013/09/17} |
| 692 |
% {Add the sub-section ``Commands for Two-Sided Typesetting and Marginal |
| 693 |
% Note Placement''.} |
| 694 |
% \changes{v1.3-5}{2013/09/17} |
| 695 |
% {Add the sub-section ``Commands for Two-Sided Typesetting and Marginal |
| 696 |
% Note Placement''.} |
| 697 |
% |
| 698 |
% \begin{description} |
| 699 |
% \item[\Midx{\!\twosided!}{$|[|t_1t_2\cdots t_k|]|$}]\mbox{}\par |
| 700 |
% \changes{v1.3-3}{2013/09/17} |
| 701 |
% {Add description of \cs{twosided}.} |
| 702 |
% \changes{v1.3-4}{2013/09/17} |
| 703 |
% {Add description of \cs{twosided}.} |
| 704 |
% \changes{v1.3-5}{2013/09/17} |
| 705 |
% {Add description of \cs{twosided}.} |
| 706 |
% |
| 707 |
% The command enables a set of two-sided typesetting features |
| 708 |
% $\Set{t_i}{t_i\in\{|p|,|c|,|m|,|b|\},\ 1\leq i\leq k}$ explicitly by the |
| 709 |
% optional argument, or all of the following four features as a whole |
| 710 |
% without the argument, in even-numbered pages. |
| 711 |
% |
| 712 |
% \begin{description} |
| 713 |
% \item[|p|\rm(\textit{age})] |
| 714 |
% for ordinary two-sided paging, letting the left side margin be |
| 715 |
% \!\evensidemargin!, page headers be different from those in odd-numbered |
| 716 |
% pages with |headings| or |myheadings| page style, and \!\cleardoublepage! |
| 717 |
% leave an even-numbered page blank if it is used in an odd-numbered page. |
| 718 |
% |
| 719 |
% \item[|c|\rm(\textit{olumn})] |
| 720 |
% for {\em\Uidx\cswap} to \emph{print} columns in even-numbered pages in |
| 721 |
% reverse order. This feature is sometimes preferable in typesetting |
| 722 |
% especially with unbalanced parallel columns to make, for example, a wider |
| 723 |
% columns are always \emph{inside} while narrower ones are \emph{outside}. |
| 724 |
% |
| 725 |
% \item[|m|\rm(\textit{arginal text})] |
| 726 |
% to place marginal notes in the side margin opposite to that specified by |
| 727 |
% the command \!\marginparthreshold! discussed shortly. |
| 728 |
% |
| 729 |
% \item[|b|\rm(\textit{ackground painting})] |
| 730 |
% to make \bgpaint, shown in Section~\ref{sec:ref-bgpaint}, |
| 731 |
% \emph{\mirror{}ed} so that, for example, a color specified for the left |
| 732 |
% margin is used to paint the right margin instead. |
| 733 |
% \end{description} |
| 734 |
% |
| 735 |
% \begin{itemize} |
| 736 |
% \item |
| 737 |
% The feature |p| is also enabled by the |twoside| option of |
| 738 |
% \!\documentclass! with almost all classes including |article|, |book|, |
| 739 |
% |report|, etc. Though it is strongly recommended to make both settings by |
| 740 |
% \!\documentclass! and this command consistent, they can be inconsistent |
| 741 |
% resulting in lack of some expected functions. For example, enabling |p| |
| 742 |
% feature by \!\twosided! without |twoside| option in \!\documentclass! |
| 743 |
% makes the format of headers and footers in all pages same even with |
| 744 |
% \!\pagestyle!|{headings}|. |
| 745 |
% |
| 746 |
% \item |
| 747 |
% The \cswap{} enabled by the feature |c| is ineffective in \npaired{} |
| 748 |
% \parapag{}ing because it is meaningless\footnote{ |
| 749 |
% |
| 750 |
% Unless somebody tells the author it is meaningful.}, |
| 751 |
% |
| 752 |
% and thus silently ignored. |
| 753 |
% |
| 754 |
% \item |
| 755 |
% In ordinary single-column typesetting, marginal note swapping in |
| 756 |
% even-numbered pages is enabled by the |twoside| option, while it never takes |
| 757 |
% place in ordinary two-column typesetting. For marginal notes given in |
| 758 |
% \env{paracol} environments, however, swapping of them in |
| 759 |
% even-numbered pages is enabled by giving the feature |m| to \!\twosided!. |
| 760 |
% |
| 761 |
% \item\label{page:cswap} |
| 762 |
% The command has to be outside of \env{paracol} environments to decide the |
| 763 |
% action in the environments following them. If it appears in a |
| 764 |
% \env{paracol} environment, you will have a warning message saying it is |
| 765 |
% ignored. |
| 766 |
% |
| 767 |
% \twosided[c]\columnratio{0.6}\columnsep0pt |
| 768 |
% \begin{paracol}{2} |
| 769 |
% \hfuzz2pt |
| 770 |
% \item |
| 771 |
% Here is an example of column swapping. Since this page |
| 772 |
% \pageref{page:cswap} is odd, this wider column-0 with roman font is placed |
| 773 |
% in left side and thus inside at the begining, but now we are in an even |
| 774 |
% page in which this column is in right side. |
| 775 |
% |
| 776 |
% \switchcolumn |
| 777 |
% \item\it |
| 778 |
% This narrower, outside and italicized column-1 is at first in right |
| 779 |
% side but the page break has changed the position to the left. |
| 780 |
% \end{paracol} |
| 781 |
% |
| 782 |
% \item |
| 783 |
% \changes{v1.2-4}{2013/05/11} |
| 784 |
% {Add description of \cs{[no]swapcolumninevenpages}.} |
| 785 |
% \changes{v1.3-5}{2013/09/17} |
| 786 |
% {Remove description of \cs{[no]swapcolumninevenpages} but mention |
| 787 |
% they are still available.} |
| 788 |
% |
| 789 |
% In old versions of \Paracol, namely 1.2 and its minor revisions 1.2x, |
| 790 |
% \cswap{} was controlled by lengthy commmands |
| 791 |
% \Midx{\!\swapcolumninevenpages!} and \Midx{\!\noswapcolumninevenpages!}. |
| 792 |
% Though they are still available and will be so forever for backward |
| 793 |
% compatibility, it is recommended to use \!\twosided! with or without the |
| 794 |
% feature |c|. The old versions also have a problem that \spanning{} |
| 795 |
% crossing a page boundary is placed incorrectly after the page break in it, |
| 796 |
% but this problem is solved by a fix incorporated in version 1.3. |
| 797 |
% |
| 798 |
% \item |
| 799 |
% It must be $t_i\in\{|p|,|c|,|m|,|b|\}$, or you will have an error message |
| 800 |
% of illegal two-siding feature. |
| 801 |
% |
| 802 |
% \item |
| 803 |
% Section~\ref{sec:ppts} shows examples of two-sided typesetting together |
| 804 |
% with related issues on \parapag{}ing. |
| 805 |
% \end{itemize} |
| 806 |
% |
| 807 |
% |
| 808 |
% |
| 809 |
% \item[\Midx{\!\marginparthreshold!}$\Arg{k}{|[|k'|]|}$]\mbox{}\par |
| 810 |
% \changes{v1.3-4}{2013/09/17} |
| 811 |
% {Add description of \cs{marginparthreshold}.} |
| 812 |
% |
| 813 |
% The command specifies the minimum ordinal $k$ of columns whose marginal |
| 814 |
% notes are placed in right margin. That is, marginal notes given in a |
| 815 |
% column-$i$ go to left margin if $i<k$, while they go to right if $i\geq |
| 816 |
% k$. The optional argument $k'$, if given, is for columns in right |
| 817 |
% \parapag{}es to decide the margin where their marginal notes are placed. |
| 818 |
% In default, $k=1$ is assumed to let marginal notes from the leftmost |
| 819 |
% column-0 go to left margin while those from other columns go to right. |
| 820 |
% |
| 821 |
% \begin{itemize} |
| 822 |
% \item |
| 823 |
% You may specify $k=0$ to let all marginal notes go to right margin, or may |
| 824 |
% give the command a large number, say 100, to place all of them in left |
| 825 |
% margin. |
| 826 |
% |
| 827 |
% \item |
| 828 |
% The setting $k=0$ or $k=100$ above makes a side margin \emph{shared} by |
| 829 |
% marginal notes from different columns, and sharing is inevitable when a |
| 830 |
% (parallel-) page has three or more columns. When a margin is shared by |
| 831 |
% marginal notes from two or more columns, it can happen that two marginal |
| 832 |
% notes from different columns conflict over the space to be occupied by each |
| 833 |
% of them. This conflict is solved by \Paracol{} to push down the note |
| 834 |
% given later in your source |.tex| until an available space for it is |
| 835 |
% found. Note that the marginal note to be pushed down is determined by the |
| 836 |
% position in the source rather than that in the printed result. Also note |
| 837 |
% that \Paracol{} exploits space between two marginal notes having been |
| 838 |
% already placed in the placement of other note coming later to place it at |
| 839 |
% the natural position if possible or to minimize the amount of pushing down |
| 840 |
% otherwise. |
| 841 |
% |
| 842 |
% \item |
| 843 |
% In the decision of the real margin in which a marginal note is placed, |
| 844 |
% other two factors are involved; |m| feature of \!\twosided! command and |
| 845 |
% the parity of the page; and \LaTeX's genuine command \!\reversemarginpar!. |
| 846 |
% More specifically, after the first preliminary decision is made according |
| 847 |
% to the threshold given to \!\marginparthreshold!, we have the following |
| 848 |
% two steps to modify the decision; if |m| feature has been specified in |
| 849 |
% \!\twosided! command and the marginal note belongs to an even-numbered |
| 850 |
% page, the decision is reversed to have the second preliminary result; and |
| 851 |
% then if \!\reversemarginpar! has been specified, the second result is |
| 852 |
% reversed (again) to have the final result. |
| 853 |
% |
| 854 |
% \item |
| 855 |
% In old versions of \Paracol, namely older than 1.3, marginal note |
| 856 |
% placement was not only uncontrollable but also gave ugly results when your |
| 857 |
% document has three or more columns because the marginal notes from a column |
| 858 |
% not being leftmost or rightmost were placed in the gap following the |
| 859 |
% column rather than a margin. This miserable {\em gap note} placement does |
| 860 |
% not happen any more, or in other words this is no more available because |
| 861 |
% the author believes nobody loves it. |
| 862 |
% |
| 863 |
% \item |
| 864 |
% Section~\ref{sec:ppts} shows examples of marginal note placement together |
| 865 |
% with related issues on \parapag{}ing and two-sided typesetting. |
| 866 |
% \end{itemize} |
| 867 |
% |
| 868 |
% |
| 869 |
% |
| 870 |
% \item[\Midx{\!\marginnote!}\oarg{left}\marg{right}\oarg{voffset}]\mbox{}\par |
| 871 |
% \changes{v1.35-3}{2018/12/31} |
| 872 |
% {Add description of \cs{marginnote}.} |
| 873 |
% You may use the package \textsf{marginnote} and its command \!\marginnote! |
| 874 |
% in \env{paracol} environments as a replacement of \!\marginpar!. However, |
| 875 |
% the command is \emph{emulated} with \!\marginpar! and \textsf{paracol}'s |
| 876 |
% own mechanism of marginal note placement. Therefore, some of |
| 877 |
% \textsf{marginnote}'s functionality are not effective in \env{paracol} |
| 878 |
% environment except for the following features. |
| 879 |
% |
| 880 |
% \begin{itemize} |
| 881 |
% \item |
| 882 |
% Shifting up/down a marginal note by the optional \meta{voffset}. |
| 883 |
% |
| 884 |
% \item |
| 885 |
% Defining fonts (and others) for marginal notes by \!\marginfont!. |
| 886 |
% |
| 887 |
% \item |
| 888 |
% Controlling the holizontal paragraph alignment by \!\raggedleftmarginnote! |
| 889 |
% and |\raggedright|\~|marginnote|\SpecialIndex{\raggedrightmarginnote}. |
| 890 |
% \end{itemize} |
| 891 |
% |
| 892 |
% Note that you will see a warning message ``|\margninnote| is emulated by |
| 893 |
% |\marginpar|'' at the first in-\env{paracol} occurrence of the command to |
| 894 |
% let you know the imperfection. |
| 895 |
% \end{description} |
| 896 |
% |
| 897 |
% |
| 898 |
% |
| 899 |
% \subsection{Commands for Counters} |
| 900 |
% \label{sec:ref-counter} |
| 901 |
% |
| 902 |
% \begin{description} |
| 903 |
% \item[\Midx{\!\globalcounter!}\marg{ctr}]\mbox{} |
| 904 |
% \Item[\Midx{\!\globalcounter!}\texttt{*}]\mbox{}\par |
| 905 |
% \changes{v1.32-1}{2015/10/10} |
| 906 |
% {Add descriptions of \cs{globalcounter*}.} |
| 907 |
% |
| 908 |
% The command \!\globalcounter!\marg{ctr} declares that the counter |
| 909 |
% \meta{ctr} is global to all columns, while \!\globalcounter!|*| does so |
| 910 |
% for all counters. An update of a \Uidx\gcounter{} in a column is seen by |
| 911 |
% any other columns. |
| 912 |
% |
| 913 |
% \begin{itemize} |
| 914 |
% \item |
| 915 |
% All column-local values of a descendant \lcounter{} of a \gcounter{} are |
| 916 |
% zero-cleared when the \gcounter{} is explicitly stepped by \!\stepcounter! |
| 917 |
% or \!\refstepcounter!, or implicitly by a sectioning command and so on. |
| 918 |
% |
| 919 |
% \item |
| 920 |
% The counter \counter{page} is always global but an explicit update of it |
| 921 |
% by e.g., \!\setcounter! in a non-leftmost column is not seen by other |
| 922 |
% columns and is canceled even for the column itself after a \cswitch{} or a |
| 923 |
% page break in the column. Therefore, if you want to make a \emph{jump} of |
| 924 |
% \counter{page}, it must be done in the leftmost column 0. Note that a |
| 925 |
% jump from a page $p$ to $q$ can be seen in other columns even if they have |
| 926 |
% gone beyond $p$ \emph{before} the column 0 makes the jump, as far as |
| 927 |
% \counter{page} having $q$ (or its successor) is referred to by \!\pageref! |
| 928 |
% or through \emph{contents} files such as |.toc|\footnote{ |
| 929 |
% |
| 930 |
% Direct reference to \counter{page} may give an inconsistent result, as you |
| 931 |
% might have in ordinary \LaTeX{} documents.}. |
| 932 |
% |
| 933 |
% \item |
| 934 |
% All counters except for \counter{page} are local by default. This feature |
| 935 |
% may cause a problem with some packages including \textsf{marginnote} and |
| 936 |
% \textsf{(auto-)pst-pdf} having their own counters which must be global. |
| 937 |
% Since it is tough to find the name of such counters from package sources, |
| 938 |
% if you have something wrong with these (or other) packages, try to put |
| 939 |
% \!\globalcounter!|*| in your preamble and use \!\localcounter! shown below |
| 940 |
% to localize specific counters which you need to be local. |
| 941 |
% |
| 942 |
% \item |
| 943 |
% Globalizing a \meta{ctr} being already global is just ignored without any |
| 944 |
% complaints. |
| 945 |
% \end{itemize} |
| 946 |
% |
| 947 |
% |
| 948 |
% |
| 949 |
% \item[\Midx{\!\localcounter!}\marg{ctr}]\mbox{}\par |
| 950 |
% The command declares that the counter \meta{ctr} is local for each column. |
| 951 |
% |
| 952 |
% \begin{itemize} |
| 953 |
% \item |
| 954 |
% Though this command is intended for localizing a \meta{ctr} which is once |
| 955 |
% globalized, localizing a local counter does not causes any error but is |
| 956 |
% just ignored. Localizing the permanently global \counter{page} is also |
| 957 |
% just ignored without any complaints. |
| 958 |
% \end{itemize} |
| 959 |
% |
| 960 |
% |
| 961 |
% |
| 962 |
% \item[\Midx{\!\definethecounter!}\marg{ctr}\marg{col}\marg{rep}]\mbox{}\par |
| 963 |
% The command defines |\the|\meta{ctr} being \marg{rep} for the local use in |
| 964 |
% the column \meta{col}. That is, |\the|\meta{ctr} in the column \meta{col} |
| 965 |
% acts as if it is defined by |
| 966 |
% \!\renewcommand!\Arg{\cs{the}\meta{ctr}}\Arg{\meta{rep}}. |
| 967 |
% |
| 968 |
% |
| 969 |
% |
| 970 |
% \item[\Midx{\!\synccounter!}\marg{ctr}]\mbox{}\par |
| 971 |
% The command \emph{broadcasts} the value of the \lcounter{} \meta{ctr} in |
| 972 |
% the column in which the command appears to the values in all other columns. |
| 973 |
% |
| 974 |
% \item[\Midx{\!\syncallcounters!}]\mbox{}\par |
| 975 |
% The command broadcasts the values of all \lcounter{}s in the column in |
| 976 |
% which the command appears to the values in all other columns. |
| 977 |
% \end{description} |
| 978 |
% |
| 979 |
% |
| 980 |
% |
| 981 |
% \subsection{Page-Wise Footnotes} |
| 982 |
% \label{sec:ref-scfnote} |
| 983 |
% \changes{v1.2-2}{2013/05/11} |
| 984 |
% {Add the sub-section ``Single-Columned Footnotes'' to describe newly |
| 985 |
% introducerd commands for page-wise footnotes.} |
| 986 |
% \changes{v1.3-5}{2013/09/17} |
| 987 |
% {Rename the sub-section title from ``Single-Columned Footnotes'' to |
| 988 |
% ``Page-Wise Footnotes'' following new naming.} |
| 989 |
% |
| 990 |
% \begin{description} |
| 991 |
% \item[\Midx{\!\footnoteplacement!}\marg{layout}]\mbox{} |
| 992 |
% \Item[\Midx{\!\footnotelayout!}\marg{layout}\footnote{ |
| 993 |
% While \cs{footnotelayout} is a nice name, it is recommended to use |
| 994 |
% \cs{footnoteplacement}, since a macro of the name \cs{footnotelayout} |
| 995 |
% is also used by the \textsf{footmisc} package. Hence our version of |
| 996 |
% \cs{footnotelayout} will not be available if \textsf{footmisc} is loaded as |
| 997 |
% well. Besides that, both \cs{footnotelayout} and \cs{footnoteplacement} are |
| 998 |
% the same. We will thus only refer to \cs{footnoteplacement} for the |
| 999 |
% remainder of this manual. |
| 1000 |
% }]\mbox{}\par |
| 1001 |
% \changes{v1.36-2}{2024/10/22} |
| 1002 |
% {Rename \cs{footnotelayout} to \cs{footnoteplacement}.} |
| 1003 |
% The command specifies the \meta{layout}${}\in\{|c|,|p|,|m|\}$ of footnotes |
| 1004 |
% in \env{paracol} environments as follows. |
| 1005 |
% |
| 1006 |
% \begin{description} |
| 1007 |
% \item[|c|\rm(\textit{olumn})] makes footnotes {\em\Uidx\mcfnote} (aka |
| 1008 |
% multi-columned) being default to place footnotes in each column at the |
| 1009 |
% bottom of the column and separating them from \Preenv{} and \Postenv{} |
| 1010 |
% footnotes. |
| 1011 |
% |
| 1012 |
% \item[|p|\rm(\textit{age})] makes footnotes {\em\Uidx\scfnote} (aka |
| 1013 |
% single-columned) so that footnotes in all columns are gathered, typeset |
| 1014 |
% spanning all columns, and placed at the bottom of the page in which they |
| 1015 |
% appear or at the end of the \env{paracol} environment they belong to, so |
| 1016 |
% that they are separated from \Preenv{} and \Postenv{} footnotes. |
| 1017 |
% |
| 1018 |
% \item[|m|\rm(\textit{erge})] makes \Scfnote{}s {\em\Uidx\mgfnote} with |
| 1019 |
% footnotes in outside of the environment but in the same page, i.e., those |
| 1020 |
% in \Preenv{} and \postenv. |
| 1021 |
% \end{description} |
| 1022 |
% |
| 1023 |
% |
| 1024 |
% \begin{itemize} |
| 1025 |
% \item |
| 1026 |
% An example of \Mgfnote{} is found in p.~\pageref{sec:ref-paracol} while |
| 1027 |
% you will see many of them in Section~\ref{sec:fnnp}\footnote{ |
| 1028 |
% |
| 1029 |
% The left-column footnote \ref{fn:flush} in p.~\pageref{fn:flush} looks like |
| 1030 |
% a merged footnote because it is at the bottom of the page and the marked |
| 1031 |
% text is above the single-column text. However, it is an ordinary |
| 1032 |
% \mcfnote{} one produced by a trick with \cs{footnotemark} and |
| 1033 |
% \cs{footnotetext} in different \env{paracol} environments.}. |
| 1034 |
% |
| 1035 |
% \item |
| 1036 |
% In any layouts, a footnote cannot have page breaks in it, i.e., a footnote |
| 1037 |
% is always put in a page as a whole. This makes it impossible to have a |
| 1038 |
% footnote taller than \!\textheight! and thus you will see a warning |
| 1039 |
% message if you give a very long footnote which will be printed intruding |
| 1040 |
% into the area for page footer (or out of the paper bound). |
| 1041 |
% |
| 1042 |
% \item |
| 1043 |
% Choosing the layout |p|age-wise or |m|erged makes \counter{footnote} |
| 1044 |
% counter global and \!\fncounteradjustment! shown below performed inside |
| 1045 |
% \!\footnoteplacement!. Choosing |c|olumn-wise let the command do the |
| 1046 |
% operations oppositely, i.e., localizes \counter{footnote} and does |
| 1047 |
% \!\nofncounteradjustment!. Though these settings are usually appropriate |
| 1048 |
% for each footnote layout but you can override them by explicitly using |
| 1049 |
% commands like \!\localcounter!|{footnote}|. |
| 1050 |
% |
| 1051 |
% \item |
| 1052 |
% The command has to be outside of \env{paracol} environments to decide the |
| 1053 |
% action in the environments following them. If it appears in a |
| 1054 |
% \env{paracol} environment, you will have a warning message saying it is |
| 1055 |
% ignored. |
| 1056 |
% |
| 1057 |
% \item |
| 1058 |
% \changes{v1.3-5}{2013/09/17} |
| 1059 |
% {Remove description of \cs{multicolumnfootnotes}, |
| 1060 |
% \cs{singlecolumnfootnotes}, \cs{mergedfootnotes} but mention they |
| 1061 |
% are still available.} |
| 1062 |
% |
| 1063 |
% In old versions of \Paracol, namely 1.2 and its minor revisions 1.2x, |
| 1064 |
% footnote layout was controlled by a set of commands |
| 1065 |
% \Midx{\!\multicolumnfootnotes!} for |c|, \Midx{\!\singlecolumnfootnotes!} |
| 1066 |
% for |p|, and \Midx{\!\mergedfootnotes!} for |m|. |
| 1067 |
% Though they are still available and will be so forever for backward |
| 1068 |
% compatibility, it is recommended to use \!\footnoteplacement!\footnote{ |
| 1069 |
% |
| 1070 |
% Not only for the sake of it, but also for being familiar with this command |
| 1071 |
% which could have some advanced feature, for example to put gathered |
| 1072 |
% footnotes into a specific column, someday.}. |
| 1073 |
% |
| 1074 |
% % \item |
| 1075 |
% It must be $\meta{layout}\in\{|c|,|p|,|m|\}$, or you will have an error |
| 1076 |
% message of illegal layout specifier. |
| 1077 |
% \end{itemize} |
| 1078 |
% |
| 1079 |
% |
| 1080 |
% |
| 1081 |
% \KeepSpace{5} |
| 1082 |
% \item[\Midx{\!\footnote!}\texttt{*}\oarg{num}\marg{text}]\mbox{} |
| 1083 |
% \Item[\Midx{\!\footnotemark!}\texttt{*}\oarg{num}]\mbox{} |
| 1084 |
% \Item[\Midx{\!\footnotetext!}\texttt{*}\oarg{num}\marg{text}]\mbox{}\par |
| 1085 |
% The starred version of \!\footnote!, \!\footnotemark! and \!\footnotetext! |
| 1086 |
% are for the adjustment of the footnote numbering, the order of footnote |
| 1087 |
% marks in main texts, and the stacking order of footnotes at page |
| 1088 |
% bottom. Their usages with various examples are given in |
| 1089 |
% Section~\ref{sec:fnnp}. |
| 1090 |
% |
| 1091 |
% |
| 1092 |
% |
| 1093 |
% \KeepSpace{3} |
| 1094 |
% \item[\Midx{\!\fncounteradjustment!}]\mbox{} |
| 1095 |
% \Item[\Midx{\!\nofncounteradjustment!}]\mbox{}\par |
| 1096 |
% The maintenance of \counter{footnote} with the starred footnote commands |
| 1097 |
% such as \!\footnote!|*| shown above causes out-of-order progress of the |
| 1098 |
% counter to make it hard to have a consistent counter value at |
| 1099 |
% \Endparacol. The command \!\fncounteradjustment! is to let \Endparacol{} |
| 1100 |
% adjust the value of the counter based on its value at |
| 1101 |
% \beginparacol{} and the number of footnote commands in the environment. |
| 1102 |
% The command \!\nofncounteradjustment! is to tell \Endparacol{} to do |
| 1103 |
% nothing as in default. |
| 1104 |
% |
| 1105 |
% \begin{itemize} |
| 1106 |
% \item |
| 1107 |
% Though \!\footnoteplacement! with |p|(age-wise) or |m|(erged) argument does |
| 1108 |
% \!\fncounteradjustment! while that with |c|(olumn) does |
| 1109 |
% \!\nofncounteradjustment! inside of it, you can override these settings by |
| 1110 |
% explicitly putting a counter adjustment command after \!\footnoteplacement!. |
| 1111 |
% |
| 1112 |
% \item |
| 1113 |
% The effect of \!\fncounteradjustment! is shown in Section~\ref{sec:fnnp}. |
| 1114 |
% \end{itemize} |
| 1115 |
% |
| 1116 |
% |
| 1117 |
% \item[\Midx{\!\belowfootnoteskip!}]\mbox{}\par |
| 1118 |
% \changes{v1.35-4}{2018/12/31} |
| 1119 |
% {Add description of \cs{belowfootnoteskip}.} |
| 1120 |
% The typesetting parameter specifies the amount of the space inserted below |
| 1121 |
% footnotes of single-column \preenv{} if it does not have bottom floats. The |
| 1122 |
% default amount is 0\,pt, i.e., no space is added. |
| 1123 |
% |
| 1124 |
% \end{description} |
| 1125 |
% |
| 1126 |
% |
| 1127 |
% \KeepSpace{6} |
| 1128 |
% \subsection{Commands for Coloring Texts and Column-Separating Rules} |
| 1129 |
% \label{sec:ref-tcolor} |
| 1130 |
% \changes{v1.3-3}{2013/09/17} |
| 1131 |
% {Rename the sub-sectoin title from ``Commands for Text Coloring'' to |
| 1132 |
% ``Commands for Coloring Texts and Column-Separating Rules'' to |
| 1133 |
% add description of the rule coloring together with the rule |
| 1134 |
% drawing itself.} |
| 1135 |
% |
| 1136 |
% \begin{description} |
| 1137 |
% \item[\Midx{\!\columncolor!}\oarg{mode}\marg{color}\oarg{col}]\mbox{} |
| 1138 |
% \Item[\Midx{\!\normalcolumncolor!}\oarg{col}]\mbox{}\par |
| 1139 |
% \changes{v1.2-1}{2013/05/11} |
| 1140 |
% {Add description of \cs{columncolor} and \cs{normlcolumncolor}.} |
| 1141 |
% |
| 1142 |
% The command \!\columncolor! declares that the \emph{default color} of a |
| 1143 |
% column is \meta{color} or what it specifies by the combination with the |
| 1144 |
% optional \meta{mode}. The command \!\normalcolumncolor! declares the |
| 1145 |
% default color is what \!\normalcolor! specifies, i.e., black usually. The |
| 1146 |
% target column of these commands is that in which the commands reside, or |
| 1147 |
% \meta{col} if it specified. |
| 1148 |
% |
| 1149 |
% \begin{itemize} |
| 1150 |
% \item |
| 1151 |
% The command may be outside of \env{paracol} environment. If so and |
| 1152 |
% \meta{col} is not provided, the target column is the leftmost 0. |
| 1153 |
% |
| 1154 |
% \item |
| 1155 |
% The default color declaration is \emph{global}. Therefore, even if the |
| 1156 |
% command appears in a \env{paracol} environment (and even in some grouping |
| 1157 |
% structure in it), the declaration will be kept effective after |
| 1158 |
% \Endparacol{} to determine the default color of the specified column in |
| 1159 |
% succeeding \env{paracol} environments. |
| 1160 |
% |
| 1161 |
% \item |
| 1162 |
% To give a color to texts (and maybe other stuff) in a column correctly, |
| 1163 |
% you need to load \textsf{color} package or its relative (e.g., |
| 1164 |
% \textsf{xcolor}) which the implementation of coloring in \textsf{paracol} |
| 1165 |
% relies on. |
| 1166 |
% |
| 1167 |
% \item |
| 1168 |
% Coloring with \!\color!\oarg{mode}\marg{color} and other coloring commands |
| 1169 |
% in \env{paracol} environments is of course allowed. One caution is that |
| 1170 |
% the \!\color! decides the color for following texts until other |
| 1171 |
% specification is given or the group surrounding the command is closed. |
| 1172 |
% Therefore, \!\switchcolumn! does not affect the coloring but a color given |
| 1173 |
% to the texts in a column is also applied to the texts in the column to be |
| 1174 |
% switched to. This irrelativeness of coloring and \cswitch{} is shown in |
| 1175 |
% the example below. |
| 1176 |
% |
| 1177 |
% \twosided[]\columnratio{0.5}\columnsep0pt |
| 1178 |
% \tolerance5000\hbadness5000 |
| 1179 |
% \begin{paracol}{2} |
| 1180 |
% \columncolor{blue} |
| 1181 |
% This column is colored blue because\\ |
| 1182 |
% \mbox{}\qquad \!\columncolor!|{blue}|\\ |
| 1183 |
% is specfied. Here we have a \!\switchcolumn!. |
| 1184 |
% \switchcolumn |
| 1185 |
% \columncolor{red} |
| 1186 |
% This column is colored red because\\ |
| 1187 |
% \mbox{}\qquad\!\columncolor!|{red}|\\ |
| 1188 |
% is specified. |
| 1189 |
% |
| 1190 |
% \begin{color}{green} |
| 1191 |
% Now the color of the right column is changed to green because\\ |
| 1192 |
% \mbox{}\qquad\!\begin!|{color}{green}|\\ |
| 1193 |
% is given prior to this paragraph. Now we have another \!\switchcolumn! to |
| 1194 |
% go back to the left. |
| 1195 |
% \switchcolumn |
| 1196 |
% The color of this paragraph is green because we are still in the |
| 1197 |
% environment of green coloring, which we are now closing.\par |
| 1198 |
% \end{color}% |
| 1199 |
% |
| 1200 |
% Since the coloring environment has been closed, the color of this |
| 1201 |
% paragraph is the default blue. Now we have yet another and the last |
| 1202 |
% \!\switchcolumn! to the right. |
| 1203 |
% \switchcolumn |
| 1204 |
% Since this paragraph is outside of the coloring environment, its color is |
| 1205 |
% the default red. |
| 1206 |
% \end{paracol} |
| 1207 |
% |
| 1208 |
% \normalcolumncolor[0]\normalcolumncolor[1] |
| 1209 |
% The default coloring of columns does not affect anything outside of |
| 1210 |
% \env{paracol} environment of course, and thus this sentence is not |
| 1211 |
% colored\footnote{ |
| 1212 |
% |
| 1213 |
% Or colored black as \cs{normalcolor} specifies.}. |
| 1214 |
% \end{itemize} |
| 1215 |
% |
| 1216 |
% |
| 1217 |
% |
| 1218 |
% \KeepSpace{4} |
| 1219 |
% \item[\Midx{\!\coloredwordhyphenated!}]\mbox{} |
| 1220 |
% \Item[\Midx{\!\nocoloredwordhyphenated!}]\mbox{}\par |
| 1221 |
% \changes{v1.3-3}{2013/09/17} |
| 1222 |
% {Add description of \cs{coloredwordhyphenated} and |
| 1223 |
% \cs{nocoloredwordhyphenated}.} |
| 1224 |
% |
| 1225 |
% The command \!\coloredwordhyphenated! allows the first word following a |
| 1226 |
% coloring command such as \!\color! to be hyphenated, but at the same time |
| 1227 |
% make it possible that a line is broken before the word. The command |
| 1228 |
% \!\nocoloredwordhyphenated! acts oppositely and thus line breaking before |
| 1229 |
% the first word and hyphenating it are inhibited. By default, |
| 1230 |
% \!\coloredwordhyphenated! is effective. |
| 1231 |
% |
| 1232 |
% \begin{itemize} |
| 1233 |
% \item |
| 1234 |
% The implementation of \textsf{color} package and its relatives makes it |
| 1235 |
% impossible that \meta{word} is hyphenated when it appears like |
| 1236 |
% |{|\!\color!|{red}|\meta{word} \ldots|}| or |
| 1237 |
% \!\textcolor!|{|\meta{word} \ldots|}|. This inhibition of the hyphenation |
| 1238 |
% is sometimes annoying especially when the document is multi-columned and |
| 1239 |
% thus a line is narrow and a column is written in a language having long |
| 1240 |
% words such as German. Therefore in \Paracol{} package, a trick is used to |
| 1241 |
% allow the \meta{word} is hyphenated. However this trick being insertion |
| 1242 |
% of a null horizontal space has a side effect that the word can have a line |
| 1243 |
% break before it. Though this line break is usually unharmful, in a |
| 1244 |
% special occasion the break is undesirable and |
| 1245 |
% in\textcolor{red}{appropriate} by making it possible that the |
| 1246 |
% \emph{half-colored} word `inappropriate' is broken between `in' and |
| 1247 |
% `appropriate' without hyphenation. Therefore, if you find such a |
| 1248 |
% inappropriate break, use \!\nocoloredwordhyphenated! as follows, for example. |
| 1249 |
% \begin{quote} |
| 1250 |
% |{\nocoloredwordhyphenated in\textcolor{red}{appropriate}}| |
| 1251 |
% \end{quote} |
| 1252 |
% \end{itemize} |
| 1253 |
% |
| 1254 |
% |
| 1255 |
% \KeepSpace{4} |
| 1256 |
% \item[\Midx{\!\colseprulecolor!}\oarg{mode}\marg{color}\oarg{col}]\mbox{} |
| 1257 |
% \Item[\Midx{\!\normalcolseprulecolor!}\oarg{col}]\mbox{}\par |
| 1258 |
% \changes{v1.3-3}{2013/09/17} |
| 1259 |
% {Add description of \cs{colseprulecolor} and |
| 1260 |
% \cs{normalcolseprulecolor}.} |
| 1261 |
% |
| 1262 |
% The command \!\colseprulecolor! declares the color for |
| 1263 |
% {\em\Uidx\cseprule{}s}, being the vertical rules drawn at the center of |
| 1264 |
% gaps between columns, is \meta{color} or what it specifies by the |
| 1265 |
% combination with the optional \meta{mode}. The command |
| 1266 |
% \!\normalcolseprulecolor! declares the color of rules is what |
| 1267 |
% \!\normalcolor! specifies, i.e., black usually. If the optional argument |
| 1268 |
% \meta{col} is given, these commands specifies the color of the rule in the |
| 1269 |
% gap following the column whose ordinal is \meta{col}, rather than all rules. |
| 1270 |
% |
| 1271 |
% \begin{itemize} |
| 1272 |
% \item |
| 1273 |
% The rules are drawn if \LaTeX's typesetting parameter \!\columnseprule! |
| 1274 |
% for the rule width has non-zero value, e.g., 0.4\,|pt| to obey the |
| 1275 |
% standard rule thickness. The rules are \emph{not} drawn on \pwstuff{}, |
| 1276 |
% i.e., \Preenv{} and \postenv, \pwise{} floats or (\mgfnote{} or |
| 1277 |
% non-merged) \Scfnote{}s of course but also \mctext{}s. Therefore, if a |
| 1278 |
% page has \mctext{}s, the rules are {\em broken} by them as shown in the |
| 1279 |
% red rule example below. |
| 1280 |
% \global\unitlength\@totalleftmargin |
| 1281 |
% \end{itemize} |
| 1282 |
% \end{description} |
| 1283 |
% |
| 1284 |
% \columnseprule0.4pt\colseprulecolor{red}[1]\colseprulecolor{white}[0] |
| 1285 |
% \setcolumnwidth{\unitlength/0pt} |
| 1286 |
% \begin{paracol}{3}\switchcolumn\noindent |
| 1287 |
% This is a left column paragraph preceding a \mctext. Of cource the rule |
| 1288 |
% separating this and the next column starts from the top of this paragraph. |
| 1289 |
% \switchcolumn\noindent |
| 1290 |
% This is a right column paragraph preceding a \mctext{} given by the |
| 1291 |
% \!\switchcolumn!|*| at its end. |
| 1292 |
% \switchcolumn[1]*[\subsubsection*{\hbox to\unitlength{} |
| 1293 |
% An Example of Spanning Text Given by \cs{subsubsection}|*| Command}] |
| 1294 |
% Since we have a \mctext{} above, the red rule separating this and the next |
| 1295 |
% column is broken by the text. |
| 1296 |
% \switchcolumn |
| 1297 |
% It is also natural that the rule separating this and the previous column is |
| 1298 |
% terminated at the end of this \env{paracol} environment. |
| 1299 |
% \end{paracol} |
| 1300 |
% \columnseprule0pt\columnratio{} |
| 1301 |
% |
| 1302 |
% \begin{description} |
| 1303 |
% \Item[]\mbox{} |
| 1304 |
% \begin{itemize} |
| 1305 |
% \Item |
| 1306 |
% To give a color to rules correctly, you need to load \textsf{color} |
| 1307 |
% package or its relative (e.g., \textsf{xcolor}) which the implementation |
| 1308 |
% of coloring in \textsf{paracol} relies on. |
| 1309 |
% |
| 1310 |
% \item |
| 1311 |
% Once you give a color to rules in a specific gap with the optional |
| 1312 |
% \meta{col}, another \!\colseprulecolor! or \!\normalcolseprulecolor! |
| 1313 |
% without \meta{col} does \emph{not} change the color of the rule in the |
| 1314 |
% gap. |
| 1315 |
% \end{itemize} |
| 1316 |
% \end{description} |
| 1317 |
% |
| 1318 |
% |
| 1319 |
% |
| 1320 |
% \KeepSpace{7} |
| 1321 |
% \subsection{Commands for Background Painting} |
| 1322 |
% \label{sec:ref-bgpaint} |
| 1323 |
% \changes{v1.3-3}{2013/09/17} |
| 1324 |
% {Add the sub-section ``Commands for Background Painting.} |
| 1325 |
% |
| 1326 |
% \begin{description} |
| 1327 |
% \item[\Midx{\!\backgroundcolor!}\marg{region}\oarg{mode}\marg{color}] |
| 1328 |
% \mbox{}\par |
| 1329 |
% \Item[\Midx{\!\backgroundcolor!} |
| 1330 |
% \Arg{\meta{region}$|(|x_0|,|y_0|)|$}\oarg{mode}\marg{color}] |
| 1331 |
% \mbox{}\par |
| 1332 |
% \Item[\Midx{\!\backgroundcolor!} |
| 1333 |
% \Arg{\meta{region}$|(|x_0|,|y_0|)||(|x_1|,|y_1|)|$} |
| 1334 |
% \oarg{mode}\marg{color}] |
| 1335 |
% \mbox{}\par |
| 1336 |
% \changes{v1.3-3}{2013/09/17} |
| 1337 |
% {Add description of \cs{backgroundcolor}.} |
| 1338 |
% |
| 1339 |
% The command declares that {\em\Uidx\bgpaint} of \meta{region} is performed |
| 1340 |
% with \meta{color} or what it specifies by the combination of the optional |
| 1341 |
% \meta{mode}. The \meta{region} whose \bground{} is painted is one of the |
| 1342 |
% following. |
| 1343 |
% |
| 1344 |
% \begin{description} |
| 1345 |
% \item[|c|\rm(\textit{olumn})] for all columns, or particular one if |
| 1346 |
% \meta{region} is |c|\oarg{col} to specify its ordinal \meta{col}. |
| 1347 |
% |
| 1348 |
% \item[|g|\rm(\textit{ap})] for all gaps between columns, or particular one |
| 1349 |
% if \meta{region} is |g|\oarg{col} to specify the ordinal \meta{col} of the |
| 1350 |
% column preceding the gap. |
| 1351 |
% |
| 1352 |
% \item[|s|\rm(\textit{panning})] for \mctext{}s. |
| 1353 |
% |
| 1354 |
% \item[|f|\rm(\textit{loat})] for \pwise{} floats. |
| 1355 |
% |
| 1356 |
% \item[|n|\rm(\textit{ote})] for (\mgfnote{} or non-merged) \Scfnote{}s. |
| 1357 |
% |
| 1358 |
% \item[|p|\rm(\textit{re/post})] for \Preenv{} and \postenv. |
| 1359 |
% |
| 1360 |
% \item[|t|\rm(\textit{op})] for top margin. |
| 1361 |
% |
| 1362 |
% \item[|b|\rm(\textit{ottom})] for bottom margin. |
| 1363 |
% |
| 1364 |
% \item[|l|\rm(\textit{eft})] for left margin. |
| 1365 |
% |
| 1366 |
% \item[|r|\rm(\textit{ight})] for right margin. |
| 1367 |
% \end{description} |
| 1368 |
% |
| 1369 |
% In addition, capitals of the keys above, i.e., |C|, |G|, \ldots, |L|, are |
| 1370 |
% also legitimate for {\em under painting}. For example, you may specify to |
| 1371 |
% paint the \bground{} of a region, say top margin, by two |
| 1372 |
% \!\backgroundcolor! with |t| and |T| and with different color arranging the |
| 1373 |
% size of the region of either |t| or |T| (or both of them) by the |
| 1374 |
% \emph{\bgext} option shown below. |
| 1375 |
% |
| 1376 |
% The optional $|(|x_0|,|y_0|)|$ is to enlarge the region to be painted |
| 1377 |
% shifting its left-top and right-bottom corner outside by |
| 1378 |
% the dimension $x_0$ horizontally and $y_0$ vertically, or to shrink it |
| 1379 |
% with negative dimensions. This {\em\Uidx\bgext} can be asymmetric giving |
| 1380 |
% another optional $|(|x_1|,|y_1|)|$ so that it acts on the right-bottom |
| 1381 |
% corner while let $|(|x_0|,|y_0|)|$ shift only the left-top corner. |
| 1382 |
% Moreover, you may make each \bgext{} {\em infinite} by giving 10000\,|pt| |
| 1383 |
% (about 3.5\,m) to $x_0$, $y_0$, $x_1$ and/or $y_1$ so that the |
| 1384 |
% corresponding region edge is shifted to the paper edge. Furthermore, this |
| 1385 |
% {\em\Uidx\bginfext{}} can be terminated at the point $\alpha$ inside the |
| 1386 |
% corresponding paper edge by giving $10000\,|pt|-\alpha$ |
| 1387 |
% ($\alpha\leq1000\,|pt|$) to an extension parameter $x_0$, etc. |
| 1388 |
% |
| 1389 |
% \begin{itemize} |
| 1390 |
% \item |
| 1391 |
% A region whose color is not specified is not painted and thus left blank |
| 1392 |
% (or kept as painted by \!\pagecolor! if you specify it). |
| 1393 |
% |
| 1394 |
% \item |
| 1395 |
% Under-painting of columns and gaps by |C| and |G| is made for regions |
| 1396 |
% different from those over-painting |c| and |g|. That is, under-painting |
| 1397 |
% is done ignoring all \pwstuff{} and thus the height of the regions is |
| 1398 |
% always $\!\textheight!+\!\maxdepth!$. On the other hand, over-painting is |
| 1399 |
% only for chunks shrunk or separated by \pwstuff. |
| 1400 |
% |
| 1401 |
% \item |
| 1402 |
% You may exploit the following painting order, where $x_i$ |
| 1403 |
% is the $i$-th \mctext{} ($x\in\{|s|,|S|\}$) or $i$-th chunk followed by |
| 1404 |
% the $i$-th \mctext, $m$ and $n$ is the number of \mctext{}s and columns in |
| 1405 |
% a page respectively, to overlay a preceding region with a succeeding |
| 1406 |
% region, if your \emph{printer} allows overlaid color painting. |
| 1407 |
% |
| 1408 |
% \begin{eqnarray*} |
| 1409 |
% |T|&\to&|B|\to|L|\to|R| |
| 1410 |
% \to|G[|0|]|\to\cdots\to|G[|n{-}1|]|\to|C[|0|]|\to\cdots\to|C[|n{-}1|]|\\ |
| 1411 |
% &\to&|t|\to|b|\to|l|\to|r|\to|N|\to|n|\to\{|F|,|P|\}\to\{|f|,|p|\} |
| 1412 |
% \to|S|_1\to\cdots\to|S|_m\\ |
| 1413 |
% &\to&|g|_1|[|0|]|\to\cdots|g|_1|[|n{-}2|]|\to |
| 1414 |
% |c|_1|[|0|]|\to\cdots|c|_1|[|n{-}1|]|\to|s|_1\\ |
| 1415 |
% &\to&\cdots\\ |
| 1416 |
% &\to&|g|_m|[|0|]|\to\cdots|g|_m|[|n{-}2|]|\to |
| 1417 |
% |c|_m|[|0|]|\to\cdots|c|_m|[|n{-}1|]|\to|s|_m\\ |
| 1418 |
% &\to&|g|_{m+1}|[|0|]|\to\cdots|g|_{m+1}|[|n{-}2|]|\to |
| 1419 |
% |c|_{m+1}|[|0|]|\to\cdots|c|_m|[|n{-}1|]| |
| 1420 |
% \end{eqnarray*} |
| 1421 |
% |
| 1422 |
% \item |
| 1423 |
% If you specify |b| feature by \!\twosided!, \bgpaint{} is |
| 1424 |
% {\em\Uidx\mirror{}ed} in even-numbered pages so that |l| and |L| mean |
| 1425 |
% right margin, |r| and |R| mean left margin, and asymmetric extensions are |
| 1426 |
% applied to right-top and left-bottom corners. |
| 1427 |
% |
| 1428 |
% \item |
| 1429 |
% To give a color for \bgpaint{} correctly, you need to load \textsf{color} |
| 1430 |
% package or its relative (e.g., \textsf{xcolor}) which the implementation |
| 1431 |
% of coloring in \textsf{paracol} relies on. |
| 1432 |
% |
| 1433 |
% \item |
| 1434 |
% To paint margins and regions having infinite extension correctly, the |
| 1435 |
% parameters \!\paperwidth! and \!\paperheight! should be set properly by, |
| 1436 |
% for example, a paper selection option of \!\documentclass!. |
| 1437 |
% |
| 1438 |
% \item |
| 1439 |
% Section~\ref{sec:bgpaint} shows examples of \bgpaint{} to give you more |
| 1440 |
% intutive explanations of \!\backgroundcolor! and its region specifications. |
| 1441 |
% \end{itemize} |
| 1442 |
% |
| 1443 |
% |
| 1444 |
% |
| 1445 |
% \item[\Midx{\!\nobackgroundcolor!}\marg{region}]\mbox{} |
| 1446 |
% \Item[\Midx{\!\resetbackgroundcolor!}]\mbox{}\par |
| 1447 |
% \changes{v1.3-3}{2013/09/17} |
| 1448 |
% {Add description of \cs{nobackgroundcolor} and |
| 1449 |
% \cs{resetbackgroundcolor}.} |
| 1450 |
% |
| 1451 |
% The command \!\nobackgroundcolor! declares that the \bground{} of |
| 1452 |
% \meta{region} is not painted, where \meta{region} is one of legitimate |
| 1453 |
% region specifiers of \!\backgroundcolor!. The command |
| 1454 |
% \!\resetbackgroundcolor! declares no regions are painted and thus gives |
| 1455 |
% you the default state. |
| 1456 |
% |
| 1457 |
% \begin{itemize} |
| 1458 |
% \item |
| 1459 |
% If you specified the \bgpaint{} of |c|\oarg{col} or |g|\oarg{col} by |
| 1460 |
% \!\backgroundcolor!, the painting is \emph{not} canceled by |
| 1461 |
% \!\nobackgroundcolor! with |c| or |g| but without \oarg{col}. Similarly, |
| 1462 |
% once you made declarations of \bgpaint{} of both |c| and |c|\oarg{col} |
| 1463 |
% (resp.\ |g| and |g|\oarg{col}), \!\nobackgroundcolor! with |c|\oarg{col} |
| 1464 |
% (resp.\ |g|\oarg{col}) cancels the painting of |c|\oarg{col} (resp.\ |
| 1465 |
% |g|\oarg{col}) but the region will still be painted by the color you gave |
| 1466 |
% to |c| (resp.\ |g|). |
| 1467 |
% \end{itemize} |
| 1468 |
% |
| 1469 |
% |
| 1470 |
% |
| 1471 |
% \item[\Midx{\!\pagerim!}]\mbox{}\par |
| 1472 |
% \changes{v1.3-3}{2013/09/17} |
| 1473 |
% {Add description of \cs{pagerim}.} |
| 1474 |
% |
| 1475 |
% This is a (kind of) \emph{length command}\footnote{ |
| 1476 |
% |
| 1477 |
% In reality, it is a \cs{dimen} register rather than a \cs{skip} register.} |
| 1478 |
% |
| 1479 |
% to have the width of the \emph{rim} area placed at each paper edge to |
| 1480 |
% inhibit \bgpaint{} in the area. That is, the inner edges of the area are |
| 1481 |
% considered as virtual paper edges to block painting of all margins and |
| 1482 |
% regions having \bginfext{} to the edges, for example in order to |
| 1483 |
% avoid printing troubles caused by painting the rim area too close to the |
| 1484 |
% real paper edges. The default value of \!\pagerim! is 0 to allow paint |
| 1485 |
% anywhere in a paper. |
| 1486 |
% \end{description} |
| 1487 |
% |
| 1488 |
% |
| 1489 |
% |
| 1490 |
% \subsection{Control of Contents Output} |
| 1491 |
% \label{sec:ref-contents} |
| 1492 |
% |
| 1493 |
% \begin{description} |
| 1494 |
% \item[\Midx{\!\addcontentsonly!}\marg{file}\marg{col}]\mbox{}\par |
| 1495 |
% The command inhibits the output of contents information to |
| 1496 |
% $\meta{file}\in\{|toc|,|lof|,|lot|\}$ from columns other than \meta{col}. |
| 1497 |
% |
| 1498 |
% \begin{itemize} |
| 1499 |
% \item |
| 1500 |
% For example, this manual has \!\addcontentsonly!|{toc}{0}| to |
| 1501 |
% inhibit the contents information output from \!\subsection! commands |
| 1502 |
% in the right column in Section~\ref{sec:env} and~\ref{sec:float}, |
| 1503 |
% or the table should have duplicated entries of sub-sections. |
| 1504 |
% |
| 1505 |
% \item |
| 1506 |
% It must be $\meta{file}\in\{|toc|,|lof|,|lot|\}$, or you will have an |
| 1507 |
% error message of illegal type of contents file. |
| 1508 |
% \end{itemize} |
| 1509 |
% \end{description} |
| 1510 |
% |
| 1511 |
% |
| 1512 |
% |
| 1513 |
% \subsection{Page Flushing Commands} |
| 1514 |
% \label{sec:ref-flush} |
| 1515 |
% |
| 1516 |
% \begin{description} |
| 1517 |
% \item[\Midx{\!\flushpage!}]\mbox{}\par |
| 1518 |
% The command flushes pages up to the {\em\Uidx\tpage} in which the \lcolumn{} |
| 1519 |
% resides. Deferred floats which can be put in the pages up to the \tpage{} |
| 1520 |
% are also flushed. |
| 1521 |
% |
| 1522 |
% \item[\Midx{\!\clearpage!}]\mbox{}\par |
| 1523 |
% The command does what \!\flushpage! does and then flushes all floats still |
| 1524 |
% deferred if any. The deferred float flushing beyond the \tpage{} takes |
| 1525 |
% place at first for \cwise{} ones creating \fcolumn{}s for them, and |
| 1526 |
% then for \pwise{} ones creating {\em\Uidx\fpage{}s} only with |
| 1527 |
% \pwise{} floats, as \LaTeX's \!\clearpage! does outside \env{paracol} |
| 1528 |
% environment. |
| 1529 |
% |
| 1530 |
% \item[\Midx{\!\cleardoublepage!}]\mbox{}\par |
| 1531 |
% \changes{v1.3-5}{2013/09/17} |
| 1532 |
% {Add description of \cs{cleardoublepage}.} |
| 1533 |
% The command does what \LaTeX's \!\cleardoublepage! does outside |
| 1534 |
% \env{paracol}. That is, it does \!\clearpage! always and then leaves a |
| 1535 |
% blank page if it is even-numbered and two-sided |p|(age) feature is |
| 1536 |
% enabled by |twoside| option of \!\documentclass! or \Paracol's own |
| 1537 |
% \!\twosided! command shown in Section~\ref{sec:ref-twoside}. |
| 1538 |
% |
| 1539 |
% \begin{itemize} |
| 1540 |
% \item |
| 1541 |
% This command is equivalent to \!\clearpage! in \env{paracol} environments |
| 1542 |
% for \npaired{} \parapag{}ing because \!\clearpage! flushes \emph{both} |
| 1543 |
% left and right \parapag{}es. |
| 1544 |
% \end{itemize} |
| 1545 |
% \end{description} |
| 1546 |
\endinput |