File: processXInclude.Rd

package info (click to toggle)
r-cran-xml 3.99-0.19-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,688 kB
  • sloc: ansic: 6,659; xml: 2,890; asm: 486; sh: 12; makefile: 2
file content (69 lines) | stat: -rw-r--r-- 2,028 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
\name{processXInclude}
\alias{processXInclude}
\alias{processXInclude.list}
\alias{processXInclude.XMLInternalDocument}
\alias{processXInclude.XMLInternalElement}
\title{Perform the XInclude substitutions}
\description{
  This function and its methods process the XInclude directives
  within the document of the form \code{<xi:include href="..."
    xpointer=".."}
  and perform the actual substitution.

  These are only relevant for "internal nodes" as generated
  via \code{\link{xmlInternalTreeParse}} and
  \code{\link{newXMLNode}} and their related functions.
  When dealing with XML documents via \code{\link{xmlTreeParse}}
  or \code{\link{xmlEventParse}}, the XInclude nodes are controlled
  during the parsing.
}
\usage{
processXInclude(node, flags = 0L)
}
\arguments{
  \item{node}{an XMLInternalDocument object or an XMLInternalElement
    node or a list of such internal nodes,
    e.g. returned from \code{\link{xpathApply}}.}
  \item{flags}{an integer value that provides information to control
    how the XInclude substitutions are done, i.e. how they are parsed. This is a bitwise OR'ing
    of some or all of the xmlParserOption values.
   This will be turned into an enum in R in the future.}
}

\value{
  These functions are used for their side-effect to modify the
  document and its nodes.
}
\references{
  libxml2 \url{http://www.xmlsoft.org}
  XInclude
}
\author{Duncan Temple Lang}

\seealso{
  \code{\link{xmlInternalTreeParse}}
  \code{\link{newXMLNode}}
}
\examples{

  f = system.file("exampleData", "include.xml", package = "XML")
  doc = xmlInternalTreeParse(f, xinclude = FALSE)

  cat(saveXML(doc))
  sects = getNodeSet(doc, "//section")
  sapply(sects, function(x) xmlName(x[[2]]))
  processXInclude(doc)

  cat(saveXML(doc))

  f = system.file("exampleData", "include.xml", package = "XML")
  doc = xmlInternalTreeParse(f, xinclude = FALSE)
  section1 = getNodeSet(doc, "//section")[[1]]

     # process 
  processXInclude(section1[[2]])
}

\keyword{IO }
\keyword{programming}
\concept{XML}