]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/features.mdwn
misc updated
[ikiwiki.git] / doc / features.mdwn
index 3b3b8ff9b902d77a54ee892c5d6e9a2a47f82d82..0992130e5b28d2ce88112f0774479e10412cca87 100644 (file)
@@ -1,13 +1,11 @@
-[[WhyIkiWiki]]?
-
-Currently implemented:
+Some of ikiwiki's features:
 
 * [[Subversion]]
 
   Rather than implement its own system for storing page histories etc,
 
 * [[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, and ikiwiki also includes support for [[Git]]
+  now.)
 
   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
 
   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 +23,15 @@ 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
   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]]
+
+  If you prefer to use some other markup language, ikiwiki allows others to
+  be added by [[plugins]].
 
 * support for other file types
 
 
 * 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.
   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.
@@ -38,13 +40,18 @@ Currently implemented:
 
   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
+* [[blogging|blog]]
+
+  You can turn any page in the wiki into a [[blog]]. Pages 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.
 
 
-  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.
+  Ikiwiki's own [[TODO]], [[news]], and [[plugins]] 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.
+* [[tags]]
+
+  You can tag pages and use these tags in various ways.
 
 * Fast compiler
 
 
 * Fast compiler
 
@@ -61,7 +68,8 @@ Currently implemented:
 
 * [[BackLinks]]
 
 
 * [[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]]
 
 
 * [[PageHistory]]
 
@@ -107,6 +115,24 @@ Currently implemented:
   ikiwiki can use the [[HyperEstraier]] search engine to add powerful
   full text search capabilities to your wiki.
 
   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 implement additional markup
+  languages, 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. 
+
+* [[todo/utf8]]
+
+  After rather a lot of fiddling, we think that ikiwiki correctly and fully
+  supports utf8 everywhere.
+
 ----
 
 It also has some [[TODO]] items and [[Bugs]].
 ----
 
 It also has some [[TODO]] items and [[Bugs]].