]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/features.mdwn
web commit by joey
[ikiwiki.git] / doc / features.mdwn
index 6f5b638f5bb5ebb8d7d3a67dd18363f4c9529fc5..a4f577f8f877b3ed28a535a2361d0ee9b6b72348 100644 (file)
@@ -11,8 +11,7 @@ Currently implemented:
 
   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.
+  when you come online.
 
   ikiwiki can be run from a [[post-commit]] hook to update your wiki
   immediately whenever you commit.
@@ -37,16 +36,29 @@ Currently implemented:
 
 * [[SubPage]]s
 
-  Arbitrarily deep hierarchies of pages with fairly simple and useful [[SubPage/LinkingRUles]]
+  Arbitrarily deep hierarchies of pages with fairly simple and useful [[SubPage/LinkingRules]]
+
+* [[blog]]s
+
+  You can turn any page in the wiki into a [[blog]]. Pages with names 
+  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.
 
 * 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)
+  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]]
+* 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]]
 
@@ -74,6 +86,33 @@ Currently implemented:
   /Discussion subpage. By default, these links are included in the
   [[templates]] for each page.
 
+* Smart merging and conflict resolution in your web browser
+
+  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 automatically merged with
+  yours when you commit.
+
+  In the rare cases where automatic merging fails due to the same part of a
+  page being concurrently edited, regular subversion commit markers are
+  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.
+
+* 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 commits mails with diffs of changes
+  of selected pages.
+
 ----
 
-It also has lots of [[TODO]] items and [[Bugs]]. This wiki is not ready for production!
+It also has some [[TODO]] items and [[Bugs]].