The R Project SVN R

Rev

Rev 63195 | Rev 66444 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 63195 Rev 63198
Line 15... Line 15...
15 
is used by those packages to register their engines, and internally by
 15 
is used by those packages to register their engines, and internally by
16 
\R{} to retrieve them.
 16 
\R{} to retrieve them.
17 
}
 17 
}
18 
\usage{
 18 
\usage{
19 
vignetteEngine(name, weave, tangle, pattern = NULL,
 19 
vignetteEngine(name, weave, tangle, pattern = NULL,
20 
	       package = NULL, text = NULL)
 20 
	       package = NULL, aspell = list())
21 
}
 21 
}
22 
\arguments{
 22 
\arguments{
23 
  \item{name}{the name of the engine.}
 23 
  \item{name}{the name of the engine.}
24 
  \item{weave}{a function to convert vignette source files to LaTeX output.}
 24 
  \item{weave}{a function to convert vignette source files to LaTeX output.}
25 
  \item{tangle}{a function to convert vignette source files to \R code.}
 25 
  \item{tangle}{a function to convert vignette source files to \R code.}
26 
  \item{pattern}{a regular expression pattern for the filenames handled
 26 
  \item{pattern}{a regular expression pattern for the filenames handled
27 
    by this engine, or \code{NULL} for the default pattern.}
 27 
    by this engine, or \code{NULL} for the default pattern.}
28 
  \item{package}{the package registering the engine.  By default, this
 28 
  \item{package}{the package registering the engine.  By default, this
29 
    is the package calling \code{vignetteEngine}.}
 29 
    is the package calling \code{vignetteEngine}.}
30 
  \item{text}{a filter to be used for spell checking the text in the
 30 
  \item{aspell}{a list with element names \code{filter} and/or
- 
 
 31 
    \code{control} giving the respective arguments to be used when spell
- 
 
 32 
    checking the text in the vignette source file with
31 
    vignette source file with \code{\link{aspell}}.}
 33 
    \code{\link{aspell}}.}
32 
}
 34 
}
33 
\details{
 35 
\details{
34 
If \code{weave} is missing, \code{vignetteEngine} will return the currently
 36 
If \code{weave} is missing, \code{vignetteEngine} will return the currently
35 
registered engine matching \code{name} and \code{package}.
 37 
registered engine matching \code{name} and \code{package}.
36 
 
 38