poemscol (21aug19)

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

4 files changed, 110 insertions, 47 deletions

diff --git a/Master/texmf-dist/doc/latex/poemscol/poemscol.pdf b/Master/texmf-dist/doc/latex/poemscol/poemscol.pdf
index 5a6ae5787e1..1342e632a7a 100644
--- a/Master/texmf-dist/doc/latex/poemscol/poemscol.pdf
+++ b/Master/texmf-dist/doc/latex/poemscol/poemscol.pdf
diff --git a/Master/texmf-dist/source/latex/poemscol/poemscol.dtx b/Master/texmf-dist/source/latex/poemscol/poemscol.dtx
index 5dab41358be..3119270c03e 100644
--- a/Master/texmf-dist/source/latex/poemscol/poemscol.dtx
+++ b/Master/texmf-dist/source/latex/poemscol/poemscol.dtx
@@ -11,13 +11,19 @@
 %
 %    http://www.latex-project.org/lppl.txt
 %
+% This work has the LPPL maintenance status `maintained'.
+% 
+% The Current Maintainer of this work is John Burt.
+%
+% This work consists of the files poemscol.dtx and poemscol.ins
+% and the derived file poemscol.sty.
 %
 % \fi
 %
 % \iffalse
 %<package>\NeedsTeXFormat{LaTeX2e}[1997/12/01]
 %<package>\ProvidesPackage{poemscol}
-%<package>   [2019/08/03 v3 poemscol file] 
+%<package>   [2019/08/18 v3.02 poemscol file] 
 %
 %<*driver>
 \documentclass{ltxdoc}
@@ -31,7 +37,7 @@
 %</driver>
 % \fi
 %
-% \CheckSum{8569}
+% \CheckSum{8587}
 %
 % \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
@@ -234,6 +240,8 @@
 % \changes{v2.99}{2019/08/02}{Hierarchy of indented stanzas}
 % \changes{v3}{2019/08/03}{With centered verse you can align the title, epigraphs,
 % attibutions, and so on with the left margin of the verse block.}
+% \changes{v3.01}{2019/08/04}{Corrections to manual}
+% \changes{v3.02}{2019/08/18}{Corrections to manual. Hierarchy of indented lines. Minor bug fix.}
 % \DoNotIndex{\newcommand,\newenvironment,\def,\edef,\else,\renewcommand,\makeatletter,\makeatother}
 % \DoNotIndex{\abovedisplayskip,\belowdisplayskip,\abovedisplayshortskip,\belowdisplayshortskip}
 % \DoNotIndex{\newcommand, \section, \subsection, \subsubsection,
@@ -266,15 +274,15 @@
 % \textsc, \unskip} 
 % \setcounter{IndexColumns}{2} 
 % \MakeShortVerb{|}
-% \def\fileversion{3} 
-% \def\filedate{3 August 2019} 
-% \def\docdate{3 August 2019}
+% \def\fileversion{3.02} 
+% \def\filedate{18 August 2019} 
+% \def\docdate{18 August 2019}
 %  \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{3 August 2019} 
+% \date{18 August 2019} 
 % \maketitle
 % \begin{abstract} \textsf{poemscol} provides commands for \LaTeX\ for
 % setting collections of poetry.  It is especially suited for setting
@@ -656,8 +664,12 @@
 %
 % \subsubsection{Customization of titles}
 % \DescribeMacro{\centertitles} By default, titles place at or near (depending on the kind
-% of title) the left margin. To center all titles, issue |\centertitles|. If you have multi-line
-% titles, |\centertitles| will center each line. |\centertitles| also moves in epigraphs, headnotes,
+% of title) the left margin. To center all titles, issue |\centertitles|. (Centering titles might be 
+% especially useful if you are setting poems so that the longest line 
+% of the verse block is centered on the page. For instructions about 
+% how to center the verse block in this way, see section \ref{centeringtextblock} 
+% on page \pageref{centeringtextblock}.) If you have multi-line
+% titles, |\centertitles| will center each line.  |\centertitles| also moves in epigraphs, headnotes,
 % attributions, and dedications towards the center. Since an epigraph or a headnote may be 
 % a prose paragraph, or a passage of verse, it would be unwise to set them in a centering
 % environment, so |\centertitles| just moves them towards the center. To adjust the placement
@@ -666,24 +678,26 @@
 %\begin{sloppypar}
 % \DescribeMacro{\leftaligntitles} Rather than centering the title over 
 % a centered block of verse, one might prefer to align the title with 
-% the left margin of the verse block. To do this, issue 
-% |\leftaligntitlestrue| to set the boolean |\ifleftaligntitles|. 
+% the left margin of the centered verse block. To do this, issue 
+% |\leftaligntitlestrue| to set the boolean |\ifleftaligntitles|. The length |\versewidth|
+% is used both to center the verse block and to place the title at the verse block's left margin.
+% You will need to use |\settowidth| to set the length of |\versewidth| before
+% issuing |\poemtitle| or the other title-making commands (such as |\sequencesectiontitle|).  
+% Issue |\settowidth{\versewidth}{Text to be used for centering}| just 
+% before you issue the |\poemtitle| or |\epigraph| command.  For how to use |\settowidth| to center the
+% verse block or to align titles, epigraphs, and so forth with the left margin of the
+% verse block, see section \ref{centeringtextblock}, page \pageref{centeringtextblock}.
 %
-% % \DescribeMacro{\leftalignepigraphs}You 
+% \DescribeMacro{\leftalignepigraphs} You 
 % may also wish to align epigraphs, dedications, attributions, or 
 % headnotes with the left margin of the verse block (even if you 
 % center the titles). To do this, issue |\leftalignepigraphstrue| to 
-% set the boolean |\ifleftalignepigraphs|. Remember that for this to 
-% work, you will need to use the |\settowidth| command. Issue 
-% |\settowidth{\versewidth}{Text to be used for centering.}| just 
-% before you issue the |\poemtitle| or |\epigraph| command. 
+% set the boolean |\ifleftalignepigraphs|.
 % |\leftalignepigraphstrue| will also align attributions, 
 % dedications, and other pre-texts of poems. (It will not affect the 
 % dedications and attributions on volume title pages, which are set 
 % using the |\volumededication|, |\volumeepigraph|, and 
-% |\volumeattribution| commands.) For how to use |\settowidth| to center the
-% verse block or to align titles, epigraphs, and so forth with the left margin of the
-% verse block, see section \ref{centeringtextblock}, page \pageref{centeringtextblock}. 
+% |\volumeattribution| commands.) 
 % \end{sloppypar}
 %
 % \begin{sloppypar}
@@ -794,8 +808,8 @@
 % short lines, and you wish to center it on the page, rather than set 
 % it against the left margin of the normal |poem| environment, you can 
 % give the width of the line you want to use to center the poem as the optional
-% argument.  To center a verse block 20 ems wide, for instance, issue
-% |\begin{poem}[20em]|. 
+% argument.  To center a verse block 30 ems wide, for instance, issue
+% |\begin{poem}[30em]|. 
 %
 % \label{centeringtextblock}
 % Rather than specifying the length explicitly, you can use the length
@@ -807,7 +821,14 @@
 % to center the poem on a sample line, you use it to center the |poem| environment this way:
 % \begin{center} |\begin{poem}[\versewidth]|.\end{center}
 % Notice that the optional argument is in square braces,
-% not in curly braces.
+% not in curly braces. 
+%
+% If you are planning to align the poem title with the
+% left margin of the centered verse block you should use the |\versewidth| method
+% to center the verse block, since |\versewidth| is used to place the title in that case.
+% (You can just enter a length into the optional argument of |\begin{poem}|, but in that case,
+% if you are left-aligning the poem title, you should set |\versewidth| to that value
+% by issuing e.g. |\setlength{\versewidth}{30em}|.)
 %
 % \DescribeMacro{\linenumberscenteredwithverse} 
 % If you want to center the verse on the page using the optional argument to |\begin{poem}|, 
@@ -898,6 +919,12 @@
 % structure of the poem (and the editor's intentions about it) clear
 % to readers of your source code.  If you want to change the |stanza| environment
 % consult its definition below at page \pageref{stanzadefine}.
+%
+%  \DescribeMacro{indentedverse} To indent stanzas (or stretches of verse) relative to the margin
+% you can use the |indentedverse| environment.
+% You can also
+% set different stanzas or passages at a hierarchy of levels of indentation.
+% (For how to do this, see section \ref{indentedverse} below, page \pageref{indentedverse}.)
 % 
 % \DescribeMacro{\stanzaatbottom}
 % \DescribeMacro{\nostanzaatbottom}
@@ -983,7 +1010,7 @@
 % |\setlength{\pmclsideparvshift}{0ex}|. 
 %
 % \subsection{~Special line markup}
-% \subsubsection{Line breaks, runover, and broken lines}
+% \subsubsection{Indentation, line breaks, runover, and broken lines}
 % \begin{sloppypar}
 % \DescribeMacro{\verseindent} The |\verseindent| command is to be
 % used for formally indented lines. It should not be used to indent 
@@ -996,8 +1023,18 @@
 % Alternatively, you can change the length |\verseindentamount| by 
 % issuing |\setlength{\verseindentamount}{3em}|.\end{sloppypar}\goodbreak
 %
+% You can create a hierarchy of indentations by issuing |\verseindent| 
+% multiple times. But you can also use an optional argument to |\verseindent|, with
+% the number indicating how many levels of indentation to add to this line,  like so
+% |\verseindent[3]| for the third level of indentation, (with each level being one |\verseindent| 
+% deep. If you use this option, don't put any white space between the end of the 
+% |\verseindent| command and the beginning of the poetic text, otherwise
+% poemscol will add about 10pt of unwanted extra white space. (The only real 
+% consequence of forgetting about this will be that |\verseindent[1]| will be about
+% 10pts deeper than plain |\verseindent|, which may not  really be an issue for you.)
+%
 % \begin{sloppypar} 
-% \DescribeMacro{indentedverse} You might want to indent whole stanzas, 
+% \DescribeMacro{indentedverse} \label{indentedverse} You might want to indent whole stanzas, 
 % or perhaps extended passages of verse, relative to the rest of the poem (you might
 % for instance, want to indent refrains systematically). This would be tedious to
 % do using |\verseindent|. Put stretches of 
@@ -1005,12 +1042,18 @@
 % in this environment will be indented. The indentation will be of the length
 % |\indentedstanzaamount|, which is by default set to |\verseindentamount|, 
 % which by default is 2 em. You can change |\indentedstanzaamount|  to 3em, by issuing
-% |\setlength{\indentedstanzaamount}{3em}|. You can set a hierarchy of intended stanzas
+% |\setlength{\indentedstanzaamount}{3em}|. 
+%
+% You can also set a hierarchy of intended stanzas
 % or passages by issuing an optional argument to |\begin{indentedverse}|. So, for instance,
 % |\begin{indentedverse}[2]| will indent that environment by two |\indentedstanzaamount|s
 % (4 em), and |\begin{indentedverse}[3]| will indent that environment by three 
 % |\indentedstanzaamount|s, or 6 em. Note that if you use the optional argument, you
- % must enclose it in square brackets, not curly ones.\end{sloppypar}
+% must enclose it in square brackets, not curly ones. Note also that (for reasons
+% I have not been able to track down) |\indentedverse[1]| indents the stanza
+% slightly more deeply than plain |\indentedverse|. To preserve a
+% consistent look for a hierarchy of indented stanzas, use |\indentedverse[1]| for the 
+% lowest level of indentation, not plain |\indentedverse|. \end{sloppypar}
 %
 % \DescribeMacro{\linebend} \textsf{poemscol} automatically runs over
 % long lines, indenting the run over portion on the next physical
@@ -2220,7 +2263,7 @@
 % dedications, and other pre-texts of poems. (It will not affect the 
 % dedications and attributions on volume title pages, which are set 
 % using the |\volumededication|, |\volumeepigraph|, and 
-% |\volumeattribution| commands.\end{sloppypar}
+% |\volumeattribution| commands.)\end{sloppypar}
 %
 % \subsection{~Appending publication date}
 % \DescribeMacro{\poemdate} You can append the date of the poem
@@ -3953,26 +3996,34 @@
 %    \begin{macrocode}
 \hfuzz=2pt
 %    \end{macrocode}
-%    For explicitly declared indented lines:
+%    For explicitly declared indented lines or ranges of lines:
 %    \begin{macrocode}
 \newlength{\verseindentamount}
 \setlength{\verseindentamount}{2em}
-\newcommand{\verseindent}{\hspace{\verseindentamount}}
+\newcount\l@@pcounter
+\newcommand{\repeatedindent}[1]{\l@@pcounter=#1%
+\loop%
+\ifnum\l@@pcounter>0%
+\hspace{\verseindentamount}%
+\advance \l@@pcounter -1
+\repeat}
+\newcommand{\verseindent}[1][]{%
+\ifthenelse{\equal{#1}{}}{\hspace{\verseindentamount}}{\repeatedindent{#1}}}
+%\newcommand{\verseindent}{\hspace{\verseindentamount}} %old version
 \newlength{\indentedstanzaamount}
 \setlength{\indentedstanzaamount}{\verseindentamount}
 \newlength{\variablestanzaamount}
 \setlength{\variablestanzaamount}{\indentedstanzaamount}
-\newcount\loopcounter
-\newcommand{\adjustst@nzaindent}[1]{\loopcounter=#1
-\loop
- \addtolength{\variablestanzaamount}{\indentedstanzaamount}
-  \advance \loopcounter -1
-\ifnum \loopcounter>0
+\newcommand{\adjustst@nzaindent}[1]{\l@@pcounter=#1%
+\loop%
+ \addtolength{\variablestanzaamount}{\indentedstanzaamount}%
+  \advance \l@@pcounter -1%
+\ifnum \l@@pcounter>0
 \repeat}
 \newif\ifinindentedverse
 \newenvironment{indentedverse}[1][]{%
-\inindentedversetrue
-\ifthenelse{\equal{#1}{}}{\relax}{\adjustst@nzaindent{#1}}
+\inindentedversetrue%
+\ifthenelse{\equal{#1}{}}{\relax}{\adjustst@nzaindent{#1}}%
 \let\\=\@centercr%
 \list{}{\itemsep\z@ \itemindent -\runoverindentvalue\listparindent \itemindent
 \rightmargin 0sp\leftmargin 0sp\advance\leftmargin
diff --git a/Master/texmf-dist/source/latex/poemscol/poemscol.ins b/Master/texmf-dist/source/latex/poemscol/poemscol.ins
index 55a4659e8d3..0f15adb7d2e 100644
--- a/Master/texmf-dist/source/latex/poemscol/poemscol.ins
+++ b/Master/texmf-dist/source/latex/poemscol/poemscol.ins
@@ -9,6 +9,12 @@
 %% http://www.latex-project.org/lppl.txt
 %% 
 %%
+%% This work has the LPPL maintenance status `maintained'.
+%% 
+%% The Current Maintainer of this work is John Burt.
+%%
+%% This work consists of the files poemscol.dtx and poemscol.ins
+%% and the derived file poemscol.sty.
  
 \input docstrip.tex
 \keepsilent
