From 3f440d21fa3847ab30a940013ceffb99ae3497b9 Mon Sep 17 00:00:00 2001 From: JP Moresmau Date: Fri, 18 Feb 2011 16:43:07 +0100 Subject: [PATCH] fixed documentation a bit --- .../net.sf.eclipsefp.haskell_2.0.3.txt | 3 + .../html/gettingStarted.html | 340 +++++++++--------- .../html/installation.html | 32 ++ .../html/overview.html | 104 +++--- .../html/tips/tips.html | 63 ++-- .../html/userGuide/cabaleditor.html | 10 +- .../html/userGuide/compilersInterpreters.html | 96 ++--- .../html/userGuide/editor.html | 84 ++--- .../html/userGuide/wizards.html | 60 ++-- .../toc_haskell.xml | 35 +- 10 files changed, 423 insertions(+), 404 deletions(-) create mode 100644 net.sf.eclipsefp.haskell.doc.user/html/installation.html diff --git a/docs/releasenotes/net.sf.eclipsefp.haskell_2.0.3.txt b/docs/releasenotes/net.sf.eclipsefp.haskell_2.0.3.txt index 51ec9ad7b..799aaea08 100644 --- a/docs/releasenotes/net.sf.eclipsefp.haskell_2.0.3.txt +++ b/docs/releasenotes/net.sf.eclipsefp.haskell_2.0.3.txt @@ -23,6 +23,7 @@ Fixes: - When launching GHCi, only hidden packages are added via -package - When running a haskell file with the "launch the selected ressource or active editor", if an existing launch configuration exists, it it reused. - When an existing launch configuration is found for a ressource, update executable to be the current executable for the delegate + - Documentation has been updated to not say things that are now totally wrong :-) Features: - Interface to cabal install via contextual action on project @@ -60,6 +61,8 @@ Features: - Occurrences shown in current files (based on lexer, so internal functions with the same name will be highlighted too) + - Set Cabal flags values in Project preferences. + Internal: Upgrade notes: diff --git a/net.sf.eclipsefp.haskell.doc.user/html/gettingStarted.html b/net.sf.eclipsefp.haskell.doc.user/html/gettingStarted.html index 659381696..0bbe9ea7c 100644 --- a/net.sf.eclipsefp.haskell.doc.user/html/gettingStarted.html +++ b/net.sf.eclipsefp.haskell.doc.user/html/gettingStarted.html @@ -1,178 +1,162 @@ -

A quick start guide to Haskell programming with Eclipse

- -

This document shows how you would create and run the 'Hello World' -application in Eclipse with Haskell support. It also explains some of the -main user interface elements in Eclipse. The focus is on helping -developers who are not familiar with Eclipse to quickly get started -with it as an IDE that supports Haskell development.

- -

-

-

- -

Note: This is work in progress, which means that some of the features -described here may not yet be in place.

- -

Preparations

- - - -

Create and edit source files

- -

- Add source files to the project source folder. -

- - - -

