diff options
author | Thomas Schilling <nominolo@googlemail.com> | 2008-10-24 17:04:08 +0000 |
---|---|---|
committer | Thomas Schilling <nominolo@googlemail.com> | 2008-10-24 17:04:08 +0000 |
commit | 9a55030410de644cb99e127f4eef2da6692836b6 (patch) | |
tree | 1a445e4b1b2b920e4f83e4dd1fe1f8c265baaaf4 /html/haddock-util.js | |
parent | f9f62bd4ff9079c57b13cf3346e2bf54419dce4a (diff) |
Enable framed view of the HTML documentation.
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.
Diffstat (limited to 'html/haddock-util.js')
-rw-r--r-- | html/haddock-util.js | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/html/haddock-util.js b/html/haddock-util.js index e5d6977e..364081f0 100644 --- a/html/haddock-util.js +++ b/html/haddock-util.js @@ -131,3 +131,9 @@ function perform_search(full) return ""; // should never be reached } } + +function setSynopsis(filename) { + if (parent.window.synopsis) { + parent.window.synopsis.location = filename; + } +} |