.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Wiki::Toolkit 3pm"
.TH Wiki::Toolkit 3pm "2021-01-04" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Wiki::Toolkit \- A toolkit for building Wikis.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Helps you develop Wikis quickly by taking care of the boring bits for
you.  You will still need to write some code \- this isn't an instant Wiki.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&  # Set up a wiki object with an SQLite storage backend, and an
\&  # inverted index/DB_File search backend.  This store/search
\&  # combination can be used on systems with no access to an actual
\&  # database server.
\&  #
\&  # The database should already exist; it can be created using
\&  # the supplied wiki\-toolkit\-setupdb script.
\&
\&  my $store     = Wiki::Toolkit::Store::SQLite\->new(
\&      dbname => "/home/wiki/store.db" );
\&  my $indexdb   = Search::InvertedIndex::DB::DB_File_SplitHash\->new(
\&      \-map_name  => "/home/wiki/indexes.db",
\&      \-lock_mode => "EX" );
\&  my $search    = Wiki::Toolkit::Search::SII\->new(
\&      indexdb => $indexdb );
\&
\&  my $wiki      = Wiki::Toolkit\->new( store     => $store,
\&                                      search    => $search );
\&
\&  # Do all the CGI stuff.
\&  my $q      = CGI\->new;
\&  my $action = $q\->param("action");
\&  my $node   = $q\->param("node");
\&
\&  if ($action eq \*(Aqdisplay\*(Aq) {
\&      my $raw    = $wiki\->retrieve_node($node);
\&      my $cooked = $wiki\->format($raw);
\&      print_page(node    => $node,
\&                 content => $cooked);
\&  } elsif ($action eq \*(Aqpreview\*(Aq) {
\&      my $submitted_content = $q\->param("content");
\&      my $preview_html      = $wiki\->format($submitted_content);
\&      print_editform(node    => $node,
\&                     content => $submitted_content,
\&                     preview => $preview_html);
\&  } elsif ($action eq \*(Aqcommit\*(Aq) {
\&      my $submitted_content = $q\->param("content");
\&      my $cksum = $q\->param("checksum");
\&      my $written = $wiki\->write_node($node, $submitted_content, $cksum);
\&      if ($written) {
\&          print_success($node);
\&      } else {
\&          handle_conflict($node, $submitted_content);
\&      }
\&  }
.Ve
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew\fR" 4
.IX Item "new"
.Vb 9
\&  # Set up store, search and formatter objects.
\&  my $store     = Wiki::Toolkit::Store::SQLite\->new(
\&      dbname => "/home/wiki/store.db" );
\&  my $indexdb   = Search::InvertedIndex::DB::DB_File_SplitHash\->new(
\&      \-map_name  => "/home/wiki/indexes.db",
\&      \-lock_mode => "EX" );
\&  my $search    = Wiki::Toolkit::Search::SII\->new(
\&      indexdb => $indexdb );
\&  my $formatter = My::HomeMade::Formatter\->new;
\&
\&  my $wiki = Wiki::Toolkit\->new(
\&      store     => $store,     # mandatory
\&      search    => $search,    # defaults to undef
\&      formatter => $formatter  # defaults to something suitable
\&  );
.Ve
.Sp
\&\f(CW\*(C`store\*(C'\fR must be an object of type \f(CW\*(C`Wiki::Toolkit::Store::*\*(C'\fR and
\&\f(CW\*(C`search\*(C'\fR if supplied must be of type \f(CW\*(C`Wiki::Toolkit::Search::*\*(C'\fR (though
this isn't checked yet \- \s-1FIXME\s0). If \f(CW\*(C`formatter\*(C'\fR isn't supplied, it
defaults to an object of class Wiki::Toolkit::Formatter::Default.
.Sp
You can get a searchable Wiki up and running on a system without an
actual database server by using the SQLite storage backend with the
SII/DB_File search backend \- cut and paste the lines above for a quick
start, and see Wiki::Toolkit::Store::SQLite, Wiki::Toolkit::Search::SII,
and Search::InvertedIndex::DB::DB_File_SplitHash when you want to
learn the details.
.Sp
\&\f(CW\*(C`formatter\*(C'\fR can be any object that behaves in the right way; this
essentially means that it needs to provide a \f(CW\*(C`format\*(C'\fR method which
takes in raw text and returns the formatted version. See
Wiki::Toolkit::Formatter::Default for a simple example. Note that you can
create a suitable object from a sub very quickly by using
Test::MockObject like so:
.Sp
.Vb 4
\&  my $formatter = Test::MockObject\->new();
\&  $formatter\->mock( \*(Aqformat\*(Aq, sub { my ($self, $raw) = @_;
\&                                    return uc( $raw );
\&                                  } );
.Ve
.Sp
I'm not sure whether to put this in the module or not \- it'd let you
just supply a sub instead of an object as the formatter, but it feels
wrong to be using a Test::* module in actual code.
.IP "\fBretrieve_node\fR" 4
.IX Item "retrieve_node"
.Vb 1
\&  my $content = $wiki\->retrieve_node($node);
\&
\&  # Or get additional data about the node as well.
\&  my %node = $wiki\->retrieve_node("HomePage");
\&  print "Current Version: " . $node{version};
\&
\&  # Maybe we stored some of our own custom metadata too.
\&  my $categories = $node{metadata}{category};
\&  print "Categories: " . join(", ", @$categories);
\&  print "Postcode: $node{metadata}{postcode}[0]";
\&
\&  # Or get an earlier version:
\&  my %node = $wiki\->retrieve_node( name    => "HomePage",
\&                                   version => 2,
\&                                  );
\&  print $node{content};
.Ve
.Sp
In scalar context, returns the current (raw Wiki language) contents of
the specified node. In list context, returns a hash containing the
contents of the node plus additional data:
.RS 4
.IP "\fBlast_modified\fR" 4
.IX Item "last_modified"
.PD 0
.IP "\fBversion\fR" 4
.IX Item "version"
.IP "\fBchecksum\fR" 4
.IX Item "checksum"
.IP "\fBmetadata\fR \- a reference to a hash containing any caller-supplied metadata sent along the last time the node was written" 4
.IX Item "metadata - a reference to a hash containing any caller-supplied metadata sent along the last time the node was written"
.RE
.RS 4
.PD
.Sp
The \f(CW\*(C`node\*(C'\fR parameter is mandatory. The \f(CW\*(C`version\*(C'\fR parameter is
optional and defaults to the newest version. If the node hasn't been
created yet, it is considered to exist but be empty (this behaviour
might change).
.Sp
\&\fBNote\fR on metadata \- each hash value is returned as an array ref,
even if that type of metadata only has one value.
.RE
.IP "\fBmoderate_node\fR" 4
.IX Item "moderate_node"
.Vb 1
\&  my $ok = $wiki\->moderate_node(name => $node, version => $version);
.Ve
.Sp
Marks the given version of the node as moderated. If this is the
highest moderated version, then update the node's contents to hold
this version.
.IP "\fBset_node_moderation\fR" 4
.IX Item "set_node_moderation"
.Vb 1
\&  my $ok = $wiki\->set_node_moderation(name => $node, required => $required);
.Ve
.Sp
Sets if a node requires moderation or not. 
(Moderation is required when \f(CW$required\fR is true).
.Sp
When moderation is required, new versions of a node will sit about
until they're tagged as moderated, when they will become the new node.
.IP "\fBrename_node\fR" 4
.IX Item "rename_node"
.Vb 1
\&  my $ok = $wiki\->rename_node(old_name => $old_name, new_name => $new_name, create_new_versions => $create_new_versions );
.Ve
.Sp
Renames a node, updating any references to it as required.
.Sp
Uses the internal_links table to identify the nodes that link to this
one, and re-writes any wiki links in these to point to the new name. If
required, it can mark these updates to other pages as a new version.
.IP "\fBverify_checksum\fR" 4
.IX Item "verify_checksum"
.Vb 1
\&  my $ok = $wiki\->verify_checksum($node, $checksum);
.Ve
.Sp
Sees whether your checksum is current for the given node. Returns true
if so, false if not.
.Sp
\&\fB\s-1NOTE:\s0\fR Be aware that when called directly and without locking, this
might not be accurate, since there is a small window between the
checking and the returning where the node might be changed, so
\&\fBdon't\fR rely on it for safe commits; use \f(CW\*(C`write_node\*(C'\fR for that. It
can however be useful when previewing edits, for example.
.IP "\fBlist_backlinks\fR" 4
.IX Item "list_backlinks"
.Vb 2
\&  # List all nodes that link to the Home Page.
\&  my @links = $wiki\->list_backlinks( node => "Home Page" );
.Ve
.IP "\fBlist_dangling_links\fR" 4
.IX Item "list_dangling_links"
.Vb 3
\&  # List all nodes that have been linked to from other nodes but don\*(Aqt
\&  # yet exist.
\&  my @links = $wiki\->list_dangling_links;
.Ve
.Sp
Each node is returned once only, regardless of how many other nodes
link to it.
.IP "\fBlist_all_nodes\fR" 4
.IX Item "list_all_nodes"
.Vb 1
\&  my @nodes = $wiki\->list_all_nodes;
.Ve
.Sp
Returns a list containing the name of every existing node.  The list
won't be in any kind of order; do any sorting in your calling script.
.IP "\fBlist_nodes_by_metadata\fR" 4
.IX Item "list_nodes_by_metadata"
.Vb 6
\&  # All documentation nodes.
\&  my @nodes = $wiki\->list_nodes_by_metadata(
\&      metadata_type  => "category",
\&      metadata_value => "documentation",
\&      ignore_case    => 1,   # optional but recommended (see below)
\&  );
\&
\&  # All pubs in Hammersmith.
\&  my @pubs = $wiki\->list_nodes_by_metadata(
\&      metadata_type  => "category",
\&      metadata_value => "Pub",
\&  );
\&  my @hsm  = $wiki\->list_nodes_by_metadata(
\&      metadata_type  => "category",
\&      metadata_value  => "Hammersmith",
\&  );
\&  my @results = my_l33t_method_for_ANDing_arrays( \e@pubs, \e@hsm );
.Ve
.Sp
Returns a list containing the name of every node whose caller-supplied
metadata matches the criteria given in the parameters.
.Sp
By default, the case-sensitivity of both \f(CW\*(C`metadata_type\*(C'\fR and
\&\f(CW\*(C`metadata_value\*(C'\fR depends on your database \- if it will return rows
with an attribute value of \*(L"Pubs\*(R" when you asked for \*(L"pubs\*(R", or not.
If you supply a true value to the \f(CW\*(C`ignore_case\*(C'\fR parameter, then you
can be sure of its being case-insensitive.  This is recommended.
.Sp
If you don't supply any criteria then you'll get an empty list.
.Sp
This is a really really really simple way of finding things; if you
want to be more complicated then you'll need to call the method
multiple times and combine the results yourself, or write a plugin.
.IP "\fBlist_nodes_by_missing_metadata\fR Returns nodes where either the metadata doesn't exist, or is blank" 4
.IX Item "list_nodes_by_missing_metadata Returns nodes where either the metadata doesn't exist, or is blank"
Unlike \fBlist_nodes_by_metadata()\fR, the metadata value is optional (the
metadata type is required).
.Sp
.Vb 6
\&  # All nodes missing documentation
\&  my @nodes = $store\->list_nodes_by_missing_metadata(
\&      metadata_type  => "category",
\&      metadata_value => "documentation",
\&      ignore_case    => 1,   # optional but recommended (see below)
\&  );
\&
\&  # All nodes which don\*(Aqt have a latitude defined
\&  my @nodes = $store\->list_nodes_by_missing_metadata(
\&      metadata_type  => "latitude"
\&  );
.Ve
.IP "\fBlist_recent_changes\fR" 4
.IX Item "list_recent_changes"
This is documented in Wiki::Toolkit::Store::Database; see there for
parameters and return values.  All parameters are passed through
directly to the store object, so, for example,
.Sp
.Vb 1
\&  my @nodes = $wiki\->list_recent_changes( days => 7 );
.Ve
.Sp
does exactly the same thing as
.Sp
.Vb 1
\&  my @nodes = $wiki\->store\->list_recent_changes( days => 7 );
.Ve
.IP "\fBlist_unmoderated_nodes\fR" 4
.IX Item "list_unmoderated_nodes"
.Vb 4
\&  my @nodes = $wiki\->list_unmoderated_nodes();
\&  my @nodes = $wiki\->list_unmoderated_nodes(
\&                                                only_where_latest => 1
\&                                            );
\&
\&  $nodes[0]\->{\*(Aqname\*(Aq}              # The name of the node
\&  $nodes[0]\->{\*(Aqnode_id\*(Aq}           # The id of the node
\&  $nodes[0]\->{\*(Aqversion\*(Aq}           # The version in need of moderation
\&  $nodes[0]\->{\*(Aqmoderated_version\*(Aq} # The newest moderated version
\&
\&  Fetches details of all the node versions that require moderation (id,
\&   name, version, and latest moderated version).
\&
\&  If only_where_latest is set, then only the latest version of nodes where 
\&   the latest version needs moderating are returned.
\&  Otherwise, all node versions (including old ones, and possibly multiple
\&   per node) are returned.
.Ve
.IP "\fBlist_node_all_versions\fR" 4
.IX Item "list_node_all_versions"
.Vb 1
\&  my @versions = $wiki\->list_node_all_versions("HomePage");
\&
\&  my @versions = $wiki\->list_node_all_versions(
\&                                                name => \*(AqHomePage\*(Aq,
\&                                                with_content => 1,
\&                                                with_metadata => 0
\&                 );
.Ve
.Sp
Returns all the versions of a node, optionally including the content
and metadata, as an array of hashes (newest versions first).
.IP "\fBlist_last_version_before\fR List the last version of every node before a given date. If no version existed before that date, will return undef for version. Returns a hash of id, name, version and date" 4
.IX Item "list_last_version_before List the last version of every node before a given date. If no version existed before that date, will return undef for version. Returns a hash of id, name, version and date"
.Vb 2
\&    my @nv = $wiki\->list_last_version_before(\*(Aq2007\-01\-02 10:34:11\*(Aq)
\&    foreach my $data (@nv) {
\&        
\&    }
.Ve
.IP "\fBnode_exists\fR" 4
.IX Item "node_exists"
.Vb 1
\&  my $ok = $wiki\->node_exists( "Wombat Defenestration" );
\&
\&  # or ignore case \- optional but recommended
\&  my $ok = $wiki\->node_exists(
\&                               name        => "monkey brains",
\&                               ignore_case => 1,
\&                             );
.Ve
.Sp
Returns true if the node has ever been created (even if it is
currently empty), and false otherwise.
.Sp
By default, the case-sensitivity of \f(CW\*(C`node_exists\*(C'\fR depends on your
store backend.  If you supply a true value to the \f(CW\*(C`ignore_case\*(C'\fR
parameter, then you can be sure of its being case-insensitive.  This
is recommended.
.IP "\fBnode_required_moderation\fR" 4
.IX Item "node_required_moderation"
.Vb 1
\&  my $needs = $wiki\->node_required_moderation( "Wombat Defenestration" );
.Ve
.Sp
Returns true if the node exists and requires moderation, and false otherwise.
.IP "\fBdelete_node\fR" 4
.IX Item "delete_node"
.Vb 1
\&  $wiki\->delete_node( name => "Home Page", version => 15 );
.Ve
.Sp
\&\f(CW\*(C`version\*(C'\fR is optional.  If it is supplied then only that version of
the node will be deleted.  Otherwise the node and all its history will
be completely deleted.
.Sp
Doesn't do any locking though \- to fix? You probably don't want to let
anyone except Wiki admins call this. You may not want to use it at
all.
.Sp
Croaks on error, silently does nothing if the node or version doesn't
exist, returns true if no error.
.IP "\fBsearch_nodes\fR" 4
.IX Item "search_nodes"
.Vb 2
\&  # Find all the nodes which contain the word \*(Aqexpert\*(Aq.
\&  my %results = $wiki\->search_nodes(\*(Aqexpert\*(Aq);
.Ve
.Sp
Returns a (possibly empty) hash whose keys are the node names and
whose values are the scores in some kind of relevance-scoring system I
haven't entirely come up with yet. For \s-1OR\s0 searches, this could
initially be the number of terms that appear in the node, perhaps.
.Sp
Defaults to \s-1AND\s0 searches (if \f(CW$and_or\fR is not supplied, or is anything
other than \f(CW\*(C`OR\*(C'\fR or \f(CW\*(C`or\*(C'\fR).
.Sp
Searches are case-insensitive.
.Sp
Croaks if you haven't defined a search backend.
.IP "\fBsupports_phrase_searches\fR" 4
.IX Item "supports_phrase_searches"
.Vb 3
\&  if ( $wiki\->supports_phrase_searches ) {
\&      return $wiki\->search_nodes( \*(Aq"fox in socks"\*(Aq );
\&  }
.Ve
.Sp
Returns true if your chosen search backend supports phrase searching,
and false otherwise.
.IP "\fBsupports_fuzzy_searches\fR" 4
.IX Item "supports_fuzzy_searches"
.Vb 3
\&  if ( $wiki\->supports_fuzzy_searches ) {
\&      return $wiki\->fuzzy_title_match( \*(AqKings Cross, St Pancreas\*(Aq );
\&  }
.Ve
.Sp
Returns true if your chosen search backend supports fuzzy title searching,
and false otherwise.
.IP "\fBfuzzy_title_match\fR" 4
.IX Item "fuzzy_title_match"
\&\fB\s-1NOTE:\s0\fR This section of the documentation assumes you are using a
search engine which supports fuzzy matching. (See above.) The 
Wiki::Toolkit::Search::DBIxFTS backend in particular does not.
.Sp
.Vb 2
\&  $wiki\->write_node( "King\*(Aqs Cross St Pancras", "A station." );
\&  my %matches = $wiki\->fuzzy_title_match( "Kings Cross St. Pancras" );
.Ve
.Sp
Returns a (possibly empty) hash whose keys are the node names and
whose values are the scores in some kind of relevance-scoring system I
haven't entirely come up with yet.
.Sp
Note that even if an exact match is found, any other similar enough
matches will also be returned. However, any exact match is guaranteed
to have the highest relevance score.
.Sp
The matching is done against \*(L"canonicalised\*(R" forms of the search
string and the node titles in the database: stripping vowels, repeated
letters and non-word characters, and lowercasing.
.Sp
Croaks if you haven't defined a search backend.
.IP "\fBregister_plugin\fR" 4
.IX Item "register_plugin"
.Vb 2
\&  my $plugin = Wiki::Toolkit::Plugin::Foo\->new;
\&  $wiki\->register_plugin( plugin => $plugin );
.Ve
.Sp
Registers the plugin with the wiki as one that needs to be informed
when we write a node.
.Sp
If the plugin \f(CW\*(C`isa\*(C'\fR Wiki::Toolkit::Plugin, calls the methods set up by
that parent class to let it know about the backend store, search and
formatter objects.
.Sp
Finally, calls the plugin class's \f(CW\*(C`on_register\*(C'\fR method, which should
be used to check tables are set up etc. Note that because of the order
these things are done in, \f(CW\*(C`on_register\*(C'\fR for Wiki::Toolkit::Plugin
subclasses can use the \f(CW\*(C`datastore\*(C'\fR, \f(CW\*(C`indexer\*(C'\fR and \f(CW\*(C`formatter\*(C'\fR
methods as it needs to.
.IP "\fBget_registered_plugins\fR" 4
.IX Item "get_registered_plugins"
.Vb 1
\&  my @plugins = $wiki\->get_registered_plugins;
.Ve
.Sp
Returns an array of plugin objects.
.IP "\fBwrite_node\fR" 4
.IX Item "write_node"
.Vb 6
\&  my $written = $wiki\->write_node($node, $content, $checksum, \e%metadata, $requires_moderation);
\&  if ($written) {
\&      display_node($node);
\&  } else {
\&      handle_conflict();
\&  }
.Ve
.Sp
Writes the specified content into the specified node in the backend
storage; and indexes/reindexes the node in the search indexes (if a
search is set up); calls \f(CW\*(C`post_write\*(C'\fR on any registered plugins.
.Sp
Note that you can blank out a node without deleting it by passing the
empty string as \f(CW$content\fR, if you want to.
.Sp
If you expect the node to already exist, you must supply a checksum,
and the node is write-locked until either your checksum has been
proved old, or your checksum has been accepted and your change
committed.  If no checksum is supplied, and the node is found to
already exist and be nonempty, a conflict will be raised.
.Sp
The first two parameters are mandatory, the others optional. If you
want to supply metadata but have no checksum (for a newly-created
node), supply a checksum of \f(CW\*(C`undef\*(C'\fR.
.Sp
The final parameter, \f(CW$requires_moderation\fR (which defaults to false),
is ignored except on new nodes. For existing nodes, use 
\&\f(CW$wiki\fR\->toggle_node_moderation to change the node moderation flag.
.Sp
Returns the version of the updated node on success, 0 on conflict, croaks on
error.
.Sp
\&\fBNote\fR on the metadata hashref: Any data in here that you wish to
access directly later must be a key-value pair in which the value is
either a scalar or a reference to an array of scalars.  For example:
.Sp
.Vb 3
\&  $wiki\->write_node( "Calthorpe Arms", "nice pub", $checksum,
\&                     { category => [ "Pubs", "Bloomsbury" ],
\&                       postcode => "WC1X 8JR" } );
\&
\&  # and later
\&
\&  my @nodes = $wiki\->list_nodes_by_metadata(
\&      metadata_type  => "category",
\&      metadata_value => "Pubs"             );
.Ve
.Sp
For more advanced usage (passing data through to registered plugins)
you may if you wish pass key-value pairs in which the value is a
hashref or an array of hashrefs. The data in the hashrefs will not be
stored as metadata; it will be checksummed and the checksum will be
stored instead. Such data can \fIonly\fR be accessed via plugins.
.IP "\fBformat\fR" 4
.IX Item "format"
.Vb 1
\&  my $cooked = $wiki\->format($raw, $metadata);
.Ve
.Sp
Passed straight through to your chosen formatter object. You do not
\&\fIhave\fR to supply the \f(CW$metadata\fR hashref, but if your formatter
allows node metadata to affect the rendering of the node then you
will want to.
.IP "\fBstore\fR" 4
.IX Item "store"
.Vb 3
\&  my $store  = $wiki\->store;
\&  my $dbname = eval { $wiki\->store\->dbname; }
\&    or warn "Not a DB backend";
.Ve
.Sp
Returns the storage backend object.
.IP "\fBsearch_obj\fR" 4
.IX Item "search_obj"
.Vb 1
\&  my $search_obj = $wiki\->search_obj;
.Ve
.Sp
Returns the search backend object.
.IP "\fBformatter\fR" 4
.IX Item "formatter"
.Vb 1
\&  my $formatter = $wiki\->formatter;
.Ve
.Sp
Returns the formatter backend object.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
For a very quick Wiki startup without any of that icky programming
stuff, see Tom Insam's Wiki::Toolkit::Kwiki, an instant wiki based on
Wiki::Toolkit.
.PP
Or for the specialised application of a wiki about a city, see the
OpenGuides distribution.
.PP
Wiki::Toolkit allows you to use different formatting modules. 
Text::WikiFormat might be useful for anyone wanting to write a
custom formatter. Existing formatters include:
.IP "\(bu" 4
Wiki::Toolkit::Formatter::Default (in this distro)
.IP "\(bu" 4
Wiki::Toolkit::Formatter::Pod
.IP "\(bu" 4
Wiki::Toolkit::Formatter::UseMod
.PP
There's currently a choice of three storage backends \- all
database-backed.
.IP "\(bu" 4
Wiki::Toolkit::Store::MySQL (in this distro)
.IP "\(bu" 4
Wiki::Toolkit::Store::Pg (in this distro)
.IP "\(bu" 4
Wiki::Toolkit::Store::SQLite (in this distro)
.IP "\(bu" 4
Wiki::Toolkit::Store::Database (parent class for the above \- in this distro)
.PP
A search backend is optional:
.IP "\(bu" 4
Wiki::Toolkit::Search::DBIxFTS (in this distro, uses DBIx::FullTextSearch)
.IP "\(bu" 4
Wiki::Toolkit::Search::SII (in this distro, uses Search::InvertedIndex)
.PP
Standalone plugins can also be written \- currently they should only
read from the backend storage, but write access guidelines are coming
soon. Plugins written so far and available from \s-1CPAN:\s0
.IP "\(bu" 4
Wiki::Toolkit::Plugin::GeoCache
.IP "\(bu" 4
Wiki::Toolkit::Plugin::Categoriser
.IP "\(bu" 4
Wiki::Toolkit::Plugin::Locator::UK
.IP "\(bu" 4
Wiki::Toolkit::Plugin::RSS::ModWiki
.PP
If writing a plugin you might want an easy way to run tests for it on
all possible backends:
.IP "\(bu" 4
Wiki::Toolkit::TestConfig::Utilities (in this distro)
.PP
Other ways to implement Wikis in Perl include:
.IP "\(bu" 4
CGI::Kwiki (an instant wiki)
.IP "\(bu" 4
CGI::pWiki
.IP "\(bu" 4
AxKit::XSP::Wiki
.IP "\(bu" 4
Apache::MiniWiki
.IP "\(bu" 4
UseModWiki <http://usemod.com>
.IP "\(bu" 4
Chiq Chaq <http://chiqchaq.sourceforge.net/>
.SH "AUTHOR"
.IX Header "AUTHOR"
Kake Pugh (kake@earth.li) and the Wiki::Toolkit team (including Nick Burch
and Dominic Hargreaves)
.SH "SUPPORT"
.IX Header "SUPPORT"
Questions should go to cgi\-wiki\-dev@earth.li.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 2
\&     Copyright (C) 2002\-2004 Kake Pugh.  All Rights Reserved.
\&     Copyright (C) 2006\-2013 the Wiki::Toolkit team. All Rights Reserved.
.Ve
.PP
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.SH "FEEDBACK"
.IX Header "FEEDBACK"
The developer web site and bug tracker is at
  http://www.wiki\-toolkit.org/ \- please file bugs there as appropriate.
.PP
You could also subscribe to the dev list at
  http://www.earth.li/cgi\-bin/mailman/listinfo/cgi\-wiki\-dev
.SH "BUGS"
.IX Header "BUGS"
Bugs are documented at <https://github.com/OpenGuides/Wiki\-Toolkit/issues>
.SH "CREDITS"
.IX Header "CREDITS"
Various London.pm types helped out with code review, encouragement,
\&\s-1JFDI,\s0 style advice, code snippets, module recommendations, and so on;
far too many to name individually, but particularly Richard Clamp,
Tony Fisher, Mark Fowler, and Chris Ball.
.PP
blair christensen sent patches and gave me some good ideas. chromatic
continues to patiently apply my patches to Text::WikiFormat and
help me get it working in just the way I need. Paul Makepeace helped
me add support for connecting to non-local databases. Shevek has been
prodding me a lot lately. The OpenGuides team keep me well-supplied
with encouragement and bug reports.
.PP
Nick Burch has been leading the way with development leading up to the
release under the Wiki::Toolkit name.
.SH "GRATUITOUS PLUG"
.IX Header "GRATUITOUS PLUG"
I'm only obsessed with Wikis because of the Open Guide to London \*(--
<http://openguides.org/london/>