aboutsummaryrefslogtreecommitdiff
path: root/src
Commit message (Collapse)AuthorAgeFilesLines
...
* Remove the complex substitutions and add more command line flags instead.Duncan Coutts2006-01-232-61/+68
| | | | | | | | | | | | | | | | | | | Instead of incomprehensable URL substitutions like ${MODULE/./-|?m=%} we now use three seperate command line flags for the top level, per-module and per-entity source and wiki links. They are: --source-base, --source-module, --source-entity --comments-base, --comments-module, --comments-entity We leave -s, --source as an alias for --source-module which is how that option behaved previously. The long forms of the substitutions are still available, ${FILE} ${MODULE} etc and the only non-trivial substitution is ${MODULE/./c} to replace the '.' characters in the module name with any other character c. eg ${MODULE/./-} Seperating the source and wiki url flags has the added bonus that they can be turned on or off individually. So users can have per-module links for example without having to also have per-entity links.`
* Extend URL variable expansion syntax and add source links to the contents pageDuncan Coutts2006-01-223-50/+89
| | | | | | | | | | | | | | | | | | | | | | | | | Like the wiki link on the contents and index page, add a source code link too. Extend the wiki & source URL variable expansion syntax. The original syntax was: %F for the source file name (the .hs version only, not the .lhs or .hs.pp one) %M for the module name (with '.' replaced by '/') The new syntax is: %F or %{FILE} for the original source file name %M or %{MODULE} for the module name (no replacements) %N or %{NAME} for the function/type export name %K or %{KIND} for a type/value flag "t" or "v" with these extensions: %{MODULE/./c} to replace the '.' module seperator with any other char c %{VAR|some text with the % char in it} which means if the VAR is not in use in this URL context then "" else replace the given text with the '%' char replaced by the string value of the VAR. This extension allows us to construct URLs wit optional parts, since the module/file name is not available for the URL in the contents/index pages and the value/type name is not available for the URL at the top level of each module.
* Teach haddock about line pragmas and add accurate source code linksDuncan Coutts2006-01-219-177/+238
| | | | | | | | | | | | | | | | | | | | | Teach haddock about C and Haskell style line pragmas. Extend the lexer/parser's source location tracking to include the file name as well as line/column. This way each AST item that is tagged with a SrcLoc gets the original file name too. Use this original file name to add source links to each exported item, in the same visual style as the wiki links. Note that the per-export source links are to the defining module rather than whichever module haddock pretends it is exported from. This is what we want for source code links. The source code link URL can also contain the name of the export so one could implement jumping to the actual location of the function in the file if it were linked to an html version of the source rather than just plain text. The name can be selected with the %N wild card. So for linking to the raw source code one might use: --source=http://darcs/haskell.org/foo/%F Or for linking to html syntax highlighted code: --source=http://darcs/haskell.org/foo/%M.html#%N
* Rewrite pathJoin to only add a path separator when necessary.Duncan Coutts2006-01-191-4/+7
| | | | | | When the path ends in a file seperator there is no need to add another. Now using "--wiki=http://blah.com/foo/" should do the right thing. (Code snippet adapted from Isaac's FilePath package.)
* Add an optional wiki link for each top level exported name.Duncan Coutts2006-01-192-75/+105
| | | | | | | | | | | | | | 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.
* Add a --wiki=URL flag to add a per-module link to a correspondng wiki page.Duncan Coutts2006-01-172-14/+40
| | | | | | | | So each html page gets an extra link (placed next to the source code and contents links) to a corresponding wiki page. The idea is to let readers contribute their own notes, examples etc to the documentation. Also slightly tidy up the code for the --source option.
* First cut of Cabal build systemsimonmar2005-10-145-155/+8
|
* [haddock @ 2005-10-10 15:02:55 by simonmar]simonmar2005-10-101-2/+2
| | | | | | extractRecSel: ignore non-record constructors (fixes a crash when using datatypes with a mixture of record and non-record style constructors).
* [haddock @ 2005-08-04 15:59:30 by simonmar]simonmar2005-08-041-3/+3
| | | | replace mingw tests with $(Windows)
* [haddock @ 2005-06-27 14:46:40 by simonmar]simonmar2005-06-271-2/+4
| | | | | | name hierarchical HTML files as A-B-C.html instead of A.B.C.html. The old way confused Apache because the extensions are sometimes interpreted as having special meanings.
* [haddock @ 2005-06-16 08:14:12 by simonmar]simonmar2005-06-161-1/+1
| | | | wibble
* [haddock @ 2005-06-15 15:43:21 by simonmar]simonmar2005-06-151-3/+4
| | | | Allow "licence" as an alternate spelling of "license"
* [haddock @ 2005-05-21 12:35:29 by panne]panne2005-05-211-2/+6
| | | | Warning/versionitis police
* [haddock @ 2005-05-18 12:41:59 by ross]ross2005-05-181-23/+17
| | | | fix 3 bugs in --use-package, and document it.
* [haddock @ 2005-03-09 08:28:39 by wolfgang]wolfgang2005-03-091-1/+6
| | | | | Hack haddock's lexer to accept the output from Apple's broken version of cpp (Apple's cpp leaves #pragma set_debug_pwd directives in it's output).
* [haddock @ 2005-03-01 17:16:40 by simonmar]simonmar2005-03-011-30/+48
| | | | | | 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-19/+20
| | | | | | | | | | | | | | | 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 @ 2005-02-04 13:36:05 by ross]ross2005-02-042-2/+37
| | | | | | | sort lists of instances by - arity of the type constructors (so higher-kinded instances come first) - name of the class - argument types
* [haddock @ 2005-02-04 12:15:52 by simonmar]simonmar2005-02-042-3/+5
| | | | | | Add attribute #not-home, to indicate that the current module should not be considered to be a home module for the each entity it exports, unless there is no other module that exports the entity.
* [haddock @ 2005-02-04 12:03:31 by simonmar]simonmar2005-02-041-1/+1
| | | | | Fix bug in renameExportItems that meant links in instances weren't being renamed properly.
* [haddock @ 2005-02-03 16:17:37 by ross]ross2005-02-031-1/+1
| | | | fix typo for < 6.3
* [haddock @ 2005-02-03 13:42:19 by simonmar]simonmar2005-02-031-24/+121
| | | | | | | | | | | | - add --ignore-all-exports flag, which behaves as if every module has the ignore-exports attribute (requested by Chris Ryder). - add --hide option to hide a module on the command line. - add --use-package option to get Haddock info for a package from ghc-pkg (largely untested). - remove reexports from the .haddock file, they aren't used any more.
* [haddock @ 2005-02-02 16:23:00 by simonmar]simonmar2005-02-029-247/+376
| | | | | | | | | | | | | | | | | | | | | | Revamp the linking strategy in Haddock. Now name resolution is done in two phases: - first resolve everything to original names, like a Haskell compiler would. - then, figure out the "home" location for every entity, and point all the links to there. The home location is the lowest non-hidden module in the import hierarchy that documents the entity. If there are multiple candidates, one is chosen at random. Also: - Haddock should not generate any HTML with dangling links any more. Unlinked references are just rendered as plain text. - Error reporting is better: if we can't find a link destination for an entity reference, we now emit a warning.
* [haddock @ 2005-01-28 23:19:39 by krasimir]krasimir2005-01-281-0/+4
| | | | import Foreign/Foreign.C are required for Windows
* [haddock @ 2005-01-16 15:41:21 by panne]panne2005-01-1612-109/+62
| | | | Cleaned up imports and dropped support for GHC < 5.03, it never worked, anyway.
* [haddock @ 2005-01-16 14:37:10 by panne]panne2005-01-165-34/+24
| | | | Refactored Text.PrettyPrint legacy hell into a separate module.
* [haddock @ 2005-01-16 14:22:44 by panne]panne2005-01-161-1/+1
| | | | Added the last missing "flip" to get identical HTML output as previous versions.
* [haddock @ 2005-01-16 14:14:39 by panne]panne2005-01-162-2/+2
| | | | Data.Map.unions is left-biased.
* [haddock @ 2005-01-16 12:58:03 by panne]panne2005-01-165-6/+6
| | | | | Correctly handle the new order of arguments for the combining function given to fromListWith.
* [haddock @ 2005-01-16 12:18:26 by panne]panne2005-01-161-1/+0
| | | | Trim imports
* [haddock @ 2005-01-15 18:44:45 by panne]panne2005-01-1511-150/+229
| | | | | | | | | | Make Haddock compile again after the recent base package changed. The Map/Set legacy hell has been factored out, so that all modules can simply use the new non-deprecated interfaces. Probably a lot of things can be improved by a little bit of Map/Set/List algebra, this can be done later if needed. Small note: Currently the list of instances in HTML code is reversed. This will hopefully be fixed later.
* [haddock @ 2005-01-13 14:43:41 by ross]ross2005-01-131-1/+1
| | | | also allow uppercase X in hexadecimal character references (like SGML)
* [haddock @ 2005-01-13 11:41:33 by ross]ross2005-01-131-3/+7
| | | | | recognize SGML-style numeric character references &#ddd; or &#xhhhh; and translate them into Chars.
* [haddock @ 2005-01-11 10:44:37 by simonmar]simonmar2005-01-111-2/+2
| | | | Remove string gap
* [haddock @ 2005-01-10 19:18:22 by ross]ross2005-01-101-1/+6
| | | | | | | | | | Render non-ASCII characters using numeric character references, to simplify charset issues. There's a META tag saying the charset is UTF-8, but GHC outputs characters as raw bytes. Ideally we need an encoding on the input side too, primarily in comments, because source files containing non-ASCII characters aren't portable between locales.
* [haddock @ 2005-01-04 16:15:51 by simonmar]simonmar2005-01-041-3/+16
| | | | parser fix: allow qualified specialids.
* [haddock @ 2004-11-01 16:39:01 by panne]panne2004-11-011-5/+0
| | | | Revert previous commit: It's Network.URI which should be changed, not Haddock.
* [haddock @ 2004-10-28 16:01:51 by krasimir]krasimir2004-10-281-0/+5
| | | | update for ghc-6.3+
* [haddock @ 2004-10-23 19:54:00 by panne]panne2004-10-231-5/+6
| | | | | Improved the Cygwin/MinGW chaos a little bit. There is still confusion about host platform vs. target platform...
* [haddock @ 2004-09-24 07:04:38 by panne]panne2004-09-241-7/+12
| | | | | | | | Switched the default state for instances and the module hierarchy to non-collapsed. This can be reversed when we finally use cookies from JavaScript to have a more persistent state. Previously going back and forth in the documentation was simply too annoying because everything was collapsed again and therefore the documentation was not easily navigatable.
* [haddock @ 2004-08-31 13:09:42 by simonmar]simonmar2004-08-312-13/+18
| | | | Avoid GHC/shell versionitis and create Version.hs
* [haddock @ 2004-08-30 15:44:59 by sof]sof2004-08-301-1/+5
| | | | escape HADDOCK_VERSION double quotes on all platforms when compiling with <=6.0.x
* [haddock @ 2004-08-26 20:08:49 by panne]panne2004-08-261-1/+1
| | | | | | | | SGML is dead, long live DocBook XML! Note: The BuildRequires tags in the spec files are still incomplete and the documentation about the DocBook tools needs to be updated, too. Stay tuned...
* [haddock @ 2004-08-25 17:15:42 by sof]sof2004-08-251-1/+5
| | | | backquote HADDOCK_VERSION defn for <= ghc-6.0.x; believe this is only needed under mingw
* [haddock @ 2004-08-12 12:08:23 by simonmar]simonmar2004-08-122-3/+2
| | | | Avoid using string-gap tricks.
* [haddock @ 2004-08-10 14:33:45 by simonmar]simonmar2004-08-102-3/+8
| | | | Fixes to installation under Windows.
* [haddock @ 2004-08-10 14:09:57 by simonmar]simonmar2004-08-102-4/+5
| | | | Fixes for DevHelp/HtmlHelp following introduction of short module description.
* [haddock @ 2004-08-09 11:55:05 by simonmar]simonmar2004-08-099-131/+384
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add support for a short description for each module, which is included in the contents. The short description should be given in a "Description: " field of the header. Included in this patch are changes that make the format of the header a little more flexible. From the comments: -- all fields in the header are optional and have the form -- -- [spaces1][field name][spaces] ":" -- [text]"\n" ([spaces2][space][text]"\n" | [spaces]"\n")* -- where each [spaces2] should have [spaces1] as a prefix. -- -- Thus for the key "Description", -- -- > Description : this is a -- > rather long -- > -- > description -- > -- > The module comment starts here -- -- the value will be "this is a .. description" and the rest will begin -- at "The module comment". The header fields must be in the following order: Module, Description, Copyright, License, Maintainer, Stability, Portability. Patches submitted by: George Russell <ger@informatik.uni-bremen.de>, with a few small changes be me, mostly to merge with other recent changes. ToDo: document the module header.
* [haddock @ 2004-08-09 11:03:04 by simonmar]simonmar2004-08-091-0/+69
| | | | | | Add FormatVersion Patch submitted by: George Russell <ger@informatik.uni-bremen.de>
* [haddock @ 2004-08-03 21:07:58 by panne]panne2004-08-031-6/+7
| | | | Improved spacing of dynamic module tree
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-03 13:44:41 +0000