summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/eledform
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-08-13 20:54:49 +0000
committerKarl Berry <karl@freefriends.org>2015-08-13 20:54:49 +0000
commit272f9f80e4e03897b37395e0adcefca25172e369 (patch)
tree3182dcbd5c1b3d42b3ed4508b6141e6b157b9ad8 /Master/texmf-dist/source/latex/eledform
parent14585fc11067ea471ce99987e51177c873254522 (diff)
eledform (13aug15)
git-svn-id: svn://tug.org/texlive/trunk@38114 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/eledform')
-rw-r--r--Master/texmf-dist/source/latex/eledform/eledform.dtx133
1 files changed, 87 insertions, 46 deletions
diff --git a/Master/texmf-dist/source/latex/eledform/eledform.dtx b/Master/texmf-dist/source/latex/eledform/eledform.dtx
index 40fbe558304..31114fc74db 100644
--- a/Master/texmf-dist/source/latex/eledform/eledform.dtx
+++ b/Master/texmf-dist/source/latex/eledform/eledform.dtx
@@ -11,7 +11,7 @@
%
% and version 1.3 or later is part of all distributions of
% LaTeX version 2003/06/01 or later.
-% This work has the LPPL maintenance status "maintained".
+% This work has the LPPL maintenance status "unmaintained".
%
% \fi
@@ -20,7 +20,8 @@
\documentclass{ltxdoc}
\usepackage{polyglossia,csquotes}
\setmainlanguage{english}
-\usepackage{eledmac,eledform,tikz,tikz-qtree}
+\usepackage[noreledmac]{eledmac}
+\usepackage{eledform,tikz,tikz-qtree}
\usepackage{hyperref}
\EnableCrossrefs
\CodelineIndex
@@ -30,7 +31,7 @@
\end{document}
%</driver>
% \fi
-% \CheckSum{82}
+% \CheckSum{106}
% \CharacterTable
% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
@@ -47,7 +48,9 @@
% Grave accent \` Left brace \{ Vertical bar \|
% Right brace \} Tilde \~}
%
-% \changes{v1.0}{2012/10/01}{First public release}
+% \changes{v1.0}{2012/10/01}{First public release.}
+% \changes{v1.1}{2012/10/08}{News options to change the order of the elements.}
+% \changes{v1.1a}{2015/13/08}{Package unmaintened.}
% \GetFileInfo{eledform.sty}
%\DoNotIndex{\csgdef,\if,\fi,\else,\listgadd}
%
@@ -55,6 +58,9 @@
% \author{Maïeul Rouquette \\ maieul at maieul dot net}
% \date{\fileversion\space\filedate}
% \maketitle
+% \textbf{This package is unmaintened.
+% Maïeul Rouquette has no more time to maintain it.
+% }
% \begin{abstract}
% The \emph{eledmac} package provides tools to make critical editions of texts.
% But it doesn't provide any formalism to note the textual variants: each user has to make his own formalism.
@@ -70,78 +76,85 @@
% \item One text, with fives manuscripts: P, A, B, C, D.
% P is the manuscript which is used as reference.
% Variants in A, B, C, D are shown in the apparatus.
-% \item The pseudo-word \enquote{lorem} has these variants :
-% \begin{description}
-% \item[A and B]the word is omitted.
-% \item[C]the word is replaced by \enquote{loram}.
-% \item[D]the word is replaced by \enquote{lorim}.
-% \end{description}
+% \item The pseudo-word \enquote{lorem} has these variants:
+% \begin{description}
+% \item[A and B]the word is omitted.
+% \item[C]the word is replaced by \enquote{loram}.
+% \item[D]the word is replaced by \enquote{lorim}.
+% \end{description}
% \end{enumerate}
-% Without formalism, you could write :
+% Without formalism, you could write:
% \begin{verbatim}
-% \edtext{lorem}{\Afootnote{AB \emph{omit} ; C loram ; D lorim}}
+% \edtext{lorem}{\Afootnote{AB \emph{omit}; C loram; D lorim}}
% \end{verbatim}
-% Which produces in the critical notes:
+% Which produces this critical note:
% \begin{quote}
-% lorem] AB omit ; C loram ; D lorim
+% lorem] AB omit; C loram; D lorim
% \end{quote}
-% There is some limits with this method:
+% There are some limits for this method:
% \begin{itemize}
% \item If we want to change display, we must changes all notes.
% \item We can't produce statistics.
% \item Difficulty to export in other format than \LaTeX.
-% \item No method to check if we don't make mistake about manuscript.
+% \item No method to check if we're making mistakes regarding to the manuscripts.
% \end{itemize}
% \subsubsection{With formalism}
-% To describe the same thing, we propose this formalism :
+% To describe the same situation, we propose this formalism :
% \begin{verbatim}
%\var{lorem}{A,B}{
%{{C}{loram}},
%{{D}{lorim}}
%}
% \end{verbatim}
-% With \emph{eledform}, this will produce the same thing that the non-formalised form,
-% but without described inconveniences.
-% You could see example in the file \href{example.tex}{example.tex}, which produces \href{example.pdf}{example.pdf}.
+% With \emph{eledform}, this will produce the same result as the non-formalised form,
+% but without the described inconveniences.
+% You can see an example in the file \href{example.tex}{example.tex}, which produces \href{example.pdf}{example.pdf}.
% \subsection{References}
% \subsubsection{Declare the manuscripts}
% \DescribeMacro{\manuscripts}
-% You must use \cs{Manuscripts}\marg{list}
-% to provide to \LaTeX\space the list of manuscripts used in the apparatus.
-% \LaTeX\ prints a warning message in the log file if you describe a variant
-% inside a manuscript which does'nt exist.
-% It also prints an error in the PDF.
+% You have to use \cs{Manuscripts}\marg{list}
+% to provide the list of manuscripts used in the apparatus.
+% \LaTeX\ prints a warning message in the log file if you're referring to a
+% manuscript that is not declared before.
+% It also prints an error in the resulting file.
% The list of manuscripts is a comma separated list:
% \begin{verbatim}
% \manuscripts{A,B,C,D}
% \end{verbatim}
% \subsubsection{Declare variants}
-% \DescribeMacro{\varseries}
-%
+% \DescribeMacro{\var}
% The main macro is \cs{var}\oarg{short}\marg{lemma}\marg{del}\marg{variants}\oarg{other}.
% This macro takes five arguments, two are optional.
% \begin{description}
% \item[\meta{short} (optional)]an abbreviated version of the lemma for the notes.
% \item[\meta{lemma}]the lemma which has variants.
% \item[\meta{del}]a comma separated list of manuscripts where the lemma is ommited.
-% \item[\meta{variants}]a comma separated list of variants. Each variant has the form \marg{manuscripts}\marg{variant}, where:
-% \begin{description}
-% \item[\meta{manuscripts}]a comma separated list of manuscripts where the variant is.
-% \item[\meta{variant}]the variant itself.
-% \end{description}
+% \item[\meta{variants}]a comma separated list of variants. Each variant has the form \verb+{+\marg{manuscripts}\marg{variant}\verb+}+, where:
+% \begin{description}
+% \item[\meta{manuscripts}]a comma separated list of manuscripts where the variant is.
+% \item[\meta{variant}]the variant itself.
+% \end{description}
% \item[\meta{other}(optional)]other code linked to the lemma, for example a call to an critical footnote.
% \end{description}
% \subsubsection{Customize}
+% \DescribeMacro{\manposition}
+% By default (since v1.1), the manuscripts are printed after the variant.
+% With \cs{manposition}\marg{position}, where position is any text except \verb+last+, you can change it.
+%
+% \DescribeMacro{\omitposition}
+% By default, the omission are printed at the begining of the variants.
+% With \cs{omitposition}\marg{position}, where position is any text except \verb+first+, you can change it.
+%
% \DescribeMacro{\varseries}
% By default, the notes for textual variants are printed in the A series of footnotes.
% With \cs{varseries}\marg{letter}, you can change it.
%
% \DescribeMacro{\omittext}
-% When a manuscript omit a lemma, \emph{eledform} print \verb|\emph{omit}|.
+% When a manuscript omits a lemma, \emph{eledform} prints \verb|\emph{omit}|.
% You can change it with \cs{omittext}\marg{text}.
%
% \DescribeMacro{\manvarseparator}
-% By default, a non breakable space is printed between the manuscript and the variant.
+% By default, a non breakable space is printed between the manuscript letter and the variant.
% You can change it with \cs{manvarseparator}\marg{separator}.
%
% \DescribeMacro{\varseparator}
@@ -151,7 +164,7 @@
% \section{Implementation}
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{eledform}[2012/10/01 v1.0 formalism for eledmac]
+\ProvidesPackage{eledform}[2015/08/13 v1.1a formalism for eledmac]
\RequirePackage{eledmac}
% \end{macrocode}
% \subsection{Define manuscripts}
@@ -189,23 +202,41 @@
% \begin{macrocode}
\varnote@{%
% \end{macrocode}
+% In the case where the manuscripts with omission must be printed in first position.
+% \begin{macrocode}
+ \ifdefstring{\omitposition@}{first}{
+% \end{macrocode}
% If the third argument is not empty, we call the \cs{del@} macro, which print the manuscript where the lemma is omitted
%  \begin{macrocode}
\ifstrempty{#3}{}%
- {\del@{#3}%
+ {\del@{#3}%
% \end{macrocode}
% If the third and fourth argument are both not empty, we print the separator between variants.
% \begin{macrocode}
- \ifstrempty{#4}%
- {}%
- {\varseparator@}%
- }%
+ \ifstrempty{#4}%
+ {}%
+ {\varseparator@}%
+ }%
% \end{macrocode}
% And so, we print all the variants which are not an omission.
% \begin{macrocode}
- \var@{#4}%
- }%
+ \var@{#4}%
% \end{macrocode}
+% The same thing, but if the manuscripts with omission must be printed in last position.
+% \begin{macrocode}
+ }%
+ {%
+ \ifstrempty{#4}%
+ {}%
+ {\var@{#4}%
+ \ifstrempty{#3}%
+ {}%
+ {\varseparator@}%
+ }%
+ \ifstrempty{#3}{}{\del@{#3}}%
+ }%
+ }%
+% \end{macrocode}
% Eventually, we add the critical notes which are not for textual criticism.
% \begin{macrocode}
#5%
@@ -219,7 +250,7 @@
\newcommand{\print@manuscript}[1]{%
\ifinlist{#1}{\manuscripts@}%
{#1}%
- {\eledmac@warning{Unknew man. #1, p.\the\page@num ; l.\the\line@num}\underline{unknew man. #1}}%
+ {\eledmac@warning{Manuscript #1 not declared, p.\the\page@num ; l.\the\line@num}\underline{Manuscript #1 not declared!}}%
}
% \end{macrocode}
% \end{macro}
@@ -231,7 +262,9 @@
\renewcommand{\do}[1]{%
\print@manuscript{##1}%
}%
- \docsvlist{#1}\manvarseparator@\omittext@%
+ \ifdefstring{\manposition@}{last}%
+ {\omittext@\manvarseparator@\docsvlist{#1}}%
+ {\docsvlist{#1}\manvarseparator@\omittext@}%
}
% \end{macrocode}
% \end{macro}
@@ -255,7 +288,9 @@
\renewcommand{\do}[1]{%
\print@manuscript{##1}%
}%
- \docsvlist{#1}\manvarseparator@#2%
+ \ifdefstring{\manposition@}{last}%
+ {#2\manvarseparator@\docsvlist{#1}}%
+ {\docsvlist{#1}\manvarseparator@#2}%
}
% \end{macrocode}
% \end{macro}
@@ -292,7 +327,11 @@
% \begin{macro}{\omittext}
% \begin{macro}{\manvarseparator}
% \begin{macro}{\varseparator}
+% \begin{macro}{\manposition}
+% \begin{macro}{\omitposition}
% \begin{macrocode}
+\new@eledform@custom{omitposition}{first}
+\new@eledform@custom{manposition}{last}
\new@eledform@custom{omittext}{\emph{omit}}
\new@eledform@custom{manvarseparator}{~}
\new@eledform@custom{varseparator}{\space}
@@ -300,6 +339,8 @@
% \end{macro}
% \end{macro}
% \end{macro}
+% \end{macro}
+% \end{macro}
% \subsection{Stemma of the code}
% The next figure is a stemma of the code.
%
@@ -310,4 +351,4 @@
% \addcontentsline{toc}{section}{Index}
% \PrintIndex
% \Finale
-\endinput \ No newline at end of file
+\endinput