]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/features.mdwn
Start documenting eventual docwiki changes.
[git.ikiwiki.info.git] / doc / features.mdwn
index c119dae974c15e20c05d4d79df35e736e3c03cc5..5bbe5ef2190685c98a0c8a7b5d5f2d5553343a6e 100644 (file)
@@ -13,7 +13,7 @@ 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.
 
 It's even possible to securely let
@@ -25,7 +25,7 @@ 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)
@@ -45,7 +45,7 @@ easily be added by [[plugins]]. For example it also supports traditional
 [[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.
@@ -64,17 +64,23 @@ 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.
 
-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]]
 
-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.
 
+Ikiwiki ships with several ready to use [[themes]].
+
 ## [[Plugins]]
 
 Plugins can be used to add additional features to ikiwiki. The interface is
@@ -125,7 +131,7 @@ yours when you commit.
 In the rare cases where automatic merging fails due to the same part of a
 page being concurrently edited, regular commit conflict markers are
 shown in the file to resolve the conflict, so if you're already familiar
-with that there's no new commit [order essays](http://custom-paper-writing.com/order) marker syntax to learn.
+with that there's no new commit marker syntax to learn.
 
 ### [[RecentChanges]], editing pages in a web browser
 
@@ -146,7 +152,7 @@ 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
-[[templates]] for each page. If you prefer blog-syle
+[[templates]] for each page. If you prefer blog-style
 [[plugins/comments]], that is available too.
 
 ### Edit controls
@@ -158,12 +164,12 @@ since page edit controls can be changed via plugins.
 
 ### [[PageHistory]]
 
-Well, sorta. Rather than implementing YA history browser [essay writing companies](http://essaywritingservices.org/custom-essay-writing.php), it can link to
+Well, sorta. Rather than implementing YA history browser, it can link to
 [[ViewVC]] or the like to browse the history of a wiki page.
 
 ### Full text search
 
-ikiwiki can use the xapian search engine to add powerful
+Ikiwiki can use the xapian search engine to add powerful
 full text [[plugins/search]] capabilities to your wiki.
 
 ### Translation via po files