]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/features.mdwn
- finish user registration and password request email
[ikiwiki.git] / doc / features.mdwn
index d3226586be8bd9aa795c751f9927a287e9c4d3dd..8a05a1679ff95e47df79a044034c3dcbb6c1abce 100644 (file)
@@ -1,5 +1,15 @@
+[[WhyIkiWiki]]?
+
 Currently implemented:
 
+* [[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).
+
+  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 when you come online. Deal with edit conflicts with others in a sane environment. Take advantage of subversion's smart merges.
+
+ ikiwiki can be run from a [[post-commit]] hook to update your wiki immediately whenever you commit.
+
 * [[MarkDown]]
 
   ikiwiki supports pages using [[MarkDown]] as their markup language. Any
@@ -19,7 +29,35 @@ Currently implemented:
 
   Arbitrarily deep hierarchies of pages with fairly simple and useful [[SubPage/LinkingRUles]]
 
-----
+* Fast compiler
+
+  ikiwiki is fast and smart about updating a wiki, it only builds pages that have changed (and tracks things like creation of new pages and links that can indirectly cause a page to need a rebuild)
+
+* [[Templates]]
+
+  ikiwiki generates html using templates 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.
+
+* [[PageHistory]]
+
+  Well, sorta. Rather than implementing YA history browser, it can link to
+  [[ViewCVS]] or the link to browse the history of a wiki page.
+
+* [[RecentChanges]], editing pages in a web browser
+
+  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]].
+
+* User registration
+
+  Can optionally be configured to allow only registered users to post
+  pages; online user registration form, etc.
+
+----
 
-[[TODO]]
\ No newline at end of file
+It also has lots of [[TODO]] items and [[Bugs]]. This wiki is not ready for production!