diff options
author | Karl Berry <karl@freefriends.org> | 2015-09-06 23:19:58 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2015-09-06 23:19:58 +0000 |
commit | 36ca69fa1454d2fc9f7034b7486051219212f60f (patch) | |
tree | cc520a527098a2edceaee2a3fcf906a481347063 /Master/texmf-dist/source/latex | |
parent | 1b2ecd77871ef20cc07ab3df20ccbce3660456d8 (diff) |
reledmac (6sep15)
git-svn-id: svn://tug.org/texlive/trunk@38307 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex')
-rw-r--r-- | Master/texmf-dist/source/latex/reledmac/reledmac.dtx | 681 | ||||
-rw-r--r-- | Master/texmf-dist/source/latex/reledmac/reledpar.dtx | 136 |
2 files changed, 472 insertions, 345 deletions
diff --git a/Master/texmf-dist/source/latex/reledmac/reledmac.dtx b/Master/texmf-dist/source/latex/reledmac/reledmac.dtx index 09c7af31f3f..d30bdabe7b4 100644 --- a/Master/texmf-dist/source/latex/reledmac/reledmac.dtx +++ b/Master/texmf-dist/source/latex/reledmac/reledmac.dtx @@ -312,16 +312,20 @@ % \changes{v2.0.0}{2015/07/19}{Fix bug when printing only one series of endnotes, but wanted to keep endnotes for other series.} % \changes{v2.0.1}{2015/07/27}{Fix incompatibility between optional argument of \protect\cs{pstart} and \protect\cs{numberpstarttrue}} % \changes{v2.0.1}{2015/07/27}{Fix bug in eledmac-compat option} -% \changes{v2.1.0}{2015/08/08}{New tools to number stanza} -% -%\changes{v2.1.0}{2015/08/02}{Fix bug with \protect\cs{chapter} in optional argument of \protect\cs{pstart} in parallel typesetting with \protect\ltxclass{scrbook}.} +% \changes{v2.1.0}{2015/08/08}{New tools to number stanzas} +% \changes{v2.1.0}{2015/08/02}{Fix bug with \protect\cs{chapter} in optional argument of \protect\cs{pstart} in parallel typesetting with \protect\ltxclass{scrbook}.} % \changes{v2.1.0}{2015/08/02}{Fix bug with \protect\cs{eledchapter} in parallel typesetting with \protect\ltxclass{scrbook}.} -% \changes{v2.1.0}{2015/08/02}{Fix bug with \protect\cs{setline} at the begin of a \protect\cs{pstart}.} -% \changes{v2.1.0}{2015/08/02}{Fix bug with \protect\cs{advanceline} at the begin of a \protect\cs{pstart}.} -% \changes{v2.1.0}{2015/08/08}{Fix space bug with \protect\cs{Xbhooknote} and \protect\cs{bhooknoteX} when using to insert text and not to execute code.} -% \changes{v2.1.0}{2015/08/08}{Fix space bug with \protect\cs{Xbhooknote} and \protect\cs{bhooknoteX} when using to insert text and not to execute code.} +% \changes{v2.1.0}{2015/08/02}{Fix bug with \protect\cs{setline} at the beginning of a \protect\cs{pstart}.} +% \changes{v2.1.0}{2015/08/02}{Fix bug with \protect\cs{advanceline} at the beginning of a \protect\cs{pstart}.} +% \changes{v2.1.0}{2015/08/08}{Fix spacing bug with \protect\cs{Xbhooknote} and \protect\cs{bhooknoteX} when using them to insert text and not to execute code.} +% \changes{v2.1.0}{2015/08/08}{Fix spacing bug with \protect\cs{Xbhooknote} and \protect\cs{bhooknoteX} when using them to insert text and not to execute code.} % \changes{v2.1.1}{2015/08/13}{Fix bug with \protect\cs{ledpbsetting}\protect\arg{before}.} -% \changes{v2.1.2}{2015/08/26}{Fix bug with lineation by pstart and tabular environment (added in 2.1.0).} +% \changes{v2.1.2}{2015/08/26}{Fix bug with lineation by pstart and tabular environments (added in 2.1.0).} +% \changes{v2.1.3}{2015/09/05}{Fix bug with \protect\cs{edindex} when using not-Latin characters without UTF-8 engines} +% \changes{v2.1.3}{2015/09/05}{\protect\cs{Xhangindent} and \protect\cs{hangindentX} work now with all the paragraphs in the note.} +% \changes{v2.1.3}{2015/09/05}{\protect\cs{Xnoindent} and \protect\cs{noindentX} work now again (broken in 2.0.0).} +% \changes{v2.1.3}{2015/09/05}{Change some internal code in order to provide compatibility with \LaTeX\ release of october~2015} +% \changes{v2.1.3}{2015/09/05}{Fix bug which inserted double space before paragraphed familiar notes.} % \hyphenation{man-u-script man-u-scripts} % % @@ -348,16 +352,19 @@ % \begin{abstract} % % The \macpackage provides many tools in order to typeset scholarly editions. -% It is base on the \eledmac package, which was was based on \ledmac package, which was based on \edmac \TeX\ package. +% It is based on the \eledmac package, which was based on the \ledmac package, which was based on the \edmac \TeX\ package. % -% It can be use in combination with \parpackage in order to typeset two texts in parallel, like an original text and its translation in modern language. +% It can be used in combination with \parpackage in order to typeset two texts in parallel, +% like an original text and its translation in a modern language. % % % \Macpackage provides many tools and options. Normally, they are all documented in this file. -% Also provided is a help folder, ``\href{examples/.}{examples}''. The folder contains additional examples (although not for all cases). -% Example starting by ``1-'' are for basic uses, those starting by ``2-'' are for advanced uses. +% Also provided is a help folder, ``\href{examples/.}{examples}''. The folder contains additional examples (although not for every possible case). +% Examples starting with ``1-'' are for basic uses, those starting with ``2-'' are for advanced uses. % -% To report bugs or request a new feature, please go to ledmac GitHub page and click on ``New Issue'': \url{https://github.com/maieul/ledmac/issues/}. You must create an account on github.com to access my page (maieul/ledmac). GitHub accounts are free for open-source users. You can post messages in English or in French (preferred). +% To report bugs or request a new feature, please go to ledmac GitHub page and click on ``New Issue'': \url{https://github.com/maieul/ledmac/issues/}. +% You must create an account on github.com to access my page (maieul/ledmac). +% GitHub accounts are free for open-source users. You can post messages in English or in French (preferred). % % You can subscribe to the \macpackage mail list at:\\ \url{http://geekographie.maieul.net/146} % \end{abstract} @@ -366,11 +373,6 @@ % \tableofcontents % % -% -% -% -% -% % \section{Introduction} % % \subsection{Aim of the package} @@ -382,14 +384,13 @@ % \item automatic stepped line numbering, by page, section or paragraph; % \item sub-lineation within the main series of line numbers; % \item variant readings automatically keyed to line numbers; -% \item caters for both prose and verse; -% \item multiple series of the footnotes and endnotes; +% \item caters to both prose and verse; +% \item multiple series of footnotes and endnotes; % \item block or columnar formatting of the footnotes; % \item simple tabular material may be line numbered; % \item indexing keyed to page and line numbers. % \end{itemize} % -% % \Macpackage allows the scholar engaged in preparing a critical % edition to focus attention wholly on the task of creating the % critical text and evaluating the variant readings, text-critical @@ -397,30 +398,22 @@ % the formatting and visual correlation of all the disparate types % of information. % +% Apart from \macpackage there are other \LaTeX\ packages for typesetting critical editions. +% However, the aim of \macpackage is to provide an ``all in one'' and flexible tool in the field of critical editions. +% +% Any suggestions for new features are welcome. % -% Apart from \macpackage there are some other \LaTeX\ packages for -% critical edition typesetting. -% However, the aim of \macpackage is to provide an ``all in one'' and flexible tool in the field of critical edition. -% -% Any suggestion for new features are welcome. -% -% -% This manual contains a general description of how to use \macpackage and -% the complete source code for the package, -% with extensive documentation (in sections~\ref{overview} and following, numbered in Roman numeric). -% It ends with a list of actions to do when migrating from some version to other, a change history and an index to the +% This manual contains a general description of how to use \macpackage followed by +% the complete source code and its extensive documentation (in sections~\ref{overview} and following, enumerated with Roman numerals). +% It ends with a list of actions to do when migrating from one version to other, a change history and an index to the % source code. - -% We do not suggest that you need to -% read the source code for this package in order to use it; we -% provide this code primarily for reference, and many of our -% comments on it repeat material that is also found in -% the earlier sections. -% -% But no documentation, however -% thorough, can cover every question that comes up, and many can be -% answered quickly by consultation of the code. On a first reading, -% we suggest that you should read only the general documentation in +% +% You do not need to read the source code for this package in order to use it; we +% provide this code primarily for reference, and many of our +% comments on it repeat material that is also found in earlier sections. But no documentation, +% however thorough, can cover every question that comes up and many can be +% answered quickly by consulting the code. On a first reading, +% we suggest that you read only the general documentation in % sections~\ref{howto}, unless you are particularly interested in the innards of \macpackage. % % \subsection{History} @@ -458,12 +451,10 @@ % format for critical editions', \emph{TUGboat} \textit{11} (1990), % pp.\,623--643. % -% From 1991 through 1994, the macros continued -% to evolve, and were tested at a -% number of sites. We are very grateful to all the members of the -% (now defunct) +% From 1991 through 1994, the macros continued to evolve, and were tested at a +% number of sites. We are very grateful to all the members of the (now defunct) % \verb"edmac@mailbase.ac.uk" discussion group who helped us with -% smoothing out bugs and infelicities in the macros. +% smoothing out the bugs and infelicities in the macros. % Ron Whitney\index{Whitney, Ron} and our anonymous reviewer at % the TUG were both of great help in ironing out last-minute % wrinkles, while Ron made some important suggestions which may help @@ -478,14 +469,14 @@ % on is a \verb"DVI" post-processor which works with an \edmac{} % that has been slightly modified to output \protect\cs{special}s. This % combination enables you to recover to some extent the text of -% each line, as {\sc ascii} code, facilitating the creation of +% each line as {\sc ascii} code, facilitating the creation of % concordances, an {\em index verborum}, etc. % -% At the time of writing (1994), we are pleased to be able to say that \edmac{} is -% being used for real-life book production of several interesting +% As of 1994, we were pleased to be able to say that \edmac{} was +% being used for the real-life book production of several interesting % editions, such as the Latin texts of Euclid's {\sl % Elements},\footnote{Gerhard Brey\index{Brey, Gerhard} used \edmac{} in -% the production of Hubert L. L. Busard\index{Busard, Hubert L. L.} and +% the production of Hubert L.~L.\ Busard\index{Busard, Hubert L.~L.} and % Menso Folkerts,\index{Folkerts, Menso} {\em Robert of Chester's % (?)\index{Chester, Robert of} Redaction of Euclid's\index{Euclid} {\em % Elements}, the so-called Adelard II\index{Adelard II} Version}, 2 vols., @@ -499,7 +490,7 @@ % text,\footnote{Richard Lorch,\index{Lorch, Richard} Gerhard % Brey\index{Brey, Gerhard} {\em et al.}, at the same Institute.} a Latin % translation of part II of the Arabic {\em Algebra\/} by Ab\=u K\=amil -% Shuj\=a' b. Aslam,\index{Abu Kamil Shuja' b. Aslam}\footnote{Richard +% Shuj\=a' b.~Aslam,\index{Abu Kamil Shuja' b.~Aslam}\footnote{Richard % Lorch, `Ab\=u K\=amil on the Pentagon and Decagon' in {\em Vestigia % Mathematica}, ed.\ M. Folkerts and J. P. Hogendijk (Amsterdam, Atlanta: % Rodopi, 1993).} the Latin {\em Rithmachia\/} of Werinher von @@ -516,10 +507,9 @@ % produced, as was the previous book, by Gyula Mayer\index{Mayer, Gyula} % in Budapest.} the collected letters and papers of % Leibniz,\index{Leibniz}\footnote{Leibniz, {\em S\"amtliche Schriften und -% Briefe}, series {\sc I, III, VII,} being edited by Dr.\ H. -% Breger\index{Breger, Herbert}, Dr. N. G\"adeke\index{G\"adeke, Nora} and -% others, -% at the Leibniz-Archiv, Nieders\"achsische Landesbibliothek, Hannover. +% Briefe}, series {\sc I, III, VII,} being edited by Dr.\ H.\ +% Breger\index{Breger, Herbert}, Dr.~N. G\"adeke\index{G\"adeke, Nora} and +% others at the Leibniz-Archiv, Nieders\"achsische Landesbibliothek, Hannover. % (see \url{http://www.nlb-hannover.de/Leibniz})} % Theodosius's\index{Theodosius} {\em Spherics}, the German {\em % Algorismus} of Sacrobosco,\index{Sacrobosco} the Sanskrit text of the @@ -546,50 +536,45 @@ % the \tabmac{} functions were added; the starting point for these % being version 1.0 of Ocober 1996. The \edstanza{} (v0.01) functions were % added in February 2004. Sidenotes and regular footnotes in numbered -% text were added in April 2004. -% -% This port was called \ledmac (\LaTeX\ \edmac). +% text were added in April 2004. This port was called \ledmac (\LaTeX\ \edmac). % -% Since July~2011, ledmac is maintained by Ma\"ieul Rouquette. Is it more and more powerful and flexible, but also more and more divergent from original TeX macro. +% Since July~2011, ledmac is maintained by Ma\"ieul Rouquette. It is increasingly +% powerful and flexible, but it also has become increasingly divergent from the original TeX macro. % % \subsubsection{\eledmac} % Important changes were put in version 1.0, to make \ledmac more easily extensible (see \reff{displayoptions}). -% These changes can trigger small problems with the old customization. -% -% That is why a new name was selected: \eledmac (extended \ledmac). +% These changes can trigger small problems with the old customization. That is why a new name was selected: \eledmac (extended \ledmac). % % To migrate from \ledmac to \eledmac, please read \reff{migration}. % % \subsubsection{\reledmac} % -% \eledmac has facilitated the creation of customized critical edition. -% However, this was made in a non systematic way in method to customize them. -% -% In other side, many deprecated commands were keept, and many technical debt was accumulated, blocking the futur evolution. +% \eledmac has facilitated the creation of customized critical editions. +% However, the changes made to allow such customization were made in a non-systematic way. +% Many deprecated commands were kept and many technical `debts' were accumulated, +% hindering the future evolution of the package. % -% For all these reasons, Maïeul Rouquette decided to make a spring cleaning. -% As some commands name were changed, the ascendant compatibility was (a little) broken. +% For these reasons, Maïeul Rouquette decided on a spring cleaning of the code. +% As some commands name were changed, the resulting compatibility was broken (a little). % % A new name was selected: \reledmac (extended renewed \eledmac). - % To migrate from \eledmac to \reledmac, please read \reff{migratereledmac}. - +% % \subsection{List of works edited with (r)(e)ledmac} -% A collaborative list of works edited with (r)(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 (r)(e)ledmac. +% A collaborative list of works edited with (r)(e)ledmac is available at +% \url{https://www.zotero.org/groups/critical_editions_typeset_with_edmac_ledmac_and_eledmac/items}. +% Please add your own edition made with (r)(e)ledmac. % % \section{How the package works}\label{howto} -% -% -% The \macpackage package is a three-pass package like -% \LaTeX\ itself. +% The \macpackage package is a three-pass package like \LaTeX\ itself. % Although your textual apparatus and line -% numbers will be printed even on the first run, it takes two more -% passes through \LaTeX\ to be sure that everything gets to its right -% place. Any changes you make to the input file may similarly -% require three passes to get everything to the right place, if the -% changes alter the number of lines or notes. \Macpackage will tell -% you that you need to make more runs, when it notices, but it does -% not expend the labor to check this thoroughly. If you have +% numbers will be printed on the first run, it takes two more +% passes through \LaTeX\ to be sure that everything is correctly +% placed. If you make any subsequent changes altering the number +% of lines or notes, the input file may similarly +% require three passes to get everything to the right place. +% \Macpackage will tell you that you need to make more runs when it detects changes, +% but it does not expend the labor to check this thoroughly. If you have % problems with a line or two misnumbered at the top of a page, try % running \LaTeX\ once or twice more. % @@ -606,20 +591,23 @@ % % % \section{Options} -% The package can be loaded with a number of global options which are listed here. -% There are two types of options: options which provide specific features and option which optimize package's performance. -% It is advised to read the relevant parts of the handbook before reading the first type of option, but you can look at the second type in you first reading of handbook. +% The package can be loaded with a number of global options which are listed here. There are two types of options: +% 1) options which provide specific features, and, 2) options which optimize the package's performance. +% It is advisable for you to read the relevant parts of the handbook, before reading about the first type of option +% (specific features), but you can look at the second type (package optimization) in your first reading of the manual. +% % \subsection{Specific features} % \begin{description} % \item[draft] underlines lemmas in the main text. % \item[eledmac-compat] help to migrate from \eledmac to \reledmac (see \reff{eledmac-compat}). -% \item[nopbinverse] prevents page break inside verses. +% \item[nopbinverse] prevents page breaks 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[parapparatus] by default, the apparatus cannot contain paragraph breaks; this option enables paragraphing inside the apparatus. % \item[xindy] and \verb|xindy+hyperref| are for selecting \verb+xindy+ as the index processor (\reff{xindy}). -% \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 \parpackage. This is useful when alternating between normal and parallel typesetting. +% \item[widthliketwocolumns] set the width of the text printed in a single column to be the same as the width of the text printed in two parallel columns with \parpackage. This is useful when alternating between normal and parallel typesetting. % \end{description} -% \subsection{Optimize package's performance}\label{option:performance} +% +% \subsection{Optimizing package performance}\label{option:performance} % \begin{description} % \item[nocritical] disables tools for critical footnotes (\protect\cs{Afootnote}, \protect\cs{Bfootnote} etc.). If you do not need critical footnotes, this option lets \eledmac\ run faster. % It will also preserve room for other packages. @@ -628,18 +616,20 @@ % It will also preserve room for other packages. % \item[nofamiliar] disables tools for familiar footnotes (\protect\cs{footnoteA}, \protect\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] \macpackage allows to use of series of critical notes and 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 \macpackage faster. +% \item[noledgroup] \macpackage allows use of a series of critical notes and a 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 \macpackage faster. % \item[series] \Macpackage defines five levels of notes: A, B, C, D, E. % Using all these levels consumes memory space and processing speed. -% This is why, if your work does not require all of the A--E series, you can narrow down the available number of series. +% This is why, if your work does not require the entire A--E 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. % \end{description} +% % \section{Text lines and paragraphs numbering} +% % \subsection{Text lines numbering} % \DescribeMacro{\beginnumbering} % \DescribeMacro{\endnumbering} -% Each section of numbered text must be preceded by -% \protect\cs{beginnumbering} and followed by \protect\cs{endnumbering}, like this: \\ +% Each section of numbered text must be preceded by \protect\cs{beginnumbering} +% and followed by \protect\cs{endnumbering}, as in the following example. \\ % \egstart % \begin{verbatim} % \beginnumbering @@ -665,8 +655,7 @@ % that should be independently numbered, and these will be appropriate % places to begin new numbered sections. % -% \Macpackage has to read and store -% in memory +% \Macpackage has to read and store in memory % a certain amount of information about the entire section when it % encounters a \protect\cs{beginnumbering} command, so it speeds up the % processing and reduces memory use when a text is divided into a larger @@ -674,7 +663,7 @@ % external files that are generated). % % \subsection{Paragraphs} -% \subsubsection{Basis} +% \subsubsection{Basics} % \DescribeMacro{\pstart} % \DescribeMacro{\pend} % Within a numbered section, each paragraph of numbered text must @@ -691,7 +680,7 @@ % \protect\cs{pstart} and \protect\cs{pend} will not be numbered. % % The following example shows the proper section and paragraph -% markup, and the kind of output that would typically be generated: +% markup and the kind of output that would typically be generated: % \egstart % \begin{verbatim} % \beginnumbering @@ -716,7 +705,7 @@ % \end{verbatim} % \egend % -% \subsubsection{Producting automatically \protect\cs{pstart}\ldots{}\protect\cs{pend}} +% \subsubsection{Automatically producing \protect\cs{pstart} \ldots{} \protect\cs{pend}} % \DescribeMacro{\autopar}\label{autopar} % You can use \protect\cs{autopar} to avoid the nuisance of this paragraph markup % and still have every paragraph automatically numbered. The scope of the @@ -750,21 +739,23 @@ % % \subsubsection{Content before specific \protect\cs{pstart} and after specific \protect\cs{pend}}\label{pstart:optionalarg} % \changes{v1.12.0}{2014/08/05}{Optional arguments for \protect\cs{pstart} and \protect\cs{pend}.} -% Both \protect\cs{pstart} and \protect\cs{pend} can take a optional argument, in brackets. +% Both \protect\cs{pstart} and \protect\cs{pend} can take a optional argument in brackets. % Its content will be printed before the beginning of \protect\cs{pstart} / after the end of \protect\cs{pend} instead of the argument of \protect\cs{AtEveryPstart} / \protect\cs{AtEveryPend}. -% If you need to start a \protect\cs{pstart} by brackets, or to add brackets after a \protect\cs{pend}, just add a \protect\cs{relax} between \protect\cs{pstart}/\protect\cs{pend} and the brackets. +% If you need to start a \protect\cs{pstart} with brackets, or to add brackets after a \protect\cs{pend}, just add a \protect\cs{relax} between \protect\cs{pstart}\,\ldots\,\protect\cs{pend} and the brackets. % -% This feature is also useful when typesetting verses (see~\reff{verse}) or \parpackage\ (see~\reff{eledpar}). +% This feature is also useful when typesetting verses (see \reff{verse}) or \parpackage\ (see \reff{eledpar}). % % A \protect\cs{noindent} is automatically added before this argument. +% % \subsubsection{Content before every \protect\cs{pstart} and after every \protect\cs{pend}} % \changes{v1.15.0}{2015/01/12}{New commands \protect\cs{AtEveryPstart} and \protect\cs{AtEveryPend}.} % \label{AtEveryPstart} \DescribeMacro{\AtEveryPstart}\DescribeMacro{\AtEveryPend} % You can use both \protect\cs{AtEveryPstart} and \protect\cs{AtEveryPend}. % Their arguments will be printed before every \protect\cs{pstart} begins / after every \protect\cs{pend} ends. +% % \subsubsection{Numbering paragraphs (\protect\cs{pstart})} % \changes{v0.12.0}{2011/10/01}{Possibility to number \protect\cs{pstart}.} -% It is possible to insert a number at every \protect\cs{pstart} command. You must use the \DescribeMacro{\numberpstarttrue}\protect\cs{numberpstarttrue} command to have it. You can stop the numbering with \DescribeMacro{\numberpstartfalse}\protect\cs{numberpstartfalse}. +% It is possible to insert a number at every \protect\cs{pstart} command; you must use the \DescribeMacro{\numberpstarttrue}\protect\cs{numberpstarttrue} command to have it. You can stop the numbering with \DescribeMacro{\numberpstartfalse}\protect\cs{numberpstartfalse}. % You can redefine the command \DescribeMacro{\thepstart}\protect\cs{thepstart} to change style. % You can change the value of the pstart number by using \emph{after} \protect\cs{beginnumbering}: % \begin{verbatim} @@ -774,16 +765,19 @@ % \changes{v0.15.0}{2012/06/11}{Possibility to print \protect\cs{pstart} number inside.} % % \DescribeMacro{\sidepstartnumtrue} -% With the \protect\cs{sidepstartnumtrue} command, the number of \protect\cs{pstart} will be printed inside. In this case, the line number will be not printed. +% With the \protect\cs{sidepstartnumtrue} command, the number of \protect\cs{pstart} will be printed inside. +% In this case, the line number will be not printed. % % \changes{v1.1.0}{2012/09/25}{Add \protect\cs{labelpstarttrue}.} % \DescribeMacro{\labelpstarttrue} -% With the \protect\cs{labelpstarttrue} command, a \protect\cs{label} added just after a \protect\cs{pstart} will refer to the number of this pstart. +% With the \protect\cs{labelpstarttrue} command, a \protect\cs{label} added just after a \protect\cs{pstart} will refer to the number of this pstart. +% % \subsubsection{Languages written in Right to Left} -% If you use languages written in right to left, with \LuaLaTeX\ or \XeLaTeX, +% If you use languages written right to left with \LuaLaTeX\ or \XeLaTeX, % you must switch text direction \emph{before} the \protect\cs{pstart} command. +% % \subsubsection{Memory limits} -% \textbf{This paragraph is kept for history, but problem described below should not appear with recent version of \LaTeX.} +% \textbf{This paragraph is kept for history, but the problems described below should not appear with the most recent version of \LaTeX.} % % \label{pause} % \DescribeMacro{\pausenumbering} @@ -793,9 +787,9 @@ % at the end of such a section, it empties its memory out, so to % speak. If your text has a very long numbered section it is % possible that your \LaTeX\ may reach its memory limit. There are -% two solutions to this. -% The first is to get a larger \LaTeX\ with -% increased memory. +% two solutions to this. +% +% The first solution is to get a larger \LaTeX\ with increased memory. % % The second solution is to % split your long section into several smaller ones. The trouble @@ -820,35 +814,33 @@ % \endnumbering % \end{verbatim} % \egend - -% -% We have -% defined these commands as two macros, in case you find it necessary +% +% We have defined these commands as two macros, in case you find it necessary % to insert text between numbered sections without disturbing the % line numbering. But if you are really just using these macros to -% save memory, you might as well say +% save memory, you might as well type, % \egstart % \begin{verbatim} % \newcommand{\memorybreak}{\pausenumbering\resumenumbering} % \end{verbatim} -% and say \protect\cs{memorybreak} between the relevant \protect\cs{pend} and +% and type \protect\cs{memorybreak} between the relevant \protect\cs{pend} and % \protect\cs{pstart}. % \egend % % \subsection{Lineation commands} +% % \subsubsection{Disabling lineation} % \DescribeMacro{\numberlinefalse} \DescribeMacro{\numberlinetrue} % Line numbering can be disabled with \protect\cs{numberlinefalse}. It can be enabled again with \protect\cs{numberlinetrue}. +% % \subsubsection{Setting lineation start and step} % \DescribeMacro{\firstlinenum} % \DescribeMacro{\linenumincrement} -% By default, \macpackage numbers every 5th line. There are two counters, -% \verb?firstlinenum? and \verb?linenumincrement?, that control this -% behaviour; they can be changed using \protect\cs{firstlinenum}\marg{num} and +% By default, \macpackage numbers every 5th line. There are two counters that control this behaviour: +% \verb?firstlinenum? and \verb?linenumincrement?. They can be changed using \protect\cs{firstlinenum}\marg{num} and % \protect\cs{linenumincrement}\marg{num}. \protect\cs{firstlinenum} specifies the first % line that will have a printed number, and \protect\cs{linenumincrement} is -% the difference between succesive -% numbered lines. For example, to start printing numbers at the first line +% the difference between succesive numbered lines. For example, to start printing numbers at the first line % and to have every other line numbered: \\ % \verb?\firstlinenum{1} \linenumincrement{2}? % @@ -865,7 +857,7 @@ % no spaces within the definition which consists of comma-separated integer % numbers. The numbers can be in any order but it is easier to read if you % put them in numerical order. Either omitting the definition of -% \protect\cs{linenumberlist} or following the vacuous definition \\ +% \protect\cs{linenumberlist} or following the empty definition \\ % \verb?\def\linenumberlist{}? \\ % the standard numbering sequence is applied. The standard sequence % is that specified by the combination of the \verb+firstlinenum+, @@ -889,10 +881,9 @@ % \subsubsection{Setting line number margin} % \DescribeMacro{\linenummargin} % The command \protect\cs{linenummargin}\marg{location} specifies the margin -% where the line (or pstart) numbers will be printed. The permissable value -% for \meta{location} is one out of the list \texttt{left}, \texttt{right}, -% \texttt{inner}, or \texttt{outer}, -% for example \verb"\linenummargin{inner}". +% where the line (or pstart) numbers will be printed. The permissable values +% for \meta{location} are \texttt{left}, \texttt{right}, \texttt{inner}, or \texttt{outer}: +% for example, \verb"\linenummargin{inner}". % The package's default setting is \\ % \verb"\linenummargin{left}" \\ % to typeset the numbers in the left hand margin. @@ -900,21 +891,19 @@ % making a paragraph. % % More precisely, the value of -% \protect\cs{linenummargin} used is that in effect at the \protect\cs{pend} +% \protect\cs{linenummargin} used is the value in effect at the \protect\cs{pend} % of a numbered paragraph. Apart from an initial setting for -% \protect\cs{linenummargin}, only change it after a \protect\cs{pend}, whereupon -% it will apply to all following numbered paragraphs, until +% \protect\cs{linenummargin}, only change \protect\cs{linenummargin} after a \protect\cs{pend}, +% whereupon it will apply to all following numbered paragraphs, until % changed again (changing it between a \protect\cs{pstart} and \protect\cs{pend} -% pair will apply the change to all the current paragraph). -% +% pair will apply the change to all of the current paragraph). % % \subsubsection{Other settings} % % \DescribeMacro{\leftlinenum} % \DescribeMacro{\rightlinenum} % \DescribeMacro{\linenumsep} -% When a marginal line number is to be printed, there are a -% lot of ways to display it. +% When a marginal line number is to be printed, there are many ways to display it. % You can redefine \protect\cs{leftlinenum} and \protect\cs{rightlinenum} to % change the way marginal line numbers are printed in the % left and right margins respectively; the initial @@ -924,9 +913,9 @@ % % \subsection{Changing the line numbers} % -% Normally the line numbering starts at 1 for the first line of -% a section and steps up by one for each line thereafter. There -% are various common modifications of this system, however; the +% Normally, line numbering starts at 1 for the first line of +% a section and increments by one for each line thereafter. There +% are various common modifications of this system and the % commands described here allow you to put such modifications % into effect. % @@ -934,25 +923,22 @@ % \DescribeMacro{\startsub} % \DescribeMacro{\endsub} % You insert the \protect\cs{startsub} and \protect\cs{endsub} commands in your text -% to turn sub-lineation on and off. In plays, for -% example, stage directions are often numbered with sub-line -% numbers: as line $10.1$, $10.2$, -% $10.3$, rather than as $11$, $12$, and $13$. -% Titles and headings are sometimes numbered with sub-line numbers -% as well. +% to turn sub-lineation on and off. For example, stage directions in plays are often numbered with sub-line +% numbers: as line $10.1$, $10.2$, $10.3$, rather than as $11$, $12$, and $13$. +% Titles and headings are sometimes numbered with sub-line numbers as well. % % When sub-lineation is in effect, the line number counter is % frozen and the sub-line counter advances instead. If one of these % commands appears in the middle of a line, it doesn't take effect % until the next line; in other words, a line is counted as a line -% or sub-line depending on what it started out as, even if that +% or sub-line depending on what it started out as, even if it % changes in the middle. % % \subsubsection{Locking lineation} % \DescribeMacro{\startlock} % \DescribeMacro{\endlock} % The \protect\cs{startlock} command, used in running text, locks the -% line number at its current value, until you say \protect\cs{endlock}. +% line number at its current value, until you insert \protect\cs{endlock}. % It can tell for itself whether you are in a patch of line or % sub-line numbering. One use for line-number locking is in printing % poetry: there the line numbers should be those of verse lines @@ -964,9 +950,9 @@ % several printed lines may have the same line number, and you have to % specify whether you want the number attached to the first printed % line or the last, or whether you just want the number printed by -% them all. (This assumes that, on the basis of the settings of -% the previous parameters, it is necessary to display a line number for -% this line.) You specify your preference using \protect\cs{lockdisp}\marg{arg}; its +% them all, assuming that the settings of the previous parameters +% requires the display of a line number for this line. +% You specify your preference using \protect\cs{lockdisp}\marg{arg}; its % argument is a word, either \verb+first+, \verb+last+, or \verb+all+. % The package initially sets this as \protect\cs{lockdisp}\verb+{first}+. % @@ -1022,18 +1008,22 @@ % % \DescribeMacro{\hidenumbering} % \changes{v1.21.0}{2015/04/13}{Add \protect\cs{hidenumbering}} -% When inserted into a numbered line the macro \protect\cs{hidenumbering} causes +% When inserted into a numbered line, the macro \protect\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 \protect\cs{stanza}, you must call it at the beginning of the verse. +% % \subsubsection{Execute code at each line} -% \Macpackage provides to advanced feature for user. +% \Macpackage provides an advanced feature for users. % \DescribeMacro{\dolinehook}\DescribeMacro{\doinsidelinehook} % The argument passed to \protect\cs{dolinehook}\marg{arg} will be executed % before slicing a new line in the paragraph. % The argument passed to \protect\cs{doinsidelinehook}\marg{arg} will be executed before printing a new line. -% In many case, the latter is more useful than the first. -% The file \href{examples/2-line_numbers_in_header.tex}{examples/2-line\_numbers\_in\_header.tex} provides an example of use in order to print the first and last line number of a page in the header. +% In many cases, the latter is more useful than the former. +% The file \href{examples/2-line_numbers_in_header.tex}{examples/2-line\_numbers\_in\_header.tex} provides +% an example for printing the first and last line numbers of a page in the header. +% % \section{Apparatus commands} +% % \subsection{Terminology} % We call ``critical notes'' notes which refer to both a lemma, that is a part of text and a line number. % Critical notes are subdivided in critical footnotes and critical endnotes. @@ -1151,7 +1141,7 @@ % %\changes{v1.0.0}{2012/09/15}{Options nonum and nosep in \protect\cs{Xfootnote}.} %\changes{v1.20.0}{2015/03/22}{Options fulllines in \protect\cs{Xfootnote}.}\label{Xfootnoteopt} -%An optional argument can be added before the text of the footnote. Its value is a comma separated list of options. +% 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 \protect\cs{Xtwolines} and \protect\cs{Xmorethantwolines} features for this note (cf. \reff{Xtwolines}). @@ -1174,7 +1164,7 @@ % The mechanism is similar to the one for footnotes: each macro takes one or more optional arguments and one single argument, like:\\ % \protect\cs{Aendnote}\oarg{option}\marg{text}. % -% \meta{option} can contain a comma separated list of values. Allowed values are: +% \meta{option} can contain a comma-separated list of values. Allowed values are: % \begin{itemize} % \item \verb|fulllines| to disable \protect\cs{Xendtwolines} and \protect\cs{Xendmorethantwolines} features for this particular note (cf. \reff{Xtwolines}). % \item \verb+nonum+ to disable line number for this particular note. @@ -1218,12 +1208,14 @@ % \usepackage[parapparatus]{eledmac} % \end{verbatim} % +% Note that you \emph{cannot} use paragraphs (e.g. blank lines or \cs{par}) inside of notes, when they are set to \texttt{paragraph} arrangement! +% % \subsubsection{Change lemma and line number} % \DescribeMacro{\lemma} % \changes{v1.0.0}{2012/09/15}{\protect\cs{lemma} can contain commands.} % If you want to change the lemma that gets passed to the notes, you % can do this by using \protect\cs{lemma}\marg{alternative} within the -% second argument to \protect\cs{edtext}, before the note commands. +% second argument to \protect\cs{edtext} and before the note commands. % The most common use of this command is to abbreviate the lemma that's % printed in the notes. For example: % \egstart @@ -1294,10 +1286,9 @@ % widely divergent notions of what sort of notes are required, where % they should be printed, and what they should be called. But this % does not mean you have to type \protect\cs{Afootnote} when you would rather -% say something you find more meaningful, like \protect\cs{variant}. +% type something you find more meaningful, like \protect\cs{variant}. % -% We -% recommend that you create a series of such aliases and use them +% We recommend that you create a series of such aliases and use them % instead of the names chosen here; all you have to do is put commands % of this form at the start of your file:\footnote{We use \protect\cs{newcommand} and \protect\cs{newcommandx} instead of classical \protect\cs{let} command because the edtabular environments have to modify the notes definition, and we need to use the newest definition of notes. Read the handbook of \protect\package{xargs} to know more about \protect\cs{newcommandx}.} % \begin{verbatim} @@ -1311,7 +1302,7 @@ % \subsection{Disambiguation of identical words in the apparatus} % \changes{v1.15.0}{2015/01/12}{New tools to prevent ambiguous references in lemma} % \changes{v1.23.0}{2015/05/18}{Fix bug with \protect\cs{sameword} when the same lemma is used for multiple notes or for nested \protect\cs{edtext}s.} -% \changes{v1.23.0}{2015/05/18}{Optional argument of \protect\cs{sameword} can be a comma separated list of \protect\cs{edtext} depth.} +% \changes{v1.23.0}{2015/05/18}{Optional argument of \protect\cs{sameword} can be a comma-separated list of \protect\cs{edtext} depth.} % \changes{v1.23.0}{2015/05/18}{Fix bug with \protect\cs{sameword} when the lemma overlaps multiple line.} % Sometimes, the same word occurs twice (or more) in the same line. % \Macpackage provides tools to disambiguate references in the critical notes. @@ -1359,7 +1350,7 @@ % \end{verbatim} % \Macpackage\ cannot know if the ``sw'' in \protect\cs{lemma} refers to the word after ``thing'', after ``other'', or after ``again''. % -% Consequently, you have to tell to \macpackage which instance of \protect\cs{sameword} in the first argument of \protect\cs{edtext} you want to reference: +% Consequently, you must tell \macpackage to which instance of \protect\cs{sameword} you are referring in the first argument of \protect\cs{edtext}: % \begin{itemize} % \item In the content of \protect\cs{lemma}, use \protect\cs{sameword} with no optional argument. % \item In the first argument of \protect\cs{edtext}, use \protect\cs{sameword} with the optional argument \oarg{X}. \meta{X} is the depth of the \protect\cs{edtext} where the \protect\cs{lemma} is used. @@ -1376,9 +1367,13 @@ % it is all}% % }{\lemma{some \sameword{word} \ldots all}\Afootnote{critical note}}.% % \end{verbatim} -% Here the \protect\cs{sameword} occurs in an \protect\cs{edtext} of level 2, but since it is referenced by \protect\cs{lemma} on level 1, it has ``1'' in the optional argument. - -% In the following example figure, each framed box represents an \protect\cs{edtext} level. Each number is an occurrence of \protect\cs{sameword}. After a framed box, the text in superscript represents the content of \protect\cs{lemma} for that \protect\cs{edtext} level. The text in subscript at the right of a number represents the content of the optional argument of \protect\cs{sameword}. +% Here the \protect\cs{sameword} occurs in an \protect\cs{edtext} of level 2, +% but since it is referenced by \protect\cs{lemma} on level 1, it has ``1'' in the optional argument. +% +% In the following example figure, each framed box represents an \protect\cs{edtext} level. +% Each number is an occurrence of \protect\cs{sameword}. After a framed box, +% the text in superscript represents the content of \protect\cs{lemma} for that \protect\cs{edtext} level. +% The text in subscript at the right of a number represents the content of the optional argument of \protect\cs{sameword}. % %\fbox{% % \fbox{% @@ -1465,8 +1460,8 @@ % \subsection{Changing series} % \subsubsection{Create a new series}\label{newseries} % -% If you need more than five series of critical footnotes you can -% create extra series, using \protect\cs{newseries} command. For example to create F and G series \protect\cs{newseries}\verb+{G,H}+. +% If you need more than five series of critical footnotes, you can +% create extra series, using \protect\cs{newseries} command. For example, to create F and G series \protect\cs{newseries}\verb+{G,H}+. % % \subsubsection{Delete series} % As the number of series which are defined increases, \macpackage gets slower. @@ -1498,9 +1493,17 @@ % \section{Critical apparatus appearance} % \label{displayoptions} % \changes{v1.0.0}{2012/09/15}{New generic commands to customize footnote display.} -% 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. If the optional argument is omitted or empty, the setting will concern all series. +% 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. +% If the optional argument is omitted or empty, the setting will apply to the entire series. +% +% When a length (\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$ units. +% If you use some relative unit\footnote{Like \verb|em|, which is the width of an `m' in a given font.}, +% it will be relative to the font size of the footnote, except for commands concerning the place kept by the notes, including blank spaces. % -% 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 unit\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. +% 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 unit\footnote{Like \verb|em| which is the width of an `m' in a given font.}, it will be relative to font size of the footnote, except for commands concerning the place kept by the notes --- including blank space. % % There is also name convention: % \begin{itemize} @@ -1508,6 +1511,7 @@ % \item Names prefixed by \verb+Xend+ are for setting of critical endnotes. % \item Names suffixed by \verb+X+ are for setting of familiar footnotes. % \end{itemize} +% % \subsection{Notes arrangement in a series}\label{arrangement} % % \DescribeMacro{\Xarrangement} @@ -1521,7 +1525,8 @@ % The value of \meta{a} can be one of the following % \begin{itemize} % \item \verb+paragraph+ formats -% all the footnotes of a series as a single paragraph; +% all the footnotes of a series as a single paragraph. If you use this arrangement, you are strongly encouraged to read \reff{paragraphednotes:advanced}. + % \item \verb+twocol+ formats them as separate paragraphs, % but in two columns; % \item \verb+threecol+, in three columns. @@ -1533,17 +1538,16 @@ % macro because its action depends on these; % too much or too little space will be allotted for the notes on % the page if these macros use the wrong -% values.\footnote{\phantomsection\label{nobreaks}There -% is one tiny proviso about using paragraphed notes: you should not -% force any explicit line-breaks inside such notes: do not use -% {\tt \bslash par}, -% {\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. \reff{nobreak} explains why this restriction -% is necessary.} -% -% The notes arrangement must be called after having defined the document geometry setting. If you must change geometry setting inside your document, do not forget to call again note arrangement. +% values. +% +% Note that you \emph{cannot} use paragraphs (e.g. blank lines or +% \cs{par}) or line breaks (\cs{break} or \cs{linebreak} or \cs{newline} etc.) +% inside of notes, when they are +% set to \texttt{paragraph} arrangement!\footnote{See \reff{nobreak} for +% further information.} +% +% The notes arrangement must be called after having defined the document geometry setting. +% If you must change geometry setting inside your document, do not forget to call note arrangement again. % % \protect\cs{hsize} has been set for the pages that use % this series of notes; otherwise \TeX\ will try to put too @@ -1555,18 +1559,20 @@ % \subsubsection{Print line number only at first time} % \DescribeMacro{\Xnumberonlyfirstinline} % \changes{v1.0.1}{2012/09/16}{Correction on \protect\cs{Xnumberonlyfirstinline} 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 given line number (i.e. one time for line 1, one time for line 2 etc.), you can use \protect\cs{Xnumberonlyfirstinline}\oarg{s}. +% 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 \protect\cs{Xnumberonlyfirstinline}\oarg{s}. % -% Use \protect\cs{Xnumberonlyfirstinline}\oarg{s}\verb+[false]+ to disable this (\meta{s} can be empty if you want to disable it for every series). +% Use \protect\cs{Xnumberonlyfirstinline}\oarg{s}\verb+[false]+ to disable this. \meta{s} can be empty if you want to disable it for every series. % % \DescribeMacro{\Xnumberonlyfirstintwolines} % \changes{v1.1.0}{2012/09/25}{Add \protect\cs{Xnumberonlyfirstintwolines}} % Suppose you have a lemma on line~2 and a lemma between line~2 and line~3. % With \protect\cs{Xnumberonlyfirstinline}, the second lemma is considered to be on the same line as the first lemma. -% But if you use both \protect\cs{Xnumberonlyfirstinline}\oarg{s} and \protect\cs{Xnumberonlyfirstintwolines}\oarg{s}, the distinction is made. -% Use the command \linebreak\protect\cs{Xnumberonlyfirstintwolines}\oarg{s}\verb+[false]+ to disable this (\meta{s} can be empty if you want to disable it for every series). +% But if you use both \protect\cs{Xnumberonlyfirstinline}\oarg{s} and \protect\cs{Xnumberonlyfirstintwolines}\oarg{s}, a distinction is made. +% Use the command \linebreak\protect\cs{Xnumberonlyfirstintwolines}\oarg{s}\verb+[false]+\\ +% to disable this. \meta{s} can be empty if you want to disable it for every series. % \DescribeMacro{\Xsymlinenum} -% For setting a particular symbol in place of the line number, you can use \protect\cs{Xsymlinenum}\oarg{s}\marg{symbol} in combination with \protect\cs{Xnumberonlyfirstinline}\oarg{s}. From the second lemma of the same line, the symbol will be used instead of the line number. Note that any command called in \meta{symbol} must be robust. Use \protect\cs{robustify} to robustify a not robust command. +% For setting a particular symbol in place of the line number, you can use \protect\cs{Xsymlinenum}\oarg{s}\marg{symbol} in combination with \protect\cs{Xnumberonlyfirstinline}\oarg{s}. From the second lemma of the same line, the symbol will be used instead of the line number. Note that any command called in \meta{symbol} must be robust. Use \protect\cs{robustify} to robustify a non-robust command. % % \subsubsection{Abbreviate line range} % \changes{v1.20.0}{2015/03/22}{Add \protect\cs{Xtwolines} and \protect\cs{Xmorethantwolines} hooks} @@ -1582,9 +1588,10 @@ % \Xtwolines{sq.} % \Xmorethantwolines{sqq.} % \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. +% 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 \protect\cs{Xtwolines} without setting \protect\cs{Xmorethantwolines}, the \meta{text} argument of \protect\cs{Xtwolines} will be used for lemmas which fall on three or more lines. +% If you use \protect\cs{Xtwolines} without setting \protect\cs{Xmorethantwolines}, the \meta{text} argument +% of \protect\cs{Xtwolines} 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 \protect\cs{Xtwolinesbutnotmore}\oarg{series}. % @@ -1603,21 +1610,23 @@ % % \label{Xendtwolines}\changes{v1.21.0}{2015/04/13}{Add \protect\cs{Xendtwolines}, \protect\cs{Xendmorethantwolines}, \protect\cs{Xendtwolinesbutnotmore} and \protect\cs{Xendtwolinesonlyinsamepage}.} % \DescribeMacro{\Xendtwolines}\DescribeMacro{\Xendmorethantwolines}\DescribeMacro{\Xendtwolinesbutnotmore} -% For endnotes, use the macros \protect\cs{Xendtwolines}; \protect\cs{Xendmorethantwolines}; \linebreak \protect\cs{Xendtwolinesbutnotmore}; \protect\cs{Xendtwolinesonlyinsamepage} instead of \protect\cs{Xtwolines}; \protect\cs{Xmorethantwolines}; \protect\cs{Xtwolinesbutnotmore}; \protect\cs{Xtwolinesonlyinsamepage}. -% +% For endnotes, use these macros: +% \protect\cs{Xendtwolines}; \protect\cs{Xendmorethantwolines}; \linebreak \protect\cs{Xendtwolinesbutnotmore};\\ +% \protect\cs{Xendtwolinesonlyinsamepage} instead of \protect\cs{Xtwolines}; \protect\cs{Xmorethantwolines};\\ +% \protect\cs{Xtwolinesbutnotmore}; \protect\cs{Xtwolinesonlyinsamepage}. % - % \subsubsection{Disable line number} % \DescribeMacro{\Xnonumber} % You can use \protect\cs{Xnonumber}\oarg{s} if you do not want to have the line number in a footnote. To cancel it, use \protect\cs{Xnonumber}\oarg{s}\verb+[false]+. % \DescribeMacro{\Xendnonumber} \protect\cs{Xendnonumber}\oarg{s} is the same for endnote. +% % \subsubsection{Printing pstart number} % \changes{v1.1.0}{2012/09/25}{Add \protect\cs{Xpstart} and \protect\cs{Xonlypstart}} % \changes{v1.18.0}{2015/02/23}{Add \protect\cs{Xpstarteverytime}} % \changes{v1.18.0}{2015/02/23}{Debug \protect\cs{Xonlypstart} when using \protect\cs{Xnumberonlyfirstinline} and the current line number differs from the previous.} % \DescribeMacro{\Xpstart} % You can use \protect\cs{Xpstart}\oarg{s} if you want to print the pstart number in the footnote, before the line and subline number. -% Use \protect\cs{Xpstart}\oarg{s}\verb+[false]+ to disable this (\meta{s} can be empty if you want to disable it for every series). +% Use \protect\cs{Xpstart}\oarg{s}\verb+[false]+ to disable this. \meta{s} can be empty if you want to disable it for every series. % Note that when you change the lineation system, the option is automatically switched : % \begin{itemize} % \item If you use lineation by pstart, the option is enabled. @@ -1632,12 +1641,13 @@ % % \DescribeMacro{\Xonlypstart} % In combination with \protect\cs{Xpstart}, you can use \protect\cs{Xonlypstart}\oarg{s} if you want to print only the pstart number in the footnote, and not the line and subline number. -% Use \protect\cs{Xonlypstart}\oarg{s}\verb+[false]+ disable this it (\meta{s} can be empty if you want to disable it for every series). +% Use \protect\cs{Xonlypstart}\oarg{s}\verb+[false]+ disable this. \meta{s} can be empty, if you want to disable it for every series. +% % \subsubsection{Printing stanza number} % % \DescribeMacro{\Xstanza}\label{Xstanza} % You can use \cs{Xstanza}\oarg{s} if you want to print the stanza number in the footnote, before the line and subline number. -% Use \cs{Xstanza}\oarg{s}\verb+[false]+ to disable this (\meta{s} can be empty if you want to disable it for every series). +% Use \cs{Xstanza}\oarg{s}\verb+[false]+ to disable this. \meta{s} can be empty if you want to disable it for every series. % % Of course the stanza number is printed only when you use \cs{numberstanza} % @@ -1655,7 +1665,9 @@ % %\changes{v1.4.3}{2012/12/18}{Add \protect\cs{Xnonbreakableafternumber}.} %\DescribeMacro{\Xnonbreakableafternumber} -% By default, the space defined by \protect\cs{Xafternumber} is breakable. With \protect\cs{Xnonbreakableafternumber}\oarg{s} it becomes nonbreakable. Use \protect\cs{Xnonbreakableafternumber}\oarg{s}\verb+[false]+ to disable this (\meta{s} can be empty if you want to disable it for every series). +% By default, the space defined by \protect\cs{Xafternumber} is breakable. +% With \protect\cs{Xnonbreakableafternumber}\oarg{s} it becomes nonbreakable. +% Use \protect\cs{Xnonbreakableafternumber}\oarg{s}\verb+[false]+ to disable this. \meta{s} can be empty if you want to disable it for every series. % % \subsubsection{Space around line symbol} % \DescribeMacro{\Xbeforesymlinenum} @@ -1805,7 +1817,7 @@ % % \subsection{Arbitrary code at the beginning of notes} % \changes{v1.1.0}{2012/09/25}{New hook to add arbitrary code at the beginning of the notes} -% The three next commands add an arbitrary code at the beginning of notes. +% The three next commands add arbitrary code at the beginning of notes. % As the name's space is local to the notes, you can use it to redefine some style inside the notes. % For example, if you don't want the pstart number to be in bold, use : % \begin{verbatim} @@ -1824,12 +1836,14 @@ % \protect\cs{Xendbhooknote}\oarg{s}\marg{code} is to be used at the beginning of the endnotes. % % \subsection{Options for footnotes in columns} +% % \subsubsection{Alignment} % \DescribeMacro{\Xcolalign} % \DescribeMacro{\colalignX} % \changes{v1.21.0}{2015/04/13}{Add \protect\cs{Xcolalign} and \protect\cs{colalignX} hooks} -% By default, texts in footnotes in two or three columns are flushed left without hyphenation. -% However, you can change this with \protect\cs{Xcolalign}\oarg{s}\marg{code}, for critical footnotes, and \protect\cs{colalignX}\oarg{s}\marg{code}, for familiar footnotes. +% By default, text in footnotes of two or three columns are flush left and without hyphenation. +% However, you can change this with \protect\cs{Xcolalign}\oarg{s}\marg{code} for critical footnotes, +% and \protect\cs{colalignX}\oarg{s}\marg{code} for familiar footnotes. % % \verb+<code>+ must be one of the following command: % \begin{description} @@ -1852,7 +1866,7 @@ % \protect\cs{Xhsizethreecol}\oarg{s}\marg{l} is used to change width of a column when critical notes are displaying in three columns. Defaut value is \verb+.3 \hsize+. % % \DescribeMacro{\hsizetwocolX} -% \protect\cs{hsizetwocol}\oarg{s}\marg{l} is used to change width of a column when familiar notes are displaying in two columns. Defaut value is \verb+.45 \hsize+. +% \protect\cs{hsizetwocolX}\oarg{s}\marg{l} is used to change width of a column when familiar notes are displaying in two columns. Defaut value is \verb+.45 \hsize+. % % \DescribeMacro{\hsizethreecolX} % \protect\cs{hsizethreecolX}\oarg{s}\marg{l} is used to change width of a column when familiar notes are displaying in three columns. Defaut value is \verb+.3 \hsize+. @@ -1868,26 +1882,28 @@ % % Note that if the symbol defined by \protect\cs{Xsymlinenum} must be used at the beginning of a note, the \protect\cs{Xparafootsep} / \protect\cs{parafootsepX} is not used before this note. % -% \subsubsection{Ragging} +% \subsubsection{Ragged text} % \changes{v1.12.0}{2014/08/05}{New options for ragged-paragraph notes} % \DescribeMacro{\Xragged} -% Text in paragraphed critical notes is justified, but you can use \protect\cs{Xragged}\oarg{s}\arg{L} if you want it to be ragged left, or \protect\cs{Xragged}\oarg{s}\arg{R} if you want it to be ragged right. - +% Text in paragraphed critical notes is justified, but you can use \protect\cs{Xragged}\oarg{s}\arg{L} if you want it to be ragged left (i.e., right justified), +% or \protect\cs{Xragged}\oarg{s}\arg{R} if you want it to be ragged right (i.e., left justified). +% % \DescribeMacro{\raggedX} % Text in paragraphed footnotes is justified, but you can use \protect\cs{raggedX}\oarg{s}\arg{L} if you want it to be ragged left, or \protect\cs{raggedX}\oarg{s}\arg{R} if you want it to be ragged right. % % \subsection{Options for block of notes} +% % \subsubsection{Text before notes} % \changes{v1.1.0}{2012/09/12}{New options for block of notes.} % \DescribeMacro{\Xtxtbeforenotes} -% You can add some text before critical notes with \protect\cs{Xtxtbeforenotes}\oarg{s}\marg{text}. +% You can add text before critical notes with \protect\cs{Xtxtbeforenotes}\oarg{s}\marg{text}. % % \subsubsection{Spacing} % \DescribeMacro{\Xbeforenotes} -% You can change the vertical space printed before the rule of the critical notes with \protect\cs{Xbeforenotes}\oarg{s}\marg{l}. +% You can change the vertical space before the rule of the critical notes with \protect\cs{Xbeforenotes}\oarg{s}\marg{l}. % The default value is \verb|1.2em plus .6em minus .6em|. % -% \textbf{Be careful, the standard \LaTeX\ footnote rule, which is used by \macpackage, decreases by 3pt. This 3pt decrease is not changed by this command..} +% \textbf{Be careful, the standard \LaTeX\ footnote rule used by \macpackage decreases by 3pt. This 3pt decrease is not changed by this command.} % % \DescribeMacro{\beforenotesX} % You can change the vertical space printed before the rule of the familiar notes with \protect\cs{beforenotesX}\oarg{s}\marg{l}. @@ -1897,19 +1913,15 @@ % % \DescribeMacro{\preXnotes} % You can set the space before the first series of critical notes printed on each page -% and set a different amount of space for subsequent the series on the page. -% You can do it with \protect\cs{preXnotes}\marg{l}. Default value is \verb+0pt+. +% and set a different amount of space for each subsequent series on the page. +% You can do it with \protect\cs{preXnotes}\marg{l}. The default value is \verb+0pt+. % You can disable this feature by setting the length to 0pt. % -% -% % \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+. -% You can do it with \protect\cs{prenotesX}\marg{l}. -% You can disable this feature by setting the length to 0pt. -% -% -% +% You can set the space before the first printed (in a page) series of familiar notes to be different from the space before other series. +% The default value is \verb+0pt+. +% You can do this with \protect\cs{prenotesX}\marg{l}. You can disable this feature by setting the length to 0pt. +% % \subsubsection{Rule} % \changes{v1.12.0}{2014/08/05}{New hooks: \protect\cs{Xafterrule} and \protect\cs{afterruleX}} % \DescribeMacro{\Xafterrule} @@ -1928,7 +1940,7 @@ % % \subsubsection{Maximum height} % \DescribeMacro{\Xmaxhnotes}\label{Xmaxhnotes} -% By default, one series of critical notes can take 80\% of the page size, before being broken to the next page. +% By default, one series of critical notes can take up to 80\% of \cs{vsize}, before being broken to the next page. % If you want to change the size use \protect\cs{Xmaxhnotes}\oarg{s}\marg{l}. % Be careful : the length can't be flexible, and is relative to the the current font. % For example, if you want the note to take, at most, 33\% of the text height, do \verb|\Xmaxhnotes{.33\textheight}|. @@ -1936,9 +1948,16 @@ % \DescribeMacro{\maxhnotesX} % \protect\cs{maxhnotesX}\oarg{s}\marg{l} is the same as previous, but for familiar footnotes. % +% Note that in many cases, you should call these commands, because the \cs{vsize} in the preamble is not the same as \cs{vsize} after the preamble. +% That why we recommend to you to add in your preamble +% \begin{verbatim} +% \maxhnotesX{0.8\textheight} +% \Xmaxhnotes{0.8\textheight} +% \end{verbatim} +% % Be careful with the two previous commands. % Actually, for technical purposes, one paragraphed note is considered as one block. -% Consequently, it can not be broken between two pages, even if you used these commands. +% Consequently, it cannot be broken between two pages, even if you used these commands. % The debug is in the todolist. % \subsection{Footnotes and the \parpackage columns} % \changes{v1.13.0}{2014/09/16}{Add \protect\cs{Xnoteswidthliketwocolumns} and \protect\cs{noteswidthliketwocolumnsX}} @@ -2095,7 +2114,7 @@ % % \subsection{Repeating stanza indents} %\changes{v0.13.0}{2011/11/08}{New stanzaindentsrepetition counter to repeat stanza indents every \emph{n} verses.} -% \label{stanzaindentsrepetition}Since version 0.13, if the indentation is repeated every \emph{n} verses of the stanza, you can define only the \emph{n} first indentations, and say they are repeated, defining the value of the \verb+stanzaindentsrepetition+ counter at \emph{n}. For example: +% \label{stanzaindentsrepetition}Since version 0.13, if the indentation is repeated every \emph{n} verses of the stanza, you can define only the \emph{n} first indentations, and indicate that they are repeated, defining the value of the \verb+stanzaindentsrepetition+ counter at \emph{n}. For example: %\begin{verbatim} %\setstanzaindents{5,1,0} %\setcounter{stanzaindentsrepetition}{2} @@ -2159,7 +2178,7 @@ % between penalties and \emph{glue}, so it may take some adjustment of skips % and penalties to achieve the best results. % \subsection{Hanging symbol} -% It is possible to insert a symbol in each line of hanging verse, as in French typography for example the opening bracket [. To insert it in \macpackage, use macro \DescribeMacro{\sethangingsymbol}\protect\cs{sethangingsymbol}\marg{h} with this code. +% It is possible to insert a symbol in each line of hanging verse, as in French typography; for example, the opening bracket `['. To insert it in \macpackage, use macro \DescribeMacro{\sethangingsymbol}\protect\cs{sethangingsymbol}\marg{h} with this code. % In the example of French typography, do % \begin{verbatim} % \sethangingsymbol{[\,} @@ -2278,7 +2297,7 @@ % First you place a label in the text using the command % \protect\cs{edlabel}\marg{lab}. \meta{lab} can be almost anything you like, including % letters, numbers, punctuation, or a combination---anything but spaces; -% you might say \protect\cs{edlabel}\verb+{toves-3}+, for example.\footnote{More precisely, +% you might type \protect\cs{edlabel}\verb+{toves-3}+, for example.\footnote{More precisely, % you should stick to characters in the \TeX\ categories of ``letter'' % and ``other''.} % @@ -2303,7 +2322,7 @@ % your document through \LaTeX\ twice in order for the references to % be resolved. % -% You will be warned if you say \verb"\edlabel{foo}" and \verb"foo" +% You will be warned if you use \verb"\edlabel{foo}" and \verb"foo" % has been used as a label before. The \verb"ref" commands will % return references to the last place in the file marked with this % label. You will also be warned if a reference is made to an @@ -2384,9 +2403,8 @@ % cases, you can use the \protect\cs{edmakelabel}\marg{lab}\marg{numbers} % macro so that you can `roll your own' label. % -% For example, if you say `\verb"\edmakelabel{elephant}{10|25|0}"' -% you will create a new -% label, and a later call to \verb"\edpageref{elephant}" would print +% For example, if you type `\verb"\edmakelabel{elephant}{10|25|0}"' +% you will create a new label, and a later call to \verb"\edpageref{elephant}" would print % `10' and \verb"\lineref{elephant}" would print `25'. The sub-line % number here is zero. It is usually best to collect your % \protect\cs{edmakelabel} statements near the top of your document, so that @@ -2466,8 +2484,8 @@ % % \section{Side notes} % -% \subsection{Basis} -% The \protect\cs{marginpar} command does not work in numbered text. Instead +% \subsection{Basics} +% The \protect\cs{marginpar} command does not work in numbered text. Instead, % the package provides for non-floating sidenotes in either margin. % % \DescribeMacro{\ledinnernote} @@ -2491,14 +2509,15 @@ % is \\ % \verb?\sidenotemargin{right}? \\ % to typeset \protect\cs{ledsidenote}s in the right hand margin. -% This is the opposite -% to the default margin for line numbers. The style for a \protect\cs{ledsidenote} +% This is the opposite of the default margin for line numbers. The style for a \protect\cs{ledsidenote} % follows that for a \protect\cs{ledleftnote} or a \protect\cs{ledrightnote} depending % on the margin it is put in. % % If two note commands for the same side are called in the same line, they will % be appended and separated by a comma. +% % \subsection{Setting} +% % \subsubsection{Width} % \DescribeMacro{\ledlsnotewidth} % \DescribeMacro{\ledrsnotewidth} @@ -2533,8 +2552,10 @@ % \DescribeMacro{\setsidenotesep} % If you have two or more sidenotes for the same line, they are separated by a comma. % But if you want to change this separator, you can use \protect\cs{setsidenotesep}\marg{sep}. +% % \section{Indexing} -% \subsection{Basis} +% +% \subsection{Basics} % \DescribeMacro{\edindex} % \LaTeX\ provides the |\index|\marg{item} command for specifying that \meta{item} % and the current page number should be added to the raw index (\file{idx}) file. @@ -2543,7 +2564,7 @@ % the raw index file. % % Note that the file \verb+.idx+ will contain the right reference only after the third run, because of the internal indexing mechanism of \protect\package{eledmac}. -% That means you must first run three times (Xe/Lua)\LaTeX, then run \verb+makeindex+ and finally run again (Xe/Lua)\LaTeX\ to get an index with the right page numbers. +% That means you must first run (Xe/Lua)\LaTeX three times, then run \verb+makeindex+, and then finally run (Xe/Lua)\LaTeX\ again, in order to get an index with the right page numbers. % % If the \protect\package{imakeidx} or \protect\package{indextools} package is used then the macro takes an optional % argument, which is the name of a raw index file. For example @@ -2556,7 +2577,7 @@ % \begin{enumerate} % \item Load \package{imakeidx} or \package{indextools} . % \item Load \macpackage. -% \item Declare the index with the macro \cs{makeindex} of \package{imakeidx}/\package{indextools}. +% \item Declare the index with the macro \cs{makeindex} of \package{imakeidx} and \package{indextools}. % \end{enumerate} % \subsection{Separator between page and line numbers} % \DescribeMacro{\pagelinesep} @@ -2602,11 +2623,11 @@ % \item Use \verb|xindy+hyperref| option when loading the \macpackage package. % When you run (Xe/Lua)\LaTeX with this option, a \verb+.xdy+ configuration file will be generated with all the settings needed to allow internal hyperlinking in each index entry which is created by \protect\cs{edindex}. % \item Use \verb+hyperindex=false+ option when loading hyperref. -% \item Uncomment --- by removing the semicolons at the beginning of the relevant lines --- some lines in the <code>.xdy</code> file provided in the ``\href{examples/.}{examples}'' folder in order to restore internal links in the index to be used by the standard \verb+index+ command.\footnote{These are the recommended lines to provide the best possible compatibility between hyperref and xindy, even without using \macpackage.}. +% \item Uncomment\,---\,by removing the semicolons at the beginning of the relevant lines\,---\,some lines in the <code>.xdy</code> file provided in the ``\href{examples/.}{examples}'' folder in order to restore internal links in the index to be used by the standard \verb+index+ command.\footnote{These are the recommended lines to provide the best possible compatibility between hyperref and xindy, even without using \macpackage.}. % \end{enumerate} % \subsection{Advanced setting} % \DescribeMacro{\edindexlab} -% The \protect\cs{edindex} process uses a \protect\cs{label}/\protect\cs{ref} mechanism to get +% The \protect\cs{edindex} process uses a \protect\cs{label} and \protect\cs{ref} mechanism to get % the correct line number. It automatically generates labels % of the form \protect\cs{label}\verb|{\edindexlab N}|, where N is a number, and % the default definition of \protect\cs{edindexlab} is: \\ @@ -2894,22 +2915,22 @@ % Pstart content. % \pend % \end{verbatim} -% The line which contains them will not been numbered, and you can not add critical notes inside. +% The line which contains them will not be numbered, and you cannot add critical notes inside. % \subsection{Sectioning commands with line numbering and critical notes} % \label{eledsection} % You have to use the following commands: % \begin{itemize} -% \item \protect\cs{eledchapter}\oarg{text}\marg{critical text} -% \item \protect\cs{eledchapter*} -% \item \protect\cs{eledsection}\oarg{text}\marg{critical text} -% \item \protect\cs{eledsection*} -% \item \protect\cs{eledsubsection}\oarg{text}\marg{critical text} -% \item \protect\cs{eledsubsection*} -% \item \protect\cs{eledsubsubsection}\oarg{text}\marg{critical text} -% \item \protect\cs{eledsubsubsection*} +% \item \protect\cs{eledchapter}\oarg{text}\marg{critical text}, +% \item \protect\cs{eledchapter*}, +% \item \protect\cs{eledsection}\oarg{text}\marg{critical text}, +% \item \protect\cs{eledsection*}, +% \item \protect\cs{eledsubsection}\oarg{text}\marg{critical text}, +% \item \protect\cs{eledsubsection*}, +% \item \protect\cs{eledsubsubsection}\oarg{text}\marg{critical text}, +% \item \protect\cs{eledsubsubsection*}. % \end{itemize} -% Which are equivalent to the \LaTeX\ commands. -% Each individual command must be called alone in a \protect\cs{pstart}\ldots\protect\cs{pend}: +% These are equivalent to the \LaTeX\ commands. +% Each individual command must be called alone in a \protect\cs{pstart}\,\ldots\,\protect\cs{pend}: % \begin{verbatim} %\pstart %\eledsection*{xxxx\ledsidenote{section}} @@ -2921,31 +2942,34 @@ %normal text %\pend % \end{verbatim} -% At the first run, you will see only the text. It is normal. -% At the second run, you will see the formating. -% And consequently, at the third run, you will see the table of contents. +% After the first run, you will see only the text. This is normal. +% After the second run, you will see the formatting. +% Finally, with the third run, you will see the table of contents. % -% For technical reasons, the page break before \protect\cs{elechapter} ca not be added automatically. You have to insert it manually via \protect\cs{beforeeledchapter}, which must be called outside of a numbered section. +% For technical reasons, the page break before \protect\cs{elechapter} cannot be added automatically. +% You have to insert it manually via \protect\cs{beforeeledchapter}, which must be called outside of a numbered section. % % \subsection{Optimization} % \DescribeMacro{\noeledsec} % If you are not going to have any \protect\cs{eledxxx} commands, then load \macpackage with \protect\cs{noeledsec} option. -% That will suppress the generation of unneeded \file{.eledsec} file, keep memory and make \macpackage faster. +% That will suppress the generation of unneeded \file{.eledsec} files, save memory, and make \macpackage run faster. +% % \section{Quotation environments} -% The \verb+quotation+ and \verb+quote+ environment can be used so that same definition/note appears both inside and outside a numbered section. +% The \verb+quotation+ and \verb+quote+ environments can be used so that the same definition/note appears both inside and outside a numbered section. % The typographical consequences will resemble the outside numbered sections, based on the styles of the \emph{book} class. % However, if you use a package that redefines these environments, these redefinitions won't be available inside the numbered section. -% You must open any quotation environments inside a \protect\cs{start}-\protect\cs{pend} block, not outside. -% A quotation environment MUST not be opened immediately after a \protect\cs{pstart} -% and MUST not be closed immediately before a \protect\cs{pend}. +% You must open any quotation environments inside a \protect\cs{pstart}\,\ldots\,\protect\cs{pend} block, not outside. +% A quotation environment MUST NOT be opened immediately after a \protect\cs{pstart} +% and MUST NOT be closed immediately before a \protect\cs{pend}. % % \label{noquotation} In some cases, you do not want these environments to be redefined in numbered sections. % You can load the package with the option \verb+noquotation+ to prevent this redefinition. +% % \section{Page breaks} +% % \subsection{Control page breaking} % \changes{v1.7.0}{2013/11/08}{New features for managing page breaks.} -% \Macpackage and \parpackage break pages automatically. -% However, you may sometimes want to either force page breaks or prevent them. +% \Macpackage and \parpackage break pages automatically. However, you may sometimes want to either force page breaks, or prevent them. % \DescribeMacro{\ledpb} \DescribeMacro{\lednopb} The packages provide two macros: % \begin{itemize} % \item \protect\cs{ledpb} adds a page break. @@ -2953,20 +2977,23 @@ % \end{itemize} % \textbf{These commands have effect only at the second run}. % -% These two commands take effect at the beginning of line in which they are called. For example, if you call \protect\cs{ledpb} at l.~444, the l.~443 will be at the p.~$n$, and the l.~444 at the p.~$n+1$. -% \DescribeMacro{\ledpbsetting} However you can change the behavior, and decide they will have effect after the end of the line, adding \verb+\ledpbsetting{after}+ at the beginning of your file (better: in your preamble). With the previous example, the l.~444 will be at the p.~$n$ and the l.~445 will be at the p.~$n+1$. +% These two commands take effect at the beginning of line in which they are called. +% For example, if you call \protect\cs{ledpb} at l.~444, then l.~443 will be at the p.~$n$, and the l.~444 at the p.~$n+1$. +% \DescribeMacro{\ledpbsetting} However, you can change the behavior and decide they will have effect after the end of the line, adding +% \verb+\ledpbsetting{after}+ at the beginning of your file (better: in your preamble). With the previous example, l.~444 will be +% on p.~$n$ and l.~445 will be on p.~$n+1$. % -% If you are using \parpackage to typeset parallel pages you must use \protect\cs{lednopb} on +% If you are using \parpackage to typeset parallel pages, you must use \protect\cs{lednopb} on % both sides in the two corresponding lines. This is especially important when you are using -% stanzas; otherwise the pages will run out of sync. +% stanzas; otherwise, the pages will be out of sync. % % \subsection{Prevent page break in a long verses} -%\label{lednopbinversetrue}\DescribeMacro{\lednopbinversetrue} You can also decide to prevent page breaks between two lines of a long verse. To do this, use \verb+nopbinverse+ when loading package, or add \protect\cs{lednopbinversetrue} in the beginning of your file (better: in your preamble). +% \label{lednopbinversetrue}\DescribeMacro{\lednopbinversetrue} You can also decide to prevent page breaks between two lines of a long verse. To do this, use \verb+nopbinverse+ when loading package, or add \protect\cs{lednopbinversetrue} in the beginning of your file (better: in your preamble). % -%This feature works only with verse of 2 lines, not more. It works at the third run, or at fourth run with \reledpar. -% By default, when a long verse runs normally between two pages, a page break will be placed at the beginning of the verse. However, if you have added \cs{ledpbsetting}\arg{after}, the page break will be placed at the end of the long verse, and the page containing the long verse will have one extra line. -% \section{Miscellaneous} +% This feature works only with verse of 2 lines and no more. It works on the third run, or on the fourth run if using \reledpar. +% By default, when a long verse runs between two pages, a page break will be placed at the beginning of the verse. However, if you have added \cs{ledpbsetting}\arg{after}, the page break will be placed at the end of the long verse and the page containing the long verse will have one extra line. % +% \section{Miscellaneous} % % \DescribeMacro{\extensionchars} % When the package assembles the name of the auxiliary file for a @@ -3049,12 +3076,12 @@ % will be subtracted from the penalties which apply to the page % breaks calculated on the \emph{previous} run through \TeX, thus % reinforcing these breaks. So if you find your page breaks -% oscillating, say \\ +% oscillating, insert \\ % \verb"\setcounter{ballast}{100}" \\ % or some such figure, and with any % luck the page breaks will settle down. Luckily, this problem % does not crop up at all often. -% \subsection{Paragraphed footnotes} +% \subsection{Paragraphed footnotes}\label{paragraphednotes:advanced} % The restriction on explicit line-breaking in paragraphed footnotes, % mentioned in a footnote \reff{nobreaks}, and % described in more detail on \reff{nobreaks-detail}, really is a @@ -3068,14 +3095,18 @@ % For paragraphed footnotes \TeX{} has to estimate the amount of space % required. If it underestimates this then the notes may get too long and % run off the bottom of the text block. \protect\cs{footfudgefiddle} can be increased -% from its default 64 (say to 68) to increase the estimate. You have to use +% from its default 64 (say, to 68) to increase the estimate. You have to use % \protect\cs{renewcommand} for this, like: \\ % \verb?\renewcommand{\footfudgefiddle}{68}? +% Note that you must call it \emph{before} \cs{Xarrangement}\arg{paragraph} or \cs{arrangementX}\arg{paragraph}. % -% \subsection{Use with other packages} +% Any settings to `geometry' must be made before \cs{Xarrangement} / \cs{arrangementX}. % +% Finally, in many cases you should use \cs{Xmaxhnotes} and / or \cs{maxhnotesX} (\reff{Xmaxhnotes}), in order to define the maximum height relative to \cs{textheight} and not to \cs{vsize}, because the \cs{vsize} value is not the same inside and outside of the preamble. +% +% \subsection{Use with other packages} % -% Because of \macpackage's complexity it may not play well with other +% Because of \macpackage's complexity, it may not play well with other % packages. In particular \macpackage is sensitive to commands in the % arguments to the \protect\cs{edtext} and \protect\cs{*footnote} macros (this is % discussed in more detail in section~\ref{text}, and in particular @@ -3227,7 +3258,7 @@ % \begin{macrocode} %<*code> \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{reledmac}[2015/08/26 v2.1.2 typesset critical edition]% +\ProvidesPackage{reledmac}[2015/09/05 v2.1.3 typeset critical edition]% % \end{macrocode} % % \subsection{Package options} @@ -3347,7 +3378,7 @@ % \subsection{Loading packages} % Loading package \protect\package{xargs} to declare commands with optional arguments. % \protect\package{Etoolbox} is also used to make code clearer - for example, in dynamic command names (which can replace \protect\cs{csname} etc.). -% Use \protect\package{suffix} to declare commands with a starred version, \protect\package{xstring} to work with strings, \protect\package{ifluatex} and \protect\package{ifxetex} to test if \LuaTeX\ or \XeTeX\ is running, and \protect\package{ragged2e} to manage ragged for paragraphed notes. +% Use \protect\package{suffix} to declare commands with a starred version, \protect\package{xstring} to work with strings, \protect\package{ifluatex} and \protect\package{ifxetex} to test if \LuaTeX\ or \XeTeX\ is running, and \protect\package{ragged2e} to manage ragged justification for paragraphed notes. % \begin{macrocode} \RequirePackage{xargs} \RequirePackage{etoolbox} @@ -3361,6 +3392,13 @@ \RequirePackage{ifxetex}% % \end{macrocode} % +% \subsection{Compatibility with \LuaTeX} +% Here, we enable some primitives for \LuaTeX. +% \begin{macrocode} +\ifx\directlua\undefined\else% + \directlua{tex.enableprimitives("",{"textdir","pardir","bodydir"})} +\fi +% \end{macrocode} % \subsection{Boolean flags} % \begin{macro}{\ifl@dmemoir} % Define a flag for if the \protect\package{memoir} class has been used. @@ -4159,7 +4197,7 @@ % \begin{macro}{\gl@p} % The \protect\cs{gl@p} macro removes the leftmost % item from a list and places it in a -% control sequence. You say \verb"\gl@p\l\to\z" +% control sequence. You type \verb"\gl@p\l\to\z" % (where \verb"\l" is the list macro, and % \verb"\z" receives the left item). \verb"\l" is assumed nonempty:use % \verb"\ifx\l\empty" to test for an empty \verb"\l". The control @@ -4547,7 +4585,7 @@ \newcommand*{\ledlinenum}{% \bgroup% \ifluatex% - \luatextextdir TLT% + \textdir TLT% \fi% \numlabfont\linenumrep{\line@num}% \ifsublines@ @@ -5026,7 +5064,7 @@ % associated with.) % % When these commands modify the various page and line counters, -% they deliberately do not say \protect\cs{global}. This is because we +% they deliberately do not use \protect\cs{global}. This is because we % want them to affect only the counter values within the current % group when nested calls of \protect\cs{@ref} occur. (The code assumes % throughout that the value of \protect\cs{globaldefs} is zero.) @@ -6367,7 +6405,7 @@ {\if@RTL\flag@start\else\flag@end\fi% With polyglossia, you must track whether the language reads left to right (English) or right to left (Arabic). }% % \end{macrocode} -% We switch to false some flags. +% We switch some flags to false. % \begin{itemize} % \item The one that checks having footnotes inside a \protect\cs{edtext}. % \item The one that says we are inside a \protect\cs{edtext}. In fact, it is not a flag, but a counter which is increased to 1 in each leavel of \protect\cs{edtext}. @@ -6410,13 +6448,13 @@ % font specifier for the current block of text into \protect\cs{l@d@nums}. % % One instance of \protect\cs{edtext} may generate several notes, or it -% may generate none --- it is legitimate for argument \verb"#2" to \protect\cs{edtext} to +% may generate none\,---\,it is legitimate for argument \verb"#2" to \protect\cs{edtext} to % be empty. But \protect\cs{flag@start} and \protect\cs{flag@end} induce the generation of % a single entry in \protect\cs{line@list} during the next run, and it is vital % to also remove one and only one \protect\cs{line@list} entry here. % % If no more lines are listed in \protect\cs{line@list}, something is -% wrong --- probably just some change in the input. We set all the numbers +% wrong\,---\,probably just some change in the input. We set all the numbers % to zeros, following an old publishing convention for numerical % references that have not yet been resolved. % \begin{macrocode} @@ -6908,7 +6946,7 @@ \autopar% \fi% \ifluatex% - \edef\l@luatextextdir@L{\the\luatextextdir}% + \edef\l@luatextextdir@L{\the\textdir}% \fi% \if@nobreak% \let\@oldnobreak\@nobreaktrue% @@ -7071,7 +7109,7 @@ % character that ends the group will be mistaken for the end of the % \protect\cs{vbox} that \protect\cs{pstart} creates, and the rest of the paragraph % will not be numbered. Such paragraphs need to be started explicitly -% using \protect\cs{indent}, \protect\cs{noindent}, or \protect\cs{leavevmode} --- or \protect\cs{pstart}, since +% using \protect\cs{indent}, \protect\cs{noindent}, or \protect\cs{leavevmode}\,---\,or \protect\cs{pstart}, since % you can still include your own \protect\cs{pstart} and \protect\cs{pend} % commands even with \protect\cs{autopar} on. % @@ -7218,7 +7256,7 @@ % If we use \LuaLaTeX\, then restore the direction. % \begin{macrocode} \ifluatex% - \luatextextdir\l@luatextextdir@L% + \textdir\l@luatextextdir@L% \fi% % \end{macrocode} % Insert, if needed, the hanging symbol. @@ -7393,7 +7431,7 @@ % \begin{macro}{\ballast@count} % \begin{macro}{\c@ballast} % First we set up the required counters; they are initially -% set to zero, and will remain so unless you say +% set to zero, and will remain so unless you type % \verb"\setcounter{ballast}"\marg{some figure} in your document. % \begin{macrocode} \newcount\ballast@count @@ -8006,7 +8044,7 @@ % \protect\cs{@xloop} is % a variant of the \PlainTeX\ \protect\cs{loop} macro, useful when it's % hard to construct a positive test using the \TeX\ \verb"\if" commands---as -% in \protect\cs{flush@notes} above. One says \protect\cs{@xloop} \verb"..." \verb"\if" \verb"..." \verb"\else" +% in \protect\cs{flush@notes} above. One types \protect\cs{@xloop} \verb"..." \verb"\if" \verb"..." \verb"\else" % \verb"..." \verb"\repeat", and the action following \verb"\else" is repeated as long % as the \verb"\if" test fails. (This macro will work wherever the \PlainTeX\ % \protect\cs{loop} is used, too, so we could just call it \protect\cs{loop}; @@ -8090,15 +8128,15 @@ % \begin{macrocode} \newcommandx*{\footnotelang@lua}[1][1=L,usedefault]{% \ifstrequal{#1}{L}{% - \xright@appenditem{{\csxdef{footnote@luatextextdir}{\the\luatextextdir}}}\to\inserts@list%Know the dir of lemma + \xright@appenditem{{\csxdef{footnote@luatextextdir}{\the\textdir}}}\to\inserts@list%Know the dir of lemma \global\advance\insert@count \@ne% - \xright@appenditem{{\csxdef{footnote@luatexpardir}{\the\luatexpardir}}}\to\inserts@list%Know the dir of lemma + \xright@appenditem{{\csxdef{footnote@luatexpardir}{\the\pardir}}}\to\inserts@list%Know the dir of lemma \global\advance\insert@count \@ne% }% {% - \xright@appenditem{{\csxdef{footnote@luatextextdir}{\the\luatextextdir}}}\to\inserts@listR%Know the dir of lemma + \xright@appenditem{{\csxdef{footnote@luatextextdir}{\the\textdir}}}\to\inserts@listR%Know the dir of lemma \global\advance\insert@countR \@ne% - \xright@appenditem{{\csxdef{footnote@luatexpardir}{\the\luatexpardir}}}\to\inserts@listR%Know the dir of lemma + \xright@appenditem{{\csxdef{footnote@luatexpardir}{\the\pardir}}}\to\inserts@listR%Know the dir of lemma \global\advance\insert@countR \@ne% }% } @@ -8220,7 +8258,7 @@ % We can now define all the parameters for the series of % footnotes; initially they use the ``normal'' footnote formatting. % -% What we want to do here is to say something like the following +% What we want to do here is to insert something like the following % for each footnote series. (This is an example, not part of the % actual \macpackage{} code.) % \begin{verbatim} @@ -8344,6 +8382,7 @@ \notbool{parapparatus@}{\newcommand*}{\newcommand}{\normalfootfmt}[4]{% \Xledsetnormalparstuff{#4}% \hangindent=\csuse{Xhangindent@#4} + \everypar{\hangindent=\csuse{Xhangindent@#4}}% \strut{\printlinefootnote{#1}{#4}}% {\nottoggle{Xlemmadisablefontselection@#4}{\select@lemmafont#1|#2}{#2}}% \iftoggle{nosep@}{\hskip\csuse{Xinplaceoflemmaseparator@#4}}{\ifcsempty{Xlemmaseparator@#4}% @@ -8437,7 +8476,7 @@ % % \begin{macro}{\mpnormalfootgroup} % A somewhat different version for minipages. -% Notes that, in this case, we don not make distinction between \protect\cs{Xfootgroup} and \protect\cs{Xfootstarts} macro. +% Note that, in this case, we do not make distinctions between the \protect\cs{Xfootgroup} and \protect\cs{Xfootstarts} macros. % \changes{v0.4.0}{2004/02/29}{Added \protect\cs{mpnormalfootgroup}} % \begin{macrocode} \unless\ifnoledgroup@ @@ -8521,7 +8560,7 @@ % For paragraphed footnotes \TeX{} has to estimate the amount of space % required. If it underestimates this then the notes may get too long and % run off the bottom of the text block. \protect\cs{footfudgefiddle} can be increased -% from its default 64 (say to 70) to increase the estimate. +% from its default 64 (say, to 70) to increase the estimate. % \changes{v0.2.2}{2003/11/04}{Added \protect\cs{footfudgefiddle}} % \begin{macrocode} \providecommand{\footfudgefiddle}{64} @@ -8565,7 +8604,8 @@ % The argument of the macro is again the note series letter. % \begin{macrocode} \newcommand*{\parafootstart}[1]{% - \rightskip=0pt \leftskip=0pt \parindent=0pt + \rightskip=0pt \leftskip=0pt% + \nottoggle{Xparindent@#1}{\parindent=\z@}{}% \ifdimequal{0pt}{\preXnotes@}{}% {% \iftoggle{preXnotes@}{% @@ -8643,7 +8683,7 @@ % consequence:\label{nobreaks-detail} as Michael % pointed out, you really can't put an explicit line-break into a % note built in a \protect\cs{vbox} the way we are doing.\footnote{`Line -% Breaking', p.\,610.} In other words, be very careful not to say +% Breaking', p.\,610.} In other words, be very careful not to use % \protect\cs{break}, or \verb"\penalty-10000", or any equivalent inside your % para-footnote.\label{nobreak} If you do, most of the note will % probably disappear. You \emph{are} allowed to make strong @@ -8760,7 +8800,7 @@ % \begin{macrocode} \newcommand*{\parafootfmt}[4]{% \Xinsertparafootsep{#4}% - \Xledsetnormalparstuff{#4}% + \ledsetnormalparstuff@common% \printlinefootnote{#1}{#4}% {\nottoggle{Xlemmadisablefontselection@#4}{\select@lemmafont#1|#2}{#2}}% \iftoggle{nosep@}{\hskip\csuse{Xinplaceoflemmaseparator@#4}}{\ifcsempty{Xlemmaseparator@#4}% @@ -8793,7 +8833,7 @@ \makehboxofhboxes \setbox0=\hbox{{\csuse{Xnotefontsize@#1}\csuse{Xtxtbeforenotes@#1}}\unhbox0 \removehboxes}% \csuse{Xnotefontsize@#1} - \noindent\unhbox0\par% + \unhbox0\par% \global\hsize=\old@hsize% }% @@ -8829,7 +8869,7 @@ \makehboxofhboxes \setbox0=\hbox{{\csuse{Xnotefontsize@#1}\csuse{Xtxtbeforenotes@#1}}\unhbox0 \removehboxes}% \csuse{Xnotefontsize@#1} - \noindent\unhbox0\par}} + \unhbox0\par}} % \end{macrocode} % \end{macro} @@ -9024,7 +9064,10 @@ \tolerance=5000 \hangindent=\csuse{Xhangindent@#4} \leavevmode + \everypar{\hangindent=\csuse{Xhangindent@#4}}% + \@tempdima=\parindent% \csuse{Xcolalign@#4}% + \parindent=\@tempdima% \strut{\printlinefootnote{#1}{#4}}% {\nottoggle{Xlemmadisablefontselection@#4}{\select@lemmafont#1|#2}{#2}}% \iftoggle{nosep@}{\hskip\csuse{Xinplaceoflemmaseparator@#4}}{\ifcsempty{Xlemmaseparator@#4}% @@ -9145,7 +9188,10 @@ \tolerance=5000 \hangindent=\csuse{Xhangindent@#4} \leavevmode + \everypar{\hangindent=\csuse{Xhangindent@#4}}% + \@tempdima=\parindent% \csuse{Xcolalign@#4}% + \parindent=\@tempdima% \strut{\printlinefootnote{#1}{#4}}% {\nottoggle{Xlemmadisablefontselection@#4}{\select@lemmafont#1|#2}{#2}}% \iftoggle{nosep@}{\hskip\csuse{Xinplaceoflemmaseparator@#4}}{\ifcsempty{Xlemmaseparator@#4}% @@ -9649,7 +9695,7 @@ % If we use \LuaTeX, ensure we use good text's direction. % \begin{macrocode} \ifluatex% - \luatextextdir TLT% + \textdir TLT% \fi% % \end{macrocode} % Decide which part of line number components we will print. @@ -9955,8 +10001,8 @@ % \begin{macrocode} \notbool{parapparatus@}{\newcommand*}{\newcommand}{\normalfootfmtX}[2]{% \ifluatex% - \luatextextdir\footnote@luatextextdir% - \luatexpardir\footnote@luatexpardir% + \textdir\footnote@luatextextdir% + \pardir\footnote@luatexpardir% \par% \fi% \protected@edef\@currentlabel{% @@ -9964,6 +10010,7 @@ }% \ledsetnormalparstuffX{#1}% \hangindent=\csuse{hangindentX@#1}% + \everypar{\hangindent=\csuse{hangindentX@#1}}% {{\csuse{notenumfontX@#1}\@nameuse{footfootmark#1}}\strut% #2\strut\par}} @@ -10221,11 +10268,14 @@ }% \normal@pars \hangindent=\csuse{hangindentX@#1}% + \everypar{\hangindent=\csuse{hangindentX@#1}}% \hsize \csuse{hsizetwocolX@#1} \nottoggle{parindentX@#1}{\parindent=\z@}{} \tolerance=5000\relax \leavevmode + \@tempdima=\parindent% \csuse{colalignX@#1}% + \parindent=\@tempdima% {\csuse{notenumfontX@#1}\@nameuse{footfootmark#1}\strut% #2\strut\par}\allowbreak} @@ -10332,12 +10382,15 @@ \@nameuse{@thefnmark#1}% }% \hangindent=\csuse{hangindentX@#1}% + \everypar{\hangindent=\csuse{hangindentX@#1}}% \normal@pars \hsize \csuse{hsizethreecolX@#1} \nottoggle{parindentX@#1}{\parindent=\z@}{} % \tolerance=5000\relax \leavevmode + \@tempdima=\parindent% \csuse{colalignX@#1}% + \parindent=\@tempdima% {\csuse{notenumfontX@#1}\@nameuse{footfootmark#1}\strut% #2\strut\par}\allowbreak} @@ -10444,10 +10497,9 @@ }% {}% }% - \vskip\skip\csname footins#1\endcsname% \leftskip=\z@ \rightskip=\z@ - \parindent=\z@ + \nottoggle{parindentX@#1}{\parindent=\z@}{}% \vskip\skip\@nameuse{footins#1}% \setnoteswidthliketwocolumnsX@{#1}% \setnotesXpositionliketwocolumns@{#1}% @@ -10514,7 +10566,7 @@ \@nameuse{@thefnmark#1}% }% \insertparafootsepX{#1}% - \ledsetnormalparstuffX{#1}% + \ledsetnormalparstuff@common% {\csuse{notenumfontX@#1}% \csuse{notenumfontX@#1}% \@nameuse{footfootmark#1}% @@ -10535,7 +10587,7 @@ \makehboxofhboxes \setbox0=\hbox{\unhbox0 \removehboxes}% \csuse{notefontsizeX@#1} - \noindent\unhbox0\par} + \unhbox0\par} \newcommand*{\mppara@footgroupX}[1]{{% \setnoteswidthliketwocolumnsX@{#1}% \vskip\skip\@nameuse{mpfootins#1} @@ -10563,7 +10615,7 @@ \makehboxofhboxes \setbox0=\hbox{\unhbox0 \removehboxes}% \csuse{notefontsizeX@#1} - \noindent\unhbox0\par}} + \unhbox0\par}} % \end{macrocode} % \end{macro} @@ -10599,11 +10651,12 @@ % % \changes{v1.4.0}{2012/11/16}{Direction of footnotes with polyglossia.} % \changes{v1.21.0}{2015/04/13}{\protect\cs{ledsetnormalparstuff} is deprecated and becomes \protect\cs{ledsetnormalparstuffX} and \protect\cs{Xledsetnormalparstuff}.} +% \changes{v2.1.3}{2015/09/05}{Replaced \protect\cs{noindent} with \protect\cs{parindent} set to 0pt.} % \begin{macrocode} \newcommand*{\ledsetnormalparstuff@common}{% \ifluatex% - \luatextextdir\footnote@luatextextdir% - \luatexpardir\footnote@luatexpardir% + \textdir\footnote@luatextextdir% + \pardir\footnote@luatexpardir% \fi% \csuse{\csuse{footnote@dir}}% \normal@pars% @@ -10611,12 +10664,12 @@ \newcommand*{\Xledsetnormalparstuff}[1]{% \ledsetnormalparstuff@common% - \nottoggle{Xparindent@#1}{\noindent}{}%\noindent and and not \parindent=0pt to avoid to break the (bad) change made when moving from ledmac to eledmac + \nottoggle{Xparindent@#1}{\parindent=\z@}{\hspace{\parindent}}% }% \newcommand*{\ledsetnormalparstuffX}[1]{% \ledsetnormalparstuff@common% - \nottoggle{parindentX@#1}{\noindent}{}%\noindent and and not \parindent=0pt to avoid to break the (bad) change made when moving from ledmac to eledmac + \nottoggle{parindentX@#1}{\parindent=\z@}{\hspace{\parindent}}% }% % \end{macrocode} % \end{macro} @@ -11406,8 +11459,8 @@ {\csuse{@footnotemark#1}}% {}% \ifluatex% - \xdef\footnote@luatextextdir{\the\luatextextdir}% - \xdef\footnote@luatexpardir{\the\luatexpardir}% + \xdef\footnote@luatextextdir{\the\textdir}% + \xdef\footnote@luatexpardir{\the\pardir}% \fi% \csuse{vfootnote#1}{#1}{\expandonce\content}\m@mmf@prepare% \endgroup% @@ -11676,7 +11729,7 @@ % \subsubsection{Tools to generate options commands} % \begin{macro}{\newhookcommand@series} % \protect\cs{newhookcommand@series}\protect\cs{command names} is a generic command to add new commands for hooks, like \protect\cs{Xhsizetwocol}. -% The first argument is the name of the hook, the second a comma separated list of pseudo-series where the hook can be used, like \verb+appref+ in the case of \protect\cs{Xtwolines}. +% The first argument is the name of the hook, the second a comma-separated list of pseudo-series where the hook can be used, like \verb+appref+ in the case of \protect\cs{Xtwolines}. % The second argument is also used to create commands named \protect\cs{<hookname><pseudoseries>}, % like \protect\cs{Xtwolinesappref}. % \changes{v1.21.0}{2015/04/13}{\protect\cs{newhookcommand@series} can take an optional argument.} @@ -12206,7 +12259,7 @@ % % You can mark a place in the text using a command of the form % \protect\cs{edlabel}\marg{foo}, and later refer to it using the label -% \meta{foo} by saying \protect\cs{edpageref}\marg{foo}, or \protect\cs{lineref}\marg{foo} or +% \meta{foo} by typing \protect\cs{edpageref}\marg{foo}, or \protect\cs{lineref}\marg{foo} or % \protect\cs{sublineref}\marg{foo} or \protect\cs{pstartref}. These reference commands will produce, % respectively, the page, line sub-line and pstart on which the % \protect\cs{edlabel}\marg{foo} command occurred. @@ -12593,7 +12646,7 @@ % place where \protect\cs{label}\verb+{mouse}+ was placed, and the ending % numbers to those at \verb+{elephant}+. The point of this is % to be able to manufacture footnote line references to passages -% which can not be specified in the normal way as the first argument +% which cannot be specified in the normal way as the first argument % to \protect\cs{edtext} for one reason or another. Using \protect\cs{xxref} in the % second argument of \protect\cs{edtext} lets you set things up at least % semi-automatically. @@ -12715,7 +12768,7 @@ % \begin{macro}{\edmakelabel} % Sometimes the \protect\cs{edlabel} command cannot be used to specify % exactly the page and line desired; you can use the \protect\cs{edmakelabel} macro -% make your own label. For example, if you say +% make your own label. For example, if you insert % \protect\cs{edmakelabel}\verb+{elephant}{10|25|0}+ you will have created a % new label, and a later call to \protect\cs{edpageref}\verb+{elephant}+ would % print `10' and \protect\cs{lineref}\verb+{elephant}+ would print `25'. @@ -12739,7 +12792,7 @@ % % \section{Side notes} % -% Regular \protect\cs{marginpar}s do not work inside numbered text --- they +% Regular \protect\cs{marginpar}s do not work inside numbered text\,---\,they % do not produce any note but do put an extra unnumbered blank line into % the text. % @@ -13513,7 +13566,7 @@ \fi% % \end{macrocode} % If we do not use \verb+xindy+ option, \protect\cs{@ledinnote@command} will produce -% something like \verb+ledinnote{formatingcommand}+. +% something like \verb+ledinnote{formattingcommand}+. % \begin{macrocode} \else% \gdef\@ledinnote@command{% @@ -13677,7 +13730,7 @@ % \begin{macrocode} \edef\temp@{% \catcode`\ =9 %space need for catcode - #1% + \detokenize{#1}%For active character in unicode \catcode`\ =10 % space need for catcode }% % \end{macrocode} @@ -15505,7 +15558,7 @@ % % \section{Quotation's commands} % \begin{macro}{\initnumbering@quote} -% This macro, called at the begin of any numbered section, redefine locally the \verb+quotation+ and \verb+quote+ environment, in order to allow to use it inside numbered section. +% This macro, called at the beginning of any numbered section, locally redefines the \verb+quotation+ and \verb+quote+ environments, in order to allow their use inside of numbered sections. % \changes{v2.0.0}{2015/07/19}{\protect\cs{initnumbering@sectcmd} becomes \protect\cs{initnumbering@quote}} % \begin{macro}{\quotation} % \begin{macro}{\endquotation} @@ -16387,7 +16440,7 @@ % % \bibitem[Fai03]{FOOTMISC} % Robin Fairbairns. -% \newblock \emph{\protect\package{footmisc} --- a portmanteau package for +% \newblock \emph{\protect\package{footmisc}\,---\,a portmanteau package for % customising footnotes in \LaTeX}. % \newblock February 2003. % \newblock (Available from CTAN in @@ -16404,7 +16457,7 @@ % % \bibitem[L\"{u}c03]{EDNOTES} % Uwe L\"{u}ck. -% \newblock `\textsf{ednotes} --- critical edition typesetting with LaTeX'. +% \newblock `\textsf{ednotes}\,---\,critical edition typesetting with LaTeX'. % \newblock \emph{TUGboat}, \textbf{24}, 2, pp. 224--236, 2003. % \newblock (Code available from CTAN in % \texttt{macros/latex/contrib/ednotes}) diff --git a/Master/texmf-dist/source/latex/reledmac/reledpar.dtx b/Master/texmf-dist/source/latex/reledmac/reledpar.dtx index 65de1a12139..1226600d08a 100644 --- a/Master/texmf-dist/source/latex/reledmac/reledpar.dtx +++ b/Master/texmf-dist/source/latex/reledmac/reledpar.dtx @@ -242,6 +242,9 @@ % \changes{v2.2.0}{2015/08/08}{\protect\env{astanza} environment can take an optional argument, which will be the optional argument of \protect\cs{pstart} started by this environment.} % \changes{v2.2.0}{2015/08/08}{New tools to number stanza} % \changes{v2.2.1}{2015/08/13}{Fix bug with optional argument of last left \protect\cs{pend}} +% \changes{v2.3.0}{2015/09/05}{Fix bug with title number in parallel columns} +% \changes{v2.3.0}{2015/09/05}{Change some internal codes in order to provide compatibility with \LaTeX\ release of october~2015} +% \changes{v2.3.0}{2015/09/05}{New line setting command suffixed by R to set only the right side.} % \hyphenation{man-u-script man-u-scripts} % % @@ -572,11 +575,11 @@ % \footnote{The same applies to \LaTeX\ normal notes. Read \url{http://tex.stackexchange.com/a/228283/7712} for technical informations.} % We have not changed this default setting, because we do not want to break compatibility with older version of \macpackage and we want to be as close as possible to default \LaTeX's feature. % -% So, you MUST change the default setting via \protect\cs{Xmaxnotes} (for critical notes) and \protect\cs{maxhnotesX} (for familiar notes). +% So, you MUST change the default setting via \protect\cs{Xmaxhnotes} (for critical notes) and \protect\cs{maxhnotesX} (for familiar notes). % Both commands are explained in \macpackage handbook (\reff{reledmac-Xmaxhnotes}). % As an advisable setting: % \begin{verbatim} -% \maxhXnotes{0.6\textheight} +% \Xmaxhnotes{0.6\textheight} % \maxhnotesX{0.6\textheight} % \end{verbatim} % \subsubsection{Notes for one side only} @@ -702,10 +705,6 @@ % \DescribeMacro{\linenumincrement} % \DescribeMacro{\firstsublinenum} % \DescribeMacro{\sublinenumincrement} -% \DescribeMacro{\firstlinenum*} -% \DescribeMacro{\linenumincrement*} -% \DescribeMacro{\firstsublinenum*} -% \DescribeMacro{\sublinenumincrement*} % Following % \protect\cs{firstlinenum}\marg{num} the first line number will be \meta{num}, and % following \protect\cs{linenumincrement}\marg{num} only every \meta{num}th @@ -714,19 +713,36 @@ % control over the left and right numbering schemes. The \protect\cs{firstsublinenum} % and \protect\cs{sublinenumincrement} macros correspondingly set the numbering % scheme for sublines. -% The starred versions change both left and right numbering schemes. -% % Generally speaking, controls like \protect\cs{firstlinenum} or \protect\cs{linenummargin} % apply to sequential and left texts. % To effect right texts only, they have % to be within a \verb?Rightside? environment. - +% +% \DescribeMacro{\firstlinenum*} +% \DescribeMacro{\linenumincrement*} +% \DescribeMacro{\firstsublinenum*} +% \DescribeMacro{\sublinenumincrement*} +% The starred versions change both left and right numbering schemes. +% +% \DescribeMacro{\firstlinenumR} +% \DescribeMacro{\linenumincrementR} +% \DescribeMacro{\firstsublinenumR} +% \DescribeMacro{\sublinenumincrementR} +% The suffixed version change the right side, without regard to the position they are called. +% % \DescribeMacro{\lineationR} % \protect\cs{lineationR} macro is the equivalent of \macpackage \protect\cs{lineation} macro for the right side. % \DescribeMacro{\lineation*} % \protect\cs{lineation*} macro is the equivalent of \macpackage \protect\cs{lineation} macro for both sides. % +% \DescribeMacro{\linenumberstyleR} +% \DescribeMacro{\sublinenumberstyleR} +% \DescribeMacro{\linenumberstyle*} +% \DescribeMacro{\sublinenumberstyle*} +% \cs{linenumberstyleR} is the equivalent of \macpackage \cs{linenumberstyle} for right text. +% \cs{sublinenumberstyleR} is the equivalent of \macpackage \cs{sublinenumberstyle} right text. +% The starred version are for both side. % \DescribeMacro{\setRlineflag} % A ``R'' is appended to the line numbers of the % right texts. @@ -977,7 +993,7 @@ % \begin{macrocode} %<*code> \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{reledpar}[2015/08/13 v2.2.1 reledmac extension for parallel texts]% +\ProvidesPackage{reledpar}[2015/09/05 v2.3.0 reledmac extension for parallel texts]% % \end{macrocode} % \subsection{Package's requirement} @@ -1512,6 +1528,29 @@ % \end{macro} % \end{macro} % +% \begin{macro}{\firstlinenumR} +% \begin{macro}{\linenumincrementR} +% \begin{macro}{\firstsublinenumR} +% \begin{macro}{\sublinenumincrementR} +% And the `R` suffixed version. +% \begin{macrocode} +\newcommand\firstlinenumR[1]{% + \setcounter{firstlinenumR}{#1}% +} +\newcommand\linenumincrementR[1]{% + \setcounter{linenumincrementR}{#1}% +} +\newcommand\firstsublinenumR[1]{% + \setcounter{subfirstlinenumR}{#1}% +} +\newcommand\sublinenumincrementR[1]{% + \setcounter{sublinenumincrementR}{#1}% +} +% \end{macrocode} +% \end{macro} +% \end{macro} +% \end{macro} +% \end{macro} % \subsection{Setting line flag} % \begin{macro}{\Rlineflag} % This is appended to the line numbers of right text. @@ -1535,6 +1574,34 @@ % \end{macrocode} % \end{macro} % \end{macro} +% \begin{macro}{\linenumberstyleR} +% \begin{macro}{\sublinenumberstyleR} +% The style can be changed by some user level command +% \begin{macrocode} +\newcommand*{\linenumberstyleR}[1]{% + \def\linenumrepR##1{\@nameuse{@#1}{##1}}} +\newcommand*{\sublinenumberstyleR}[1]{% + \def\sublinenumrepR##1{\@nameuse{@#1}{##1}}} +% \end{macrocode} +% \end{macro} +% \end{macro} +% \begin{macro}{\linenumberstyle*} +% \begin{macro}{\sublinenumberstyle*} +% And for both side. +% \begin{macrocode} +\WithSuffix\newcommand\linenumberstyle*[1]{% + \linenumberstyle{#1}% + \linenumberstyleR{#1}% +}% + +\WithSuffix\newcommand\sublinenumberstyle*[1]{% + \sublinenumberstyle{#1}% + \sublinenumberstyleR{#1}% +}% +% +% \end{macrocode} +% \end{macro} +% \end{macro} % \subsection{Print marginal line number} % \begin{macro}{\leftlinenumR} % \begin{macro}{\rightlinenumR} @@ -2568,9 +2635,9 @@ \fi% \@nobreaktrue% \ifluatex% - \xdef\l@luatextextdir@L{\the\luatextextdir}% - \xdef\l@luatexpardir@L{\the\luatexpardir}% - \xdef\l@luatexbodydir@L{\the\luatexbodydir}% + \xdef\l@luatextextdir@L{\the\textdir}% + \xdef\l@luatexpardir@L{\the\pardir}% + \xdef\l@luatexbodydir@L{\the\bodydir}% \fi% \ifnumbering \else% \led@err@PstartNotNumbered% @@ -2646,9 +2713,9 @@ \fi% \@nobreaktrue% \ifluatex% - \xdef\l@luatextextdir@R{\the\luatextextdir}% - \xdef\l@luatexpardir@R{\the\luatexpardir}% - \xdef\l@luatexbodydir@R{\the\luatexbodydir}% + \xdef\l@luatextextdir@R{\the\textdir}% + \xdef\l@luatexpardir@R{\the\pardir}% + \xdef\l@luatexbodydir@R{\the\bodydir}% \fi% \ifnumberingR \else% \led@err@PstartNotNumbered% @@ -2900,7 +2967,7 @@ {\ledllfill\hb@xt@ \Lcolwidth{% \do@insidelineLhook% \ifluatex% - \luatextextdir\l@luatextextdir@L% + \textdir\l@luatextextdir@L% \fi% \new@lineL% \inserthangingsymbolL% @@ -2923,9 +2990,9 @@ \@eled@sectioningtrue% \bgroup% \ifluatex% - \luatextextdir\l@luatextextdir@L% - \luatexpardir\l@luatexpardir@L% - \luatexbodydir\l@luatexbodydir@L% + \textdir\l@luatextextdir@L% + \pardir\l@luatexpardir@L% + \bodydir\l@luatexbodydir@L% \ifdefstring{\l@luatextextdir@L}{TRT}{\@RTLtrue}{}% \fi% \csuse{eled@sectioning@\the\l@dpscL}% @@ -2987,6 +3054,8 @@ % \changes{v1.8.1}{2014/08/07}{Fix a bug with critical notes a the begining of a page, added by v1.8.0 (?).} % \begin{macrocode} \newcommand*{\do@lineR}{% + \let\linenumrep\linenumrepR% + \let\sublinenumrep\sublinenumrepR% \letcs{\ifnumberpstart}{numberpstart@R\the\l@dpscR}% \ledRcol@true% \advance\countRline \@ne% @@ -3044,7 +3113,7 @@ \new@lineR% \inserthangingsymbolR% \ifluatex% - \luatextextdir\l@luatextextdir@R% + \textdir\l@luatextextdir@R% \fi% \l@dunhbox@line{\one@lineR}}\ledrlfill\l@drd@ta% \l@drsn@te% @@ -3060,9 +3129,9 @@ \@eled@sectioningtrue% \bgroup% \ifluatex% - \luatextextdir\l@luatextextdir@R% - \luatexpardir\l@luatexpardir@R% - \luatexbodydir\l@luatexbodydir@R% + \textdir\l@luatextextdir@R% + \pardir\l@luatexpardir@R% + \bodydir\l@luatexbodydir@R% \ifdefstring{\l@luatextextdir@L}{TRT}{\@RTLtrue}{}% \fi% \csuse{eled@sectioning@\the\l@dpscR R}% @@ -4824,6 +4893,7 @@ }% \print@columnseparator% \parbox[t][][t]{\Rcolwidth}{% + \initnumbering@sectcountR% \csuse{before@pstartR@\the\l@dpscR}% }% \ifdefstring{\columns@position}{R}{}{\hfill}% @@ -4846,6 +4916,7 @@ }% \print@columnseparator% \parbox[t][][t]{\Rcolwidth}{% + \initnumbering@sectcountR% \csuse{after@pendR@\the\l@dpscR}% }% \ifdefstring{\columns@position}{R}{}{\hfill}% @@ -4902,17 +4973,20 @@ \led@err@BadLeftRightPstarts{\the\l@dnumpstartsL}{\the\l@dnumpstartsR}% \fi% % \end{macrocode} -% \changes{v1.13.0}{2015/03/06xx}{Prevent false overfull hboxes when using \protect\cs{Pages} outside of pages environment.} -% As \protect\cs{Pages} must be called outside of the pages environment, we have to redefine the \protect\cs{Lcolwidth} and \protect\cs{Rcolwidth} lengths, to prevent false overfull hboxes. -% \begin{macrocode} - \setlength{\Lcolwidth}{\textwidth}% - \setlength{\Rcolwidth}{\textwidth}% -% \end{macrocode} % Get onto an empty even (left) page, then initialise counters, etc. % \begin{macrocode} \cleartol@devenpage% \l@dprintingpagestrue% \begingroup% +% \end{macrocode} +% As \protect\cs{Pages} must be called outside of the pages environment, we have to redefine the \protect\cs{Lcolwidth} and \protect\cs{Rcolwidth} lengths, to prevent false overfull hboxes. +% \changes{v1.13.0}{2015/03/06}{Prevent false overfull hboxes when using \protect\cs{Pages} outside of pages environment.} +% \changes{v2.3.0}{2015/09/05}{Fix bug when calling \protect\cs{Columns} after a \protect\cs{Pages} (bug added in v1.13.0).} +% \begin{macrocode} + \setlength{\Lcolwidth}{\textwidth}% + \setlength{\Rcolwidth}{\textwidth}% +% \end{macrocode} +% \begin{macrocode} \l@dzeropenalties% \endgraf\global\num@lines=\prevgraf% \global\num@linesR=\prevgraf% @@ -5250,7 +5324,7 @@ % Because \protect\cs{clearpage} prints all footnotes before the next page, even if it has to add new empty pages, while \protect\cs{newpage} does not. % And as we want notes started in the left page continue in the right page and \emph{vice-versa}, we must use \protect\cs{newpage} and not \protect\cs{clearpage} % -% \changes{v1.13.0}{2015/03/06x}{Use \protect\cs{newpage} instead of \protect\cs{clearpage}.} +% \changes{v1.13.0}{2015/03/06}{Use \protect\cs{newpage} instead of \protect\cs{clearpage}.} % \begin{macrocode} \newcommand*{\clearl@dleftpage}{% \ifdim\pagetotal=0pt\hbox{}\fi% |