Re: [Rd] \dQuote{} in \code{} not processed

From: Gavin Simpson <gavin.simpson_at_ucl.ac.uk>
Date: Thu 01 Dec 2005 - 07:56:16 GMT

On Thu, 2005-12-01 at 07:14 +0000, Prof Brian Ripley wrote:
> On Wed, 30 Nov 2005, Gavin Simpson wrote:
>
> > Just wondering if this is the expected behaviour.
>
> Yes. The only command processed inside \code is \link (plus support for
> \example and \usage which go through the same processing).
>
>
> > I was wanting to produce quoted text within \code{}, without manually
> > entering the '"'. \dQuote{} seems advisable after reading the Writing R
> > Extensions manual, so I tried \code{\dQuote{mytext}} expecting it to
> > produce "mytext" in monospace font (with ' ' round it in the R help
> > files) but it appears that \dQuote{mytext} is not processed within \code
> > {} as \dQuote{mytext} is printed literally in the produced
> > documentation.
> >
> > Is this intended? I didn't see any statements suggesting \code{} could
> > not include other markup, and \code{\link{}} works...
>
> Hmm, \dQuote is described in a section called
>
> Marking text
>
> The following logical markup commands are available for emphasizing or
> quoting text.
>
> and \code is described as
>
> Indicate text that is a literal example of a piece of a program, e.g., a
> fragment of @R{} code or the name of an @R{} object, using
> @code{typewriter} font if possible.
>
> Is `literal example' not warning enough? I'll add an explicit statement,
> but this is the first time I have seen any indication that anyone thought
> otherwise.

Thanks for confirming this - it was the fact that \link{} works that caused confusion. Such \link{} usage is not a 'literal example'.

Cheers,

G

-- 
%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%
Gavin Simpson                     [T] +44 (0)20 7679 5522
ENSIS Research Fellow             [F] +44 (0)20 7679 7565
ENSIS Ltd. & ECRC                 [E] gavin.simpsonATNOSPAMucl.ac.uk
UCL Department of Geography       [W] http://www.ucl.ac.uk/~ucfagls/cv/
26 Bedford Way                    [W] http://www.ucl.ac.uk/~ucfagls/
London.  WC1H 0AP.
%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%~%

______________________________________________
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
Received on Thu Dec 01 19:00:57 2005

This archive was generated by hypermail 2.1.8 : Thu 01 Dec 2005 - 11:21:29 GMT