web commit by ThomasSchwinge: Initial version.

[ikiwiki.git] / doc / features.mdwn

diff --git a/doc/features.mdwn b/doc/features.mdwn
index eaf0d539fb5588189975bb93dcc5d074ba625511..5765552f01d85482ea8deb08df2e359b60dc88cb 100644 (file)
--- a/doc/features.mdwn
+++ b/doc/features.mdwn
@@ -1,13 +1,9 @@
-[[WhyIkiWiki]]?
-
-Currently implemented:
+Some of ikiwiki's features:
 
 * [[Subversion]]
 
   Rather than implement its own system for storing page histories etc,
-  ikiwiki simply uses subversion. (Supporting other revision control
-  systems is also possible, ikiwiki only needs $FOO add, $FOO commit, and
-  $FOO log).
+  ikiwiki simply uses subversion. (It's also possible to [[plugins/write]] support for other systems.)
 
   Instead of editing pages in a stupid web form, you can use vim and commit
   changes via svn. Or work disconnected using svk and push your changes out
@@ -25,11 +21,12 @@ Currently implemented:
   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 aside from regular markdown is the [[WikiLink]].
+  provided by ikiwiki aside from regular markdown is the [[WikiLink]] and 
+  [[PreprocessorDirective]]
 
 * support for other file types
 
-  ikiwiki also supports files of any other type, including raw html, text,
+  ikiwiki also supports files of any other type, including plain text,
   images, etc. These are not converted to wiki pages, they are just copied
   unchanged by ikiwiki as it builds your wiki. So you can check in an image,
   program, or other special file and link to it from your wiki pages.
@@ -44,7 +41,8 @@ Currently implemented:
   matching a specified [[GlobList]] will be displayed as a weblog within
   the blog page. And an RSS feed can be generated to follow the blog.
 
-  Ikiwikit's own [[TODO]] and [[news]] pages are good examples of some of the flexible ways that this can be used.
+  Ikiwiki's own [[TODO]], [[news]], and [[plugins]] pages are good examples of some of
+  the flexible ways that this can be used.
 
 * Fast compiler
 
@@ -61,7 +59,8 @@ Currently implemented:
 
 * [[BackLinks]]
 
-  Automatically included on pages. Rather faster than eg [[MoinMoin]] and always there to help with navigation.
+  Automatically included on pages. Rather faster than eg MoinMoin and
+  always there to help with navigation.
 
 * [[PageHistory]]
 
@@ -98,10 +97,27 @@ Currently implemented:
   shown in the file to resolve the conflict, so if you're already familiar
   with that there's no new commit marker syntax to learn.
 
+  For all the gory details of how ikiwiki handles this behind the scenes,
+  see [[commit-internals]].
+
 * page locking
 
   Wiki admins can lock pages so that only other admins can edit them.
 
+* Full text search
+
+  ikiwiki can use the [[HyperEstraier]] search engine to add powerful
+  full text search capabilities to your wiki.
+
+* Commit mails
+
+  ikiwiki can be configured to send you commit mails with diffs of changes
+  to selected pages.
+
+* [[Plugins]]
+
+  Plugins can be used to add additional features to ikiwiki. The interface is quite flexible, allowing plugins to register [[PreProcessorDirective]]s, hook into [[CGI]] mode, and more. Ikiwiki's backend RCS support is also pluggable, so support for new revision control systems can be added to ikiwiki. 
+
 ----
 
 It also has some [[TODO]] items and [[Bugs]].