The R Project SVN R

Rev

Rev 49496 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
49314 ripley 1 
% File src/library/tools/man/HTMLlinks.Rd
47348 ripley 2 
% Part of the R package, http://www.R-project.org
59039 ripley 3 
% Copyright 2009 R Core Team
47348 ripley 4 
% Distributed under GPL 2 or later
5 
 
49314 ripley 6 
\name{HTMLlinks}
47635 ripley 7 
\alias{findHTMLlinks}
49314 ripley 8 
\title{Collect HTML Links from Package Documentation}
47348 ripley 9 
\description{
49314 ripley 10 
  Compute relative file paths for URLs to other package's installed HTML
11 
  documentation.
47348 ripley 12 
}
13 
\usage{
49496 ripley 14 
findHTMLlinks(pkgDir = "", lib.loc = NULL, level = 0:2)
47348 ripley 15 
}
16 
\arguments{
49314 ripley 17 
  \item{pkgDir}{the top-level directory of an installed package.  The
18 
    default indicates no package.}
19 
  \item{lib.loc}{character vector describing the location of \R library
20 
    trees to scan: the default indicates \code{\link{.libPaths}()}.}
49496 ripley 21 
  \item{level}{Which level(s) to include.}
47348 ripley 22 
}
23 
\details{
49314 ripley 24 
  \code{findHTMLlinks} tries to resolve links from one help page to
25 
  another.  It uses in decreasing priority
47624 ripley 26 
  \itemize{
47635 ripley 27 
    \item The package in \code{pkgDir}: this is used when converting
49496 ripley 28 
    HTML help for that package (level 0).
29 
    \item The base and recommended packages (level 1).
47635 ripley 30 
    \item Other packages found in the library trees specified by
31 
    \code{lib.loc} in the order of the trees and alphabetically within a
49496 ripley 32 
    library tree (level 2).
47635 ripley 33 
  }
47348 ripley 34 
}
49008 maechler 35 
\value{
49314 ripley 36 
  A named character vector of file paths, relative to the \file{html}
37 
  directory of an installed package.  So these are of the form
38 
  \file{"../../\var{somepkg}/html/\var{sometopic}.html"}.
47348 ripley 39 
}
49314 ripley 40 
\author{Duncan Murdoch, Brian Ripley}
47348 ripley 41 
\keyword{ documentation }