#2 [Docs] Include language & tutorial docs in plugin

open
Leif Frenzel
None
5
2008-02-17
2005-10-07
Tony O'Hagan
No

It would be fantastic if the eclipse plugin included
the full HTML documentation for the Haskell language
and any available language tutorials.

This would mean that we can just point students at a
single plugin URL to install everything required to
learn and use Haskell from within eclipse. Having a
complete copy of the docs as part of eclipse is also
very convenient for doc upgrades. Using the web site
docs can be a problem when student network performance
is slow or when I'm mobile with the laptop.

This sounds to me like a minimal effort but very high
value feature for the plugin. Many other language
plugins take this appraoch (e.g. ANTLR).

Thanks very much for Haskell Eclipse!
Tony.

Discussion

  • Leif Frenzel
    Leif Frenzel
    2007-10-04

    • assigned_to: nobody --> leiffrenzel
     
  • Leif Frenzel
    Leif Frenzel
    2007-10-04

    Logged In: YES
    user_id=873711
    Originator: NO

    [I know this is very old, sorry :-(]

    Good point. I think we should at least be able to put in some pointers to the latest GHC libs docs. On the other hand, copying in the HTML docs themselves wouldn't be good, because users could be using any version of the compiler, and that version might not be in sync with what HTML files we included.

    For Haskell tutorials etc., this looks more doable, but we have to consider some license issues.

     
  • Leif Frenzel
    Leif Frenzel
    2007-10-04

    • summary: Include language & tutorial docs in plugin --> [Docs] Include language & tutorial docs in plugin
     
  • Leif Frenzel
    Leif Frenzel
    2008-02-17

    • milestone: 395993 -->
     
  • Leif Frenzel
    Leif Frenzel
    2008-02-17

    Logged In: YES
    user_id=873711
    Originator: NO

    Moving to backlog tracker.

    For the Haddock docs, I think the sensible solution is to introduce a configurable docs location (similar to JavaDoc locations in JDT). If users have downloaded the haddocks, they can point that docs location to the downloaded file/folder. If not, they can leave it as online docs location, or disable it completely.