-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A SXML-parser
--   
--   This library parses and write <a>SXML</a> files, using datatypes from
--   the <a>xml-types</a> package to represent their structure. It
--   currently only features a DOM-style parser.
@package sxml
@version 0.1.0.0


-- | Utility functions.
--   
--   This module contains utility functions which might be useful
--   elsewhere. So far, there are only functions to determine if a
--   <tt>String</tt> may be a valid XML element name.
module Text.SXML.Utils

-- | This function returns <tt>True</tt> is its input is a valid character
--   at the beginning of an XML element name.
isXMLNameStartChar :: Char -> Bool

-- | This function returns <tt>True</tt> is its input is a valid character
--   within an XML element name.
isXMLNameChar :: Char -> Bool

-- | This function returns <tt>True</tt> is its input is a valid XML
--   element name.
isXMLName :: [Char] -> Bool


-- | DOM-based parsing and rendering.
--   
--   This module uses the datatypes from <a>Data.XML.Types</a>, with the
--   <tt>String</tt>-based function being the “default” parsing one and the
--   <tt>Text.Lazy</tt>-based one being the “default” rendering one,
--   <tt>writeFile</tt> and <tt>readFile</tt> being convenience functions.
--   It uses more or less the same naming conventions as <a>xml-conduit</a>
module Text.SXML
readFile :: FilePath -> IO (Either String Document)
parseString :: String -> Either String Document
parseText :: Text -> Either String Document
parseLazyText :: Text -> Either String Document
writeFile :: FilePath -> Document -> IO ()
renderString :: Document -> String
renderText :: Document -> Text
renderLazyText :: Document -> Text