The R Project SVN R

Rev

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

Rev Author Line No. Line
54635 ripley 1 
% File src/library/tools/man/HTMLheader.Rd
2 
% Part of the R package, http://www.R-project.org
59039 ripley 3 
% Copyright 2009-11 R Core Team
54635 ripley 4 
% Distributed under GPL 2 or later
5 
 
50445 murdoch 6 
\name{HTMLheader}
56186 murdoch 7 
\alias{HTMLheader}
50445 murdoch 8 
\title{
52664 hornik 9 
  Generate a standard HTML header for R help
50445 murdoch 10 
}
11 
\description{
12 
This function generates the standard HTML header used on R help pages.
13 
}
14 
\usage{
52664 hornik 15 
HTMLheader(title = "R", logo = TRUE, up = NULL,
61433 ripley 16 
           top = file.path(Rhome, "doc/html/index.html"),
54057 ripley 17 
           Rhome = "",
18 
           css = file.path(Rhome, "doc/html/R.css"),
19 
           headerTitle = paste("R:", title),
52664 hornik 20 
           outputEncoding = "UTF-8")
50445 murdoch 21 
}
22 
\arguments{
23 
  \item{title}{
24 
The title to display and use in the HTML headers.  Should have had any
25 
HTML escaping already done.
26 
}
27 
  \item{logo}{
28 
Whether to display the \R{} logo after the title.
29 
}
30 
  \item{up}{
31 
Which page (if any) to link to on the \dQuote{up} button.
32 
}
33 
  \item{top}{
34 
Which page (if any) to link to on the \dQuote{top} button.
35 
}
36 
  \item{Rhome}{
54057 ripley 37 
A \bold{relative} path to the R home directory.  See the \sQuote{Details}.
50445 murdoch 38 
}
54057 ripley 39 
  \item{css}{
40 
The relative URL for the Cascading Style Sheet.
41 
}
50445 murdoch 42 
  \item{headerTitle}{
43 
The title used in the headers.
44 
}
45 
  \item{outputEncoding}{
46 
The declared encoding for the whole page.
47 
}
48 
}
49 
\details{
50 
The \code{up} and \code{top} links should be relative to the current page.
51 
The \code{Rhome} path default works with dynamic help; for static help, a
52 
relative path (e.g. \file{../..}) to it should be used.
53 
}
54 
\value{
55 
A character vector containing the lines of an HTML header which can be used
56 
to start a page in the R help system.
57 
}
58 
\examples{
59 
cat(HTMLheader("This is a sample header"), sep="\n")
60 
}
61 
\keyword{ utilities }
62 
\keyword{ documentation }