Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 60 lines (34 sloc) 1.434 kB
83c5bfe @wlangstroth added to README.md and updated CONTRIBUTORS
wlangstroth authored
1 # Heist
bc05d15 @gregorycollins Commit the new re-structured heist library
gregorycollins authored
2
83c5bfe @wlangstroth added to README.md and updated CONTRIBUTORS
wlangstroth authored
3 Heist, part of the [Snap Framework](http://www.snapframework.com/), is a
19e22c1 @wlangstroth fixed editing mistake
wlangstroth authored
4 Haskell library for xhtml templating. It uses simple XML tags to bind values
83c5bfe @wlangstroth added to README.md and updated CONTRIBUTORS
wlangstroth authored
5 to your templates in a straightforward way. For example, if you were to put
6 the following in a template:
bc05d15 @gregorycollins Commit the new re-structured heist library
gregorycollins authored
7
83c5bfe @wlangstroth added to README.md and updated CONTRIBUTORS
wlangstroth authored
8 <bind tag="message">some text</bind>
9 <p><message/></p>
10
c691b09 @wlangstroth final typo correction
wlangstroth authored
11 the resulting xhtml would be
83c5bfe @wlangstroth added to README.md and updated CONTRIBUTORS
wlangstroth authored
12
13 <p>some text</p>
14
15 Likewise, if you need to add text to an attribute,
16
17 <bind tag="special">special-id</bind>
18 <div id="$(special)">very special</div>
19
20 gives you
21
22 <div id="special-id">very special</div>
23
d60f739 @wlangstroth README.md formatting fix and link
wlangstroth authored
24 Values can also be pulled from "Splices" (see
25 [the documentation](http://snapframework.com/docs/tutorials/heist#heist-programming)
26 for more information.)
83c5bfe @wlangstroth added to README.md and updated CONTRIBUTORS
wlangstroth authored
27
28 ## Building heist
bc05d15 @gregorycollins Commit the new re-structured heist library
gregorycollins authored
29
30 The heist library is built using [Cabal](http://www.haskell.org/cabal/) and
31 [Hackage](http://hackage.haskell.org/packages/hackage.html). Just run
32
33 cabal install
34
35 from the `heist` toplevel directory.
36
37
38 ## Building the Haddock Documentation
39
40 The haddock documentation can be built using the supplied `haddock.sh` shell
41 script:
42
43 ./haddock.sh
44
45 The docs get put in `dist/doc/html/`.
46
47
48 ## Building the testsuite
49
50 To build the test suite, `cd` into the `test/` directory and run
51
52 $ cabal configure
53 $ cabal build
54
55 From here you can invoke the testsuite by running:
56
57 $ ./runTestsAndCoverage.sh
58
59 The testsuite generates an `hpc` test coverage report in `test/dist/hpc`.
Something went wrong with that request. Please try again.