- If you give the files a Haskell-specific extension (like .hs - or .lhs (for literate Haskell), you can open the files with - the Haskell source code editor from the Project Explorer - view.

-

- - - -

You can configure the editor in the main Preferences Dialog: - Select Window > Preferences from the menu and choose the - Functional Programming section.

- - - -

Run the application

- -

- You can launch the compiled executable of your Haskell programs from within - the IDE. -

- - - -

- Running a program creates a new Launch configuration for that - program. You can re-run a lauch configuration from the Run menu. - Clicking the Run-icon re-launches always the last launched configuration. -

- -

- If you choose Run ... from the menu, you get a dialog where you - can edit launch configurations. For example, you may want to add parameters - to the program launch. -

- -

- Console input and output are handled by the Console View (at the - bottom left of the workbench). You should see the 'Hello world' output - appear there, and if your program takes console input, the Console View - is where you can type in while developing. -

+

A quick start guide to Haskell programming with Eclipse

+ +

This document shows how you would create and run the 'Hello World' +application in Eclipse with Haskell support. It also explains some of the +main user interface elements in Eclipse. The focus is on helping +developers who are not familiar with Eclipse to quickly get started +with it as an IDE that supports Haskell development.

+ +

+

+

+ +

Note: This is work in progress, which means that some of the features +described here may not yet be in place.

+ +

Preparations

+ + + +

Create and edit source files

+ +

+ Add source files to the project source folder. +

+ +

If you have selected "executable" in the new project wizard page, a + Main.hs file should have been created for you. + Otherwise you can create a new Haskell module from the menu (File > New > Haskell > Haskell Module). + The second page of the wizard lets you choose in which component the module will be present. You can have a project with several components, and not all modules are present in all components. +

+ +

+ If you give the files a Haskell-specific extension (like .hs + or .lhs (for literate Haskell), you can open the files with + the Haskell source code editor from the Project Explorer + view.

+

+ + + +

You can configure the editor in the main Preferences Dialog: + Select Window > Preferences from the menu and choose the + General > Editors > Text Editors section.

+ + + +

Run the application

+ +

+ You can launch the compiled executable of your Haskell programs from within + the IDE. +

+ + + +

+ Running a program creates a new Launch configuration for that + program. You can re-run a lauch configuration from the Run menu. + Clicking the Run-icon re-launches always the last launched configuration. +

+ +

+ If you choose Run ... from the menu, you get a dialog where you + can edit launch configurations. For example, you may want to add parameters + to the program launch. +

+ +

+ Console input and output are handled by the Console View (at the + bottom left of the workbench). You should see the 'Hello world' output + appear there, and if your program takes console input, the Console View + is where you can type in while developing. +

+ +

Run a module in the interpreter

+ +

You can right click on any Haskell module and choose Run GHCi session. This will open GHCi, the GHC interpreter, in a Eclipse console, and load all the required modules.

+ +

You can type in that console and have a full interactive session, modifying your modules in the Eclipse editors and running code in the console

+ +

The launch configuration options for interpreter sessions let you configure some automation features, like automatically reloading modules that you've saved in the editor.

+ + \ No newline at end of file diff --git a/net.sf.eclipsefp.haskell.doc.user/html/installation.html b/net.sf.eclipsefp.haskell.doc.user/html/installation.html new file mode 100644 index 000000000..e50daf685 --- /dev/null +++ b/net.sf.eclipsefp.haskell.doc.user/html/installation.html @@ -0,0 +1,32 @@ +

Installation steps

+

If you see this, you have successfully installed the eclipseFP plugins. +However there may still be some configuration steps to be done before you can use the plugins fully.

+ +

GHC configuration

+

+EclipseFP requires GHC to compile Haskell source files. +We recommend installing the Haskell Platform that comes with all required libraries bundled in a installer for your platform. +You can configure GHC by opening the Eclipse Preferences and going to Haskell > Haskell implementations. If a GHC is in your PATH you should see it in the list. Otherwise you can manually add a GHC installation. +

+ +

Cabal configuration

+

+EclipseFP also requires a working Cabal. Cabal is a build management tool for Haskell. Similarly, the Haskell Platform contains a version of Cabal compatible with the GHC it ships with. +You can configure Cabal in the Eclipse Preferences under Haskell > Scion and Cabal. By default EclipseFP will have looked in your PATH and use any Cabal installation it can find there. +

+ +

Scion configuration

+

+Scion is a Haskell program that uses GHC and Cabal to give a consistent API to manage and build Haskell projects. EclipseFP uses Scion for a lot of operations. +It comes with a version of Scion in source form, that should get built automatically once GHC and Cabal have been set up. +The Eclipse Preferences page under Haskell > Scion and Cabal allows you to change settings if required. +We recommend to stick to default setting (built-in server through Standard Stream/Pipe) unless you feel adventurous! +

+ +

Problems building Scion

+

+It may happen that Scion does not build successfully when you start EclipseFP. +The build process dumps its outputs and errors into a Console in the Console View of Eclipse. Please check this file for errors. +Often, the build fails due to some libraries conflict. Please run cabal update before restarting EclipseFP. +This will ensure your Cabal knows about the latest versions of libraries available on Hackage. +

\ No newline at end of file diff --git a/net.sf.eclipsefp.haskell.doc.user/html/overview.html b/net.sf.eclipsefp.haskell.doc.user/html/overview.html index 60335e54b..09f48acdb 100644 --- a/net.sf.eclipsefp.haskell.doc.user/html/overview.html +++ b/net.sf.eclipsefp.haskell.doc.user/html/overview.html @@ -1,57 +1,49 @@ -

Overview

- -

- This is the overview page for the functional programming tools features, - implemented by an open source project located at - eclipsefp.sourceforge.net. -

- -

General

- -

- Eclipse is an open source project that - has at its center an extensible, universal plugin architecture and a - (meanwhile very popular) IDE. There are various programming languages - already supported by this IDE, namely Java, C/C++, COBOL and more. -

- -

We are adding development tools for functional programming to that - framework. These tools extend the Eclipse IDE to support currently - Haskell, a pure, non-strict functional - programming language, and Objective Caml. -

- -

Contributors

- -

- - - - - - - - - - - - - - - -
Andrei de A. Formiga  
Leif Frenzel himself@leiffrenzel.de
Thiago Arrais thiago.arrais@gmail.com
-

-

- ... and of course all the people who try it and send feedback. -

- -

Contact

- -

Any feedback is most welcome. If you want to actively help visit -eclipsefp.sourceforge.net and -subscribe to the development Mailing list (or simply file a bug report or -feature request on the Tracker or in one of the Forums). - -