NAME

Quiki - A lightweight Wiki in Perl

VERSION

Version 0.12

SYNOPSIS

    use Quiki;

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

EXPORT FUNCTIONS

new

Creates a new Quiki object.

run

Runs the Quiki.

QUIKI CONFIGURATION FILE

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 configuration file supports the following keys:

name

The display name for your wiki

theme

The theme to be used. Note that at the time we are writing this only the default theme exists

index

The name of the main quiki page. It defaults to index.

opensite

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 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 /var/www/html/myquiki
       $ quiki_create /var/www/html/myquiki

3. 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>

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:

• 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/

ACKNOWLEDGEMENTS

Thank you Luis 'Houser' Fernandes <housah at gmail.com> for the default theme layout design.

COPYRIGHT & LICENSE

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.