An overview of some of ikiwiki's features:
-[[toc ]]
+[[!toc ]]
## Uses a real RCS
Rather than implement its own system for storing page histories etc,
-ikiwiki uses a real Revision Control System. This isn't (just) because we're
-lazy, it's because a real RCS is a good thing to have, and there are
-advantages to using one that are not possible with a standard wiki.
+ikiwiki uses a real [[Revision_Control_System|rcs]]. This isn't (just)
+because we're lazy, it's because a real RCS is a good thing to have, and
+there are advantages to using one that are not possible with a standard
+wiki.
Instead of editing pages in a stupid web form, you can use vim and commit
changes via [[Subversion|rcs/svn]], [[rcs/git]], or any of a number of other
ikiwiki can be run from a [[post-commit]] hook to update your wiki
immediately whenever you commit a change using the RCS.
+It's even possible to securely let
+[[anonymous_users_git_push_changes|tips/untrusted_git_push]]
+to the wiki.
+
Note that ikiwiki does not require a RCS to function. If you want to
run a simple wiki without page history, it can do that too.
## Supports many markup languages
-By default, pages in the wiki are written using the [[MarkDown]] format.
+By default, pages in the wiki are written using the [[ikiwiki/MarkDown]] format.
Any page with a filename ending in ".mdwn" is converted from markdown to html
by ikiwiki. Markdown understands text formatted as it would be in an email,
and is quite smart about converting it to html. The only additional markup
-provided by ikiwiki on top of regular markdown is the [[WikiLink]] and
-[[PreprocessorDirective]].
+provided by ikiwiki on top of regular markdown is the [[ikiwiki/WikiLink]] and
+the [[ikiwiki/directive]].
If you prefer to use some other markup language, ikiwiki allows others to
easily be added by [[plugins]]. For example it also supports traditional
## Blogging
You can turn any page in the wiki into a [[blog]]. Pages matching a
-specified [[PageSpec]] will be displayed as a weblog within the blog
+specified [[ikiwiki/PageSpec]] will be displayed as a weblog within the blog
page. And RSS or Atom feeds can be generated to follow the blog.
Ikiwiki's own [[TODO]], [[news]], and [[plugins]] pages are good examples
## [[Plugins]]
-Plugins can be used to add additional features to ikiwiki. The interface
-is quite flexible, allowing plugins to implement additional markup
-languages, register [[PreProcessorDirective]]s, hook into [[CGI]] mode,
-and more. Most of ikiwiki's features are actually provided by plugins.
-Ikiwiki's backend RCS support is also pluggable, so support for new
-revision control systems can be added to ikiwiki.
+Plugins can be used to add additional features to ikiwiki. The interface is
+quite flexible, allowing plugins to implement additional markup languages,
+register [[directives|ikiwiki/directive]], provide a [[RCS]] backend, hook
+into [[CGI]] mode, and much more. Most of ikiwiki's features are actually
+provided by plugins.
The standard language for ikiwiki plugins is perl, but ikiwiki also supports
[[plugins/write/external]] plugins: Standalone programs that can be written in
up in the ways you'd expect, like at the bottom of pages, in blogs, and
in RSS and Atom feeds.
-### [[SubPages|SubPage]]
+### [[SubPages|ikiwiki/SubPage]]
Arbitrarily deep hierarchies of pages with fairly simple and useful
-[[SubPage/LinkingRules]]
+[[ikiwiki/SubPage/LinkingRules]]
### [[BackLinks]]
Nearly the definition of a wiki, although perhaps ikiwiki challenges how
much of that web gunk a wiki really needs. These features are optional
-and can be enabled by enabling [[CGI]].
+and can be enabled by enabling [[CGI]] and a [[Revision_Control_System|rcs]].
### User registration
Thanks to subpages, every page can easily and automatically have a
/Discussion subpage. By default, these links are included in the
-[[templates]] for each page.
+[[templates]] for each page. If you prefer blog-syle
+[[plugins/comments]], that is available too.
### Edit controls
-Wiki admins can [[lock_pages|page_locking]] so that only other admins can
-edit them. Or a wiki can be set up to allow anyone to edit Discussion
-pages, but only registered users to edit other pages. These are just two
-possibilities, since page edit controls can be changed via plugins.
+Wiki admins can lock pages so that only other admins can edit them. Or a
+wiki can be set up to allow anyone to edit Discussion pages, but only
+registered users to edit other pages. These are just two possibilities,
+since page edit controls can be changed via plugins.
### [[PageHistory]]
### Full text search
-ikiwiki can use the [[HyperEstraier]] search engine to add powerful
-full text search capabilities to your wiki.
+ikiwiki can use the xapian search engine to add powerful
+full text [[plugins/search]] capabilities to your wiki.
-### Commit mails
+### Translation via po files
-ikiwiki can be configured to send you commit mails with diffs of changes
-to selected pages.
+The [[plugins/po]] plugin allows translating individual wiki pages using
+standard `po` files.
### [[w3mmode]]