* Support a w3mmode, which lets w3m run ikiwiki using its local CGI

[git.ikiwiki.info.git] / doc / features.mdwn

diff --git a/doc/features.mdwn b/doc/features.mdwn
index eaf0d539fb5588189975bb93dcc5d074ba625511..1b09a32747241477b2a9a96d22bd5c723db5a88b 100644 (file)
--- a/doc/features.mdwn
+++ b/doc/features.mdwn
@@ -1,13 +1,11 @@
-[[WhyIkiWiki]]?
-
-Currently implemented:
+Some of ikiwiki's features:
 
 * [[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
@@ -25,26 +23,38 @@ 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 on top of regular markdown is the [[WikiLink]] and 
+  [[PreprocessorDirective]]
+
+  If you prefer to use some other markup language, ikiwiki allows others to
+  easily be added by [[plugins]]. For example it also supports traditional
+  [[plugins/WikiText]] formatted pages or pages written as pure
+  [[plugins/HTML]].
 
 * 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.
 
-* [[SubPage]]s
+* [[SubPages|SubPage]]
+
+  Arbitrarily deep hierarchies of pages with fairly simple and useful
+  [[SubPage/LinkingRules]]
+
+* [[blogging|blog]]
 
-  Arbitrarily deep hierarchies of pages with fairly simple and useful [[SubPage/LinkingRules]]
+  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.
 
-* [[blog]]s
+  Ikiwiki's own [[TODO]], [[news]], and [[plugins]] pages are good examples
+  of some of the flexible ways that this can be used.
 
-  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.
+* [[tags]]
 
-  Ikiwikit's own [[TODO]] and [[news]] pages are good examples of some of the flexible ways that this can be used.
+  You can tag pages and use these tags in various ways.
 
 * Fast compiler
 
@@ -61,12 +71,13 @@ Currently implemented:
 
 * [[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]]
 
   Well, sorta. Rather than implementing YA history browser, it can link to
-  [[ViewCVS]] or the link to browse the history of a wiki page.
+  [[ViewCVS]] or the like to browse the history of a wiki page.
 
 * [[RecentChanges]], editing pages in a web browser
 
@@ -102,6 +113,34 @@ Currently implemented:
 
   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 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.
+
+* [[w3mmode]]
+
+  Can be set up so that w3m can be used to browse a wiki and edit pages
+  without using a web server.
+
 ----
 
 It also has some [[TODO]] items and [[Bugs]].