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|.

Constants

A convenient default XML declaration. If you want an XML declaration, the easiest way to add one is mydoc << Document::DECLARATION DEPRECATED Use: mydoc << XMLDecl.default

Attributes
No documentation available
Class Methods

Get the entity expansion limit. By default the limit is set to 10000.

Deprecated. Use REXML::Security.entity_expansion_limit= instead.

Set the entity expansion limit. By default the limit is set to 10000.

Deprecated. Use REXML::Security.entity_expansion_limit= instead.

Get the entity expansion limit. By default the limit is set to 10240.

Deprecated. Use REXML::Security.entity_expansion_text_limit instead.

Set the entity expansion limit. By default the limit is set to 10240.

Deprecated. Use REXML::Security.entity_expansion_text_limit= instead.

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.

No documentation available
Instance Methods
An alias for add

We override this, because XMLDecls and DocTypes must go at the start of the document

No documentation available
No documentation available

Should be obvious

@return the DocType child of the document, if one exists, and nil otherwise.

No documentation available

@return the XMLDecl encoding of this document as an Encoding object. If no XMLDecl has been set, returns the default encoding.

According to the XML spec, a root node has no expanded name

An alias for expanded_name
No documentation available
No documentation available

@return the root Element of the document, or nil if this document has no children.

@return the XMLDecl standalone value of this document as a String. If no XMLDecl has been set, returns the default setting.

@return the XMLDecl version of this document as a String. If no XMLDecl has been set, returns the default version.

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 unnecessary bandwidth to applications such as XML-RPC.

Accept Nth argument style and options Hash style as argument. The recommended style is options Hash style for one or more arguments case.

Examples

Document.new("<a><b/></a>").write

output = ""
Document.new("<a><b/></a>").write(output)

output = ""
Document.new("<a><b/></a>").write(:output => output, :indent => 2)

See also the classes in the rexml/formatters package for the proper way to change the default formatting of XML output.

Examples

output = ""
tr = Transitive.new
tr.write(Document.new("<a><b/></a>"), output)
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 twice this number of spaces, and children will be indented an additional amount. For a value of 3, every item will be indented 3 more levels, or 6 more spaces (2 * 3). Defaults to -1

transitive

If transitive is true and indent is >= 0, then the output will be pretty-printed in such a way that the added whitespace does not affect the absolute value of the document – that is, it leaves the value and number of Text nodes in the document unchanged.

ie_hack

This hack inserts a space before the /> on empty tags to address a limitation of Internet Explorer. Defaults to false

encoding

Encoding name as String. Change output encoding to specified encoding instead of encoding in XML declaration. Defaults to nil. It means encoding in XML declaration is used.

@return the XMLDecl of this document; if no XMLDecl has been set, the default declaration is returned.