You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

114 lines
4.1 KiB

% Generated by roxygen2: do not edit by hand
6 years ago
% Please edit documentation in R/tidy.r
\name{tidy_html}
\alias{tidy_html}
6 years ago
\alias{tidy_html.HTMLInternalDocument}
\alias{tidy_html.character}
\alias{tidy_html.connection}
6 years ago
\alias{tidy_html.default}
\alias{tidy_html.raw}
\alias{tidy_html.xml_document}
\title{Tidy or "Pretty Print" HTML/XHTML Documents}
6 years ago
\usage{
6 years ago
tidy_html(content, options = list(TidyXhtmlOut = TRUE))
6 years ago
\method{tidy_html}{default}(content, options = list(TidyXhtmlOut = TRUE))
\method{tidy_html}{character}(content, options = list(TidyXhtmlOut = TRUE))
\method{tidy_html}{raw}(content, options = list(TidyXhtmlOut = TRUE))
\method{tidy_html}{xml_document}(content, options = list(TidyXhtmlOut = TRUE))
\method{tidy_html}{HTMLInternalDocument}(content, options = list(TidyXhtmlOut
= TRUE))
\method{tidy_html}{connection}(content, options = list(TidyXhtmlOut = TRUE))
6 years ago
}
\arguments{
6 years ago
\item{content}{accepts a character vector, raw vector or parsed content from the \code{xml2}
or \code{XML} packages.}
6 years ago
\item{options}{named list of options}
}
\value{
Tidied HTML/XHTML content. The object type will be the same as that of the input type
except when it is a \code{connection}, then a character vector will be returned.
6 years ago
}
\description{
6 years ago
Pass in HTML content as either plain or raw text or parsed objects (either with the
\code{XML} or \code{xml2} packages) along with an options list that specifies how
the content will be tidied and get back tidied content of the same object type as passed
in to the function.
}
\details{
The default option \code{TixyXhtmlOut} will convert the input content to XHTML.
Currently supported options:
\itemize{
\item{Ones taking a logical value: }{\code{TidyAltText}, \code{TidyBodyOnly}, \code{TidyBreakBeforeBR},
\code{TidyCoerceEndTags}, \code{TidyDropEmptyElems}, \code{TidyDropEmptyParas},
\code{TidyFixBackslash}, \code{TidyFixComments}, \code{TidyGDocClean}, \code{TidyHideComments},
\code{TidyHtmlOut}, \code{TidyIndentContent}, \code{TidyJoinClasses}, \code{TidyJoinStyles},
\code{TidyLogicalEmphasis}, \code{TidyMakeBare}, \code{TidyMakeClean}, \code{TidyMark},
\code{TidyOmitOptionalTags}, \code{TidyReplaceColor}, \code{TidyUpperCaseAttrs},
\code{TidyUpperCaseTags}, \code{TidyWord2000}, \code{TidyXhtmlOut}}
\item{Ones taking a character value: }{\code{TidyDoctype}, \code{TidyInlineTags}, \code{TidyBlockTags},
\code{TidyEmptyTags}, \code{TidyPreTags}}
\item{Ones taking an integer value: }{\code{TidyIndentSpaces}, \code{TidyTabSize}, \code{TidyWrapLen}}
}
File \href{https://github.com/hrbrmstr/htmltidy/issues}{an issue} if there are other \code{libtidy}
options you'd like supported.
It is likely that the most used options will be:
\itemize{
\item{\code{TidyXhtmlOut} (logical)},
\item{\code{TidyHtmlOut} (logical)} and
\item{\code{TidyDocType} which should be one of "\code{omit}",
"\code{html5}", "\code{auto}", "\code{strict}" or "\code{loose}"}.
}
You can clean up Microsoft Word (2000) and Google Docs HTML via logical settings for
\code{TidyWord2000} and \code{TidyGDocClean}, respectively.
It may also be advantageous to remove all comments with \code{TidyHideComments}.
}
\examples{
opts <- list(
TidyDocType="html5",
TidyMakeClean=TRUE,
TidyHideComments=TRUE,
TidyIndentContent=TRUE,
TidyWrapLen=200
)
txt <- paste0(
c("<html><head><style>p { color: red; }</style><body><!-- ===== body ====== -->",
"<p>Test</p></body><!--Default Zone --> <!--Default Zone End--></html>"),
collapse="")
cat(tidy_html(txt, option=opts))
library(httr)
res <- GET("http://rud.is/test/untidy.html")
# look at the original, un-tidy source
cat(content(res, as="text"))
# see the tidied version
cat(tidy_html(content(res, as="text"), list(TidyDocType="html5", TidyWrapLen=200)))
# but, you could also just do:
cat(tidy_html(url("http://rud.is/test/untidy.html")))
6 years ago
}
6 years ago
\references{
6 years ago
\url{http://api.html-tidy.org/tidy/quickref_5.1.25.html} &
\url{https://github.com/htacg/tidy-html5/blob/master/include/tidyenum.h}
for definitions of the options supported above and \url{https://www.w3.org/People/Raggett/tidy/}
for an explanation of what "tidy" HTML is and some canonical examples of what it can do.
6 years ago
}
6 years ago