From 162519496ac907f55274039075bcb7dc7f75cc8b Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Wed, 24 Jan 2018 21:51:12 +0000 Subject: poemscol (24jan18) git-svn-id: svn://tug.org/texlive/trunk@46433 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/poemscol/poemscol.pdf | Bin 647029 -> 654487 bytes .../texmf-dist/source/latex/poemscol/poemscol.dtx | 621 +++++++++++++-------- Master/texmf-dist/tex/latex/poemscol/poemscol.sty | 5 +- 3 files changed, 400 insertions(+), 226 deletions(-) (limited to 'Master/texmf-dist') diff --git a/Master/texmf-dist/doc/latex/poemscol/poemscol.pdf b/Master/texmf-dist/doc/latex/poemscol/poemscol.pdf index 31370ac9588..d2aa3870609 100644 Binary files a/Master/texmf-dist/doc/latex/poemscol/poemscol.pdf and b/Master/texmf-dist/doc/latex/poemscol/poemscol.pdf differ diff --git a/Master/texmf-dist/source/latex/poemscol/poemscol.dtx b/Master/texmf-dist/source/latex/poemscol/poemscol.dtx index d2fb0bf84cb..09f5a51ed4d 100644 --- a/Master/texmf-dist/source/latex/poemscol/poemscol.dtx +++ b/Master/texmf-dist/source/latex/poemscol/poemscol.dtx @@ -19,7 +19,7 @@ % \iffalse %\NeedsTeXFormat{LaTeX2e}[1997/12/01] %\ProvidesPackage{poemscol} -% [2018/01/05 v2.97 poemscol file] +% [2018/01/11 v2.98 poemscol file] % %<*driver> \documentclass{ltxdoc} @@ -232,6 +232,7 @@ % towards the center when titles are centered. Easier customization of epigraphs and similar things.} % \changes{v2.97}{2018/01/05}{Correction to JHepigraphs. Epigraphenvironment for % headnotes with more than one stanza or paragraph. Corrections to manual.} +% \changes{v2.98}{2018/01/11}{Corrections to manual.} % \DoNotIndex{\newcommand,\newenvironment,\def,\edef,\else,\renewcommand,\makeatletter,\makeatother} % \DoNotIndex{\abovedisplayskip,\belowdisplayskip,\abovedisplayshortskip,\belowdisplayshortskip} % \DoNotIndex{\newcommand, \section, \subsection, \subsubsection, @@ -264,15 +265,15 @@ % \textsc, \unskip} % \setcounter{IndexColumns}{2} % \MakeShortVerb{|} -% \def\fileversion{2.97} -% \def\filedate{5 January 2018} -% \def\docdate{5 January 2018} +% \def\fileversion{2.98} +% \def\filedate{11 January 2018} +% \def\docdate{11 January 2018} % \title{Typesetting Poetry Collections with % \textsf{poemscol}\thanks{This document corresponds to % \textsf{poemscol}~\fileversion, dated \filedate.}} % \author{John Burt % \\ \texttt{burt@brandeis.edu}} -% \date{5 January 2018} +% \date{11 January 2018} % \maketitle % \begin{abstract} \textsf{poemscol} provides commands for \LaTeX\ for % setting collections of poetry. It is especially suited for setting @@ -434,13 +435,16 @@ % series of global search-and-replaces, and could conceivably be done % with a perl script. % -% This is a long manual, but there is no read to study it all before beginning. +% This is a long manual, but there is no need to study it all before beginning. % In the first place, it includes all the commented-on source code for the % package, which will only matter to you if you are planning to customize % it in some way I didn't anticipate, or if you need to know how the commands % work internally. (The code section begins on page \pageref{implementation}.) % The most important commands are explained in the first 30 pages, and even there -% many sections discuss things you may not need to know immediately. +% many sections discuss things you may not need to know immediately. Also, +% many sections conclude with a subsection which suggests ways of customizing +% the output, usually giving suggestions in increasing order of difficulty. You'll +% have to be the judge of what to skip the first time through. % % \section{Dependencies and compatibility with other packages} % @@ -649,6 +653,7 @@ % either |\setlength| or |\renewcommand| (depending upon what you are % changing). % +% \subsubsection{Customization of titles} % \DescribeMacro{\centertitles} By default, titles place at or near (depending on the kind % of title) the left margin. To center all titles, issue |\centertitles|. If you have multi-line % titles, |\centertitles| will center each line. |\centertitles| also moves in epigraphs, headnotes, @@ -667,11 +672,14 @@ % your preamble. There are similar commands to set the font size and leading for % the titles of poetic sequences, % sequence sections, titles of volumes, and so on. +% You can find a complete list of those font parameters at section \ref{internal font size commands}, +% page \pageref{internal font size commands}. +% % |\poemtitlefont| and its siblings do not change the -% default font family. To change the default font family to, say, Times Roman, or +% default typeface. To change the default typeface to, say, Times Roman, or % Tex Gyre Pagella, use the commands \LaTeX\ % or Xe\LaTeX\ provide for that purpose (e.g.\ |\usepackage{tgpagella}|). Changing the default -% font family is probably something you would want +% typeface is probably something you would want % to do globally, not at the level of classes of title, anyway. %\end{sloppypar} % @@ -680,6 +688,8 @@ % for poem titles in the table of contents. There are similar commands for each of the % other kinds of titles in the table of contents. They can be changed just as the font % parameters for titles in the main text are changed, using |\renewcommand|. +% You can find a complete list of those font parameters at section \ref{internal font size commands}, +% page \pageref{internal font size commands}. % % \begin{sloppypar} % \DescribeMacro{\afterpoemtitleskip} @@ -689,7 +699,8 @@ % issue |\renewcommand{\afterpoemtitleskip}{\medskip}| in your preamble. % |\afterpoemskip| sets the vertical separation between the end of a % poem and the title of the next poem. ``Skips'' for other kinds of title can be -% changed the same way. \end{sloppypar} +% changed the same way. You can find a complete list of these skips at +% section \ref{skiplist}, page \pageref{skiplist}.\end{sloppypar} % % \DescribeMacro{\poemtitlepenalty} % |\poemtitlepenalty| encourages @@ -706,9 +717,6 @@ % If you don't want the entry in the notes section for this poem to include % the page number of the poem, issue |\putpagenumberinnotesfalse|. % -% \DescribeMacro{\poemsubtitle} Subtitles of poems should be issued as -% the arguments to the |\poemsubtitle| command. -% % \DescribeMacro{\titleindent} |\titleindent| is an internal command for indented parts of titles. % You should change it with caution. In the % commands for setting the sections and subsections of poetic sequences, @@ -719,6 +727,10 @@ % line titles. Instructions about changing the value of |\titleindent| % can be found in section \ref{changingfontsandleading}. % +% \subsubsection{Subtitles and special titles} +% \DescribeMacro{\poemsubtitle} Subtitles of poems should be issued as +% the arguments to the |\poemsubtitle| command. +% % Multiple line titles (if it matters how they are broken up on page), % titles of subsections of poems, titles of % sequences of poems, titles of the elements of a sequence of @@ -730,10 +742,11 @@ % % \subsection{~The body of the poem} % +% \subsubsection{The poem environment} % \DescribeEnv{poem} The body of every poem should be placed in a % |poem| environment. Putting the body of the poem between % |\begin{poem}| and |\end{poem}| resets the line counter to 1, -% puts the poem in a |verse| environment (to handle run over lines +% puts the poem in a modified |verse| environment (to handle run over lines % automatically), and turns off automatic hyphenation with the |poem| environment. % % \DescribeEnv{pmclverse} \textsf{poemscol} slightly modifies the |verse| @@ -748,6 +761,7 @@ % The verse environment for \textsf{poemscol} is |pmclverse|, defined % below on page \pageref{versedefine}. % +% \subsubsection{Customizing the poem environment} % \DescribeMacro{\versewidth} % The |poem| environment takes an optional argument. If your poem has % short lines, and you wish to center it on the page, rather than set @@ -791,6 +805,14 @@ % You can turn on centering the text block again by issuing % |\textcenteringturnedontrue|. % +% \DescribeMacro{\versemarginadjust} +% If you don't want to center the verse block on the longest line, but do want +% to adjust its horizontal placement, you can adjust the +% placement of the verse block by changing the value of the +% length |\versemarginadjust|. For most commonly used type sizes, setting +% |\versemarginadjust| to 28pts will put the verse block at the left margin. +% +% \subsubsection{Hyphenation is off in the poem environment} % \textsf{poemscol} turns off automatic hyphenation in poetry % environments. The idea here is that every hyphen in the printed % poem is authorial, obviating the need for you to compile a @@ -831,6 +853,7 @@ % globally. You might wish, for instance, to turn automatic % hyphenation off in the |prosesection| environment.) % +% \subsubsection{The stanza environment} % \DescribeEnv{stanza} Every stanza should be placed in its own stanza % environment. Every poem should have at least one stanza. Marking % the beginning and end of every stanza (with |\begin{stanza}| and @@ -857,6 +880,7 @@ % using as the argument whatever you wish to mark such cases. The % default is |\relax| (which is to say, ``don't do anything''). % +% \subsubsection{Verse lines and line numbering} % \DescribeMacro{\verseline} |\verseline| should mark the end of every % line, except the last line of every stanza (which should be marked % with |\end{stanza}|). |\verseline| marks the end of every line as a @@ -881,18 +905,24 @@ % \begin{sloppypar} % \DescribeMacro{\verselinenumberstoright} % \DescribeMacro{\verselinenumberstoleft} -% \DescribeMacro{\verselinenumbersswitch} -% \DescribeMacro{\verselinenumbersgutter} -% \DescribeMacro{\verselinenumbersouter} % To put all of the line numbers to the left, issue |\verselinenumberstoleft| in % your preamble. |\verselinenumberstoright| puts the line numbers in the right % margin. (These two commands use non-floating marginal note commands derived % from the \textsf{memoir} class, |\pmclleftsidepar| and |\pmclrightsidepar|, -% respectively.) If you wish them to appear in the outer margins, issue +% respectively.) +% \end{sloppypar} +% +% \DescribeMacro{\verselinenumbersouter} +% \DescribeMacro{\verselinenumbersgutter} +% If you wish the line numbers to appear in the outer margins of each two-page spread, issue % |\verselinenumbersouter| in your preamble. If you want the line numbers to % appear in the inner margins, issue |\verselinenumbersgutter| in your preamble. % (These two commands use |\pmclsidepar|, derived from |\sidepar| from the -% \textsf{memoir} class, but modified by Dan Leucking.) You can adjust the +% \textsf{memoir} class, but modified by Dan Leucking.) +% +% \begin{sloppypar} +% \DescribeMacro{\marginparsep} +% You can adjust the % distance between the marginal line number and the text with % |\setlength{\marginparsep}{your length}|. The default value for |\marginparsep| is 18pt, % and the default value for the width of the box in which the line numbers are @@ -905,19 +935,31 @@ % numbers, and puts both at the margin. If you move the verse line numbers by % changing |\marginparsep|, you can move the page numbers to keep them aligned % by changing |\headoffsetlength| to the same value. -%\end{sloppypar} +% \end{sloppypar} % +% \DescribeMacro{\marginparsepmin} +% If the verse block is centered on the longest line, the distance between the line numbers and the +% verse can be set by setting the length of |\marginparsepmin| (not +% |\marginparsep|). The default +% value of |\marginparsepmin| is 2em. +% +% \DescribeMacro{\pmclsideparvshift} % The line numbers should print on the baseline. You can adjust them % to move them up or down by changing the value of a length called % |\pmclsideparvshift|. The default value is % |\setlength{\pmclsideparvshift}{0ex}|. % -% % \DescribeMacro{\versemarginadjust} -% You can adjust the placement of the verse block by changing the value of the -% length |\versemarginadjust|. For most commonly used type sizes, setting -% |\versemarginadjust| to 28pts will put the verse block at the left margin. -% % \subsection{~Special line markup} +% \subsubsection{Line breaks, runover, and broken lines} +% \DescribeMacro{\verseindent} The |\verseindent| command is to be +% used for formally indented lines. It should not be used to indent +% the run over portion of long lines (which \textsf{poemscol} handles +% automatically anyway). |\verseindent| indents the line a bit less +% than the run over portion of long ``bent'' lines are indented, so +% that the two cases can be visually distinguished. By default, the +% length of |\verseindent| is 2 em. To change it, say to 3 em, issue +% |\renewcommand{\verseindent}{\hspace{3em}}| +% % \DescribeMacro{\linebend} \textsf{poemscol} automatically runs over % long lines, indenting the run over portion on the next physical % line. If you are unhappy with where \textsf{poemscol} has run over @@ -959,17 +1001,7 @@ % environment. By default, the runover portion of long lines is % indented. You may wish to flush the runover portion to the right % margin instead. For instructions about how to do this, see section -% \ref{rightflushverse}, page \pageref{rightflushverse}. -% -% \DescribeMacro{\verseindent} The |\verseindent| command is to be -% used for formally indented lines. It should not be used to indent -% the run over portion of long lines (which \textsf{poemscol} handles -% automatically anyway). |\verseindent| indents the line a bit less -% than the run over portion of long ``bent'' lines are indented, so -% that the two cases can be visually distinguished. By default, the -% length of |\verseindent| is 2 em. To change it, say to 3 em, issue -% |\renewcommand{\verseindent}{\hspace{3em}}| -% +% \ref{rightflushverse}, page \pageref{rightflushverse}. % % \DescribeMacro{\brokenline} % \DescribeMacro{\versephantom}|\brokenline| should be used where you @@ -1005,6 +1037,18 @@ % |\versephantom{And Agamemnon dead.}| Being so caught up,|\verseline| % \end{verse} % +% \DescribeMacro{\stanzalinestraddle} +% Some poets (such as Robert Penn Warren) occasionally introduce a +% stanza break in the middle of a broken line, considering the line to +% be a single metrical unit despite the fact that it straddles a stanza +% break. To record these cases, mark the end of the first half-line +% with |\end{stanza}| as usual. But instead of opening the next stanza +% with |\begin{stanza}| issue |\stanzalinestraddle| instead. This will +% make sure that the line counter counts the straddling line as only one +% line, despite the stanza break. |\stanzalinestraddle| is usually used +% with |\versephantom|. +% +% \subsubsection{Customizing broken lines} % \DescribeMacro{\tweakbrokenline} % By default, \textsf{poemscol} sets the line numbers level with the % ends of broken lines. If the line numbers are set to the right of @@ -1048,18 +1092,8 @@ % |\verselinenumbersgutter| in your preamble). To ensure that % |\startverseline| does this, issue |\tweakstartverseline| in your % preamble. -% -% \DescribeMacro{\stanzalinestraddle} -% Some poets (such as Robert Penn Warren) occasionally introduce a -% stanza break in the middle of a broken line, considering the line to -% be a single metrical unit despite the fact that it straddles a stanza -% break. To record these cases, mark the end of the first half-line -% with |\end{stanza}| as usual. But instead of opening the next stanza -% with |\begin{stanza}| issue |\stanzalinestraddle| instead. This will -% make sure that the line counter counts the straddling line as only one -% line, despite the stanza break. |\stanzalinestraddle| is usually used -% with |\versephantom|. -% +% +% \subsubsection{Right-flushed runover lines} % \DescribeEnv{rightflushverse} % \DescribeMacro{\rightversebegin}\label{rightflushverse} By default, % \textsf{poemscol} indents the runover portion of long lines by the @@ -1079,6 +1113,7 @@ % examples of this kind of environment from Markus Kohm and Christian % Ebert, but so far I haven't been able to persuade them to play well with \textsf{poemscol} % +% \subsection{Cross references by line number} % \DescribeMacro{\poemlinelabel} \label{poemlinelabel} % |\poemlinelabel| enables crossreferences by line number. To make % a line label, issue |\poemlinelabel{text of label}| right after the @@ -1096,7 +1131,14 @@ % \DescribeMacro{\makepoemcontents} % I found the normal \LaTeX\ commands for making tables of contents for scholarly works % unsuited for making tables of contents of poetry, so I have provided my own. To make a table of -% contents for your poems, issue |\makepoemcontents|. It might seem +% contents for your poems, issue |\makepoemcontents|. +% +% |\makepoemcontents| takes an optional argument, which +% sets the page number for the table of contents. If your publisher +% wishes to add some front matter so that the contents will appear on +% page vii, you should issue |\makepoemcontents[7]|. +% +% It might seem % as though you would want to issue this command in your preamble. In % fact it is better to issue it in the body of the document, % immediately \emph{after} issuing the |\putpoemcontents|, the command which @@ -1104,55 +1146,30 @@ % before issuing |\putpoemcontents|, you will simply erase the table of contents % from the prior run (the one which will have all the contents information you % are intending to use) and enter an empty table of contents into your document. +% +% \subsection{~Printing the table of contents} +% \DescribeMacro{\putpoemcontents}\label{putpoemcontents} % Information for your table of contents will be written to an % external file with the extension .ctn. |\makepoemcontents| creates this file, and % opens an output channel to send information to it. |\putpoemcontents| closes -% the file and reads it into your document. You will need to run your +% the file and reads it into your document. +% +% You will need to run your % book through \LaTeX\ twice in order to generate a table of contents, % the first time to generate the titles and the references for the page numbers, and the second % time to use the labels to which the references point % to enter the page numbers. (Under some circumstances --- if % you have an index, for instance --- you may need three passes rather % than two.) - -% |\makepoemcontents| takes an optional argument, which -% sets the page number for the table of contents. If your publisher -% wishes to add some front matter so that the contents will appear on -% page vii, you should issue |\makepoemcontents[7]|. - -% All of the commands that generate lines in the table of contents are -% somewhat messy and somewhat rigid, but you can modify them if you -% wish. Lines in the table of contents usually include an indent (how -% much of one depends upon what the entry is --- whether it is a -% volume title, a poem title, or something else), then the title -% itself. If the entry is for a poem, for a section of a poem, or for -% a section of a poetic sequence, a slash follows the title, followed -% by the page number. To -% change the appearance of a \emph{particular} kind of entry (for all -% sequences of poems, for instance), go to the definition of the title -% of that kind of entry (e.g. |\sequencetitle|) below, find the line -% where it calls the |\c@ntentsinfo| command, and change the arguments -% to that command to suit you. If you wish to give \emph{all} your entries a -% different look altogether, modify the |\c@ntentsinfo| command below -% (see section \ref{poemtitlecode}, page \pageref{poemtitlecode}). % -%\DescribeMacro{\setcontentsleaders} By default the title and the page -% are separated by a slash (actually by |~/~|). If you wish to change -% this, say to put dot leaders in instead, issue what you wish to use -% as the argument to |\setcontentsleaders|, as for instance -% |\setcontentsleaders{\poemdotfill}|, which will flush the number to -% the right margin, and insert leading dots up to the number. -% The argument to |\setcontentsleaders| can be whatever you wish -% to use to separate the title from the page number, such as a colon, -% a hard space (|~|), or even |\hfil| to flush the page number to the left margin. -% -% \DescribeMacro{\putpoemcontents}\label{putpoemcontents} -% |\putpoemcontents| will input the table of contents file if it -% exists, and complain on your log file if it does not. Because the +% \DescribeMacro{\resetpagestyle} +% Because the % table of contents uses a special page style and special fonts -% |\putpoemcontents| restores the default fancy page style once it has +% |\putpoemcontents| issues |\resetpagestyle|, +% which restores the default fancy page style to ``main'' once it has % input the contents, and restores the font size to |\normalsize| as well. % +% \DescribeMacro{\pagenumbering} % Be sure to % reset the style of page numbering (from |\pagenumbering{roman}| to % |\pagenumbering{arabic}|) after issuing |\putpoemcontents|, since @@ -1162,16 +1179,16 @@ % the fancy page style to that used in the main body of the volume, % but it won't change the page numbering to arabic, in case there is % some frontmatter between the contents and the main text, so you -% should be sure to do so yourself. If you neglect to issue -% |\pagenumbering{arabic}| before you begin to get to your poems your +% should be sure to do so yourself. (Front matter is normally given page numbers +% in roman numerals.) If you neglect to issue +% |\pagenumbering{arabic}| at the end of your front matter, the % page numbering will remain in roman numerals. The notes sections % use the page numbers from the poem to construct running headers of % the form ``Notes to pp.~xx--yy.'' If those numbers are roman % numerals rather than arabic ones, \textsf{poemscol} will not % recognize them as numbers, and you will get the infamous ``Missing % Number'' error that puzzles so many users of \LaTeX. -% -% +% % \subsection{~Contents entries for notes sections and the index} % % \begin{sloppypar}\DescribeMacro{\puttextnotes} @@ -1203,6 +1220,102 @@ % |\putmultiplepoemindex| see section \ref{multipleindex}, % p.~\pageref{multipleindex}. % +% \subsection{~Customizing contents entries} +% Lines in the table of contents usually include an indent (how +% much of one depends upon what the entry is --- whether it is a +% volume title, a poem title, or something else), then the title +% itself. If the entry is for a poem, for a section of a poem, for a poetic sequence, or for +% a section or subsection of a poetic sequence, a slash follows the title, followed +% by the page number. +% All of the commands that generate lines in the table of contents are +% somewhat messy and somewhat rigid, but you can modify them if you +% wish. Here are some ways of customizing contents +% entries, in increasing order of difficulty. +% +%\DescribeMacro{\setcontentsleaders} By default the title and the page +% are separated by a slash (actually by |~/~|). If you wish to change +% this, say to put dot leaders in instead, issue what you wish to use +% as the argument to |\setcontentsleaders|. For instance +% |\setcontentsleaders{\poemdotfill}| will flush the number to +% the right margin, and insert leading dots up to the number. +% The argument to |\setcontentsleaders| can be whatever you wish +% to use to separate the title from the page number, such as a colon, +% a hard space (|~|), or even |\hfil| to flush the page number to the left margin. +% +% \DescribeMacro{\contentspoemtitlefont} +% You can change the font sizes that are used to set particular classes of title +% in the contents by redefining the commands that are used to set the font size +% for that kind of title. For instance, if you wanted to set the titles of all +% poems in 12 point type on 14.5 point leading, issue \begin{verbatim} +% \renewcommand{\contentspoemtitlefont}{\fontsize{12}{14.5}\selectfont} +% \end{verbatim} +% in your preamble. You can find a list of the various relevant font size commands +% below at section \ref{internal font size commands}, page \pageref{internal font size commands}. +% +% \DescribeMacro{\contentsindentoneamount} +% You can also change the amount of the indentations used in the hierarchy of indentations +% in the table of contents by changing the value of the elements of +% that hierarchy. You can change ``contentsindentoneamount'' +% (the amount a poem title is normally indented, by default 24pt) to, +% say, 36pt, by issuing |\contentsindentoneamount=36pt| in your preamble. You +% can find all of the values in the contents indentation hierarchy at section +% \ref{contents indentation hierarchy}, page \pageref{contents indentation hierarchy}. +% +% \DescribeMacro{\renewcommand} +% You can also make global changes to the appearance of a particular kind of contents entry. To +% change the appearance of a kind of entry (for all sections of +% sequences of poems, for instance), go to the definition of the title +% of that kind of entry (e.g.\ |\sequencesectiontitle|) below, +% and copy the definition into a |\renewcommand| for that kind of title; +% find where that command calls the +% |\c@ntentsinfo| command, and change the arguments +% to that command to suit you. (You should consult section \ref{customizing titles}, page +% \pageref{customizing titles}, to see what all of the arguments to |\c@ontentsinfo| do.) +% Put the whole renewed version of the title command into your preamble, being +% sure to issue |\makeatletter| before the |\renewcommand| and to issue +% |\makeatother| after it. +% (You have to put this whole |\renewcommand| between |\makeatletter| and |\makeatother| because +% |\c@ntentsinfo| and several other commands called to set titles include +%the |@| character, which you can't use in command names +% except in the .sty file. Internal commands like |\c@ntentsinfo|, which are used by +% other commands but are under most circumstances not meant to be invoked +% by users directly, have an |@| in their names so that the user won't accidentally +% redefine them.) +% You can find the commands for making titles below at +% section \ref{poemtitlecode}, page \pageref{poemtitlecode}. +% +% Here, for instance, is the code that defines titles for sections of poetic sequences: +% \begin{verbatim} +% \newcommand{\sequencesectiontitle}[1]{% +% \set@p@emtitle{#1}{\poemtitlepenalty}{\poemtitlefont} +% {\titleindent}{\nobreak\par\nobreak\afterpoemtitleskip\nobreak} +% {\titleindentamount} +% \c@ntentsinfo{#1}{\contentsindenttwo}{\contentspoemtitlefont} +% {\contentsindentthreeamount} +% \t@xtnotesinfo{#1}} +% \end{verbatim} +% Notice in the above that entries for sequence sections in the table +% of contents are given the indentation +% |\contentsindenttwo|. To give them the indentation |\contentsindentthree| +% and to set the runover portion of long titles with the indentation |\contentsindentfour| put this in +% your preamble: +% \begin{verbatim} +% \makeatletter +% \renewcommand{\sequencesectiontitle}[1]{% +% \set@p@emtitle{#1}{\poemtitlepenalty}{\poemtitlefont} +% {\titleindent}{\nobreak\par\nobreak\afterpoemtitleskip\nobreak} +% {\titleindentamount} +% \c@ntentsinfo{#1}{\contentsindenthree}{\contentspoemtitlefont} +% {\contentsindentfouramount} +% \t@xtnotesinfo{#1}} +% \makeatother +% \end{verbatim} +% +% \DescribeMacro{\c@ntentsinfo} +% You can make even more sweeping and fundmental changes in the look of your +% table of contents by redefining the |\c@ntentsinfo| command itself, which can be found +% below at section \ref{poemtitlecode}. Think very hard about this before doing it. +% % \section{Making an index of titles and first lines} % \subsection{~Setup} % \DescribeMacro{\indexingontrue} First you must add the \textsf{makeidx} package @@ -1216,6 +1329,7 @@ % cards'' generated by all of the |\index| commands in your source % files. % +% \subsection{~Printing the index} % \DescribeMacro{\putpoemindex} %Once you have processed your .idx file with MakeIndex, and % generated the sorted and formatted .ind file for your book, the @@ -1246,12 +1360,14 @@ % more than one index. You might, for instance, wish a separate index % of titles and index of first lines, or an index of proper names. To % do this, call \textsf{splitindex} in your list of packages. Then, -% in your preamble, declare the indices you are planning to use, e.g. -% |\newindex[Index of Titles]{idx}| -% |\newindex[Index of First Lines]{fir}| -% |\newindex[Onomastic Index]{ono}|. The second argument is the +% in your preamble, declare the indices you are planning to use, e.g.: +% \begin{verbatim} +% \newindex[Index of Titles]{idx} +% \newindex[Index of First Lines]{fir} +% \newindex[Onomastic Index]{ono} +% \end{verbatim}The second argument is the % ``shortcut'' defined by \textsf{splitindex}, and will be used to -% mark index entries in your text (see below), and as the extension +% mark index entries in your text (see below), and used also as the extension % for the external index files used by MakeIndex. % % Then mark up individual entries. Some entries (in the example @@ -1301,14 +1417,19 @@ % % \begin{sloppypar} % \DescribeMacro{\wholebooktitle} \DescribeMacro{\volumetitle} +% |\wholebooktitle| is for the title of the entire collection. +% |\volumetitle| is for the title of an individual volume within a +% Collected Poems. |\wholebooktitle| +% merely sets its argument in a very large font. |\volumetitle| also sets an entry +% in the table of contents (with no page number, but followed by extra +% vertical space) and in the endnotes (with +% no page number). +% % \DescribeMacro{\volumetitlefirstline} % \DescribeMacro{\volumetitlemiddleline} % \DescribeMacro{\volumetitlelastline} % \DescribeMacro{\volumesubtitle} -% \DescribeMacro{\volumesectiontitle} -% |\wholebooktitle| is for the title of the entire collection. -% |\volumetitle| is for the title of an individual volume within a -% Collected Poems. The |\volumetitlefirstline|, +% The |\volumetitlefirstline|, % |\volumetitlemiddleline|, and |\volumetitlelastline| commands are % for multi-line titles of volumes gathered into the collection. (Use % these last commands if you want to specify how a long title is @@ -1317,38 +1438,51 @@ % if you don't specify how to break them up, but % you might not be happy with how it breaks up the lines.) % |\volumesubtitle| is for setting the subtitle to a volume. -% |\volumesectiontitle| is for setting the title of a section of a -% volume. In addition to setting the text in the body of your +% In addition to setting the text in the body of your % edition, these commands send the title (and the formatting % information about it) to the table of contents file and to the % various endnotes files.\end{sloppypar} % +% \DescribeMacro{\volumesectiontitle} +% |\volumesectiontitle| is for setting the title of a section of a +% volume. |\volumesectiontitle| merely prints the title in a large font in boldface +% in the text. It always prints at the top of a page, but it does not ensure that that +% page is a recto page, does not reserve the whole +% page for the title, or put a blank verso page following the title. It prints the title +% in the contents without a page number, and prints the title in the textual notes +% (but not in the other endnote sections) in boldface on a separate line. +% Because it is so different from other titles, it does not use the three internal +% commands (|\set@p@emtitle|, |\c@ntentsinfo|, and |\t@xtnotesinfo|) that +% all of the other title commands use, so modifying those internal commands will not +% change |\volumesectiontitle|. +% % \DescribeMacro{\volumeepigraph} \DescribeMacro{\volumeattribution} -% \DescribeMacro{\volumeheader} \DescribeMacro{\leftheader} -% \DescribeMacro{\rightheader} |\volumeepigraph| and +% |\volumeepigraph| and % |\volumeattribution| are for epigraphs and attributions on the -% divider pages. |\volumeheader| or |\rightheader| is the right +% divider pages. \goodbreak +% +% \DescribeMacro{\volumeheader} \DescribeMacro{\leftheader} \DescribeMacro{\rightheader} +% |\volumeheader| or |\rightheader| is for setting the right % running header for that volume (except for divider pages, the table % of contents, the notes sections, and other special cases). Normally -% that is just the name of the particular volume. |\leftheader| is +% that is just the name of the particular volume. |\leftheader| is for setting % the left running header for the entire book (except for divider % pages, the table of contents, the notes sections, and other special % cases). Normally that is the name of the entire book. % % \section{Recording textual notes, emendations, and explanatory notes}\label{recordingtextualnotes} % \subsection{~Setup for endnote sections} -% \DescribeMacro{\makeemendations} \DescribeMacro{\maketextnotes} +% \DescribeMacro{\maketextnotes} \DescribeMacro{\makeemendations} % \DescribeMacro{\makeexplanatorynotes} -% To collect emendations, issue |\makeemendations| in your preamble. % To collect textual collations, issue |\maketextnotes| in your -% preamble. To collect explanatory notes, issue +% preamble. +% To collect emendation notes, issue |\makeemendations| in your preamble. +% To collect explanatory notes, issue % |\makeexplanatorynotes| in your preamble. -% If you issue these commands, -% \textsf{poemscol} puts all of the emendations, textual collations, -% and explanatory notes in the backmatter of your volume. -% \textsf{poemscol} opens external files for emendations, textual +% These commands open external files for emendations, textual % collations, and explanatory notes (with extensions .emd, .ent, and -% .enx respectively), and reads them back in at the place you specify +% .enx respectively). \textsf{poemscol} reads these files back into the main document +% at the place you specify % with |\puttextnotes|, |\putexplanatory|, or |\putemendations|, or at % the end (if you use the |\finish| command). % These commands also send to the external files the commands for typesetting the @@ -1357,22 +1491,16 @@ % running headers of the notes sections to xx--yy format (e.g. % ``Explanatory Notes to pp.~55--7''). % -% If you wish to use multi-layer footnotes rather than endnotes, you -% do not need to issue |\maketextnotes| or its relatives (but you -% should of course issue |\textnotesatfoot| or its relatives). You can mix -% footnotes or endnotes as you wish. You may, for instance, wish to -% set explanatory notes as footnotes, and textual notes and -% emendations as endnotes. Instructions for setting up -% \textsf{poemscol} to make such footnotes are in section -% \ref{makingfootnotes} below. -% -% In end note sections \textsf{poemscol} opens an entry (headed with -% the title and page of the poem in the text) in the textual notes +% \textsf{poemscol} opens an entry (headed with +% the title, and the page the poem appears on in the body of the +% text, in boldface) in the textual notes % section for every poem (since, minimally, you want to include -% information about the variants and copy text of the poem), but only -% opens entries in the emendations or explanatory notes sections -% (or any other endnote sections you may create) if -% you actually have emendations or explanatory notes on that poem. +% information about the variants and copy text of the poem). +% In the emendations or explanatory notes sections +% \textsf{poemscol} +% sets this information only if you actually have emendations or explanatory notes on that poem. +% If you have defined a new endnote section using |\definenewnotetype| \textsf{poemscol} +% will also only set the poem heading in the notes if there actually is a note for that poem. % % The notes for each poem are set in a block paragraph, with a new % paragraph for every |\poemtitle| command, and the line counter for @@ -1385,6 +1513,16 @@ % By default, there is one paragraph per poem, with a hanging indent to give % prominence to the page number. % +% If you wish to use multi-layer footnotes rather than endnotes, you +% do not need to issue |\maketextnotes| or its relatives (but you +% should of course issue |\textnotesatfoot| or its relatives). You can mix +% footnotes or endnotes as you wish. You may, for instance, wish to +% set explanatory notes as footnotes, and textual notes and +% emendations as endnotes. Instructions for setting up +% \textsf{poemscol} to make such footnotes are in section +% \ref{makingfootnotes} below. +% +% \subsection{~Customizing endnotes} % \begin{sloppypar} % \DescribeMacro{\iftextnotessinglepar} % \DescribeMacro{\ifemendationssingplepar} @@ -1400,7 +1538,8 @@ % hanging indent, to give prominence to the line number. % \end{sloppypar} % -%\begin{sloppypar} +% \begin{sloppypar} +% \DescribeMacro{\noteindentation} % You may have notes with multiple paragraphs. The default settings for all of % the forms of endnotes set them with hanging indentation, which probably is not % a good idea for multiple paragraph notes. There are two ways of approaching @@ -1437,8 +1576,9 @@ % the notes. To turn off the appearance of the page number in the % notes, issue |\putpagenumberinnotesfalse|. You may also not wish to % put the poem's title in the notes. To turn off the appearance of the -% poem's title in the notes, issue |\puttitleinnotesfalse|. -% +% poem's title in the notes, issue |\puttitleinnotesfalse|. +% +% \goodbreak % \DescribeMacro{\contentsendnotesindent} % \DescribeMacro{\contentsendnotesfont} % You can control the appearance of the entry for endnote sections in @@ -1452,16 +1592,30 @@ % editions and publication history of individual poems, or any % information not tied to specific lines in the poem, you should place % that information in the argument to the |\sources| command. +% |\sources| sends information to the external file for textual notes, but does not +% tag what it sends with line numbers, hence its use for sending ``sources.'' % Typically, you should issue this command after you have issued -% |\poemtitle| and before you issue |\begin{poem}|. If you wish to -% send information to the textual notes file (such as to force a page -% break), you can do so by using |\sources|. You can send -% typesetting information to other sections by using -% |\literalemend|, |\literalexplain|, or |\literalcontents|. -% There is also a |\literaltextnote| command, which is equivalent to -% |\sources|. Although they do the same thing, I use |\sources| to +% |\poemtitle| and before you issue |\begin{poem}|. That way the ``sources'' will +% appear in the textual notes section just after the title of the poem, but before the +% notes on particular lines. +% You could conceivably use |\sources| +% send typesetting information to the textual notes file (such as to force a page +% break), but I prefer to do that +% by using |\literaltextnote|, which also sends information to the external +% file for textnotes without sending line numbers. Although they do the same thing, I use |\sources| to % send editorial information to the texual note section, but use -% |\literaltexnote| to send formatting instructions to the textual note section. +% |\literaltexnote| to send formatting instructions to the textual note section, so that +% the different purposes of the note are clear at first glance. You can send +% typesetting information to other sections by using +% |\literalemend|, |\literalexplain|, or |\literalcontents|. \textsf{poemscol} also +% creates a similar ``literal'' command for any type of endnote you create on the fly +% using |\definenewnotetype|. +% +% There is one subtle difference between |\sources| and |\literaltextnote|. If you +% issue the commands to set your textual notes as footnotes rather than endnotes, +% notes issued with |\sources| will be set as footnotes, but anything issued using |\literaltextnote| +% will be discarded. To set textual notes as footnotes, +% see section \ref{makingfootnotes}, page \pageref{makingfootnotes}, below. % % \DescribeMacro{\textnote} % \DescribeMacro{\emendation} @@ -1476,8 +1630,9 @@ % variants or comment in the argument to the |\textnote| command. % For emendations, use |\emendation|, and for explanatory notes, % use |\explanatory|. These notes go to their own endnote sections. The -% only difference is that each poem opens a new paragraph for its own -% textual notes, but paragraphs for explanatory notes or emendations are only +% only difference is that each poem opens a new paragraph (headed with the +% poem's title and page number) for its own +% textual notes, but such paragraphs for explanatory notes or emendations are only % opened if there actually are explanatory notes or emendations for that poem. % % \DescribeMacro{\sameword} @@ -1541,69 +1696,38 @@ % concludes the line to which it is a comment. These commands also can % take optional arguments to specify line ranges. % -% If you quote verse \emph{within} a textual note, an explanatory -% note, or an emendation, you may want to use the normal \LaTeX\ -% markup for verse for that quotation, rather than the special markup -% for \textsf{poemscol}. \textsf{poemscol} will not complain about -% this. -% -% \DescribeMacro{\quotedversecorrectiontextnote} If a textual note -% \emph{ends} with a quotation in verse, you should -% follow the |\textnote| entry with -% |\quotedversecorrectiontextnote|. I found that if I quoted verse in -% the note sections a dirty trick I used to send the notes to the -% external files would cause the following notes on that poem in the -% notes sections to be set in a new paragraph. (This is of course not -% a problem if the quoted verse is the last thing in the notes to that -% poem, since the next poem will open a new paragraph in the notes -% anyway. It is also not a problem if more of the individual textnote -% follows the verse. It's only a problem if the last thing in the -% note is quoted verse, and the note is not the last one on that -% poem.) The command should set it flush as it is, but I have found -% odd cases I can't understand in which that doesn't work, so the -% command has an optional argument, which should be the additional -% length you need to adjust the next line by to make it flush. The -% default is 0pt. |\quotedversecorrectionexplanatory| and -% |\quotedversecorrectionemendation| should follow explanatory notes -% or emendations that end with snippets of verse. These three -% commands are an embarrassing kludge on my part. They simply send -% commands to the relevant note sections that prohibit opening a new -% paragraph. You should issue this command in the main text right -% after the close of the textnote (not in the text of the textnote -% itself). -% +% \begin{sloppy} % \DescribeMacro{\accidental} |\accidental| behaves exactly like -% |\textnote|. If you wish to distinguish between accidentals and -% substantives, this command provides a way of doing so. If you wish to -% exclude -% accidentals from your textual notes, issue -% |\global||\includeaccidentalsfalse| in your preamble. Accidentals -% are included by default, but if you issue |\includeaccidentalstrue| -% in your preamble, you will remind yourself of that fact. -% -% \textsf{poemscol} does not provide for a separate backmatter section -% for accidentals, but it would be trivial to construct one, using -% |\definenewnotetype|, described in section \ref{definingnewnotes} -% below. Use |\definenewnotetype| to create a command called -% |\newaccidental|, then issue| \let\accidental=\newaccidental|. -% +% |\textnote|. Accidentals +% are included by default, but if you issue |\global\includeaccidentalstrue| +% in your preamble, you will remind yourself of that fact. +% If you wish to distinguish between accidentals and +% substantives, using |\accidental| provides a way of doing so.\end{sloppy} +% % If you wish to exclude accidentals from your printed output, but to -% mark them in your source files, so that your published collation +% mark them in your source files, so that your published collation in the +% textual notes endnotes section % consists only of substantives, issue % |\global\includeaccidentalsfalse| in your preamble. Many publishers % are reluctant to publish accidentals, believing that they are, well, % less substantive than substantives. Using the |\accidental| % command allows you to exclude accidentals from the published version % should your publisher insist, while preserving the information about -% them should the publisher's mind change. In the very worst case, if +% them in your source files should the publisher's mind change. In the very worst case, if % you have marked all the accidentals in this way you can still % produce a list of accidentals for later use, and other scholars can % search for accidentals in your source files simply by searching for % the string |\accidental|. % -% +% \textsf{poemscol} does not provide for a separate backmatter section +% for accidentals, but it would be trivial to construct one, using +% |\definenewnotetype|, described in section \ref{definingnewnotes} +% below. You may, for instance, use |\definenewnotetype| to create a command called +% |\newaccidental|, then issue| \let\accidental=\newaccidental|. +% % \DescribeMacro{\tsvariant} \DescribeMacro{\tsentry} Some publishers -% may turn up their noses at typescript or manuscript variants in just +% may turn up their noses at typescript or manuscript variants (changes on +% a manuscript or typescript as opposed to differences between published versions) in just % the way they turn up their noses at accidentals. If you wish to % distinguish between published variants and typescript, % man\-u\-script, or galley variants, |\tsvariant| (for a whole note) @@ -1620,7 +1744,7 @@ % Here is how to use |\tsentry|: % if you wish to include typescript entries in a single note including % those entries in a list with variants from other published versions -% (as for instance when a comma appears in a typescript but only in +% (as for instance when a word appears in a typescript but only in % the second edition of the published poem), simply issue % |\textnote| as usual, marking the relevant variant in the list of % variants with the |\tsentry| command. If typescript variants @@ -1658,7 +1782,9 @@ % \DescribeMacro{\margrefexplanatory} % \DescribeMacro{\margrefemendation} % Some editions include a marginal mark in the text showing where in the -% apparatus a textual note on that line can be found. +% apparatus a textual note on that line can be found. (The edition of William +% Blake's poetry and prose edited by Harold Bloom and David V. Erdman, for instance, +% includes such marks.) % |\margreftextnote| sets a label in the textual notes section, and % sets a marginal note with a page reference to that label in the main text. Issue % |\margreftextnote| \emph{before} issuing the |\verseline| or @@ -1672,6 +1798,39 @@ % details about how these markers work, see % section \ref{margreftextnote}, page \pageref{margreftextnote}. % +% \DescribeMacro{\quotedversecorrectiontextnote} +% If you quote verse \emph{within} a textual note, an explanatory +% note, or an emendation, you may want to use the normal \LaTeX\ +% |verse| environment for that quotation, rather than the special markup +% for \textsf{poemscol}. You can also use the special |pmclverse| environment, which +% enlarges the indentation of runover lines and the white space +% between stanzas. But you should not use the |poem| environment within the textual notes. +% +% If a textual note +% \emph{ends} with a quotation in verse, you should +% follow the |\textnote| entry with +% |\quotedversecorrectiontextnote|. I found that if I quoted verse in +% the note sections a dirty trick I used to send the notes to the +% external files would cause the following notes on that poem in the +% notes sections to be set in a new paragraph. (This is of course not +% a problem if the quoted verse is the last thing in the notes to that +% poem, since the next poem will open a new paragraph in the notes +% anyway. It is also not a problem if more of the individual textnote +% follows the verse. It's only a problem if the last thing in the +% note is quoted verse, and the note is not the last one on that +% poem.) The command should set it flush as it is, but I have found +% odd cases I can't understand in which that doesn't work, so the +% command has an optional argument, which should be the additional +% length you need to adjust the next line by to make it flush. The +% default is 0pt. |\quotedversecorrectionexplanatory| and +% |\quotedversecorrectionemendation| should follow explanatory notes +% or emendations that end with snippets of verse. These three +% commands are an embarrassing kludge on my part. They simply send +% commands to the relevant note sections that prohibit opening a new +% paragraph. You should issue this command in the main text right +% after the close of the textnote (not in the text of the textnote +% itself). +% % \section{Creating new kinds of endnote} \label{definingnewnotes} % \DescribeMacro{\definenewnotetype} The |\definenewnotetype| command % can be used to create new kinds of endnote, in case the kinds @@ -1731,17 +1890,28 @@ % to use it explicitly, |\firstxyznote|) the output channel xyznotes, % the external file |\jobname.xyz|, an entry in the contents for % ``Xyznotes'', and an endnotes section with a running header of the -% form ``Xyznotes to pp.~xx--yy'' and a title XYZNOTES. |\xyznote| -% takes the same arguments that |\explanatory| does (which is to say, +% form ``Xyznotes to pp.~xx--yy'' and a title XYZNOTES. +% +% |\xyznote| +% takes the same arguments that |\textnote| does (which is to say, % an optional argument for a label for entering line ranges, and an % argument for the lemma and the comment). There won't be an entry % for a poem in the ``Xyznotes'' endnotes section unless there -% actually is an xyznote for the poem. |\prosexyznote| takes the same -% arguments |\proseexplanatory| does (which is to say, an optional +% actually is an xyznote for the poem. +% + %|\prosexyznote| +% (for ``xyznotes'' on line-numbered prose passages) takes the same +% arguments |\prosetextnote| does (which is to say, an optional % argument for a label for entering line ranges, an argument for a % label to capture the line number of the first line, and an argument -% for the lemma and the comment). |\pmxyznote| behaves exactly like -% |\pmexplanatory|. +% for the lemma and the comment). For notes on passages of line-numbered +% prose, see section \ref{prosesections}, page \pageref{prosesections}. +% +% |\pmxyznote| (for prose passages +% numbered by paragraph and sentence) takes the same arguments as +% |\pmtextnote|. For notes on passages of prose numbered by +% paragraph and sentence, see section \ref{paragraphsentence}, page +% \pageref{paragraphsentence}. % % \section{Multi-level footnotes} \label{makingfootnotes} % \DescribeMacro{\textnotesatfoot} \textsf{poemscol} will set multiple @@ -1772,7 +1942,8 @@ % use |\literaltextnote| anywhere in your file, however, you will lose % the text it would have put in your textnotes, since |\literaltextnote| % just writes its argument onto the external file for textual notes. -% +% The arguments to |\literalexplain| and |\literalemendation| will +% be discarded as well if explanatory notes or emendation notes are set as footnotes. % % \DescribeMacro{\iftextfootnotespara} % \DescribeMacro{\ifsourcesfootnotespara} @@ -1791,9 +1962,8 @@ % |\explanatory| are set in ``plain'' mode (|\explanfootnotesparafalse|). To change explanatory % footnotes from plain to para mode, for instance, issue % |\global\explanfootnotesparatrue|. Counterintuitive as it sounds, -% you must issue this \emph{before} issuing |\textnotesatfoot| (or the -% command for whichever other kind of note you are wishing to change -% the appearance of). +% you must issue this \emph{before} issuing |\textnotesatfoot|, |\emendationsatfoot|, +% or |\explanationsatfoot|. % % When |\sources| is defined to send endnotes to the textual notes % section, they usually appear immediately underneath the title of @@ -1826,8 +1996,9 @@ % \FootnotetextE{\citerange}{#2} % \resetlemmacounters} \end{verbatim} % |\setlemmarange|, |\citerange|, and -% |\resetlemmacounters| enable your footnote to handle line ranges in -% the lemma. If a |\mynote| refers to a range of lines, you can issue +% |\resetlemmacounters| are internal commands to enable your footnote to handle line ranges in +% the lemma. They are defined in the implementation section below, at section +% \ref{notetools}. If a |\mynote| refers to a range of lines, you can issue % the same kinds of optional argument that are used with |\textnote|. % % \section{Notes at the end of poems} @@ -1848,7 +2019,7 @@ % \DescribeMacro{\poemendemendationnote} % \DescribeMacro{\makepoemendemendationnotes} % \DescribeMacro{\putpoemendemendationnotes} -% You can print a list of emendations at the end of each poem. +% You can also print emendation notes at the end of each poem. % To do this, issue |\makepoemendemendationnotes| just % after |\begin{poem}|. Issue |\poemendemendationnote| where you wish to make a note, % using the same conventions you use for |\textnote|. Where you want to output @@ -1907,7 +2078,7 @@ % |\putexplanatory| do the same thing for the textual % notes and for the explanatory notes. % -% All of these last three commands restore normal hyphenation. Since +% Each of these last three commands restores normal hyphenation. Since % all three are printed with the |\small| font size, the hyphen % character is defined only for that size. This should not create % other issues, however, because the commands that prohibit @@ -1946,13 +2117,13 @@ % table of contents. % % -% \section{Special Cases} +% \section{Special cases} % \subsection{~Epigraphs, attributions etc.} \label{centerepigraphs} % \DescribeMacro{\epigraph} \DescribeMacro{\headnote} % \DescribeMacro{\attribution} \DescribeMacro{\poemdedication} % |\epigraph|, |\headnote|, |\attribution|, and |\poemdedication| set % their arguments as epigraphs, headnotes, attributions, or -% dedications for poems or poetic sequences. +% dedications for poems or poetic sequences. \goodbreak % % \DescribeEnv{epigraphenvironment} % If your epigraph or headnote is a prose passage of more than one paragraph, or a verse @@ -1960,7 +2131,11 @@ % rather than the |\epigraph| command. If you use the standard \LaTeX\ |verse| % environment within an epigraph, you may wish to add a |\smallskip| between % stanzas. (To my eye that environment does not leave enough white space between -% stanzas.) +% stanzas.) Alternatively, you can use the special |pmclverse| environment +% within the |epigraphenvironment| environment. (You can even use +% the |poem| environment within the |epigraphenvironment| environment, but if +% you mark up the epigraph with things like |\verseline| and |\end{stanza}| you may wind +% up with marginal line numbers.) % % \DescribeMacro{\centertitles} % Issuing |\centertitles| moves the margins in on both sides by the length @@ -1983,7 +2158,7 @@ % include both the composition and publication date if you wish simply by % including both dates in the argument. % (In fact, you can put anything in the argument, not just dates.) By default |\poemdate| places the -% date one |\bigskip| under left margin of the verse block of the poem, +% date one |\bigskip| under the left margin of the verse block of the poem, % whether the poem is set at the left % margin or whether the verse block is centered on the longest line. % You can move the placement of the date left or right @@ -1997,7 +2172,7 @@ % flush with the indented runover portion of the line rather than with the beginning % of the line. This should not in practice % be a problem, because you should use |\longpage| or several |\shortpage| commands -% to move the orphan date line anyway. (For |\longpage| and |\shortpage| see section \ref{longpage}, +% to move the widow date line anyway. (For |\longpage| and |\shortpage| see section \ref{longpage}, % page \pageref{longpage}.) % % \subsection{~Pausing line numbering} @@ -2069,8 +2244,8 @@ % explicitly how the title is to be broken up in the text and in the % table of contents. You can construct variants of these commands for % dealing with special cases I didn't anticipate by using -% the commands described in \ref{customizing titles}. -%.\end{sloppypar} +% the commands described in section \ref{customizing titles}. +%\end{sloppypar} % % \subsection{~Poetic sequences}\label{poeticsequences} % @@ -2146,7 +2321,7 @@ % \item |\sequencetitlemiddleline| % \item |\sequencetitlelastline| % \item |\sequencetitlenonotes| -% \end{itemize} +% \end{itemize} \goodbreak % \item Sequence Sections % \begin{itemize} % \item |\sequencesectiontitle| @@ -2481,7 +2656,7 @@ % \subsection{~Font sizes, skips, sinks, indents, and penalties} % % \label{changingfontsandleading} -% \textsf{poemscol} sets the font sizes, but not the font family, of +% \textsf{poemscol} sets the font sizes, but not the typeface, of % fonts for many common tasks, in order to create a hierarchy of % sizes. They can be changed with a |\renewcommand| of the following % form, where the first number is the font size in points and the @@ -2517,7 +2692,7 @@ % The following table gives various skips, sinks, penalties, and indentations. The % titles of these should be self-explanatory. These should be changed % with |\renewcommand| as follows:\\ -% |\newcommand{\volumetitlesink}{\leavevmode\vspace{23.5pt}}| +% |\renewcommand{\volumetitlesink}{\leavevmode\vspace{23.5pt}}| % \bigskip % % \begin{tabular}{l l l} @@ -2568,9 +2743,9 @@ % definitions of those ``fancy'' and ``main'' below at \ref{pagestyledefs}, page \pageref{pagestyledefs}. % % -% You can change the text in the left running head +% You can change the text in the left (verso) running head % by issuing |\leftheader{your header}| or |\volumeheader{your header}|. (The commands -% are synonyms.) You can change the text in the right running head by issuing +% are synonyms.) You can change the text in the right (recto) running head by issuing % |\rightheader{your header}|. % % \subsection{~Special page style for long poems} The fancy page style ``longpoem'' @@ -2591,7 +2766,7 @@ % headers for the backmatter % sections. % -% The header will include the abbreviation l. (for a single line) or ll. (for a range of lines). +% The header will include the abbreviation l.\ (for a single line) or ll.\ (for a range of lines). % You can change either abbreviation with |\changesinglelineabbrev| or % |\changemultiplelineabbrev|. So, for instance, to get rid of the abbreviations % entirely, issue |\changemultiplelineabbrev{\relax}| and |\changesinglelineabbrev{\relax}|. @@ -3126,7 +3301,7 @@ % % \medskip % -% All those fields filled with |\relax| are for reporting the success of failure +% All those fields filled with |\relax| are for reporting the success or failure % |\pretocmd| has had in appending |\versotitleinnotescheck| (or |\rectotitleinnotescheck|) % to the different endnotes commands. You may wish to replace % the |\relax| with something like |\typeout{fiftytextnote modified}| or @@ -3640,7 +3815,7 @@ % \subsubsection{Internal font size commands} You will probably never need % to use these font commands explicitly. I defined these for internal % use within \textsf{poemscol}, so that a command will always call the -% same fonts. +% same fonts. \label{internal font size commands} % % As a way of making global changes to repeated features I have % defined various special fonts for special purposes. For instance, @@ -3726,7 +3901,7 @@ \setlength{\parindent}{\titleindentamount} % \end{macrocode} % White space after poem titles, after poems, and after sequence -% titles. +% titles. \label{skiplist} % \begin{macrocode} \newcommand{\afterpoemtitleskip}{\smallskip} \newcommand{\afterpoemskip}{\bigskip} @@ -3736,7 +3911,7 @@ % \begin{macrocode} \newcommand{\stanzaskip}{\medskip} % \end{macrocode} -% A hierarchy of indentations for the table of contents: +% A hierarchy of indentations for the table of contents: \label{contents indentation hierarchy} % \begin{macrocode} \newdimen\volumetitleshiftamount \volumetitleshiftamount=1pc \newcommand{\volumetitleshift}{\hbox{\hspace{\volumetitleshiftamount}}} @@ -6122,7 +6297,7 @@ % \end{macro} % \end{macro} % \end{macro} -% \subsection{~Tools used for making note sections} The main tool is +% \subsection{~Tools used for making note sections} \label{notetools} The main tool is % a dirty trick borrowed from John Lavagnino's package for endnotes, % \textsf{endnotes}, which allows for writing out literal characters to an % external file. The trick involves redefining the space character as diff --git a/Master/texmf-dist/tex/latex/poemscol/poemscol.sty b/Master/texmf-dist/tex/latex/poemscol/poemscol.sty index f2a9ebde7ea..0c98be0af3e 100644 --- a/Master/texmf-dist/tex/latex/poemscol/poemscol.sty +++ b/Master/texmf-dist/tex/latex/poemscol/poemscol.sty @@ -22,9 +22,8 @@ %% in the same archive or directory.) \NeedsTeXFormat{LaTeX2e}[1997/12/01] \ProvidesPackage{poemscol} - [2018/01/05 v2.97 poemscol file] - - + [2018/01/11 v2.98 poemscol file] + %|\prosexyznote| %% -- cgit v1.2.3