
All, People were taking recently about how to make it easier for people to contribute to the official documentation. Well here's a suggestion: We have the Haddock-generated pages link to a wiki. Each module would link to one page of a wiki. On that wiki page people could add their extended documentation, notes, example code snippets, pitfalls etc. The PHP online docs have a similar (albeit more integrated) solution where each module has user-contributed notes at the end of each page. For example here's the documentation for the PHP array module: http://www.php.net/manual/en/ref.array.php Actually having a wiki might be better than the PHP solution where they have a series of attributed contributions since with a wiki an 'editor' can re-arrange the notes to improve the organisation. The nice thing about most wikis is that if you link to a page that doesn't yet exist then it can be created. So the wiki does not even need to be prepared before the docs get pointed at it. The first person to add notes for a module will just create the corresponding wiki page. So we'd want to patch haddock to generate the links (controlled by an extra flag I guess). So I expect that there should be at least a top level link to the corresponding wiki page. How about links for each documented entity (eg functions)? That could generate links with anchors #functionName. If there were no such anchor then the browser just defaults to the top of the page which is ok. How would we put the wiki links in for each documented entity? How about a little [wiki] icon (with a suitable mouse-over descriptive text) in the right margin of the name. eg: rawSystem :: String -> [String] -> IO ExitCode [wiki] The computation ... Other suggestions? Just use a top level per-module wiki link? Duncan

Hi,
We have the Haddock-generated pages link to a wiki. Each module would link to one page of a wiki. On that wiki page people could add their extended documentation, notes, example code snippets, pitfalls etc.
I started some of this a few months ago: http://www.haskell.org/hawiki/LibraryDocumentation Perhaps that might be a basis for starting of this new wiki page set? If the extended function information is in some logical place, with proper anchors in the source, then I'll set hoogle (http://haskell.org/hoogle) up to give that as the documentation link. It already uses the wiki documentation for some modules, i.e. try searching for getCPUTime. Thanks Neil

Hello Neil, Sunday, January 15, 2006, 9:16:53 PM, you wrote:
We have the Haddock-generated pages link to a wiki. Each module would link to one page of a wiki. On that wiki page people could add their extended documentation, notes, example code snippets, pitfalls etc.
NM> I started some of this a few months ago: NM> http://www.haskell.org/hawiki/LibraryDocumentation can you move these pages to the new wiki? NM> Perhaps that might be a basis for starting of this new wiki page set? NM> If the extended function information is in some logical place, with NM> proper anchors in the source, then I'll set hoogle NM> (http://haskell.org/hoogle) up to give that as the documentation link. NM> It already uses the wiki documentation for some modules, i.e. try NM> searching for getCPUTime. see the page for the "base" package, it contains links to several other pages -- Best regards, Bulat mailto:bulatz@HotPOP.com

On 15/01/06, Duncan Coutts
All,
People were taking recently about how to make it easier for people to contribute to the official documentation.
Well here's a suggestion:
We have the Haddock-generated pages link to a wiki. Each module would link to one page of a wiki. On that wiki page people could add their extended documentation, notes, example code snippets, pitfalls etc.
That sounds suspiciously similar to Fermat's Last Margin.

On Sun, 2006-01-15 at 17:57 +0000, Duncan Coutts wrote:
All,
People were taking recently about how to make it easier for people to contribute to the official documentation.
Well here's a suggestion:
We have the Haddock-generated pages link to a wiki. Each module would link to one page of a wiki. On that wiki page people could add their extended documentation, notes, example code snippets, pitfalls etc.
So we'd want to patch haddock to generate the links (controlled by an extra flag I guess). So I expect that there should be at least a top level link to the corresponding wiki page.
I've had a go at patching Haddock to put a link on the page for each module. It's controlled by an optional --wiki=URL flag. As an example, I used this with the (devel version of the) Gtk2Hs docs: http://haskell.org/gtk2hs/docs/devel/ For example this page: http://haskell.org/gtk2hs/docs/devel/Graphics-Rendering-Cairo-SVG.html links to: http://haskell.org/haskellwiki/Gtk2Hs/Graphics.Rendering.Cairo.SVG Seem reasonable? Duncan
participants (4)
-
Bulat Ziganshin
-
Duncan Coutts
-
Neil Mitchell
-
Samuel Bronson