diff --git a/Master/texmf-dist/tex/latex/poemscol/poemscol.sty b/Master/texmf-dist/tex/latex/poemscol/poemscol.sty
index 1a42da65680..15617f71408 100644
--- a/Master/texmf-dist/tex/latex/poemscol/poemscol.sty
+++ b/Master/texmf-dist/tex/latex/poemscol/poemscol.sty
@@ -22,8 +22,7 @@
 %% in the same archive or directory.)
 \NeedsTeXFormat{LaTeX2e}[1997/12/01]
 \ProvidesPackage{poemscol}
-   [2019/08/03 v3 poemscol file]
- % must enclose it in square brackets, not curly ones.\end{sloppypar}
+   [2019/08/18 v3.02 poemscol file]
  %|\prosexyznote|
 
 %%
@@ -92,22 +91,29 @@
 \hfuzz=2pt
 \newlength{\verseindentamount}
 \setlength{\verseindentamount}{2em}
-\newcommand{\verseindent}{\hspace{\verseindentamount}}
+\newcount\l@@pcounter
+\newcommand{\repeatedindent}[1]{\l@@pcounter=#1%
+\loop%
+\ifnum\l@@pcounter>0%
+\hspace{\verseindentamount}%
+\advance \l@@pcounter -1
+\repeat}
+\newcommand{\verseindent}[1][]{%
+\ifthenelse{\equal{#1}{}}{\hspace{\verseindentamount}}{\repeatedindent{#1}}}
 \newlength{\indentedstanzaamount}
 \setlength{\indentedstanzaamount}{\verseindentamount}
 \newlength{\variablestanzaamount}
 \setlength{\variablestanzaamount}{\indentedstanzaamount}
-\newcount\loopcounter
-\newcommand{\adjustst@nzaindent}[1]{\loopcounter=#1
-\loop
- \addtolength{\variablestanzaamount}{\indentedstanzaamount}
-  \advance \loopcounter -1
-\ifnum \loopcounter>0
+\newcommand{\adjustst@nzaindent}[1]{\l@@pcounter=#1%
+\loop%
+ \addtolength{\variablestanzaamount}{\indentedstanzaamount}%
+  \advance \l@@pcounter -1%
+\ifnum \l@@pcounter>0
 \repeat}
 \newif\ifinindentedverse
 \newenvironment{indentedverse}[1][]{%
-\inindentedversetrue
-\ifthenelse{\equal{#1}{}}{\relax}{\adjustst@nzaindent{#1}}
+\inindentedversetrue%
+\ifthenelse{\equal{#1}{}}{\relax}{\adjustst@nzaindent{#1}}%
 \let\\=\@centercr%
 \list{}{\itemsep\z@ \itemindent -\runoverindentvalue\listparindent \itemindent
 \rightmargin 0sp\leftmargin 0sp\advance\leftmargin