foo

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

diff --git a/doc/features.mdwn b/doc/features.mdwn
index 2b06a7917df2ab751d38c5236d67e48c2034c9c4..05aeebfc9cf93ef15244af1445422c62b6f0e7c5 100644 (file)
--- a/doc/features.mdwn
+++ b/doc/features.mdwn
@@ -4,25 +4,25 @@ An overview of some of ikiwiki's features:
 ## Uses a real RCS
 
 Rather than implement its own system for storing page histories etc,
 ## Uses a real RCS
 
 Rather than implement its own system for storing page histories etc,

-ikiwiki uses a real RCS. This isn't because we're lazy, it's because a
-real RCS is a good thing to have, and there are advantages to using one
-that are not possible with a standard wiki.
+ikiwiki uses a real Revision Control System. This isn't because we're
+lazy, it's because a real RCS is a good thing to have, and there are
+advantages to using one that are not possible with a standard wiki.

 
 Instead of editing pages in a stupid web form, you can use vim and commit
 
 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. Or use git to work in a distributed fashion all the
-time. (It's also possible to [[plugins/write]] a plugin to support other
-systems.)
+changes via [[Subversion]]. Or work disconnected using svk and push your
+changes out when you come online. Or use [[git]], [[tla]], or [[mercurial]]
+to work in a distributed fashion all the time. (It's also possible to
+[[plugins/write]] a plugin to support other systems.)

 
 ikiwiki can be run from a [[post-commit]] hook to update your wiki
 
 ikiwiki can be run from a [[post-commit]] hook to update your wiki

-immediately whenever you commit.
+immediately whenever you commit a change using the RCS.

 
 Note that ikiwiki does not require a RCS to function. If you want to
 run a simple wiki without page history, it can do that too.
 
 ## A wiki compiler
 
 
 Note that ikiwiki does not require a RCS to function. If you want to
 run a simple wiki without page history, it can do that too.
 
 ## A wiki compiler
 

-ikiwiki is a wiki compiler; it builds static website for your wiki, and
+ikiwiki is a wiki compiler; it builds a static website for your wiki, and

 updates it as pages are edited. It 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)
 updates it as pages are edited. It 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)


@@ -50,20 +50,25 @@ program, or other special file and link to it from your wiki pages.
 
 You can turn any page in the wiki into a [[blog]]. Pages matching a
 specified [[PageSpec]] will be displayed as a weblog within the blog
 
 You can turn any page in the wiki into a [[blog]]. Pages matching a
 specified [[PageSpec]] will be displayed as a weblog within the blog

-page. And an RSS feed can be generated to follow the blog.
+page. And RSS or Atom feeds can be generated to follow the blog.

 
 Ikiwiki's own [[TODO]], [[news]], and [[plugins]] pages are good examples
 
 Ikiwiki's own [[TODO]], [[news]], and [[plugins]] pages are good examples

-of some of the flexible ways that this can be used.
+of some of the flexible ways that this can be used. There is also an 
+[[example_blog|examples/blog]] set up that you can copy into your own wiki.

 
 Ikiwiki can also [[plugins/aggregate]] external blogs, feeding them into
 the wiki. This can be used to create a Planet type site that aggregates
 interesting feeds.
 
 
 Ikiwiki can also [[plugins/aggregate]] external blogs, feeding them into
 the wiki. This can be used to create a Planet type site that aggregates
 interesting feeds.
 

-## Valid html and css
+You can also mix blogging with podcasting by dropping audio files where
+they will be picked up like blog posts. This will work for any files that
+you would care to syndicate.
+
+## Valid html and [[css]]

 
 ikiwiki aims to produce 
 [valid XHTML 1.0](http://validator.w3.org/check?url=referer).
 
 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 
+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.
 
 ## [[Plugins]]
 change the look and layout of all pages in any way you would like.
 
 ## [[Plugins]]


@@ -90,7 +95,7 @@ incomplete list of some of them.
 
 You can tag pages and use these tags in various ways. Tags will show
 up in the ways you'd expect, like at the bottom of pages, in blogs, and
 
 You can tag pages and use these tags in various ways. Tags will show
 up in the ways you'd expect, like at the bottom of pages, in blogs, and

-in rss feeds.
+in RSS and Atom feeds.

 
 ### [[SubPages|SubPage]]
 
 
 ### [[SubPages|SubPage]]
 


@@ -124,7 +129,11 @@ and can be enabled by enabling [[CGI]].
 ### User registration
 
 Can optionally be configured to allow only registered users to post
 ### User registration
 
 Can optionally be configured to allow only registered users to post

-pages; online user registration form, etc.
+pages.
+
+User registration can be done using a web form, or ikiwiki can be
+configured to accept users authenticated with OpenID, or HTTP basic
+authentication, or other methods implemented via plugins.

 
 ### Discussion pages
 
 
 ### Discussion pages