poemscol (24aug17)

git-svn-id: svn://tug.org/texlive/trunk@45115 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 68 insertions, 27 deletions

diff --git a/Master/texmf-dist/source/latex/poemscol/poemscol.dtx b/Master/texmf-dist/source/latex/poemscol/poemscol.dtx
index cc01a3d1492..f10e8d15165 100644
--- a/Master/texmf-dist/source/latex/poemscol/poemscol.dtx
+++ b/Master/texmf-dist/source/latex/poemscol/poemscol.dtx
@@ -1,7 +1,7 @@
 % \iffalse meta-comment
 % !TEX TS-program = dtxmk 
 %
-% Copyright (C) 2015 by John Burt <burt@brandeis.edu>
+% Copyright (C) 2017 by John Burt <burt@brandeis.edu>
 % --------------------------------------------------
 % 
 % This file may be distributed and/or modified under the
@@ -19,7 +19,7 @@
 % \iffalse
 %<package>\NeedsTeXFormat{LaTeX2e}[1997/12/01]
 %<package>\ProvidesPackage{poemscol}
-%<package>   [2015/6/18 v2.72 poemscol file] 
+%<package>   [2017/8/25 v2.8 poemscol file] 
 %
 %<*driver>
 \documentclass{ltxdoc}
@@ -33,7 +33,7 @@
 %</driver>
 % \fi
 %
-% \CheckSum{7758}
+% \CheckSum{7768}
 %
 % \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
@@ -207,7 +207,10 @@
 % \changes{v2.7}{2015/6/18}{Improvements to parallel texts.}
 % \changes{v2.72}{2015/6/25}{Improvements to parallel texts. Generic note types for parallel texts.
 % corrections to manual.}
-%
+% \changes{v2.8}{2017/8/25}{Changes in default values about where line numbers 
+% are placed. verselinenumberstoleft are related command no longer change 
+% marginparsep. Endnote sections may have normal or hanging paragraphs. 
+% Endnotes may have multiple paragraphs.}
 % \DoNotIndex{\newcommand,\newenvironment,\def,\edef,\else,\renewcommand,\makeatletter,\makeatother}
 % \DoNotIndex{\abovedisplayskip,\belowdisplayskip,\abovedisplayshortskip,\belowdisplayshortskip}
 % \DoNotIndex{\newcommand, \section, \subsection, \subsubsection,
@@ -240,15 +243,15 @@
 % \textsc, \unskip} 
 % \setcounter{IndexColumns}{2} 
 % \MakeShortVerb{|}
-% \def\fileversion{2.72} 
-% \def\filedate{29 June 2015} 
-% \def\docdate{29 June 2015}
+% \def\fileversion{2.8} 
+% \def\filedate{25 August 2017} 
+% \def\docdate{25 August 2017}
 %  \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{29 June 2015} 
+% \date{25 August 2017} 
 % \maketitle
 % \begin{abstract} \textsf{poemscol} provides macros for \LaTeX\ for
 % setting collections of poetry.  It is especially suited for setting
@@ -705,8 +708,13 @@
 % 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.
+% is 0pt, and the default value for the width of the box in which 
+% the line numbers are set, |\marginparwidth|, is 0 pt. These values line the 
+% verse line numbers up with the page numbers. If you move the verse line 
+% numbers by changing |\marginparsep|, you can move the page numbers to keep 
+% them aligned by changing |\headoffsetlength|. If you set |\marginparsep| to 
+% 18pts (the default value up to version 2.72 of \textsf{poemscol}), set 
+% |\headoffsetlength| to 28pts.
 % 
 % 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
@@ -1178,6 +1186,9 @@
 % 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.)
+%
+% By default, there is one paragraph per poem, with a hanging indent to give 
+% prominence to the page number.
 % 
 % \begin{sloppypar}
 % \DescribeMacro{\iftextnotessinglepar} 
@@ -1189,9 +1200,30 @@
 % with the other notes to that poem. To do this, you need to set 
 % the relevant boolean. Issue |\textnotessinglepartrue| 
 % |\emendationssingplepartrue| or |\explanationssinglepartrue| to givve
-% each such note a separate paragraph.
+% each such note a separate paragraph. By default, these notes will have a 
+% hanging indent, to give prominence to the line number
 % \end{sloppypar}
 %
