aboutsummaryrefslogtreecommitdiff
path: root/html
Commit message (Collapse)AuthorAgeFilesLines
* added assoicated types and methods back into class declsMark Lentczner2010-05-041-1/+1
|
* adjust css for current markupMark Lentczner2010-05-031-6/+42
|
* tweak list cssMark Lentczner2010-04-041-6/+4
|
* clean up Doc formatting codeMark Lentczner2010-04-031-0/+6
| | | | | - add CSS for lists - renderToString now uses showHtml since prettyHtml messes up <pre> sections
* First, experimental XHTML renderingMark Lentczner2010-03-201-0/+286
| | | | | | | | | | | | | | | | | | switch to using the xhtml package copied Html.hs to Xhtml.hs and split into sub-modules under Haddock/Backends/Xhtml and detabify moved footer into div, got ready for iface change headers converted to semantic markup contents in semantic markup summary as semantic markup description in semantic markup, info block in header fixed factored out rendering so during debug it can be readable (see renderToString)
* Enable framed view of the HTML documentation.Thomas Schilling2008-10-243-0/+63
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch introduces: - A page that displays the documentation in a framed view. The left side will show a full module index. Clicking a module name will show it in the right frame. If Javascript is enabled, the left side is split again to show the modules at the top and a very short synopsis for the module currently displayed on the right. - Code to generate the mini-synopsis for each module and the mini module index ("index-frames.html"). - CSS rules for the mini-synopsis. - A very small amount of javascript to update the mini-synopsis (but only if inside a frame.) Some perhaps controversial things: - Sharing code was very difficult, so there is a small amount of code duplication. - The amount of generated pages has been doubled, since every module now also gets a mini-synopsis. The overhead should not be too much, but I haven't checked. Alternatively, the mini-synopsis could also be generated using Javascript if we properly annotate the actual synopsis.
* Make the max number of results 75 instead of 50, to allow map searching in ↵Neil Mitchell2007-01-121-1/+1
| | | | the base library to work
* Rewrite much of the index searching code, previously was too slow to execute ↵Neil Mitchell2007-01-122-9/+107
| | | | on the base library with IE, the new version guarantees less than O(log n) operations be performed, where n is the number in the list (before was always O(n))
* Add searching on the index pageNeil Mitchell2007-01-111-0/+27
|
* Rename haddock.js to haddock-util.jsSimon Marlow2006-10-111-0/+0
| | | | | | haddock.js will be run automatically by Windows when you type 'haddock' if it is found on the PATH, so rename to avoid confusion. Spotted by Adrian Hey.
* Add an optional wiki link for each top level exported name.Duncan Coutts2006-01-191-0/+25
| | | | | | | | | | | | | | In each module, for each "top level" exported entity we add a hyper link to a corresponding wiki page. The link url gets the name of the exported entity as a '#'-style anchor, so if there is an anchor in the page with that name then the users browser should jump directly to it. By "top level" we mean functions, classes, class members and data types (data, type, newtype), but not data constructors, class instances or data type class membership. The link is added at the right of the page and in a small font. Hopefully this is the right balance of visibility/distraction. We also include a link to the wiki base url in the contents and index pages.
* First cut of Cabal build systemsimonmar2005-10-141-6/+0
|
* [haddock @ 2005-03-01 17:16:40 by simonmar]simonmar2005-03-011-0/+4
| | | | | | Another attempt at lining up the package names on the contents page. Now, they line up with Konqueror, and almost line up with Firefox & IE (different layout in each case).
* [haddock @ 2005-02-28 16:22:08 by simonmar]simonmar2005-02-281-0/+15
| | | | | | | | | | | | | | | Attempt to fix the layout of the package names in the contents. Having tried just about everything, the only thing I can get to work reliably is to make the package names line up on a fixed offset from the left margin. This obviously isn't ideal, so anyone else that would like to have a go at improving it is welcome. One option is to remove the +/- buttons from the contents list and go back to a plain table. The contents page now uses CSS for layout rather than tables. It seems that most browsers have different interpretations of CSS layout, so only the simplest things lead to consistent results.
* [haddock @ 2004-08-03 21:07:58 by panne]panne2004-08-031-1/+1
| | | | Improved spacing of dynamic module tree
* [haddock @ 2004-08-03 20:47:46 by panne]panne2004-08-031-1/+1
| | | | Fixed CSS for button style. Note that only "0" is a valid measure without a unit!
* [haddock @ 2004-08-01 19:53:50 by krasimir]krasimir2004-08-012-0/+0
| | | | I forgot to add the new +/- images
* [haddock @ 2004-07-31 12:04:37 by krasimir]krasimir2004-07-315-8/+12
| | | | | make the DHtmlTree in contents page more portable. The +/- buttons are replaced with new images which looks more beatiful.
* [haddock @ 2004-07-30 22:15:45 by krasimir]krasimir2004-07-301-1/+1
| | | | | | | | more stuffs - support for separated compilation of packages - the contents page now uses DHTML TreeView - fixed copyFile bug
* [haddock @ 2004-07-04 15:15:55 by panne]panne2004-07-041-1/+1
| | | | | | | | Install pictures for +/- pictures, too (JPEG is a strange format for graphics like this, I would have expected GIF or PNG here.) Things look fine with Konqueror and Netscape on Linux now, the only downside is that the cursor doesn't change when positioned above the "button".
* [haddock @ 2004-07-01 11:08:57 by simonmar]simonmar2004-07-014-3/+4
| | | | | | Update to the +/- buttons: use a resized image rather than a <button>. Still seeing some strange effects in Konqueror, so might need to use a fixed-size image instead.
* [haddock @ 2004-03-27 09:57:57 by panne]panne2004-03-271-1/+1
| | | | Added the new-born haddock.js to the build process and the documentation.
* [haddock @ 2004-03-25 15:17:23 by simonmar]simonmar2004-03-252-0/+13
| | | | | | | | | | Add support for collaspible parts of the page, with a +/- button and a bit of JavaScript. Make the instances collapsible, and collapse them by default. This makes documentation with long lists of instances (eg. the Prelude) much easier to read. Maybe we should give other documentation sections the same treatment.
* [haddock @ 2003-11-28 12:09:58 by simonmar]simonmar2003-11-281-1/+19
| | | | | | Fix some of the problems with Haddock generating pages that are too wide. Now we only specify 'nowrap' when it is necessary to avoid a code box getting squashed up by the text to the right of it.
* [haddock @ 2003-11-05 15:15:59 by simonmar]simonmar2003-11-051-0/+15
| | | | | | | | | | | | | | | | | | | | | | | | Index overhaul: - no more separate type/class and variable/function indices - the index now makes a distinction between different entities with the same name. One example is a type constructor with the same name as a data constructor, but another example is simply a function with the same name exported by two different modules. For example, the index entry for 'catch' now looks like this: catch 1 (Function) Control.Exception 2 (Function) GHC.Exception, Prelude, System.IO, System.IO.Error making it clear that there are two different 'catch'es, but one of them is exported by several modules. - Each index page now has the index contents (A B C ...) at the top. Please let me know if you really hate any of this.
* [haddock @ 2003-09-10 08:24:32 by simonmar]simonmar2003-09-101-1/+0
| | | | | | | Install these files in $(datadir), not $(libdir), since they're architecture independent. Patch contributed by: Ian Lynagh <igloo@earth.li>.
* [haddock @ 2003-07-28 13:32:12 by simonmar]simonmar2003-07-281-0/+2
| | | | layout tweak.
* [haddock @ 2002-08-02 09:08:22 by simonmar]simonmar2002-08-021-0/+4
| | | | | | | The <TT> and <PRE> environments seem to use a font that is a little too small in IE. Compensate. (suggestion from Daan Leijen).
* [haddock @ 2002-06-03 14:17:49 by simonmar]simonmar2002-06-031-0/+173
| | | | | A debugging version of the style-sheet, which gives some tables coloured backgrounds so we can see what's going on.
* [haddock @ 2002-05-27 12:30:37 by simonmar]simonmar2002-05-271-0/+5
| | | | | | | | | - Put function arguments *before* the doc for the function, as suggested by Sven Panne. This looks nicer when the function documentation is long. - Switch to using bold for binders at the definition site, and use underline for keywords. This makes the binder stand out more.
* [haddock @ 2002-05-21 10:28:33 by simonmar]simonmar2002-05-211-54/+85
| | | | Rearrange a bit, and add support for tabular datatype rendering
* [haddock @ 2002-05-15 13:03:01 by simonmar]simonmar2002-05-151-9/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Reworking of the internals to support documenting function arguments (the Most Wanted new feature by the punters). The old method of keeping parsed documentation in a Name -> Doc mapping wasn't going to cut it for anntations on type components, where there's no name to attach the documentation to, so I've moved to storing all the documentation in the abstract syntax. Previously some of the documentation was left in the abstract syntax by the parser, but was later extracted into the mapping. In order to avoid having to parameterise the abstract syntax over the type of documentation stored in it, we have to parse the documentation at the same time as we parse the Haskell source (well, I suppose we could store 'Either String Doc' in the HsSyn, but that's clunky). One upshot is that documentation is now parsed eagerly, and documentation parse errors are fatal (but have better line numbers in the error message). The new story simplifies matters for the code that processes the source modules, because we don't have to maintain the extra Name->Doc mapping, and it should improve efficiency a little too. New features: - Function arguments and return values can now have doc annotations. - If you refer to a qualified name in a doc string, eg. 'IO.putStr', then Haddock will emit a hyperlink even if the identifier is not in scope, so you don't have to make sure everything referred to from the documentation is imported. - several bugs & minor infelicities fixed.
* [haddock @ 2002-04-29 15:56:39 by simonmar]simonmar2002-04-291-0/+7
| | | | Install the auxilliary bits
* [haddock @ 2002-04-29 15:37:32 by simonmar]simonmar2002-04-291-1/+1
| | | | syntax fix
* [haddock @ 2002-04-26 13:15:02 by simonmar]simonmar2002-04-261-1/+15
| | | | | | Move the explicit formatting of the little table for the stability/portability/maintainer info from the HTML into the CSS, and remove the explicit table size (just right-align it).
* [haddock @ 2002-04-25 14:20:12 by simonmar]simonmar2002-04-251-0/+0
| | | | Add the little lambda icon
* [haddock @ 2002-04-10 10:50:06 by simonmar]simonmar2002-04-101-2/+2
| | | | Use explicit 'px' suffix on pixel sizes; IE seems to prefer them
* [haddock @ 2002-04-05 16:32:19 by simonmar]simonmar2002-04-051-0/+5
| | | | | Add width property to the title, and add TD.children for the module contents page.
* [haddock @ 2002-04-05 14:18:41 by simonmar]simonmar2002-04-051-2/+2
| | | | remove underlines on visited links
* [haddock @ 2002-04-04 16:23:43 by simonmar]simonmar2002-04-041-0/+111
This is Haddock, my stab at a Haskell documentation tool. It's not quite ready for release yet, but I'm putting it in the repository so others can take a look. It uses a locally modified version of the hssource parser, extended with support for GHC extensions and documentation annotations.
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-02 21:49:18 +0000