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 an object which supports ‘<< string’; this is where the document will be written.
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
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.
This hack inserts a space before the /> on empty tags to address a limitation of Internet Explorer. Defaults to false
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.
Writes out this element, and recursively, all children.
output an object which supports ‘<< string’; this is where the
document will be written.
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
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 parse tree of the document
This hack inserts a space before the /> on empty tags to address a limitation of Internet Explorer. Defaults to false
out = '' doc.write( out ) #-> doc is written to the string 'out' doc.write( $stdout ) #-> doc written to the console
Write out a fully formed, correct entity definition (assuming the Entity
object itself is valid.)
An object implementing <<
to which the entity will be output
DEPRECATED and ignored
Ignored. There must be no whitespace before an XML
declaration
Ignored
Ignored
Adds tuple
to the proxied TupleSpace
. See TupleSpace#write
.
Returns the first advertised TupleSpace
.
Adds tuple
Override to display a longer description of what this command does.
Writes out this config file, replacing its source.
Verifies that this gem:
Contains a valid gem specification
Contains a contents archive
The contents archive is not corrupt
After verification the gem specification from the gem is available from spec
Writes s to the stream. If the argument is not a String
it will be converted using .to_s
method. Returns the number of bytes written.
Formats and writes to the stream converting parameters under control of the format string.
See Kernel#sprintf
for format string details.