WebHome
- Releases
- Documentation
- Source code
Documentation

WebFunctions
%TOC%

---+++ Thesis
---++++ Download the thesis
My [[%ATTACHURL%/thesis.pdf][master's thesis]] contains documentation on <nowiki>WebFunctions</nowiki> and describes in detail how the framework is put together.

How to use the <nowiki>WebFunctions</nowiki> framework is also explained in it.

---++++ Building the Thesis document yourself
The thesis document relies on quite some tools that you need to install in order to be able to build it yourself. It is in most cases much better to  [[%ATTACHURL%/thesis.pdf][download]] it. However, for people wanting to create derivatives (e.g. a user manual), how to do it is described here:

First, you need to install the following software:
   * [[http://www.latex-project.org/][Latex]]
   * [[http://www.cs.uu.nl/~andres/lhs2tex/][lhs2tex]]
   * [[http://www.graphviz.org/][Graphviz]] to create the pictures of the graphs that occur inside the document

Then, you need to install Fragmenter, which you can download from the [[Releases]] section. Cd into its =src= directory and do =make=.
This will yield a binary called =fragger=. Put this binary somewhere in your system's path.

Go to the =doc/thesis= directory of <nowiki>WebFunctions</nowiki> and do =make=. If everything is installed correctly, this should build a file thesis.pdf.

---+++ Code examples
Once you have downloaded a <nowiki>WebFunctions</nowiki> [[Releases][release]], code examples will be available in =src/Examples=. Good starting points are
=HelloWorld= and =Example1=. Documentation on the examples is given in the thesis.

To build it, cd into =WebFunctions/trunk/WebFunctions/src= and do:<br>
=make helloworld= to build the Hello World application, or
=make example= to build example1.

The binaries will be called =helloworld= and =example=. Run one of them at a time. They will provide their own web servers listening at port 8080 of your localhost. Visit them by browsing to =http://localhost:8080/=.


---+++ Haddock documentation
For the Haddock documentation, you need to have [[http://www.haskell.org/haddock/][Haddock]] installed. If you got Haddock, download the <nowiki>WebFunctions</nowiki> source code from [[Releases]] and do:
<br>
=cd WebFunctions/trunk/WebFunctions/doc/haddock=
<br>
=make=

Now, <nowiki>WebFunction's</nowiki> Haddock documentation will be available for you in that directory.

-- Main.RobertVanHerk - 01 Nov 2005
Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
pdf	thesis.pdf	manage	507.5 K	01 Nov 2005 - 14:25	RobertVanHerk	Master's thesis containing documentation on WebFunctions