The R Project SVN R

Rev

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

Rev 74831 Rev 76497
Line 1... Line 1...
1
% File src/library/tools/man/vignetteEngine.Rd
1
% File src/library/tools/man/vignetteEngine.Rd
2
% Part of the R package, https://www.R-project.org
2
% Part of the R package, https://www.R-project.org
3
% Copyright 2013-2016 R Core Team
3
% Copyright 2013-2019 R Core Team
4
% Distributed under GPL 2 or later
4
% Distributed under GPL 2 or later
5
 
5
 
6
\name{vignetteEngine}
6
\name{vignetteEngine}
7
\alias{vignetteEngine}
7
\alias{vignetteEngine}
8
\title{Set or Get a Vignette Processing Engine}
8
\title{Set or Get a Vignette Processing Engine}
Line 44... Line 44...
44
\code{encoding}; others may be added in future. These are described in
44
\code{encoding}; others may be added in future. These are described in
45
the documentation for \code{\link{Sweave}} and \code{\link{Stangle}}.
45
the documentation for \code{\link{Sweave}} and \code{\link{Stangle}}.
46
 
46
 
47
The \code{weave} and \code{tangle} functions should return the
47
The \code{weave} and \code{tangle} functions should return the
48
filename of the output file that has been produced. Currently the
48
filename of the output file that has been produced. Currently the
49
\code{weave} function, when operating on a file named \file{<name>
49
\code{weave} function, when operating on a file named
-
 
50
\file{<name><pattern>} must produce a file named
50
<pattern>} must produce a file named \file{<name>[.](tex|pdf|html)}.
51
\file{<name>[.](tex|pdf|html)}. 
51
The \file{.tex} files will be processed by \command{pdflatex} to
52
The \file{.tex} files will be processed by \command{pdflatex} to
52
produce \file{.pdf} output for display to the user; the others will be
53
produce \file{.pdf} output for display to the user; the others will be
53
displayed as produced.  The \code{tangle} function must produce a file
54
displayed as produced.  The \code{tangle} function must produce a file
54
named \file{<name>[.][rRsS]} containing the executable \R{} code from
55
named \file{<name>[.][rRsS]} containing the executable \R{} code from
55
the vignette.  The \code{tangle} function may support a
56
the vignette.  The \code{tangle} function may support a