Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
49 lines (34 sloc) 1.05 KB
MagicWiki
=========
Designed to make static page generation and editing a joy rather than a pain.
Features include:
- Wiki style code interpretation
- Dynamic page creation
- Easy linking and embedding facilities
- In-place editing
Todo list includes:
- User auth
Requires:
- Haml
=========
To Use:
- install via git as a plugin
- run the migration scripts (easiest way is using my easy_migrate plugin)
- browse to yourapp.com/wiki/WikiPageName
To Edit:
- make a before filter that sets @magic_wiki_editable to true when you want a user to be able to edit a page
- browse to a page and click the edit button
To embed in existing pages:
- in your controller:
- * include MagicWiki
- * magic_wiki_do_setup "WikiPageName"
- * @wiki = magic_wiki_display
- in your view put either:
- * "= @wiki" for haml users
- * "<%= @wiki %>" for erb users
=========
Notes:
- go to wiki/Ref for a reference to the wiki syntax
Options:
- set @magic_wiki_allow_html when saving pages to allow html to be saved
Sponsored by Ebotech Consulting Ltd. - www.ebotech.com