| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
Text.LaTeX.Guide
Description
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 writeGuide
with a value of type Backend.
More information about how this library works can be found at the code repository on GitHub:
- data Backend
- writeGuide :: Backend -> IO ()
- sectionList :: [String]
- otherResources :: [String]
- contributors :: [String]
- guideVersion :: Version
- updateGuide :: FilePath -> IO ()
Backends
writeGuide :: Backend -> IO () Source
Write in the current directory the LaTeX User's Guide using a determined backend.
Info
sectionList :: [String] Source
Ordered list of sections.
otherResources :: [String] Source
Other resources (images).
Files stored under the res directory.
contributors :: [String] Source
List of contributors. Please, insert your name here if you have contributed in some way to the guide.
guideVersion :: Version Source
The version of the guide. Based on the version of the package.
Editing
updateGuide :: FilePath -> IO () Source
Update files in the user hatex-guide directory, using
the files contained in a given FilePath.
More in detail, updateGuide fp sets the current directory
to fp, then it looks in the src and res directories
for the files specified by sectionList and otherResources
respectively. Then, it copies these files overwriting those
in the user hatex-guide directory. This way, the next time
that writeGuide is called it will use the updated files.