+% You may have notes with multiple paragraphs.  The default settings for all of
+% the forms of endnotes are set with hanging indentation, which probably is not
+% a good idea for multiple paragraph notes.  There are two ways of approaching
+% this problem.  The first way is to change all of the paragraphs of the notes to
+% normal indentation, which you can do by issuing
+% |\literaltextnote{\setlength{\parindent}{\noteindentation}}| (you can pick the indentation)
+% just after issuing |\maketextnotes.| You should remember to issue similar 
+% commands for emendations, explanatory notes, and whatever kinds of notes you 
+% create using |\definenewnotetype|. By default, |\noteparbreak| indents the new paragraph 
+% 1em. You can change this by changing the value of the length 
+% |\noteindentation|.
+%
+% \DescribeMacro{\noteparbreak} 
+% Alternatively, if you want to keep the hanging indent for the page number, but still have paragraph 
+% breaks in the note, issue |\noteparbreak| whenever you want a paragraph break 
+% in the midst of a note. By default, |\noteparbreak| indents the new paragraph 
+% 1em. You can change this by changing the value of the length 
+% |\noteindentation|.
+%
+%
 % \DescribeMacro{\iftextnotestwocol} 
 % \DescribeMacro{\ifemendationstwocol}
 % \DescribeMacro{\ifexplanationstwocol}
@@ -1861,7 +1893,8 @@
 % 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|.) 
-
+%
+%\DescribeMacro{\set@p@emtitle}
 % |\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|
@@ -1873,7 +1906,8 @@
 % |\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.  
-
+%
+%\DescribeMacro{\c@ntentsinfo}
 %|\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
@@ -1881,10 +1915,11 @@
 % should be set (such as |\contentspoemtitlefont|) and (4) the amount 
 % overrun lines in the table of contents should be indented (such as 
 % |\contentsindenttwoamount|). 
-
+%
+% \DescribeMacro{\t@xtnotesinfo}
 %  |\t@xtnotesinfo|
 % takes one argument, the title. 
-
+%
 %  So, for example, to create a new kind of title called |\mytitle| which looks
 % just like |\poemtitle|, issue
 % \begin{verbatim}
@@ -2348,15 +2383,16 @@
 % 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
+% |\verselinenumberstoright|, and |\verselinenumbersswitch| each 
+% set |\marginparsep| to zero.  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.
+% |\verselinenumberstoleft| or whatever else you intend to use. Adjust 
+% |\headoffsetlength| to make the page numbers line up with the line numbers.
 %
 % \DescribeMacro{\pmsentence} Each sentence must begin with
 % |\pmsentence|.  |\pmsentence| increments the sentence counter,
@@ -3678,8 +3714,8 @@
 % numbers is on the right should be the negative of the value if it is
 % on the left.  First, some lengths and ifs:
 %    \begin{macrocode}
- \setlength{\marginparsep}{18pt}
- \setlength{\marginparwidth}{10pt}
+ \setlength{\marginparsep}{0pt}
+ \setlength{\marginparwidth}{0pt}
 \newif\ifnumbersswitch \numbersswitchfalse
 \newif\ifnumbersright \numbersrighttrue
 %    \end{macrocode}
@@ -3865,12 +3901,12 @@
 %    \begin{macro}{\verselinenumberstoright}
 %    \begin{macrocode}
 \newcommand{\verselinenumberstoleft}{%
-   \setlength{\marginparsep}{18pt}%
-   \setlength{\marginparwidth}{10pt}%
+%    \setlength{\marginparsep}{18pt}%
+%    \setlength{\marginparwidth}{10pt}%
    \numbersswitchfalse\numbersrightfalse}
 \newcommand{\verselinenumberstoright}{%
-   \setlength{\marginparsep}{18pt}%
-   \setlength{\marginparwidth}{10pt}%
+%    \setlength{\marginparsep}{18pt}%
+%    \setlength{\marginparwidth}{10pt}%
    \numbersswitchfalse\numbersrighttrue}
 %    \end{macrocode}
 %    \end{macro}
@@ -3881,8 +3917,8 @@
 %    \begin{macrocode}
 \newcommand{\verselinenumbersswitch}{%
    \strictpagechecktrue%
-   \setlength{\marginparsep}{18pt}%
-   \setlength{\marginparwidth}{10pt}%
+%    \setlength{\marginparsep}{18pt}%
+%    \setlength{\marginparwidth}{10pt}%
    \numbersswitchtrue\numbersrightfalse\pmclsideparswitchtrue}
 \newif\ifnumbersgutter \numbersgutterfalse%
 \newcommand{\verselinenumbersgutter}{\verselinenumbersswitch%
@@ -4233,11 +4269,16 @@
 % default styles for contents entries for endnotes sections
 \newcommand{\contentsendnotesindent}{\contentsindentone}
 \newcommand{\contentsendnotesfont}{\contentspoemtitlefont}
-% simpler command to set up contents entry with only tw parameters, 
+% simpler command to set up contents entry with only two parameters, 
 % the title and the label for page references
 \newcommand{\contentsendnotestitle}[2]{%
 \contentsendnotesdefaults{#1}{\contentsendnotesindent}{\contentsendnotesfont}{#2}%
 }
+% command for paragraph breaks within notes
+\newlength{\noteindentation}
+\setlength{\noteindentation}{1em}
+\newcommand{\noteparbreak}{\\ 
+\hspace*{\noteindentation}}
 % tokens to use to change the names of the sections
 \newtoks{\pmclnotesname}
 \pmclnotesname={TEXTUAL NOTES}