summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/paracol/ref.dtx
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2012-05-17 23:09:41 +0000
committerKarl Berry <karl@freefriends.org>2012-05-17 23:09:41 +0000
commit4a5f999a9de88cf98848a7d522b94f16c17d023c (patch)
treef7162c3c3be825beed95af289df5980e29fbe844 /Master/texmf-dist/source/latex/paracol/ref.dtx
parent00d87600cfa34bf3f096ba6e289516862409af71 (diff)
paracol (17may12)
git-svn-id: svn://tug.org/texlive/trunk@26474 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/paracol/ref.dtx')
-rw-r--r--Master/texmf-dist/source/latex/paracol/ref.dtx70
1 files changed, 66 insertions, 4 deletions
diff --git a/Master/texmf-dist/source/latex/paracol/ref.dtx b/Master/texmf-dist/source/latex/paracol/ref.dtx
index 5383aa5e3fb..29cbda9a706 100644
--- a/Master/texmf-dist/source/latex/paracol/ref.dtx
+++ b/Master/texmf-dist/source/latex/paracol/ref.dtx
@@ -1,5 +1,7 @@
% \section{Reference Manual}
+% \label{sec:ref}
% \subsection{Environment \texttt{paracol}}
+% \label{sec:ref-paracol}
%
% \begin{description}
% \item[\ENV{paracol}{\marg{num}\oarg{text}}]\mbox{}\par
@@ -71,6 +73,7 @@
%
%
% \subsection{Column-Switching Command and Environments}
+% \label{sec:ref-switchcolumn}
%
% \begin{description}
% \item[\Midx{\!\switchcolumn!}\oarg{col}]\mbox{}
@@ -220,8 +223,65 @@
% \end{description}
%
%
+% \subsection{Command to Control Column Width}
+% \label{sec:ref-columnratio}
+% \changes{v1.1}{2012/05/11}
+% {Add description of \cs{columnratio}.}
+%
+% \begin{description}
+% \item[\Midx{\!\columnratio!}\Arg{$r_0,r_1,\cdots,r_k$}]\mbox{}\par
+% The command defines the width of each column by the fraction $r_i$ to
+% specify the portion which $i$-th ($i=0$ for the leftmost) column
+% occupies. More specifically, the width $\Midx{\w}_i$ of the $i$-th column
+% is defined as follows, where $W$ is \!\textwidth!, $S$ is \!\columnsep!,
+% and $n$ is the numnber of columns given to \beginparacol.
+% 
+% \begin{eqnarray*}
+% W'&=&W-(n-1)S\\
+% w_i&=&\cases{
+% r_iW'
+% \vrule height1.5\ht\strutbox depth1.5\dp\strutbox width0pt&$i\leq k$\cr
+% \displaystyle{(1-\sum_{j=0}^k r_j)W'\over n-(k+1)}&$i>k$}
+% \end{eqnarray*}
+% 
+% \begin{itemize}
+% \item
+% The equations above imply that $k<n-1$, $r_i>0$ and $\sum_{j=0}^k
+% r_j<1$. If $k\geq n-1$, $k$ is assumed to be $n-2$ and all $r_i$ such
+% that $i\geq n-1$ are ignored. If $r_i$ or its sum does not satisfy the
+% conditions, you will have an ugly result with ``Overful'' messages.
+%
+% \item
+% The argument $r_0,r_1,\cdots,r_k$ can be empty to mean $k=-1$ to let all
+% column widths be $W'/n$ as default.
+%
+% \item
+% The setting of column width by the command takes effect in the |paracol|
+% environments following the command\footnote{
+% 
+% If the command is in a \texttt{paracol} environment, the command does not
+% affect the column widths of the environment but does the next ones, though
+% such usage is very unusual.}.
+% 
+% Therefore, though placing the command in the preamble is the most natural
+% way\footnote{
+% 
+% Or second most to not using it at all, of course.},
+% 
+% you may place this command between two |paracol| environments to change
+% the column layout for the second one even when they appear in a page as
+% shown in Section~\ref{sec:man-close}.
+%
+% \item
+% In the $i$-th column, \!\columnwidth! has $w_i$ and, for outermost
+% paragraphs in the column, \!\linewidth! and \!\hsize! have $w_i$ as well.
+% \end{itemize}
+% \end{description}
+%
+%
%
% \subsection{Commands for Counters}
+% \label{sec:ref-counter}
%
% \begin{description}
% \item[\Midx{\!\globalcounter!}\marg{ctr}]\mbox{}\par
@@ -271,6 +331,7 @@
%
%
% \subsection{Control of Contents Output}
+% \label{sec:ref-contents}
%
% \begin{description}
% \item[\Midx{\!\addcontentsonly!}\marg{file}\marg{col}]\mbox{}\par
@@ -280,10 +341,10 @@
% \begin{itemize}
% \ifx\ONLYDESCRIPTION\undefined
% \item
-% For example, this manual has \!\addcontentsonly!|{toc}{0}| to inhibit the
-% contents information output from \!\subsection! commands in
-% Section~\ref{sec:env} and~\ref{sec:float}, or the table should have
-% duplicated entries of sub-sections.
+% For example, this manual has \!\addcontentsonly!|{toc}{0}| to
+inhibit the % contents information output from \!\subsection! commands
+in the right column % in % Section~\ref{sec:env} and~\ref{sec:float},
+or the table should have % duplicated entries of sub-sections.
%
% \else
% \item
@@ -303,6 +364,7 @@
%
%
% \subsection{Page Flushing Commands}
+% \label{sec:ref-flush}
%
% \begin{description}
% \item[\Midx{\!\flushpage!}]\mbox{}\par