diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/reledmac/reledmac.dtx')
-rw-r--r-- | Master/texmf-dist/source/latex/reledmac/reledmac.dtx | 114 |
1 files changed, 66 insertions, 48 deletions
diff --git a/Master/texmf-dist/source/latex/reledmac/reledmac.dtx b/Master/texmf-dist/source/latex/reledmac/reledmac.dtx index bae73f9fe41..f80d38a2f5b 100644 --- a/Master/texmf-dist/source/latex/reledmac/reledmac.dtx +++ b/Master/texmf-dist/source/latex/reledmac/reledmac.dtx @@ -518,20 +518,21 @@ % \changes{v2.27.1}{2018/10/12}{Fix spurious space in \protect\cs{hidenumbering}.} % \changes{v2.28.0}{2018/11/30}{Familiar footnotes can take an optional argument to manually define the footnote mark.} % \changes{v2.28.1}{2018/12/22}{Fix bug with the alignment of the columns of two and three columns critical footnotes.} -% \changes{v2.29.0}{2019/01/08}{Fix bug with \protect\cs{linenumannotation} and `nofamiliar` option.} +% \changes{v2.29.0}{2019/01/08}{Fix bug with \protect\cs{linenumannotation} and `nofamiliar` option.} % \changes{v2.29.0}{2019/01/08}{Really reset line number annotation at each line} % \changes{v2.29.0}{2019/01/08}{Add \protect\option{noresetlinenumannotation}} % \changes{v2.29.0}{2019/01/08}{Fix little bug with \protect\cs{msdata}} % \changes{v2.30.0}{2019/01/22}{Add \protect\cs{Xnoidenticallinenumannotation} and \protect\cs{Xendnoidenticallinenumannotation} hooks} % \changes{v2.30.0}{2019/01/22}{Add separator between line number annotations in margin. Add \protect\cs{setlinenumannotationsep}} % \changes{v2.31.0}{2019/02/22}{Add \protect\option{noprefix} and \protect\option{prefixmore} to \protect\cs{appref} and \protect\cs{SEref}.} -% \changes{v2.31.1}{2019/03/03}{Fix bug with \protect\cs{Xgroupbyline}, which could produce spurious blank line} -% \changes{v2.31.1}{2019/03/03}{Fix bug with multiple footnote layer and \protect\cs{Xgroupbyline}} -% \changes{v2.31.1}{2019/03/03}{Fix incompatibility between \protect\cs{Xgroupbyline} and \protect\package{hyperref} package} -% \changes{v2.31.1}{2019/03/03}{Fix incompatibility between \protect\cs{Xgroupbyline} and optional argument of critical footnotes} -% \changes{v2.31.1}{2019/03/03}{Fix bug in vertical spacing with \protect\cs{Xgroupbyline}} -% \changes{v2.31.1}{2019/03/03}{Fix bug with indentation with \protect\cs{Xgroupbyline}} +% \changes{v2.31.1}{2019/03/03}{Fix bug with \protect\cs{Xgroupbyline}, which could produce spurious blank lines.} +% \changes{v2.31.1}{2019/03/03}{Fix bug with multiple footnote layer and \protect\cs{Xgroupbyline}.} +% \changes{v2.31.1}{2019/03/03}{Fix incompatibility between \protect\cs{Xgroupbyline} and \protect\package{hyperref} package.} +% \changes{v2.31.1}{2019/03/03}{Fix incompatibility between \protect\cs{Xgroupbyline} and optional argument of critical footnotes.} +% \changes{v2.31.1}{2019/03/03}{Fix bug in vertical spacing with \protect\cs{Xgroupbyline}.} +% \changes{v2.31.1}{2019/03/03}{Fix bug with indentation with \protect\cs{Xgroupbyline}.} % \changes{v2.31.1}{2019/03/03}{Fix bug with \protect\cs{Xhangindent} and \protect\cs{hangindentX} for right-to-left texts.} +% \changes{v2.31.2}{2019/04/03}{Fix bug with familiar footnote containing not default font (introduced with v.~2.20.0).} % Typeset scholarly editions with \LaTeX\thanks{This file (\dtxfilename) % has version number \fileversion, last revised \filedate.}} % @@ -604,7 +605,7 @@ % % Any suggestions for new features are welcome. % -% This manual contains a general description of how to use \macpackage followed by +% 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. @@ -959,7 +960,7 @@ % % \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 an 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}. % % Note that a \cs{noindent} will be automatically added before this argument, and, consequently, a \cs{parskip} will be inserted. @@ -1003,10 +1004,10 @@ % \setcounter{pstart}{value} % \end{verbatim} % On each \protect\cs{beginnumbering} the numbering restarts. -% \changes{v0.15.0}{2012/06/11}{Possibility to print \protect\cs{pstart} number in the sides of the text.} +% \changes{v0.15.0}{2012/06/11}{Possibility to print \protect\cs{pstart} number at the sides of the text.} % % \DescribeMacro{\sidepstartnumtrue} -% With the \protect\cs{sidepstartnumtrue} command, the number of \protect\cs{pstart} will be printed in the sides of the text. +% With the \protect\cs{sidepstartnumtrue} command, the number of \protect\cs{pstart} will be printed at the sides of the text. % In this case, the line number will be not printed. % % \changes{v1.1.0}{2012/09/25}{Add \protect\cs{labelpstarttrue}.} @@ -1074,14 +1075,30 @@ % \DescribeMacro{\numberlinefalse} \DescribeMacro{\numberlinetrue} % Line numbering can be disabled with \protect\cs{numberlinefalse}. It can be enabled again with \protect\cs{numberlinetrue}. % +% \textbf{This feature must be used with caution.} +% \begin{itemize} +% \item It should not be use if you have critical footnotes after \cs{numberlinefalse}. +% \item It could be used in the following cases: +% \begin{itemize} +% \item You want only familiar footnotes, not critical footnotes; +% \item You want only parallel typesetting (using \parpackage) but no critical footnotes. +% \item You disable, for a portion of text, line numbering +% \end{itemize} +% \item It must not be used if: +% \begin{itemize} +% \item You just not want to have the line number in the margins, but want to use critical footnote. In this case, set \label{firstlinenum} to a big value, such as 100,000 (\reff{firstlinenum}). +% \item You want to freeze the line numbering for some line, but still keep critical footnotes. In this case, use \cs{startlock} (\reff{startlock}). +% \end{itemize} +% \end{itemize} +% A successor to \reledmac\ may disable this feature. % \subsubsection{Setting lineation start and step} -% \DescribeMacro{\firstlinenum} +% \DescribeMacro{\firstlinenum}\label{firstlinenum} % \DescribeMacro{\linenumincrement} % 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 successive numbered lines. For example, to start printing numbers at the first line % and to have every other line numbered: \\ % \verb?\firstlinenum{1} \linenumincrement{2}? % @@ -1128,7 +1145,7 @@ % The package's default setting is \\ % \verb"\linenummargin{left}" \\ % to typeset the numbers in the left hand margin. -% You can change this whenever you're not in the middle of +% You can change this whenever you're not in the middle of % making a paragraph. % % More precisely, the value of @@ -1178,7 +1195,7 @@ % \DescribeMacro{Xsublinesep} % \DescribeMacro{Xsublinesepside} % You can change the separator between the line number and the subline number either by using \cs{Xsublinesep} without any optional argument (\reff{Xsublinesep}) or by using \cs{Xsublinesepside}. In the second case, it will change the separator only for line numbers in the margins, not in the footnotes. -% \subsubsection{Locking lineation} +% \subsubsection{Locking lineation}\label{startlock} % \DescribeMacro{\startlock} % \DescribeMacro{\endlock} % The \protect\cs{startlock} command, used in running text, locks the @@ -1263,7 +1280,7 @@ % You may want to have two or more numbers associated with a line of text. % Consider, for example, the following cases: % \begin{itemize} -% \item You want to split a line of verse into two parts depending upon some stylistic / rythmic / linguistic convention. +% \item You want to split a line of verse into two parts depending upon some stylistic / rhythmic / linguistic convention. % \item You want to add the line number used by a previous edition of the work. % \item You want to typeset biblical text, and use division in verse. % \end{itemize} @@ -1278,7 +1295,7 @@ % The annotation can contain any textual value (whether number, text, or other) such as the line number from the older edition. % Here are some characteristics of line number annotation: % \begin{itemize} -% \item An annotation is associated with a line of text. It is reset with each new line of text, except if you use \option{noresetlinenumannotation} option of \macpackage. +% \item An annotation is associated with a line of text. It is reset with each new line of text, unless you use the \option{noresetlinenumannotation} option of \macpackage. % \item It is printed alongside the line number in the margin. % \item It is printed following the line number in critical footnotes and endnotes. % \item And of particular interest: the annotation is printed in the critical note \emph{only} when the \cs{edtext} is issued after the \cs{linenumannotation}. @@ -1306,7 +1323,7 @@ % % The \cs{linenum} (\reff{linenum}) macro changes the line number passed to a note. % \DescribeMacro{\lineannot}The \cs{lineannot} macro does the same for the annotations. -% It takes one argument, containing the beginnning and ending annotations separated by a pipe (\verb+|+). +% It takes one argument, containing the beginning and ending annotations separated by a pipe (\verb+|+). % As with \cs{linenum}, if one wishes to change some specific part of the annotation, one can use % \begin{verbatim} % \lineannot{|b}% to change the ending annotation @@ -1403,7 +1420,7 @@ % \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. +% 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. % % We call ``familiar notes'' notes which refer to a footnote mark in the main text. @@ -1436,7 +1453,7 @@ % For example: % \egstart % \begin{verbatim} -% I am happy : +% I am happy: % I saw my friend \edtext{Smith}{ % \Afootnote{Jones C, D.}} % on Tuesday. @@ -1446,7 +1463,7 @@ % \firstlinenum{1} % \linenumincrement{1} % \pstart -% I am happy : I saw my friend \edtext{Smith}{ +% I am happy: I saw my friend \edtext{Smith}{ % \Afootnote{Jones C, D.}} % on Tuesday. % \pend @@ -4267,7 +4284,7 @@ % \begin{macrocode} %<*code> \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{reledmac}[2019/03/03 v2.31.1 typesetting critical editions]% +\ProvidesPackage{reledmac}[2019/04/03 v2.31.2 typesetting critical editions]% % \end{macrocode} % % \subsection{Package options} @@ -11563,7 +11580,7 @@ % \subsection{Footnote hanging indent} % \begin{macro}{\Xsethangindent} % \begin{macro}{\sethangindentX} -% \cs{Xsethangindent} set the hangindent for a critical footnote, while \cs{sethangindentX} does it for a familiar footnote. +% \cs{Xsethangindent} sets the hangindent for a critical footnote, while \cs{sethangindentX} does it for a familiar footnote. % \begin{macrocode} \newcommand{\Xsethangindent}[1]{% \if@RTL% @@ -11694,7 +11711,7 @@ % \begin{macro}{\Xstorelineinfo} % The \cs{Xstorelineinfo} macro is used to store some data about line number of the current critical footnote, data which will be reused later for the \cs{Xnumberonlyfirstinline} and related setting. % -% \#1 footnote specification for the current footnote ; +% \#1 footnote specification for the current footnote; % \#2 footnote series. % \begin{macrocode} \newcommand{\Xstorelineinfo}[2]{% @@ -12099,7 +12116,7 @@ \iftoggle{Xnoidenticallinenumannotation@\@currentseries}{% \ifx\annot@start\annot@end% \let\@annot@end@print\relax% - \ifx\linenumrep\@gobble%Dont print the dash if we don't print the line number + \ifx\linenumrep\@gobble%Don't print the dash if we're not printing the line number \l@d@dashfalse% \fi% \fi% @@ -12259,8 +12276,8 @@ % \begin{macro}{\prepare@Xgroupbyline} % \cs{prepare@Xgroupbyline} is a macro called on the \cs{meta{XXX}vfootnote} if \cs{Xgroupbyline} is set to true, instead of calling \cs{insert} directly. % \#1 The series\\ -% \#2 The content of the footnote, that is also the line number indication\\ -% \#3 This macro which prepare the content of the insertion \\ +% \#2 The content of the footnote, which is also the line number indication\\ +% \#3 This macro, which prepares the contents of the insertion \\ % \begin{macrocode} \newcommand{\prepare@Xgroupbyline}[3]{% \iftoggle{Xgroupbylineseparetwolines@#1}{% @@ -12603,7 +12620,8 @@ \notbool{parapparatus@}{\newcommand*}{\newcommand}{\normalvfootnoteX}[2]{% \beforeinsertion@X{#1}% \insert\@nameuse{footins#1}\bgroup - \reset@font% + \fontseries{\seriesdefault}% + \fontshape{\shapedefault}% \hsize=\expandafter\dimexpr\csuse{widthX@#1}\relax% \noindent\csuse{bhooknoteX@#1}% \csuse{notefontsizeX@#1}% @@ -12814,7 +12832,7 @@ % \end{macro} % \begin{macro}{\vbfnoteX} % This command calls the correct footnote-inserting commands. -% \#1 footnote serie, \#2 footnote content, \#3 footnote counter, \#4 manuel footnote mark +% \#1 footnote series, \#2 footnote content, \#3 footnote counter, \#4 manual footnote mark % \begin{macrocode} \newcommand{\vbfnoteX}[4]{% \get@fnmarkX{#1}{#3}{#4}\relax% @@ -12825,7 +12843,7 @@ % % \begin{macro}{\get@fnmarkX} % This command gets the correct footnote number when typesetting parallel texts. -% \#1 footnote series, \#2 footnote counter, \#3 manuel footnote number +% \#1 footnote series, \#2 footnote counter, \#3 manual footnote number % \begin{macrocode} \newcommand{\get@fnmarkX}[3]{% \ifstrempty{#3}{% @@ -14126,7 +14144,7 @@ \iftoggle{Xendnoidenticallinenumannotation@\@currentseries}{% \ifx\annot@start\annot@end% \let\@annot@end@print\relax% - \ifx\linenumrep\@gobble%Dont print the dash if we don't print the line number + \ifx\linenumrep\@gobble%Don't print the dash if we're not printing the line number \l@d@dashfalse% \fi% \fi% @@ -14618,7 +14636,7 @@ \prepare@prenotesX{#1}% \newcommand{\content}{##2}% % \end{macrocode} -% If we use the \cs{csquotes} package, we reset the quotation level. +% If we are using the \cs{csquotes} package, we reset the quotation level. % \begin{macrocode} \ifdefined\csq@qlevel% \csq@qlevel=0\relax% @@ -14626,7 +14644,7 @@ % \end{macrocode} % If we are preparing parallel typesetting, we cannot just increase the footnote counter. % Read \parpackage's handbook about that (\reff{reledpar-familiarfootnotenumber}). -% If we have manual footnote mark, use it. +% If we have a manual footnote mark, use it. % \begin{macrocode} \global\expandafter\advance\csname footnote#1@reading\endcsname by \@ne% \ifstrempty{##1}{% @@ -14689,7 +14707,7 @@ % \begin{macrocode} \expandafter\gappto\expandafter\no@expands\expandafter{\expandafter\let\csname footnote#1\endcsname\@gobble}% % \end{macrocode} -% And now, define \cs{footnoteXmark} and \cs{footnoteXtext}, equivalent to classical\cs{footnotemark} and \cs{footnotetext}. +% And now, define \cs{footnoteXmark} and \cs{footnoteXtext}, equivalent to classical \cs{footnotemark} and \cs{footnotetext}. % \begin{macrocode} \expandafter\newcommand\csname footnote#1mark\endcsname{% \begingroup% @@ -14923,7 +14941,7 @@ % \end{macro} % \subsection{Test series order} % \begin{macro}{\ifseriesbefore} -% \protect\cs{ifseriesbefore}\marg{seriesA}\marg{seriesB}\marg{true}\marg{false} expands \meta{true} if \meta{seriesA} is printed before \meta{seriesB}, expands \meta{false} otherwise. +% \protect\cs{ifseriesbefore}\marg{seriesA}\marg{seriesB}\marg{true}\marg{false} expands to \meta{true} if \meta{seriesA} is printed before \meta{seriesB}, or to \meta{false} otherwise. % \begin{macrocode} \newcommand{\ifseriesbefore}[4]{% \StrPosition{\@series}{#1}[\@first]% @@ -15001,7 +15019,7 @@ % \end{macrocode} % \end{macro} % \begin{macro}{\setcommand@series} -% \protect\cs{setcommand@series}\marg{series}\marg{command}\marg{value} is a generic command to store hook's value into commands specific to some series. +% \protect\cs{setcommand@series}\marg{series}\marg{command}\marg{value} is a generic command to store a hook's value into commands specific to some series. % The arguments are: % \begin{itemize} % \item \verb+#1+ (mandatory): the series for which the hooks should be set. If empty, all the series will be affected. @@ -15323,7 +15341,7 @@ % \begin{macro}{\add@hooktoggle@specific@to@cs} % The \cs{add@hooktoggle@specific@to@cs} macro stores to a macro % all the current values of hook toggle specific to a command. -% It is useful for \cs{Xgroupbyline} option, which does not add immediately notes to the inserts list. +% It is useful for the \cs{Xgroupbyline} option, which does not immediately add notes to the inserts list. % It uses the \cs{hooktoggle@specific} list. % \begin{macrocode} \def\hooktoggle@specific{}% @@ -15417,7 +15435,7 @@ % \subsection{Extra footnotes output} % % With luck we might only have to change \protect\cs{@makecol} and -% \protect\cs{@reinserts} of the \LaTeX's kernel. +% \protect\cs{@reinserts} of \LaTeX's kernel. % Since \reledmac, we use \protect\package{etoolbox}'s patching commands instead of overriding. % It should provides better compatibility with other package which modify these commands @@ -15523,7 +15541,7 @@ % % % \begin{macro}{\l@ddodoreinxtrafeet} -% \protect\cs{l@ddodoreinxtrafeet} is the code for catering for the extra footnotes +% \protect\cs{l@ddodoreinxtrafeet} is the code catering for the extra footnotes % within \protect\cs{@reinserts}. % We use the same category and ordering as in \protect\cs{l@ddoxtrafeet}. % \changes{v0.2.1}{203/09/13}{Renamed \protect\cs{dodoreinxtrafeet} to \protect\cs{l@ddodoreinxtrafeet}} @@ -15584,7 +15602,7 @@ \csuse{footgroup#1}{#1}% }% % \end{macrocode} -% We print all the series of notes by looping on them. +% We print all the series of notes by looping over them. % We check before printing them that they are not voided. % \begin{macrocode} \newcommand*{\do@feetX}{% @@ -15644,7 +15662,7 @@ % \end{macrocode} % \protect\ltxclass{memoir} has not been loaded, so patch \protect\cs{@makecol} and % \protect\cs{@reinserts}. -% If the \package{fancyhdr} package $<$ version 3.8 has been loaded, we patch the \cs{latex@makecol} command, because this package redefines the standard \cs{@makecol} in the preamble, to call \cs{latex@makecol} which have been \cs{let} to \cs{@makecol}. +% If the \package{fancyhdr} package $<$ version 3.8 has been loaded, we patch the \cs{latex@makecol} command, because this package redefines the standard \cs{@makecol} in the preamble to call \cs{latex@makecol}, which has been \cs{let} to \cs{@makecol}. % If this package is not loaded, we directly patch \cs{@makecol}. % If the \package{fancyhdr} package $\geq$ version 3.8, we also directly patch \cs{@makecol}, because \package{fancyhdr} does its own patch \cs{AtBeginDocument}. % \begin{macrocode} @@ -15692,7 +15710,7 @@ % \begin{macrocode} \@ifclassloaded{memoir}{% % \end{macrocode} -% If the \protect\ltxclass{memoir} class is loaded we hook into its modified +% If the \protect\ltxclass{memoir} class is loaded, we hook into its modified % \verb?\@doclearpage?. % \begin{macro}{\@mem@extranofeet} % \begin{macrocode} @@ -15993,7 +16011,7 @@ % \changes{v1.4.1}{2012/11/16}{Fix a bug with \protect\cs{edlabel}.} %In cases where \protect\cs{edlabel} is the first element in a paragraph, we have a problem with line counts, because line counts change only at the first horizontal box of the paragraph. %Hence, we need to test \protect\cs{edlabel} if it occurs at the start of a paragraph. To do so, we use \protect\cs{ifvmode}. If the test is true, we must advance by one unit the amount of text we write into the \verb].aux] file. -% We do so using \protect\cs{advancelabel@refs} command. +% We do so with the \protect\cs{advancelabel@refs} command. % \begin{macrocode} \newcounter{line}% \newcounter{subline}% @@ -16114,7 +16132,7 @@ \expandafter\l@dp@rsefootspec\l@d@nums|% \expandafter\parse@annot\l@current@annot|% % \end{macrocode} -% Use the \LaTeX\ standard hack for label. +% Use the \LaTeX\ standard hack for label. % \begin{macrocode} \@bsphack% % \end{macrocode} @@ -21248,15 +21266,15 @@ % \section{Things to do when changing versions} % \input{doc-include/migrate-mac.dtx} % \section{Auxiliary softwares} -% This appendix list some softwares and tools related to \package{reledmac} at that may be useful. +% This appendix lists some software and tools related to \package{reledmac} that may be useful. % \subsection{\emph{samewords}} -% The \emph{samewords} software (Michael Stenskjær Christensen) automatically add \cs{sameword} commands (\reff{sameword}) into a \verb+.tex+ file. \\ +% The \emph{samewords} program (Michael Stenskjær Christensen) automatically adds \cs{sameword} commands (\reff{sameword}) into a \verb+.tex+ file. \\ % \url{https://samewords.readthedocs.io/en/latest/} % \subsection{critical-keys for \emph{Emacs}} % The \emph{Emacs} editor has a package to help inserting \macpackage's commands (Juan Manuel Macías Chaín).\\ % \url{https://gitlab.com/maciaschain/critical-keys} % \subsection{Import from TEI} -% There is multiple tools to convert from XML-TEI to \emph{reledmac}. Here a non exhaustive-list: +% There are multiple tools to convert from XML-TEI to \emph{reledmac}. Here is a non exhaustive-list: % \begin{itemize} % \item \url{http://ciham-digital.huma-num.fr/teicat/} % \item \url{https://github.com/fizzbucket/tei_transformer} @@ -21264,7 +21282,7 @@ % \item \url{http://lombardpress.org/print/} % \item \url{https://github.com/Jean-Baptiste-Camps/TEItoLaTeX} % \end{itemize} -% Please, tell us if you know any other tool. +% Please, tell us if you know of other tools. % \clearpage % \bibliographystyle{alpha} % \phantomsection |