From 9a22a89b06d6f5fd7dd67adb367e490fb2425a78 Mon Sep 17 00:00:00 2001 From: Joe Cheng Date: Wed, 23 Dec 2015 09:42:29 -0800 Subject: [PATCH] Add docs --- man/htmlTemplate.Rd | 26 ++++++++++++++++++++++++++ man/suppressDependencies.Rd | 22 ++++++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 man/htmlTemplate.Rd create mode 100644 man/suppressDependencies.Rd diff --git a/man/htmlTemplate.Rd b/man/htmlTemplate.Rd new file mode 100644 index 000000000..b1fa420aa --- /dev/null +++ b/man/htmlTemplate.Rd @@ -0,0 +1,26 @@ +\name{htmlTemplate} +\alias{htmlTemplate} +\title{Process an HTML template} +\usage{ +htmlTemplate(filename, ..., document_ = "auto") +} +\arguments{ +\item{filename}{Path to an HTML template file.} + +\item{...}{Variable values to use when processing the template.} + +\item{document_}{Is this template a complete HTML document (\code{TRUE}), or +a fragment of HTML that is to be inserted into an HTML document +(\code{FALSE})? With \code{"auto"} (the default), auto-detect by searching +for the string \code{""} within the template.} +} +\description{ +Process an HTML template and return a tagList object. If the template is a +complete HTML document, then the returned object will also have class +\code{html_document}, and can be passed to the function +\code{\link{renderDocument}} to get the final HTML text. +} +\seealso{ +\code{\link{renderDocument}} +} + diff --git a/man/suppressDependencies.Rd b/man/suppressDependencies.Rd new file mode 100644 index 000000000..b7e217377 --- /dev/null +++ b/man/suppressDependencies.Rd @@ -0,0 +1,22 @@ +\name{suppressDependencies} +\alias{suppressDependencies} +\title{Suppress web dependencies} +\usage{ +suppressDependencies(...) +} +\arguments{ +\item{...}{Names of the dependencies to suppress. For example, +\code{"jquery"} or \code{"bootstrap"}.} +} +\description{ +This suppresses one or more web dependencies. It is meant to be used when a +dependency (like a JavaScript or CSS file) is declared in raw HTML, in an +HTML template. +} +\seealso{ +\code{\link{htmlTemplate}} for more information about using HTML + templates. + +\code{\link[htmltools]{htmlDependency}} +} +