tests/miniwiki/README

   1 Miniwiki
   2 ---------
   3
   4 Miniwiki is a simple wiki written for Ocsigen by Janne Hellsten
   5 (jjhellst@gmail.com).  It's primary purpose is to server as a code
   6 example for Ocsigen module developers.
   7
   8 Compiling & running
   9 -------------------
  10
  11 Miniwiki should be compiled and install with Ocsigen.
  12
  13 The default config file usually contains miniwiki preconfigured.
  14
  15 If not, adapt files/miniwiki.conf and start Ocsigen with Miniwiki by running
  16
  17    ocsigen -c examples/miniwiki/files/miniwiki.conf
  18
  19 4. Point your browser to localhost:9999/
  20
  21 Implementation
  22 --------------
  23
  24 Wiki page storage
  25
  26 Each wiki page is a file in the wiki storage directory
  27 (/var/lib/ocsigen/miniwiki/wikidata/ is the default).  A wiki page "Foo"
  28 corresponds to a file called "Foo.wiki" in the "wikidata" directory.
  29
  30 Character encoding
  31
  32 Wiki pages are stored as UTF-8 text files.  If the site is properly
  33 configured, the wiki properly allows the use of UTF-8 content in wiki
  34 pages.  Since wiki page names map directly to filenames on disk, page
  35 names containing non 7-bit ASCII might not work well.