===============================================================================
wiki2xml - README
===============================================================================

FILES

--/
  |-- src/scanner.jflex     - JFlex scanner 
  |-- src/MANIFEST          - Defines main class for executable jar
  |-- src/org/*             - Java source
  |-- lib/                  - 3rd party libraries
  |-- test/                 - Test wikitext files / junit tests (TODO)
  |-- doc/                  - Some helpful links and info about wikitext
  |-- build.xml             - Ant build file
  |-- bin/wiki2xml          - Shell script wrapper to run wiki2xml.jar

BUILD

* To build just type in ant. See ant -projecthelp for a list of targets. 
* For JFlex syntax highlighting in vim: 
    - Add doc/jflex.vim to your ~/.vim/syntax directory. 
    - Add the following lines to ~/.vim/filetype.vim
        " jflex filetype file
        if exists("did_load_filetypes")
            finish
        endif
        augroup filetypedetect
            au! BufRead,BufNewFile *.jflex  setfiletype jflex
        augroup END

* JFlex manual: http://jflex.de/manual.html

TEST

Run bin/wiki2xml [filename]. It takes wikitext file names as command line
arguments and translates them into xml. After a successful ant build there will
be an executable jar in the dist directory which you can also run:
    java -jar dist/wiki2xml.jar [filename] 


AUTHORS

Andrew Bruno <aeb@qnot.org>