Dear list,
How can I link a vignette of a package in a man page (Rd files)?
I try \link[=pkgname/doc/filename]{a name} without success.
The link gives the following error message: Only help files, NEWS, DESCRIPTION and files under doc/ and demo/ in a package can be viewed
Thanks in advance
Kind regards, Christophe
---------------------------------------
Christophe Dutang
LMM, UdM, Le Mans, France
web: http://dutangc.free.fr
linking vignettes in a man page
4 messages · Christophe Dutang, Bert Gunter, Duncan Murdoch
Please post this on R-package-devel, not here. Cheers, Bert Bert Gunter "The trouble with having an open mind is that people keep coming along and sticking things into it." -- Opus (aka Berkeley Breathed in his "Bloom County" comic strip )
On Wed, Jun 29, 2016 at 1:49 PM, Christophe Dutang <dutangc at gmail.com> wrote:
Dear list,
How can I link a vignette of a package in a man page (Rd files)?
I try \link[=pkgname/doc/filename]{a name} without success.
The link gives the following error message: Only help files, NEWS, DESCRIPTION and files under doc/ and demo/ in a package can be viewed
Thanks in advance
Kind regards, Christophe
---------------------------------------
Christophe Dutang
LMM, UdM, Le Mans, France
web: http://dutangc.free.fr
______________________________________________ R-help at r-project.org mailing list -- To UNSUBSCRIBE and more, see https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
On 29/06/2016 4:49 PM, Christophe Dutang wrote:
Dear list,
How can I link a vignette of a package in a man page (Rd files)?
I try \link[=pkgname/doc/filename]{a name} without success.
The link gives the following error message: Only help files, NEWS, DESCRIPTION and files under doc/ and demo/ in a package can be viewed
You can give \url{} style links, for example the grid package has
\url{../doc/grid.pdf}
in the package?grid help topic. Similarly, ../../<pkg>/help/<alias>
will link from a vignette to help topic ?alias.
Duncan Murdoch
Thanks both to your answer.
In my case, I link both html and pdf vignetttes with \href, typically \href{../doc/FAQ.html}{Frequently Asked Questions}.
Maybe Duncan, you could add your answer based on \url{../doc/<name>} and \url{../../<pkg>/help/<alias>} as a complement in Section 2.5 of Writing R extensions?
I spent quite a lot of time searching how to do this.
Regards, Christophe
---------------------------------------
Christophe Dutang
LMM, UdM, Le Mans, France
web: http://dutangc.free.fr <http://dutangc.free.fr/>
Le 29 juin 2016 ? 23:27, Duncan Murdoch <murdoch.duncan at gmail.com> a ?crit : On 29/06/2016 4:49 PM, Christophe Dutang wrote:
Dear list,
How can I link a vignette of a package in a man page (Rd files)?
I try \link[=pkgname/doc/filename]{a name} without success.
The link gives the following error message: Only help files, NEWS, DESCRIPTION and files under doc/ and demo/ in a package can be viewed
You can give \url{} style links, for example the grid package has
\url{../doc/grid.pdf}
in the package?grid help topic. Similarly, ../../<pkg>/help/<alias> will link from a vignette to help topic ?alias.
Duncan Murdoch