README

Vimfluence - Edit Confluence with Vim (or some other editor)

Free yourself from the shackles of WYSIWYG and TextArea wiki editors. Reach
unheralded levels of productivity by editing your Confluence wiki with the
most powerful text editor known to mankind: Vim!

(You can use less powerful editors as well.)

INSTALLATION

- (Optional) For confluence wiki syntax highlighting in Vim, download and
  install the confluencewiki syntax plugin from
  <http://www.vim.org/scripts/script.php?script_id=1994>

- Vimfluence uses the values in WIKI_EDITOR, VISUAL, or EDITOR to select the
  editor. If none of these are set, Vimfluence defaults to the most powerful
  editor known to makind.

- Edit your "~/.profile" to set the wiki path:

      export WIKI_URL="http://hub.example.com/wiki"    # edit for your wiki path

- Drop `vimfluence` somewhere in your path.

- Create a "~/.netrc" file with your wiki url and login/password. Change the
  permission to 0600.

      machine http://hub.example.com/wiki
        login myuser@example.com
        password mypassword

- Run vimfluence: `vimfluence MySpace "My Wiki Page"`

- If you consistently editing pages in a particular Confluence space you might
  like an alias like this:

      alias devwiki="WIKI_URL=http://hub.example.com/wiki vimfluence dev"

- Alternatively you can also call `vimfluence` like this:

        vimfluence http://hub.example.com/wiki/display/space/Page+Name

  which can be handy for a quick cut 'n paste from the browser.


Oh and...

You're Welcome!