% \iffalse meta-comment % % Copyright (C) 2005 by John Burt % -------------------------------------------------- % % This file may be distributed and/or modified under the % conditions of the LaTeX Project Public License, either version 1.2 % of this license or (at your option) any later version. % The latest version of this license is in: % % http://www.latex-project.org/lppl.txt % % and version 1.2 or later is part of all distributions of LaTeX % version 1999/12/01 or later. % % \fi % % \iffalse %\NeedsTeXFormat{LaTeX2e}[1997/12/01] %\ProvidesPackage{poemscol} % [2007/07/14 v2.53 poemscol file] % %<*driver> \documentclass{ltxdoc} \usepackage{makeidx,multicol,keyval,ifthen} \EnableCrossrefs \CodelineIndex \RecordChanges \begin{document} \DocInput{poemscol.dtx} \end{document} % % \fi % % \CheckSum{5979} % % \CharacterTable % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z % Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z % Digits \0\1\2\3\4\5\6\7\8\9 % Exclamation \! Double quote \" Hash (number) \# % Dollar \$ Percent \% Ampersand \& % Acute accent \' Left paren \( Right paren \) % Asterisk \* Plus \+ Comma \, % Minus \- Point \. Solidus \/ % Colon \: Semicolon \; Less than \< % Equals \= Greater than \> Question mark \? % Commercial at \@ Left bracket \[ Backslash \\ % Right bracket \] Circumflex \^ Underscore \_ % Grave accent \` Left brace \{ Vertical bar \| % Right brace \} Tilde \~} % % % \changes{v1.0}{2002/06/05}{Initial version} % \changes{v1.01}{2002/06/25}{Added macros 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 % command to change the amount of indentation in runover lines in verse. % Removed special geometry to % make the program more generic.} % \changes{v1.11}{2005/02/12}{Corrected bugs in headers for explanatory notes and % emendations.} % \changes{v1.2}{2005/2/19}{Accidentals and typescript variants test to see whether % textual notes are being made. Corrected a bug when quoting verse in note % sections. Added a command to change the page number of the table of contents. % Added a command to input the table of contents file. Added commands % to input the external files for emendations, explanatory notes, textual % notes, and the index of titles and first lines. Added a command to test % whether there is an .aux file from a previous run and to prevent typesetting % of the external files for emendations, explanatory notes, textual % notes if there is not. Added a command to restore the main page style after % the table of contents.} % \changes{v1.7}{2005/2/22}{Changed how labels are made for use in % contents and notes sections. Control sequences 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 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 without % formal titles} % \changes{v2.12}{2005/3/19}{Notes sections can take ranges of lines.} % \changes{v2.13}{2005/3/20}{tsentry no longer needs an unskip % if the entry starts with a comma.} % \changes{v2.2}{2005/3/23}{The user can create new kinds of endnote.} % \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 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 command, to % prepare for making poemscol and lineno compatible} % \changes{v2.30}{2005/5/16}{Prose sections such as Authors' % Introductions are line numbered by lineno.sty. Textnotes, % emendations, and explanatory notes for prose sections may be either % 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} % \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.} % \changes{v2.32}{2005/6/29}{Simpler configuration of marginal line % numbers, revision of manual} % \changes{v2.33}{2005/7/03}{Fixed a bug in index generation, % compensated for odd interaction between fancyhdr and reversemarginpar} % \changes{v2.34}{2005/7/17}{Easier modification of format of tables % of contents} % \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 % 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 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 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 mode. Up to four % sentences can appear on a line in paragraph-line mode without % having their marginal line numbers overlap. Fixed a bug that added % an extra colon in footnotes in paragraph-sentence format. Changed % ``gutter'' and ``outer'' line numbering in verse and % paragraph-sentence prose to use Peter Wilson's sidepars rather % than marginpars.} % \changes{v2.39}{2005/9/07}{Left a DeclareOption hanging in version % 2.38. Fixed that.} % \changes{v2.391}{2005/10/06}{Corrections to user's guide.} % \changes{v2.392}{2005/10/13}{More corrections to user's guide.} % \changes{v2.394}{2005/12/10}{More corrections to user's guide.} % \changes{v2.4}{2006/02/25}{Commands to make new kinds of endnotes % also make notes for line numbered prose sections and for prose % sections with paragraph and sentence numbering.} % \changes{v2.41}{2006/03/02}{Fixed a bug in line numbers of new % kinds of prose note.} % \changes{v2.42}{2006/03/04}{Fixed error in handling conditionals when % setting prose numbered by sentence and paragraph.} % \changes{v2.43}{2006/03/06}{Notes in prose numbered by sentence % and paragraph number can refer only to the sentence number even % when paragraphs are also being counted.} % \changes{v2.44}{2006/03/07}{Fixed a bug which caused new kinds of % endnotes in prose sections to add unwanted white space to the % output.} % \changes{v2.45}{2006/04/08}{Use of sidepar in v2.38 introduced a % problem, causing line numbers sometimes to drift up a point. % Changed commands for putting verse line numbers, but not paragraph and % sentence numbers, to use marginpars again.} % \changes{v2.46}{2006/04/10}{Changed definition of sidepar so that % it uses struts to find the depth of the line, restored line number % commands to use sidepar and its variants.} % \changes{v2.47}{2006/04/12}{Changed name of sidepar to % pcmclsidepar to avoid conflicts with the sidepar command from the % memoir class, since they are no longer exactly the same. Added % commands to put a marginal reference to the notes section in the % margins of poem titles.} % \changes{v2.48}{2006/04/13}{Added more general form of the % commands to put a marginal reference to the notes section in the % margins of poem titles.} % \changes{v2.49}{2006/04/25}{Changed marginal reference command to % use marginpar rather than pmclsidepar (alas, it still adds vertical % white space after the title with pmclsidepar). Added marginal % reference commands for sequences and sequence sections. Fixed % errors in manual. } % \changes{v2.50}{2006/05/13}{Added marginal % reference commands for poem sections, poem subtitles, epigraphs, % and dedications. These commands no longer require an addition label % command to set the label to which they refer. Added commands to % make marginal references to the pages in notes sections where % comments on individual lines may be found, for textual notes, % explanatory notes, emendations, and user-defined notes. Added % commands for changing the names of the Table of Contents, the % various endnotes sections, and the running headers for the contents % and endnotes sections, in order to facilitate editions of works in % languages other than English.} % \changes{v2.51}{2006/05/22}{Changed prose section environment so % that it does not always assume that the modulo for line numbers in % prose is the same as the number in verse. Corrected a problem with % alignment of line numbers in the prosesectionnoreset environment. % Added commands to support generation of multiple indices using the % splitindex package. Fixed a variety of small bugs, including a % newly introduced one in the correction to textual notes for quoted % verse.} % \changes{v2.52}{2007/07/10}{Changed dedication to poemdedication to % avoid a conflict with a command in koma-script. dedication command % is provided using providecommand for compatibility} % \changes{v2.53}{2007/07/14}{Changed the name of an internal token % register to avoid a conflict with babel} % \GetFileInfo{poemscol.sty} % % \DoNotIndex{\newcommand,\newenvironment,\def,\edef,\else,\renewcommand,\makeatletter,\makeatother} % \DoNotIndex{\abovedisplayskip,\belowdisplayskip,\abovedisplayshortskip,\belowdisplayshortskip} % \DoNotIndex{\newcommand, \section, \subsection, \subsubsection, % \fileversion,} \DoNotIndex{\filedate, \docdate, \leavevmode, % \vspace, \small, \normalsize, \fontsize,} \DoNotIndex{\newcommand, % \section, \subsection, \subsubsection, \fileversion} % \DoNotIndex{\filedate, \docdate, \leavevmode, \vspace, \small, % \normalsize, \fontsize} \DoNotIndex{\selectfont, \abovedisplayskip, % \belowdisplayskip, \setlength, \item} \DoNotIndex{\global, \input, % \def, \edef, \texttt, \textsf, \setcounter} % \DoNotIndex{\pagenumbering, \oddsidemargin, \evensidemargin, % \newdimen, \renewcommand} \DoNotIndex{\makeatletter, \let, \@listi, % \@listl, \z@, \@xpt, \@xipt, \p@ , \@plus2} \DoNotIndex{\@minus5, % \@minus3, \@plus3, \makeatother, \@minus4, \relax, \pagestyle} % \DoNotIndex{\fancyhead, \fancyfoot, \thepage, \@ixp} % \DoNotIndex{\begin \botmark, \botmark, \catcode, \croppadbot, % \croppadtop} \DoNotIndex{\croppagewidth, \endverse, \equal, % \fancyfoot, \fancyhead, \fancyhf} \DoNotIndex{\fancypagestyle, % \firstmark, \footrulewidth, \hbox, \hbox, \headrulewidth} % \DoNotIndex{\hfil, \hspace, \ifthenelse, \immediate, \itemindent, % \listparindent} \DoNotIndex{\makeatletter, \nolinebreak, \openout, % \raggedbottom, \setcounter, \textrm} \DoNotIndex{\value, \vspace, % \write} % \DoNotIndex{\afterpoemtitleskip, \addtocounter, \advance, % \begin, \bf, \bigskip} % \DoNotIndex{\bigskipamount, \fi, \@fulltitle, \label, \large, \leftheader} % \DoNotIndex{\leftheadervalue, \leftmargin, \leftmargini} % \DoNotIndex{\medskip, \newcounter, \nobreak, \par, \textbf} % \DoNotIndex{\closeout,\em,\emph,\expandafter,\Huge,\it,\jobname,\kern,\newif, % \newwrite,\p@,\pageref,\renewenvironment,\rm,\scriptsize,\string, % \textsc, \unskip} % \setcounter{IndexColumns}{2} % \MakeShortVerb{|} % \def\fileversion{2.53} % \def\filedate{14 July 2007} % \def\docdate{14 July 2007} % \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{July 14, 2007} % \maketitle % \begin{abstract} % \textsf{poemscol} provides macros 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 structures % required to produce a critical edition of the kind specified by the % Modern Language Association's Committee on Scholarly Editions, and it % automatically marks every occasion where a stanza break falls on a % page break. % \end{abstract} % \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, multi-layered footnotes), tying % each note the number of the line upon which it is a comment. It % also automatically generates a table of contents, an index of titles % and first lines, and divider pages for the sections of the volumes. % It produces running headers of the form ``Emendations to pp.~xx-yy'' % for the note sections. And it marks occasions when a stanza break % falls at a page break. % % Producing line numbers for verse is something for which \LaTeX\ % would seem to be especially suited. A line of verse, after all, is % not a carriage return but a logical unit, an element of % versification more than of typesetting, perhaps running over several % physical lines, or perhaps split into half-lines as speakers or % subjects change. With \textsf{poemscol} you mark lines, stanzas, % and entire poems up as logical units, and \LaTeX\ does the % formatting and counting. Once you have marked out the logical units % of the poem, \textsf{poemscol} will automatically mark every textual % note, emendation, or explanatory note with the range of line % numbers to which it applies. % % In poetry which does not have a regular stanzaic form, it is useful % to be able to mark automatically occasions where there is a stanza % break at the bottom of a page which the reader might not notice. % Doing this by hand is not only tedious and easy to get wrong, but % also a process you will have to start over again if anything about % your volume changes, if you add a poem, say, or even decide to break % a title across two lines. \textsf{poemscol} takes care of this % process, so that the editor need never worry about it, automatically % marking cases where the page break coincides with a stanza break % with a symbol. % % Editions of Collected Poetry might also require special structures % to reflect the fact that they are made up of the contents of several % volumes of poetry. In particular, such editions require special % structures for setting up specially formatted divider pages between % volumes. They also require tables of contents and other front matter. % \textsf{poemscol} provides these structures. % % The best features of \textsf{poemscol} are of course simply that it % is \TeX: it uses \TeX's automatic kerning and setting of ligatures, % its algorithm for justifying lines (in prose sections), and \LaTeX's % way of setting verse. % % Using \LaTeX\ to typeset critical editions offers more advantages % than simply the ability to automate tedious and easy to fumble % tasks. Most modern \TeX\ compilers have the ability to produce % output in Adobe pdf format. Adobe pdf output can be used as camera % ready copy, saving your publisher time and expense, and perhaps % making a marginally economic critical edition a bit easier to bring % to press. Furthermore, since typesetting the edition yourself in % \LaTeX\ obviates the publisher's own typesetting of your text, it % removes another possible source of new errors. (You should expect % to work with your publisher on the final design of the book, but % \LaTeX\ is a flexible language which will enable you to reproduce % most book designs.) % % Editions made in the formats of proprietary software such as % Word\copyright\ or Quark\copyright\ will become not only obsolete % but unreadable if those programs pass from use. Since your \LaTeX\ % sources for your edition are in ASCII, 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 whether or not they can read \LaTeX\ % code. % % Finally, although \LaTeX\ is a typesetting language, not a content % markup language, the ability to create new commands which the % language offers comes very close to enabling one to realize the % ideal of completely separating content markup from formatting. One % advantage of this kind of markup is that even if the appearance of % the poem on the page may be ambiguous, the editor's intentions about % the logical structure of the poem will be preserved in the \LaTeX\ % source. Should you wish later to produce an electronic edition of % your work, either using XML or the SGML markup approved by the Text % Encoding Initiative, transforming your texts from \LaTeX\ to XML % would largely (although not entirely) be a matter of performing a % series of global search-and-replaces, and could conceivably be done % with a perl script. % % \textsf{poemscol} is also suited for verse drama, and the % package \textsf{dramatist} has been modified to work with % \textsf{poemscol}. \textsf{poemscol} can provide line numbers and % notes for prose sections such as the author's introduction or prose % poetry, and it can also handle inset prose passages in the midst of % verse. \textsf{poemscol} is not, however, designed for % typesetting large scale prose works. For critical editions of prose % works, several other packages are available, including the % \texttt{EDMAC} format, a \TeX\ format analogous to but distinct from % \LaTeX, by John Lavagnino and Dominik Wujastyk, or \textsf{ledmac}, % a port of \texttt{EDMAC} into \LaTeX\ by Peter Wilson, or \textsf{ednotes}, a % completely independent set of macros for critical editions which % builds on \textsf{manypar} and \textsf{lineno}, by Uwe L\"{u}ck. % % \section{Dependencies and compatibility with other packages} % % \textsf{poemscol} depends upon several other packages, which you % should be sure you have in your preamble and search path: % \textsf{fancyhdr} for managing the running headers, \textsf{makeidx} % and \textsf{multicol} for managing the index, \textsf{geometry}, and % \textsf{ifthen} and \textsf{keyval} to simplify page geometry. If % you are using the |\JHpoemtitle| alternate form of the |\poemtitle| % command, you need to add \textsf{mparhack} to your package list, to % make sure that the marginal references |\JHpoemtitle| adds appear on % the correct side of the page. You should make sure that % \textsf{poemscol} is the very last package you load in your % preamble, or at least is loaded after those packages upon which it % depends. % % If you are planning to generate multiple indices, substitute % \textsf{splitindex} for \textsf{makeidx} in your list of packages. % % % \subsection{~Prose sections} % If you plan to number lines in prose contexts, and to make textual % notes, emendations, or explanatory notes in prose contexts, you will % need to add the \textsf{lineno} package to your preamble. I use the % ``right'' and ``modulo'' options with this package, but you can set % the options however you wish to make how you number the lines of % prose sections consistent with how you number the lines of verse % sections. % % \subsection{~Multi-layer footnotes} If you plan to use % paragraph-formatted footnotes rather than endnotes, you should load % \textsf{manyfoot}. You should load it with the ``ruled,'' and % ``para'' options. (\textsf{poemscol's} footnote commands are just a % wrapper around \textsf{manyfoot}.) \textsf{manyfoot} inherited some % of the limitations of \LaTeX\ in dealing with long inserts at the % end of the page, so you may have to do some fiddling. As fixes to % these problems emerge, I will incorporate them into % \textsf{poemscol}. \textsf{manyfoot} does not allow multiple % paragraph footnotes when typesetting in ``para'' mode. This is % probably a feature, not a bug, since one would want such notes to be % set in several paragraphs, rather than running them together into % one, as \textsf{manyfoot} would naturally want to do in para mode. % For that reason, I have defined the two traditional classes of note % in which multiple paragraph notes are likely to appear, ``sources,'' % and ``explanatory notes,'' to be typeset in ``plain'' mode, which % opens a new paragraph with each note. If your textual notes or % emendations sections also have multiple paragraph notes, you should % re-define them in order to produce footnotes in plain rather than in % para mode, if you wish to produce footnotes rather than endnotes. % % % \subsection{~Verse drama and \textsf{dramatist}} % Massimiliano Dominici has made his \textsf{dramatist} package % compatible with \textsf{poemscol}, for which I am very grateful. % Versions 1.2a or later of \textsf{dramatist} are compatible with % versions 2.3 or later of \textsf{poemscol}. % % \subsection{~Compatibility with earlier versions of % \textsf{poemscol}} Making \textsf{poemscol} compatible with % \textsf{lineno} required me also to change the commands for turning % verse line numbering on and off, which means that version 2.3 of % \textsf{poemscol} is incompatible with prior versions. The old % command |\makelinenumbers| has been replaced with % |\makeverselinenumbers| to distinguish it from a command from the % \textsf{lineno} world. (|\makelinenumbers| will still work, but I % have deprecated it.) To turn on verse line numbering, issue % |\makeverselinenumbers|. Because the counter ``linenumber'' has % been changed to ``verselinenumber,'' you must use % |\global\verselinenumbersfalse| to turn off line numbering, rather % than |\global\linenumbersfalse| as before. % % Up to version 2.44 \textsf{poemscol} borrowed the code for % |\sidepar| non-floating marginal paragraphs from the memoir class, % and also made |\leftsidepar| and |\rightsidepar| commands on their % model. Version 2.46 modified Peter Wilson's original code for % |\sidepar|, so therefore I have changed the names of |\sidepar|, % |\leftsidepar|, and |\rightsidepar| to |\pmclsidepar|, % |\pmclleftsidepar| and |\pmclrightsidepar| respectively. If you % used any of these commands in your files, you will need to change % their names. % % Up to version 2.5 the |\definenewnotetype| command took four % arguments, using the third argument for both the running header for % the notes section and for the entry in the table of contents. In % order to make it easier to handle titles in languages other than % English I have found it necessary to separate these two uses, so % |\definenewnotetype| now takes five arguments. You will need to % retrofit files that use the old version of this command. You can % see the details at section \ref{definingnewnotes}, page % \pageref{definingnewnotes}. % % \subsection{~Incompatibility with \textsf{memoir} and \textsf{verse}} % Unfortunately, \textsf{poemscol} is not compatible with the % \textsf{memoir} class and the \textsf{verse} package, because they % share some command names. I am preparing a workaround for this % problem. % % \subsection{~Crop marks} % \textsf{poemscol} no longer provides cropmarks, but is compatible with % the style packages that do. I use \textsf{crop}, with the % letter,pdftex,cam, and center options. % % % % % \section{Marking up individual poems} % First, a word about the command names. The command names may seem % ugly and long. And there are separate commands for many tasks that % 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 % 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 % meaning. % % There are also many commands for special purposes whose necessity % may not seem clear until the editor finds him or herself in the jam % the command was designed for. For instance, \textsf{poemscol} % normally encourages a page break before the title of a poem, or % before the title of a section of a poetic sequence, to discourage % page breaks between the title and the poem. But for the first % section of a poetic sequence, or the first section of a poem in % sections, one does not want to encourage \LaTeX\ to break the page % before the title, since that would leave the title of the sequence % or the title of the larger poem as a widow on the previous page. % |\sequencefirstsectiontitle| and its siblings are designed for this % situation. Although all commands like |\sequencefirstsectiontitle| % discourage page breaks before the title (and all of the commands % discourage page breaks after the title), they will still sometimes % happen, particularly if you have a multi-line sequence title % followed by a multi-line section title. For these cases, page % breaks will have to be explicitly issued. % % \subsection{~The title of the poem} % % \DescribeMacro{\poemtitle}|\poemtitle{}|, as its name implies, sets % the title of the poem. \textsf{poemscol} gives default values for % such things as the font size, the separation between the top of the % title and the bottom of the previous poem, the separation between % the bottom of the title and the first line, and so on. It also sets % penalties in order to encourage page breaks just before a title, and % 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 % either |\setlength| or |\renewcommand| (depending upon what you are % changing). |\poemtitlefont| globally sets the font size (and % leading) for all poem titles in the main text. % |\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. % |\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. A % complete list of all of the special commands for setting font sizes, % skips, and penalties, is in section \ref{changingfontsandleading} below. % % In the actual text of the poem, you need only use the |\poemtitle{}| % macro to specify the title of the poem. The macro takes one % argument --- the title, of course. The macro 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 % (with the page number), typesets the title in the textual notes % (adding the page number, and checking to see whether there is room % enough on the page), and prepares similar entries in the lists of % emendations and in the explanatory notes (if you need them). % Multiple line titles, 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. % % \DescribeMacro{\poemsubtitle} Subtitles of poems should be issued as % the arguments to the |\poemsubtitle{}| macro. % % \DescribeMacro{\titleindent} For indented parts of titles. In the % macros 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.) % |\titleindent| is also used internally in the commands for multiple % line titles. Instructions about changing the value of |\titleindent| % can be found in section \ref{changingfontsandleading}. % % \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 % puts the poem in a |verse| environment (to handle run over lines % automatically). \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, % and an explicitly indented second line, more obvious in the output. % % \textsf{poemscol} turns off automatic hyphenation in poetry % environments. The idea here is that every hyphen in the printed poem is % authorial, obviating the need for you to compile a 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 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 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} 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 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.) % % \DescribeEnv{stanza} Every stanza should be placed in its own stanza % environment. Every poem should have at least one stanza. Marking % the beginning and end of every stanza (with |\begin{stanza}| and % |\end{stanza}|) provides \textsf{poemscol} with a way of detecting % cases in which a page boundary falls on a stanza break, since in % those cases a page turn happens when one is \emph{inside} a poem % 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. % % \textsf{poemscol} adds a little bit % 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.) % % \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{}|, % 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{}|, % using as the argument whatever you wish to mark such cases. The % default is |\relax|. % % \DescribeMacro{\verseline} |\verseline| should mark the end of every % line, except the last line of every stanza (which should be marked % with |\end{stanza}|). |\verseline| marks the end of every line as a % prosodic unit (since a line of verse is not simply a carriage % return), and advances the line counter. There are commands below % for changing the line counter's horizontal placement (how close it % is to the left or right margin of the line) and appearance. (See % section \ref{marginalgeometry} for these.) % % % \DescribeMacro{\setverselinemodulo} |\setverselinemodulo| sets how often a % marginal line % number appears. To print a line % number every five lines, issue |\setverselinemodulo{5}|. The % default value is 10. % % % \DescribeMacro{\makeverselinenumbers} % Marginal verse line numbering is on by default. To turn line % numbering off, issue |\global\verselinenumbersfalse|. To turn it % back on, issue |\makeverselinenumbers|. % % \DescribeMacro{\verselinenumberstoright} % \DescribeMacro{\verselinenumberstoleft} % \DescribeMacro{\verselinenumbersswitch} % \DescribeMacro{\verselinenumbersgutter} % \DescribeMacro{\verselinenumbersouter} % To put all of the line numbers to the left, issue % |\verselinenumberstoleft| in your preamble. % |\verselinenumberstoright| puts the line numbers in the right % margin. (These two commands use non-floating marginal note macros % 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 appear in the inner margins, issue % |\verselinenumbersgutter| in your preamble. (These two commands use % |\pmclsidepar|, derived from |\sidepar| from the \textsf{memoir} % class, but modified by Dan Leucking.) You can adjust the distance % between the marginal line number and the text with % |\setlength{\marginparsep}{}|.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 10 pt. % % The line numbers should print on the baseline. You can adjust them % to move them up or down by changing the value of a length called % |\pmclsideparvshift|. The default value is % |\setlength{\pmclsideparvshift}{0ex}|. % % \subsection{~Special features} % \DescribeMacro{\linebend} \textsf{poemscol} automatically runs over % long lines, indenting the run over portion on the next physical % line. If you are unhappy with where \textsf{poemscol} has run over % a particular line, you can ``bend'' that line by issuing |\linebend| % at the point where you wish it to run over. The run over portion of % 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. % % 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). % % |\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) % 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.) % % \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 % 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 % margin instead. For instructions about how to do this, see section % \ref{rightflushverse}, page \pageref{rightflushverse}. % % \DescribeMacro{\verseindent} The |\verseindent| command is to be % used for formally indented lines. It should not be used to indent % the run over portion of long lines (which \textsf{poemscol} handles % automatically anyway). |\verseindent| indents the line a bit less % than the run over portion of long ``bent'' lines are indented, so % that the two cases can be visually distinguished. By default, the % length of |\verseindent| is 2em. To change it, say to 3em, issue % |\renewcommand{\verseindent}{\hspace{3em}}| % % % \DescribeMacro{\brokenline} % \DescribeMacro{\versephantom}|\brokenline| should be used where you % wish to break the line without incrementing the line counter. % Authors often break a line into two half-lines, setting the % beginning of the second half-line flush with the end of the first % half-line. (Sometimes these broken lines indicate a change of % 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{}|, % which adds white space exactly as long as its argument would have % 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. % % % The sestet of Yeats's sonnet ``Leda and the Swan,'' has such a broken % line: % \begin{verse} % A shudder in the loins engenders there\\ % The broken wall, the burning roof and tower\\ % And Agamemnon dead.\\ % $\phantom{And Agamemnon dead.~}$ Being so caught up,\\ % So mastered by the brute blood of the air,\\ % Did she put on his knowledge with his power\\ % Before the indifferent beak could let her drop?\end{verse} % % To set the broken line properly, issue: % \begin{verse} % And Agamemnon dead.|\brokenline|\\ % |\versephantom{And Agamemnon dead.}| Being so caught up,|\verseline| % \end{verse} % % \DescribeMacro{\tweakbrokenline} % By default, \textsf{poemscol} sets the line numbers level with the % ends of broken lines. If the line numbers are set to the right of % the text, this seems the obvious choice. Conceivably you might want % to set the line number level with the beginning of a broken line % when the line numbers are set to the left. To ensure that the line % numbers of broken lines are set level with the beginning of a % broken line when the line number is on the left, issue % |\tweakbrokenline| in your preamble. % % You should issue |\tweakbrokenline| with caution, because although % it changes how |\brokenline| is handled, it does not change the % handling of long lines with runover. Runover lines will still set % the line number level with the end of the line. You can have % runover lines set their line number level with the beginning of the % line by issuing |\startverseline| at the beginning of the line. % % \DescribeMacro{\brokenlineatbeginning} Conceivably you might want % |\brokenline| to set the line number level with the beginning of % the line in every case. To do this, issue |\brokenlineatbeginning| % in your preamble. If you do this, you should be prepared to mark % the beginning of runover lines with |\startverseline|. % % \DescribeMacro{\startverseline} % If you begin a verse line with |\startverseline| the line number % will be set level with the beginning of the line rather than with % the end. This is useful, for instance, if you want to ensure that % the line number of a line with runover is set level with the % beginning of the line. You can, if you don't want to keep track of % where runover lines are, start every line with |\startverseline|. % % \DescribeMacro{\tweakstartverseline} % Rather than setting the line number of every runover line level with % the beginning of the line, it may make more sense for you to set the % line number level with the beginning in cases where the line number % is to the left, and level with the end in cases where the line % number is to the right. You might want to do this, for instance, if % you have decided to set all the verse lines at the outer margin (by % issuing |\verselinenumbersouter| in your preamble), or have decided to % set all the verse lines at the inner margin (by issuing % |\verselinenumbersgutter| in your preamble). To ensure that % |\startverseline| does this, issue |\tweakstartverseline| in your % preamble. % % \DescribeMacro{\stanzalinestraddle} % Some poets (such as Robert Penn Warren) occasionally introduce a % stanza break in the middle of a broken line, considering the line to % be a single metrical unit despite the fact that it straddles a stanza % break. To record these cases, mark the end of the first half-line % with |\end{stanza}| as usual. But instead of opening the next stanza % with |\begin{stanza}| issue |\stanzalinestraddle| instead. This will % make sure that the line counter counts the straddling line as only one % line, despite the stanza break. |\stanzalinestraddle| is usually used % with |\versephantom{}|. % % \DescribeEnv{rightflushverse} % \DescribeMacro{\rightversebegin}\label{rightflushverse} By default, % \textsf{poemscol} indents the runover portion of long lines by the % amount |\runoverindent| (by default 6 em). It is possible to set % verse so that the runover portion is flushed to the right margin. % To do this, you should put the |\rightflushverse| environment inside % the |\poem| environment. And you must mark the beginning of each % verse line with |\rightversebegin|. Christian Ebert has reminded me % that the |\rightflushverse| environment must be issued \emph{inside} % the poem environment. Otherwise it simply flushes every line to the % right. % % It is rather clumsy to need a special environment for verse with % right flushed runover. I plan to provide a command for switching % between a verse environment that indents runover lines and a verse % environment that flushes runover lines to the right. I have seen % examples of this kind of environment from Markus Kohm and Christian % Ebert, but so far I haven't been able to persuade them to play well with \textsf{poemscol} % % \DescribeMacro{\poemlinelabel} \label{poemlinelabel} |\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 should issue the command \emph{after} the |\verseline| or % |\end{stanza}| command, to make sure that the line number will be % correct.) To produce the reference, just issue |\ref{text of label}| % as usual. (|\poemlinelabel| is just a crudely hacked version of % |\label| from \LaTeX.) |\pageref{text of label}| will set the page % number of the page on which the label appears. % % \section{Making a table of contents} % \DescribeMacro{\makepoemcontents} % I found the normal \LaTeX\ macros for making tables of contents % unsuited to 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 % fact it is better, for reasons explained below, to issue it % immediately after issuing the |\putpoemcontents|, the command which % inputs and typesets a table of contents from a prior run. % Information for your table of contents will be written to an % external file with the extension .ctn. You may need to run your % book through \LaTeX\ twice in order to generate a table of contents, % the first time to generate the correct page numbers, and the second % time to set the table of contents. (Under some circumstances --- if % you have an index, for instance --- you may need three passes rather % than two.) |\makepoemcontents| takes an optional argument, which % sets the page number for the table of contents. If your publisher % wishes to add some front matter so that the contents will appear on % page vii, you should issue |\makepoemcontents{7}|. % All of the commands that generate lines in the table of contents are % somewhat messy and somewhat rigid, but you can modify them if you % wish. Lines in the table of contents usually include an indent (how % much of one depends upon what the entry is --- whether it is a % volume title, a poem title, or something else), then the title % itself. If the entry is for a poem, for a section of a poem, or for % a section of a poetic sequence, a slash follows the title, followed % by the page number. If you wish to give \emph{all} your entries a % different look altogether, modify the |\c@ntentsinfo| macro below % (see section \ref{poemtitlecode}, page \pageref{poemtitlecode}. To % change the appearance of a \emph{particular} kind of entry (for all % sequences of poems, for instance), go to the definition of the title % of that kind of entry (e.g. |\sequencetitle|) below, find the line % where it calls the |\c@ntentsinfo| macro, and change the arguments % to that macro to suit you. % %\DescribeMacro{\setcontentsleaders} By default the title and the page % are separated by a slash (actually by |~/~|). If you wish to change % this, say to put dot leaders in instead, issue what you wish to use % as the argument to |\setcontentsleaders|, as for instance % |\setcontentsleaders{\poemdotfill}|, which will flush the number to % the right margin, and insert leading dots up to the number. % % \DescribeMacro{\putpoemcontents}\label{putpoemcontents} % |\putpoemcontents| will input the table of contents file if it % exists, and complain on your log file if it does not. Because the % 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. Be sure to % reset the style of page numbering (from |\pagenumbering{roman}| to % |\pagenumbering{arabic}|) after issuing |\putpoemcontents|, since % when you read in the external file created by |\makepoemcontents| % the page numbering will be set to roman. The command % |\resetpagestyle| (which is called by |\putpoemcontents|) will reset % the fancy page style to that used in the main body of the volume, % but it won't change the page numbering to arabic, in case there is % some frontmatter between the contents and the main text, so you % should be sure to do so yourself. If you neglect to issue % |\pagenumbering{arabic}| before you begin to get to your poems your % page numbering will remain in roman numerals. The notes sections % use the page numbers from the poem to construct running headers of % the form ``Notes to pp.~xx--yy.'' If those numbers are roman % numerals rather than arabic ones, \textsf{poemscol} will not % recognize them as numbers, and you will get the infamous ``Missing % Number'' error that puzzles so many users of \LaTeX. % % Because |\putpoemcontents| uses the table of contents file from a % prior run, you should issue |\putpoemcontents| \emph{before} % issuing |\makepoemcontents|. That sounds counterintuitive. % But remember that |\putpoemcontents| will read in the contents file you made on a % previous run, and |\makepoemcontents| will over-write that file and % start a new one. You should issue |\makepoemcontents| just % \emph{after} issuing |\putpoemcontents|. % % \subsection{~Entries for notes sections and the index} % \DescribeMacro{\putpoemindex} % Remember that if you are making an index of titles and first lines % you may need to run your file through \LaTeX\ after running % MakeIndex, to put the entry for the index into your table of % contents. |\putpoemindex| inputs the formatted index, and adds an entry % for it into the table of contents. Use |\putmultiplepoemindex| if % you are making several indices. For instructions about % |\putmultiplepoemindex| see section \ref{multipleindex}, % p.~\pageref{multipleindex}. % % \begin{sloppypar}\DescribeMacro{\puttextnotes} % \DescribeMacro{\putemendations} % \DescribeMacro{\putexplanatory} % |\puttextnotes|, and its siblings |\putemendations| and % |\putexplanatory|, like |\putpoemindex|, input the formatted notes % sections, and put entries for them into your table of contents. As % with |\putpoemindex|, you will have to run \LaTeX\ again to set the % table of contents properly. The first run sets a label to find the % page number to add to the table of contents, and the second run % actually sets the table of contents. (These commands are described % below, in section \ref{putexternalfiles}.) All of these commands % also restore normal hyphenation. \end{sloppypar} % % \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} % \DescribeMacro{\indexingontrue} 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 external file (the .idx file) with MakeIndex and run % your book through \LaTeX\ again in order to set a properly organized % and formatted index. MakeIndex sorts the various multi-level % ``index cards'' generated by all of the |\index| commands in your % source files. Once you have processed your .idx file with % MakeIndex, and generated the sorted and formatted .ind file for your % book, the |\putpoemindex| command will insert the typeset index where % you issue it, and put an entry for your index in your table of contents. You will % have to run your file through \LaTeX\ again to make the page number for that % entry correct. % % \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.) % To turn indexing off, issue |\global\indexingonfalse|. % % Enter the individual index entries in the poems as you normally % would for use by MakeIndex (say, after each title and first line). One of % the nice features of MakeIndex is that every entry has two parts, % one for specifying the sort key of the entry (or subentry), the other % for specifying the font and typesetting information of the entry (or % subentry). This enables you to drop all of the initial uses of % ``the'' in titles for sorting purposes, while still including the % ``the'' in the title. It also enables you to distinguish titles % from first lines (by italicizing them), and to include typesetting % information (such as italicization) in titles or first lines without % messing up their sort order. % % \subsection{Making Multiple Indices}\label{multipleindex} % \textsf{poemscol} can work with \textsf{splitindex} to generate % more than one index. You might, for instance, wish a separate index % of titles and index of first lines, or an index of proper names. To % do this, call \textsf{splitindex} in your list of packages. Then, % in your preamble, declare the indices you are planning to use, e.g. % |\newindex[Index of Titles]{idx}| % |\newindex[Index of First Lines]{fir}| % |\newindex[Onomastic Index]{ono}|. The second argument is the % ``shortcut'' defined by \textsf{splitindex}, and will be used to % mark index entries in your text (see below), and as the extension % for the external index files used by MakeIndex. % % Then mark up individual entries. Some entries (in the example % above, the ``Index of Titles'' examples) can be marked up with % |\index| just as if you were using only one index. Entries for % other indices should be marked using the |\sindex| command from % \textsf{splitindex}, as follows % \begin{verbatim} % \sindex[fir]{Of Man's first disobedience and the fruit} % \end{verbatim} % where the % first argument is the ``shortcut'' and the second is the index % entry. If you are loading \textsf{splitindex} with the % \textsf{split} option, the different types of index entry will be % sent to separate output streams, which each must be processed separately % with MakeIndex. \TeX\ has only a limited number of such output % streams, however, so it is probably wiser not to choose that % option, but to use splitindex.tex, splitindex.pl, or one of the % other means provided with the \textsf{splitindex} package to break % up the index into the separate parts, each of which must be % processed with MakeIndex separately. % % To include the indices, and to add entries for them to the table of % contents, issue |\putmultiplepoemindex| for each one. % |\putmultiplepoemindex| takes four arguments, which are: 1. The % three letter ``shortcut'' used by |\splitindex|, 2. The title of % the Index on its first page, 3. The running header for that index % section, and 4. The name of the section as you wish it to appear in % the Table of Contents. So, for instance % \begin{verbatim} % \putmultipleindex{fir}{INDEX OF FIRST LINES]{Index of First % Lines}{First Line Index} \end{verbatim} % includes an index with shortcut ``fir,'' title ``INDEX OF FIRST % LINES,'' running header ``Index of First Lines,'' and contents % entry ``First Line Index.'' % \section{Collections with multiple volumes} % \DescribeEnv{volumetitlepage} \DescribeEnv{maintitlepage} % The |\volumetitlepage| environment is an % environment for divider pages in collections made up of several % volumes. Volume title pages will always appear on recto pages. % \textsf{poemscol} will automatically create a blank verso page % preceding the volume title page if it 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 % page styles, with no page numbers and no running headers. % % \begin{sloppypar} % \DescribeMacro{\wholebooktitle} \DescribeMacro{\volumetitle} % \DescribeMacro{\volumetitlefirstline} % \DescribeMacro{\volumetitlemiddleline} % \DescribeMacro{\volumetitlelastline} % \DescribeMacro{\volumesubtitle} % \DescribeMacro{\volumesectiontitle} % |\wholebooktitle{}| is for the title of the entire collection. % |\volumetitle{}| is for the title of an individual volume within a % Collected Poems. The |\volumetitlefirstline{}|, % |\volumetitlemiddleline{}|, and |\volumetitlelastline{}| macros 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, but % you might not be happy with how it breaks up the lines.) % |\volumesubtitle{}| is for setting the subtitle to a volume. % |\volumesectiontitle{}| is for setting the title of a section of a % volume. In addition to setting the text in the body of your % edition, these commands send the title (and the formatting % information about it) to the table of contents file and to the % textnotes file.\end{sloppypar} % % \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 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 the % left running header for the entire book (except for divider pages, % the table of contents, the notes sections, and other special % cases). Normally that is the name of the entire book. % % \section{Recording textual notes} \subsection{~Setup for sections for % textual notes, emendations, and explanatory notes.} % \DescribeMacro{\makeemendations} \DescribeMacro{\maketextnotes} % \DescribeMacro{\makeexplanatorynotes} If you issue these commands, % \textsf{poemscol} puts all of the emendations, textual collations, % and explanatory notes in the backmatter of your volume. % \textsf{poemscol} opens external files for emendations, textual % collations, and explanatory notes (with extensions .emd, .ent, and % .enx respectively), and reads them back in at the place you specify % with |\puttextnotes|, |\putexplanatory|, or |\putemendations|, or at % the end (if you use the |\finish| command). % % To collect emendations, issue |\makeemendations| in your preamble. % To collect textual collations, issue |\maketextnotes| in your % preamble. To collect explanatory notes, issue % |\makeexplanatorynotes| in your preamble. These commands set up the % external files, send to them the commands for typesetting the % title of each section (e.g. Explanatory Notes) and for modifying the % running headers of the notes sections to xx--yy format (e.g. % ``Explanatory Notes to pp.~55--7''). % % If you wish to use multi-level footnotes rather than endnotes, you % do not need to issue |\maketextnotes| or its relatives (but you % should of course issue |\textnotesatfoot| or its relatives). You can mix % footnotes or endnotes as you wish. You may, for instance, wish to % set explanatory notes as footnotes, and textual notes and % emendations as endnotes. Instructions for setting up % \textsf{poemscol} to make footnotes are in section % \ref{makingfootnotes} below. % % In end note sections \textsf{poemscol} opens an entry (headed with % the title and page of the poem in the text) in the textual notes % section for every poem (since, minimally, you want to include % information about the variants and copy text of the poem), but only % opens entries in the emendations or explanatory notes sections if % you actually have emendations or explanatory notes on that poem. % The notes for each poem are set in a block paragraph, with a new % paragraph for every |\poemtitle| command, and the line counter for % the notes is reset to 1 with every |\begin{poem}|. (For long poems % in books or cantos, it would be wise to use |\poemtitle| for the % canto names or numbers, setting the poem title in some other way, % perhaps with |\volumetitle| described above.) % % % \subsection{~Textual notes of various kinds} % \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 send information to the textual notes % file (such as to force a page break), you can do so by using % |\sources{}|. You can send typesetting information to other sections % by using |\literalemend{}|, |\literalexplain{}|, or |\literalcontents{}|. % There is also a |\literaltextnote{}| command, which is equivalent to % |\sources{}|. % % \DescribeMacro{\textnote} % \DescribeMacro{\sameword} % \DescribeMacro{\missingpunct} % \DescribeMacro{\emendation} % \DescribeMacro{\explanatory} % |\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{}| % 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. To % put the $\sim$ glyph in your note (used for recording places where % the variant and the copy text have the same word, as for instance % when recording a variation of punctuation) use |\sameword|. To put % the ${}_{\wedge}$ glyph into your text (used for recording places % where a punctuation mark is missing in a variant), use % |\missingpunct|. % % For notes that refer to ranges of lines, |\textnote|, |\emendation|, and |\explanatory| % have an optional argument, which records how many lines the note % refers to. There are two ways of using this argument. The grubby % but simple way is simply to put into the argument the number of % lines it refers to. If, for instance, you issue |\textnote[4]{lemma] rest of note}|, % \textsf{poemscol}, rather than printing merely the number of % the line which closed just before you issued |\textnote|, will % print a line range, beginning at that line, and ending at the % fourth line after it. If that |\textnote| were issued after line % 214, this is to say, the output in the textual notes would be: % 214--218: lemma] rest of note. % % \begin{sloppypar} It seems clumsy to count the lines referred to by % a note, especially since you don't have to count lines to set where % the note begins. A more sophisticated way, and one which involves % no counting, is to make a unique poem line label for the last line % of the range by issuing |\poemlinelabel{some unique label}| just % after the |\verseline| or |\end{stanza}| that ends the range. (To % use |\poemlinelabel| see section \ref{poemlinelabel}.) Then, back % after the |\verseline| or |\end{stanza}| command that closes the % first line of the range, put the text of the label into the optional % argument of |\textnote| as follows: |\textnote[some unique label]{lemma]rest of note}|. % This is the preferred method. The line-counting method is % deprecated, but retained for backwards compatibility with earlier % versions. If you use the label method, you will have to run your % file through \LaTeX\ twice, once to define the labels, and once to % set the text.\end{sloppypar} % % One advantage of using an optional argument to specify line ranges % in notes is that nested or overlapping lemmas, or lemmas that % include stanza breaks, do not pose any difficulties. % % |\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 % take optional arguments to specify line ranges. % % If you quote verse \emph{within} a textual note, an explanatory note, or an % emendation, you may want to use the normal \LaTeX\ markup for verse % for that quotation, rather than the special markup for % \textsf{poemscol}. \textsf{poemscol} will not complain about this. % % If a textual note \emph{ends} with a quotation in verse, you should % follow the |\textnote{}| entry with % |\quotedversecorrectiontextnote|. % I found that if I % quoted verse in the note sections a dirty trick I used to send the % notes to the external files would cause the following notes on that % poem in the notes sections to be set in a new paragraph. (This is % of course not a problem if the quoted verse is the last thing in the % notes to that poem, since the next poem will open a new paragraph in % the notes anyway. It is also not a problem if more of the % individual textnote follows the verse. It's only a problem if the % last thing in the note is quoted verse, and the note is not the % last one % on that poem.) The command should set it flush as it is, but I have % found odd cases I can't understand in which that doesn't work, so % the command has an optional argument, which should % be the additional length you need to adjust the next line by to make it flush. % The default is 0pt. % |\quotedversecorrectionexplanatory| and % |\quotedversecorrectionemendation| should follow explanatory notes % or emendations that end with snippets of verse. These three % commands are an embarrassing kludge on my part. % They simply send commands to the relevant % note sections that prohibit opening a new paragraph. You should % issue this command in the main text right after the close of the textnote (not in the % text of the textnote itself). % % \DescribeMacro{\accidental} |\accidental{}| behaves exactly like % |\textnote{}|. If you wish to distinguish between accidentals and % substantives, this command provides a way of doing so. If you wish to % exclude % accidentals from your textual notes, issue % |\global||\includeaccidentalsfalse| in your preamble. Accidentals % are included by default, but if you issue |\includeaccidentalstrue| % in your preamble, you will remind yourself of that fact. % % \textsf{poemscol} does not provide for a separate backmatter section % for accidentals, but it would be trivial to construct one, using % |\definenewnotetype|, described in section \ref{definingnewnotes} % below. Be sure to delete the % existing definition of |\accidental| from poemscol.sty before doing % this. % % If you wish to exclude accidentals from your printed output, but to % mark them in your source files, so that your published collation % consists only of substantives, issue % |\global\includeaccidentalsfalse| in your preamble. Many publishers % are reluctant to publish accidentals, believing that they are, well, % less substantive than substantives. Using the |\accidental{}| % command allows you to exclude accidentals from the published version % should your publisher insist, while preserving the information about % them should the publisher's mind change. In the very worst case, if % you have marked all the accidentals in this way you can still % produce a list of accidentals for later use, and other scholars can % search for accidentals in your source files simply by searching for % the string |\accidental|. % % % \DescribeMacro{\tsvariant} % \DescribeMacro{\tsentry} % Some % publishers may turn up their noses at typescript or manuscript variants in just % the way they turn up their noses at accidentals. % If you wish to distinguish between published variants and typescript, % man\-u\-script, or galley variants, |\tsvariant| (for a whole note) % and |\tsentry| (for a typescript entry in a list of variants in a % textual note that includes other kinds of variant) provide ways of doing so. % By default, typescript variants are included. % To exclude 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 |\tsentry| will be included in your % output. % % Here is how to use |\tsentry|: % if you wish to include typescript entries in a single note including % those entries in a list with variants from other published versions % (as for instance when a comma appears in a typescript but only in % 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 % are excluded, the typescript entry will also be excluded. % % 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, % 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} % automatically provides the |\unskip| if the entry starts with a % comma or a semicolon. % % You can % 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|. % % \textsf{poemscol} does not provide for a separate backmatter section % for typescript variants, but it would be trivial to construct one, % 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 construct % |\tsvariant{}| commands in those places. For information about % |\definenewnotetype| see section \ref{definingnewnotes}. % % \section{Creating new kinds of endnote} \label{definingnewnotes} % \DescribeMacro{\definenewnotetype} The |\definenewnotetype| macro % 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. |\ifmynoteson| to see whether you are % collecting ``mynotes'', and |\ifnomynoteyet| to see whether you % have written a ``mynote'' for a particular poem yet). \textsf{poemscol} % will only open an entry for a poem in the ``mynotes'' section if % there actually is a ``mynote'' on that poem. Note that the |\if| % that refers to the section is plural (|\ifmynoteson|) and that the % |\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'' command for % writing literal, unexpanded text on the file (as % |\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. |\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 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} % \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 % 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 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} % % So, for instance,\begin{verbatim} % \definenewnotetype{xyznote}{xyz}{Xyznotes to}{XYZNOTES}{Xyznotes} % \end{verbatim} % creates the % booleans |\ifxyznoteson| and |\ifnoxyznoteyet|, the commands |\xyznote|, % |\literalxyznote|, |\prosexyznote|, |\pmxyznote|, and |\putxyznotes| (and, although you don't ever % have to use it explicitly, |\firstxyznote|) the output channel xyznotes, % the external file |\jobname.xyz|, an entry in the contents for % ``Xyznotes'', and an endnotes section with a running header of the % form ``Xyznotes to pp.~xx--yy'' and a title XYZNOTES. |\xyznote| % takes the same arguments that |\explanatory| does (which is to say, % an optional argument for a label for entering line ranges, and an % argument for the lemma and the comment). There won't be an entry % for a poem in the ``Xyznotes'' endnotes section unless there % actually is an xyznote for the poem. |\prosexyznote| takes the same % arguments |\proseexplanatory| does (which is to say, an aptional % argument for a label for entering line ranges, an argument for a % label to capture the line number of the first line, and an argument % for the lemma and the comment). |\pmxyznote| behaves exactly like % |\pmexplanatory|. % % \section{Multi-level footnotes} \label{makingfootnotes} % \textsf{poemscol} will set multiple % levels of footnotes in block paragraphs, separating each level with % a rule. To enable this feature, call the \textsf{manyfoot} package % as follows in your preamble: |\usepackage[ruled,para*]{manyfoot}|. % % To set your textual notes as footnotes, issue |\textnotesatfoot| in % your preamble. If you do this, \textsf{poemscol} will actually % create two sets of footnotes for textnotes, one for those that are % called with |\textnote|, which will produce an unindented block of % notes, and one for those that are called with |\sources|, which will % produce individual indented paragraphs, opening a new paragraph with % every note. |\sources| notes often have several paragraphs, so they % are inappropriate for block-paragraph or ``para'' mode, and because % those paragraphs are often in fact prose paragraphs, rather than % blocks of notations, they are indented, so that they will be read as % prose. To set your emendations as footnotes, issue % |\emendationsatfoot| in your preamble. These notes will be set by % default as block paragraphs. If you have multiple-paragraph notes % in your emendations, you should redefine these notes to set plain % rather than para style notes. (See the next paragraph for how to do % this.) To set your explanatory notes as % footnotes, issue |\explanationsatfoot|. These notes will also, by % default, be plain style notes, with one indented paragraph per note. % You do not need to issue |\maketextnotes|, |\makeemendations| or % |\makeexplanatorynotes| if you set those notes as footnotes. If you % use |\literaltextnote| anywhere in your file, however, you will lose % the text it would have put in your textnotes, since |\literaltext| % just writes its argument onto the external file for textual notes. % % % To change the style of your footnotes between plain and % para modes, globally change the values some of the following % booleans. |\ifsourcesfootnotespara|, obviously, is true if % footnotes from the |\sources| command are set in ``para'' mode % (default is false). |\iftextfootnotespara| is true if footnotes % from |\textnote| are set in ``para'' mode (default is true). % |\ifemendationfootnotespara|, or |\ifexplanfootnotespara| are the % booleans which set the style of footnotes from |\emendation| and % |\explanatory| respectively. By default, footnotes from % |\emendation| are set in ``para'' mode, and footnotes from % |\explanatory| are set in ``plain'' mode. g explanatory % footnotes from plain to para mode, for instance, issue % |\global\explanfootnotesparatrue|. Counterintuitive as it sounds, % you must issue this \emph{before} issuing |\textnotesatfoot| (or the % command for whichever other kind of note you are wishing to change % the appearance of). % % When |\sources| is defined to send endnotes to the textual notes % section, they usually appear immediately underneath the title of % the volume or poem they comment upon. If you are having |\sources| % output footnotes, it would be a good idea to open the note with the % title of the volume or poem it is a comment upon, in case there is % more than one poem on the page. % % When note classes are set as footnotes, the symbol which marks % cases in which a page turn falls on a stanza break will be set % \emph{beneath} the footnotes. This is a consequence of the way % \textsf{poemscol} uses the |\mark| mechanism to keep track of these % cases, so I have not figured out how to change it. But it may well % be more of an idiosyncrasy than a bug, particularly if the symbol % is changed from * to something like ``stanza break at page turn.'' % % To create a new level of footnote, you must first declare it to % 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 % |\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 % are reserved for sources, textual notes, emendations, and explanatory notes, % respectively). Then issue % |\newcommand{\mynote}[2][0]{\setlemmarange{#1}|\\ % |\FootnotetextE{\citerange}{#2}| % | \resetlemmacounters}| (|\setlemmarange|, |\citerange|, and % |\resetlemmacounters| enable your footnote to handle line ranges in % the lemma.) If a |\mynote| refers to a range of lines, you can issue % the same kinds of optional argument that are used with |\textnote|. % % \section{Pulling it all together} % \DescribeMacro{\testforauxonfirstrun} % If you don't want to listen to \LaTeX\ complain about missing % references during your first run, issue |\testforauxonfirstrun|, % which won't let |\finish|, % |\putexplanatory|, |\puttextnotes|, or |\putemendations| run unless there is an % .aux file for a previous run. \emph{Be sure to issue this command before % issuing} |\begin{document}|, \emph{since that reads in the existing .aux file, % and overwrites it with a new one.} % % \label{putexternalfiles} % \DescribeMacro{\putemendations} This macro 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 % will need to run your file through \LaTeX\ again, to put the correct % page number in the table of contents file. % % \DescribeMacro{\puttextnotes} % \DescribeMacro{\putexplanatory} |\puttextnotes| and % |\putexplanatory| do the same thing for the textual % notes and for the explanatory notes. % % All of these last three commands restore normal hyphenation. Since % all three are printed with the |\small| font size, the hyphen % character is defined only for that size. This should not create % other issues, however, because the commands that prohibit % hyphenation in the |poem| environment (and in the |contentsentry| % environment) are local to those environments, so the restoration of % the hyphen character may be redundant. % % \DescribeMacro{\putpoemindex} |\putpoemindex| reads in the index at % this point, and adds an entry for the index to external file for the % table of contents. % % \DescribeMacro{\putmultiplepoemindex} If you are generating % several indices using \textsf{splitindex} |\putmultiplepoemindex| % reads in one of them at this point. For instructions about this % command, see section \ref{multipleindex}, p.~\pageref{multipleindex}. % % \DescribeMacro{\finish} The % |\finish| macro 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 files for the three notes sections and reads them back into % the document (turning the automatic hyphenation back on for these % sections). It adds entries to the table of contents file for the % notes sections. It reads in the formatted index file (which you % have made from your raw .idx file using MakeIndex between \LaTeX\ % runs) and adds an entry for the index to the table of contents. % Then it closes the external file for the table of contents and reads % that in (putting it at the end of the document, as I explained % before). Then it adds a page explaining that the symbol (by default *) 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 the lines to % read those files in and add entries for them in the table of % contents. % % % \section{Special cases} % \subsection{~Epigraphs, attributions etc.} % \DescribeMacro{\epigraph} \DescribeMacro{\headnote} % \DescribeMacro{\attribution} \DescribeMacro{\poemdedication} % |\epigraph|, |\headnote|, |\attribution|, and |\poemdedication| set % their arguments as epigraphs, headnotes, attributions, or % dedications. If you have dedications, epigraphs, or attributions on % the divider pages of editions that combine several volumes of % poetry, use |\volumededication{}|, |\volumeepigraph{}|, and % |\volumeattribution{}|. % % \subsection{~Inset prose quotations} % \DescribeMacro{\saveverselinenumber} % \DescribeMacro{\restoreverselinenumber} Sometimes you will have inset prose % passages, but you will not wish to start the line numbering over % 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 % |\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 % different handling. To provide line numbers and notes for such % prose sections, see section \ref{prosesections}. % % \subsection{~Multiline poem titles} % \DescribeMacro{\poemtitlefirstline} % \DescribeMacro{\poemtitlemiddleline} % \DescribeMacro{\poemtitlelastline} % \DescribeMacro{\poemtitlenocontents} % \DescribeMacro{\poemtitlebaretitle} % Very long titles present special problems. In the first place, they % require special provisions to make sure that page breaks don't % 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 % 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 % long title.) % % If you wish to set the titles differently in the text and in the % contents, you can set the title in the text and notes with % |\poemtitlenocontents{}| and send a differently formatted entry to % the table of contents file using |\literalcontents{}|. (Remember % that you will have to send not only the title of the poem to the % contents, but also the other formatting information, such as the % indentation, the slash, and the label for the page number.) % |\poemtitlebaretitle{}| simply sets the title in the text, enabling % you to use |\literalcontents{}| and |literaltextnotes{}| to produce % whatever effect you wish. % % Alternatively, you can just let \textsf{poemscol} handle the long % titles by itself. If you are pretty sure that the author did not % 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 % may get a complaint on your log file about an overfull |\hbox| if % you do this, however. % % \subsection{~Italicized poem titles and empty poem titles} 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. % % \DescribeMacro{\poemtitleitalic{}{}} |\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, % for cross reference purposes. (Actually, now that \textsf{poemscol} % 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{\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 % 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{\poemtitlenotitleitalic{}{}} % |\poemtitlenotitleitalic{}{}|, with its even more paradoxical name, % is for poems without formal titles but with italicized words in their % 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 % is obsolete now that italics in titles no longer require special % handing, but is retained for backwards compatibility. % % \subsection{~Poems in sections} % % \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 % 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 % 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 % dealing with special cases I didn't anticipate by using % |\poemsectiontitlebaretitle{}| and |\literalcontents{}| and its % siblings.\end{sloppypar} % % \subsection{~Poetic sequences} % % \DescribeMacro{\sequencetitle} \DescribeMacro{\sequencesectiontitle} % \DescribeMacro{\sequencefirstsectiontitle} Sequences of related % poems, perhaps with an over-title, demand special handling in the % text, in the notes sections, and in the table of contents. (A % moment's thought will show that they are different in some ways from % 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, and % |\sequencesectiontitle{}| sets the titles of the sections of the % sequence. |\sequencefirstsectiontitle{}| gives a little more % vertical space between the main title and the first section title % 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, % since there should be no page break between the sequence title and % the title of the first section of the sequence (although page breaks % are permissible, indeed even slightly favored, between later % sections). There should also never be a page break between a % section title and the first or second line of the section. The % penalties \textsf{poemscol} sets should take care of these % automatically, but you may still have cases which require you to % specify a page break with |\pagebreak| or |\newpage|. There are a % host of other commands, all with self-explanatory titles, that deal % with some special situations that arise in setting the elements of % 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 % you may need. % % Here is a list of all of the defined title commands. % % \begin{itemize} % \item Macros for Poem titles % \begin{itemize} % \item |\poemtitle| % \item |\poemtitlefirstline| % \item |\poemtitlemiddleline| % \item |\poemtitlelastline| % \item |\poemtitlenotitle| % \item |\poemtitlenocontents| % \item |\poemtitlebaretitle| % \item |\poemsubtitle| % \end{itemize} % \item Poems in Sections % \begin{itemize} % \item |\poemsectiontitle| % \item |\poemsectiontitlefirstline| % \item |\poemsectiontitlemiddleline| % \item |\poemsectiontitlelastline| % \item |\poemsectiontitlenocontents| % \item |\poemsectiontitlebaretitle| % \item |\poemfirstsectiontitle| % \item |\poemfirstsectiontitlebaretitle| % \item |\poemsubsectiontitle| % \end{itemize} % \item Sequence Titles % \begin{itemize} % \item |\sequencetitle| % \item |\sequencetitlefirstline| % \item |\sequencetitlemiddleline| % \item |\sequencetitlelastline| % \item |\sequencetitlenonotes| % \end{itemize} % \item Sequence Sections % \begin{itemize} % \item |\sequencesectiontitle| % \item |\sequencesectiontitlenocontents| % \item |\sequencesectiontitlenonotes| % \item |\sequencesectiontitlebaretitle| % \item |\sequencesectiontitlefirstline| % \item |\sequencesectiontitlemiddleline| % \item |\sequencesectiontitlelastline| % \item |\sequencefirstsectiontitle| % \item |\sequencefirstsectiontitlenocontents| % \item |\sequencefirstsectiontitlenonotes| % \item |\sequencefirstsectiontitlefirstline| % \item |\sequencefirstsectiontitlemiddleline| % \item |\sequencefirstsectiontitlelastline| % \item |\sequencesectionsubtitle| % \end{itemize} % \item Sequence Subsections % \begin{itemize} % \item |\sequencesubsectiontitle| % \item |\sequencesubsectiontitlenocontents| % \item |\sequencefirstsubsectiontitle| % \item |\sequencefirstsubsectiontitlenocontents| % \item |\sequencesubsectiontitlefirstline| % \item |\sequencesubsectiontitlemiddleline| % \item |\sequencesubsectiontitlelastline| % \item |\sequencefirstsubsectiontitlefirstline| % \item |\sequencefirstsubsectiontitlemiddleline| % \item |\sequencefirstsubsectiontitlelastline| % % \item |\sequencesubsubsectiontitle| % \item |\sequencesubsubsectiontitlenocontents| % \item |\sequencefirstsubsubsectiontitlenocontents| % \end{itemize} % \end{itemize} % % % \subsection{~Customizing titles} \textsf{poemscol} provides a large % 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 should in turn call three macros, % |\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 % sets the title in the notes sections. (You should enclose the whole % thing between |\makeatletter| and |\makeatother|.) |\set@p@emtitle| % takes six arguments, which are, in order, (1) the title (which, if % you are calling this command inside of the definition of |\mytitle| % should just be |#1|), (2) commands to be issued before setting the % title (minimally, a penalty, such as |\poemtitlepenalty|), (3) the % font size in which the title is to be set in the text (such as % |\poemtitlefont| or |\large|), (4) any indentation of the title % (|\relax| for |\poemtitle|, or |\titleindent| for % |\sequencesectiontitle|), (5) commands to be issued after the % title is set (such as |\afterpoemtitleskip|) and (6) the amount % overrun lines in the title should be indented. |\c@ntentsinfo| takes % four arguments, which are, in order, (1) the title, (2) the % indentation of the title in the table of contents (such as % |\contentsindentone|), (3), the font size in which the title % should be set (such as |\contentspoemtitlefont|) and (4) the amount % overrun lines in the table of contents should be indented (such as % |\contentsindenttwoamount|). |\t@xtnotesinfo| % takes one argument, the title. By default, \textsf{poemscol} % does not indent the overrun portion of titles relative to the first % line of the title, but if that first line is indented will set the % overrun portions to be indented the same amount. Overrun portions % of titles in the table of contents will be indented by one % |\contentsindentamount| more than the first line is indented. Both % of these behaviors can be changed by changing the arguments to % |\set@p@emtitle| or |\c@ntentsinfo|. % % If you wish to design a title which might have multiple lines, you will need to % write three macros: one for the first line, one for middle lines, and one for % the last lines. 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 the body of the text in the same way, but will be run in in % the notes sections. % % \DescribeMacro{\JHpoemtitle} % In his edition of the poetry of Jos\'e Maria Heredia, Tilmann % Altenberg placed a marker in the margin next to poem titles with a reference to where % in the apparatus notes on that poem could be found. To do this, use % the |\JHpoemtitle| command. This command takes two arguments: % first, the title of the poem, second, the label used by the % |\label| command on the page of the notes section to which the % title refers. So, you would issue the poem title command this way: % |\poemtitle{Los desvelados}{EP_LosDesvelados_AC}|. Up to version 2.49 % of \textsf{poemscol} you had to be sure to define the label in the % notes sections by issuing |\sources{\label{EP_LosDesvelados_AC}}|. % This is no longer necessary, and |\JHpoemtitle| defines both the % |\label| and the |\pageref|. Instructions are % given in section \ref{JHpoemtitle}, p.~\pageref{JHpoemtitle} for how to % construct similar commands for sequences, sequence sections, and so % on. % % \begin{sloppypar} % The following related commands are defined already % |\JHsequencetitle|, |\JHsequencefirstsectiontitle|, % |\JHsequencesectiontitle|, |\JHsequencesubsectiontitle|, % |\JHpoemsectiontitle|, |\JHpoemfirstsectiontitle|, % |\JHpoemsubtitle|, |\JHepigraph|, |\JHprosesectiontitle|, and % |\JHdedication|.\end{sloppypar} % % If you are using |\JHpoemtitle| and its siblings, you need to be % sure to add \textsf{mparhack} to your package list. You can prevent % the marginal reference from switching sides on alternate pages by issuing % |\@mparswitchfalse| (be sure to put |\makeatletter| and % |\makeatother| around this command). You can control the side on % which the marginal reference appears with |\normalmarginpar| (to % place them on the right) or |\reversemarginpar| (to place them on % 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 % want to be issued while the title is being processed. % % \DescribeMacro{\margreftextnote} % Another feature of Altenberg's Heredia edition is a marginal mark % attached to lines to which text notes refer showing where in the % apparatus a comment upon that line is to be found. % |\margreftextnote| sets a label in the textual notes section, and % set a marginal note with a page reference to that label. Issue % |\margreftextnote| \emph{before} issuing the |\verseline| or % |\end{stanza}| that closes the line to which it refers. (The textual % note itself can be an ordinary |\textnote|, and should be place, as % usual, \emph{after} the |\verseline| or |\end{stanza}|. % % |\margreftextnote| generates its own label, so there is no need to % make up one yourself. % % |\margreftextnote| uses |\marginpar| rather % that |\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. % |\mparswitch| and |\reversemarginpar|) to control the behavior of % these marks. % % \begin{sloppypar} % If you define a new endnote type using |\definenewnotetype|, % |\definenewnotetype| will also define a new |\margref| command to go % with it.\end{sloppypar} % % \DescribeMacro{\setmargrefmarker} Altenberg's edition used a ding % 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. % |\setmargrefmarker{\ding{228}}|). % % \DescribeMacro{\margrefemendation} |\margrefemendation| is a % version of |\margreftextnote| for emendations. % % \DescribeMacro{\margrefexplanatory}|\margrefexplanatory| is a % version of |\margreftextnote| for explanatory notes. % % \subsection{~Visual formatting} % \DescribeMacro{\longpage} % \DescribeMacro{\shortpage} % The ideal in \LaTeX\ is to separate % content markup and formatting as completely as possible. In the text % itself you simply mark the logical units (a poem, a title, a stanza, % a textual note), and a header program like this interprets the % meaning of those terms typographically. However, one still winds up % having to do some visual formatting. Especially in prose sections, % such as in the textual notes, you will sometimes have to enlarge or % shrink a page by one line in order to avoid an intractable widow or % club line, and when one does so one must be careful to do the same to % the other member of the two-page spread of which that page is a part. % These commands enable one to wiggle pagelength enough to handle these % problems. Since verse sections should be set with |\raggedbottom| % in effect, the commands are not necessary in verse sections. % % \section{Customizing page geometry} % % % \subsection{~Font sizes, skips, sinks indents, and penalties} % % \label{changingfontsandleading} % \textsf{poemscol} sets the font sizes, but not the font family, of fonts for many % common tasks, in order to create a hierarchy of sizes. They can be changed % with a |\renewcommand| of the following form, where the first number is % the font size in points and the second is the leading:\\ % |\renewcommand{\volumetitlefont}{\fontsize{18}{23}\selectfont}| % % % The following table gives the default values for the fonts. The titles of % the fonts give their uses. Backmatterheaderfont is for setting the % titles of back matter sections. Sequence section titles use % poemtitlefont. Backmattertext font is |\small|, backmatterintrofont % is |\normalsize|. % \bigskip % % \begin{tabular}{l l l} % \textbf{Font} & \textbf{Size} & \textbf{Leading} \\ % volumetitlefont & 18 & 23 \\ % volumesubtitlefont & 14 & 18 \\ % poemtitlefont & 14 & 18 \\ % sequencetitlefont & 16 & 20 \\ % subsectiontitlefont & 12 & 14.5 \\ % backmatterheaderfont & 16 & 20 \\ % backmattervolumefont & 12 & 14.5 \\ % backmattervolumesubtitlefont & 11 & 13 \\ % contentsvolumefont & 13 & 20 \\ % contentsvolumesubtitlefont & 12 & 14.5 \\ % contentssequencetitlefont & 10 & 14 \\ % contentspoemtitlefont & 10 & 14 \\ % \end{tabular} % % \bigskip % % The following table gives various skips, sinks, penalties, and indentations. The % titles of these should be self-explanatory. These should be changed % with |\renewcommand| as follows:\\ % |\newcommand{\volumetitlesink}{\leavevmode\vspace{23.5pt}}| % \bigskip % % \begin{tabular}{l l l} % \textbf{Name} & \textbf{Argument} & \textbf{Comment} \\ % backmattersink & 21.5pt & \relax \\ % backmatterafterheadersink & 11pt& \relax \\ % afterpoemtitleskip & |\smallskip| & \relax \\ % afterpoemskip & |\bigskip| & \relax \\ % aftersequencetitleskip & |\medskip| & \relax \\ % stanzaskip & |\medskip| & Extra skip between stanzas \\ % titleindent & |\titleindentamount| (1pc) & use |\setlength| to % change \\ % parindent & titleindentamount & \relax \\ % volumetitleshift & volumetitleshiftamount & use |\setlength| to % change \\ % contentsindentone & 24pt & \relax \\ % contentsindenttwo & 42pt & \relax \\ % contentsindentthree & 60pt & \relax \\ % contentsindentfour & 72pt & \relax \\ % runoverindentvalue & 6em & for runover lines in verse\\ % verseindent & 2em & for formally indented lines\\ % notesclubpoempenalty & -300 & \relax \\ % notessequenceclubpenalty & -1500 & \relax \\ % notesvolumetitlepenalty & -1500 & \relax \\ % \end{tabular} % % \subsection{~Page styles} % \textsf{poemscol} also sets several default page styles, defined % below. The main page style is ``fancy'' (defined below), used for % prose frontmatter (such as introductions), the main body of the % poetry, and the endnotes sections. ``Volumefirststyle'' is for the % first page of a volume of poems. ``Volumetitlestyle'' is for the % title page of a volume of poems. The external file for the table of % contents redefines ``fancy,'' so you should issue |\resetpagestyle| % after issuing |\putpoemcontents|. % % \subsection{~Page geometry and type leading} % % You have to give geometry the values that suit you. I include the % values I used in my own book, just to give you a starting place. % Using these numbers out of the box might make your page look % strange, since I also used the now obsolete \textsf{cropmarks} % package, which defined a few other lengths and moved the page box % around on the page. Also, the default values for marginparsep and % marginparwidth are different now (18pt and 10pt respectively). With % that warning, here is a list of the values I used: % % \bigskip % % \begin{tabular}{l l} % tmargin& 33pt\\ % textwidth&318.21pt\\ % textheight&550pt\\ % marginparsep&7pt\\ % marginparwidth&10pt\\ % headheight& 15pt\\ % headsep&19pt\\ % footskip&15pt\\ % lmargin&132pt\\ % \end{tabular} % %\bigskip % % You can reproduce this geometry by issuing the command % |\tightgeometry|. % % In my own book I also, strictly to save money, and at the price of % some ugliness, changed the definition of |\normalsize| and |\small|, % so that the former was 10 pt type on 11 pt leading (rather than 12 % pt), and that the latter was 9 pt type on 10 pt leading. You can % reproduce this setting by issuing |\tightleading|, although I would % advise not doing so unless you are under financial constraints. % % \section{Prose Sections} \label{prosesections} \textsf{poemscol} % uses the \textsf{lineno} package to make marginal line numbers for % prose sections such as the Author's Introduction, Afterword, % Author's Notes, or such prose interludes or prose poems the volume % may include. To control the appearance, placement, and frequency of % marginal line numbers in prose sections, you may wish to consult the % manual to \textsf{lineno}. I have added a minimal user interface to % make \textsf{lineno} cohere with poemscol. You may have to fiddle % with the parameters of both \textsf{poemscol} and \textsf{lineno} to % persuade them to set marginal line numbers that look the same way in % prose and verse contexts. The default values should work as is. % % Line numbers in prose sections are placed using a different % |\length| from that used in verse sections. Essentially, verse % sections, and prose sections which use paragraph and sentence % numbering --- see below, in section \ref{paragraphsentence} --- % place the marginal line numbers using |\marginparsep|. Prose % sections which are numbered by line use |\linenumbersep| instead, % which is a length defined in the \textsf{lineno} package. I have % given values for both lengths which seem to place line numbers on % the left and on the right side in prose sections roughly where they % are placed in verse sections. You can change these values with % |\setcounter{countername}{length}|. % % |\verselinenumberstoleft| and |\verselinenumberstoright| also place % the line numbers to the left or to the right, respectively, in prose % sections. If you wish the numbering to appear on a different side % in prose contexts you can set the side by issuing |\leftlinenumbers| % or |\rightlinenumbers|. These last are commands from the % \textsf{lineno} package. The two forms in which line numbers switch % sides in prose contexts can't at the moment be used, because of a % clash between how \textsf{lineno} handles line numbers that switch % sides and the way I pass the line numbers to notes sections. If you % have set the verse line numbers to switch sides, prose line numbers % will appear on the right side. I hope soon to find a workaround for % this problem. % % By default, the line modulo for prose sections is the same as that for % verse sections; if you have a line number every 5 lines in verse, % you will have the same in prose. You can set the prose line modulo % independently with |\setprosemodulo|. % % \textsf{poemscol} may deal with rather long stretches of prose, but % it is not designed to be used for critical editions of extended % prose texts, as \texttt{EDMAC}, \textsf{ledmac}, or \textsf{ednotes} % are. The method of entering line ranges into notes in prose % contexts is something of a hack, and rather a worse one than the one % employed in verse contexts, since it involves using two labels for % each note, one to capture the line number of the beginning, the % other to capture the line number of the end. Other limitations of % this method may show up with longer prose extracts. % % \DescribeMacro{\prosesectiontitle} Prose sections may be titled with % |\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 % |\literalcontents| and |\literaltextnotes| to set such titles as you % please. % %\DescribeMacro{prosesection} % Prose sections should be enclosed in a |prosesection| environment % (between |\begin{prosesection}| and % |\end{prosesection}|). Entering this environment sets the modulo repeat for line % numbering to the same value that prevails in verse contexts, and % resets the prose line number to zero. If for some reason you do not % wish to reset the line number but continue on from where it left off at the end of % the last prose section, use the |prosesectionnoreset| environment % instead. % % \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{}|. % % % 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 % verse passage to a prose passage, just before the |\end{poem}| at the % end of the first verse passage issue |\saveverselinenumber| to save % the number of the verse passage. After you issue % |\begin{prosesection}| issue % |\resetlinenumber[\theverselineumberscratch]| to apply that number to % the prose section. To number continuously while moving from prose to % verse is more tricky. One way might be to mark a label at the end of % the prose passage with |\proselinelabel{prose end label}| (or some other % suitably unique label). This label will record the line number of % the last prose line. Pass that value to |\restoreverselinenumber| % by issuing |\setcounterfromref{verselinenumberscratch}{prose end label}|. % Then issue |\restoreverselinenumber| just after issuing the |\begin{poem}| that restarts % the verse again. I would recommend % against numbering verse and prose continuously, however, since a verse % line and a prose line are different categories of thing, the one being % an element of prosody, the other being only an element of typography. % % % \DescribeMacro{\proselinelabel} % |\proselinelabel| is simply |\linelabel| from \textsf{lineno}. I % have provided the new name to make it easy to distinguish from % |\poemlinelabel|. % % % % \DescribeMacro{\prosetextnote} % \DescribeMacro{\prosemendation} % \DescribeMacro{\proseexplanatory} % Special versions of |\textnote|, |\emendation| and |\explanatory| % are available for use in prose sections. |\prosetextnote|, % |\proseemendation|, and |\proseexplanatory| differ from the verse % versions in that they each require an extra argument, a unique label % to be used in locating the line number for use by the notes % commands. If |\maketextnotes|, |\makeemendations|, or % |\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 % poem. |\textnotesatfoot|, |\emendationsatfoot|, and % |\explanationsatfoot| will send the notes from prose contexts to the % usual footnote levels. Notes commands in prose contexts take three % arguments. As in verse sections, in prose sections textnotes, % explanatory notes, and emendations have an optional first argument % for recording line ranges. As in verse sections, you can record % these line ranges either by simply putting in the argument how many % lines the lemma will refer to (a deprecated method retained for % backward compatibility reasons), or the argument of a % |\proselinelabel| command on the last line of the lemma. (The only % difference from the verse version here is that you should make the % label using the |\proselinelabel| command, rather than with the % |\poemlinelabel| command.) The second argument is a label to % identify each note uniquely, which is used to find the line number % at which the note begins. You will need a different label for % 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 % 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 % occur (at the beginning of the passage): % \begin{verbatim} % \prosetextnote[a way of driving away the spleen] {Call me Ishmael} % {Call me Ishmael \ldots\ a way of driving away the spleen] text of % textual note} \end{verbatim}, and on % last line of the passage to which the note refers you would % issue: \\ |\proselinelabel{a way of driving away the spleen}|. % % \DescribeMacro{\prosetsvariant} % \DescribeMacro{\proseaccidental} % \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 % line ranges, as usual), and two mandatory arguments (the first a % label to capture the line number, the second the lemma and comment). % |\proseaccidental| and |\prosetsaccidental| take only the two mandatory arguments, since % by definition an accidental variant is confined to one line. % % One caveat: because the line numbers for notes in prose contexts % are generated by a label/ref mechanism, each note will result in a % complaint about an undefined reference the first time the file is run through % \LaTeX. Either run the first pass in quiet mode, or be prepared to % ignore a lot of griping until % \LaTeX\ has generated the .aux file at the end of the first run. % % \section{Paragraph and Sentence Annotation}\label{paragraphsentence} % Annotating a prose section by sentence number, or by paragraph number and % sentence number, has some advantages over annotating it by line % number. The principal advantage is that the annotation and reference % system can remain stable over multiple editions, even if they are set % in different formats. The most familiar of such systems is the % chapter and verse system in the Bible, introduced by Archbishop % Stephen Langton in the thirteenth century (who divided the Vulgate % edition into numbered chapters) and by Robert Estienne in the % sixteenth century (who added the verse numbers). Such a form of % annotation might be especially useful for medieval prosimetra, a form % combining verse and prose. (Hence the commands that follow often % begin with |pm|.) % % \DescribeMacro{pmsection} % You should put prose marked up for sentence and paragraph % annotation in a |pmsection| environment. % You do not need to put prose marked up for sentence and paragraph % annotation in a |prosesection| environment. That environment is % only needed if you are line-numbering prose. You also do not need % to load the \textsf{lineno} package if you are using the sentence % and paragraph system for annotating prose. You might, however, % still wish to set the title with |\prosesectiontitle|. % % \DescribeMacro{\setprosebysentence} % |\setprosebysentence| sets \textsf{poemscol} to number prose by % sentence rather than by line number. This command is mostly a % placeholder now, used only for setting the value of |\marginparsep| % to something better for prose. (|\marginparsep| sets how far the % line numbers are from the text block.) |\verselinenumberstoleft|, % |\verselinenumberstoright|, and |\verselinenumbersswitch| each pick % convenient values for |\marginparsep|. By default these values all % line up on the page, but if you change any of them, you may have to % use reset |\marginparsep| to some value you will have to find by % trial and error, since they each use |\marginparsep| in slightly % different ways. You can change |\marginparsep| either by using % |\setlength{\marginparsep}{length}| or, better, by using % |\renewcommand| to change the setting of |\marginparsep| in % |\verselinenumberstoleft| or whatever else you intend to use. % % \DescribeMacro{\pmsentence} Each sentence must begin with % |\pmsentence|. |\pmsentence| increments the sentence counter, % optionally puts the sentence number in the running text, and % optionally puts the sentence number in the margin. % % |\runningsentencenumberstrue| % sets sentence % numbers in the running text. % To set sentence numbers in the margin, issue % |\marginsentencenumberstrue|. You can issue both, either, or neither of % these commands. % % \DescribeMacro{\setpmmodulo} % If you are putting sentence numbers in % the margin, you need not number every sentence. Indeed, if there is % more than one sentence on a line, the numbers will overwrite each % other (unless you use the marn.sty package, and substitute |\marn| % for |\pmclrightsidepar|, |\pmclleftsidepar| or |\pmclsidepar| in the 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{}|. % % \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 % are something of a kludge, but they will do until I figure out how % to do this better. % % \DescribeMacro{\pmnumberstoright} % \DescribeMacro{\pmnumberstoleft} % \DescribeMacro{\pmnumbersgutter} % \DescribeMacro{\pmnumbersouter} % If you wish to control the % margin in which sentence and paragraph numbers appear, issue |\pmnumbersright|, % |\pmnumbersleft|, |\pmnumbersgutter|, or % |\pmnumbersouter|. By default, these numbers will line up with % the line numbers in verse sections. If you change the value of % |\marginparsep| for prose sections from those used by their verse equivalents, it is a % good idea to issue the verse equivalent command % (|\versenumberstoright| or whatever) again when you move % from a prose to a verse environment. % % % |\runningsentencenumberformat| sets the format of running sentence numbers. Currently it is % |\textsuperscript| and |\tiny|. % You can change this with |\renewcommand|. The format of marginal % sentence numers is set by |\marginsentencenumberformat|. Currently it % is |\tiny|. You can % change this with |\renewcommmand|. % % \DescribeMacro{\pmpara} % \DescribeMacro{\pmsentencebypara} % \DescribeMacro{\pmsparainmartrue} % \DescribeMacro{\pmpararunningtrue} % You can also number paragraphs. Each paragraph must begin with % |\pmpara|. |\pmpara| increments the paragraph counter, optionally % puts the paragraph number in the running text, and optionally puts % the paragraph number in the margin. To reset the sentence counter % at the beginning of each paragraph, issue |\pmsentencebyparatrue| in % your preamble. To set paragraph numbers in the margin, issue % |\pmparainmartrue|. To set paragraph numbers in the running text, % issue |\pmpararunningtrue|. You can issue both, either, or neither of % these last two commands. Which margin these numbers are set in % is controlled by the same commands that control placement of % marginal sentence numbers. % % If you begin a paragraph with |\pmpara| \textsf{poemscol} will % assume that you intend to include the paragraph number in your % notes (in the form \emph{paragraph: sentence:} for simple % references, or \emph{firstparagraph: firstsentence: -- % ;astparagraph: lastentence:} for ranges of sentences) even if you do not reset % the sentence number at the beginning of each paragraph. Normally % you would not issue |\pmpara| if you are not resetting the sentence % number at the beginning of each paragraph, since under those % circumstances you don't really need to keep track of the paragraph % numbers, in which case each note would simply include the sentence % number (just as in verse it would include the line number). In the % unusual event in which you wish to put the paragraph number in the % margin but refer only to sentence numbers in the notes, simply % follow every use of |\pmpara| with |\pmparasfalse|. % % \DescribeMacro{\pmpararunningformat}\DescribeMacro{\pmparmarformat} % The format of running paragraph numbers is set % by |\pmparrunningformat|. Currently it is % |\textbf| and |\small|. % The format of marginal paragraph numbers is set by % |\pmparmarformat|. Currently it is % |\textbf| and |\small|. Either can % be changed with |\renewcommand|. % % \subsection{Cross Reference 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 % 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). % % \subsection{End notes by Sentence and Paragraph} % % \begin{sloppypar} % \DescribeMacro{\pmtextnote} % \DescribeMacro{\pmexplanatory} % \DescribeMacro{\pmemendation} % \DescribeMacro{\pmaccidental} % \DescribeMacro{\pmtsvariant} % \DescribeMacro{\pmtsaccidental} % |\pmtextnote|, |\pmexplanatory|, |\pmemendation|, |\pmaccidental|, % |\pmtsvariant| and |\pmtsaccidental| are special versions of the % usual endnote commands for use with annotations by sentence and % paragraph. If you have not issued |\pmsentencebypara| these % commands will write the sentence number at the head of each note, % where the line number would usually go. If you have issued % |\pmsentencebypara|, these commands will issue both the paragraph % and sentence number, in the format \textless paragraph % number\textgreater:\textless sentence number\textgreater. You can % refer to ranges of sentences (or paragraphs and sentences) in a way % very similar to how you do so in verse sections. At the end of the % range, issue a |\sentencelabel| command, with a unique label. At % the beginning of the range, issue your |\pmtextnote| command with the % optional argument in square brackets before the main argument, % giving your unique label as the value of that argument, e.g. % |\pmtextnote[some label]{text of lemma] comment}|. At the end of % your range, issue |\sentencelabel{some label}|, using the same % label you put in the square brackets for the |\pmtextnote|. If you have not % issued |\pmsentencebypara|, the range will simply be the range of % sentence numbers. If you have issued |\pmsentencebypara|, the range % will include paragraph and sentence numbers, like this: % 4:12--6:13.\end{sloppypar} % % |\sources| needs no special handling if you are annotating by % sentence and paragraph. % % \subsection{Footnotes by Sentence and Paragraph} % |\textnoteatfoot| shifts |\pmtextnotes| to the foot, as with % |\prosetextnote|. |\emendationsatfoot| and |\explanationsatfoot| % work the same way. % \subsection{Bible Chapter and Verse} % Since |\pmsentence| and |\pmpar| are the moral equivalents of bible % verse and chapter, |\biblechapter| and |\bibleverse| are provided % for convenience. % \section{Parallel Text Editions} % \textsf{poemscol} does not make parallel texts in which the texts are % set in parallel on the same page, but it can help one make parallel % text editions in which the contrasting versions are set on facing % verso and recto pages. \textsf{poemscol} does not provide the page % breaks for parallel editions, and even if it did, one would still % probably have to specify page breaks every two or three pages to keep % the texts in register. If you are willing to set the page breaks % yourself, however, it does provide macros 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 page on a particular side of the book. And it provides, in % the |\synchrolabel| and |\synchroref| commands, a way of marking which % lines on the recto side correspond to particular lines on the verso % side. |\synchroref| will even tag the marginal line number it makes % with a marker to specify the text to which it refers. % % \DescribeMacro{\startparalleltexts} % \DescribeMacro{\startrectopage} % \DescribeMacro{\finishrectopage} % \DescribeMacro{\startversopage} % \DescribeMacro{\finishversopage} % You must begin a region of parallel text on a \emph{verso} page. % Setting parallel texts requires one to redefine the poem and stanza % environments. A parallel text region must begin with % |\startparalleltexts| to redefine those environments. Verso pages % should begin with |\startversopage| and end with |\finishversopage|. % Recto pages should begin with |\startrectopage| and end with % |\finishrectopage|. You have to declare the page breaks manually, % so be sure you are putting the two |\finish| commands in places which % will work. % % Although usually with \textsf{poemscol} it is up to you where to put % the marginal line numbers, when you issue |\startparalleltexts| the % positions are fixed as follows: marginal line numbers are in the left % margin, line cross references (marking which lines in the recto text % correspond to which lines in the verso text) are in the right margin. % % \DescribeMacro{\synchrolabel} \DescribeMacro{\synchroref} % \DescribeMacro{\setsynchroflag} To mark these cross references, you % need to make a label on the verso side, and a corresponding % reference on the recto side. You may also wish to add a mark to % that reference to specify what edition it refers to. So, for % instance, if your verso text is the 1805 version of Wordsworth's % \emph{The Prelude}, and your recto text is the 1850 version, you may % wish to specify |\setsynchroflag{1850: }|, which will preface the % references put out by the |\synchroref| command with `1850: '. % Suppose you wished to tie the line ``Oh, what can ail thee, man at % arms?'' on the verso side to the line ``Oh, what can ail thee, % wretched wight?'' on the recto. To make the label, issue the % |\synchrolabel| command on the verso side just after the % |\verseline| or |\end{stanza}| which closes the line you wish to % label: % % \begin{verbatim} % Oh, what can ail thee, man at arms?\verseline % \synchrolabel{Oh, what can ail thee, man at arms?} % \end{verbatim} % You don't have to quote the whole line in the label, but it should be % long enough to uniquely pick out that line in the poem. (If the line % is repeated in the poem, you will have to exercise your ingenuity in % making up a unique label.) % % Over on the recto side, you will want to use |\synchroref| in order % to print the marginal cross reference. The |\synchroref| command % should come \emph{before} the |\verseline| that closes the line it is % tied to, as follows: % % \begin{verbatim} % Oh, what can ail thee, wretched wight? % \synchroref{Oh what can ail thee, knight at arms?}\verseline % \end{verbatim} % % \section{Using \textsf{poemscol} in a Multilingual World} % % \begin{sloppypar} % \DescribeMacro{\changecontentsname} % By default, \textsf{poemscol} uses English language titles for such % things as the Table of Contents, the Explanatory Notes, and so on, % and uses English language running headers. As of version 2.5 these % are easily changed. To change the name of the Table of Contents % (the default is CONTENTS) to Inhaltsverzeichnis, issue % |\changecontentsname{Inhaltsverzeichnis}|. To change the running % header on contents pages, iss