The R Project SVN R

Rev

Rev 68948 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 68948 Rev 86803
Line 9... Line 9...
9 
\description{
 9 
\description{
10 
  Compute relative file paths for URLs to other package's installed HTML
 10 
  Compute relative file paths for URLs to other package's installed HTML
11 
  documentation.
 11 
  documentation.
12 
}
 12 
}
13 
\usage{
 13 
\usage{
14 
findHTMLlinks(pkgDir = "", lib.loc = NULL, level = 0:2)
 14 
findHTMLlinks(pkgDir = "", lib.loc = NULL, level = 0:3)
15 
}
 15 
}
16 
\arguments{
 16 
\arguments{
17 
  \item{pkgDir}{the top-level directory of an installed package.  The
 17 
  \item{pkgDir}{the top-level directory of an installed package.  The
18 
    default indicates no package.}
 18 
    default indicates no package.}
19 
  \item{lib.loc}{character vector describing the location of \R library
 19 
  \item{lib.loc}{character vector describing the location of \R library
Line 24... Line 24...
24 
  \code{findHTMLlinks} tries to resolve links from one help page to
 24 
  \code{findHTMLlinks} tries to resolve links from one help page to
25 
  another.  It uses in decreasing priority
 25 
  another.  It uses in decreasing priority
26 
  \itemize{
 26 
  \itemize{
27 
    \item The package in \code{pkgDir}: this is used when converting
 27 
    \item The package in \code{pkgDir}: this is used when converting
28 
    HTML help for that package (level 0).
 28 
    HTML help for that package (level 0).
29 
    \item The base and recommended packages (level 1).
 29 
    \item The base and recommended packages (levels 1 and 2).
30 
    \item Other packages found in the library trees specified by
 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
 31 
    \code{lib.loc} in the order of the trees and alphabetically within a
32 
    library tree (level 2).
 32 
    library tree (level 3).
33 
  }
 33 
  }
34 
}
 34 
}
35 
\value{
 35 
\value{
36 
  A named character vector of file paths, relative to the \file{html}
 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
 37 
  directory of an installed package.  So these are of the form