process Rd \bib notes as raw strings

smeyer · smeyer · commit ed85ecc6831a · 2026-02-11T15:47:54.000Z
git-svn-id: https://svn.r-project.org/R/trunk@89404 00db46b3-68df-0310-9c12-caf00c1e9a41
diff --git a/doc/manual/R-exts.texi b/doc/manual/R-exts.texi
@@ -8708,9 +8708,7 @@ argument, where a @var{citespec} can be a @var{keyspec} or of the form
 @code{@var{before}|@var{keyspec}|@var{after}} with both @samp{|}
 mandatory and @var{before} and @var{after} possibly empty text to be
 inserted before and after the citation if not empty.  If these texts
-contain commas, these can be backslash-escaped: due to the way Rd macros
-are processed, this needs 6 (!) backslashes, see the examples below.
-(This is clearly inconvenient, but most likely too late to change.)
+contain commas, these can be backslash-escaped: see the examples below.
 
 A @var{keyspec} is either a simple @var{key} or of the form
 @code{@var{pkg}::@var{key}}.  In the former case, @var{key} is taken as
@@ -8747,7 +8745,7 @@ For example,
 gives a textual citation of the ``@emph{Blue Book}''
 (`@I{Becker, Chambers, and Wilks (1988)}' when first encountered),
 @example
-\bibcitep@{e.g.\\\\\\,|R:Chambers+Hastie:1992|page 123@}
+\bibcitep@{e.g.\,|R:Chambers+Hastie:1992|page 123@}
 @end example
 @noindent
 gives a parenthetical citation of a page in the ``@emph{White Book}''
diff --git a/share/Rd/macros/system.Rd b/share/Rd/macros/system.Rd
@@ -60,7 +60,7 @@
 \newcommand{\manual}{\Sexpr[results=rd]{tools:::Rd_expr_manual("#1", "#2")}}
 
 % To cite from installed bibentries (R_bibentries() or package-specific REFERENCES)
-\newcommand{\bibcitep}{\Sexpr[results=rd,stage=build]{tools:::Rd_expr_bibcite("#1", FALSE)}}
-\newcommand{\bibcitet}{\Sexpr[results=rd,stage=build]{tools:::Rd_expr_bibcite("#1", TRUE)}}
+\newcommand{\bibcitep}{\Sexpr[results=rd,stage=build]{tools:::Rd_expr_bibcite(r"(#1)", FALSE)}}
+\newcommand{\bibcitet}{\Sexpr[results=rd,stage=build]{tools:::Rd_expr_bibcite(r"(#1)", TRUE)}}
 \newcommand{\bibshow}{\Sexpr[results=rd,stage=build]{tools:::Rd_expr_bibshow("#1")}}
-\newcommand{\bibinfo}{\Sexpr[stage=build]{tools:::Rd_expr_bibinfo("#1", "#2", "#3")}}
+\newcommand{\bibinfo}{\Sexpr[stage=build]{tools:::Rd_expr_bibinfo("#1", "#2", r"(#3)")}}
diff --git a/src/library/base/man/Arithmetic.Rd b/src/library/base/man/Arithmetic.Rd
@@ -174,7 +174,7 @@ x \%/\% y
 }
 \references{
   \bibinfo{R:Goldberg:1991}{footer}{Also available at
-    \\\\\\url{https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html}.}
+    \url{https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html}.}
   
   \bibshow{R:Becker+Chambers+Wilks:1988,
     R:Goldberg:1991}
diff --git a/src/library/base/man/Hyperbolic.Rd b/src/library/base/man/Hyperbolic.Rd
@@ -35,7 +35,7 @@ atanh(x)
 
    Branch cuts are consistent with the inverse trigonometric functions
    \code{asin} \emph{et seq}, and agree with those defined in
-   \bibcitet{|R:Abramowitz+Stegun:1972|figure 4.7\\\\\\, page 86}.
+   \bibcitet{|R:Abramowitz+Stegun:1972|figure 4.7\, page 86}.
    The behaviour actually on the cuts
    follows the C99 standard which requires continuity coming round the
    endpoint in a counter-clockwise direction.
diff --git a/src/library/base/man/Random.Rd b/src/library/base/man/Random.Rd
@@ -256,19 +256,19 @@ set.seed(seed, kind = NULL, normal.kind = NULL, sample.kind = NULL)
 }
 \references{
   \bibinfo{R:Becker+Chambers+Wilks:1988}{footer}{
-    (\\\\\\code{set.seed}, storing in \\\\\\code{.Random.seed}.)}
+    (\code{set.seed}, storing in \code{.Random.seed}.)}
   \bibinfo{R:Knuth:1997:v2}{footer}{
-    Source code at \\\\\\url{https://www-cs-faculty.stanford.edu/~knuth/taocp.html}.}
+    Source code at \url{https://www-cs-faculty.stanford.edu/~knuth/taocp.html}.}
   \bibinfo{R:L_Ecuyer+Simard:2007}{footer}{
-    The \\\\\\I{TestU01} C library is available from
-    \\\\\\url{https://simul.iro.umontreal.ca/testu01/tu01.html} or also
-    \\\\\\url{https://github.com/umontreal-simul/TestU01-2009}.
+    The \I{TestU01} C library is available from
+    \url{https://simul.iro.umontreal.ca/testu01/tu01.html} or also
+    \url{https://github.com/umontreal-simul/TestU01-2009}.
   }
   \bibinfo{R:Matsumoto+Nishimura:1998}{footer}{
-    Source code formerly at \\\\\\code{http://www.math.keio.ac.jp/~matumoto/emt.html}.
-    Now see \\\\\\url{https://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/VERSIONS/C-LANG/c-lang.html}.}
+    Source code formerly at \code{http://www.math.keio.ac.jp/~matumoto/emt.html}.
+    Now see \url{https://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/VERSIONS/C-LANG/c-lang.html}.}
   \bibinfo{R:Wichmann+Hill:1982}{note}{Remarks:
-    \\\\\\bold{34}, 198 and \\\\\\bold{35}, 89.}
+    \bold{34}, 198 and \bold{35}, 89.}
 
   \bibshow{*,
     R:Ahrens+Dieter:1973,
diff --git a/src/library/base/man/Special.Rd b/src/library/base/man/Special.Rd
@@ -52,23 +52,23 @@ lfactorial(x)
   \deqn{B(a,b) = \frac{\Gamma(a)\Gamma(b)}{\Gamma(a+b)}.}{B(a,b) = \Gamma(a)\Gamma(b)/\Gamma(a+b).}
   The formal definition is
   \deqn{B(a, b) = \int_0^1 t^{a-1} (1-t)^{b-1} dt}{integral_0^1 t^(a-1) (1-t)^(b-1) dt}
-  \bibcitep{|R:Abramowitz+Stegun:1972|section 6.2.1\\\\\\, page 258}.
+  \bibcitep{|R:Abramowitz+Stegun:1972|section 6.2.1\, page 258}.
   Note that it is only
   defined in \R for non-negative \code{a} and \code{b}, and is infinite
   if either is zero.
 
   The functions \code{gamma} and \code{lgamma} return the gamma function
   \eqn{\Gamma(x)} and the natural logarithm of \emph{the absolute value of} the
   gamma function.  The gamma function is defined by
-  \bibcitep{|R:Abramowitz+Stegun:1972|section 6.1.1\\\\\\, page 255}
+  \bibcitep{|R:Abramowitz+Stegun:1972|section 6.1.1\, page 255}
   \deqn{\Gamma(x) = \int_0^\infty t^{x-1} e^{-t} dt}{\Gamma(x) = integral_0^Inf t^(x-1) exp(-t) dt}
   for all \eqn{x > 0}, from which the recursions \eqn{\Gamma(x+1) =
   x\Gamma(x)} and then \eqn{\Gamma(x+n) = (x+n-1)(x+n-2)\cdots x \Gamma(x)}
   for all non-negative integers \eqn{n}.  Solving  for \eqn{\Gamma(x)} and
   analytic continuation leads to the expression for non-integer negative real numbers,
   \deqn{\Gamma(x) = \frac{\Gamma(x + n)}{(x + n -1) \cdots (x + 1)x}, \ n \in \mathbb{Z}^{+}, -n < x < 0,%
   }{\Gamma(x) = \Gamma(x + n)/((x + n -1) ... (x + 1)x), n in N, -n < x < 0,}
-  see \bibcitet{|R:Abramowitz+Stegun:1972|6.1.16 or 6.1.22\\\\\\, page 256}.
+  see \bibcitet{|R:Abramowitz+Stegun:1972|6.1.16 or 6.1.22\, page 256}.
   %
   The gamma function is not defined for zero and negative integers (when
   \code{NaN} is returned).  There will be a warning on possible loss of
@@ -87,7 +87,7 @@ lfactorial(x)
     \frac{\Gamma'(x)}{\Gamma(x)}}{digamma(x) = \psi(x) = d/dx{ln \Gamma(x)} = \Gamma'(x) / \Gamma(x)}
   \eqn{\psi} and its derivatives, the \code{psigamma()} functions, are
   often called the \sQuote{\I{polygamma}} functions, e.g.\sspace{}in
-  \bibcitet{|R:Abramowitz+Stegun:1972|section 6.4.1\\\\\\, page 260}; and higher
+  \bibcitet{|R:Abramowitz+Stegun:1972|section 6.4.1\, page 260}; and higher
   derivatives (\code{deriv = 2:4}) have occasionally been called
   \sQuote{\I{tetragamma}}, \sQuote{\I{pentagamma}}, and \sQuote{\I{hexagamma}}.
 
@@ -120,10 +120,10 @@ lfactorial(x)
 }
 \references{
   \bibinfo{R:Abramowitz+Stegun:1972}{footer}{
-    \\\\\\url{https://en.wikipedia.org/wiki/Abramowitz_and_Stegun} provides
-    links to the full text which is in public domain.\\\\\\cr
+    \url{https://en.wikipedia.org/wiki/Abramowitz_and_Stegun} provides
+    links to the full text which is in public domain.\cr
     Chapter 6: Gamma and Related Functions.}
-  \bibinfo{R:Becker+Chambers+Wilks:1988}{footer}{(For \\\\\\code{gamma} and \\\\\\code{lgamma}.)}
+  \bibinfo{R:Becker+Chambers+Wilks:1988}{footer}{(For \code{gamma} and \code{lgamma}.)}
   \bibshow{*, R:Becker+Chambers+Wilks:1988}
 }
 \seealso{
diff --git a/src/library/base/man/Trig.Rd b/src/library/base/man/Trig.Rd
@@ -72,7 +72,7 @@ tanpi(x)
 
 \section{Complex values}{
    For the inverse trigonometric functions, branch cuts are defined as in
-   \bibcitet{|R:Abramowitz+Stegun:1972|figure 4.4\\\\\\, page 79}.
+   \bibcitet{|R:Abramowitz+Stegun:1972|figure 4.4\, page 79}.
 
    For \code{asin} and \code{acos}, there are two cuts, both along
    the real axis: \eqn{\left(-\infty, -1\right]}{(-Inf, -1]} and
diff --git a/src/library/base/man/rapply.Rd b/src/library/base/man/rapply.Rd
@@ -57,7 +57,7 @@ rapply(object, f, classes = "ANY", deflt = NULL,
   \code{\link{lapply}}, \code{\link{dendrapply}}.
 }
 \references{
-  \bibinfo{R:Chambers:1998}{footer}{(\\\\\\code{rapply} is only
+  \bibinfo{R:Chambers:1998}{footer}{(\code{rapply} is only
     described briefly there.)}
   \bibshow{R:Chambers:1998}
 }
diff --git a/src/library/base/man/sort.Rd b/src/library/base/man/sort.Rd
@@ -149,7 +149,7 @@ sort.int(x, partial = NULL, na.last = NA, decreasing = FALSE,
   \code{\link{order}} if you want the original element numbers.
 
   All attributes are removed from the return value
-  \bibcitep{|R:Becker+Chambers+Wilks:1988|p.\\\\\\sspace{}146}
+  \bibcitep{|R:Becker+Chambers+Wilks:1988|p.\sspace{}146}
   except names, which are sorted.  (If
   \code{partial} is specified even the names are removed.)  Note that
   this means that the returned value has no class, except for factors
diff --git a/src/library/datasets/man/BJsales.Rd b/src/library/datasets/man/BJsales.Rd
@@ -18,7 +18,7 @@ BJsales
 BJsales.lead
 }
 \source{
-  The data are given in \bibcitet{|R:Box+Jenkins:1976|p.\\\\\\sspace{}537}.
+  The data are given in \bibcitet{|R:Box+Jenkins:1976|p.\sspace{}537}.
   Obtained from the Time Series Data Library at
   \url{https://robjhyndman.com/TSDL/}
 }
diff --git a/src/library/datasets/man/LifeCycleSavings.Rd b/src/library/datasets/man/LifeCycleSavings.Rd
@@ -24,7 +24,7 @@
 }
 \source{
   The data were obtained from
-  \bibcitet{|R:Belsley+Kuh+Welsch:1980|pp.\\\\\\sspace{}41--42}.
+  \bibcitet{|R:Belsley+Kuh+Welsch:1980|pp.\sspace{}41--42}.
   They in turn obtained the data from \bibcitet{R:Sterling:1977}.
 }
 \details{
diff --git a/src/library/datasets/man/Nile.Rd b/src/library/datasets/man/Nile.Rd
@@ -12,7 +12,7 @@
   Measurements of the annual flow of the river Nile at Aswan (formerly
   \code{Assuan}), 1871--1970, in \eqn{10^8 m^3},
   \dQuote{with apparent changepoint near 1898}
-  \bibcitep{|R:Cobb:1978|Table 1\\\\\\, page 249}.
+  \bibcitep{|R:Cobb:1978|Table 1\, page 249}.
 }
 \format{
   A time series of length 100.
diff --git a/src/library/datasets/man/Theoph.Rd b/src/library/datasets/man/Theoph.Rd
@@ -53,7 +53,7 @@
 }
 \source{
   \bibinfo{R:Davidian+Giltinan:1995}{footer}{
-    (section 5.5, p.\\\\\\sspace{}145 and section 6.6, p.\\\\\\sspace{}176)}
+    (section 5.5, p.\sspace{}145 and section 6.6, p.\sspace{}176)}
   \bibinfo{R:Pinheiro+Bates:2000}{footer}{(Appendix A.29)}
   \bibshow{*}
 }
diff --git a/src/library/datasets/man/crimtab.Rd b/src/library/datasets/man/crimtab.Rd
@@ -32,7 +32,7 @@
     I had endeavoured to do so empirically.  The material used was a
     correlation table containing the height and left middle finger
     measurements of 3000 criminals, from a paper by
-    \bibcitet{|R:MacDonell:1902|p.\\\\\\sspace{}219)}.
+    \bibcitet{|R:MacDonell:1902|p.\sspace{}219)}.
     The
     measurements were written 
     out on 3000 pieces of cardboard, which were then very thoroughly
diff --git a/src/library/datasets/man/iris.Rd b/src/library/datasets/man/iris.Rd
@@ -36,7 +36,7 @@ iris3
   The data were collected by \bibcitet{R:Anderson:1935}.
 }
 \references{
-  \bibinfo{R:Becker+Chambers+Wilks}{footer}{(Has \\\\\\code{iris3} as \\\\\\code{iris}.)}
+  \bibinfo{R:Becker+Chambers+Wilks}{footer}{(Has \code{iris3} as \code{iris}.)}
   \bibshow{*,
     R:Becker+Chambers+Wilks:1988}
 }
diff --git a/src/library/grDevices/man/boxplot.stats.Rd b/src/library/grDevices/man/boxplot.stats.Rd
@@ -57,8 +57,8 @@ boxplot.stats(x, coef = 1.5, do.conf = TRUE, do.out = TRUE)
 
   The notches (if requested) extend to \code{+/-1.58 IQR/sqrt(n)}.
   This seems to be based on the same calculations as the formula with 1.57 in
-  \bibcitet{|R:Chambers+Cleveland+Kleiner:1983|p.\\\\\\sspace{}62)}, given in
-  \bibcitet{|R:Mcgill+Tukey+Larsen:1978|p.\\\\\\sspace{}16)}.
+  \bibcitet{|R:Chambers+Cleveland+Kleiner:1983|p.\sspace{}62)}, given in
+  \bibcitet{|R:Mcgill+Tukey+Larsen:1978|p.\sspace{}16)}.
   They are based on asymptotic normality of the median
   and roughly equal sample sizes for the two medians being compared, and
   are said to be rather insensitive to the underlying distributions of
diff --git a/src/library/stats/man/Fdist.Rd b/src/library/stats/man/Fdist.Rd
@@ -63,7 +63,7 @@ rf(n, df1, df2, ncp)
 
   The F distribution's cumulative distribution function (\abbr{cdf}),
   \eqn{F_{\nu_1,\nu_2}}{F_{n1,n2}} fulfills
-  \bibcitep{|R:Abramowitz+Stegun:1972|section 26.6.2\\\\\\, page 946}
+  \bibcitep{|R:Abramowitz+Stegun:1972|section 26.6.2\, page 946}
   \eqn{F_{\nu_1,\nu_2}(qF) = 1 - I_x(\nu_2/2, \nu_1/2) = I_{1-x}(\nu_1/2, \nu_2/2),}{%
        F_{n1,n2}(qF)   = 1 - I_x(n2/2, n1/2)   = I_{1-x}(n1/2, n2/2),}  where
   \eqn{x := \frac{\nu_2}{\nu_2 + \nu_1*qF}}{x := n2/(n2 + n1*qF)},  and
diff --git a/src/library/stats/man/bandwidth.Rd b/src/library/stats/man/bandwidth.Rd
@@ -50,7 +50,7 @@ bw.SJ(x, nb = 1000, lower = 0.1 * hmax, upper = hmax,
   minimum of the standard deviation and the interquartile range divided by
   1.34 times the sample size to the negative one-fifth power
   (= \I{Silverman}'s \sQuote{rule of thumb},
-  \bibcitet{|R:Silverman:1986|page 48\\\\\\, \\\\\\abbr{eqn} (3.31)})
+  \bibcitet{|R:Silverman:1986|page 48\, \abbr{eqn} (3.31)})
   \emph{unless} the quartiles coincide when a positive result
   will be guaranteed.
 
diff --git a/src/library/stats/man/glm.Rd b/src/library/stats/man/glm.Rd
@@ -179,7 +179,7 @@ glm.fit(x, y, weights = rep.int(1, nobs),
   For the background to warning messages about
   \sQuote{\I{fitted probabilities numerically 0 or 1 occurred}}
   for binomial GLMs, see
-  \bibcitet{|R:Venables+Ripley:2002|pp.\\\\\\sspace{}197--8}.
+  \bibcitet{|R:Venables+Ripley:2002|pp.\sspace{}197--8}.
 }
 
 \section{Fitting functions}{
diff --git a/src/library/stats/man/spectrum.Rd b/src/library/stats/man/spectrum.Rd
@@ -63,7 +63,7 @@ spectrum(x, \dots, method = c("pgram", "ar"))
   \code{(-frequency(x)/2, +frequency(x)/2]},
   whereas a more common scaling is \eqn{2\pi}{2pi} and range
   \eqn{(-0.5, 0.5]}
-  \bibcitep{e.g.\\\\\\,|R:Bloomfield:1976|} or 1 and range
+  \bibcitep{e.g.\,|R:Bloomfield:1976|} or 1 and range
   \eqn{(-\pi, \pi]}{(-pi, pi]}.
 
   If available, a confidence interval will be plotted by

Original file line number	Diff line number	Diff line change
`@@ -174,7 +174,7 @@ x \%/\% y`
`174`	`174`	`}`
`175`	`175`	`\references{`
`176`	`176`	`\bibinfo{R:Goldberg:1991}{footer}{Also available at`
`177`		`- \\\\\\url{https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html}.}`
	`177`	`+ \url{https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html}.}`
`178`	`178`
`179`	`179`	`\bibshow{R:Becker+Chambers+Wilks:1988,`
`180`	`180`	`R:Goldberg:1991}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ rapply(object, f, classes = "ANY", deflt = NULL,`
`57`	`57`	`\code{\link{lapply}}, \code{\link{dendrapply}}.`
`58`	`58`	`}`
`59`	`59`	`\references{`
`60`		`- \bibinfo{R:Chambers:1998}{footer}{(\\\\\\code{rapply} is only`
	`60`	`+ \bibinfo{R:Chambers:1998}{footer}{(\code{rapply} is only`
`61`	`61`	`described briefly there.)}`
`62`	`62`	`\bibshow{R:Chambers:1998}`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ BJsales`
`18`	`18`	`BJsales.lead`
`19`	`19`	`}`
`20`	`20`	`\source{`
`21`		`- The data are given in \bibcitet{\|R:Box+Jenkins:1976\|p.\\\\\\sspace{}537}.`
	`21`	`+ The data are given in \bibcitet{\|R:Box+Jenkins:1976\|p.\sspace{}537}.`
`22`	`22`	`Obtained from the Time Series Data Library at`
`23`	`23`	`\url{https://robjhyndman.com/TSDL/}`
`24`	`24`	`}`