From murdoch at stats.uwo.ca  Fri Mar  6 01:49:47 2009
From: murdoch at stats.uwo.ca (Duncan Murdoch)
Date: Thu, 05 Mar 2009 19:49:47 -0500
Subject: [Rd] Chunk of text won't show up when compiling Rd file
In-Reply-To: <885c6fdd0903050929l15fa3213t10969af2ae303761@mail.gmail.com>
References: <885c6fdd0903050929l15fa3213t10969af2ae303761@mail.gmail.com>
Message-ID: <49B0732B.70906@stats.uwo.ca>

On 05/03/2009 12:29 PM, Ben Bryant wrote:
> Greetings -
> 
> I am trying to document the "value" section of a function.  The function
> returns a list, but the list itself also has attributes.  I would like to
> itemize the list entries, and itemize the attributes, but in between I would
> like to have a sentence or two about the attributes in general.  However,
> for some reason this intermediate sentence won't show up in the compiled
> version, so that it appears the attributes are all just elements in the
> returned list.  Something is making the assumption that the itemized list
> must be uninterrupted, and I don't know the code to tell it not to do that.
> I presume it is a very easy fix, but I haven't been able to get at it.
> 
> I pasted some example explanatory Rd code below.
> 
> Thanks!
> -Ben Bryant

Could you give your example a try in R-devel, with one of the new 
conversion functions, e.g. tools::Rd2HTML?  I don't think these new 
functions are used by default even in R-devel, but if they solve your 
problem, there will be less motivation to fix the legacy functions.

Duncan Murdoch

> 
> 
> %%%%% Just the Value Section:
> 
> \value{
> Here I have a paragraph giving the general description of the output form.
> Then I have an itemized list describing the elements.
> 
>    \item{listobject1}{Description of list object 1}
>    \item{listobject2}{Description of list object 2}
>   %... etc
>    \item{lastlistobject}{Description of the last list object}
> 
> THEN, here I have a general description of the attributes, and the text
> represented by this sentence is what doesn't show up, because it's in
> between more of an itemized list.
> 
>    \item{attribute1}{details of attribute 1}
>    \item{attribute 2}{details of attribute 2}
> 
> Then I have text here, and this text does show up.
> }
> 
> %%%%
> 
> 	[[alternative HTML version deleted]]
> 
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel



[Rd] Chunk of text won't show up when compiling Rd file
Duncan Murdoch