From 22890f408d6b15d09ef6876135e4527347f3cdf4 Mon Sep 17 00:00:00 2001 From: Mark Lentczner Date: Wed, 1 Sep 2010 05:29:32 +0000 Subject: update options documentation rewrote doc for --html added doc for --theme and --built-in-themes added --use-contents and --gen-contents --- doc/haddock.xml | 120 +++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 93 insertions(+), 27 deletions(-) (limited to 'doc') diff --git a/doc/haddock.xml b/doc/haddock.xml index a7688e4e..58047598 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -350,6 +350,15 @@ specified directory if the option is given), including the following: + + module.html + mini_module.html + + An HTML page for each + module, and a "mini" page for + each used when viewing in frames. + + index.html @@ -359,36 +368,33 @@ - haddock.css + doc-index.html + doc-index-X.html - The stylesheet used by the generated HTML. Feel - free to modify this to change the colors or - layout, or even specify your own stylesheet using the - option. + The alphabetic index, possibly split into multiple + pages if big enough. - haddock-util.js + frames.html - A small piece of JavaScript for collapsing sections - of the generated HTML. + The top level document when viewing in frames. - module.html + some.css + etc... - An HTML page for each - module. + Files needed for the themes used. Specify your themes + using the option. - doc-index.html - doc-index-XX.html + haddock-util.js - The index, split into two - (functions/constructors and types/classes, as per - Haskell namespaces) and further split - alphabetically. + Some JavaScript utilities used to implement some of the + dynamic features like collapsable sections, and switching to + frames view. @@ -634,6 +640,59 @@ $ pdflatex package.tex + + + + =path + + + Specify a theme to be used for HTML () + documentation. If given multiple times then the pages will use the + first theme given by default, and have alternate style sheets for + the others. The reader can switch between themes with browsers that + support alternate style sheets, or with the "Style" menu that gets + added when the page is loaded. If + no themes are specified, then just the default built-in theme + ("Ocean") is used. + + + The path parameter can be one of: + + + + + A directory: The base name of + the directory becomes the name of the theme. The directory + must contain exactly one + some.css file. + Other files, usually image files, will be copied, along with + the some.css + file, into the generated output directory. + + + A CSS file: The base name of + the file becomes the name of the theme. + + + The name of a built-in theme + ("Ocean" or "Classic"). + + + + + + + + + + + + Includes the built-in themes ("Ocean" and "Classic"). + Can be combined with . Note that order + matters: The first specified theme will be the default. + + + @@ -644,9 +703,7 @@ $ pdflatex package.tex =file - Specify a CSS stylesheet to use instead of the default one - that comes with Haddock. It should specify certain classes: - see the default stylesheet for details. + Deprecated aliases for @@ -748,31 +805,40 @@ $ pdflatex package.tex + + + + When generating HTML, do not generate an index. - Instead, redirect the Index link on each page to + Instead, redirect the Contents and/or Index link on each page to URL. This option is intended for - use in conjuction with for - generating a separate index covering multiple + use in conjuction with and/or + for + generating a separate contents and/or index covering multiple libraries. + + + + - Generate an HTML index containing entries pulled from - all the specified interfaces (interfaces are specified using + Generate an HTML contents and/or index containing entries pulled + from all the specified interfaces (interfaces are specified using or ). - This is used to generate a single index for multiple sets of - Haddock documentation. + This is used to generate a single contents and/or index for multiple + sets of Haddock documentation. -- cgit v1.2.3