1Kwiki(3) User Contributed Perl Documentation Kwiki(3)
2
6 Kwiki - The Kwiki Wiki Building Framework
7
9 STOP. Don't install this CPAN module! Read this section to find out
10 why...
11 Kwiki-0.38 and the large collection of Kwiki CPAN modules has been rel‐
13 atively stable on CPAN for the last couple years. Being stable also
14 means being undeveloped.
15 In December 2006, the Kwiki community started actively developing Kwiki
17 again. We call the revitalized project Kwiki 2.0. This is not a version
18 number (at least not yet), but a code name for the effort.
19 Some goals of Kwiki 2.0 are:
21 * Make Kwiki easier to install and maintain
23 * Make Kwiki fast
24 * Make Kwiki plugins easier to develop
25 * Make Kwiki more fun
26 We've made a lot of headway on these goals and other goals too.
28 Kwiki is *really* simple to install now. _All_ the Perl dependencies
30 come with Kwiki, and are /preinstalled/. This means you just need Perl
31 5.8.3 and a web server. Well actually we give you a web server too!
32 NOTE: /Preinstalled/ means that the modules are all linked into a lib
34 tree that is separate from your installed Perl modules. This is good
35 for several reasons:
36 1) Installing modules takes a lot of time.
38 2) Kwiki is guaranteed to have module versions that work.
39 3) Kwiki doesn't change anything about your system's Perl lib.
40 4) You can delete all the modules by just deleting the Kwiki checkout.
41 5) Upgrading Kwiki is simple as 'svn update'!
42 6) You can install Kwiki without root permissions.
43 Also Kwiki is now smoking fast if you use Kwiki::FastCGI. There are
45 also some new caching modules that make Kwiki even faster still.
46 The important part is this: all the new stuff is not yet on CPAN. If
48 you want to install Kwiki, get it from our subversion repository
49 (highly recommended) or tarball downloads.
50 You will be amazed at how simple and fast it is to install the new
52 Kwiki which comes with nearly 500 Perl modules. The longest part is
53 simply checking out the repository. See
54 <http://www.kwiki.org/?InstallingKwiki2> for details.
55 Eventually all this work will make it back to CPAN, but likely not for
57 a while.
58 Here's a list of references for more information:
60 * http://www.kwiki.org - Main Kwiki Site
62 * http://www.kwiki.org/?KwikiNews - Kwiki News
63 * http://svn.kwiki.org/kwiki/trunk/ - Kwiki SVN Repository
64 * http://trac.kwiki.org/trac/timeline - Kwiki Project Management
65 * #kwiki on irc.freenode.net - Kwiki IRC Channel
66 * http://www.kwiki.org/downloads/ - Kwiki downloads
67 * http://doolittle.kwiki.org/ - Kwiki Documentation Wiki
68 Finally, there are generally a good amount of helpful people on IRC.
70 Please drop by sometime!
71 Cheers, Ingy
73 Here's the old Kwiki.pm doc. It might be a little out of date...
75
77 > kwiki -new cgi-bin/my-kwiki
78 Kwiki software installed! Point your browser at this location.
80
82 If you are impatient (don't worry, that's a good thing!) read
83 Kwiki::Command to get the details on how to install and configure a new
84 Kwiki wiki in record time.
85
87 A Wiki is a website that allows its users to add pages, and edit any
88 existing pages. It is one of the most popular forms of web collabora‐
89 tion. If you are new to wiki, visit http://c2.com/cgi/wiki?WelcomeVisi‐
90 tors which is possibly the oldest wiki, and has lots of information
91 about how wikis work.
92 Kwiki is a Perl wiki implementation based on the Spoon application
94 architecture and using the Spiffy object orientation model. The major
95 goals of Kwiki are that it be easy to install, maintain and extend.
96 All the features of a Kwiki wiki come from plugin modules. The base
98 installation comes with the bare minimum plugins to make a working
99 Kwiki. To make a really nice Kwiki installation you need to install
100 additional plugins. Which plugins you pick is entirely up to you.
101 Another goal of Kwiki is that every installation will be unique. When
102 there are hundreds of plugins available, this will hopefully be the
103 case.
104
106 Kwiki is the successor of the popular CGI::Kwiki software. It is a com‐
107 plete refactoring of that code. The new code has a lovely plugin API
108 and is much cleaner and extendable on all fronts.
109 There is currently no automated way to upgrade a CGI::Kwiki installa‐
111 tion to Kwiki. It's actually quite easy to do by hand. Instructions on
112 how to do it are here: http://www.kwiki.org/?KwikiMigrationByHand
113
115 All of the future Kwiki module documentation is being written at the
116 http://doc.kwiki.org/ wiki. Check there for the latest doc, and help
117 improve it. Each successive release of Kwiki will include the latest
118 doc from that site.
119
121 I am currently employed by Socialtext, Inc. They make high quality
122 social software for enterprise deployment. Socialtext has a bold new
123 vision of building their products over Open Source software and return‐
124 ing the generic source code to the community. This results in a win/win
125 effect for both entities. You get this shiny new wiki framework, and
126 Socialtext can take advantage of your plugins and bug fixes.
127 The Kwiki project would not be where it is now without their support. I
129 thank them.
130 Of particular note, Dave Rolsky and Chris Dent are two current Social‐
132 text employees that have made significant contributions to Kwiki.
133 ---
135 Iain Truskett was probably the most active Kwiki community hacker
137 before his untimely death in December 2003. The underlying foundation
138 of Kwiki has been named "Spoon" in his honor. Rest in peace Spoon.
139 ---
141 Ian (what's with all these Iai?ns??) Langworth has become a new Kwiki
143 warrior. He helped a lot with the maiden release. Expect a lot of plug‐
144 ins to come from him! Thanks Ian.
145 ---
147 Finally, big props to all the folks on http://www.kwiki.org and
149 irc://irc.freenode.net/#kwiki. Thanks for all the support!
150
152 Kwiki::Command
153
155 Ingy döt Net <ingy@cpan.org>
156
158 Copyright (c) 2004. Brian Ingerson. All rights reserved. Copyright (c)
159 2007. Ingy döt Net. All rights reserved.
160 This program is free software; you can redistribute it and/or modify it
162 under the same terms as Perl itself.
163 See http://www.perl.com/perl/misc/Artistic.html
165perl v5.8.8 2007-03-06 Kwiki(3)