From c75fbb3cd27c0c61bb4d93cedf51f4794edfa12d Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 8 Jan 2018 22:19:00 +0000 Subject: poemscol (8jan18) git-svn-id: svn://tug.org/texlive/trunk@46251 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/poemscol/poemscol.pdf | Bin 639407 -> 647029 bytes .../doc/latex/poemscol/poemscolcheatsheet.pdf | Bin 54810 -> 54616 bytes .../doc/latex/poemscol/poemscolcheatsheet.tex | 46 +- .../texmf-dist/source/latex/poemscol/poemscol.dtx | 750 ++++++++++++--------- Master/texmf-dist/tex/latex/poemscol/poemscol.sty | 46 +- 5 files changed, 506 insertions(+), 336 deletions(-) diff --git a/Master/texmf-dist/doc/latex/poemscol/poemscol.pdf b/Master/texmf-dist/doc/latex/poemscol/poemscol.pdf index e6dc7355805..31370ac9588 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/doc/latex/poemscol/poemscolcheatsheet.pdf b/Master/texmf-dist/doc/latex/poemscol/poemscolcheatsheet.pdf index 1070d60508a..0a6d796f1b1 100644 Binary files a/Master/texmf-dist/doc/latex/poemscol/poemscolcheatsheet.pdf and b/Master/texmf-dist/doc/latex/poemscol/poemscolcheatsheet.pdf differ diff --git a/Master/texmf-dist/doc/latex/poemscol/poemscolcheatsheet.tex b/Master/texmf-dist/doc/latex/poemscol/poemscolcheatsheet.tex index 28597855910..27b058092ae 100644 --- a/Master/texmf-dist/doc/latex/poemscol/poemscolcheatsheet.tex +++ b/Master/texmf-dist/doc/latex/poemscol/poemscolcheatsheet.tex @@ -5,7 +5,8 @@ \raggedbottom \title{\textsf{poemscol} Cheat Sheet} \author{John Burt} -\date{May 19, 2006} +%\date{May 19, 2006} +\date{\relax} % \addtolength{\textwidth}{1in} % \addtolength{\oddsidemargin}{-.5in} @@ -18,39 +19,40 @@ \maketitle \begin{supertabular}{|l|l|} \hline \textbf{Dependencies} & \\ -\hline general &geometry,ifthen,keyval,mparhack,makeidx\\ -if footnotes & [para,ruled] manyfoot\\ +\hline general &geometry,ifthen,keyval,mparhack,makeidx, multicol\\ +if footnotes & [para,ruled] manyfoot (or bigfoot)\\ if prose sections & [left,modulo]lineno\\ if cropmarks & [letter,pdftex,cam]crop\\ +if ``longpoem'' page style & etex, emarks \\ \hline \textbf{Setup} & \\ \hline & \verb|\makeverselinenumbers| \\ - & \verb|\global\verselinenumbersfalse|\\ - & \verb|\stanzaatbottom{*}| \\ + to turn off line numbering & \verb|\global\verselinenumbersfalse|\\ + marks stanza break at page turn & \verb|\stanzaatbottom{*}| \\ & \verb|\nostanzaatbottom{\relax}| \\ - & \verb|\leftheader{}| \\ +titles for running headers & \verb|\leftheader{}| \\ & \verb|\rightheader{}| \\ - & \verb|\setcounter{lineindexrepeat}{}| \\ + modulo for line numbers & \verb|\setverselinemodulo{}| \\ for endnote sections & \verb|\maketextnotes \puttextnotes | \\ & \verb|\makeemendations \putemendations|\\ & \verb|\makeexplanatorynotes \putexplanatorynotes| \\ & \verb|\global\includeaccidentalstrue| \\ & \verb|\global\includetypescriptstrue| \\ - & \verb|\indexingontrue \putpoemindex| \\ +indexing & \verb|\indexingontrue \putpoemindex| \\ for footnotes & \verb|\textnotesatfoot| \\ & \verb|\emendationsatfoot| \\ & \verb|\explanationsatfoot| \\ -``Plain'' footnotes & \verb|\global\textfootnotesparafalse| \\ +footnotes with multiple paragraphs & \verb|\global\textfootnotesparafalse| \\ & \verb|\global\emendationfootnotesparafalse| \\ & \verb|\global\explanfootnotesparafalse |\\ & \verb|\global\sourcesfootnotesparafalse |\\ -Contents & \verb|\makepoemcontents| \\ -put this one first & \verb|\putpoemcontents| \\ +contents setup & \verb|\makepoemcontents| \\ +print contents (put this one first) & \verb|\putpoemcontents| \\ \hline \end{supertabular} \newpage \begin{supertabular}{|l|l|} \hline \textbf{Poetic elements} & \\ -\hline Titles & \verb|\poemtitle{}| \\ +\hline titles & \verb|\poemtitle{}| \\ & \verb|\poemsectiontitle{}| \\ & \verb|\poemsubtitle{}| \\ & \verb|\poemtitlefirstline{} \poemtitlemiddleline{} \poemtitlelastline{}| \\ @@ -59,10 +61,10 @@ put this one first & \verb|\putpoemcontents| \\ & \verb|\sequencesectiontitlefirstline{}| etc. \\ & \verb|\sequencesubsectiontitle{}| \\ & \verb|\prosesectiontitle{}| \\ - & \verb|\epigraph{} \headnote{}| \\ +epigraphs etc. & \verb|\epigraph{} \headnote{}| \\ & \verb|\attribution{}| \\ & \verb|\dedication{}| \\ -Main Text & \verb|\begin{poem} \end{poem}| \\ +main text & \verb|\begin{poem} \end{poem}| \\ & \verb|\begin{stanza} \end{stanza}| \\ & \verb|\begin{prosesection} \end{prosesection}| \\ & \verb|\verseline| \\ @@ -72,10 +74,10 @@ Main Text & \verb|\begin{poem} \end{poem}| \\ & \verb|\linebend| \\ & \verb|\verseindent| \\ & \verb|\begin{rightflushverse} \rightflushversebegin| \\ - & \verb|\poemlinelabel{} \proselinelabel{}| \\ +cross references & \verb|\poemlinelabel{} \proselinelabel{}| \\ \hline \textbf{Notes} & \\ \hline & \verb|\textnote[label]{}| \\ - &\verb| \emendation[label]{}| \\ + &\verb|\emendation[label]{}| \\ & \verb|\explanatory[label]{}| \\ & \verb|\sources{}| \\ & \verb|\accidental{} \tsvariant{} \tsentry| \\ @@ -84,15 +86,17 @@ Main Text & \verb|\begin{poem} \end{poem}| \\ & \verb|\prosetextnote[end label]{beginning label}{}| etc. \\ & \verb|\definenewnotetype{cmd}{extension}{running head entry}|\\ & \verb|{title}{contents} |\\ + \hline + \end{supertabular} +\newpage +\begin{supertabular}{|l|l|} \hline \textbf{Collections} & \\ \hline & \verb|\begin{volumetitlepage} \end{volumetitlepage} | \\ & \verb|\volumetitle{} \volumetitlefirstline{} \volumesubtitle{}| \\ & \verb|\volumeepigraph{} \volumeattribution{}| \\ & \verb|\volumededication{}| \\ - \hline -\end{supertabular} -\newpage -\begin{supertabular}{|l|l|} +%\hline +% \hline \textbf{Annotation by Paragraph} & \\ \textbf{and Sentence Number} & \\ \hline & \verb|\pmsentence| \verb|\pmpara| \\ @@ -100,7 +104,7 @@ Main Text & \verb|\begin{poem} \end{poem}| \\ & \verb|\pmtextnote[]{} \pmexplanatory[]{}|\\ & \verb|\pmemendation[]{} \biblechapter \bibleverse| \\ \hline \textbf{Parallel Texts} & \\ -\hline & \verb|\startparalleltexts| \\ +\hline & \verb|\startparalleltexts| \verb|\finishparalleltexts|\\ & \verb|\startversopage \finishversopage| \\ & \verb|\startrectopage \finishrectopage| \\ & \verb|\synchrolabel \synchroref |\\ diff --git a/Master/texmf-dist/source/latex/poemscol/poemscol.dtx b/Master/texmf-dist/source/latex/poemscol/poemscol.dtx index 790ed06fa10..d2fb0bf84cb 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} -% [2017/12/20 v2.95 poemscol file] +% [2018/01/05 v2.97 poemscol file] % %<*driver> \documentclass{ltxdoc} @@ -33,7 +33,7 @@ % % \fi % -% \CheckSum{8443} +% \CheckSum{8465} % % \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 @@ -53,7 +53,7 @@ % % % \changes{v1.0}{2002/06/05}{Initial version} -% \changes{v1.01}{2002/06/25}{Added macros for titles of poems without +% \changes{v1.01}{2002/06/25}{Added commands for titles of poems without % formal titles. Corrected typographical errors in manual.} % \changes{v1.1}{2003/04/18}{Added commands to change mark in cases % where page break fall (or does not fall) on stanza break. Added @@ -76,7 +76,7 @@ % in titles (such as for italics and so on) no longer require special % commands, although those commands are retained for backward % compatibility.} \changes{v2.01}{2005/2/22}{Rewrote all of the title -% macros in order to make them easier to maintain. Added environment +% commands in order to make them easier to maintain. Added environment % for flushing runover lines in verse to the right margin. Added % information on how to customize titles.} % \changes{v2.02}{2005/2/28}{Corrected an error in setting poems @@ -87,7 +87,7 @@ % \changes{v2.21}{2005/3/24}{Cross references can refer to line % numbers} \changes{v2.22}{2005/3/25}{Removed dependence upon % marn.sty. Enabled multiple levels of block-formatted footnotes} -% \changes{v2.24}{2005/4/02}{Macros to aid typesetting parallel +% \changes{v2.24}{2005/4/02}{commands to aid typesetting parallel % texts.} \changes{v2.25}{2005/5/06}{Bug fix in running headers to % notes sections} \changes{v2.26}{2005/5/09}{Fix no unskip in vertical % mode error} \changes{v2.27}{2005/5/09}{Changed name of linelabel @@ -98,7 +98,7 @@ % footnotes or endnotes, and the latter are sent to the same place as % their verse equivalents. Good solution to ``missing number'' % problem on first runs.} \changes{v2.301}{2005/5/31}{Corrected small -% bug in table of contents macros, rewrote manual for clarity} +% bug in table of contents commands, rewrote manual for clarity} % \changes{v2.31}{2005/6/3}{Ranges of line for notes sections (in % verse or prose sections) need no longer involve counting of lines. % Lemmas may be nested, may overlap, and may cross stanza boundaries.} @@ -110,17 +110,17 @@ % \changes{v2.35}{2005/7/18}{poemscol can break the lines for long % titles in the table of contents on its own without making a mess of % it. poemscol can break the lines for long titles on its own without -% making a mess of it. Modified macros for volume titles to use the +% making a mess of it. Modified commands for volume titles to use the % facilities for poem titles.} \changes{v2.36}{2005/8/16}{Versions of -% note macros for typescript variants and accidentals for annotated -% prose. Macros for marking up and annotating prose by paragraph and -% sentence number. Macros for cross references by sentence and +% note commands for typescript variants and accidentals for annotated +% prose. Commands for marking up and annotating prose by paragraph and +% sentence number. Commands for cross references by sentence and % paragraph number.} \changes{v2.37}{2005/8/30}{In cases of broken % lines or runover lines you can choose whether to set the line number % with the beginning of the line or with the end of the line. Also, % you can choose to have it set the number always at the beginning if % the line number is at the left, and always at the end if it is at -% the right.} \changes{v2.38}{2005/9/04}{Checked cases where macros +% the right.} \changes{v2.38}{2005/9/04}{Checked cases where commands % might introduce extra white space. Made sure that line numbers for % verse, prose, and paragraph-sentence prose line up. Fixed % overlapping of paragraph and line numbers for paragraph-sentence @@ -201,7 +201,7 @@ % \changes{v2.64}{2013/08/02}{Bug fix: remove extra white space in % custom endnotes for prose sections when notes are in single paragraph mode. Fix % appearance of page number in endnote sections.} -% \changes{v2.65}{2013/12/20}{Modifications to parallel text macros, +% \changes{v2.65}{2013/12/20}{Modifications to parallel text commands, % corrections to manual.} % \changes{v2.66}{2015/5/14}{Change to page styles} % \changes{v2.7}{2015/6/18}{Improvements to parallel texts.} @@ -218,8 +218,7 @@ % control the distance of line numbers from margins of centered text block. New default % values for marginparwidth and marginparsep.} % \changes{v2.85}{2017/9/03}{Boolean to turn centering of verse block on and off. -% Subtitles center when centertitles is issued. Epigraphs and attributions move -% in when centertitles is issued. New boolean to adjust placement of marginal +% Subtitles center when centertitles is issued. New boolean to adjust placement of marginal % reference markers in jhtextnote and related commands.} % \changes{v2.87}{2017/10/23}{Notes to appear at the end of individual poems.} % \changes{v2.88}{2017/10/29}{Revisions to manual.} @@ -229,6 +228,10 @@ % Revisions to manual. Textual notes, emendation notes, and explanatory notes can also be % placed at the end of the poem rather than at the bottom of the page or in an endnote section. % Commands to set the title only in the contents and only in the notes.} +% \changes{v2.96}{2018/01/02}{Epigraphs, headnotes, dedications, and attributions move +% 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.} % \DoNotIndex{\newcommand,\newenvironment,\def,\edef,\else,\renewcommand,\makeatletter,\makeatother} % \DoNotIndex{\abovedisplayskip,\belowdisplayskip,\abovedisplayshortskip,\belowdisplayshortskip} % \DoNotIndex{\newcommand, \section, \subsection, \subsubsection, @@ -261,17 +264,17 @@ % \textsc, \unskip} % \setcounter{IndexColumns}{2} % \MakeShortVerb{|} -% \def\fileversion{2.95} -% \def\filedate{20 December 2017} -% \def\docdate{20 December 2017} +% \def\fileversion{2.97} +% \def\filedate{5 January 2018} +% \def\docdate{5 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{20 December 2017} +% \date{5 January 2018} % \maketitle -% \begin{abstract} \textsf{poemscol} provides macros for \LaTeX\ for +% \begin{abstract} \textsf{poemscol} provides commands for \LaTeX\ for % setting collections of poetry. It is especially suited for setting % collections of poetry in which several volumes are combined, such as % in a critical edition of a poet's Collected Poems. It provides the @@ -282,11 +285,13 @@ % \tableofcontents \hfuzz=50pt \section{Introduction} % % \textsf{poemscol} provides the structures necessary for editing a -% critical edition of a volume of poems or of a collection of a poet's -% works. \textsf{poemscol} numbers the lines, and produces separate, -% formatted endnote sections for emendations, textual collations, and -% explanatory notes (or, optionally, multiple layers of footnotes), tying -% each note to the range of lines upon which it is a comment. +% critical edition of a volume of poems (or of a collection of a poet's +% works) such as those required by the Modern Language Association's +% Committee on Scholarly Editions. \textsf{poemscol} numbers the lines, and produces separate, +% formatted endnote sections (or, optionally, +%multiple layers of footnotes) for emendations, textual collations, and +% explanatory notes, tying +% each note to the range of lines upon which it is a comment. % % Producing line numbers for verse is something for which \LaTeX\ % would seem to be especially suited. A line of verse, after all, is @@ -348,11 +353,17 @@ % Lavagnino and Dominik Wujastyk, or \textsf{ledmac}, a port of % \texttt{EDMAC} into \LaTeX\ originally by Peter Wilson and % now maintained as \textsf{reledmac} by Ma\"{\i}eul Rouquette, or \textsf{ednotes}, a -% completely independent set of macros for critical editions which +% completely independent set of commands for critical editions which % builds on \textsf{manypar} and \textsf{lineno}, by Uwe L\"{u}ck. % -% \textsf{poemscol} can annotate prose marked in ``paragraph number: sentence number'' -% format (or bible chapter and verse). +% \textsf{poemscol} can number and annotate prose marked in +% ``paragraph number: sentence number'' +% format (or bible chapter and verse). The advantage of this method of numbering lines +% of prose is that what is numbered is something the author chose to create +% (sentences and paragraphs) +% rather than an accidental feature of typesetting (line numbers). Paragraph and sentence +% numbering will also be stable across multiple editions, and, like line numbers in verse, +% provides a common system of reference. % % \textsf{poemscol} also provides % the ability to make cross references to verse line numbers, to line numbers in prose sections, @@ -364,7 +375,7 @@ % verse block wherever you wish), and the ability to place a mark in the margin % indicating where in the apparatus commentary on that line can be found. % For long poems, \textsf{poemscol} can provide a -% a special running header which indicates which lines are to be +% a special running header which indicates the range of lines to be % found on the page. % It has a special command to place % the publication date under the poem just at the left margin of the verse block even @@ -405,7 +416,7 @@ % sources for your edition are in ASCII, or perhaps Unicode, they provide a permanent % record of your local intentions at every point in your edition, % whether or not those who wish to consult your files have access to a -% \LaTeX\ compiler, or indeed (since most of the macros have self-explanatory names) +% \LaTeX\ compiler, or indeed (since most of the commands have self-explanatory names) % whether or not they can read \LaTeX\ % code. % @@ -423,6 +434,14 @@ % 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. +% 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. +% % \section{Dependencies and compatibility with other packages} % %\subsection{~General} @@ -469,7 +488,7 @@ % \textsf{manyfoot} sometimes gets into conflicts with other packages % over the number of |\counts| it uses, causing \LaTeX\ to complain % that there is no room for a |\newcount|. If this happens, -% issue |\usepackage{etex}| and |\reserveinserts|. +% issue |\usepackage{etex}| and |\reserveinserts| in your preamble. % % \subsection{~Special running header for long poems} % For long poems, it is a convenience to have a running header @@ -577,7 +596,7 @@ % seem closely related, such as a command to mark the title of a % section of a poetic sequence, and a separate command to mark a % subsection. But the names do describe pretty much what -% each macro does, and they do specify exactly what the object they +% each command does, and they do specify exactly what the object they % mark is supposed to be. The markup is designed to look like content % markup, marking objects as a poem title, as a stanza, as a line, and so on. % \textsf{poemscol} gives all of these content terms typographical @@ -597,7 +616,7 @@ % situation. Although all commands like |\sequencefirstsectiontitle| % discourage page breaks before the title (and all of the commands % discourage page breaks after the title), widowed or orphaned titles, -% and widowed or orphaned first lines will still sometimes +% and orphaned first lines will still sometimes % happen, particularly if you have a multi-line sequence title % followed by a multi-line section title. For these cases, a page % break at some other suitable point will have to be explicitly issued to @@ -605,10 +624,10 @@ % % \subsection{~The title of the poem} % -% \DescribeMacro{\poemtitle}|\poemtitle{}|, as its name implies, sets -% the title of the poem. -%The macro takes one -% argument --- the title, of course. The macro typesets the title in +% \DescribeMacro{\poemtitle}|\poemtitle|, as its name implies, sets +% its argument as the title of the poem. +%The command takes one +% argument --- the title, of course. The command typesets the title in % the body of the volume (testing first to see whether there is enough % space at the bottom of the page to get the title and a couple of % lines of the poem in), typesets the title in the table of contents @@ -625,36 +644,74 @@ % to discourage page breaks between a title and a poem. % % You can -% change all these values in your header file by changing the value of -% the parameters listed below in the implementation section using +% change all these values in your preamble by changing the value of +% the parameters for the relevant commands, listed below in the implementation section, using % either |\setlength| or |\renewcommand| (depending upon what you are -% changing). |\poemtitlefont| globally sets the font size (and +% changing). +% +% \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, +% attributions, and dedications towards the center. Since an epigraph or a headnote may be +% a prose paragraph, or a passage of verse, it would be unwise to set them in a centering +% environment, so |\centertitles| just moves them towards the center. To adjust the placement +% of epigraphs and similar things, see section \ref{centerepigraphs}, page \pageref{centerepigraphs}. +% +% \begin{sloppypar} +% \DescribeMacro{\poemtitlefont} +% |\poemtitlefont| globally sets the font size (and % leading) for all poem titles in the main text. +% For instance, you can change the font parameters for the font for +% setting poem titles from 14 points type on 18 points leading to 12 on 14 by issuing +% |\renewcommand{\poemtitlefont}{\fontsize{12}{14}\selectfont}| in +% 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. +% |\poemtitlefont| and its siblings do not change the +% default font family. To change the default font family 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 +% to do globally, not at the level of classes of title, anyway. +%\end{sloppypar} +% +% \DescribeMacro{\contentspoemtitlefont} % |\contentspoemtitlefont| globally sets the font size (and leading) -% for poem titles in the table of contents. |\afterpoemtitleskip| -% sets the vertical separation between a poem and its title. +% 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|. +% +% \begin{sloppypar} +% \DescribeMacro{\afterpoemtitleskip} +% |\afterpoemtitleskip| +% sets the vertical separation between a poem and its title. To change +% its value, for instance, to |\medskip| (the default is |\smallskip|), +% 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. |\poemtitlepenalty| encourages -% but does not require a page break just before a poem title. -% If you don't want the entry in the notes section for this poem to include -% the page number of the poem, issue |\putpagenumberinnotesfalse|. A +% poem and the title of the next poem. ``Skips'' for other kinds of title can be +% changed the same way. \end{sloppypar} +% +% \DescribeMacro{\poemtitlepenalty} +% |\poemtitlepenalty| encourages +% but does not require a page break just before a poem title. To change +% the penalty, for instance, from -1000 to -3000, +% issue |\renewcommand{\poemtitlepenalty}{\penalty-3000}| +% in your preamble. Penalties for other kinds of title can be changed the same way. +% A % complete list of all of the special commands for setting font sizes, % skips, and penalties, is in section \ref{changingfontsandleading}, page % \pageref{changingfontsandleading}, below. -% -% Multiple line titles (if it matters how they are broken up on page), -% titles of subsections of poems, titles of -% sequences of poems, and titles of the elements of a sequence of -% poems are all special cases, with special commands, which will be -% dealt with below at sections \ref{multilinetitles} and \ref{poeticsequences}. -%You can also create new varieties of title. For instructions -% on how to do this, see section \ref{customizing titles} below, page \pageref{customizing titles}. +% +% \DescribeMacro{\putpagenumberinnotesfalse} +% 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{}| macro. +% the arguments to the |\poemsubtitle| command. % -% \DescribeMacro{\titleindent} For indented parts of titles. In the -% macros for setting the sections and subsections of poetic sequences, +% \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, % \textsf{poemscol} uses |\titleindent| internally to set up a % hierarchy of indentations. (A section of a sequence is indented one % |\titleindent|. A subsection is indented two. And so on.) @@ -662,13 +719,24 @@ % line titles. Instructions about changing the value of |\titleindent| % can be found in section \ref{changingfontsandleading}. % +% 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 +% poems, and ``empty'' titles (for untitled poems) +% are all special cases, with special commands, which will be +% dealt with below at sections \ref{multilinetitles} and \ref{poeticsequences}. +%You can also create new varieties of title. For instructions +% on how to do this, see section \ref{customizing titles} below, page \pageref{customizing titles}. +% % \subsection{~The body of the poem} % % \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, and +% |\begin{poem}| and |\end{poem}| resets the line counter to 1, % puts the poem in a |verse| environment (to handle run over lines -% automatically). \textsf{poemscol} slightly modifies the |verse| +% automatically), and turns off automatic hyphenation with the |poem| environment. +% +% \DescribeEnv{pmclverse} \textsf{poemscol} slightly modifies the |verse| % environment from the standard \LaTeX\ definition, increasing the % indentation used for run over lines, in order to make the difference % between the indented run over portion of a long line, on one hand, @@ -677,9 +745,8 @@ % more white space between stanzas than the standard \LaTeX\ |verse| % environment does. (I found that the standard stanza breaks did not % leap out on the page as stanza breaks.) -% The verse environment for \textsf{poemscol} is pmclverse, defined -% below on page \pageref{versedefine}. If you want to change any of these things -% consult the definition of the stanza environment below at page \pageref{stanzadefine}. +% The verse environment for \textsf{poemscol} is |pmclverse|, defined +% below on page \pageref{versedefine}. % % \DescribeMacro{\versewidth} % The |poem| environment takes an optional argument. If your poem has @@ -692,26 +759,34 @@ % \label{centeringtextblock} % |\settowidth{\versewidth}{Text of line to use for centering}|. To use |\versewidth| % to center the poem on a sample line, enter the |poem| environment this way: -% |\begin{poem}[\versewidth]|. +% |\begin{poem}[\versewidth]|. Notice that the optional argument is in square braces, +% not in curly braces. % % \DescribeMacro{\linenumberscenteredwithverse} -% If you center the verse on the page using this option, you probably also want +% If you want to center the verse on the page using the optional argument to |\begin{poem}|, +% you probably also want % to move the line numbers in, so as to be closer to the line. % \textsf{poemscol} will do this by default. If you wish to leave the line % numbers at the margin, set the boolean |\linenumberscenteredwithverse| to % false. For centered verse, 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. +% value of |\marginparsepmin| is 2em. % -% \DescribeMacro{\centertitles} +% \begin{sloppy} +% \DescribeMacro{\centertitles} % If you center the poem on a sample % line, you probably also want to center the title of the poem too, -% which you can do by issuing |\centertitles|. -% -% \DescribeMacro{iftextcenteringturnedon} Suppose you have marked up poems with -% the optional second argument to |\begin{poem}| which would cause the text -% block to be centered on the longest line. You can turn off centering, without +% which you can do by issuing |\centertitles|. If you decide against centering the title, +% you can either just remove or comment out the |\centertitles| command, or +% switch a boolean by issuing |\centertitlesonfalse|. By default, |\centertitles| +% also moves epigraphs, dedications, headnotes, and attributions toward the center. +% To prevent this, issue |\centerepigraphsonfalse|.\end{sloppy} +% +% \DescribeMacro{\iftextcenteringturnedon} Suppose you have marked up many poems with +% the optional second argument to |\begin{poem}|, which would cause the text +% block to be centered on the longest line, but change your mind about +% centering all the poems. You can turn off centering, without % erasing all of the second arguments, by issuing |\textcenteringturnedonfalse|. % You can turn on centering the text block again by issuing % |\textcenteringturnedontrue|. @@ -721,26 +796,40 @@ % poem is authorial, obviating the need for you to compile a % hyphenated-lines list to distinguish between authorial hyphens and % hyphens you added for lineation purposes. Line-ending hyphens -% should not be a feature of verse anyway, I think. (You may wish to -% change this for your own edition, in order to improve its look; but -% if you do so you must keep track of added hyphens yourself. This +% should not be a feature of verse anyway, I think. +% +% You may wish to restore automatic hyphenation in poetry environments +% for your own edition. +% If you do so you must keep track of added hyphens yourself. This % list will be easy to compile, however, because only authorial % hyphens will appear in your source code. Automatically added -% hyphens will appear only in the output. You might even modify the +% hyphens will appear only in the output. (You might even modify the % output routine so that automatically added hyphens have a different % look. That would be non-trivial, but Donald Knuth has an exercise -% about doing just that in \emph{The \TeX book}.) \textsf{poemscol} +% about doing just that in \emph{The \TeX book}.) To +% restore automatic hyphenation, copy the definition of the |poem| +% environment (below at page \pageref{poemdef}) and redefine the +% environment using |\renewenvironment|, commenting out the line that reads +% |\language=255|. Place the renewed definition of the environment in your preamble, +% with |\makeatletter| before the renewed definition and |\makeatother| after it. +% If you are restoring automatic hyphenation for a parallel-text +% edition, be aware that |\startparalleltexts| also (defined below at +% page \pageref{startparalleltexts}) redefines the |poem| +% environment, so you will have to change |\startparalleltexts| using +% |\renewcommand| as well. +% +% \textsf{poemscol} % turns automatic hyphenation back on in prose contexts, so if you % wish to keep a hyphenation list for such things as authorial % prefaces and so on, you must do so yourself manually. % (Alternatively, you can turn automatic hyphenation off in those % contexts as well, by setting the |\language| to 255. For an example -% of how to do this, look at the definition of the |\poem| environment +% of how to do this, look at the definition of the |poem| environment % in the implementation section below. If you do turn automatic % hyphenation off, it would be wise to restrict the change to some % particular environment, rather than changing the |\language| % globally. You might wish, for instance, to turn automatic -% hyphenation off in the |\prosesection| environment.) +% hyphenation off in the |prosesection| environment.) % % \DescribeEnv{stanza} Every stanza should be placed in its own stanza % environment. Every poem should have at least one stanza. Marking @@ -751,19 +840,20 @@ % environment but \emph{not} inside a stanza environment. Further, % marking the beginning and end of every stanza makes the logical % structure of the poem (and the editor's intentions about it) clear -% to readers of your source code. +% to readers of your source code. If you want to change the |stanza| environment +% consult its definition below at page \pageref{stanzadefine}. % % \DescribeMacro{\stanzaatbottom} % \DescribeMacro{\nostanzaatbottom} % If you wish to change the symbol used to mark cases in which a -% break falls on a page turn, issue the command |\stanzaatbottom{}|, +% break falls on a page turn, issue the command |\stanzaatbottom|, % using as the argument whatever you wish to use to mark such cases. % The default is *, which is suitable for a published volume. If you % are preparing a typescript for submission, you may wish to set % |\stanzaatbottom| to ``stanza break.'' % -% If you wish also to mark all cases where there is NOT a stanza break -% at the bottom of the page, issue the command |\nostanzaatbottom{}|, +% If you wish also to mark all cases where there is \emph{not} a stanza break +% at the bottom of the page, issue the command |\nostanzaatbottom|, % using as the argument whatever you wish to mark such cases. The % default is |\relax| (which is to say, ``don't do anything''). % @@ -796,7 +886,7 @@ % \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 macros derived +% 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 % |\verselinenumbersouter| in your preamble. If you want the line numbers to @@ -804,7 +894,7 @@ % (These two commands use |\pmclsidepar|, derived from |\sidepar| from the % \textsf{memoir} class, but modified by Dan Leucking.) You can adjust the % distance between the marginal line number and the text with -% |\setlength{\marginparsep}{}|. The default value for |\marginparsep| is 18pt, +% |\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 % set, |\marginparwidth|, is 18 pt. If you are setting with the line numbers to % the right, |\marginparwidth| can be as small as you wish, although your log @@ -836,14 +926,8 @@ % the line will be indented just as if \textsf{poemscol} had ``bent'' % the line at your selected point. This command only works if you % have chosen to bend the line at some point earlier than -% \textsf{poemscol} would have chosen on its own. If you really do -% want to extend a line further into the right margin, you can -% probably do so by using a combination of |\nobreak| and |\hbox{}|, -% or by turning all of the spaces in that line into unbreakable -% spaces, marked with |~| in your source. But \textsf{poemscol} will -% complain if you do this, and rightly so, since the result is likely -% to be ugly. -% +% \textsf{poemscol} would have chosen on its own. +% % You may also wish to use |\linebend| to reproduce how your author % broke up long lines on the page (if you know that your author cared % about such things and did not leave them up to the typesetter). @@ -851,17 +935,26 @@ % |\linebend| should only be used for managing run over lines, not for % cases in which a line is to be broken into separate half-lines. For % cases in which a line is to be broken into half-lines, use the -% |\brokenline| macro. The two macros do similar (but not identical) +% |\brokenline| command. The two commands do similar (but not identical) % things. But a ``linebend'' is a feature of typesetting, and a % ``broken line'' is a feature of versification, and it seems best to % distinguish them logically. (|\linebend|, like |\brokenline|, issues % a carriage return without incrementing the line number, but % |\linebend| adds indentation to the next line.) +% +% If you +% want to extend a line further into the right margin, beyond the normal break point, you can +% probably do so by using a combination of |\nobreak| and |\hbox|, +% or by turning all of the spaces in that line into unbreakable +% spaces, marked with |~| in your source. But \textsf{poemscol} will +% complain if you do this, and rightly so, since the result is likely +% to be ugly. It would probably be wiser to adjust the lengths |\leftmargin| +% and |\rightmargin|, allowing all of the line to be a little bit longer. % % \DescribeMacro{\runoverindent} To change the indentation for the run % over portion of verse lines globally, issue the amount of -% indentation as the argument to |\runoverindent{}|. -% |\runoverindent{}| is currently set to 6 em, rather more than the +% indentation you desire as the argument to |\runoverindent|. +% |\runoverindent| is currently set to 6 em, rather more than the % standard amount in the definition of the \LaTeX\ |verse| % environment. By default, the runover portion of long lines is % indented. You may wish to flush the runover portion to the right @@ -887,9 +980,9 @@ % speaker. Sometimes they just indicate a change of subject, usually % an abrupt one, a change which calls attention to itself by % interrupting a line rather than waiting for a line break or stanza -% break). |\brokenline| is normally used with |\versephantom{}|, +% break). |\brokenline| is normally used with |\versephantom|, % which adds white space exactly as long as its argument would have -% been had it been set in type. |\versephantom{}| thus provides an easy +% been had it been set in type. |\versephantom| thus provides an easy % way of setting the beginning of the second half-line flush with the % end of the first, whatever the font size or special formatting of the % first line. @@ -965,7 +1058,7 @@ % 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{}|. +% with |\versephantom|. % % \DescribeEnv{rightflushverse} % \DescribeMacro{\rightversebegin}\label{rightflushverse} By default, @@ -987,7 +1080,7 @@ % Ebert, but so far I haven't been able to persuade them to play well with \textsf{poemscol} % % \DescribeMacro{\poemlinelabel} \label{poemlinelabel} -% |\poemlinelabel{}| enables crossreferences by line number. To make +% |\poemlinelabel| enables crossreferences by line number. To make % a line label, issue |\poemlinelabel{text of label}| right after the % line to which you wish to refer, where ``text of label'' is some % distinctive label you can use for a reference elsewhere. (You @@ -1001,7 +1094,7 @@ % \section{Making a table of contents} % \subsection{~Setup} % \DescribeMacro{\makepoemcontents} -% I found the normal \LaTeX\ macros for making tables of contents for scholarly works +% 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 % as though you would want to issue this command in your preamble. In @@ -1025,7 +1118,7 @@ % |\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}|. +% 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 @@ -1038,9 +1131,9 @@ % 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| macro, and change the arguments -% to that macro to suit you. If you wish to give \emph{all} your entries a -% different look altogether, modify the |\c@ntentsinfo| macro below +% 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 @@ -1058,7 +1151,7 @@ % exists, and complain on your log file if it does not. Because the % table of contents uses a special page style and special fonts % |\putpoemcontents| restores the default fancy page style once it has -% input the contents, and restores |\normalfont| as well. +% input the contents, and restores the font size to |\normalsize| as well. % % Be sure to % reset the style of page numbering (from |\pagenumbering{roman}| to @@ -1105,32 +1198,16 @@ % contents. % % \DescribeMacro{\putmultiplepoemindex} -%Use |\putmultiplepoemindex| instead if +% Use |\putmultiplepoemindex| instead if % you are making several indices. For instructions about % |\putmultiplepoemindex| see section \ref{multipleindex}, % p.~\pageref{multipleindex}. -% -% \DescribeMacro{\finish} Rather than issuing |\putpoemcontents| in -% the proper place, and |\puttextnotes| and its siblings in their -% proper places, you can issue the |\finish| command just after your -% last poem. |\finish| turns automatic hyphenation back on, closes -% and reads back in the external files for the emendations, the -% textual collations, and the explanatory notes, sets the index of -% first lines and titles, puts the information about these sections in -% the table of contents, closes the external file for the contents, -% and reads it back in. One disadvantage of this method is that -% you print the book with the contents at the end, so when you print -% it you must retrieve the contents pages and put them in the proper -% place. I found the convenience worth the hassle, but you might not. -% This command is deprecated now. But I have retained it, since the -% few users who gave me their opinions of the matter told me that -% they preferred to use |\finish| than |\puttextnotes|. -% -% % % \section{Making an index of titles and first lines} % \subsection{~Setup} -% \DescribeMacro{\indexingontrue} To set up the Index section of your +% \DescribeMacro{\indexingontrue} First you must add the \textsf{makeidx} package +% to the list of packages you call in your preamble. (If you are planning to set several +% indices, call \textsf{splitindex} instead.) Then, to set up the Index section of your % volume, issue |\indexingontrue| in your preamble. This will create % the external file for your index information and send that file the % typesetting information for its title. You must process this @@ -1149,7 +1226,7 @@ % % \textsf{poemscol} sets up a two-column index with a simple running % header. (Setting up a two-column index, however, requires that you -% include the \textsf{multicol} package in your |\usepackage{}| list.) +% include the \textsf{multicol} package in your |\usepackage| list.) % To turn indexing off, issue |\global\indexingonfalse|. % % Enter the individual index entries in the poems as you normally @@ -1216,7 +1293,7 @@ % environment for divider pages in collections made up of several % volumes. Volume title pages will always appear on recto pages with blank verso pages. % \textsf{poemscol} will also automatically create a blank verso page -% preceding the volume title page if it necessary. The +% preceding the volume title page if it is necessary. The % |maintitlepage| environment is for the title page of the whole % book. The main title page will also automatically always be on a % recto page. These divider pages have special @@ -1229,18 +1306,18 @@ % \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{}|, -% |\volumetitlemiddleline{}|, and |\volumetitlelastline{}| macros are +% |\wholebooktitle| is for the title of the entire collection. +% |\volumetitle| is for the title of an individual volume within a +% Collected Poems. 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 % broken up both in the text and in the table of contents. % \textsf{poemscol} will break up long titles on its own anyway % 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 +% |\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 % edition, these commands send the title (and the formatting % information about it) to the table of contents file and to the @@ -1248,12 +1325,12 @@ % % \DescribeMacro{\volumeepigraph} \DescribeMacro{\volumeattribution} % \DescribeMacro{\volumeheader} \DescribeMacro{\leftheader} -% \DescribeMacro{\rightheader} |\volumeepigraph{}| and -% |\volumeattribution{}| are for epigraphs and attributions on the -% divider pages. |\volumeheader{}| or |\rightheader{}| is the right +% \DescribeMacro{\rightheader} |\volumeepigraph| and +% |\volumeattribution| are for epigraphs and attributions on the +% divider pages. |\volumeheader| or |\rightheader| is 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 % 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. @@ -1325,12 +1402,12 @@ % %\begin{sloppypar} % You may have notes with multiple paragraphs. The default settings for all of -% the forms of endnotes are set with hanging indentation, which probably is not +% 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 % this problem. The first way is to change all of the paragraphs of the notes to % normal indentation, which you can do by issuing % |\literaltextnote{\setlength{\parindent}{\noteindentation}}| just after issuing |\maketextnotes| . -% You can change the amoutn of indentation by changing the value of the +% You can change the amoubt of indentation by changing the value of the % length |\noteindentation| (the default value is 1 em). % You should remember to issue similar % commands for emendations, explanatory notes, and whatever kinds of notes you @@ -1340,7 +1417,9 @@ % \DescribeMacro{\noteparbreak} % Alternatively, if you want to keep the hanging indent for the page number, but still have paragraph % breaks in the note, issue |\noteparbreak| whenever you want a paragraph break -% in the midst of a note. By default, |\noteparbreak| indents the new paragraph +% in the midst of a note. The first paragraph will have a hanging indent for the +% page number, but every paragraph that follows a |\noteparbreak| will have normal +% paragraph indentation. By default, |\noteparbreak| indents the new paragraph % 1em. You can change this by changing the value of the length % |\noteindentation|. % @@ -1372,31 +1451,31 @@ % \DescribeMacro{\sources} To record information about the copy text, % 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{}| macro. -% Typically, you should issue this macro after you have issued -% |\poemtitle{}| and before you issue |\begin{poem}|. If you wish to +% that information in the argument to the |\sources| command. +% 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 +% 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 +% |\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 % 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. % % \DescribeMacro{\textnote} % \DescribeMacro{\emendation} % \DescribeMacro{\explanatory} -% |\textnote{}| is used to capture variants and tie them to the +% |\textnote| is used to capture variants and tie them to the % correct line number. You don't have to count line numbers; -% \textsf{poemscol} keeps track of them for you. Issue |\textnote{}| +% \textsf{poemscol} keeps track of them for you. Issue |\textnote| % immediately after the |\verseline| command which marks the ending of % the line you wish to comment upon. Put the text of your note (which % may be simply the recording of a variant in standard notation) into -% the argument of the macro. You should put both the lemma and the -% variants or comment in the argument to the |\textnote{}| macro. -% For emendations, use |\emendation{}|, and for explanatory notes, -% use |\explanatory{}|. These notes go to their own endnote sections. The +% the argument of the command. You should put both the lemma and the +% 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 % opened if there actually are explanatory notes or emendations for that poem. @@ -1456,7 +1535,7 @@ % Overlapping lemmas, or lemmas that % include stanza breaks, do not pose any difficulties for |poemscol|. % -% |\emendation{}| and |\explanatory{}| are used exactly as |\textnote{}| +% |\emendation| and |\explanatory| are used exactly as |\textnote| % is. Issue the emendation or the explanatory note as the argument to % the command. Place the command immediately after the |\verseline| that % concludes the line to which it is a comment. These commands also can @@ -1470,7 +1549,7 @@ % % \DescribeMacro{\quotedversecorrectiontextnote} If a textual note % \emph{ends} with a quotation in verse, you should -% follow the |\textnote{}| entry with +% 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 @@ -1493,8 +1572,8 @@ % after the close of the textnote (not in the text of the textnote % itself). % -% \DescribeMacro{\accidental} |\accidental{}| behaves exactly like -% |\textnote{}|. If you wish to distinguish between accidentals and +% \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 @@ -1513,7 +1592,7 @@ % 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{}| +% 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 @@ -1534,8 +1613,8 @@ % typescript variants, issue |\global\includetypescriptsfalse| in your % preamble. You can issue |\global||\includetypescriptstrue| in your % preamble, to remind yourself that you are including typescript -% variants. In that (default) case |\tsvariant{}| will behave exactly -% like |\textnote{}|, and entries in other notes marked with +% variants. In that (default) case |\tsvariant| will behave exactly +% like |\textnote|, and entries in other notes marked with % |\tsentry| will be included in your output. % % Here is how to use |\tsentry|: @@ -1543,18 +1622,18 @@ % those entries in a list with variants from other published versions % (as for instance when a comma 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{}| macro. If typescript variants +% |\textnote| as usual, marking the relevant variant in the list of +% variants with the |\tsentry| command. If typescript variants % are excluded, the typescript entry will also be excluded. % -% Here is a typical use of the |\tsentry{}| command: +% Here is a typical use of the |\tsentry| command: % \begin{verbatim} % Of moonlit desert. A stallion, white and flashing, slips,\verseline % \textnote{Of moonlit] Of the moonlit {\em NY\/}\tsentry{, SP85TS % (revised in black pen to SP85)}} % \end{verbatim} % -% Notice that since the |\tsentry{}| comes in the middle of the list, +% Notice that since the |\tsentry| comes in the middle of the list, % it begins with a comma. You might expect an |\unskip| command % before the comma, to prevent % \LaTeX\ from adding white space before the comma. \textsf{poemscol} @@ -1562,8 +1641,8 @@ % comma or a semicolon. % % You can -% mark individual variants with |\tsentry{}| in the arguments to the -% |\explanatory{}| and |\emendation{}| commands as well, and +% mark individual variants with |\tsentry| in the arguments to the +% |\explanatory| and |\emendation| commands as well, and % |\tsentry| will also behave normally in any endnote or footnote section % you define using |\definenewnotetype|. % @@ -1572,7 +1651,7 @@ % again using |\definenewnotetype|. To do this, you would also have to % copy all of the emendations, explanatory notes, and textual notes % which have a |\tsentry| in their arguments, and add -% |\tsvariant{}| commands in those places. For information about +% |\tsvariant| commands in those places. For information about % |\definenewnotetype| see section \ref{definingnewnotes}. % % \DescribeMacro{\margreftextnote} @@ -1594,11 +1673,12 @@ % section \ref{margreftextnote}, page \pageref{margreftextnote}. % % \section{Creating new kinds of endnote} \label{definingnewnotes} -% \DescribeMacro{\definenewnotetype} The |\definenewnotetype| macro +% \DescribeMacro{\definenewnotetype} The |\definenewnotetype| command % can be used to create new kinds of endnote, in case the kinds -% \textsf{poemscol} defined are not enough. |\definenewnotetype| -% takes five arguments. They are \begin{enumerate} \item A base name -% used to construct \begin{itemize} \item some |\if| variables (e.g. +% \textsf{poemscol} has predefined do not suffice. |\definenewnotetype| +% takes five arguments. They are (assuming you are creating a new +% kind of note to be called a ``mynote''): \begin{enumerate} \item A base name +% used to construct \begin{itemize} \item some |\if| variables (e.g.\ % |\ifmynoteson| to see whether you are collecting ``mynotes'', % |\ifnomynoteyet| to see whether you have written a ``mynote'' for a % particular poem yet, |\ifmynotestwocol| to set the notes in two @@ -1611,33 +1691,35 @@ % that every |\if| that refers to a singular note % is singular (|\ifnomynoteyet|). \item The name for the output % channel for writing the notes to the appropriate external file. -% This name will always be plural. \item The name for the ``literal'' +% This name will always be plural (e.g.\ ``mynotes"). \item The name for the ``literal'' % command for writing literal, unexpanded text on the file (as -% |\literaltextnote{}| does on the textnotes file), and for the note +% |\literaltextnote| does on the textnotes file), and for the note % command that sends the actual textual note (line number and all) to -% the section (e.g. |\mynote{}|), also the command to write notes in -% line-numbered prose (e.g. |\prosemynote{}{}|) or prose numbered by -% paragraph and sentence (e.g. |\pmmynote{}|). These commands will -% always be singular. \item The name of the |\put| command (e.g. +% the section (e.g.\ |\literalmynote| and |\mynote|), also the command to write notes in +% line-numbered prose (e.g.\ |\prosemynote|) or prose numbered by +% paragraph and sentence (e.g.\ |\pmmynote|). These commands will +% always be singular. \item The name of the |\put| command (e.g.\ % |\putmynotes|) which closes the external file for the notes section, % reads it back in to your document, and adds an entry in the table of % contents for that notes section. This command will always be -% plural. \item The name of the |\margref| command for putting a +% plural. (There won't be a |\makemynotes| command, +% because |\definenewnotetype| takes its place.) +% \item The name of the |\margref| command for putting a % marginal mark next to a line giving the page number in the apparatus -% where a note is to be found (e.g. |\margrefmynote|) \end{itemize} +% where a note is to be found (e.g.\ |\margrefmynote|) \end{itemize} % \item The extension for the external file which will hold the notes % as you generate them. ``Emendations'' for instance, are written to % an external file called |\jobname.emd| The file name will always be % |\jobname|, and the different species of endnotes will all have -% distinctive extensions. (|\jobname| is a macro that always expands +% distinctive extensions. (|\jobname| is a command that always expands % to the name of your top level source file. If, for instance, I am % setting running a file called ``myfile.tex'' through \LaTeX\, % |\jobname.emd| translates to ``myfile.emd.'') \item The title of the % notes section as you wish it to appear in the running header (e.g. -% ``Emendations''). \item The title of the notes section as you wish +% ``Mynotes to ''). \item The title of the notes section as you wish % it to appear on the first page of the notes section (e.g. -% ``EMENDATIONS''). \item The title of the notes section as you wish -% it to appear in the table of contents. \end{enumerate} +% ``MYNOTES''). \item The title of the notes section as you wish +% it to appear in the table of contents (e.g.\ ``Mynotes''). \end{enumerate} % % \sloppypar So, for instance,\begin{verbatim} % \definenewnotetype{xyznote}{xyz}{Xyznotes to}{XYZNOTES}{Xyznotes} @@ -1733,11 +1815,11 @@ % make it known to \textsf{manyfoot}, which requires each level of % footnote to be given a unique suffix (usually a capital letter of % the alphabet). You can declare a new footnote level called -% |\footnoteE{}| for instance, by issuing +% |\footnoteE| for instance, by issuing % |\DeclareNewFootnote[para]{E}|. You will want notes which don't put % a mark in the body of the text, and begin with the line number or % range of line numbers of the lemma. To define a footnote called -% |\mynote{}|, first declare new footnote |\footnoteE| (A, B, C and D +% |\mynote|, first declare new footnote |\footnoteE| (A, B, C and D % are reserved for sources, textual notes, emendations, and explanatory notes, % respectively). Then issue: \begin{verbatim} % \newcommand{\mynote}[2][0]{\setlemmarange{#1}\\ @@ -1755,7 +1837,7 @@ % You may wish, rather than using endnotes or footnotes, simply to print your % notes at the end of each poem. To do this for simple notes, issue |\makepoemendnotes| just % after |\begin{poem}|. Issue |\poemendnote| where you wish to make a note, -% using the same conventions you use for |\textnote|. Where you want to output +% using the same conventions for line ranges you use for |\textnote|. Where you want to output % the notes, issue |\putpoemendnotes|. These notes can have multi-line lemmas, % just like textual notes. % @@ -1813,7 +1895,7 @@ % reads in the existing .aux file, and overwrites it with a new one.} % % \label{putexternalfiles} -% \DescribeMacro{\putemendations} This macro closes the external file +% \DescribeMacro{\putemendations} This command closes the external file % for emendations and reads it in. It also puts an entry for the % emendations section into your table of contents. After % |\putemendations| has read in the external file for emendations, you @@ -1843,7 +1925,7 @@ % command, see section \ref{multipleindex}, p.~\pageref{multipleindex}. % % \DescribeMacro{\finish} The -% |\finish| macro is deprecated but still available. It is designed +% |\finish| command is deprecated but still available. It is designed % to be placed just before |\end{document}| (which, in fact, it % replaces --- but you should still put an |\end{document}| at the end % of your document for form's sake). |\finish| closes the external @@ -1859,28 +1941,45 @@ % *) at the bottom of certain pages marks places where a stanza break % and a page break coincide. If you have an editor's introduction % preceding your notes section, or a list of abbreviations, you may -% wish to consult the |\finish| macro for suggestions about how to add +% wish to consult the |\finish| command for suggestions about how to add % the lines to read those files in and add entries for them in the % table of contents. % % % \section{Special Cases} -% \subsection{~Epigraphs, attributions etc.} +% \subsection{~Epigraphs, attributions etc.} \label{centerepigraphs} % \DescribeMacro{\epigraph} \DescribeMacro{\headnote} % \DescribeMacro{\attribution} \DescribeMacro{\poemdedication} -% |\epigraph{}|, |\headnote{}|, |\attribution{}|, and |\poemdedication{}| set +% |\epigraph|, |\headnote|, |\attribution|, and |\poemdedication| set % their arguments as epigraphs, headnotes, attributions, or -% dedications for poems or poetic sequences. You can adjust the left and right margins -% of epigraphs by changing the values of |\epigraphquoteleftmargin| -% or |\epigraphquoterightmargin|. +% dedications for poems or poetic sequences. +% +% \DescribeEnv{epigraphenvironment} +% If your epigraph or headnote is a prose passage of more than one paragraph, or a verse +% passage of more than one stanza, use the |epigraphenvironment| environment +% 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.) +% +% \DescribeMacro{\centertitles} +% Issuing |\centertitles| moves the margins in on both sides by the length +% |\centerepigraphindentation| (the default is 6em). The margins for +% uncentered epigraphs and the like are controlled by the length |\normalepigraphindentation| +% (the default is 1.5em). Both values can be adjusted by using |\setlength|. +% +% After issuing |\centertitles| you can move epigraphs and similar things back to the margin +% by issuing |\centerepigraphsonfalse|. After issuing |\centertitles| you can put titles at the margin +% while leaving epigraphs alone by issuing |\centertitlesonfalse|. +% % If you have dedications, epigraphs, or attributions on % the divider pages of editions that combine several volumes of -% poetry, use |\volumededication{}|, |\volumeepigraph{}|, and -% |\volumeattribution{}|. +% poetry, use |\volumededication|, |\volumeepigraph|, and +% |\volumeattribution|. These commands are unaffected by |\centertitles|. % -% \subsection{~Appending Publication Date} +% \subsection{~Appending publication date} % \DescribeMacro{\poemdate} You can append the date of the poem -% with |\poemdate{}|. Issue |\poemdate{}| just after |\end{poem}|. You can +% with |\poemdate|. Issue |\poemdate| just after |\end{poem}|. You can % 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 @@ -1910,7 +2009,7 @@ % after the passage. The way to set this is to issue |\end{stanza}| % at the end of the stanza before the prose insert. Then issue % |\saveverselinenumber|. Then issue |\end{poem}|. Insert the prose -% quotation (perhaps followed by |\attribution{}|). Then issue +% quotation (perhaps followed by |\attribution|). Then issue % |\begin{poem}| followed by |\restoreverselinenumber| and |\begin{stanza}|. % Then begin entering the rest of the poem as usual. Longer, independent prose % sections (such as the author's preface or prose poems) require @@ -1919,8 +2018,10 @@ % % \subsection{~Quoted verse} % Sometimes you wish to quote verse within verse (as when a speaker -% in a verse play quotes a poem). \DescribeMacro{\quotedverse} The -% |quotedverse| environment is desiged for this contingency. +% in a verse play quotes a poem). \DescribeMacro{quotedverse} The +% |quotedverse| environment is designed for this contingency. If +% you issue |\verseline| commands or the |stanza| environment, line counting +% and annotation will proceed as usual in quoted verse. % % \subsection{~Multiline poem titles}\label{multilinetitles} % \DescribeMacro{\poemtitlefirstline} @@ -1931,7 +2032,7 @@ % happen in the middle of a title, or immediately after a title. In % the second place, they raise questions about how the author wished % to break them up over several lines. If you think it might matter, -% these macros make it possible for you to ensure that long titles are +% these commands make it possible for you to ensure that long titles are % broken in exactly the same way in your text and in your table of % contents. (I didn't pursue this question for titles in notes % sections, and in notes sections these commands simply concatenate a @@ -1939,7 +2040,7 @@ % % There are similar commands for most but not all of the whole series of % titles for sequences, sequence sections, sequence subsections, and so on. -% If you need macros for a kind of multi-line title that is not already +% If you need commands for a kind of multi-line title that is not already % defined, see below at section \ref{customizing titles}, page \pageref{customizing titles}. % % Alternatively, you can just let \textsf{poemscol} handle the long @@ -1947,7 +2048,7 @@ % care how long titles were broken up, this would probably be the % best thing to do. Remember also that if \textsf{poemscol} breaks a % title across two lines, you can always force it not break the line -% by using enclosing the argument to |\poemtitle{}| in |\hbox{}|. You +% by using enclosing the argument to |\poemtitle| in an |\hbox|. You % may get a complaint on your log file about an overfull |\hbox| if % you do this, however. % @@ -1955,20 +2056,20 @@ % % \begin{sloppypar} % \DescribeMacro{\poemsectiontitle} -% |\poemsectiontitle{}| and |\poemsubsectiontitle{}|, as their -% names imply, are for the titles of sections or subsections of poems -% that have them. |\poemfirstsectiontitle| is for the first section +% |\poemsectiontitle| and |\poemsubsectiontitle|, as their +% names imply, set their arguments as the titles of sections or subsections of poems. +% |\poemfirstsectiontitle| is for the first section % of a poem with many sections. (It differs from |\poemsectiontitle| % in that it tries to make it harder for a page break to separate the % title of a poem from the title of its first section.) -% |\poemsectiontitlefirstline{}|, |\poemsectiontitlemiddleline{}|, -% |\poemsectiontitlelastline{}|, |\poemsectiontitlenocontents{}|, and -% |\poemsectiontitlebaretitle{}|), as their titles imply, are used for +% |\poemsectiontitlefirstline|, |\poemsectiontitlemiddleline|, +% |\poemsectiontitlelastline|, |\poemsectiontitlenocontents|, and +% |\poemsectiontitlebaretitle|), as their titles imply, are used for % special cases such as long section titles, if you wish to specify % explicitly how the title is to be broken up in the text and in the -% table of contents. You can construct variants of these macros for +% table of contents. You can construct variants of these commands for % dealing with special cases I didn't anticipate by using -% the macros described in \ref{customizing titles}. +% the commands described in \ref{customizing titles}. %.\end{sloppypar} % % \subsection{~Poetic sequences}\label{poeticsequences} @@ -1982,14 +2083,14 @@ % poems in sections. For one thing, a sequence manifests a different % relationship between part and whole than a poem in sections does, % and often provides stronger experiences of momentary closure between -% sections.) |\sequencetitle{}| sets the title of the sequence, -% |\sequencesectiontitle{}| sets the titles of the sections of the -% sequence, and |\sequencesubsectiontitle{}| sets the titles of +% sections.) |\sequencetitle| sets its argument as the title of the sequence, +% |\sequencesectiontitle| sets the titles of the sections of the +% sequence, and |\sequencesubsectiontitle| sets the titles of % subsections of the sequence (there is even a command for the title -% of sub-subsections, |\sequencesubsbusectiontitle{}|). -% |\sequencefirstsectiontitle{}| gives a little more +% of sub-subsections, |\sequencesubsbusectiontitle|). +% |\sequencefirstsectiontitle| gives a little more % vertical space between the main title and the first section title -% than |\sequencesectiontitle{}| gives between adjacent sections later +% than |\sequencesectiontitle| gives between adjacent sections later % on in the sequence (since the over-title for the sequence is in % larger type) and adjusts the page breaking penalties to reflect the % fact that such titles should not occur near the bottom of a page, @@ -2006,14 +2107,14 @@ % poetic sequences, such as cases where you wish to specify how long % titles will be broken up into lines, or where you wish no entry to % be made for the section in the table of contents or in the notes -% sections. These macros don't of course exhaust the dizzying -% possibilities, but from them you can construct whatever other macros +% sections. These commands don't of course exhaust the dizzying +% possibilities, but from them you can construct whatever other commands % you may need. % % Here is a list of all of the defined title commands. % % \begin{itemize} -% \item Macros for Poem titles +% \item Commands for Poem titles % \begin{itemize} % \item |\poemtitle| % \item |\poemtitlefirstline| @@ -2118,9 +2219,9 @@ % the left). |\JHpoemtitle| and its siblings place the marginal % reference using |\marginpar|. % -% \DescribeMacro{\setmpargpoemtitle} -% |\setmargpoemtitle{}{}| is a more general version of -% |\JHpoemtitle{}{}|, with the second argument being any commands you +% \DescribeMacro{\setmargpoemtitle} +% |\setmargpoemtitle| is a more general version of +% |\JHpoemtitle|, with the second argument being any commands you % want to be issued while the title is being processed. % % \DescribeMacro{\margreftextnote}\label{margreftextnote} @@ -2141,7 +2242,7 @@ % than |\pmclsidepar| to set the note, because I had to use % |\marginpar| for |\JHpoemtitle| and its siblings, and I wanted the % whole family of markers to be controlled by the same settings. You -% use the settings that control the behavior of |\marginpar| (e.g. +% use the settings that control the behavior of |\marginpar| (e.g.\ % |\mparswitch| and |\reversemarginpar|) to control the behavior of % these marks. % @@ -2160,7 +2261,7 @@ % from the pifonts collection in the marginal marks made by % |\margreftextnote| and its siblings. I have set the default to % |\dag|, so as not to depend upon yet another style package. You can -% choose another mark using |\setmargrefmarker| (e.g. +% choose another mark using |\setmargrefmarker| (e.g.\ % |\setmargrefmarker{\ding{228}}|). % % \DescribeMacro{\margrefemendation} |\margrefemendation| is a @@ -2171,21 +2272,21 @@ % % \subsection{~Empty poem titles and italicized poem titles} % -% \DescribeMacro{\poemtitlenotitle{}} -% |\poemtitlenotitle{}|, with its paradoxical name, is for poems +% \DescribeMacro{\poemtitlenotitle} +% |\poemtitlenotitle|, with its paradoxical name, is for poems % without formal titles. Usually such poems are referred to by their -% first lines. This macro does not produce a title in the text, but +% first lines. This command does not produce a title in the text, but % sets its argument in the table of contents and in the notes. Usually % you use the first line as the moral equivalent of a title. % -% \DescribeMacro{\poemtitleitalic{}{}} +% \DescribeMacro{\poemtitleitalic} % Titles % with italics or other special formatting posed special problems in % earlier versions (before version 1.7) since the typesetting commands % gummed up how I passed parameters around that I was unable to solve % using |\protect|. All of these commands are obsolete now, but are % retained for backward compatibility. -% |\poemtitleitalic{}{}| takes +% |\poemtitleitalic| takes % two arguments. The first is the title of the poem with the italics % (or small capitals or international characters or what have you), % for typesetting, and the second is the title without the commands, @@ -2193,10 +2294,10 @@ % no longer needs to treat italics in titles in a different way, it can % be anything you want, since the second argument is discarded.) % -% \DescribeMacro{\poemtitlenotitleitalic{}{}} -% |\poemtitlenotitleitalic{}{}|, with its doubly paradoxical name, +% \DescribeMacro{\poemtitlenotitleitalic} +% |\poemtitlenotitleitalic|, with its doubly paradoxical name, % is for poems without formal titles but with italicized words in their -% first lines. |\poemtitlenotitleitalic{}{}| takes two arguments. The +% first lines. |\poemtitlenotitleitalic| takes two arguments. The % first is the first line with the italics (for typesetting % purposes), and the second is the % first line without the italics (for crossreference purposes). This command @@ -2207,19 +2308,20 @@ % \DescribeMacro{\poemtitlebaretitle} % \DescribeMacro{\poemtitleonlycontents} % \DescribeMacro{\poemtitleonlynotes} -% A user planned to attach a footnote to a poem title, but didn't want the mark or the text of the +% If you have a problem title, one for instance +% in which the title in the text might cause problems in the contents or in the notes, +% you can send information +% separately to the places it will be used. +% For example, a user planned to attach a footnote to a poem title, +% but didn't want the mark or the text of the % note to show up in the contents or in the endnotes. I would usually % have advised him to use |\sources| to send the text of the note to the endnotes, % but he really wanted the title to include the footnote mark and to put the footnote % on the same page. The solution to this problem % was to set the title in the text separately from setting it in the notes and in the contents. -% If you have a problem title, one for instance -% in which the title in the text might cause problems in the contents or in the notes, -% you can send information -% separately to the places it will be used. -% |\poemtitlebaretitle{}|, for instance simply sets the title in the text. Then -% you can use |\poemtitleonlycontents{}| to send the title to the contents -% and |\poemtitleonlynotes{}| to send the title to the notes. These commands +% |\poemtitlebaretitle|, for instance simply sets the title in the text. Then +% you can use |\poemtitleonlycontents| to send the title to the contents +% and |\poemtitleonlynotes| to send the title to the notes. These commands % are defined for poem titles, and for some but not all of the whole range of titles including % sequence titles, sequence section titles, sequence section subtitles, and so on. But % it would be easy to roll your own versions of these commands by looking below at @@ -2228,8 +2330,8 @@ % % \DescribeMacro{\poemtitlenocontents} % \DescribeMacro{\poemtitlenonotes} -% \DescribeMacro{\poemtitlenotitle{}} -% There are also macros to send information to any two of the relevant locations +% \DescribeMacro{\poemtitlenotitle} +% There are also commands to send information to any two of the relevant locations % but not the third. |\poemtitlenocontents| sends the title to the text and to the notes, % but not to the contents. |\poemtitlenonotes| sends the title to the text and to the % contents, but not to the notes. |\poemtitlenotitle| sends the title to the contents and the @@ -2237,11 +2339,11 @@ % % Remember that in the last resort, you can send information to the contents section % with |\literalcontents|. To actually set a contents entry using |\literalcontents| is a tall order, -% however, since you would have to include all the information from the |\c@ntentsinfo| macro +% however, since you would have to include all the information from the |\c@ntentsinfo| command % for the relevant type of title. (For what |\c@ntentsinfo| does, % see section \ref{customizing titles}, below.) % For instance, for a poem called -% Test Poem that is the first in the volume, that would be: +% Test Poem, that would be: % % \begin{verbatim} % \literalcontents{\setlength\contentsentryoverrun{\contentsindenttwoamount } @@ -2257,10 +2359,13 @@ % \end{verbatim} % % Another tricky thing about this method is the |\pageref| line in the above, which is a pageref to find -% the page the poem appears on. You should put |\label{testpoemlabel}|, with any unique -% text for the label, on the page of the text where the poem occurs, in order to capture +% and set in the contents the number of the +% page the poem appears on. You should put |\label{testpoemlabel}|, with any unique +% text for the label (so long as it is the same one used in the |\pageref| line), +% on the page of the text where the poem occurs, in order to capture % the correct page number. (Alternatively, you could just put the actual page number in -% here instead of the pageref line.) +% what you send to the contents with |\literalcontents| instead of the pageref line, but you will +% have to remember to change this number if anything changes in your edition.) % % Remember also that you can send information to the relevant notes sections using % |\literaltextnote|, |\literalexplain|, and |\literalemend|. @@ -2270,8 +2375,8 @@ % number of ways of setting titles, but conceivably you may wish to % define your own. Here is a template for designing a new kind of % title. Suppose you wish to create a kind of title called -% |\mytitle{}|. It would take one argument, which would be the title -% itself. The macro defining the |\mytitle| command should call three macros, +% |\mytitle|. It would take one argument, which would be the title +% itself. The command defining the |\mytitle| command should call three commands, % |\set@p@emtitle|, to set the title in the main text and make the % label for use by the contents and notes sections, |\c@ntentsinfo| to % set the title in the table of contents, and |\t@xtnotesinfo|, which @@ -2337,14 +2442,14 @@ %\DescribeMacro{\restoresinglelinesettings} % If you wish to design a title which might have multiple lines, % and you wish to specify how those lines are broken up, you -% will need to write three macros: one for the first line, one for +% will need to write three commands: one for the first line, one for % middle lines, and one for the last lines. % (This only matters if you care how the title is broken up. You % can choose to let \LaTeX\ do the breaking if you wish.) Before issuing % |\set@p@emtitle| issue |\firstlinesettings|, |\middlelinesettings|, % or |\lastlinesettings| (as the case may require). And issue % |\restoresinglelinesettings| last of all in each of your three -% macros. The lines will be broken in the table of contents and in +% commands. The lines will be broken in the table of contents and in % the body of the text in the same way, but will be run in in the % notes sections. % @@ -2453,16 +2558,21 @@ % after issuing |\putpoemcontents|. |\resetpagestyle| resets the page % style to ``main'' (which is the same as the original ``fancy''). % -%You can change the text in the left running head +% Because |\putpoemcontents| resets the page style to ``main,'' any page style you defined +% in the preamble becomes forgotten if you include a table of contents. There are two +% possible solutions to this. The first is to define your page style after you have issued +% |\putpoemcontents|. The second is to redefine the fancypage style ``main,'' so that it does +% what you want. In either case, do not forget to issue |\pagenumbering{arabic}| +% after |\putpoemcontents|, else all of your page numbers will be in roman numerals. +% You can find the default +% definitions of those ``fancy'' and ``main'' below at \ref{pagestyledefs}, page \pageref{pagestyledefs}. +% +% +% You can change the text in the left 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 % |\rightheader{your header}|. % -%If you want to change to look of the headers, you -% can't just issue, say |\fancyhead[RO]{{\small\textrm{\thepage}}}|. You must -% redefine the fancypage style ``fancy'' or ``main.'' You can find the default -% definitions of those page styles below at \ref{pagestyledefs}, page \pageref{pagestyledefs}. -% % \subsection{~Special page style for long poems} The fancy page style ``longpoem'' % will add information of the form ``firstline--lastline'' to the running header. This % page style otherwise resembles ``main,'' and ``fancy.'' @@ -2471,11 +2581,27 @@ % to issue |\newpage|, otherwise the running header will list the first line on the page from the % first poem and the last line on the page from the second poem. % +% If you use ``longpoem'' and you have a table of contents, you must issue +% |\pagestyle{longpoem}| at some point \emph{after} issuing |\putpoemcontents|. +% Do not forget to issue |\pagenumbering{arabic}| +% after |\putpoemcontents|, else all of your page numbers will be in roman numerals. Also, if you +% have back matter, you must issue |\pagestyle{main}| at the end of your poetry section, +% before the back matter starts, since otherwise your header will include the last line +% number \textsf{poemscol} saw. Issuing |\pagestyle{main}| will restore the normal page +% headers for the backmatter +% sections. +% % 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}|. % +% You may need to play with |\leftheader| and |\rightheader| to get the information you +% want into the header. You might, for instance, what to use something like +% |\leftheader{``Your main title'' \hfil ``Your poem title''}| and +% |\rightheader{``Your volume title'' \hfil ``Your poem title''}|. Whatever else you put into +% the header, the last thing should be your poem title, since it will be followed by the line +% numbers. % % \subsection{~Page geometry and type leading} % @@ -2564,13 +2690,13 @@ % this method may show up with longer prose extracts. % % \DescribeMacro{\prosesectiontitle} Prose sections may be titled with -% |\prosesectiontitle{}| which is essentially just |\poemtitle|, or +% |\prosesectiontitle| which is essentially just |\poemtitle|, or % |\prosesectiontitlenotitle|, which is essentially just % |\poemtitlenotitle|. (Remember that if you use the latter command, % you must specify a ``dummy'' title to use in the note and contents % sections.) They will be formatted in the notes and contents % sections as poems are. Alternatively, you can use -% the macros for defining new kinds of titles, in section +% the commands for defining new kinds of titles, in section % \ref{customizing titles}, page \pageref{customizing titles}, % to make new kinds of titles for prose sections. % @@ -2587,7 +2713,7 @@ % \DescribeMacro{\setprosemodulo} % If you wish to set the modulo repeat for line numbering in prose to % some value different for that from verse contexts, issue the new -% modulo as the argument to |\setprosemodulo{}|. +% modulo as the argument to |\setprosemodulo|. % % It is possible, if a prose section is interpolated in the midst of % verse, to number the prose and verse continuously. To move from a @@ -2630,7 +2756,7 @@ % |\makeexplanatorynotes| have been issued, the endnotes will be sent % to the usual sections, where all the notes from that prose section % will be grouped into a paragraph, with the entry headed by the title -% given by |\prosesectiontitle{}|, just as if that were the title of a +% given by |\prosesectiontitle|, just as if that were the title of a % poem. |\textnotesatfoot|, |\emendationsatfoot|, and % |\explanationsatfoot| will send the notes from prose contexts to the % usual footnote levels. Notes commands in prose contexts take three @@ -2649,8 +2775,8 @@ % every note. The third argument is the text of the note, which % should include both the lemma and the rest of the note, as in the % notes for verse sections. -% |\proseemendation[]{}{}| and -% |\proseexplanatory[]{}{}| are coded the same way. So, if you wished +% |\proseemendation[]| and +% |\proseexplanatory[]| are coded the same way. So, if you wished % to make a textual note on a passage that begins with ``Call me % Ishmael.'' and ends ``a way of driving away the spleen,'' you would % issue at the point where the note is to @@ -2667,9 +2793,9 @@ % \DescribeMacro{\prosetsaccidental} % You can issue |\sources| and |\tsentry| in prose contexts as usual. % For typescript variants and accidental variants you need to issue -% |\prosetsvariant[]{}{}|, |\proseaccidental{}{}|, and -% |\prosetsaccidental{}{}|. |\prosetsvariant| is entered just as -% |\prosetextnote[]{}{}| is, with an optional argument (for use with +% |\prosetsvariant[]|, |\proseaccidental|, and +% |\prosetsaccidental|. |\prosetsvariant| is entered just as +% |\prosetextnote[]| is, with an optional argument (for use with % line ranges, as usual), and two mandatory arguments (the first a % label to capture the line number, the second the lemma and comment). % @@ -2747,14 +2873,14 @@ % code for |\pmsentence|). You can also avoid overlapping sentence % numbers by using |\pmsentencetwo| and its siblings, defined below. % You can set the modulo for sentence marginal numbers by issuing -% |\setpmmodulo{}|. +% |\setpmmodulo|. % % \DescribeMacro{\pmsentencetwo} % \DescribeMacro{\pmsentencethree} % \DescribeMacro{\pmsentencefour} If you know, from a prior run, % that there will be a second or third sentence on some particular % line, marking them with these commmands will ensure that the -% marginal sentence numbers do not overwrite each other. These macros +% marginal sentence numbers do not overwrite each other. These commands % are something of a kludge, but they will do until I figure out how % to do this better. % @@ -2828,7 +2954,7 @@ % \subsection{~Cross references by sentence and paragraph} % \DescribeMacro{\sentencelabel} % To make labels that refer to sentences or paragraphs, issue -% |\sentencelabel{}|. The label will be either both the paragraph +% |\sentencelabel|. The label will be either both the paragraph % number and the sentence number (if you are resetting sentence numbers % by paragraph), or only the sentence number (if you are not resetting % sentence numbers by paragraph). @@ -2890,7 +3016,7 @@ % probably have to specify page breaks every two or three pages to keep % the texts in register anyway, so you will have to use |\newpage| % to mark every page break. If you are willing to set the page breaks -% yourself, however, \textsf{poemscol} does provide macros for keeping the line count +% yourself, however, \textsf{poemscol} does provide commands for keeping the line count % correct on successive recto or verso pages, and for keeping track of % whether or not one was in the middle of a stanza when one closed the % previous verso or recto page (as the case may be). And it provides, in @@ -2950,7 +3076,7 @@ % If you wish to make titles for other things, % such as poetic sequences or sequence sections, you can use the techniques % described in section \ref{customizing titles} above, page \pageref{customizing titles}, -% except substitute the macro |\versoset@p@emtitle| +% except substitute the command |\versoset@p@emtitle| % or |\rectoset@p@emtitle| for |\set@p@emtitle|, using % all the same arguments you would have used with |\set@p@emtitle|. % @@ -3439,7 +3565,7 @@ % % % \StopEventually{\PrintChanges\PrintIndex} -% \section{Implementation} +% \section{Implementation}\label{implementation} % \subsection{~Page geometry and crop marks} @@ -3562,7 +3688,7 @@ % intractable widow problem in the contents or in the notes sections % by issuing |\literalcontents{\pagebreak}| or % |\literalemend{\pagebreak}| just before you issue the -% |\poemtitle{}| or |\volumetitle{}| that resulted in the problematic +% |\poemtitle| or |\volumetitle| that resulted in the problematic % title line.) \textsf{poemscol} also manipulates penalties for places like % the space between a poem's title and its first line. It defines % special values for the white space before and after poems and for @@ -3639,7 +3765,7 @@ % slightly modified to indent run over lines more. The idea is to % distinguish the automatic indentation of run over lines from the % explicitly declared indentation of indented lines. You can change -% the amount of indentation of runover lines with |\runoverindent{}|. +% the amount of indentation of runover lines with |\runoverindent|. % \label{versedefine} % \begin{macrocode} \def\makeatletter{\catcode`\@=11} @@ -4022,8 +4148,8 @@ \fancyhfoffset[RO,LE]{\headoffsetlength} \fancyhead[RO]{{\small\textrm{\thepage}}} \fancyhead[LE]{{\small\textrm{\thepage}}} -\fancyhead[CO]{\hfil{\small{\em \leftheadervalue ~ \myversemarks}}\hfil} -\fancyhead[CE]{\hfil{\small{\em \volumeheadervalue ~ \myversemarks}}\hfil} +\fancyhead[CO]{\hfil{\small{\em \volumeheadervalue ~\myversemarks}}\hfil} +\fancyhead[CE]{\hfil{\small{\em \leftheadervalue~\myversemarks}}\hfil} \fancyfoot[CE]{{\small \botmark}\hfil} \fancyfoot[CO]{\hfil{\small \botmark}} \renewcommand{\headrulewidth}{0pt} @@ -4095,8 +4221,8 @@ % Page breaks are slightly encouraged in stanza breaks. Notice that % entering a stanza sets the mark to |\relax| and leaving it sets the % mark to * (the default value of |\stanzaatbottom|). If you want to -% use some other symbol for this purpose, use |\stanzaatbottom{}| or -% |\nostanzaatbottom{}| (if you also want to mark cases where there +% use some other symbol for this purpose, use |\stanzaatbottom| or +% |\nostanzaatbottom| (if you also want to mark cases where there % is \emph{no} stanza break at the bottom of the page) to change it. % \begin{macrocode} \newenvironment{stanza}{\penalty-100\instanzatrue\mark{\nostanzaatbottomvalue\ }} @@ -4121,7 +4247,7 @@ % idea is to handle overrun titles the way overrun lines are handled % in verse. Contents entries indent the overrun slightly. Titles do % not indent the overrun relative to the first line, but preserve the -% indentation of that line. +% indentation of that line. % \begin{macrocode} \newlength{\contentsentryoverrun} \setlength{\contentsentryoverrun}{\contentsindentoneamount} @@ -4147,28 +4273,17 @@ % \end{macro} % The poem environment. The little trick about setting the language % number is designed to suppress automatic hyphenation in the poem -% environment. The booleans tell the |\emendation{}| and -% |\explanatory{}| macros that there have not yet been emendations or +% environment. The booleans tell the |\emendation| and +% |\explanatory| macros that there have not yet been emendations or % explanatory notes for this poem. The little trick with |\mark| sets % the value of |\mark| to the current value of |\stanzaatbottom| (by % default *) if the current location is in a poem but not in a stanza % (which is to say, in a stanza break). The |\pagestyle| for poetry % sets the value of |\mark| in the footer, which is * if the page break % happens at a stanza break, and |\relax| if the page break happens -% anywhere else. +% anywhere else. \label{poemdef} % \begin{macro}{poem} % \begin{macrocode} -% \newenvironment{poem}{\raggedright% -% \language=255%no hyphenation in verse -% \noemendyettrue% -% \noexplainyettrue% -% \setcounter{verselinenumber}{0}\setcounter{printlineindex}{0}% -% \nobreak\begin{verse}% -% \inpoemtrue\nobreak\mark{\relax}% -% }{\end{verse}% -% \inpoemfalse\mark{\relax}% -% \goodbreak\afterpoemskip%\bigskip -% } \newlength{\versewidth} \newenvironment{poem}[1][\linewidth] {\raggedright% @@ -4545,7 +4660,7 @@ % \end{macrocode} % \end{macro} % \begin{macro}{\hour} -% |\hour{}| is useful for typesetting the AM and the PM in the time. +% |\hour| is useful for typesetting the AM and the PM in the time. % \begin{macrocode} \newcommand{\hour}[1]{{{\textsc{#1}}\ $\!\!\!$} } @@ -5120,7 +5235,7 @@ \fi } \newif\ifcentertitleson -\newcommand{\centertitles}{\centertitlesontrue} +\newcommand{\centertitles}{\centertitlesontrue\centerepigraphsontrue} \makeatletter \newcommand{\set@p@emtitle}[6]{\setlength{\titleentryoverrun}{#6}% {#2}% @@ -5838,10 +5953,12 @@ } \newcommand{\JHpoemsubtitle}[2]{\JHsequencesectionsubtitle{#1}{#2} } -\newcommand{\JHdedication}[2]{\nopagebreak\afterpoemtitleskip\begin{epigraphquote}% +\newcommand{\JHdedication}[2]{\nopagebreak\afterpoemtitleskip\testforcenterepigraph% +\begin{epigraphquote}% \emph{#1}\JHlabel{#2}\end{epigraphquote}% \sources{\label{#2}}\afterpoemtitleskip\nopagebreak} -\newcommand{\JHepigraph}[2]{\nopagebreak\afterpoemtitleskip\begin{epigraphquote}% +\newcommand{\JHepigraph}[2]{\nopagebreak\afterpoemtitleskip\testforcenterepigraph% +\begin{epigraphquote}% \emph{#1}\JHlabel{#2}\end{epigraphquote}% \sources{\label{#2}}\afterpoemtitleskip\nopagebreak} % \end{macrocode} @@ -5948,12 +6065,34 @@ % \begin{macro}{\volumeepigraph} % \begin{macro}{\volumeattribution} % \begin{macrocode} -\newcommand{\epigraph}[1]{\nopagebreak\afterpoemtitleskip\begin{epigraphquote} - \emph{#1}\end{epigraphquote}\afterpoemtitleskip\nopagebreak} +\newif\ifcenterepigraphson +\centerepigraphsonfalse +\newlength{\centerepigraphindentation} +\setlength{\centerepigraphindentation}{6em} +\newlength{\normalepigraphindentation} +\setlength{\normalepigraphindentation}{1.5em} +\newcommand{\centerepigraphquote}{% +\setlength{\epigraphquoteleftmargin}{\centerepigraphindentation} +\setlength{\epigraphquoterightmargin}{\centerepigraphindentation} +} +\newcommand{\normalepigraphquote}{% +\setlength{\epigraphquoteleftmargin}{\normalepigraphindentation} +\setlength{\epigraphquoterightmargin}{\normalepigraphindentation} +} +\newcommand{\testforcenterepigraph}{\ifcenterepigraphson% +\centerepigraphquote +\else +\normalepigraphquote +\fi} +\newcommand{\epigraph}[1]{\nopagebreak\afterpoemtitleskip\testforcenterepigraph% +\begin{epigraphquote}% + \emph{#1}\end{epigraphquote}\afterpoemtitleskip\nopagebreak} \newcommand{\headnote}[1]{\epigraph{#1}} -\newcommand{\attribution}[1]{\nopagebreak\afterpoemtitleskip\begin{epigraphquote} +\newcommand{\attribution}[1]{\nopagebreak\afterpoemtitleskip\testforcenterepigraph% +\begin{epigraphquote}% {\small\emph{#1}}\end{epigraphquote}\afterpoemtitleskip\nopagebreak} -\newcommand{\poemdedication}[1]{\nopagebreak\afterpoemtitleskip\begin{epigraphquote} +\newcommand{\poemdedication}[1]{\nopagebreak\afterpoemtitleskip\testforcenterepigraph% +\begin{epigraphquote}% \emph{#1}\end{epigraphquote}\afterpoemtitleskip\nopagebreak} \providecommand{\dedication}[1]{\poemdedication{#1}} \newcommand{\volumededication}[1]{\par\bigskip\begin{volumetitlepagequote} @@ -5962,7 +6101,8 @@ \emph{#1}\end{volumetitlepagequote}} \newcommand{\volumeattribution}[1]{\par\smallskip\begin{volumetitlepagequote} {\small \emph{#1}}\end{volumetitlepagequote}} -%\newcommand{\poemdate}[1]{\begin{prosesection}\bigskip\raggedright[#1]\bigskip\end{prosesection}} + \newenvironment{epigraphenvironment}{\nopagebreak\afterpoemtitleskip\testforcenterepigraph% +\begin{epigraphquote}\em}{\end{epigraphquote}\afterpoemtitleskip\nopagebreak} \newlength{\dateindent}% \setlength{\dateindent}{\leftmargin}% \newcommand{\variabledateindent}{% @@ -7633,7 +7773,7 @@ r@#2\endcsname{}{}\@nil % \begin{macro}{\startparalleltexts} % Clears to a verso (even-numbered) page, fixes where to put line % numbers, modifies poem and stanza environments, changes where -% marginal line numbers are set, sets the booleans. +% marginal line numbers are set, sets the booleans. \label{startparalleltexts} % \begin{macrocode} \newcommand{\startparalleltexts}{% \leavevmode diff --git a/Master/texmf-dist/tex/latex/poemscol/poemscol.sty b/Master/texmf-dist/tex/latex/poemscol/poemscol.sty index 6cfc4fceb8a..f2a9ebde7ea 100644 --- a/Master/texmf-dist/tex/latex/poemscol/poemscol.sty +++ b/Master/texmf-dist/tex/latex/poemscol/poemscol.sty @@ -22,7 +22,7 @@ %% in the same archive or directory.) \NeedsTeXFormat{LaTeX2e}[1997/12/01] \ProvidesPackage{poemscol} - [2017/12/20 v2.95 poemscol file] + [2018/01/05 v2.97 poemscol file] @@ -310,8 +310,8 @@ \fancyhfoffset[RO,LE]{\headoffsetlength} \fancyhead[RO]{{\small\textrm{\thepage}}} \fancyhead[LE]{{\small\textrm{\thepage}}} -\fancyhead[CO]{\hfil{\small{\em \leftheadervalue ~ \myversemarks}}\hfil} -\fancyhead[CE]{\hfil{\small{\em \volumeheadervalue ~ \myversemarks}}\hfil} +\fancyhead[CO]{\hfil{\small{\em \volumeheadervalue ~\myversemarks}}\hfil} +\fancyhead[CE]{\hfil{\small{\em \leftheadervalue~\myversemarks}}\hfil} \fancyfoot[CE]{{\small \botmark}\hfil} \fancyfoot[CO]{\hfil{\small \botmark}} \renewcommand{\headrulewidth}{0pt} @@ -897,7 +897,7 @@ \fi } \newif\ifcentertitleson -\newcommand{\centertitles}{\centertitlesontrue} +\newcommand{\centertitles}{\centertitlesontrue\centerepigraphsontrue} \makeatletter \newcommand{\set@p@emtitle}[6]{\setlength{\titleentryoverrun}{#6}% {#2}% @@ -1438,10 +1438,12 @@ } \newcommand{\JHpoemsubtitle}[2]{\JHsequencesectionsubtitle{#1}{#2} } -\newcommand{\JHdedication}[2]{\nopagebreak\afterpoemtitleskip\begin{epigraphquote}% +\newcommand{\JHdedication}[2]{\nopagebreak\afterpoemtitleskip\testforcenterepigraph% +\begin{epigraphquote}% \emph{#1}\JHlabel{#2}\end{epigraphquote}% \sources{\label{#2}}\afterpoemtitleskip\nopagebreak} -\newcommand{\JHepigraph}[2]{\nopagebreak\afterpoemtitleskip\begin{epigraphquote}% +\newcommand{\JHepigraph}[2]{\nopagebreak\afterpoemtitleskip\testforcenterepigraph% +\begin{epigraphquote}% \emph{#1}\JHlabel{#2}\end{epigraphquote}% \sources{\label{#2}}\afterpoemtitleskip\nopagebreak} \newcommand{\backmattersectiontitle}[1]{% @@ -1480,12 +1482,34 @@ \newcommand{\margrefspecial}[1]{% \marginpar{\scriptsize {\the\margrefmarker~p.~\pageref{#1}}} } -\newcommand{\epigraph}[1]{\nopagebreak\afterpoemtitleskip\begin{epigraphquote} - \emph{#1}\end{epigraphquote}\afterpoemtitleskip\nopagebreak} +\newif\ifcenterepigraphson +\centerepigraphsonfalse +\newlength{\centerepigraphindentation} +\setlength{\centerepigraphindentation}{6em} +\newlength{\normalepigraphindentation} +\setlength{\normalepigraphindentation}{1.5em} +\newcommand{\centerepigraphquote}{% +\setlength{\epigraphquoteleftmargin}{\centerepigraphindentation} +\setlength{\epigraphquoterightmargin}{\centerepigraphindentation} +} +\newcommand{\normalepigraphquote}{% +\setlength{\epigraphquoteleftmargin}{\normalepigraphindentation} +\setlength{\epigraphquoterightmargin}{\normalepigraphindentation} +} +\newcommand{\testforcenterepigraph}{\ifcenterepigraphson% +\centerepigraphquote +\else +\normalepigraphquote +\fi} +\newcommand{\epigraph}[1]{\nopagebreak\afterpoemtitleskip\testforcenterepigraph% +\begin{epigraphquote}% + \emph{#1}\end{epigraphquote}\afterpoemtitleskip\nopagebreak} \newcommand{\headnote}[1]{\epigraph{#1}} -\newcommand{\attribution}[1]{\nopagebreak\afterpoemtitleskip\begin{epigraphquote} +\newcommand{\attribution}[1]{\nopagebreak\afterpoemtitleskip\testforcenterepigraph% +\begin{epigraphquote}% {\small\emph{#1}}\end{epigraphquote}\afterpoemtitleskip\nopagebreak} -\newcommand{\poemdedication}[1]{\nopagebreak\afterpoemtitleskip\begin{epigraphquote} +\newcommand{\poemdedication}[1]{\nopagebreak\afterpoemtitleskip\testforcenterepigraph% +\begin{epigraphquote}% \emph{#1}\end{epigraphquote}\afterpoemtitleskip\nopagebreak} \providecommand{\dedication}[1]{\poemdedication{#1}} \newcommand{\volumededication}[1]{\par\bigskip\begin{volumetitlepagequote} @@ -1494,6 +1518,8 @@ \emph{#1}\end{volumetitlepagequote}} \newcommand{\volumeattribution}[1]{\par\smallskip\begin{volumetitlepagequote} {\small \emph{#1}}\end{volumetitlepagequote}} + \newenvironment{epigraphenvironment}{\nopagebreak\afterpoemtitleskip\testforcenterepigraph% +\begin{epigraphquote}\em}{\end{epigraphquote}\afterpoemtitleskip\nopagebreak} \newlength{\dateindent}% \setlength{\dateindent}{\leftmargin}% \newcommand{\variabledateindent}{% -- cgit v1.2.3