The original goal of Pylowiki was to create an advanced same page, section edit and preview, wiki solution.
- Browse and View articles.
- Edit and Save changes on the same page.
- Preview the result real-time and in place. See the page before submitting.
Browse, Edit, Preview, and Submit from the same page!
The name Pylowiki is a portmanteau of the words Pylons and wiki. To define Pylowiki we must first define Pylons and wiki.
- def Pylons( pahy-lons ):
Pylons is a lightweight python web framework emphasizing flexibility and rapid development.
def wiki( wik-ee ):
A collaborative website whose content can be edited by anyone who has access to it.
def Pylowiki( pahy - loh - wik-ee ):
A wiki built using the Pylons framework.
- Pylo wiki
- Pile of wiki
Pylowiki 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!
Real-time preview of the users wiki mark-up is important because of the following reasons:
- Users get feedback before they save changes.
- Users do not have to leave the article to make a change, they may edit while the browse.
- It is faster and leads to less consecutive edits by the same user.
- Its fun and futuristic!
Setup a working pylons virtualenv, review the pylons wiki to get started.
Acquire the Pylowiki source:
hg clone ssh://email@example.com/russellballestrini/pylowiki
Install Pylowiki into python environment (or virtualenv):
python setup.py develop
Navigate to the pylowiki directory and create a config file as follows:
paster make-config Pylowiki config.ini
Tweak the config file as appropriate and then setup the application:
paster setup-app config.ini
Test the install by running the dev paste server:
paster serve --reload config.ini
Navigate a browser to http://127.0.0.1:5000