| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
| |
Add root node to the table of contents. All modules in tree are not children of
the root
|
| |
|
|
| |
fix some bugs. Now I have got the entire libraries documentation in HtmlHelp 2.0 format.
|
| |
|
|
| |
Added support for DevHelp
|
| |
|
|
| |
HtmlHelp 1.x
|
| |
|
|
| |
Make DHtmlTree compatible with Mozila browser
|
| |
|
|
|
| |
make the DHtmlTree in contents page more portable. The +/- buttons are replaced
with new images which looks more beatiful.
|
| |
|
|
|
|
|
|
| |
more stuffs
- support for separated compilation of packages
- the contents page now uses DHTML TreeView
- fixed copyFile bug
|
| |
|
|
|
| |
bugfix. Move contentsHtmlFile, indexHtmlFile and subIndexHtmlFile functions to
HaddockUtil.hs module to make them accessible from HaddockHH2.hs
|
| |
|
|
| |
Add basic support for Microsoft HTML Help 2.0
|
| |
|
|
|
| |
A quote is a valid part of a Haskell identifier, but it would interfere with an
ECMA script string delimiter, so escape it there.
|
| |
|
|
|
|
| |
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.
|
| |
|
|
| |
Add a doctype for the contents page, too.
|
| |
|
|
| |
"type" is a required attribute of the "script" element
|
| |
|
|
| |
Remove all that indentation in the generated HTML to keep the file sizes down.
|
| |
|
|
|
|
|
|
|
|
| |
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.
|
| |
|
|
| |
Fix bug in index generation
|
| |
|
|
|
|
| |
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.
|
| |
|
|
|
|
|
|
|
| |
Go back to producing just the documentation section, rather than just
the synopsis section, for a module with no documentation annotations.
One reason is that the synopsis section tries to link each entity to
its documentation on the same page. Also, the doc section anchors
each entity, and it lists instances which the synopsis doesn't.
|
| |
|
|
| |
copyright update
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Re-exporting names from a different package is problematic, because we
don't have access to the full documentation for the entity. Currently
Haddock just ignores entities with no documentation, but this results
in bogus-looking empty documentation for many of the modules in the
haskell98 package. So:
- the documentation will now just list the name, as a link
pointing to the location of the actual documentation.
- now we don't attempt to link to these re-exported entities if
they are referred to by the current module.
Additionally:
- If there is no documentation in the current module, include
just the Synopsis section (rather than just the documentation
section, as it was before). This just looks nicer and was on
the TODO list.
|
| |
|
|
|
|
|
|
|
| |
- Include the OptHide setting in the interface, so we don't include
hidden modules in the combined index/contents.
- Add a -k/--package flag to set the package name for the current set
of modules. The package name for each module is now shown in the
right-hand column of the contents, in a combined contents page.
|
| |
|
|
|
| |
Remove the 'Parent' button - it is of dubious use, and often points
into thin air.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
- Add definition lists, marked up like this:
-- | This is a definition list:
--
-- [@foo@] The description of @foo@.
--
-- [@bar@] The description of @bar@.
Cunningly, the [] characters are not treated specially unless a [ is
found at the beginning of a paragraph, in which case the ] becomes
special in the following text.
- Add --use-contents and --gen-contents, along the lines of
--use-index and --gen-index added yesterday. Now we can generate a
combined index and contents for the whole of the hierarchical
libraries, and in theory the index/contents on the system could
be updated as new packages are added.
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
Support for generating a single unified index for several packages.
--use-index=URL turns off normal index generation, causes Index
links to point to URL.
--gen-index generates an combined index from the specified
interfaces.
Currently doesn't work exactly right, because the interfaces don't
contain the iface_reexported info. I'll need to fix that up.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|
| |
|
|
|
|
|
|
|
|
|
| |
- Remove the emboldening of index entries for defining locations.
This isn't useful, and breaks abstractions.
- If an entity is re-exported by a module but the module doesn't
include documentation for that entity (perhaps because it is
re-exported by 'module M'), then don't attempt to hyperlink to
the documentation from the index. Instead, just list that module
in the index, to indicate that the entity is exported from there.
|
| |
|
|
| |
support for i-parameters + zip comprehensions
|
| |
|
|
|
|
| |
I'm not sure why, but it seems that the index entries for non-defining
occurrences of entities did not have an anchor - the link just pointed
to the module. This fixes it.
|
| |
|
|
| |
Don't print parentheses around one-element contexts
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Rename instances based on the import_env for the module in which they
are to be displayed. This should give, in many cases, better links
for the types and classes mentioned in the instance head.
This involves keeping around the import_env in the iface until the
end, because instances are not collected up until all the modules have
been processed. Fortunately it doesn't seem to affect performance
much.
Instance heads are now attached to ExportDecls, rather than the HTML
backend passing around a separate mapping for instances. This is a
cleanup.
|
| |
|
|
| |
Update to avoid using hslibs with GHC >= 5.04
|
| |
|
|
|
| |
Differentiate links to types/classes from links to
variables/constructors with a prefix ("t:" and "v:" respectively).
|
| |
|
|
|
|
| |
Two small fixes to make the output valid HTML 4.01 (transitional).
Thanks to Malcolm Wallace for pointing out the problems.
|
| |
|
|
| |
Only omit the module contents when there are no section headings at all.
|
| |
|
|
|
| |
Don't turn a single DocCodeBlock into a DocMonospaced, because that
tends to remove the line breaks in the code.
|
| |
|
|
| |
Escape fragments. This fixes e.g. links to operators.
|
| |
|
|
|
| |
Don't append a fragment to non-defining index entries, only documents
with a defining occurrence have a name anchor.
|
| |
|
|
|
| |
* Add varsyms and consyms to index
* Exclude empty entries from index
|
| |
|
|
|
|
|
| |
Remove <P>..</P> from around list items, to reduce excess whitespace
between the items of bulleted and ordered lists.
(Suggestion from Daan Leijen).
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Patch to allow simple hyperlinking to an arbitrary location in another
module's documentation, from Volker Stolz.
Now in a doc comment:
#foo#
creates
<a name="foo"></a>
And you can use the form "M\#foo" to hyperlink to the label 'foo' in
module 'M'. Note that the backslash is necessary for now.
|
| |
|
|
| |
Patches to quieten ghc -Wall, from those nice folks at Galois.
|
| |
|
|
| |
Allow special id's ([], (), etc.) to be used in an import declarations.
|
| |
|
|
|
| |
Tweaks to the MS Help support: the extra files are now only generated
if you ask for them (--ms-help).
|
| |
|
|
| |
Fix for rendering of the (->) type constructor, from Ross Paterson.
|
| |
|
|
| |
'Microsoft HTML Help' support
|
| |
|
|
|
|
| |
Don't require that the list type comes from "Prelude" for it to be
treated as special syntax (sometimes it comes from Data.List or maybe
even GHC.Base).
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
When reading an interface, allow a file path offset to be specified
which represents the path to the HTML files for the modules specified
by that interface. The path may be either relative (to the location
of the HTML for this package), or absolute.
The syntax is
--read-interface=PATH,FILE
where PATH is the path to the HTML, and FILE is the filename
containing the interface.
|
| |
|
|
|
|
| |
When we have a single code block paragraph, don't place it in
<pre>..</pre>, just use <tt>..</tt> to avoid generating extra vertical
white space in some browsers.
|
| |
|
|
|
| |
Add support for a "prologue" - a description for the whole library,
placed on the contents page before the module list.
|
| |
|
|
| |
portability nit
|
