A simple, but full-featured, Wiki system for Symfony applications. Provides following main features :
* I18n-ready (Embedded languages : en, fr).
* Full versionning of all changes.
* Pages can be contributed by anonymous or requires registered users.
* Support for InterWiki standard.
* Table of contents for each page.
* Support for page categories.
* Full index.
* External syntax engine : you can choose your engine freely (works well with sfMarkdownPlugin)

Developers

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Release 0.1.1 - 15/01/2008

Release 0.1 - 15/01/2008

nahoWikiplugin - Wiki for symfony

Overview

This plugin allows you to embed a wiki within your symfony application with
the following features:

Create/edit pages with full versionning

Basic permissions management

Basic security features

History of changes

Graphical and unified diff between two given revisions

Preview changes before saving

Internal links, supporting namespaces

Interwiki links

Automatically generated table of contents

Breadcrumbs

Configurable

Fully extendable

A bunch of helpers to provide total integration in your application

Most features have been inspired from
DokuWiki (e.g. namespaces and
Interwiki work the same way).

It is not aimed at replacing full-featured wiki packages, but offers a
lightweight alternative for when you build a website that has to contain a
simple wiki. It is very easy to configure and adapt, so it should fulfill most
basic wiki requirements.

Please note that this plugin is in active development. If you want to help and
improve it, please contact Nicolas Chambrier (naholyr at yahoo dot fr).

Screenshots

Requirements

The prerequisites for using the nahoWiki plugin are:

As the plugin doesn't contain a user management module, the project where
you install it must have a table managing authors, or users (whatever the
name), and the related Propel class must have a __toString() method. Both
these conditions are satisfied by the
sfGuardPlugin, so
installing this plugin is a good choice.

You need the [http://trac.symfony-project.com/trac/wiki/sfMarkdownPlugin
sfMarkdownPlugin] which will provide the ability to convert from wiki syntax
to XHTML contents.

Installation

PEAR Install

To install the plugin for a symfony project, the usual process is to use the
symfony command line:

Start using the plugin by browsing to the frontend module's default page:

http://myproject/frontend_dev.php/nahoWiki

Slots

The templates of the nahoWiki module define some slots that you can use
inside your layout:

wiki_page_actions : For the current page actions

wiki_page_name : Name of the current page

wiki_breadcrumbs : For the wiki breadcrumbs

If you want to insert the actions menu or the breadcrumbs in your layout at
the place you exactly want, simply disable the auto-inclusion of it (see
app.yml configuration) and include the corresponding slot in your layout.

Here is an example layout (in this example, options include_page_actions and
include_page_name have been disabled in app.yml):

Configuration

Schema customization

If you install the sfPropelAlternativeSchemaPlugin, you can customize this
plugin's schema by creating a nahoWikiPlugin_schema.custom.yml file under
your project's config/ directory. This allows you to customize the
connection name, table names, etcâ€¦ Refer to the
README file for more information.

Extending model, actions, or templates

If you want to extend a class of the model, just create an empty file
lib/model/nahoWikiClass.php, which will contain:

To override a template file named
plugins/nahoWikiplugin/modules/nahoWiki/templates/theTemplate.php, just copy
it to modules/nahoWiki/templates/theTemplate.php in your app's folder, and
then edit the copied file: it will be the one used by Symfony to render the
pages.
In most cases, you will want to override _page_actions.php or
_breadcrumbs.php, or _toc.php. Templates have been smartly exploded, you
should be able to customize the rendering with a few efforts.

Using another Wiki renderer

The default engine is Markdown
(if sfMarkdownPlugin is not installed, no conversion at all is done). If you
want to use another engine, just override the method
nahoWikiContentPeer::doConvert($content).

Look and Feel

The nahoWiki module comes with a default stylesheet. You can choose to use
your own stylesheet instead of the default one. To do so, you must create an
empty nahoWiki module inside your application with just one
config/view.yml file in it, with the following content:

Interwiki

The main syntax is [Title]]([Key>PageName), and it outputs a link to the page
"PageName" of the wiki named "Key", preceded by a nice icon telling the user
this is an Interwiki link.

If the file named web/nahoWikiPlugin/images/interwiki/key.gif exists (or
.png or .jpg) it will be used, else we use the generic interwiki.png
[[Image(source:plugins/nahoWikiPlugin/trunk/web/images/interwiki.png,
image/x-trac-wiki)]]

To add a new Interwiki, just create a file named interwiki.yml in your app's
folder, and add the key you want :

all:
Key: "http://UrlOfTheWiki?page="

The page name provided in the link is just added to the corresponding URL.

Internal links

The syntax for internal links is [Title]]([PageName).

Page names support namespaces.

If an internal link points to a unexisting page, it's show to the user, using
different models : internal_link_model for links to existing pages,
internal_link_broken_model for links to unexisting pages.