README

   1 fuse-mediawiki is an attempt to create a FUSE-compatible filesystem that allows
   2 you to read, edit, move, and otherwise play around with wikis that run on the
   3 MediaWiki platform.  An attempt will be made to offer every feature that is
   4 possibly available in a filesystem that also works on the wiki *except*
   5 deletion, which I've deemed too dangerous for a simple filesystem.
   6
   7 Usage:
   8   python fuse-mediawiki.py [-t TIMEOUT] [-u USERNAME] [-l LOG_FILE] \
   9     [--http-basic] [-o FUSEOPTS] ROOT_URL MOUNTPOINT
  10
  11   The root URL is usually something that ends in something like /w/index.php.
  12   If you have trouble finding it, try editing or viewing the history of a
  13   page... it should end in index.php without any options.
  14
  15 Example:
  16  python fuse-mediawiki.py [-u USERNAME] \
  17    http://en.wikipedia.org/w/index.php ~/wiki/
  18 This will mount the English Wikipedia into $HOME/wiki/.
  19
  20 If your wiki uses HTTP Basic authentication, pass the --http-basic option.
  21
  22 To edit an article, open the name of the article with a .wiki extension in your
  23 favorite text editor; i.e.,
  24  vim ~/wiki/Main_Page.wiki
  25 If your article is nested under another article (say, [[Main Page/new]]):
  26  mkdir ~/wiki/Main_Page
  27  vim ~/wiki/Main_Page/new.wiki
  28
  29 If you encounter a problem, try and reproduce it with the -f flag at the end of
  30 your command line, and copy and paste the problematic-looking part. See HACKING
  31 for more information.
  32
  33 ==============================================================================
  34
  35 Yes, I know that the wikipediafs project exists... however, it didn't do
  36 everything I wish it would, and it wouldn't work with the wiki I was attempting
  37 to use it with (http://fedoraproject.org/wiki/), because of how authorization
  38 was done on that wiki.  So, here comes this project.
  39
  40 Anybody who can help is greatly appreciated.  Send me an email, a patch, or
  41 whatever.
  42
  43 May 28, 2008
  44 Ian Weller <ianweller@gmail.com>
  45
  46 ==============================================================================
  47
  48 KNOWN BUGS (other than the filesystem itself not working as it should)
  49
  50 - On --help, usage and non-FUSE options are echoed twice.