Text-XML-HXT-DOM-XmlOptions.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Text.XML.HXT.DOM.XmlOptions</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>hxt-8.2.0: A collection of tools for processing XML with Haskell.</TD
><TD CLASS="topbut"
><A HREF="src/Text-XML-HXT-DOM-XmlOptions.html"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Text.XML.HXT.DOM.XmlOptions</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
><P
>Common useful options
</P
><P
>Version : $Id: XmlOptions.hs,v 1.1 2006<EM
>11</EM
>09 20:27:42 hxml Exp $
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3AinputOptions"
>inputOptions</A
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ArelaxOptions"
>relaxOptions</A
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AoutputOptions"
>outputOptions</A
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgeneralOptions"
>generalOptions</A
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AversionOptions"
>versionOptions</A
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AshowOptions"
>showOptions</A
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AselectOptions"
>selectOptions</A
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>] -&gt; [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)] -&gt; [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AremoveOptions"
>removeOptions</A
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>] -&gt; [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)] -&gt; [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AoptionIsSet"
>optionIsSet</A
> :: <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="Text-XML-HXT-DOM-TypeDefs.html#t%3AAttributes"
>Attributes</A
> -&gt; <A HREF="/usr/local/share/doc/ghc/libraries/ghc-prim/GHC-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AisTrueValue"
>isTrueValue</A
> :: <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="/usr/local/share/doc/ghc/libraries/ghc-prim/GHC-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AinputOptions"
></A
><B
>inputOptions</B
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
><TD CLASS="declbut"
><A HREF="src/Text-XML-HXT-DOM-XmlOptions.html#inputOptions"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>commonly useful options for XML input
</P
><P
>can be used for option definition with haskell getopt
</P
><P
>defines options: <TT
>a_trace</TT
>, <TT
>a_proxy</TT
>, <TT
>a_use_curl</TT
>, <TT
>a_do_not_use_curl</TT
>, <TT
>a_options_curl</TT
>, <TT
>a_encoding</TT
>,
 <TT
>a_issue_errors</TT
>, <TT
>a_do_not_issue_errors</TT
>, <TT
>a_parse_html</TT
>, <TT
>a_parse_by_mimetype</TT
>, <TT
>a_tagsoup</TT
> <TT
>a_issue_warnings</TT
>, <TT
>a_do_not_issue_warnings</TT
>,
 <TT
>a_parse_xml</TT
>, <TT
>a_validate</TT
>, <TT
>a_do_not_validate</TT
>, <TT
>a_canonicalize</TT
>, <TT
>a_do_not_canonicalize</TT
>,
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3ArelaxOptions"
></A
><B
>relaxOptions</B
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
><TD CLASS="declbut"
><A HREF="src/Text-XML-HXT-DOM-XmlOptions.html#relaxOptions"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>available Relax NG validation options
</P
><P
>defines options
 <TT
>a_check_restrictions</TT
>, <TT
>a_validate_externalRef</TT
>, <TT
>a_validate_include</TT
>, <TT
><A HREF="Text-XML-HXT-DOM-XmlKeywords.html#v%3Aa_do_not_check_restrictions"
>a_do_not_check_restrictions</A
></TT
>,  
 <TT
>a_do_not_validate_externalRef</TT
>, <TT
>a_do_not_validate_include</TT
>
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AoutputOptions"
></A
><B
>outputOptions</B
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
><TD CLASS="declbut"
><A HREF="src/Text-XML-HXT-DOM-XmlOptions.html#outputOptions"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>commonly useful options for XML output
</P
><P
>defines options: <TT
>a_indent</TT
>, <TT
>a_output_encoding</TT
>, <TT
>a_output_file</TT
>, <TT
>a_output_html</TT
>
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AgeneralOptions"
></A
><B
>generalOptions</B
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
><TD CLASS="declbut"
><A HREF="src/Text-XML-HXT-DOM-XmlOptions.html#generalOptions"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>commonly useful options
</P
><P
>defines options: <TT
>a_verbose</TT
>, <TT
>a_help</TT
>
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AversionOptions"
></A
><B
>versionOptions</B
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
><TD CLASS="declbut"
><A HREF="src/Text-XML-HXT-DOM-XmlOptions.html#versionOptions"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>defines <TT
>a_version</TT
> option
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AshowOptions"
></A
><B
>showOptions</B
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
><TD CLASS="declbut"
><A HREF="src/Text-XML-HXT-DOM-XmlOptions.html#showOptions"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>debug output options
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AselectOptions"
></A
><B
>selectOptions</B
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>] -&gt; [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)] -&gt; [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
><TD CLASS="declbut"
><A HREF="src/Text-XML-HXT-DOM-XmlOptions.html#selectOptions"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>select options from a predefined list of option desciptions
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AremoveOptions"
></A
><B
>removeOptions</B
> :: [<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>] -&gt; [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)] -&gt; [<A HREF="/usr/local/share/doc/ghc/libraries/base/System-Console-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> (<A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
>)]</TD
><TD CLASS="declbut"
><A HREF="src/Text-XML-HXT-DOM-XmlOptions.html#removeOptions"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AoptionIsSet"
></A
><B
>optionIsSet</B
> :: <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="Text-XML-HXT-DOM-TypeDefs.html#t%3AAttributes"
>Attributes</A
> -&gt; <A HREF="/usr/local/share/doc/ghc/libraries/ghc-prim/GHC-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="declbut"
><A HREF="src/Text-XML-HXT-DOM-XmlOptions.html#optionIsSet"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>check whether an option is set
</P
><P
>reads the value of an attribute, usually applied to a document root node,
 and checks if the value represents True. The following strings are interpreted
 as true: &quot;1&quot;, &quot;True&quot;, &quot;true&quot;, &quot;yes&quot;, &quot;Yes&quot;.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AisTrueValue"
></A
><B
>isTrueValue</B
> :: <A HREF="/usr/local/share/doc/ghc/libraries/base/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="/usr/local/share/doc/ghc/libraries/ghc-prim/GHC-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="declbut"
><A HREF="src/Text-XML-HXT-DOM-XmlOptions.html#isTrueValue"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>check whether a string represents True
</P
><P
>definition:
</P
><PRE
> isTrueValue	= (`elem` [&quot;1&quot;, &quot;True&quot;, &quot;true&quot;, &quot;Yes&quot;, &quot;yes&quot;])
</PRE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.3.0</TD
></TR
></TABLE
></BODY
></HTML
>