Merge branch 'fancypodcast' of github.com:schmonz/ikiwiki into fancypodcast

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

diff --git a/doc/features.mdwn b/doc/features.mdwn
index 1d762bed4d95a9b15d8e950ec1330455ded61909..5bbe5ef2190685c98a0c8a7b5d5f2d5553343a6e 100644 (file)
--- a/doc/features.mdwn
+++ b/doc/features.mdwn
@@ -1,26 +1,31 @@
 An overview of some of ikiwiki's features:
 An overview of some of ikiwiki's features:

-[[toc ]]
+[[!toc ]]

 
 ## 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 Revision Control System. This isn't (just) 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|rcs]]. This isn't (just)
+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
 changes via [[Subversion|rcs/svn]], [[rcs/git]], or any of a number of other
 [[Revision_Control_Systems|rcs]].
 
 
 Instead of editing pages in a stupid web form, you can use vim and commit
 changes via [[Subversion|rcs/svn]], [[rcs/git]], or any of a number of other
 [[Revision_Control_Systems|rcs]].
 

-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 a change using the RCS.
 
 immediately whenever you commit a change using the RCS.
 

+It's even possible to securely let
+[[anonymous_users_git_push_changes|tips/untrusted_git_push]]
+to the wiki.
+

 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 a 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)


@@ -32,7 +37,7 @@ Any 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 on top of regular markdown is the [[ikiwiki/WikiLink]] and 
 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 on top of regular markdown is the [[ikiwiki/WikiLink]] and 

-[[ikiwiki/PreprocessorDirective]].
+the [[ikiwiki/directive]].

 
 If you prefer to use some other markup language, ikiwiki allows others to
 easily be added by [[plugins]]. For example it also supports traditional
 
 If you prefer to use some other markup language, ikiwiki allows others to
 easily be added by [[plugins]]. For example it also supports traditional


@@ -40,14 +45,14 @@ easily be added by [[plugins]]. For example it also supports traditional
 [[plugins/HTML]], or pages written in [[reStructuredText|plugins/rst]]
 or [[Textile|plugins/textile]].
 
 [[plugins/HTML]], or pages written in [[reStructuredText|plugins/rst]]
 or [[Textile|plugins/textile]].
 

-ikiwiki also supports files of any other type, including plain 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.
 
 ## Blogging
 
 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.
 
 ## Blogging
 

-You can turn any page in the wiki into a [[ikiwiki/blog]]. Pages matching a
+You can turn any page in the wiki into a [[blog]]. Pages matching a

 specified [[ikiwiki/PageSpec]] will be displayed as a weblog within the blog
 page. And RSS or Atom feeds can be generated to follow the blog.
 
 specified [[ikiwiki/PageSpec]] will be displayed as a weblog within the blog
 page. And RSS or Atom feeds can be generated to follow the blog.
 


@@ -59,25 +64,30 @@ 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.
 
 the wiki. This can be used to create a Planet type site that aggregates
 interesting feeds.
 

-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.
+You can also mix blogging with podcasting. Simply drop media files
+where they will be picked up like blog posts. For fuller-featured
+podcast feeds, enclose media files in blog posts using [[plugins/meta]].
+Either way, this will work for any files that you would care to
+syndicate.

 
 ## Valid html and [[css]]
 
 
 ## Valid html and [[css]]
 

-ikiwiki aims to produce 
-[valid XHTML 1.0](http://validator.w3.org/check?url=referer). ikiwiki
-generates html using [[templates|wikitemplates]], and uses [[css]], so you
+Ikiwiki aims to produce 
+[valid XHTML 1.0](http://validator.w3.org/check?url=referer).
+(Experimental [[tips/HTML5]] support is also available.)
+
+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.
 
 can change the look and layout of all pages in any way you would like.
 

+Ikiwiki ships with several ready to use [[themes]].
+

 ## [[Plugins]]
 
 ## [[Plugins]]
 

-Plugins can be used to add additional features to ikiwiki. The interface
-is quite flexible, allowing plugins to implement additional markup
-languages, register [[ikiwiki/PreProcessorDirective]]s, hook into [[CGI]] mode,
-and more. Most of ikiwiki's features are actually provided by plugins.
-Ikiwiki's backend RCS support is also pluggable, so support for new
-revision control systems can be added to ikiwiki.
+Plugins can be used to add additional features to ikiwiki. The interface is
+quite flexible, allowing plugins to implement additional markup languages,
+register [[directives|ikiwiki/directive]], provide a [[RCS]] backend, hook
+into [[CGI]] mode, and much more. Most of ikiwiki's features are actually
+provided by plugins.

 
 The standard language for ikiwiki plugins is perl, but ikiwiki also supports
 [[plugins/write/external]] plugins: Standalone programs that can be written in
 
 The standard language for ikiwiki plugins is perl, but ikiwiki also supports
 [[plugins/write/external]] plugins: Standalone programs that can be written in


@@ -142,14 +152,15 @@ authentication, or other methods implemented via plugins.
 
 Thanks to subpages, every page can easily and automatically have a
 /Discussion subpage. By default, these links are included in the
 
 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.
+[[templates]] for each page. If you prefer blog-style
+[[plugins/comments]], that is available too.

 
 ### Edit controls
 
 
 ### Edit controls
 

-Wiki admins can [[lock_pages|page_locking]] so that only other admins can
-edit them. Or a wiki can be set up to allow anyone to edit Discussion
-pages, but only registered users to edit other pages. These are just two
-possibilities, since page edit controls can be changed via plugins.
+Wiki admins can lock pages so that only other admins can edit them. Or a
+wiki can be set up to allow anyone to edit Discussion pages, but only
+registered users to edit other pages. These are just two possibilities,
+since page edit controls can be changed via plugins.

 
 ### [[PageHistory]]
 
 
 ### [[PageHistory]]
 


@@ -158,8 +169,13 @@ Well, sorta. Rather than implementing YA history browser, it can link to
 
 ### Full text search
 
 
 ### Full text search
 

-ikiwiki can use the [[HyperEstraier]] search engine to add powerful
-full text search capabilities to your wiki.
+Ikiwiki can use the xapian search engine to add powerful
+full text [[plugins/search]] capabilities to your wiki.
+
+### Translation via po files
+
+The [[plugins/po]] plugin allows translating individual wiki pages using
+standard `po` files.

 
 ### [[w3mmode]]
 
 
 ### [[w3mmode]]