| | 1 | |
| | 2 | |
| | 3 | = The user manual = |
| | 4 | |
| | 5 | GHC's user manual contains documentation intended for users of GHC. They are not interested in how GHC works; they just want to use it. |
| | 6 | |
| | 7 | The user manual is held in [[GhcFile(docs/user_guide)]], and is written in !DocBook format (.xml files). This allows us to typeset it as HTML pages, or as Latex. |
| | 8 | |
| | 9 | See also the [wiki:Building/Docs notes on building the documentation]. |
| | 10 | |
| | 11 | Notes on formatting: |
| | 12 | * Cross-links to Haddock library documtation for module `A.B` in package `foo` should be wrtten thus: |
| | 13 | {{{ |
| | 14 | <ulink url="../libraries/foo/A-B.html"> visible link text </ulink> |
| | 15 | }}} |
| | 16 | This relative path will link correctly when the user manual is installed locally, or on GHC's home page. Unfortunately, it won't link correctly in an in-place tree, but that's too bad. |
