| 27445 |
ripley |
1 |
\name{link.html.help}
|
|
|
2 |
\alias{link.html.help}
|
|
|
3 |
\alias{make.packages.html}
|
|
|
4 |
\alias{make.search.html}
|
|
|
5 |
\alias{fixup.package.URLs}
|
|
|
6 |
\alias{fixup.libraries.URLs}
|
|
|
7 |
\title{Update HTML documentation files}
|
|
|
8 |
\usage{
|
|
|
9 |
link.html.help(verbose = FALSE, lib.loc = .libPaths())
|
|
|
10 |
make.packages.html(lib.loc = .libPaths())
|
|
|
11 |
make.search.html(lib.loc = .libPaths())
|
|
|
12 |
|
|
|
13 |
fixup.package.URLs(pkg, force = FALSE)
|
|
|
14 |
fixup.libraries.URLs(lib.loc = .libPaths())
|
|
|
15 |
}
|
|
|
16 |
\description{
|
|
|
17 |
Functions to re-create the HTML documentation files to reflect all
|
|
|
18 |
installed packages. \code{make.packages.html} creates
|
|
|
19 |
the list of packages and \code{make.search.html} creates the
|
|
|
20 |
database used by the Java search engine. \code{link.html.help} runs
|
|
|
21 |
both, as well as \code{fixup.libraries.URLs} which attempts to
|
|
|
22 |
fix up cross-library links.
|
|
|
23 |
}
|
|
|
24 |
\arguments{
|
|
|
25 |
\item{verbose}{logical. If true, print out a message. For use to
|
|
|
26 |
explain a delay when called from other functions.}
|
|
|
27 |
\item{lib.loc}{character vector. List of libraries to be included.}
|
|
|
28 |
\item{pkg}{character vector. The full path to a package.}
|
|
|
29 |
\item{force}{logical. Should the links be fixed even if the stamp is
|
|
|
30 |
present?}
|
|
|
31 |
}
|
|
|
32 |
\details{
|
| 27730 |
ripley |
33 |
Cross-library links do not work on this platform.
|
|
|
34 |
\code{fixup.package.URLs} attempts to correct links in the
|
|
|
35 |
named package to the \code{doc} directory (usually to icons) and to the
|
|
|
36 |
\code{base}, \code{utils}, \code{graphics} and \code{stats} packages,
|
|
|
37 |
and then stamps a file \file{fixedHTMLlinks} in the package directory.
|
|
|
38 |
If that file is found, no correction is attempted unless \code{force =
|
|
|
39 |
TRUE} or the \R installation directory (recorded in the stamp) has been
|
|
|
40 |
changed.
|
| 27445 |
ripley |
41 |
|
|
|
42 |
\code{fixup.libraries.URLs} calls \code{fixup.package.URLs} on all
|
|
|
43 |
packages in current library trees except the standard one.
|
|
|
44 |
|
|
|
45 |
The functions will give a warning if the files are not writeable.
|
|
|
46 |
}
|
|
|
47 |
\value{
|
|
|
48 |
\code{make.packages.html} and \code{fixup.package.URLs} return a
|
|
|
49 |
logical showing if they suceeded.
|
|
|
50 |
|
|
|
51 |
The files
|
|
|
52 |
\file{R\_HOME\\doc\\html\\packages.html} and
|
|
|
53 |
\file{R\_HOME\\doc\\html\\search\\index.txt} are (re-)created by
|
|
|
54 |
\code{make.packages.html} and \code{make.search.html} respectively.
|
|
|
55 |
}
|
| 27730 |
ripley |
56 |
\note{
|
|
|
57 |
You will need write permission in the \file{R\_HOME\\doc\\html}
|
| 27445 |
ripley |
58 |
directory to use any of the first three functions, and in the
|
| 27730 |
ripley |
59 |
appropriate library trees to use the last two.
|
|
|
60 |
}
|
| 27445 |
ripley |
61 |
\keyword{utilities}
|
The R Project SVN
R