/ 
Quiki-0.01_1
/ Quiki

NAME

Quiki - A lightweight Wiki in Perl

VERSION

Version 0.01_1

SYNOPSIS

use Quiki;

my %conf = ( name => 'MyQuiki' );
Quiki->new(%conf)->run;

EXPORT FUNCTIONS

new

Creates a new Quiki object.

run

Runs de Quiki.

SYNTAX

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]];

  • To link the Internet use just the URL and it should be highlighted

  • You can also create named links with: [[URL|URL Description]]

  • Basic formatting:

    • Bolds: **bold**;

    • Italics: //italic//;

    • Underlines: __underline__;

    • Typewriter: ''typewriter'';

  • Six levels of headings:

    • Stronger: ====== title ======

    • Weaker: = 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 |

      • put the content at the right without spaces, to get right alignment: | foo|

      • put the content at the center, with spaces both sides, to get center alignment: | foo |

QUIKI DEPLOYMENT

  1. Install the Quiki Perl module

    $ cpan Quiki

  2. Use the quiki_create Perl script

    $ mkdir /home/quiki
$ quiki_create /var/www/html/myquiki

  3. Configure your Apache accordingly.

    Sample VirtualHost for Apache2:

    <VirtualHost *:80>
   ServerName quiki.server.com
   DocumentRoot /home/quiki/
   ServerAdmin admin@quiki.server.com
   DirectoryIndex index.html
 
   <Directory /home/quiki>
      Options +ExecCGI
      AddHandler cgi-script .cgi
   </Directory>
</VirtualHost>

AUTHOR

  • Alberto Simoes, <ambs at cpan.org>

  • Nuno Carvalho, <smash at cpan.org

BUGS

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.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Quiki

You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2009 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.