Represents a full XML document, including PIs, a doctype, etc. A Document has a single child that can be accessed
by root(). Note that if you want to have an XML declaration written for a
document you create, you must add one; REXML
documents do not write a default declaration for you. See |DECLARATION| and
|write|.
Constructor @param source if supplied, must be a Document, String, or IO. Documents have their
context and Element attributes cloned. Strings
are expected to be valid XML documents. IOs are expected to be sources of
valid XML documents. @param context if supplied, contains the context of
the document; this should be a Hash. NOTE that I’m not sure what the
context is for; I cloned it out of the Electric XML API (in which it also
seems to do nothing), and it is now legacy. It may do something,
someday… it may disappear.
According to the XML spec, a root node has no expanded name
This method is also aliased as
name
We override this, because XMLDecls and DocTypes must go at the start of the
document
This method is also aliased as
<<
@return the root Element of the document, or nil
if this document has no children.
@return the DocType child of the document, if
one exists, and nil otherwise.
@return the XMLDecl of this document; if no XMLDecl has been set, the default declaration is
returned.
@return the XMLDecl version of this document as
a String. If no XMLDecl has been set, returns
the default version.
@return the XMLDecl encoding of this document as
a String. If no XMLDecl has been set, returns
the default encoding.
@return the XMLDecl standalone value of this
document as a String. If no XMLDecl has been
set, returns the default setting.
Write the XML tree out, optionally with indent. This writes out the entire
XML document, including XML declarations, doctype declarations, and
processing instructions (if any are given). A controversial point is
whether Document should always write the XML
declaration (<?xml version=’1.0’?>) whether or not one is
given by the user (or source document). REXML
does not write one if one was not specified, because it adds unneccessary
bandwidth to applications such as XML-RPC.
output: | output an object which supports ’<< string’; this is
where the
|
document will be written.
indent: | An integer. If -1, no indenting will be used; otherwise, the indentation
will be this number of spaces, and children will be indented an additional
amount. Defaults to -1
|
transitive: | What the heck does this do? Defaults to false
|
ie_hack: | Internet Explorer is the worst piece of crap to have ever been written,
with the possible exception of Windows itself. Since IE is unable to parse
proper XML, we have to provide a hack to generate XML that IE’s
limited abilities can handle. This hack inserts a space before the /> on
empty tags. Defaults to false
|