texlive[72851] Master/texmf-dist: rebuttal (14nov24)
commits+karl at tug.org
commits+karl at tug.org
Thu Nov 14 21:42:15 CET 2024
Revision: 72851
https://tug.org/svn/texlive?view=revision&revision=72851
Author: karl
Date: 2024-11-14 21:42:15 +0100 (Thu, 14 Nov 2024)
Log Message:
-----------
rebuttal (14nov24)
Modified Paths:
--------------
trunk/Master/texmf-dist/doc/latex/rebuttal/README.md
trunk/Master/texmf-dist/doc/latex/rebuttal/rebuttal.pdf
trunk/Master/texmf-dist/source/latex/rebuttal/rebuttal.dtx
trunk/Master/texmf-dist/source/latex/rebuttal/rebuttal.ins
trunk/Master/texmf-dist/tex/latex/rebuttal/rebuttal.sty
Added Paths:
-----------
trunk/Master/texmf-dist/doc/latex/rebuttal/01-scrlttr2.tex
trunk/Master/texmf-dist/doc/latex/rebuttal/02-article.tex
trunk/Master/texmf-dist/doc/latex/rebuttal/examples/
trunk/Master/texmf-dist/doc/latex/rebuttal/examples/01-scrlttr2.pdf
trunk/Master/texmf-dist/doc/latex/rebuttal/examples/02-article.pdf
trunk/Master/texmf-dist/doc/latex/rebuttal/rebuttal.tex
Removed Paths:
-------------
trunk/Master/texmf-dist/doc/latex/rebuttal/01-example.tex
Deleted: trunk/Master/texmf-dist/doc/latex/rebuttal/01-example.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/rebuttal/01-example.tex 2024-11-14 20:42:02 UTC (rev 72850)
+++ trunk/Master/texmf-dist/doc/latex/rebuttal/01-example.tex 2024-11-14 20:42:15 UTC (rev 72851)
@@ -1,172 +0,0 @@
-%%
-%% This is file `01-example.tex',
-%% generated with the docstrip utility.
-%%
-%% The original source files were:
-%%
-%% rebuttal.dtx (with options: `example1')
-%%
-%% Copyright (C) 2018-2021, 2024 Sergiu Deitsch
-%%
-%% This work may be distributed and/or modified under the
-%% conditions of the LaTeX Project Public License, either version 1.3
-%% 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.3 or later is part of all distributions of LaTeX
-%% version 2005/12/01 or later.
-%%
-%% This work has the LPPL maintenance status `maintained'.
-%%
-%% The Current Maintainer of this work is Sergiu Deitsch.
-%%
-%% This work consists of the files rebuttal.dtx and rebuttal.ins.
-%%
-\documentclass[american,version=last,fromphone,fromemail,svgnames,dvipsnames,x11names]{scrlttr2}
-\usepackage[T1]{fontenc}
-\usepackage[utf8]{inputenc}
-\usepackage[babel]{csquotes}
-\usepackage{babel}
-\usepackage{graphicx}
-\usepackage{microtype}
-\usepackage{lipsum}
-\usepackage{rebuttal}
-\usepackage{varioref}
-\usepackage{hyperref}
-\usepackage{cleveref}
-
-\hypersetup{colorlinks=true}
-
-\setkomavar{fromname}{Jane Smith}
-\setkomavar{fromaddress}{%
- Pattern Recognition Lab\\
- University of Erlangen-Nürnberg
-}
-\setkomavar{backaddress}{}
-\setkomavar{fromphone}{$+49$\,(0)\,12345678}
-\setkomavar{fromemail}{firstname.lastname at fau.de}
-\setkomavar{place}{Erlangen}
-
-\begin{document}
-
-\setkomavar{subject}{Manuscript: Extended Field of View in C-Arm Computed
- Tomography for Weight-Bearing Imaging}
-
-\begin{letter}{Medical Physics}
-
-\opening{Dear Prof. Jones, Dear Prof. Taylor,}
-
-We thank you for considering our submission as a research article for Medical
-Physics. We also thank the reviewers for the thoughtful comments. We have
-carefully revised the document and prepared a point-by-point response to the
-reviewer’s comments.
-
-The major changes to the paper are:
-\begin{itemize}
- \item Clarification of the medical impact
- \item An extension of the evaluation and discussion to 3D Cone Beam CT and
- off-center positioning of the object
- \item Inclusion of more substantive figure captions
-\end{itemize}
-
-Below, you will find the reviewers’ comments in blue, our response in normal
-face and additions to the manuscript in quotes and \enquote{italic face.} Note
-that we omitted footnotes and references in the quotations.
-
-We are looking forward to hearing from you.
-
-\closing{With kind regards,}
-
-\end{letter}
-
-\clearpage\noindent The following pages contain a list of editor's and
-reviewers' comments followed by our replies. The comments are sequentially
-numbered and associated either with the editor or the corresponding reviewer.
-The replies may contain references to changes in the original manuscript which
-are identified by a label consisting of a running number and followed by the
-label of the original comment in parentheses. The label back references the
-original reviewer comment within the manuscript. For instance, the reference
-\textbf{C2~(1.3)}, which is typeset in the manuscript margin, refers to the
-second change stemming from the third comment of the first reviewer.
-
-\begin{rebuttal}[Editor's Comments]
- \begin{comment}
- The topic of this manuscript is of interest. We concur with the summary review
- of the associate editor and the reviews of the referees. The authors should
- thoroughly address all of the comments, below, in a revised manuscript.
- \end{comment}
-
-\end{rebuttal}
-
-\begin{rebuttal}[Specific Comments]
- \begin{comment}
- \label{c:specific}
- You need to include figure captions that make your figures intelligible.
- See~\cref{a:foo} and \cref{c:foo2}.
- \end{comment}
-
- \begin{answer}
- The reviewer is right. We have reworked the figure captions to make the
- figures more independent of the text. Furthermore, check if lists are
- typeset correctly:
- \begin{itemize}
- \item One
- \item Two
- \begin{enumerate}
- \item Three
- \item Four
- \end{enumerate}
- \end{itemize}
- \end{answer}
-
- \begin{comment}
- \label{c:c2}
- Are you going to pay for color in the print article? If not, the lines are
- not intelligible in Figures 2, 5, 11. In addition to color coding for the
- digital version, you could make lines with distinct patterns (dots, dashes,
- etc.) so they are distinct in monochrome presentations.
- \end{comment}
-
- \begin{answer}
- We agree with this point and we are sorry that we missed this in the first
- version of the article. The article will appear as an online only version
- and is part of the special issue associated with this year’s CT Meeting
- conference. Thus there will be no additional cost associated with color
- figures. Nonetheless, we agree that all figures need to be correct in
- grey-scale as some readers might print the article. According to the
- reviewer’s comment, we have adjusted the figures by using different patterns
- and gray levels.
-
- (Refer also to \cref{c:specific} for more information.)
- \end{answer}
-\end{rebuttal}
-
-\lipsum[1] \addition[label=a:foo,ref=c:specific]{\lipsum[2]} \lipsum[3]
-
-\lipsum[4] \deletion[label=a:foo1,ref=c:c2]{An unintended addition.}
-and a \change[label=c:foo2,ref=c:c2]{from}{to} change. And another addition
-\addition[label=a:foo3,ref=c:c2]{here}.
-Also \addition[label=a:foo4,ref=c:c2]{here}.
-Maybe \addition[label=a:foo5,ref=c:c2]{here}.
-Additionally \addition[label=a:foo6,ref=c:c2]{here}.
-Additionally \addition[label=a:foo7,ref=c:c2]{here}.
-
-\begin{additionenv}[label=d:par,ref=c:c2]
- \begin{itemize}
- \item \lipsum[1]
- \end{itemize}
- \lipsum[2]
-\end{additionenv}
-
-Additional notes:
-\begin{itemize}
- \item Multiple source references can be
- \addition[label=a:foo8,ref={c:specific,c:c2}]{specified}.
- \item If the references do not fit into a single line in the margin, you may
- force a \addition[label=a:break,ref={c:specific,c:c2},break]{break}.
-\end{itemize}
-
-\end{document}
-\endinput
-%%
-%% End of file `01-example.tex'.
Added: trunk/Master/texmf-dist/doc/latex/rebuttal/01-scrlttr2.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/rebuttal/01-scrlttr2.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/rebuttal/01-scrlttr2.tex 2024-11-14 20:42:15 UTC (rev 72851)
@@ -0,0 +1,87 @@
+%%
+%% This is file `01-scrlttr2.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% rebuttal.dtx (with options: `example1')
+%%
+%% Copyright (C) 2018-2021, 2024 Sergiu Deitsch
+%%
+%% This work may be distributed and/or modified under the
+%% conditions of the LaTeX Project Public License, either version 1.3
+%% 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.3 or later is part of all distributions of LaTeX
+%% version 2005/12/01 or later.
+%%
+%% This work has the LPPL maintenance status `maintained'.
+%%
+%% The Current Maintainer of this work is Sergiu Deitsch.
+%%
+%% This work consists of the files rebuttal.dtx and rebuttal.ins.
+%%
+\documentclass[american,version=last,fromphone,fromemail,svgnames,dvipsnames,x11names]{scrlttr2}
+\usepackage[T1]{fontenc}
+\usepackage[utf8]{inputenc}
+\usepackage[babel]{csquotes}
+\usepackage{babel}
+\usepackage{graphicx}
+\usepackage{microtype}
+\usepackage{lipsum}
+\usepackage{rebuttal}
+\usepackage{varioref}
+\usepackage{hyperref}
+\usepackage{cleveref}
+
+\hypersetup{colorlinks=true}
+
+\setkomavar{fromname}{Jane Smith}
+\setkomavar{fromaddress}{%
+ Pattern Recognition Lab\\
+ University of Erlangen-Nürnberg
+}
+\setkomavar{backaddress}{}
+\setkomavar{fromphone}{$+49$\,(0)\,12345678}
+\setkomavar{fromemail}{firstname.lastname at fau.de}
+\setkomavar{place}{Erlangen}
+
+\begin{document}
+
+\setkomavar{subject}{Manuscript: Extended Field of View in C-Arm Computed
+ Tomography for Weight-Bearing Imaging}
+
+\begin{letter}{Medical Physics}
+
+\opening{Dear Prof. Jones, Dear Prof. Taylor,}
+
+We thank you for considering our submission as a research article for Medical
+Physics. We also thank the reviewers for the thoughtful comments. We have
+carefully revised the document and prepared a point-by-point response to the
+reviewer’s comments.
+
+The major changes to the paper are:
+\begin{itemize}
+ \item Clarification of the medical impact
+ \item An extension of the evaluation and discussion to 3D Cone Beam CT and
+ off-center positioning of the object
+ \item Inclusion of more substantive figure captions
+\end{itemize}
+
+Below, you will find the reviewers’ comments in blue, our response in normal
+face and additions to the manuscript in quotes and \enquote{italic face.} Note
+that we omitted footnotes and references in the quotations.
+
+We are looking forward to hearing from you.
+
+\closing{With kind regards,}
+
+\end{letter}
+\include{rebuttal}
+\end{document}
+
+
+\endinput
+%%
+%% End of file `01-scrlttr2.tex'.
Property changes on: trunk/Master/texmf-dist/doc/latex/rebuttal/01-scrlttr2.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/rebuttal/02-article.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/rebuttal/02-article.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/rebuttal/02-article.tex 2024-11-14 20:42:15 UTC (rev 72851)
@@ -0,0 +1,39 @@
+%%
+%% This is file `02-article.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% rebuttal.dtx (with options: `example2')
+%%
+%% Copyright (C) 2018-2021, 2024 Sergiu Deitsch
+%%
+%% This work may be distributed and/or modified under the
+%% conditions of the LaTeX Project Public License, either version 1.3
+%% 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.3 or later is part of all distributions of LaTeX
+%% version 2005/12/01 or later.
+%%
+%% This work has the LPPL maintenance status `maintained'.
+%%
+%% The Current Maintainer of this work is Sergiu Deitsch.
+%%
+%% This work consists of the files rebuttal.dtx and rebuttal.ins.
+%%
+\documentclass{article}
+\usepackage{rebuttal}
+\usepackage[colorlinks]{hyperref}
+\usepackage{lipsum}
+\usepackage{cleveref}
+
+\begin{document}
+\section{Test}
+\input{rebuttal}
+\end{document}
+
+
+\endinput
+%%
+%% End of file `02-article.tex'.
Property changes on: trunk/Master/texmf-dist/doc/latex/rebuttal/02-article.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/Master/texmf-dist/doc/latex/rebuttal/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/rebuttal/README.md 2024-11-14 20:42:02 UTC (rev 72850)
+++ trunk/Master/texmf-dist/doc/latex/rebuttal/README.md 2024-11-14 20:42:15 UTC (rev 72851)
@@ -107,3 +107,8 @@
* Rebuttal markup cannot be used within floating environments such as `figure`
and `table`, and the `\caption` command.
+
+## License
+
+The `rebuttal` package is distributed under the [LaTeX Project Public
+License 1.3](https://ctan.org/license/lppl1.3) or later.
Added: trunk/Master/texmf-dist/doc/latex/rebuttal/examples/01-scrlttr2.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/rebuttal/examples/01-scrlttr2.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/rebuttal/examples/01-scrlttr2.pdf 2024-11-14 20:42:02 UTC (rev 72850)
+++ trunk/Master/texmf-dist/doc/latex/rebuttal/examples/01-scrlttr2.pdf 2024-11-14 20:42:15 UTC (rev 72851)
Property changes on: trunk/Master/texmf-dist/doc/latex/rebuttal/examples/01-scrlttr2.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/rebuttal/examples/02-article.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/rebuttal/examples/02-article.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/rebuttal/examples/02-article.pdf 2024-11-14 20:42:02 UTC (rev 72850)
+++ trunk/Master/texmf-dist/doc/latex/rebuttal/examples/02-article.pdf 2024-11-14 20:42:15 UTC (rev 72851)
Property changes on: trunk/Master/texmf-dist/doc/latex/rebuttal/examples/02-article.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Modified: trunk/Master/texmf-dist/doc/latex/rebuttal/rebuttal.pdf
===================================================================
(Binary files differ)
Added: trunk/Master/texmf-dist/doc/latex/rebuttal/rebuttal.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/rebuttal/rebuttal.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/rebuttal/rebuttal.tex 2024-11-14 20:42:15 UTC (rev 72851)
@@ -0,0 +1,116 @@
+%%
+%% This is file `rebuttal.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% rebuttal.dtx (with options: `rebuttal-comments')
+%%
+%% Copyright (C) 2018-2021, 2024 Sergiu Deitsch
+%%
+%% This work may be distributed and/or modified under the
+%% conditions of the LaTeX Project Public License, either version 1.3
+%% 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.3 or later is part of all distributions of LaTeX
+%% version 2005/12/01 or later.
+%%
+%% This work has the LPPL maintenance status `maintained'.
+%%
+%% The Current Maintainer of this work is Sergiu Deitsch.
+%%
+%% This work consists of the files rebuttal.dtx and rebuttal.ins.
+%%
+
+The following pages contain a list of editor's and reviewers' comments followed
+by our replies. The comments are sequentially numbered and associated either
+with the editor or the corresponding reviewer. The replies may contain
+references to changes in the original manuscript which are identified by a label
+consisting of a running number and followed by the label of the original comment
+in parentheses. The label back references the original reviewer comment within
+the manuscript. For instance, the reference \textbf{C2~(1.3)}, which is typeset
+in the manuscript margin, refers to the second change stemming from the third
+comment of the first reviewer.
+
+\begin{rebuttal}[Editor's Comments]
+ \begin{comment}
+ The topic of this manuscript is of interest. We concur with the summary review
+ of the associate editor and the reviews of the referees. The authors should
+ thoroughly address all of the comments, below, in a revised manuscript.
+ \end{comment}
+
+\end{rebuttal}
+
+\begin{rebuttal}[Specific Comments]
+ \begin{comment}
+ \label{c:specific}
+ You need to include figure captions that make your figures intelligible.
+ See~\cref{a:foo} and \cref{c:foo2}.
+ \end{comment}
+
+ \begin{answer}
+ The reviewer is right. We have reworked the figure captions to make the
+ figures more independent of the text. Furthermore, check if lists are
+ typeset correctly:
+ \begin{itemize}
+ \item One
+ \item Two
+ \begin{enumerate}
+ \item Three
+ \item Four
+ \end{enumerate}
+ \end{itemize}
+ \end{answer}
+
+ \begin{comment}
+ \label{c:c2}
+ Are you going to pay for color in the print article? If not, the lines are
+ not intelligible in Figures 2, 5, 11. In addition to color coding for the
+ digital version, you could make lines with distinct patterns (dots, dashes,
+ etc.) so they are distinct in monochrome presentations.
+ \end{comment}
+
+ \begin{answer}
+ We agree with this point and we are sorry that we missed this in the first
+ version of the article. The article will appear as an online only version
+ and is part of the special issue associated with this year’s CT Meeting
+ conference. Thus there will be no additional cost associated with color
+ figures. Nonetheless, we agree that all figures need to be correct in
+ grey-scale as some readers might print the article. According to the
+ reviewer’s comment, we have adjusted the figures by using different patterns
+ and gray levels.
+
+ (Refer also to \cref{c:specific} for more information.)
+ \end{answer}
+\end{rebuttal}
+
+\lipsum[1] \addition[label=a:foo,ref=c:specific]{\lipsum[2]} \lipsum[3]
+
+\lipsum[4] \deletion[label=a:foo1,ref=c:c2]{An unintended addition.}
+and a \change[label=c:foo2,ref=c:c2]{from}{to} change. And another addition
+\addition[label=a:foo3,ref=c:c2]{here}.
+Also \addition[label=a:foo4,ref=c:c2]{here}.
+Maybe \addition[label=a:foo5,ref=c:c2]{here}.
+Additionally \addition[label=a:foo6,ref=c:c2]{here}.
+Additionally \addition[label=a:foo7,ref=c:c2]{here}.
+
+\begin{additionenv}[label=d:par,ref=c:c2]
+ \begin{itemize}
+ \item \lipsum[1]
+ \end{itemize}
+ \lipsum[2]
+\end{additionenv}
+
+Additional notes:
+\begin{itemize}
+ \item Multiple source references can be
+ \addition[label=a:foo8,ref={c:specific,c:c2}]{specified}.
+ \item If the references do not fit into a single line in the margin, you may
+ force a \addition[label=a:break,ref={c:specific,c:c2},break]{break}.
+\end{itemize}
+
+
+\endinput
+%%
+%% End of file `rebuttal.tex'.
Property changes on: trunk/Master/texmf-dist/doc/latex/rebuttal/rebuttal.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/Master/texmf-dist/source/latex/rebuttal/rebuttal.dtx
===================================================================
--- trunk/Master/texmf-dist/source/latex/rebuttal/rebuttal.dtx 2024-11-14 20:42:02 UTC (rev 72850)
+++ trunk/Master/texmf-dist/source/latex/rebuttal/rebuttal.dtx 2024-11-14 20:42:15 UTC (rev 72851)
@@ -15,7 +15,7 @@
% \iffalse
%<package>\NeedsTeXFormat{LaTeX2e}
%<package>\ProvidesPackage{rebuttal}
-%<package> [2024-11-01 v0.1.0 Markup for rebuttal letters]
+%<package> [2024-11-14 v0.1.1 Markup for rebuttal letters]
%
%<*driver>
\ProvidesFile{rebuttal.dtx}
@@ -31,7 +31,6 @@
\usepackage{hyperref}
\EnableCrossrefs
-\OnlyDescription
\CodelineIndex
\RecordChanges
@@ -38,6 +37,8 @@
\hypersetup{%
pdfauthor = {Sergiu Deitsch},
pdftitle = {The rebuttal package},
+ urlcolor = NavyBlue,
+ linkcolor = Firebrick3,
}
\begin{document}
@@ -66,22 +67,25 @@
%
%
% \changes{v0.1.0}{2024-11-01}{Initial release}
+% \changes{v0.1.1}{2024-11-14}{Improved documentation}
%
% \GetFileInfo{rebuttal.sty}
%
-% \DoNotIndex{\newcommand,\newenvironment,\def,\the,\let,\if,\fi,\else}
+% \DoNotIndex{\newcommand,\newenvironment,\def,\the,\let,\if,\fi,\else,\\}
% \DoNotIndex{\newif,\ifx,\ifcase,\or}
% \DoNotIndex{\begingroup,\endgroup}
%
-% \title{The \textsf{rebuttal} package\thanks{This document
-% corresponds to \textsf{rebuttal}~\fileversion, dated \filedate.}}
-% \author{Sergiu Deitsch\\\texttt{sergiu.deitsch at gmail.com}}
-% \date{November 1, 2024}
+% \title{The \href{https://github.com/sergiud/rebuttal}{\textsf{rebuttal}} package%
+% \thanks{This document corresponds to \textsf{rebuttal}~\fileversion, dated \filedate.}}
+% \author{Sergiu % Deitsch\\%
+% \href{mailto:sergiu.deitsch at gmail.com}{\texttt{sergiu.deitsch at gmail.com}}%
+% }
+% \date{November 14, 2024}
%
% \maketitle
%
% \begin{abstract}
-% The rebuttal LaTeX package provides means for writing structured journal and
+% The rebuttal \LaTeX\ package provides means for writing structured journal and
% conference paper rebuttals.
% \end{abstract}
%
@@ -110,8 +114,9 @@
% \DescribeEnv{answer}
% The packages defines the |rebuttal| environment that can contain several
% blocks that refer to editor's or specific reviewers' comments and your replies
-% to referees' comments. Specifically, the environment is expected to contain a
-% |comment| and an |answer| environment. The general layout looks as follows:
+% to referees' comments. Specifically, the environment accepts an optional
+% \oarg{title} and is expected to contain a |comment| and an |answer|
+% environment. The general layout looks as follows:
%
% \begin{verbatim}
% \begin{rebuttal}[Editor's Comments]
@@ -132,7 +137,9 @@
% Within the manuscript, three main commands can be used to denote additions,
% deletions, or changes. The corresponding commands are
% |\addition|\oarg{options}\marg{text}, |\deletion|\oarg{options}\marg{text},
-% and |\change|\oarg{options}\marg{old text}\marg{new text}.
+% and |\change|\oarg{options}\marg{old text}\marg{new text}. While |\addition|
+% and |\deletion| require a single argument. |\change| expects two arguments,
+% where the first one denotes the changed text, and the second one the new text.
%
% All three commands require specifying their labels for referencing the
% modifications using the \meta{label} option. Additionally, the \meta{ref}
@@ -143,11 +150,6 @@
% \addition[label=a:new,ref={c:c1,c:c2}]{new text}.
% \end{verbatim}
%
-% While |\addition| and
-% |\deletion| require a single argument. |\change| expects two arguments, where
-% the first one denotes the changed text, and the second one the new text.
-%
-%
% \subsection{Annotating Multiple Paragraphs}
%
% \DescribeEnv{additionenv}
@@ -173,12 +175,24 @@
% \end{deletionenv}
% \end{verbatim}
%
+% \subsection{Disabling Annotations}
+%
+% \DescribeMacro{\rebuttalset}
+% Once a manuscript has been accepted for publication, rebuttal annotations are
+% no longer necessary and only the accepted changes should be typeset.
+% \textsf{rebuttal} allows to disable annotations using the |\rebuttalset|
+% command by disabling the \meta{marked} option, \ie,
+% \begin{verbatim}
+% \rebuttalset{marked=false}
+% \end{verbatim}
+% which will disable the annotiations in the current group.
+%
% \section{Known Limitations}
%
% Rebuttal markup cannot be used within floating environments such as |figure|
% and |table|, and the |\caption| command.
%
-% \MaybeStop{\PrintChanges}
+% \MaybeStop{\PrintChanges\PrintIndex}
%
% \section{Implementation}
%
@@ -187,10 +201,12 @@
% \begin{macrocode}
%<*package>
% \end{macrocode}
+% We need to load additional color sets.
% \begin{macrocode}
-
\PassOptionsToPackage{dvipsnames,svgnames,x11names}{xcolor}
-
+% \end{macrocode}
+% Package dependencies.
+% \begin{macrocode}
\RequirePackage{calc}
\RequirePackage{environ}
\RequirePackage{etoolbox}
@@ -210,7 +226,10 @@
\ifx\counterwithin\@undefined
\RequirePackage{chngcntr}
\fi
-
+% \end{macrocode}
+% \begin{macro}{\rebuttal at triangle}
+% The following command is used to generate a triangle in the left margin.
+% \begin{macrocode}
\newcommand\rebuttal at triangle{%
\begingroup
\ifx\tikzexternaldisable\@undefined\else
@@ -221,7 +240,12 @@
\end{tikzpicture}%
\endgroup
}
-
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\rebuttal at decbookmarklevel}
+% Unless \textsf{hyperref} was not loaded, the command decrements the current
+% bookmark level.
+% \begin{macrocode}
\newcommand\rebuttal at decbookmarklevel{%
\ifx\Hy at currentbookmarklevel\@undefined\else
\@tempcnta\Hy at currentbookmarklevel
@@ -229,7 +253,13 @@
\xdef\Hy at currentbookmarklevel{\the\@tempcnta}%
\fi
}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\rebuttal at incbookmarklevel}
+% Unless \textsf{hyperref} was not loaded, the command incements the current
+% bookmark level.
+% \begin{macrocode}
\newcommand\rebuttal at incbookmarklevel{%
\ifx\Hy at currentbookmarklevel\@undefined\else
\@tempcnta\Hy at currentbookmarklevel
@@ -237,7 +267,10 @@
\xdef\Hy at currentbookmarklevel{\the\@tempcnta}%
\fi
}
+% \end{macrocode}
+% \end{macro}
+% \begin{macrocode}
\newif\ifrebuttal at marked
\newif\ifrebuttal at nohyperlinks
\newif\ifrebuttal at refbreak
@@ -371,7 +404,9 @@
\label{\pgfkeysvalueof{/rebuttal/#1/label}}%
\colorlet{Changes at Color}{rebuttal@#1}%
\begingroup
- % Main content
+% \end{macrocode}
+% Main content.
+% \begin{macrocode}
#2%
\endgroup
\StrLeft{#1}{1}[\rebuttal at id]%
@@ -378,15 +413,21 @@
\ifx\tikzexternaldisable\@undefined\else
\tikzexternaldisable
\fi
- % Shrink to text
+% \end{macrocode}
+% Shrink to text.
+% \begin{macrocode}
\settowidth\rebuttal at textwidth{\rebuttal at reference{#1}}%
\tikzset{notestyleraw/.append style={text width=\rebuttal at textwidth}}%
- % Place labels in left margin at the same distance as on the right
+% \end{macrocode}
+% Place labels in left margin at the same distance as on the right.
+% \begin{macrocode}
\setlength\rebuttal at hskip{\marginparwidth}%
\addtolength\rebuttal at hskip{-\rebuttal at textwidth}%
\let\old at xmpar\@xmpar
- % Hook into LaTeX kernel command since \if at firstcolumn is not unreliable
- % because margin notes are floats.
+% \end{macrocode}
+% Hook into \LaTeX\ kernel command since |\if at firstcolumn| is not unreliable
+% because margin notes are floats.
+% \begin{macrocode}
\renewcommand\@xmpar[2][]{%
\old at xmpar[\hspace*{\rebuttal at hskip}####1]{####2}%
}%
@@ -406,20 +447,36 @@
\fi
}%
}
+% \end{macrocode}
-% Provide an equivalent environment for rebuttal commands
+% \begin{environment}{additionenv}
+% Provide an equivalent environment for the |\addition| command.
+% \begin{macrocode}
\NewEnviron{additionenv}[1][]{%
\addition[#1]{\BODY}%
}%
+% \end{macrocode}
+% \end{environment}
+% \begin{environment}{changeenv}
+% Provide an equivalent environment for the |\change| command.
+% \begin{macrocode}
\NewEnviron{changeenv}[2][]{%
\change[#1]{#2}{\BODY}%
}%
+% \end{macrocode}
+% \end{environment}
+% \begin{environment}{deletionenv}
+% Provide an equivalent environment for the |\deletion| command.
+% \begin{macrocode}
\NewEnviron{deletionenv}[1][]{%
\deletion[#1]{\BODY}%
}%
+% \end{macrocode}
+% \end{environment}
+% \begin{macrocode}
\newcommand\rebuttal at added[1]{%
\ifrebuttal at marked
\rebuttal at addition@font%
@@ -472,8 +529,11 @@
\counterwithin*{rebuttalanswer}{rebuttalcomment}%
\newdimen\rebuttal at labelsep
+% \end{macrocode}
-% Disable hyperlinks if NoHyper environment is available
+% \begin{macro}{\rebuttal at startlinkguard}
+% Disable hyperlinks if |NoHyper| environment is available.
+% \begin{macrocode}
\newcommand\rebuttal at startlinkguard{%
\ifx\NoHyper\@undefined\else
\ifrebuttal at nohyperlinks
@@ -481,8 +541,12 @@
\fi
\fi
}
+% \end{macrocode}
+% \end{macro}
-% End of disable hyperlinks if NoHyper environment is available
+% \begin{macro}{\rebuttal at startlinkguard}
+% End of disable hyperlinks if |NoHyper| environment is available.
+% \begin{macrocode}
\newcommand\rebuttal at endlinkguard{
\ifx\endNoHyper\@undefined\else
\ifrebuttal at nohyperlinks
@@ -490,17 +554,27 @@
\fi
\fi
}
+% \end{macrocode}
+% \end{macro}
% TODO Comment labels tooltips
+% \begin{environment}{rebuttal}
+% The main environment that defines the remaining ones.
+% \changes{v0.1.1}{2024-11-14}{Fixed incorrect bookmark structure}
+% \begin{macrocode}
\newenvironment{rebuttal}[1][]{%
\rebuttal at startlinkguard
- % Execute user code
+% \end{macrocode}
+% Execute user code.
+% \begin{macrocode}
\pgfkeysvalueof{/rebuttal/execute on begin}%
\begingroup
\refstepcounter{rebuttal}%
\if at twocolumn
\onecolumn
- % Remember the layout
+% \end{macrocode}
+% Remember the layout.
+% \begin{macrocode}
\rebuttal at twocolumntrue
\else
\rebuttal at twocolumnfalse
@@ -509,9 +583,23 @@
\par
\addvspace{\bigskipamount}%
\ifstrempty{#1}{}{%
- \ifx\subpdfbookmark\@undefined\else
- \subpdfbookmark{#1}{rebuttalcomment.\therebuttalcomment}%
+% \end{macrocode}
+% In case the current bookmark level is 0, we leave it as is. Otherwise, we
+% increment the level to anchor the following bookmarks below the current
+% bookmark. This ensures that the bookmark structure is correct even if the
+% document either does not use or provides structuring commands (\eg,
+% missing |\section| in a \textsf{scrlttr2} document).
+% \begin{macrocode}
+ \ifx\Hy at currentbookmarklevel\@undefined\else
+ \ifnum\Hy at currentbookmarklevel>0
+ \@tempcnta\Hy at currentbookmarklevel
+ \advance\@tempcnta by 1 %
+ \xdef\Hy at currentbookmarklevel{\the\@tempcnta}%
+ \fi
\fi
+ \ifx\currentpdfbookmark\@undefined\else
+ \currentpdfbookmark{#1}{rebuttalcomment.\therebuttalcomment}%
+ \fi
\noindent\bgroup\rebuttal at titlefont\strut
\pgfkeys{/rebuttal/title/format=#1}\egroup%
}%
@@ -541,8 +629,10 @@
\PackageWarning{rebuttal}{Failed to patch the \string\@item\space command.
Bookmarks may not be displayed correctly.}%
}%
- % Do not allow to place answers within a comment by undefining the answer
- % environment
+% \end{macrocode}
+% Do not allow to place answers within a comment by undefining the answer
+% environment
+% \begin{macrocode}
\let\answer\@undefined
\let\endanswer\@undefined
\stepcounter{rebuttalcomments}%
@@ -598,16 +688,23 @@
\endgroup
\par\addvspace{\bigskipamount}%
\ifrebuttal at twocolumn
- % Restore the layout
+% \end{macrocode}
+% Restore the layout.
+% \begin{macrocode}
\twocolumn
\fi
\endgroup
- % Execute user code
+% \end{macrocode}
+% Execute user code.
+% \begin{macrocode}
\pgfkeysvalueof{/rebuttal/execute on end}%
\rebuttal at endlinkguard
}
+% \end{macrocode}
+% \end{environment}
-% Support cleveref
+% Support \textsf{cleveref}.
+% \begin{macrocode}
\AtEndPreamble{%
\@ifpackageloaded{cleveref}{%
\crefname{rebuttalcomment}{comment}{comments}
@@ -633,11 +730,20 @@
\gdef\string\rebuttaltotalchanges{\arabic{rebuttalchanges}}%
}
}
-
+% \end{macrocode}
+% \begin{macro}{\rebuttalset}\marg{options}
+% Allows to update package options.
+% \begin{macrocode}
\newcommand\rebuttalset[1]{%
\pgfqkeys{/rebuttal}{#1}%
}
%</package>
+% \end{macrocode}
+% \end{macro}
+%
+% \subsection{Example}
+%
+% \begin{macrocode}
%<*example1>
\documentclass[american,version=last,fromphone,fromemail,svgnames,dvipsnames,x11names]{scrlttr2}
\usepackage[T1]{fontenc}
@@ -695,17 +801,39 @@
\closing{With kind regards,}
\end{letter}
+\include{rebuttal}
+\end{document}
+%</example1>
+% \end{macrocode}
+%
+% \begin{macrocode}
+%<*example2>
+\documentclass{article}
+\usepackage{rebuttal}
+\usepackage[colorlinks]{hyperref}
+\usepackage{lipsum}
+\usepackage{cleveref}
-\clearpage\noindent The following pages contain a list of editor's and
-reviewers' comments followed by our replies. The comments are sequentially
-numbered and associated either with the editor or the corresponding reviewer.
-The replies may contain references to changes in the original manuscript which
-are identified by a label consisting of a running number and followed by the
-label of the original comment in parentheses. The label back references the
-original reviewer comment within the manuscript. For instance, the reference
-\textbf{C2~(1.3)}, which is typeset in the manuscript margin, refers to the
-second change stemming from the third comment of the first reviewer.
+\begin{document}
+\section{Test}
+\input{rebuttal}
+\end{document}
+%</example2>
+% \end{macrocode}
+%
+% \begin{macrocode}
+%<*rebuttal-comments>
+The following pages contain a list of editor's and reviewers' comments followed
+by our replies. The comments are sequentially numbered and associated either
+with the editor or the corresponding reviewer. The replies may contain
+references to changes in the original manuscript which are identified by a label
+consisting of a running number and followed by the label of the original comment
+in parentheses. The label back references the original reviewer comment within
+the manuscript. For instance, the reference \textbf{C2~(1.3)}, which is typeset
+in the manuscript margin, refers to the second change stemming from the third
+comment of the first reviewer.
+
\begin{rebuttal}[Editor's Comments]
\begin{comment}
The topic of this manuscript is of interest. We concur with the summary review
@@ -782,9 +910,11 @@
\item If the references do not fit into a single line in the margin, you may
force a \addition[label=a:break,ref={c:specific,c:c2},break]{break}.
\end{itemize}
-
-\end{document}
-%</example1>
+%</rebuttal-comments>
% \end{macrocode}
%
+% \Finale
+
+% \endinput
+
% vim: ft=tex
Modified: trunk/Master/texmf-dist/source/latex/rebuttal/rebuttal.ins
===================================================================
--- trunk/Master/texmf-dist/source/latex/rebuttal/rebuttal.ins 2024-11-14 20:42:02 UTC (rev 72850)
+++ trunk/Master/texmf-dist/source/latex/rebuttal/rebuttal.ins 2024-11-14 20:42:15 UTC (rev 72851)
@@ -39,7 +39,9 @@
\generate{
\file{rebuttal.sty}{\from{rebuttal.dtx}{package}}
- \file{01-example.tex}{\from{rebuttal.dtx}{example1}}
+ \file{rebuttal.tex}{\from{rebuttal.dtx}{rebuttal-comments}}
+ \file{01-scrlttr2.tex}{\from{rebuttal.dtx}{example1}}
+ \file{02-article.tex}{\from{rebuttal.dtx}{example2}}
}
\obeyspaces
Modified: trunk/Master/texmf-dist/tex/latex/rebuttal/rebuttal.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/rebuttal/rebuttal.sty 2024-11-14 20:42:02 UTC (rev 72850)
+++ trunk/Master/texmf-dist/tex/latex/rebuttal/rebuttal.sty 2024-11-14 20:42:15 UTC (rev 72851)
@@ -24,10 +24,8 @@
%%
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{rebuttal}
- [2024-11-01 v0.1.0 Markup for rebuttal letters]
-
+ [2024-11-14 v0.1.1 Markup for rebuttal letters]
\PassOptionsToPackage{dvipsnames,svgnames,x11names}{xcolor}
-
\RequirePackage{calc}
\RequirePackage{environ}
\RequirePackage{etoolbox}
@@ -47,7 +45,6 @@
\ifx\counterwithin\@undefined
\RequirePackage{chngcntr}
\fi
-
\newcommand\rebuttal at triangle{%
\begingroup
\ifx\tikzexternaldisable\@undefined\else
@@ -58,7 +55,6 @@
\end{tikzpicture}%
\endgroup
}
-
\newcommand\rebuttal at decbookmarklevel{%
\ifx\Hy at currentbookmarklevel\@undefined\else
\@tempcnta\Hy at currentbookmarklevel
@@ -208,7 +204,6 @@
\label{\pgfkeysvalueof{/rebuttal/#1/label}}%
\colorlet{Changes at Color}{rebuttal@#1}%
\begingroup
- % Main content
#2%
\endgroup
\StrLeft{#1}{1}[\rebuttal at id]%
@@ -215,15 +210,11 @@
\ifx\tikzexternaldisable\@undefined\else
\tikzexternaldisable
\fi
- % Shrink to text
\settowidth\rebuttal at textwidth{\rebuttal at reference{#1}}%
\tikzset{notestyleraw/.append style={text width=\rebuttal at textwidth}}%
- % Place labels in left margin at the same distance as on the right
\setlength\rebuttal at hskip{\marginparwidth}%
\addtolength\rebuttal at hskip{-\rebuttal at textwidth}%
\let\old at xmpar\@xmpar
- % Hook into LaTeX kernel command since \if at firstcolumn is not unreliable
- % because margin notes are floats.
\renewcommand\@xmpar[2][]{%
\old at xmpar[\hspace*{\rebuttal at hskip}####1]{####2}%
}%
@@ -327,13 +318,11 @@
\newenvironment{rebuttal}[1][]{%
\rebuttal at startlinkguard
- % Execute user code
\pgfkeysvalueof{/rebuttal/execute on begin}%
\begingroup
\refstepcounter{rebuttal}%
\if at twocolumn
\onecolumn
- % Remember the layout
\rebuttal at twocolumntrue
\else
\rebuttal at twocolumnfalse
@@ -342,9 +331,16 @@
\par
\addvspace{\bigskipamount}%
\ifstrempty{#1}{}{%
- \ifx\subpdfbookmark\@undefined\else
- \subpdfbookmark{#1}{rebuttalcomment.\therebuttalcomment}%
+ \ifx\Hy at currentbookmarklevel\@undefined\else
+ \ifnum\Hy at currentbookmarklevel>0
+ \@tempcnta\Hy at currentbookmarklevel
+ \advance\@tempcnta by 1 %
+ \xdef\Hy at currentbookmarklevel{\the\@tempcnta}%
+ \fi
\fi
+ \ifx\currentpdfbookmark\@undefined\else
+ \currentpdfbookmark{#1}{rebuttalcomment.\therebuttalcomment}%
+ \fi
\noindent\bgroup\rebuttal at titlefont\strut
\pgfkeys{/rebuttal/title/format=#1}\egroup%
}%
@@ -374,8 +370,6 @@
\PackageWarning{rebuttal}{Failed to patch the \string\@item\space command.
Bookmarks may not be displayed correctly.}%
}%
- % Do not allow to place answers within a comment by undefining the answer
- % environment
\let\answer\@undefined
\let\endanswer\@undefined
\stepcounter{rebuttalcomments}%
@@ -431,11 +425,9 @@
\endgroup
\par\addvspace{\bigskipamount}%
\ifrebuttal at twocolumn
- % Restore the layout
\twocolumn
\fi
\endgroup
- % Execute user code
\pgfkeysvalueof{/rebuttal/execute on end}%
\rebuttal at endlinkguard
}
@@ -465,10 +457,11 @@
\gdef\string\rebuttaltotalchanges{\arabic{rebuttalchanges}}%
}
}
-
\newcommand\rebuttalset[1]{%
\pgfqkeys{/rebuttal}{#1}%
}
+
+
\endinput
%%
%% End of file `rebuttal.sty'.
More information about the tex-live-commits
mailing list.