]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/features.mdwn
web commit by joey
[ikiwiki.git] / doc / features.mdwn
index 80f7b58c85aa186b13d438df3df84e672752ba09..3ab10c1102815daf3e010c33ce6e7b06d792761a 100644 (file)
@@ -1,6 +1,4 @@
-[[WhyIkiWiki]]?
-
-Currently implemented:
+Some of ikiwiki's features:
 
 * [[Subversion]]
 
@@ -25,7 +23,8 @@ 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
 
@@ -44,7 +43,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.
+  Ikiwikit's own [[TODO]] and [[news]] pages are good examples of some of
+  the flexible ways that this can be used.
 
 * Fast compiler
 
@@ -52,14 +52,17 @@ Currently implemented:
   that have changed (and tracks things like creation of new pages and links
   that can indirectly cause a page to need a rebuild)
 
-* [[Templates]]
+* valid html and css
 
-  ikiwiki generates html using templates so you can change the look and 
-  layout of all pages in any way you would like.
+  ikiwiki aims to produce 
+  [valid XHTML 1.0](http://validator.w3.org/check?url=referer).
+  ikiwiki generates html using [[templates]], and uses css, so you can 
+  change the look and layout of all pages in any way you would like.
 
 * [[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]]
 
@@ -88,7 +91,7 @@ Currently implemented:
   Since it uses subversion, ikiwiki takes advantage of its smart merging to
   avoid any conflicts when two people edit different parts of the same page
   at the same time. No annoying warnings about other editors, or locking,
-  etc, instead the other person's changes will be automaticaly merged with
+  etc, instead the other person's changes will be automatically merged with
   yours when you commit.
 
   In the rare cases where automatic merging fails due to the same part of a
@@ -96,10 +99,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]].