About RiverPython Wiki

RiverPython Wiki

RiverPython is a pylons application for advanced user commenting, linking to inline bookmarks and image area selection tools. It provides an upload system for audio and video attachments to an wysiwyg edited wiki. Comments are edited inline with markup.

A demo is available at the site.

RiverPython provides:

• Annotate wiki pages with audio/video/pdf and text comments.
• Link comments to bookmarks or image area selection using imgareaselect with jquery.
• Edit and Save changes n a wysiwyg editor using elrte.

Why the name RiverPython?

The first site to use the software was a Clarence River oral history site developed in Python

The ststem is build on Pylons, a lightweight python web framework emphasizing flexibility and rapid development.

For more about Pylons

What mark-up does RiverPython use?

For the wiki, River Python uses elrte wysiwyg editor

For comments, RiverPython uses reStructured Text reST as mark-up.

How does RiverPython render mark-up for real-time preview of comments?

River Python uses ajax to send reST mark-up to the web server. The web server accepts reST and converts it to HTML. The HTML is sent back to the browser and appears on the page in place and in real-time. The browser then links the comments to the bookmarks using javascript.

Installation and Setup

1. Setup a working pylons virtualenv, review the pylons wiki to get started.

http://pylonshq.com/docs/en/1.0/gettingstarted/

1. Acquire the Clarence River source::

git clone ssh://UserName@git.code.sf.net/p/riverpython/code RiverPython

1. Navigate to the RiverPython directory and create a config file as follows::

   paster make-config RiverPython config.ini

2. Tweak the config file as appropriate and then setup the application::

   paster setup-app config.ini

3. Test the install by running the dev paste server::

   paster serve --reload config.ini

4. Navigate a browser to http://127.0.0.1:5000