README
1This Wiki was originally based on Joe Armstrongs wiki implementation.
2It has been ported to yaws and hacked quite a bit in general by Johan
3Bevemyr.
4
5To Install
6----------
7
8- Yaws should be installed
9
10- Run 'make install'
11
12- Edit your /etc/yaws.conf and include $(vardir)/yaws/wiki/ebin in the
13ebin path:
14
15 ebin_dir = $(vardir)/yaws/wiki/ebin
16
17It is possible to have several Wiki instances on the same server.
18Just install the www/* files in the directory where you want a
19Wiki instance. This is easily done by running the updateWiki script
20and give a new directory as argument.
21
22To edit the wiki preferences go to the wiki page WikiPreferences
23(for example by clicking on the "All Pages" or "Zombies" icon)
24and replace the gifs with our own favorites.
25
26The password to the WikiPreferences page is ForgetMe.
27
28Getting started
29---------------
30WIKIINSTALLDIR is where the wiki is located. It must be part of your
31docroot. After installation, browse to the wiki directory. You will be
32asked to create a 'home' page, which will be the first wiki page. To find out
33about the special wiki formatting rules, go to WikiFormattingRules (e.g.
34from "All Pages"). To create a new page, just create a link to it by clicking
35EditMe on the home page (use the ~ character: "my new page ~TestPage"), and
36save the home page. The new link will show up as: "my new page TestPage???".
37The question marks means that the node TestPage doens't exist. Click on the
38question marks to create the the page.
39
40
41Look and feel
42-------------
43
44The layout of the Wiki pages is to a large extent controlled by
45two templates in WikiPreferences.files called template.html
46and template_info.html. There is an alternative look and feel
47bundled, just copy template2.html to template.html and
48template_info2.html to template_info.html.
49
50To maintain
51-----------
52
53There are a number of useful scripts in the script directory.
54
55updateWiki - takes a number of wiki directories and updates
56 the .yaws files etc
57
58getPassword - takes a path to a wob file as argument. Will print
59 the password associated with that node.
60
61importFiles - takes a path to a wob file as argument. Will add
62 any files in the corresponding .files directory
63 to the page. Useful when you want to import many
64 files without going through the WEB GUI. Just
65 copy the files to the .files directory and run
66 the importFiles command.
67
68