]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/features.mdwn
fix Discussion links to not take the BestLink.
[ikiwiki.git] / doc / features.mdwn
index 0f2c57761e7db1f2eed7f551ceb0409a1c012823..6f5b638f5bb5ebb8d7d3a67dd18363f4c9529fc5 100644 (file)
@@ -1,12 +1,24 @@
+[[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).
+  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.
 
-  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.
 
- ikiwiki can be run from a [[post-commit]] hook to update your wiki immediatly whenever you commit.
+  Note that ikiwiki does not require subversion to function. If you want to
+  run a simple wiki without page history, it can do that too.
 
 * [[MarkDown]]
 
@@ -31,14 +43,37 @@ Currently implemented:
 
   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.
 
-* [[RecentChanges]], editng pages in a web browser
+* [[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.
+
+* Discussion pages
 
-  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]].
+  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.
 
 ----
 
-It also has lots of [[TODO]] items and [[Bugs]]. This wiki is not ready for production!
\ No newline at end of file
+It also has lots of [[TODO]] items and [[Bugs]]. This wiki is not ready for production!