= wfo - wiki frontend at offline

wfo is a offline frontend for wikis and blogs. 
You can checkout a wiki page to a local file,
edit the file, and
commit to the page.

== Author

Tanaka Akira <akr@fsij.org>

== License

GPLv2 or later

(escape.rb, keyring.rb and mconv.rb is the modified BSD license.)

== Home Page

http://www.a-k-r.org/wfo/

== Feature

* cvs/svn like workflow
  * checkout a wiki page as a local file
  * edit the file using your favorite editor
  * update the file (merge and resolve conflicts)
  * commit the file to the wiki
* supported wiki and blog systems:
  * qwikWeb
  * Trac's wiki
  * PukiWiki
  * tDiary

== Requirements

* ruby 1.8.3 : http://www.ruby-lang.org/
* htree 0.4 : http://raa.ruby-lang.org/project/htree/
* GnuPG : http://www.gnupg.org/

== Download

* latest release: http://www.a-k-r.org/wfo/wfo-0.1.tar.gz

* development version: http://github.com/akr/wfo

== Install

  % ./configure
  % make
  % make install

configure option:

  --prefix=PREFIX         install files in PREFIX
  --with-ruby=PATHNAME    use ruby interpreter specified by PATHNAME

== Usage

  wfo checkout [-t repo_type] URL [local-filename][.ext]
  wfo status [-u] [local-filename...]
  wfo update [local-filename...]
  wfo commit [local-filename...]
  wfo diff [-u] [local-filename...]
  wfo workdump [local-filename...]

== Example

You can edit "SandBox" page on qwik.jp as follows.

  % wfo co http://qwik.jp/SandBox.html
  % vi SandBox.txt
  % wfo ci SandBox.txt

Note that you needs TypeKey account.
TypeKey username and password should be stored in ~/.keyring/.

== Authentication

  % mkdir ~/.keyring
  % cd ~/.keyring

  * TypeKey

      % echo TypeKey typekey-username typekey-password |
        gpg --comment TypeKey -e -a --default-recipient-self > typekey.asc

  * HTTP Basic Authentication

      % echo 'canonical-root-url basic "realm" username password' |
        gpg --comment 'canonical-root-url basic "realm"' -e -a --default-recipient-self > service.asc

See keyring.rb for more information.