diff options
author | Duncan Coutts <duncan.coutts@worc.ox.ac.uk> | 2006-01-19 20:17:59 +0000 |
---|---|---|
committer | Duncan Coutts <duncan.coutts@worc.ox.ac.uk> | 2006-01-19 20:17:59 +0000 |
commit | 17adfda903a5bf9051159beb61cb37dc084eb8b4 (patch) | |
tree | b0e92093c71b9434a1f6f8f09a6b721c6e8b19f9 /src/Main.hs | |
parent | e06e2da2b14e133c0994706fcd34d8d40935f2c0 (diff) |
Add an optional wiki link for each top level exported name.
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.
Diffstat (limited to 'src/Main.hs')
-rw-r--r-- | src/Main.hs | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/Main.hs b/src/Main.hs index 2d6408f0..70c2dd58 100644 --- a/src/Main.hs +++ b/src/Main.hs @@ -235,11 +235,13 @@ run flags files = do die ("-h cannot be used with --gen-index or --gen-contents") when (Flag_GenContents `elem` flags) $ do - ppHtmlContents odir title package maybe_html_help_format maybe_index_url visible_read_ifaces prologue + ppHtmlContents odir title package maybe_html_help_format + maybe_index_url maybe_wiki_url visible_read_ifaces prologue copyHtmlBits odir libdir css_file when (Flag_GenIndex `elem` flags) $ do - ppHtmlIndex odir title package maybe_html_help_format maybe_contents_url visible_read_ifaces + ppHtmlIndex odir title package maybe_html_help_format + maybe_contents_url maybe_wiki_url visible_read_ifaces copyHtmlBits odir libdir css_file when (Flag_GenContents `elem` flags && Flag_GenIndex `elem` flags) $ do |