From ab9be52a67d39f40115219e0f9bc910e2f3fe161 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 13 Apr 2015 22:09:26 +0000 Subject: eledmac (13apr15) git-svn-id: svn://tug.org/texlive/trunk@36840 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/source/latex/eledmac/eledmac.dtx | 2210 ++++++++++++++------ Master/texmf-dist/source/latex/eledmac/eledpar.dtx | 618 +++--- 2 files changed, 1879 insertions(+), 949 deletions(-) (limited to 'Master/texmf-dist/source/latex/eledmac') diff --git a/Master/texmf-dist/source/latex/eledmac/eledmac.dtx b/Master/texmf-dist/source/latex/eledmac/eledmac.dtx index 02faa9a3688..a4497cb1601 100644 --- a/Master/texmf-dist/source/latex/eledmac/eledmac.dtx +++ b/Master/texmf-dist/source/latex/eledmac/eledmac.dtx @@ -51,7 +51,8 @@ % % \fi % -% \CheckSum{10716} +% \newcommand{\reff}[1]{\ref{#1} p.~\pageref{#1}} +% \CheckSum{11453} % % \makeatletter % \newcommand*{\DescribeIt}{\leavevmode\@bsphack\begingroup\MakePrivateLetters @@ -138,6 +139,7 @@ % \newcommand{\Lpack}[1]{\textsf{#1}} % \newcommand{\Lclass}[1]{\textsf{#1}} % \newcommand{\file}[1]{\texttt{#1}} +% \newcommand{\Eledpar}{\Lpack{eledpar}} % \newcommand{\eledmac}{eledmac} % \newcommand{\Eledmac}{\Lpack{\eledmac}} % \newcommand{\edmac}{\texttt{EDMAC}} @@ -206,7 +208,7 @@ % \changes{v1.12.3}{2014/08/15}{Correct bug with side and familiar notes in tabular environments.} % \changes{v1.12.3}{2014/08/15}{Debug left and right notes (bugs added by 1.12.0)} % \changes{v1.12.3}{2014/08/15}{Debug \cs{eledxxx} with some paper size} -% \changes{v1.12.4}{2014/08/25}{Debug spurious page breaks before \cs{chapter} (bug added by 1.12.0)} +% \changes{v1.12.4}{2014/08/25}{Debug spurious page breaks before \cs{chapter} (bug added in 1.12.0)} % \changes{v1.13.1}{2014/09/25}{Debug quotation environment inside of a \cs{pstart} preceded by a sectioning command.} % \changes{v1.13.1}{2014/09/25}{Coming back of page and line breaking penalties's management, deleted by error in v0.17.} % \changes{v1.13.2}{2014/09/30}{Fix bug with normal footnotes, added by v1.13.0.} @@ -225,6 +227,20 @@ % \changes{v1.20.0}{2015/03/22}{The \cs{newif}s are not followed by boolean values set to false, because it is the \TeX\ default setting.} % \changes{v1.20.0}{2015/03/22}{Explicit error message when calling \cs{Xfootnote} outside of \cs{edtext}.} % \changes{v1.20.0}{2015/03/22}{Fix bug with line number typesetting direction when using \cs{eledsection} and similar commands for RTL texts with \LuaLaTeX.} +% \changes{v1.21.0}{2015/04/13}{\cs{AtEveryPstart} and \cs{AtEveryPend} are now compatible with \cs{autopar}} +% \changes{v1.21.0}{2015/04/13}{Fix bug with space between columns with notes in two columns (bug added in v1.13.0).} +% \changes{v1.21.0}{2015/04/13}{Add nocritical, noend, nofamiliar and noledgroup options.} +% \changes{v1.21.0}{2015/04/13}{Fix bug with \cs{maxhnotesX} when using \cs{foottwocolX} or \cs{footthreecolX}.} +% \changes{v1.21.0}{2015/04/13}{Add \cs{twolinesbutnotmore} and \cs{twolinesonlyinsamepage}.} +% \changes{v1.21.0}{2015/04/13}{Fix bug when a \cs{Xfootnote} follows a \cs{Xendnote} in the second argument of \cs{edtext} (bug added in eledmac 1.0.0 !).} +% \changes{v1.21.0}{2015/04/13}{Add noeledsec package option} +% \changes{v1.21.0}{2015/04/13}{parapparatus option works now with familiar footnotes.} +% \changes{v1.21.0}{2015/04/13}{Add \cs{beforenotesX} and \cs{beforeXnotes} features for notes set in two and three column.} +% \changes{v1.21.0}{2015/04/13}{Debug \cs{beforenotesX} \cs{maxhnotesX} \cs{notesXwidthliketwocolumns} and \cs{afterruleX} with footnotes set in two and three columns.} +% \changes{v1.21.0}{2015/04/13}{\cs{afterXrule} and \cs{afterruleX} features no longer create problems of overflowing at the bottom of the page.} +% \changes{v1.21.0}{2015/04/13}{\cs{preXnotes} and \cs{prenotesX} features no longer create problems of overflowing at the bottom of the page.} +% \changes{v1.21.0}{2015/04/13}{Fix spurious space after first page number in \cs{doendnotes}. oldprintnpnumspace option allows to come back to previous setting} +% \changes{v1.21.0}{2015/04/13}{\cs{chapter} inside optional argument of \cs{pstart} works when typesetting parallel pages} % \hyphenation{man-u-script man-u-scripts} % % @@ -244,17 +260,16 @@ % \end{minipage}\par\endgroup} % % \title{\Lpack{\eledmac} \\ -% A presumptuous attempt to port \\ -% \edmac, \tabmac{} and \edstanza{} to LaTeX\thanks{This file (\dtxfilename) +% Typeset scholarly editions with \LaTeX\thanks{This file (\dtxfilename) % has version number \fileversion, last revised \filedate.}} % % \author{% -% Peter Wilson \\ -% Herries Press\thanks{% -% \texttt{herries dot press at earthlink dot net}} \\ % Ma\"ieul Rouquette\thanks{\texttt{maieul at maieul dot net}} \\ -% {\small based on the original work by} \\ -% John Lavagnino, Dominik Wujastyk, Herbert Breger and Wayne Sullivan +% {\small based on the original \Lpack{ledmac} by} \\ +% Peter Wilson \\ +% Herries Press \\ +% {\small which was based on the original \edmac, \tabmac{} and \edstanza{} by} \\ +% John Lavagnino, Dominik Wujastyk, Herbert Breger and Wayne Sullivan. % } % % \date{} @@ -584,9 +599,9 @@ % % Since July~2011, ledmac is maintained by Ma\"ieul Rouquette. % -% Important changes were put in version 1.0, to make eledmac more easily extensible (see \ref{displayoptions} p.\pageref{displayoptions}). +% Important changes were put in version 1.0, to make eledmac more easily extensible (see \reff{displayoptions}). % These changes can trigger small problems with the old customization. -% That is why a new name was selected: \emph{eledmac}. To migrate from ledmac to eledmac, please read Appendix \ref{migration} (p.\pageref{migration}). +% That is why a new name was selected: \emph{eledmac}. To migrate from ledmac to eledmac, please read Appendix \ref{migration} (p.~\pageref{migration}). % % \subsubsection{List of works edited with (e)ledmac} % A collaborative list of works edited with (e)ledmac is available on \url{https://www.zotero.org/groups/critical_editions_typeset_with_edmac_ledmac_and_eledmac/items}. Please add your own edition made with (e)ledmac. @@ -621,15 +636,24 @@ % The package can be loaded with a number of global options which are listed here. % It is advised to read the relevant parts of the handbook before reading this section. % \begin{description} -% \item[draft], if called, underline lemmas in the main text. +% \item[draft] underlines lemmas in the main text. % \item[ledsecnolinenumber] is deprecated. -% \item[nopbinverse] prevent page break inside verses. -% \item[noquotation] by default, the quotation environment is redefined inside numbered text. You can disable this redefinition with \verb|noquotation| (see \ref{noquotation} p.~\pageref{noquotation}). -% \item[parapparatus] by default, the appparatus cannot contain paragraph breaks; this option enables paragraphing inside the apparatus. +% \item[nocritical] disables tools for critical footnotes (\cs{Afootnote}, \cs{Bfootnote} etc.). If you do not need critical footnotes, this option lets \eledmac\ run faster. +% It will also preserve room for other packages. +% \item[noeledsec] disables tools for \cs{eledsection} and related commands (\reff{eledsection}). +% \item[noend] disables tools for end footnotes (\cs{Aendnote}, \cs{Bendnote} etc.). If you do not need endnotes, this option lets \eledmac\ run faster. +% It will also preserve room for other packages. +% \item[nofamiliar] disables tools for familiar footnotes (\cs{footnoteA}, \cs{footnoteB} etc.). If you do not need familiar footnotes, this option lets \eledmac\ run faster. +% It will also preserve room for other packages. +% \item[noledgroup] \eledmac{} allows to use of (two or more) critical series of notes and (two or more) new series of normal notes inside minipage and ledgroup environments (see~\reff{ledgroup}). However, such features use up computer memory, at the expense of other processing needs. So if you do not need this feature, use \verb+noledgroup+ option. This should make \eledmac{} faster. +% \item[nopbinverse] prevents page break inside verses. +% \item[noquotation] by default, the quotation environment is redefined inside numbered text. You can disable this redefinition with \verb|noquotation| (see \reff{noquotation}). +% \item[oldprintnpnumspace] is only to be used if you want to have the (bugged) behavior of \cs{doendnotes} of \Eledmac{} versions prior to v.1.21.0 (see \reff{oldprintnpnumspace}) +% \item[parapparatus] by default, the apparatus cannot contain paragraph breaks; this option enables paragraphing inside the apparatus. % \item[series] \Lpack{eledmac} defines six levels of notes: A, B, C, D, E, Z. % Using all these levels consumes memory space and processing speed. % This is why, if your work does not require all of the A-E, Z series, you can narrow down the available number of series. -% For example, if you only need A and B series, call the package with verb+series={A,B}+ option. +% For example, if you only need A and B series, call the package with \verb+series={A,B}+ option. % \item[widthliketwocolumns] set the width of the text disposed on one column to be the same as the width of the text disposed on two parallel columns with \Lpack{eledpar}. This is useful when alternating between normal and parallel typesetting. % \end{description} % \section{Text lines and paragraphs numbering} @@ -734,15 +758,15 @@ % \AtEveryPend{\vskip\parskip}% Apply after every \Pend % \end{verbatim} -%. This feature is also useful when typesetting verses (see~\ref{verse} p.~\pageref{verse}) or \Lpack{eledpar} (see~\ref{eledpar} p.~\pageref{eledpar}). +%. This feature is also useful when typesetting verses (see~\reff{verse}) or \Lpack{eledpar} (see~\reff{eledpar}). % % A \cs{noindent} is automatically added before this argument. % \subsubsection{Content before every \cs{pstart} and after every \cs{pend}} % \changes{v1.15.0}{2015/01/12}{New commands \cs{AtEveryPstart} and \cs{AtEveryPend}.} -% \DescribeMacro{\AtEveryPstart}\DescribeMacro{\AtEveryPend} +% \label{AtEveryPstart} \DescribeMacro{\AtEveryPstart}\DescribeMacro{\AtEveryPend} % You can use both \cs{AtEveryPstart} and \cs{AtEveryPend}. % Their arguments will be printed before every \cs{pstart} begins / after every \cs{pend} ends. -% \subsubsection{Producting automatically \cs{pstart}…\cs{pend}} +% \subsubsection{Producting automatically \cs{pstart}\ldots{}\cs{pend}} % \DescribeMacro{\autopar} % You can use \cs{autopar} to avoid the nuisance of this paragraph markup % and still have every paragraph automatically numbered. The scope of the @@ -817,7 +841,7 @@ % with this is that your line numbering will start again at zero % with each new section. To avoid this problem, we provide % \cs{pausenumbering} and \cs{resumenumbering} which are just -% like \cs{endnumbering} \ldots \cs{beginnumbering}, except that +% like \cs{endnumbering} \ldots\ \cs{beginnumbering}, except that % they arrange for your line numbering to continue across the break. % Use \cs{pausenumbering} only between numbered paragraphs: % \egstart @@ -1012,8 +1036,8 @@ % use \cs{linenumberstyle}\marg{style} to change the numbering style. % \meta{style} must be one of: % \begin{itemize} -% \item[\texttt{Alph}] Uppercase letters (A\ldots Z). -% \item[\texttt{alph}] Lowercase letters (a\ldots z). +% \item[\texttt{Alph}] Uppercase letters (A\ldots\ Z). +% \item[\texttt{alph}] Lowercase letters (a\ldots\ z). % \item[\texttt{arabic}] Arabic numerals (1, 2, \ldots) % \item[\texttt{Roman}] Uppercase Roman numerals (I, II, \ldots) % \item[\texttt{roman}] Lowercase Roman numerals (i, ii, \ldots) @@ -1028,8 +1052,13 @@ % When inserted into a numbered line the macro \cs{skipnumbering} causes % the numbering of that particular line to be skipped; that is, the line % number is unchanged and no line number will be printed. +% Note that if you use it in \cs{stanza}, you must call it at the beginning of the verse. % -% +% \DescribeMacro{\hidenumbering} +% \changes{v1.21.0}{2015/04/13}{Add \cs{hidenumbering}} +% When inserted into a numbered line the macro \cs{hidenumbering} causes +% the number for that particular line to be hidden; namely, no line number will print. +% Note that if you use it in \cs{stanza}, you must call it at the beginning of the verse. % \section{The apparatus} % \subsection{Commands} % \DescribeMacro{\edtext} @@ -1107,10 +1136,11 @@ % \DescribeMacro{\Cfootnote} % \DescribeMacro{\Dfootnote} % \DescribeMacro{\Efootnote} -% Five separate series of the footnotes are maintained; each macro -% taking one argument like \cs{Afootnote}\marg{text}. When all five +% \DescribeMacro{\Zfootnote} +% Six separate series of the footnotes are maintained; each macro +% takes one argument like \cs{Afootnote}\marg{text}. When all of the five % are used, the \texttt{A} notes appear in a layer just below the main -% text, followed by the rest in turn, down to the \texttt{E} notes at +% text, followed by the rest in turn, down to the \texttt{Z} notes at % the bottom. These are the main macros that you will use to construct % the critical apparatus of your text. The package provides five % layers of notes in the belief that this will be adequate for @@ -1122,7 +1152,7 @@ %An optional argument can be added before the text of the footnote. Its value is a comma separated list of options. % \label{fulllines}The available options are: % \begin{itemize} -% \item \verb|fulllines| to disable \cs{twolines} and \cs{morethantwolines} features for this note (cf. \ref{twolines} p.~\pageref{twolines}). +% \item \verb|fulllines| to disable \cs{twolines} and \cs{morethantwolines} features for this note (cf. \reff{twolines}). % \item \verb|nonum| to disable line numbering for this note. % \item \verb|nosep| to disable the lemma separator for this note. % \end{itemize} @@ -1134,12 +1164,13 @@ % \DescribeMacro{\Cendnote} % \DescribeMacro{\Dendnote} % \DescribeMacro{\Eendnote} -% The package also maintains five separate series of endnotes. +% \DescribeMacro{\Zendnote} +% The package also maintains six separate series of endnotes. % Like footnotes each macro takes a single argument like % \cs{Aendnote}\marg{text}. % Normally, none of them are printed: you must use the % \cs{doendnotes} macro described below -% (p.\,\pageref{doendnotes}) to call for their +% (\reff{doendnotes}) to call for their % output at the appropriate point in your document. % % By default, no paragraph can be made in the notes of critical apparatus. @@ -1200,7 +1231,7 @@ % specify a note with an abbreviated lemma using \cs{lemma} and % \cs{linenum}. The numbers used in \cs{linenum} need not be % entered manually; you can use the `\texttt{x-}' symbolic cross-referencing -% commands below (p.\,\pageref{crossref}) to compute them +% commands below (\reff{crossref}) to compute them % automatically. % % Similarly, being able to manually change the lemma's font specifier @@ -1302,19 +1333,21 @@ % \changes{v1.0}{2012/09/15}{New generic commands to customize footnote display.} % Since version 1.0, some commands can be used to change the display of the footnotes. All can have an optional argument \oarg{s}, which is the letter of the series --- or a list of letters separated by comma --- depending on which option is applied. % -% When a length, noted \meta{l}, is used, it can be stretchable: \verb|a plus b minus c|. The final length |m| is calculated by \LaTeX{} to have: $a-c \leq m \leq a+b$. If you use relative unity\footnote{Like \verb|em| which is the width of a M.}, it will be relative to fontsize of the footnote. +% When a length, noted \meta{l}, is used, it can be stretchable: \verb|a plus b minus c|. The final length |m| is calculated by \LaTeX{} to have: $a-c \leq m \leq a+b$. If you use some relative unity\footnote{Like \verb|em| which is the width of a mg.}, it will be relative to fontsize of the footnote, except for commands concerning the place kept by the notes --- including blank space. % % \subsubsection{Control line number printing} % \DescribeMacro{\numberonlyfirstinline} % \changes{v1.0.1}{2012/09/16}{Correction on \cs{numberonlyfirstinline} with lineation by pstart or by page.} -% By default, the line number is printed in every note. If you want to print it only the first time for a value (i.e one time for line 1, one time for line 2 etc.), you can use \cs{numberonlyfirstinline}\oarg{s}. Use \cs{numberonlyfirstinline}\oarg{s}\verb+[false]+ to cancel it (\verb|| can be empty if you want to disable it for every series). +% By default, the line number is printed in every note. If you want to print it only the first time for a given line number (i.e one time for line 1, one time for line 2 etc.), you can use \cs{numberonlyfirstinline}\oarg{s}. +% +% Use \cs{numberonlyfirstinline}\oarg{s}\verb+[false]+ to disable this (\verb|| can be empty if you want to disable it for every series). % % \DescribeMacro{\numberonlyfirstintwolines} % \changes{v1.1}{2012/09/25}{Add \cs{numberonlyfirstintwolines}} % Suppose you have a lemma on line~2 and a lemma between line~2 and line~3. % With \cs{numberonlyfirstinline}, the second lemma is considered to be on the same line as the first lemma. % But if you use both \cs{numberonlyfirstinline}\oarg{s} and \cs{numberonlyfirstintwolines}\oarg{s}, the distinction is made. -% Use \cs{numberonlyfirstintwolines}\oarg{s}\verb+[false]+ to cancel it (\verb|| can be empty if you want to disable it for every series). +% Use \cs{numberonlyfirstintwolines}\oarg{s}\verb+[false]+ to disable this (\verb|| can be empty if you want to disable it for every series). % % \changes{v1.20.0}{2015/03/22}{Add \cs{twolines} and \cs{morethantwolines} hooks} % \label{twolines} @@ -1331,11 +1364,30 @@ % \end{verbatim} % Will print ``1sq.'' for a lemma which falls on lines 1-2 and ``1sqq.'' for a lemma which falls on lines 1-4. % -% If you use \cs{twolines} without setting \cs{morethantwolines}, the \verb|| argument of \cs{twolines} will be used for lemmas which fall on three and more lines. +% \DescribeMacro{\morethantwolines} If you use \cs{twolines} without setting \cs{morethantwolines}, the \verb|| argument of \cs{twolines} will be used for lemmas which fall on three or more lines. +% +% However, if you want to use a short form (when the lemma overlaps two lines, but not more than two), use \cs{twolinesbutnotmore}\oarg{series}. +% +% It is possible to disable \cs{twolinesbutnotmore}\oarg{series} with \cs{twolinesbutnotmore}\oarg{series}\verb+[false]+. +% +% When you use lineation by page, the final page number, if different from the initial page number, +% will not be printed, because the final page number is included in the \cs{Xendtwolines} symbol. +% +% \DescribeMacro{\twolinesonlyinsamepage} +% However, you can force print the final page number with\\ +% \cs{twolinesonlyinsamepage}\oarg{series}. +% +% Use \cs{twolinesonlyinsamepage}\oarg{series}\verb+[false]+ to disable this. +% +% You can disable \cs{twolines} and related for a specific note by using the `[fulllines]` argument in the note macro cf.~\reff{fulllines}. +% +% \label{Xendtwolines}\changes{v1.21.0}{2015/04/13}{Add \cs{Xendtwolines}, \cs{Xendmorethantwolines}, \cs{Xendtwolinesbutnotmore} and \cs{Xendtwolinesonlyinsamepage}.} +% \DescribeMacro{\Xendtwolines}\DescribeMacro{\Xendmorethantwolines}\DescribeMacro{\Xendtwolinesbutnotmore} +% For endnotes, use \cs{Xendtwolines}; \cs{Xendmorethantwolines}; \cs{Xendtwolinesbutnotmore}; \cs{Xendtwolinesonlyinsamepage} instead of \cs{twolines}; \cs{morethantwolines}; \cs{twolinesbutnotmore}; \cs{twolinesonlyinsamepage}. +% % -% You can disable this option for a specific note by using the `[fulllines]` argument in the note macro cf.~\ref{fulllines} p.~\pageref{fulllines}. % \DescribeMacro{\symlinenum} -% For setting a particular symbol in place of the line number, you can use \cs{symlinenum}\oarg{s}\marg{symbol} in combination with \cs{numberonlyfirstinline}\oarg{s}. From the second lemma of the same line, the symbol will be used instead of line number. +% For setting a particular symbol in place of the line number, you can use \cs{symlinenum}\oarg{s}\marg{symbol} in combination with \cs{numberonlyfirstinline}\oarg{s}. From the second lemma of the same line, the symbol will be used instead of the line number. % % \DescribeMacro{\nonumberinfootnote} % You can use \cs{nonumberinfootnote}\oarg{s} if you don't want to have the line number in a footnote. To cancel it, use \cs{nonumberinfootnote}\oarg{s}\verb+[false]+. @@ -1449,12 +1501,20 @@ % % % \subsubsection{Styles of notes content} +% \changes{v1.21.0}{2015/04/13}{Add \cs{Xparindent} and \cs{hangindentX}} +% \DescribeMacro{\Xparindent} +% By default, \Eledmac{} does not add indentation before the paragraphs inside critical footnotes. +% Use \cs{Xparindent}\oarg{series} to enable indentation. +% +% \DescribeMacro{\parindentX} +% By default, \Eledmac{} does not add indentation before the paragraphs inside familiar footnotes. +% Use \cs{parindentX}\oarg{series} to enable indentation. % % \DescribeMacro{\Xhangindent} % For critical notes NOT paragraphed you can define an indent with \cs{Xhangindent}\oarg{s}\marg{l}, which will be applied in the second line of notes. It can help to make distinction between a new note and a break in a note. The default value is 0~pt. % % \DescribeMacro{\hangindentX} -% For familiar notes NOT paragraphed you can define an indent with \cs{Xhangindent}\oarg{s}\marg{l}, which will be applied in the second line of notes. It can help to make a distinction between a new note and a break in anote. +% For familiar notes NOT paragraphed you can define an indentation with \cs{Xhangindent}\oarg{s}\marg{l}, which will be applied in the second line of notes. It can help to make a distinction between a new note and a break in a note. % % \subsubsection{Arbitrary code at the beginninging of notes} % \changes{v1.1}{2012/09/25}{New hook to add arbitrary code at the beginning of the notes} @@ -1476,7 +1536,24 @@ % \DescribeMacro{\bhookXendnote} % \cs{bhookXendnote}\oarg{series}\marg{code} is to be used at the beginning of the endnotes. % -% \subsubsection{Options for notes in columns} +% \subsubsection{Options for footnotes in columns} +% \paragraph{Alignement} +% \changes{v1.21.0}{2015/04/13}{Add \cs{Xcolalign} and \cs{colalignX} hooks} +% By default, texts in footnotes in two or three columns are flushed left without hyphenation. +% However, you can change this with \cs{Xcolalign}\oarg{s}\marg{code}, for critical footnotes, and \cs{colalignX}\oarg{s}\marg{code}, for familiar footnotes. +% +% \verb++ must be one of the following command: +% \begin{description} +% \item[\cs{justifying}] to have text justified, as usual with \LaTeX. You can also let \verb++ empty. +% \item[\cs{raggedright}] to have text left aligned, but \emph{without hyphenation}. That is the default \Lpack{eledmac} setting. +% \item[\cs{RaggedRight}] to have text left aligned \emph{with hyphenation}. +% \item[\cs{raggedleft}] to have text right aligned, but \emph{without hyphenation}. +% \item[\cs{RaggedLeft}] to have text right aligned \emph{with hyphenation}. +% \item[\cs{centering}] to have text centered, but \emph{without hyphenation}. +% \item[\cs{Centering}] to have text centered \emph{with hyphenation}. +% \end{description} +% +% \paragraph{Size of the columns} % For the following four macros, be careful that the columns are made from right to left. % % \DescribeMacro{\hsizetwocol} @@ -1529,7 +1606,6 @@ % % \textbf{Be careful, the standard \LaTeX\ footnote rule, which is used by \Lpack{eledmac}, adds 2.6pt. These 2.6pt are not changed by this command.} % -% Be careful with this setting: it can place notes by the page number, at the bottom of the page. % % \DescribeMacro{\afterruleX} % You can change the vertical space printed after the rule of the familiar notes with \cs{beforenotesX}\oarg{s}\marg{l}. @@ -1537,7 +1613,6 @@ % % \textbf{Be careful, the standard \LaTeX\ footnote rule, which is used by \Lpack{eledmac}, adds 2.6pt. These 2.6pt are not changed by this command.} % -% Be careful with this setting: it can place notes by the page number, at the bottom of the page. % % \DescribeMacro{\preXnotes} % You can set the space before the first series of critical notes printed on each page @@ -1546,7 +1621,6 @@ % You can disable this feature by setting the length to 0pt. % % -% Be careful with this setting: it can place notes by the page number, at the bottom of the page. % % \DescribeMacro{\prenotesX} % You can want the space before the first printed (in a page) series of familiar notes not to be the same as before other series. Default value is \verb+0pt+. @@ -1554,7 +1628,6 @@ % You can disable this feature by setting the length to 0~pt. % % -% Be careful with this setting: it could make the notes be written on the bottom pages number. % \DescribeMacro{\maxhXnotes}\label{maxhXnotes} % By default, one series of critical notes can take 80\% of the page size, before being broken to the next page. % If you want to change the size use \cs{maxhXnotes}\oarg{s}\marg{l}. @@ -1582,7 +1655,7 @@ % {\tt \bslash break}, or {\tt \bslash penalty=-10000}. If % you must have a line-break for some obscure reason, just suggest % the break very strongly: {\tt \bslash penalty=-9999} will do -% the trick. Page \pageref{nobreak} explains why this restriction +% the trick. \reff{nobreak} explains why this restriction % is necessary.} % % \changes{v1.13.0}{2014/09/16}{Add \cs{Xnoteswidthliketwocolumns} and \cs{notesXwidthliketwocolumns}} @@ -1681,12 +1754,26 @@ % formatted in the same way. % % +% \subsection{Changing series} +% \subsubsection{Create a new series}\label{newseries} % -% \subsection{Create a new series}\label{newseries} -% -% If you need more than 5 series of critical footnotes you can +% If you need more than six series of critical footnotes you can % create extra series, using \cs{newseries} command. For example to create G and H series \cs{newseries}\verb+G,H+. +% +% \subsubsection{Delete series} +% As the number of series which are defined increases, \Eledmac{} gets slower. +% If you do not need all of the six standard series (A, B, C, D, E, Z), +% you can load the package with the \verb+series+ option. +% For example if you need only series~A and~B, use: +% \begin{verbatim} +% \usepackage[series={A,B}]{eledmac} +% \end{verbatim} +% \subsubsection{Series order} +% The default series order is the one called with the \verb+series+ option of the package, or, if this option is not used, A, B, C, D, E, Z. +% Series order determines footnotes order. % +% \DescribeMacro{seriesatbegin}\DescribeMacro{seriesatend} However in some specific cases, you need to change the series order at some point inside the document. +% You can use \cs{seriesatbegin}\marg{} to pull up a given series \verb++ to the beginning, or \cs{seriesatend}\marg{} to push it down to the end. % \section{Verse}\label{verse} % % @@ -1737,7 +1824,7 @@ % 0 but is never used. % % If you want the hanging verse to be flush right, -% you can use \cs{hanginsymbol}: see p.~\pageref{hfillhanging}. +% you can use \cs{hanginsymbol}: see p.~\reff{hfillhanging}. % % Enumeration is by stanza lines, not by print lines. % In the above example the lines are indented one unit, two units, one unit, @@ -1757,7 +1844,7 @@ %\setstanzaindents{0,1,0,1,0,1,0,1,0,1,0} % \end{verbatim} % -% \textbf{Be careful: the feature change in eledmac 1.5.1. See \ref{change151} p.~\pageref{change151}.} +% \textbf{Be careful: the feature is changed in eledmac 1.5.1. See \reff{change151}.} % %If you don't use the \verb+stanzaindentsrepetition+ counter, make sure you have at least one more numerical % entry in \verb+\setstanzavalues+ than the number of lines in the stanza. @@ -1821,7 +1908,7 @@ % \end{verbatim} % \subsection{Long verse and page break} % If you want to prevent page breaks inside long verses, use the option \verb+nopbinverse+ when loading package, or use \cs{lednopbinversetrue}. -% Read \ref{lednopbinversetrue} p.~\pageref{lednopbinversetrue} for further details. +% Read \reff{lednopbinversetrue} for further details. % \subsection{Various tools} % \DescribeMacro{\ampersand} % If you need to print an \& symbol in a stanza, use the \verb?\ampersand? @@ -1884,7 +1971,7 @@ % in a minipage but unlike with \verb?\footnote? the numbering scheme is % unaltered. % -% \DescribeEnv{ledgroup} +% \DescribeEnv{ledgroup}\label{ledgroup} % Minipages, of course, aren't broken across pages. Footnotes in a \verb?ledgroup? % environment are typeset at the end of the environment, as with minipages, % but the environment includes normal page breaks. The environment makes no @@ -1933,7 +2020,7 @@ % macro that's called to print each note. It uses % \cs{select@lemmafont} % to select fonts, just as the footnote -% macros do (see p.\,\pageref{notefonts} above). +% macros do (see \reff{notefonts} above). % % As endnotes may be printed at any point in the document they always % start with the page number of where they were specified. The @@ -1941,10 +2028,7 @@ % Its default definition is: \\ % \verb?\newcommand*{\printnpnum}[1]{p.#1) }? % -% \DescribeMacro{\noendnotes} -% If you aren't going to have any endnotes, you can say \cs{noendnotes} -% in your file, before the first \cs{beginnumbering}, to suppress the -% generation of an unneeded \file{.end} file. +% If you do not use endnotes, you should use \verb+noend+ option when loading \Lpack{eledpar}. % % \section{Cross referencing} % \changes{v1.12.0}{2014/08/05}{Add hyperlink to crossref (needs \Lpack{hyperref} package).} @@ -1954,8 +2038,8 @@ % line number references to those places elsewhere % using those labels. % -% -% +% \subsection{Basic use} +% % \DescribeMacro{\edlabel} % First you place a label in the text using the command % \cs{edlabel}\marg{lab}. \meta{lab} can be almost anything you like, including @@ -2001,6 +2085,14 @@ % unafraid}{\Afootnote{Of the mouse, that is.}} % \end{verbatim} % +% If you add the \cs{edlabel} inside some \cs{Xfootnote} command, +% it will refer to that note, and a suffix \emph{n} will be added to the reference. +% You can redefine this suffix by redefining the command \cs{ledinnotemark}. +% Its actual definition is: +% \begin{verbatim} +% \newcommand{\ledinnotemark}[1]{#1\emph{n}} +% \end{verbatim} +% Where \verb+#1+ stands for the reference. % \DescribeMacro{\xpageref} % \DescribeMacro{\xlineref} % \DescribeMacro{\xsublineref} @@ -2024,7 +2116,7 @@ % do the necessary processing of the \file{.aux} file, and the \cs{x...} % ones cannot. % \item When \Lpack{hyperref} is loaded, the hyperref link won't be added. (Indeed, -% it's not a limitation, but a feature. +% it's not a limitation, but a feature.) % \end{itemize} % % \DescribeMacro{\xxref} @@ -2037,7 +2129,7 @@ % lines, for use in the second argument of \cs{edtext}. % It takes two arguments, both of which are % labels: e.g., \verb"\xxref{mouse}{elephant}". It calls \cs{linenum} -% (q.v., p.\,\pageref{linenum} above) and sets the beginning page, +% (q.v., \reff{linenum} above) and sets the beginning page, % line, and sub-line numbers to those of the place where % \verb"\edlabel{mouse}" was placed, and the ending numbers to those where % \verb"\edlabel{elephant}" occurs. @@ -2055,17 +2147,82 @@ % number here is zero. It is usually best to collect your % \cs{edmakelabel} statements near the top of your document, so that % you can see them at a glance. -% +% \subsection{Normal \LaTeX\ cross-referencing} % \DescribeMacro{\label} % \DescribeMacro{\ref} % \DescribeMacro{\pageref} % \changes{v0.2.1}{2003/08/25}{Added text about normal labeling} % The normal \cs{label}, \cs{ref} and \cs{pageref} macros may be used % within numbered text, and operate in the familiar fashion. +% \subsection{References to lines commented in the apparatus} +% \changes{v1.21.0}{2015/03/09}{Add \cs{applabel} and related} +% You may want to make a cross-reference to a passage that is referred to by \cs{edtext}. +% \Eledmac{} provides specific tools for this scenario. +% +% \DescribeMacro{\applabel} +% If you use \cs{applabel}\marg{label} inside the second argument of a \cs{edtext}, +% \Eledmac\ will add a \cs{edlabel} at the beginning and end of the marked passage. +% The label at the beginning of the passage will have the title \verb+