view release on metacpan or  search on metacpan

lib/CGI/Kwiki/Pages.pm  view on Meta::CPAN

__KwikiAbout__
CGI::Kwiki is simple yet powerful Wiki environment written in Perl as a CPAN module distribribution. It was written by BrianIngerson.

*This is CGI::Kwiki Version [#.#]* 
  - XXX

Changes in version 0.17:
  - RCS Support!!!
  - Changed wiki_link regexps to include '_'
  - Cleaned up html and css (AdamTrickett)
  - Support template/local/ directory
  - Add Login button to edit
  - Added Blog to navbar
  - Change localtime to gmtime
  - Added time to RecentChanges

Changes in version 0.16:
  - Support Page Privacy (Public, Protected, Private)
  - Support administrator login
  - KwikiBlog is a reality
  - Allow uppercase suffixes for urls (.GIF)
  - Display 'Site Index' for empty search (JoergBraukhoff)
  - Display 'Search' as the page_id on a search results page.
  - Bang (!) before bracket ([) negates the usual formatting effect.
  - Defeat browser caching (JoergBraukhoff)
  - Support $ENV{REMOTE_USER} for htaccess (Pardus)


Changes for version 0.15:
  - Support unicode character classes in page names
  - Search searches page names
  - Search is written in Perl now, instead of grep
  - Cookies span sessions
  - Allow ftp:// and irc:// links
  - Allow to create a new page from an old one
  - Dead wiki links use <strike>
  - Stop links from being underlined
  - Allow Wiki links like KWiki
  - Support <H4> <H5> and <H6>
  - Refactored installation and upgrade process
  - Added [#.#] format for $CGI::Kwiki::VERSION

Changes for version 0.14:
  - Works with mod_perl.
  - Preferences works.
  - Support for page metadata.
  - RecentChanges shows who last edited page.
  - Almost all non-perl content is now written to 
    appropriate files. Javascript, CSS etc. Much easier to
    maintain and extend now.
  - Support mailto links and inline code.
  - https links added. Thanks to GregSchueler.
  - ':' added to charset for page names. Suggested by 
    JamesFitzGibbon.
  - Javascript fix reported by MikeArms.
  - Security hole in CGI params fixed. Reported by 
    TimSweetman.
  - Emacs artifact bug fix by HeikkiLehvaslaiho.
  - Cleaned up unneeded <p> tags. Reported by HolgerSchurig
__KwikiBackup__
Kwiki supports backing up of each page change, so that you can easily revert a page to an older version. Currently the only backup module is CGI::Kwiki::Backup::Rcs and it uses RCS to do the backups. RCS is generally found on almost all modern Unix s...

KwikiBackup support is not enabled by default. To enable it, add the following line to your config.yaml file:

    backup_class: CGI::Kwiki::Backup::Rcs
__KwikiBlog__
KwikiBlog allows you to turn any wiki page into a blog page. You need to have KwikiPrivacy enabled, and you must be logged in as the administrator of the site.

Click [here http:blog.cgi] to see if this site has KwikiBlog working.
__KwikiCustomization__
There are basically three levels of customization you can do with a kwiki site. They are discussed from easiest to hardest:

^=== Config File Changes

^=== Template/CSS Changes

There are 2 directories in your kwiki installation that contain files that control the layout and appearance of your web pages:

* [=template]
* [=css]

You can change the html and css files anyway that suits you. It is generally best to copy the modified files into [=local/template] and [=local/css]. This way your changes will not be overwritten if you later do a [=kwiki-install --upgrade].

^=== Perl Code Changes
__KwikiFastCGI__
Apache's mod_fastcgi makes Perl applications run much faster and scale well to heavy usage. Using Kwiki with mod_fastcgi is a piece of cake. 

First you need is an Apache server built with mod_fstcgi support. See http://www.fastcgi.com/ for more information.

Then install a Kwiki site following the normal KwikiInstallation procedures.

Finally add something like this to your Apache configuration (The example is for named virtual host):

  <VirtualHost *>
    ServerName kwiki.yourhost.name
    DocumentRoot /usr/local/www/data/kwiki
  
    AddHandler fastcgi-script cgi
    DirectoryIndex index.cgi
  
    <Location />
      Options ExecCGI
    </Location>
  </VirtualHost>

That's it! You'll get an instant *performance boost*.

You can switch from the standard CGI installation to mod_fastcgi anytime you want.
__KwikiFeatures__
The overall design goal of CGI::Kwiki is /simplicity/ and /extensibility/. 

Even so, Kwiki will have some killer builtin features not available in most wikis:

* KwikiPrivacy
* KwikiSlideShow
* KwikiBlog
* KwikiSisters
* KwikiHotKeys
* KwikiFit
* KwikiPod

Each feature is implemented as a separate plugin class. This keeps things _simple_ and _extensible_.
__KwikiFit__
*Due next release or so*