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


-- | HaTeX User's Guide.
--   
--   The HaTeX User's Guide is a manual explaining the HaTeX library
--   (<a>http://hackage.haskell.org/package/HaTeX</a>). This library can be
--   used to output the guide in different formats. A compiled pdf version
--   of the latex output can be found at
--   <a>http://daniel-diaz.github.com/projects/hatex/hatex-guide.pdf</a>.
--   See the README file
--   (<a>https://github.com/Daniel-Diaz/hatex-guide/blob/master/README.md</a>)
--   for more details.
@package hatex-guide
@version 1.1.0.0


-- | The HaTeX User's Guide.
--   
--   This module generates the HaTeX User's Guides from its custom syntax
--   to any available format. This format is specified feeding the function
--   <a>writeGuide</a> with a value of type <a>Backend</a>.
--   
--   More information about how this library works can be found at the code
--   repository on GitHub:
--   
--   <a>https://github.com/Daniel-Diaz/hatex-guide</a>
module Text.LaTeX.Guide

-- | Available backends.
data Backend
LaTeX :: Backend
Wiki :: Backend

-- | Write in the current directory the LaTeX User's Guide using a
--   determined backend.
writeGuide :: Backend -> IO ()

-- | Ordered list of sections.
sectionList :: [String]

-- | Other resources (images).
--   
--   Files stored under the <i>res</i> directory.
otherResources :: [String]

-- | List of contributors. Please, insert your name here if you have
--   contributed in some way to the guide.
contributors :: [String]

-- | The version of the guide. Based on the version of the package.
guideVersion :: Version

-- | Update files in the user <i>hatex-guide</i> directory, using the files
--   contained in a given <a>FilePath</a>.
--   
--   More in detail, <tt>updateGuide fp</tt> sets the current directory to
--   <tt>fp</tt>, then it looks in the <tt>src</tt> and <tt>res</tt>
--   directories for the files specified by <a>sectionList</a> and
--   <a>otherResources</a> respectively. Then, it copies these files
--   overwriting those in the user <i>hatex-guide</i> directory. This way,
--   the next time that <tt>writeGuide</tt> is called it will use the
--   updated files.
updateGuide :: FilePath -> IO ()