Current File : //proc/thread-self/root/opt/alt/ruby18/share/ri/1.8/system/REXML/Document/write-i.yaml

--- !ruby/object:RI::MethodDescription 
aliases: []

block_params: 
comment: 
- !ruby/struct:SM::Flow::P 
  body: 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).
- !ruby/struct:SM::Flow::P 
  body: 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.
- !ruby/struct:SM::Flow::P 
  body: See also the classes in the rexml/formatters package for the proper way to change the default formatting of XML output
- !ruby/struct:SM::Flow::P 
  body: <em>Examples</em>
- !ruby/struct:SM::Flow::VERB 
  body: "  Document.new(&quot;&lt;a&gt;&lt;b/&gt;&lt;/a&gt;&quot;).serialize\n\n  output_string = &quot;&quot;\n  tr = Transitive.new( output_string )\n  Document.new(&quot;&lt;a&gt;&lt;b/&gt;&lt;/a&gt;&quot;).serialize( tr )\n"
- !ruby/object:SM::Flow::LIST 
  contents: 
  - !ruby/struct:SM::Flow::LI 
    label: "output:"
    body: output an object which supports '&lt;&lt; string'; this is where the
  type: :NOTE
- !ruby/struct:SM::Flow::VERB 
  body: "  document will be written.\n"
- !ruby/object:SM::Flow::LIST 
  contents: 
  - !ruby/struct:SM::Flow::LI 
    label: "indent:"
    body: 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
  - !ruby/struct:SM::Flow::LI 
    label: "trans:"
    body: If transitive is true and indent is &gt;= 0, then the output will be pretty-printed in such a way that the added whitespace does not affect the absolute <b>value</b> of the document -- that is, it leaves the value and number of Text nodes in the document unchanged.
  - !ruby/struct:SM::Flow::LI 
    label: "ie_hack:"
    body: 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 /&gt; on empty tags. Defaults to false
  type: :NOTE
full_name: REXML::Document#write
is_singleton: false
name: write
params: ( output=$stdout, indent=-1, trans=false, ie_hack=false )
visibility: public