X-Git-Url: https://scripts.mit.edu/gitweb/www/ikiwiki.git/blobdiff_plain/48ac90f72e3526207e08b7d7581ff567cb465dd1..ba2a1f7eaa34e00593250903211388a58dbb09f9:/doc/features.mdwn diff --git a/doc/features.mdwn b/doc/features.mdwn index 1f0a018f4..3890bc5dc 100644 --- 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, -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 -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 -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 -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) @@ -59,11 +59,11 @@ 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 +## Valid html and [[css]] 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]] @@ -75,7 +75,7 @@ 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. -### [[todo/utf8]] +## [[todo/utf8]] After rather a lot of fiddling, we think that ikiwiki correctly and fully supports utf8 everywhere. @@ -86,7 +86,7 @@ The above are the core design goals and features of ikiwiki, but on that foundation a lot of other important features are added. Here is an incomplete list of some of them. -## [[Tags]] +### [[Tags]] 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