/murawiki

Primary LanguageColdFusionApache License 2.0Apache-2.0

MuraWiki - Mura CMS plugin for Wiki

A full wiki-implementation as a plugin for Mura CMS - a CFML (Adobe ColdFusion/Lucee) content management system.

Download latest release

Status

This projects is sort of at a beta/rc stage. It is feature complete and has been tested with various CFML engines (Adobe/Lucee), but it could use some more real-world testing. It is recommended that you start by deploying this on a development/staging server and review it fully before putting into production. Please report any bugs/issues that you might find!

Requirements

A Mura CMS 6.2 or 7 install, using either MySQL or Microsoft SQL Server. The plugin has been reviewed on Lucee 4.5/5 and Adobe Coldfusion 10 and 11. Not sure about Coldfusion 9 - in either case it shouldn't be too hard to fix for those.

MuraWiki has not been tested on any other database engines (Oracle, PostgreSQL)

Why MuraWiki

If you are currently using Mura CMS, then you get to use the user database, permissions and existing stylesheets and templates. The plugin integrates well within your site, e.g. navigation and search.

Possible uses

  • Intranet, that is easy to modify and update for all registered users, with e.g. document guidelines, meeting notes.
  • Could be used for technical documentation to encourage participation and updates.
  • FAQ, that is easy to maintain and keep updated.
  • Shared knowledgebase of a mix of document information resources.

What is a Wiki?

But whatitaminnit - what in the #¤%& is a wiki??? A Wiki is a unstructured body ("cloud") of textual information resources which are easily linked with each other. The basic design is unhierarchical and the underlying idea is to make editing and participation very easy to spread maintenance responsibilities. Read more on the Wikipedia page for Wiki.

Alternatives

The biggest other option for a CFML-powered Wiki is the excellent Canvas Wiki, which is a stand-alone Wiki CMS that has more futures than MuraWiki - it has better handling of sections and attachments, for instance. The page renderer from Canvas is included in MuraWiki. If you go outside the CFML-world, there are plenty of options, and many are quite feature-heavy. For deployment on a servlet-engine there is e.g. XWiki, and for other engines (e.g. PHP) there is MuraWiki (which powers WikiPedia) and many others.

History

This project started off with an ancient ColdFusion-application called CfWiki, programmed by Brian Shearer with contributions from many others. Not sure what license this was under, but I am sort of assuming it is Apache/MIT-license... Over they years I modified CfWiki and implemented it in Mach-II, which wasn't very difficult. All the processing was moved to CFCs and there was a full MVC architecture. I am happy to share the code (MachWiki) if anyone is interested. There was some problem with race conditions in MachWiki though, and at the same time I was implementing some projects as plugins in Mura CMS. I thought it would be an interesting little project to re-implement CfWiki inside Mura CMS taking full advantage of the handy api and object model exposed by Mura - so that one wouldn't worry about CRUD and handling e.g. users.

Credits

Instructions

  • Download the latest release, or deploy by URL
  • ...or clone this repo
  • Load into Mura from the plugins page in the administrator
  • Create a wiki by adding an item in the site manager of type Wiki and give it the name of the wiki
  • Set up and configure the wiki in the plugin page in the administration
  • Now it should be ready for use and testing!

Hints and tips

  • It is designed to use a Bootstrap3 theme with a three-column layout, if not all is displaying correctly, verify that you have 3-column template (site manager)
  • If you use cfindex/cfsearch, you might want to verify that it works as expected
  • You might want to disable whitespace supression you can will need to do this both at the CFML server level, and in the site ContentRenderer.
  • There are a few CSS/designs to choose from. You might want to consider putting this in your theme/site css.

License

Apache license 2.0 See the credits section for parts inherited/included from other pieces.

Future

###Highest priority

Other