From fb16db91198c4ad4ddc4267ba7ae4d16ce94c56f Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 29 Apr 2008 17:21:56 +0000 Subject: edmargin update (28apr08) git-svn-id: svn://tug.org/texlive/trunk@7723 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/source/latex/edmargin/edmargin.dtx | 113 +++++++++++---------- 1 file changed, 57 insertions(+), 56 deletions(-) (limited to 'Master/texmf-dist/source/latex/edmargin') diff --git a/Master/texmf-dist/source/latex/edmargin/edmargin.dtx b/Master/texmf-dist/source/latex/edmargin/edmargin.dtx index 3a0175895a0..df6564c9ab1 100644 --- a/Master/texmf-dist/source/latex/edmargin/edmargin.dtx +++ b/Master/texmf-dist/source/latex/edmargin/edmargin.dtx @@ -18,7 +18,7 @@ % \iffalse %\NeedsTeXFormat{LaTeX2e}[1997/12/01] %\ProvidesPackage{edmargin} -% [2008/04/14 v1.01 edmargin file] +% [2008/04/14 v1.02 edmargin file] % %<*driver> \documentclass{ltxdoc} @@ -54,6 +54,8 @@ % \changes{v1.0}{2008/04/21}{Initial version} % \changes{v1.01}{2008/04/23}{Bug fix in macro for defining new % endnote kinds.} +% \changes{v1.02}{2008/04/28}{Corrections to manual.} + % \GetFileInfo{edmargin.sty} % % \DoNotIndex{\newcommand,\newenvironment,\def,\edef,\else,\renewcommand,\makeatletter,\makeatother} @@ -89,9 +91,9 @@ % \textsc, \unskip} % \setcounter{IndexColumns}{2} % \MakeShortVerb{|} -% \def\fileversion{1.01} -% \def\filedate{23 April 2008} -% \def\docdate{23 April 2008} +% \def\fileversion{1.02} +% \def\filedate{28 April 2008} +% \def\docdate{28 April 2008} % \title{\textsf{Edmargin:} A Simple Design for Critical Editions with Multiple Endnote Series\thanks{This document % corresponds to \textsf{edmargin}~\fileversion, dated \filedate.}} % \author{John Burt \\ \texttt{burt@brandeis.edu}} @@ -115,10 +117,7 @@ % prose text or verse lines in poetry. Some editions of prose works % enumerate sentences and paragraphs rather than lines, as the Bible % does. All of these systems involve considerable amounts of -% laborious markup. And attaching line numbers to prose involves -% doing things which might make other tasks in \LaTeX\ more -% difficult, such as writing the text to a box and peeling off one -% line at a time. \textsf{edmargin} provides a different system of +% laborious markup. \textsf{edmargin} provides a different system of % annotation which minimizes markup, and also minimizes the % possibilities of conflicts among commands. In the text, instead of % placing a marker, or remembering the line or sentence number, @@ -126,8 +125,8 @@ % instance ``c'' for a commentary, ``t'' for a textual note, or ``e'' % for an emendation) followed by the page number in the relevant % endnotes section to which the note refers. So, for instance, if on -% page 42 of my text I have the anchor for a textual note which -% appears on page 563 of the endnotes section for textual notes, +% page 42 of my text I have the anchor for an explanatory note which +% appears on page 563 of the endnotes section for explanatory notes, % \textsf{edmargin} would put \emph{c: p.~563} in the margin on page % 42 of the line where that note occurs, and the text of the note % would appear on p.~563, with a reference to the page in the text to @@ -142,13 +141,14 @@ % the traditional schemes, does provide the information a critical % edition requires, and should be easy for readers to use, provided % that there are not many notes on every line. The scheme is modelled -% on that used by David Erdman and Harold Bloom in their edition of -% the Collected Poetry and Prose of William Blake. \textsf{edmargin} +% on that used by David V. Erdman and Harold Bloom in their edition of +% \emph{The Complete Poetry and Prose of William Blake}. \textsf{edmargin} % can also make notes with markers in the text, in the traditional % fashion. % -% \textsf{edmargin} requires the following packages to work correctly: -% with the standard document classes, or the komascript classes: +% +% With the standard document classes, or the komascript classes, +% \textsf{edmargin} requires the following packages to work correctly: % \textsf{fancyhdr}, % \textsf{ifthen} (for comparing page numbers), \textsf{needspace} (to % prevent widowed chapter titles in notes sections when resetting @@ -166,13 +166,13 @@ % With \textsf{memoir} class, \textsf{edmargin} requires fewer % packages, since many of the package functions are built into % \textsf{memoir} and some, \textsf{fancyhdr} most especially, -% conflict with it. Minimally, you will need \textsf{endnotes} and +% conflict with it. Minimally, you will need % \textsf{ifthen}. You might wish to call \textsf{memoir} with the % oldfontcommands option. % % \section{Setup} \DescribeMacro{\setupendnoteheaders} -% |\setupendnoteheaders| opens an external file to receive each of the -% three preset kinds of endnote. \textsf{edmargin} opens external +% |\setupendnoteheaders| opens an external channel to receive each of the +% three preset kinds of endnote, opening external % files for emendations, textual collations, and explanatory notes % (with extensions .emd, .ent, and .enx respectively). Then it sets % the first page of each notes section to the |empty| pagestyle, since @@ -181,7 +181,7 @@ % a running header of the form ``Notes to pages xx--yy.'' This text % will appear in the center of each header. It also writes % information to the external file which will send information to the -% table of contents when the external file is read back into your +% table of contents when the external file for the endnotes section is read back into your % document. Each note written to the file increments a counter that % keeps track of all the endnotes (even if you are resetting the % number by chapter). \textsf{edmargin} creates two labels and two @@ -189,33 +189,32 @@ % main text \emph{from} which a note comes, and a label and a pageref % for each page in the notes sections \emph{upon} which the note is % written. Finally \textsf{edmargin} writes on the external file for -% the endnotes a command to set the |\mark| for that page of the -% endnotes using the |\pageref| to the label in the main text it has -% just defined. +% the endnotes a command to update the running header for that page of the +% endnotes to be sure that it correctly reflects the pages in the +% main text from which the notes are drawn. % % \DescribeMacro{\makeemendations} \DescribeMacro{\maketextnotes} % \DescribeMacro{\makeexplanatorynotes} You can use these commands % individually to set up the predefined classes of endnote, rather -% than using |\setupendnoteheaders| to have \textsf{edmargin} put all of the -% emendations, textual collations, and explanatory notes in the -% backmatter of your volume. (This would be useful if you are not +% than using |\setupendnoteheaders| to have \textsf{edmargin} put all three classes +% of notes in the backmatter of your volume. (This would be useful if you are not % intending to make use of all three classes of note.) % \DescribeMacro{\putemendations} \DescribeMacro{\puttextnotes} % \DescribeMacro{\putexplanatory} |\puttextnotes|, |\putexplanatory|, % or |\putemendation| read the external files back into your document % at the place you specify. Remember that these commands change the -% running header, so if any sections follow these (the bibliography, -% for instance) be sure to restore your prevailing headings style by +% page style, so if any sections that do not use the same type of running +% header follow these sections (the bibliography, +% for instance), be sure to restore your prevailing headings style by % issuing, for example, |\pagestyle{headings}| % |\thispagestyle{empty}|. % % % \DescribeMacro{\notesbychapter} |\notesbychapter| -% % resets all the note -% % counter every time you issue a |\chapter| command, and it +% resets the note counters for each kind of endnote and % puts a centered line reading ``Chapter \textless\emph{chapter -% number}\textgreater ~ \textless\emph{chapter title}\textgreater'' in +% number}\textgreater : ~ \textless\emph{chapter title}\textgreater'' in % each of the three predefined sections of the the notes whenever % |\chapter| is issued. If you want only the chapter number, not its % title, issue |\titleinnotesfalse| in your preamble. Please note @@ -240,9 +239,9 @@ % |\setstyleforchapternotebegin{\bf}| in your preamble. (It's safe, % indeed required, to use the old style font commands here, since the % chapter title line in the notes is confined to a group, which -% restricts the scope of the font style command to the line. If you are +% restricts the scope of the font style command to the line.) If you are % using \textsf{memoir} class, you should use the oldfontcommands option if you -% plan on issuing |\setstyleforchapternotebegin| and |\setstyleforchapternoteend|.) +% plan on issuing |\setstyleforchapternotebegin| and |\setstyleforchapternoteend|. % Remember that if you open an environment with % |\setstyleforchapternotebegin| you must close it in % |\setstyleforchapternoteend|. So, for instance, if you wish the @@ -258,7 +257,7 @@ % there may be a chapter without endnotes, in which case % |\notesbychapter| would issue the centered line for that chapter, % but no notes would follow, which is ugly. Also, since the -% Bibliography is, as far as \LaTeX\ is concerned, a chapter, you must +% Bibliography is, as far as memoir class is concerned, a chapter, you must % use |\resetendnotes| before each chapter rather issuing % |\notesbychapter| in the preamble if you have a bibliography, or odd % results will follow. @@ -271,42 +270,43 @@ % \section{Predefined Endnote Sections} % \textsf{edmargin} comes with three predefined endnotes sections and % three predefined kinds of endnote, |\textnote{}|, |\emendation{}|, -% and |\explanatory{}|. The argument of each note can be whatever you +% and |\explanatory{}|. +% +% +% \DescribeMacro{\textnote} \DescribeMacro{\explanatory} +% \DescribeMacro{\emendation} Use |\textnote| and its siblings as you +% would use an ordinary |\endnote|. The argument of each note can be whatever you % wish, but for clarity it is a good idea to use as a lemma from the % text, since that will make the passage the note refers to clear. % For example: |\textnote{lemma] comment}|. % +% \DescribeMacro{\literaltextnote} \DescribeMacro{\literalemendation} +% \DescribeMacro{\literalexplanatory} |\literaltextnote| and its +% siblings are useful for sending information directly to the +% endnotes section to which the command refers. All of these commands +% send unexpanded text to the endnote sections, so you use this command +% to send to the endnote sections commands which will be executed when the endnote section is +% read back into your document. You can send expanded text using +% |\immediate\write\textnotes| and its siblings. +% % \DescribeMacro{\notesincontents} If you do not wish to include a % line for the endnotes in the table of contents, issue -% |\notesincontentsonfalse| (This is the default). To include a line +% |\notesincontentsonfalse|. (This is the default). To include a line % for the endnotes in the table of contents, issue |\notesincontents| % or (toggling the boolean) |\notesincontentsontrue|. If you wish to -% rethink how to present the notes in the table of contents, include -% an |\addtocontents| line just before you issue |\theendnotes|, the +% rethink how to present the notes in the table of contents, rather than +% issuing |\notesincontents| include +% an |\addtocontents| line in the main text just before you issue |\puttextnotes| or its siblings, the % command which will read all of your endnotes into your document at -% that point. For instance, I set the word ``Textual Notes'' in the +% that point. For instance, |\notesincontents| sets the word ``Textual Notes'' in the % table of contents flush with the left margin, just where the numbers % in the preceding chapters are. You might, however, wish to indent % that word just a bit, so that it will be flush with the chapter % titles above, rather than with the chapter numbers. If you wish to -% do this, just before issuing |\theendnotes|, issue +% do this, just before issuing |\puttextnotes|, issue % |\addcontentsline{toc}{chapter}{\protect\numberline{}\the\textnotescontentsname}|. -% -% \DescribeMacro{\textnote} \DescribeMacro{\explanatory} -% \DescribeMacro{\emendation} Use |\textnote| and its siblings as you -% would use an ordinary |\endnote|. If you are using a lemma, you -% must include it in the text of -% the note: |\textnote{lemma text] comment}|. -% -% \DescribeMacro{\literaltextnote} \DescribeMacro{\literalemendation} -% \DescribeMacro{\literalexplanatory} |\literaltextnote| and its -% siblings are useful for sending information directly to the -% endnotes section to which the command refers. All of these commands -% send unexpanded text to the endnote sections, so you can feel free -% to send this way to the endnote sections commands this way to the -% endnote sections which will be executed when the endnote section is -% read back into your document. You can send expanded text using -% |\immediate\write\textnotes| and its siblings. +% Use a similar line for the other endnotes sections, replacing |\textnotescontentsname| +% with |\emendationscontentsname| or |\explanationscontentsname| as the case may be. % % \section{Creating New Endnote Sections} % \DescribeMacro{\definenewnotetype} You can create as many new kinds @@ -416,7 +416,7 @@ % \textsf{edmargin} can be set to put regular endnote markers in the % text and in the endnote sections. The different series of endnotes % will be distinguished by using the same abbrevations that were used -% I the case in which marginal references were used. So, for +% for marginal references. So, for % instance, the third textual note will have a mark that looks % ``t:3'' both in the text and in the textual notes section, and the % fifth explanatory note will have a mark that ``c:5'' both in the @@ -426,6 +426,7 @@ % markers in the margin is the default, but you can make sure that % they go there by issuing |\notemarkinmargin|. % +% \begin{sloppypar} % \DescribeMacro{\textnotesparamode} % \DescribeMacro{\emendationsparamode} % \DescribeMacro{\explanationsparamode} If you wish to print your @@ -435,7 +436,7 @@ % |\definenewnotetype| to define a note type called |\xyznote|, you % can set these notes in block paragraphs by issuing % |\xyznotesparamode|. You might consider setting your notes in block -% paragraphs if you have very many very short notes. +% paragraphs if you have very many very short notes. \end{sloppypar} % % \section{Known Issues} Because the marginal references are set with % |\marginpar| some of them will appear on the wrong side in -- cgit v1.2.3