Text.XML.HXT.Arrow.WriteDocument

Compound arrow for writing XML documents

Documentation

writeDocument :: Attributes -> String -> IOStateArrow s XmlTree XmlTree

the main filter for writing documents

this filter can be configured by an option list like Text.XML.HXT.Arrow.ReadDocument.readDocument

usage: writeDocument optionList destination

if destination is the empty string or "-", stdout is used as output device

available options are

• a_indent : indent document for readability, (default: no indentation)
• a_remove_whitespace : remove all redundant whitespace for shorten text (default: no removal)
• a_output_encoding : encoding of document, default is a_encoding or utf8
• a_output_xml : (default) issue XML: quote special XML chars >,<,",',& where neccessary add XML processing instruction and encode document with respect to a_output_encoding, if explicitly switched of, the plain text is issued, this is useful for non XML output, e.g. generated Haskell code, LaTex, Java, ...
• a_output_html : issue XHTML: quote alle XML chars, use HTML entity refs or char refs for none ASCII chars
• a_no_empty_elements : do not write the short form <name .../> for empty elements. When a_output_html is set, the always empty HTML elements are still written in short form, but not the others, as e.g. the script element. Empty script elements, like <script href="..."/>, are always a problem for firefox and others. When XML output is generated with this option, all empty elements are written in the long form.
• a_no_empty_elem_for : do not generate empty elements for the element names given in the comma separated list of this option value. This option overwrites the above described a_no_empty_elements option
• a_add_default_dtd : if the document to be written was build by reading another document containing a Document Type Declaration, this DTD is inserted into the output document (default: no insert)
• a_no_xml_pi : suppress generation of <?xml ... ?> processing instruction
• a_show_tree : show tree representation of document (for debugging)
• a_show_haskell : show Haskell representaion of document (for debugging)

a minimal main program for copying a document has the following structure:

 module Main
 where
 
 import Text.XML.HXT.Arrow
 
 main        :: IO ()
 main
     = do
       runX ( readDocument  [] "hello.xml"
              >>>
              writeDocument [] "bye.xml"
            )
       return ()

an example for copying a document to standard output with tracing and evaluation of error code is:

 module Main
 where
 
 import Text.XML.HXT.Arrow
 import System.Exit
 
 main        :: IO ()
 main
     = do
       [rc] <- runX ( readDocument  [ (a_trace, "1")
                                    ] "hello.xml"
                      >>>
                      writeDocument [ (a_output_encoding, isoLatin1)
                                    ] "-"        -- output to stdout
                      >>>
                      getErrStatus
                    )
       exitWith ( if rc >= c_err
                  then ExitFailure 1
                  else ExitSuccess
                )

writeDocumentToString :: ArrowXml a => Attributes -> a XmlTree String

Convert a document into a string. Formating is done the same way and with the same options as in writeDocument. Default output encoding is no encoding, that means the result is a normal unicode encode haskell string. The default may be overwritten with the Text.XML.HXT.XmlKeywords.a_output_encoding option. The XML PI can be suppressed by the Text.XML.HXT.XmlKeywords.a_no_xml_pi option.

This arrow fails, when the encoding scheme is not supported. The arrow is pure, it does not run in the IO monad. The XML PI is suppressed, if not explicitly turned on with an option (a_no_xml_pi, v_0)

prepareContents :: ArrowXml a => Attributes -> (Bool -> String -> a XmlTree XmlTree) -> a XmlTree XmlTree

indent and format output