Login

    Register

Managed Hosting

PROJECT CATEGORIES

 

miniWiki
Project Home Forums Known Issues Screenshots Contact Project

Author: Oscar Arevalo (All RIAForge projects by this author)
Last Updated: April 3, 2010 3:53 PM
Version: 0.2
Views: 26,252
Downloads: 1,089
Demo URL: http://www.oscararevalo.com/miniwiki
License: Apache License, Version 2

Description:

miniWiki is an ultra-light wiki engine implemented using the HomePortals framework. The focus of miniWiki is to provide basic wiki functionality on a small footprint package, while at the same time being easy to customize and extend. miniWiki supports the Bliki syntax (Wikimedia) and is easily configurable.

miniwiki uses the HomePortals framework as the rendering engine and for content storage.

** no database required **

Usage
-----------
Using miniwiki is really simple, navigation is done automatically by following wikipage links. To add/edit page login using the provided link. The default password is "miniwiki". Anytime you reach a nonexistent page, click on Add/edit and you will be displayed a textearea to edit or create that page. You can also select from a previous version of that page.

To change the password edit the Application.cfc file and change the wiki.password setting. Setting wiki.password to empty will allow any visitor to add or edit pages.


Wiki Syntax
--------------
miniWiki uses Bliki as its wiki parser (Thanks to Brian Rinaldi for WikiConverter http://wikiconverter.riaforge.org). This is the same syntax that is used by wikimedia. To learn about the supported syntax you can check out this page: http://meta.wikimedia.org/wiki/Help:Editing


Customization & Themes:
-----------------------
Not all wikis are created alike, nor should they. So, with miniwiki you can easily change how you wiki looks to suit your preferences or maybe to integrate better with an existing website.

There are two different ways in which you can customize your wiki. First you can modify the layout and content, and second you can modify the HTML structure, add CSS, javascript files, etc.

Layout and content is driven by a file named wiki.xml located in the miniwiki folder. miniwiki provides a default (and very simple) layout file which contains just the wiki text, and a sample RSS feed. However you can create your own layouts, add content widgets, move content around. For example you can add more RSS feeds, add some static content, maybe some cfincludes to add some dynamic (i.e. CFML) features. You can even create your own custom widgets. Checkout http://www.homeportals.net for more info.

Besides customizing content and placement you can go further and modify the HTML structure alltogher or add your own CSS stylesheets. In fact, miniWiki is easily "themeable" by adapting the myriad of available skins and themes on the Internet (both free and commercial).

By default miniWiki uses an adaptation of the "Bamboo" theme from http://www.freecsstemplates.org/. To use your own themes or designs just change the 'templates' used by editing config/homePortals-config.xml.cfm file. Look for the <pageTemplates /> section:

   <renderTemplates>
      <renderTemplate name="page" type="page"
            default="true" href="themes/bamboo/page.html" />
      <renderTemplate name="module" type="module"
            default="true" href="themes/bamboo/module.html" />
   </renderTemplates>
The "page" template points to an HTML file that provides the overall html structure, and the "module" template is the one that provides the HTML markup for each individual content block. From there you can invoke your own stylesheets, images, or anything else that you want.

To find more about templates, checkout the HomePortals Templates documentation.

Requirements:

ColdFusion 8.01 or Railo 3 (or higher)
HomePortals framework (http://www.homeportals.net)

Issue Tracker:

There are no issues for this project.

To enter issues for this (or any other) project, you must be logged in.