summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/proofread/proofread.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/proofread/proofread.dtx')
-rw-r--r--Master/texmf-dist/source/latex/proofread/proofread.dtx293
1 files changed, 213 insertions, 80 deletions
diff --git a/Master/texmf-dist/source/latex/proofread/proofread.dtx b/Master/texmf-dist/source/latex/proofread/proofread.dtx
index 2ba8eb2f34c..64130fa45ca 100644
--- a/Master/texmf-dist/source/latex/proofread/proofread.dtx
+++ b/Master/texmf-dist/source/latex/proofread/proofread.dtx
@@ -17,11 +17,10 @@ The proofread package defines a few LaTeX commands that are useful
when you proofread a latex document. These allow you to easily highlight
text and add comments in the margin. Vim escape sequences are provided
for inserting these LaTeX commands in the source. The package is based
-on code for a text highlighting command that was published by Antal S-Z
-in http://tex.stackexchange.com/questions/5959.
-The main file, proofread.dtx, is self-extracting, so you can generate the
-style file by compiling proofread.dtx with pdflatex.
-
+on code for a text highlighting command that was published by Antal
+Spector-Zabusky in http://tex.stackexchange.com/questions/5959. The main file,
+proofread.dtx, is self-extracting, so you can generate the style file by
+compiling proofread.dtx with pdflatex.
%</readme>
%<*internal>
\fi
@@ -45,7 +44,7 @@ proofread:| Commands for inserting annotations
\endpreamble
\postamble
-Copyright (C) 2015 by Wybo Dekker <wybo@dekkerdocumenten.nl>
+Copyright (C) 2017 by Wybo Dekker <wybo@dekkerdocumenten.nl>
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License (LPPL), either
@@ -96,7 +95,7 @@ Running "make install" installs the files in the local TeX tree.
%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<package>\ProvidesPackage{proofread}
%<*package>
- [2015/12/07 v1.01 Commands for inserting annotations]
+ [2017/02/28 v1.02 Commands for inserting annotations]
%</package>
%<*driver>
\documentclass{ltxdoc}
@@ -117,13 +116,15 @@ Running "make install" installs the files in the local TeX tree.
% \fi
%
% \GetFileInfo{\jobname.dtx}
-% \DoNotIndex{\newcommand, \DeclareRobustCommand, \RequirePackage, \add,
-% \advance, \begin, \bgroup, \coordinate, \def, \del, \discretionary,
-% \egroup, \end, \endinput, \endpgfextra, \fi, \fill, \footnotesize,
-% \global, \hbox, \hilite, \ifdef, \ifdim, \marginpar, \marginparmargin,
-% \marginparpush, \mbox, \newbox, \newcount, \newdimen, \p, \path,
-% \pgfextra, \rep, \sbox, \st, \the, \tikz, \tikzset, \usebox,
-% \usetikzlibrary, \y, \yel
+% \DoNotIndex{\AtBeginDocument, \DeclareOption, \DeclareRobustCommand,
+% \DoubleSpacing, \OnehalfSpacing, \PackageError, \ProcessOptions,
+% \RequirePackage, \advance, \baselineskip, \begin, \bgroup, \coordinate, \def,
+% \discretionary, \egroup, \else, \end, \endinput, \endpgfextra, \fi, \fill,
+% \footnotesize, \global, \hbox, \hilite, \ifdef, \ifdim, \ifx, \let, \marginpar,
+% \marginparmargin, \marginparpush, \mbox, \newbox, \newcommand, \newcount,
+% \newdimen, \newif, \p, \path, \pgfextra, \raggedright, \renewcommand, \sbox,
+% \setSpacing, \setstretch, \st, \the, \tikz, \tikzset, \undefined, \usebox,
+% \usetikzlibrary,\y,
% }
%
%\title{\textsf{proofread} --- Commands for inserting annotations\thanks{This file
@@ -136,82 +137,92 @@ Running "make install" installs the files in the local TeX tree.
%
%\changes{v1.00}{2015/09/06}{First public release}
%\changes{v1.01}{2015/12/07}{running counter was sometimes not advanced}
+%\changes{v1.02}{2017/02/28}{- Now works in tables, footnotes, minipages and more\\
+% - package options frame, corrected, uncorrected added\\
+% - package options doublespacing, onehalfspacing added\\
+% - skp command for manual moving down marginnotes\\
+% - vim commands are provided for removing notes,\\
+% either honoring or undoing the correction.
+% }
%
% \begin{abstract}\noindent
-% The |proofread| package defines a few \LaTeX\ commands that are useful
-% when you proofread a latex document. These allow you to easily highlight
-% text and add comments in the margin. Vim escape sequences are provided
-% for inserting these \LaTeX\ commands in the source. The package is based
-% on code for a text highlighting command that was published by Antal S-Z
-% in \href{http://tex.stackexchange.com/questions/5959}{StackExchange}.
+% The |proofread| package defines a few \LaTeX\ commands that are useful when
+% you proofread a latex document. These allow you to easily highlight text and
+% add comments in the margin. Vim escape sequences are provided for inserting or
+% removing these \LaTeX\ commands in the source. The package is based on code
+% for a text highlighting command that was published by Antal Spector-Zabusky in
+% \href{http://tex.stackexchange.com/questions/5959}{StackExchange}.
+%
+% Options are provided for displaying the document with extra line spacing,
+% and for display of it in either uncorrected or corrected state, both
+% without margin notes.
% \end{abstract}
%
% \section{Usage}
% The commands described below display a highlighted phrase in your
% compiled document and place a comment in the margin, prefixed with a
-% counter, which is indicated with \textit{n} in the following. This
+% counter, which is indicated with |n| in the following. This
% counter is useful in the communication with the author of the document.
%
-% \DescribeMacro{\del}
-% |\del{phrase}| displays \del{phrase} and places \textit{n}:Delete in the
-% margin. In the |vim| editor, you can generate this code by selecting the
-% phrase and typing |<escape>d| if you add the following line to your
-% |.vimrc| file:\footnote{If you made sequences or commands for your own
-% editor, please inform the author; he will include those in this
-% document.}
+% Previous versions of this package used the standard \LaTeX\ |\marginpar| to
+% create notes in the margin. However, although these will not overwrite each
+% other, they can not be used in tables, minipages, footnotes and more.
+% Therefore, this version creates margin notes using the |marginnote| package,
+% in order to make them work in tables, minipages, footnotes and more. This
+% implies that margin notes are placed at the vertical position where they are
+% called, instead of being automatically stacked. So if several notes are
+% generated on the same line, they overwrite each other. You can prevent this by
+% \DescribeMacro{skp}
+% prefixing the second note on the line with |\skp| or |\skp[1]|, the third note
+% with |\skp[2]| and so on. Multiline notes may need larger numbers.
%
-% |map <Esc>d s\del{}<Esc>hp|
+% The following supposes that you have installed vim-facilities as
+% described in section~\ref{inst} (``Installing the Vim commands'').
%
-% After typing this escape sequence, you will be in normal mode, behind the
-% closing brace.
-%
+% \DescribeMacro{\del}
+% |\del{phrase}| displays \del{phrase} and places |n: delete| in the
+% margin. In the |vim| editor, you can generate this code by selecting the
+% \DescribeMacro{esc d}
+% phrase and typing |<escape>d|. After typing this escape sequence, you
+% will be in normal mode, behind the closing brace.
% \DescribeMacro{\yel}
% |\yel[comment]{phrase}| displays \yel{phrase} and places
-% \textit{n}:comment in the margin. In the |vim| editor, you can generate
-% this code by selecting the phrase and typing |<escape>y| if you add the
-% following line to your |.vimrc| file:
-%
-% |map <Esc>y s\yel[]{}<Esc>PF[li|
-%
+% |n: comment| in the margin. In the |vim| editor, you can generate
+% \DescribeMacro{esc y}
+% this code by selecting the phrase and typing |<escape>y|.
% After typing this escape sequence, you will be in insert mode between the
% square bracket pair, ready to insert the \textit{comment}.
%
% \DescribeMacro{\add}
-% |\add{phrase}| displays \add{phrase} and places \textit{n}:Add in the
-% margin. In the |vim| editor, you can generate this code by typing
-% |<escape>a| if you add the following line to your |.vimrc| file:
-%
-% |map <Esc>a a\add{}<Esc>i|
-%
-% After typing this escape sequence, you will be in insert mode between the
-% braces pair, ready to type what should be added.
+% |\add{phrase}| displays \add{phrase} and places |n: add| in the
+% margin. In the |vim| editor, you can generate this code \emph{after} the
+% \DescribeMacro{esc a}
+% current cursor position by typing |<escape>a|, or \emph{before} the cursor
+% \DescribeMacro{esc i}
+% position with |<escape>i|. After typing these escape sequences, you will
+% be in insert mode between the braces pair, ready to type what should be
+% added.
%
% \DescribeMacro{\rep}
% |\rep{phrase}{replacement}| displays \rep{phrase}{replacement} and places
-% \textit{n}:was:phrase in the margin. In the |vim| editor, you can
-% generate this code by selecting the phrase and typing |<escape>r| if you
-% add the following line to your |.vimrc| file:
-%
-% |map <Esc>r s\rep{}{}<Esc>2F{plla|
-%
-% After typing this escape sequence, you will be in normal mode between
-% the second pair of braces, ready to edit the new content.
+% |n: was: phrase| in the margin. In the |vim| editor, you can
+% \DescribeMacro{esc r}
+% generate this code by selecting the phrase and typing |<escape>r|.
+% After typing this escape sequence, you will be in insert mode between
+% the second pair of braces, ready to insert the new content.
%
% \DescribeMacro{\com}
% |\com{comment}| is used by |\del|, |\yel|, |\add|, and |\rep| to place
-% \textit{n}:comment in the margin. You can use it to place comment in the
+% |n: comment| in the margin. You can use it to place comment in the
% margin without text highlighting. In the |vim| editor, you can insert the
-% command by typing |<escape>c| if you add the following line to your
-% |.vimrc| file:
-%
-% |map <Esc>c a\com{}<Esc>i|
-%
+% \DescribeMacro{esc c}
+% command by typing |<escape>c|.
% After typing this escape sequence, you will be in insert mode between the
% braces pair, ready to type your comment.
%
% \DescribeMacro{\hilite}
% |\hilite[options]{phrase}| is the command on which the above commands are
-% based. It was published by Antal S-Z in
+% based. It was published by Antal Spector-Zabusky in
% \href{http://tex.stackexchange.com/questions/5959}{StackExchange}.
% It highlights the phrase with the default colour, yellow, using the
% default fill opacity, 0.25; but using the options, you can change this.
@@ -226,8 +237,68 @@ Running "make install" installs the files in the local TeX tree.
% each individually with the |fill opacity| and |draw opacity| options.
% See the documentation of the tikz package for more options.
%
+% \section{Installing the Vim commands}\label{inst}
+% The |proofread| distribution comes with a Vimball archive named
+% |proofread.vmb|. Edit that file in vim and run the command: |:so %|. This will
+% install the necessary files in your |~/.vim| directory, plus the Ruby executable
+% |proofread| in your |~/bin| directory. The latter should be in your |PATH| of
+% course, and you'll have to set its executable flag (|chmod +x ~/bin/proofread|).
+% Finally, in order to use these facilities, you'll have to add this line
+% at the end of your Latex source: |% vim: syntax=proofread|.
+%
+% The majority of the escape commands that are installed by this
+% procedure have been described above. However, there are two others:
+% \DescribeMacro{esc u}
+% The vim sequence |<escape>u| will \emph{undo} the nearest of the three
+% letter commands (|\del, \add, \yel, \rep, \com|) described above, which
+% starts \emph{before} the current cursor position (which may be even on
+% the first character after the starting |\|). So if it sees
+% |\del{something}| it will replace that with |something|, and if it sees
+% |\add{something}| it will remove that.
+%
+% \DescribeMacro{esc h}
+% The counterpart is the |<escape>h| sequence, which will \emph{honor} the
+% first command found before the cursor. If it sees |\del{something}| it will
+% remove it, and if it sees |\add{something}| it will replace it with
+% |something|.
+% The following table illustrates what happens with these two escape
+% sequences:
+%
+% \begin{tabular}{@{}lll@{}}
+% &after |<escape>u|&after |<escape>h| \\
+% |\del{something}| & something & \\
+% |\add{something}| & &something \\
+% |\yel{something}| &something &something \\
+% |\yel[remark]{something}| &something &something \\
+% |\com{something}| & & \\
+% |\rep{old}{new}| &old &new \\
+% \end{tabular}
+%
+% As you see, both sequences simply undo |\yel| and |\com| commands, because
+% they are comments, not corrections.
+%
+% \section{Package options}
+% Options are provided, displaying the document in various spacing and
+% correction modes.
+% \DescribeMacro{onehalfspacing}
+% The |onehalfspacing| option displays the document with 1.5 times the
+% normal line spacing,
+% \DescribeMacro{doublespacing}
+% The |doublespacing| option displays the document with doubled
+% line spacing.
+% \DescribeMacro{uncorrected}
+% The |uncorrected| displays the document in its uncorrected state, without
+% notes in the margin.
+% \DescribeMacro{corrected}
+% The |corrected| displays the document in its corrected state, without
+% notes in the margin.
+% \DescribeMacro{frame}
+% Finally, the |frame| option is provided for visually handicapped users;
+% it causes .5pt black borders to be drawn around the colored backgrounds
+% around \hilite[draw=black,line width=.5pt]{marked} texts.
%\StopEventually{^^A
% \PrintChanges
+% \clearpage
% \PrintIndex
%}
%
@@ -236,19 +307,53 @@ Running "make install" installs the files in the local TeX tree.
% \begin{macrocode}
%<*package>
% \end{macrocode}
-
+% Option handling:
+% For the |onehalfspacing| and |doublespacing| options we need the setspace
+% package, but the memoir class has its own version for this. So if
+% |\DoubleSpacing| is defined, we redefined the other commands needed.
+% The |PR@spaced| remembers if margin notes need a shift up.
+% \begin{macrocode}
+\RequirePackage{marginnote}
+\ifx\undefined\DoubleSpacing
+ \RequirePackage{setspace}
+\else
+ \let\setstretch\setSpacing
+ \let\onehalfspacing\OnehalfSpacing
+ \let\doublespacing\DoubleSpacing
+\fi
+\newif\ifPR@spaced\PR@spacedfalse
+\newdimen\PR@unit\PR@unit.6\baselineskip
+\DeclareOption{onehalfspacing}{\onehalfspacing\PR@spacedtrue\PR@unit.525\baselineskip}
+\DeclareOption{doublespacing}{\doublespacing\PR@spacedtrue\PR@unit.35\baselineskip}
+% \end{macrocode}
+% The default is to show corrections; the |corrected| and |uncorrected|
+% options will show the document without those in either corrected of
+% uncorrected state.
+% \begin{macrocode}
+\newif\ifPR@corrected\PR@correctedfalse
+\newif\ifPR@uncorrected\PR@uncorrectedfalse
+\DeclareOption{corrected}{\PR@correctedtrue}
+\DeclareOption{uncorrected}{\PR@uncorrectedtrue}
+% \end{macrocode}
+% The frame option draws a black 0.5pt frame around colored areas for
+% the visually disabled.
+% \begin{macrocode}
+\newif\ifPR@frame\PR@framefalse
+\newdimen\PR@lw\PR@lw=0pt
+\DeclareOption{frame}{\PR@lw=.5pt\PR@frametrue}
+\ProcessOptions
+% \end{macrocode}
% The following code for a text highlighting command (here renamed to
-% |\hilite| was published by Antal S-Z in
+% |\hilite| was published by Antal Spector-Zabusky in
% \href{http://tex.stackexchange.com/questions/5959}{StackExchange}.
% \begin{macrocode}
\RequirePackage{soul}
\RequirePackage{tikz}
-\RequirePackage{etoolbox}
\usetikzlibrary{calc}
\usetikzlibrary{decorations.pathmorphing}
\newcommand{\PR@defhiliter}[3][]{%
- \tikzset{every hiliter/.style={color=#2, fill opacity=#3, #1}}%
+ \tikzset{every hiliter/.style={fill=#2,fill opacity=#3, #1}}%
}
\PR@defhiliter{yellow}{.25}
@@ -275,7 +380,11 @@ Running "make install" installs the files in the local TeX tree.
% \begin{macro}{\hilite}
% \begin{macrocode}
\DeclareRobustCommand*\hilite[1][]{%
- \tikzset{this hiliter/.style={#1}}%
+ \ifPR@frame%
+ \tikzset{this hiliter/.style={#1,draw=black,line width=\PR@lw}}%
+ \else%
+ \tikzset{this hiliter/.style={#1}}%
+ \fi
\SOUL@setup
%
\def\SOUL@preamble{%
@@ -335,8 +444,8 @@ Running "make install" installs the files in the local TeX tree.
% Reduce minimum vertical space between margin paragraphs; if the memoir
% class is active, use the outer margin:
% \begin{macrocode}
-\AtEndPreamble{\marginparpush2pt}
-\ifdef{\marginparmargin}{\marginparmargin{outer}}{}
+\AtBeginDocument{\marginparpush2pt}
+\ifx\undefined\marginparmargin\else\marginparmargin{outer}\fi
% \end{macrocode}
% We need a save box and a counter for prefixing the margin paragraphs:
% \begin{macrocode}
@@ -344,34 +453,43 @@ Running "make install" installs the files in the local TeX tree.
\newcount\PR@markerno\PR@markerno=1
% \end{macrocode}
% \begin{macro}{\com}
-% Make a margin paragraph, in footnote fontsize, prefixed with the counter
+% Make a raggedright margin note, in footnote fontsize, prefixed with the counter
% plus a colon:
% \begin{macrocode}
\newcommand{\com}[1]{%
- \marginpar{%
+ \marginnote{%
+ \setstretch{1}%
+ \raggedright%
\footnotesize%
- \the\PR@markerno:#1%
- }%
+ \the\PR@markerno: #1%
+ }[\PR@skip]%
+ \global\PR@skip0pt
\global\advance\PR@markerno1%
}
% \end{macrocode}
% \end{macro}
+% \begin{macro}{\skp}
+% \begin{macrocode}
+\newdimen\PR@skip\PR@skip0\PR@unit
+\newcommand{\skp}[1][1]{%
+ \PR@skip#1\PR@unit%
+}
+% \end{macrocode}
+% \end{macro}
% \begin{macro}{\del}
% \begin{macrocode}
\newcommand{\del}[1]{%
\com{delete}%
\sbox\PR@soulbox{\st{#1}}%
\hilite[red]{{\usebox\PR@soulbox}}%
- \bgroup\egroup%
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{\yel}
% \begin{macrocode}
-\newcommand{\yel}[2][\mbox{}]{%
+\newcommand{\yel}[2][]{%
\com{#1}%
- \hilite[yellow]{#2}%
- \bgroup\egroup%
+ \hilite{#2}%
}
% \end{macrocode}
% \end{macro}
@@ -379,18 +497,33 @@ Running "make install" installs the files in the local TeX tree.
% \begin{macrocode}
\newcommand{\add}[1]{%
\com{add}%
- \hilite[green,draw=blue]{#1}%
- \bgroup\egroup%
+ \hilite[green]{#1}%
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{\rep}
% \begin{macrocode}
\newcommand{\rep}[2]{%
- \com{was:#1}%
+ \com{was: #1}%
\hilite[blue]{#2}%
- \bgroup\egroup%
}
+% \end{macrocode}
+% If one of the |corrected| or |uncorrected| options is used, redefine the
+% above commands accordingly:
+% \begin{macrocode}
+\ifPR@uncorrected
+ \ifPR@corrected
+ \PackageError{proofread}{You may not use both the corrected and uncorrected options}
+ \fi
+ \def\com#1{} \def\add#1{} \def\del#1{#1} \def\rep#1#2{#1}
+ \renewcommand{\yel}[2][]{#2}\renewcommand{\hilite}[2][]{#2}
+\else
+ \ifPR@corrected
+ \def\com#1{} \def\add#1{#1} \def\del#1{} \def\rep#1#2{#2}
+ \renewcommand{\yel}[2][]{#2}\renewcommand{\hilite}[2][]{#2}
+ \fi
+\fi
+
\endinput
%</package>
% \end{macrocode}