---

Page Source for PodWikiTools

=begin options 

write = root 

=end 

=head3 PodWiki Tools 

B<PodWiki> includes a number of tools for site and page
maintenance which are described here in detail. 

=head4 L<Page Index|state:pageindex> 

The B<Page Index> lists all existing pages of the B
<PodWiki> site. Be carefull: this can become a huge table after a
while! 

For every page is an B<Edit|PodWikiEdit> and
B<Remove|PodWikiRemovedPages> link provided. Removed pages can be
l<restored|PodWikiRemovedPages>. 

=head4 L<Newest Pages|state:newest> 

This lists the B<5> lates changed pages of the whole site. 

=head4 L<File Index|state:fileindex> 

This is a listing of all uploaded files (such as images or pdf files).
You are able to remove files from this listing. Removed files cannot be
restored, so be carefull! 

=head4 L<Search|state:search> 

The search form provides a complete searching capability for your 

It is possible to do a full text search or an index search. The latter
only works if indexed pages exists. 

If you are using L<attributes|PodWikiMarkup#Attributes> an
attribute search form will be provided as well. 

=head4 L<Editor|state:edit?page=none> 

The editor is available for every page. It allows the user to edit a
page and to change or apply attributes to a page (if attributes have
been configured by the administrator). 

You can upload files from the editor form. 

=head3 Administrator Tools 

These tools are only available (and even visible) if you are logged in
as B<root>. 

=head4 L<Site Admin|state:site_admin> 

This is the main interface for the site administrator. It allows the
administrator to create or modify Users, Groups, Attributes and
Variables. 

It also provides a link to the L<Upload PodWiki Pages and
Documentation|state:docupdate_admin> tool which makes it possible to
update one or more pages, especially the documentation of PodWiki
itself. 

From the Site Admin page you can also view a list of all installed
templates. The template currently in use is marked green. More about
templates: L<PodWikiTemplates>. 

=head4 Remove Comment 

This is only a link, visible if logged in as root. Visit the page where
the comment to be removed is posted and click this link. 

=head3 User Tools 

These are tools (or: internal states) usable by PodWiki users by
including them in a page: 

=over 

=item B<state> 

The core engine of PodWiki. This state must be called everytimes. Take
a look at the B<AutoLoad> Page which makes use of this one. If
you do not include this, PodWiki will not work at all! 

=item B<edit_bar> 

Display the edit bar which provides links to edit the current document
and to the revision control info box. 

=item B<toc> 

Show the table of contents (build from all =head tags). 

=item B<toc_by_attribute> 

Show table of all pages matching an attribute. Just add the
attribute/value as CGI param to the state. 

=item B<comments> 

Includes the comment feature to a page. The recommended position where
to include this state is the end of a page. All posted comments will be
displayed. Visitors are able to post new comments and it is possible to
reply to a comment. 

The B<root>-User is able to remove comments. Just login as root,
visit the page where the comment to be removed is posted and click the
"remove comment" link. 

Comments can be written in L<PodWikiMarkup> or
L<WikiShorthand> markup. 

=back 

Read the L<PodWikiMarkup> page for more details. 

=cut 

---