Quiki - A lightweight Wiki in Perl
Version 0.12
use Quiki; my %conf = ( name => 'MyQuiki' ); Quiki->new(%conf)->run;
Creates a new Quiki object.
Runs the Quiki.
After a Quiki wiki is deployed with quiki_create a quiki.conf file can be edited to configure Quiki behavior. While later versions might offer a web interface to configure them, at present you need to use a text editor and change the file. Note that it is a Perl file. Therefore it should parse correctly by Perl. You can check it using perl -c quiki.conf.
quiki_create
quiki.conf
perl -c quiki.conf
Quiki configuration file supports the following keys:
The display name for your wiki
The theme to be used. Note that at the time we are writing this only the default theme exists
default
The name of the main quiki page. It defaults to index.
index
This is a boolean value. By default it is true (1), meaning the register button will be available to everybody visiting your Quiki. Turn it off setting it to false (0).
At the current moment there isn't any other way to register. Therefore you should turn registering off only after all users have an account, or you need to turn it off manually everytime a new user has to register.
Quiki wiki syntax is very similar to other wiki, and especially similar with dokuwiki syntax.
To force a paragraph give a blank line;
To refer to another node use: [[NodeName]] or [[NodeName|Node Description]];
[[NodeName]]
[[NodeName|Node Description]]
To link the Internet use just the URL and it should be highlighted
You can also create named links with: [[URL|URL Description]]
[[URL|URL Description]]
Basic formatting:
Bolds: **bold**;
**bold**
Italics: //italic//;
//italic//
Underlines: __underline__;
__underline__
Typewriter: ''typewriter'';
''typewriter''
Six levels of headings:
Stronger: ====== title ======
====== title ======
Weaker: = title =
= title =
Hard rules are obtained with ten or more dashes: ---------------
---------------
Code/verbatim zones are blocks with all lines indented three spaces.
Lists:
Ordered lists as a dash -
-
Unordered lists as an asterisk *
*
Each item with two spaces before the mark
Deeper levels have multiples of two spaces indentation
Tables:
Table headers separated by a carret character ^. Note that no space should exist in the beginning of the line.
Table rows separated by a pipe character |. Note that no space should exist in the beginning of the line.
Each cell (not header) will be formatted accordingly with the ascii alignment:
put the content at the left without spaces, to get left alignment: |foo |
|foo |
put the content at the right without spaces, to get right alignment: | foo|
| foo|
put the content at the center, with spaces both sides, to get center alignment: | foo |
| foo |
Install the Quiki Perl module
$ cpan Quiki
Use the quiki_create Perl script
$ mkdir /var/www/html/myquiki $ quiki_create /var/www/html/myquiki
Configure your Apache accordingly.
Sample VirtualHost for Apache2:
<VirtualHost *:80> ServerName quiki.server.com DocumentRoot /var/www/html/myquiki ServerAdmin admin@quiki.server.com DirectoryIndex index.html <Directory /var/www/html/myquiki> Options +ExecCGI AddHandler cgi-script .cgi </Directory> </VirtualHost>
Alberto Simoes, <ambs at cpan.org>
<ambs at cpan.org>
Nuno Carvalho, <smash at cpan.org>
<smash at cpan.org>
Please report any bugs or feature requests to bug-quiki at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Quiki. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-quiki at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Quiki
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Quiki
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Quiki
CPAN Ratings
http://cpanratings.perl.org/d/Quiki
Search CPAN
http://search.cpan.org/dist/Quiki/
Thank you Luis 'Houser' Fernandes <housah at gmail.com> for the default theme layout design.
<housah at gmail.com>
Copyright 2009-2010 Alberto Simoes and Nuno Carvalho.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
To install Quiki, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Quiki
CPAN shell
perl -MCPAN -e shell install Quiki
For more information on module installation, please visit the detailed CPAN module installation guide.