doc/features.mdwn

   1 Some of ikiwiki's features:
   2
   3 * Uses a real RCS
   4
   5   Rather than implement its own system for storing page histories etc,
   6   ikiwiki uses a real RCS. This isn't because we're lazy, it's because a
   7   real RCS is a good thing to have, and there are advantages to using one
   8   that are not possible with a standard wiki.
   9
  10   Instead of editing pages in a stupid web form, you can use vim and commit
  11   changes via svn. Or work disconnected using svk and push your changes out
  12   when you come online. Or use git to work in a distributed fashion all the
  13   time. (It's also possible to [[plugins/write]] a plugin to support other
  14   systems.)
  15
  16   ikiwiki can be run from a [[post-commit]] hook to update your wiki
  17   immediately whenever you commit.
  18
  19   Note that ikiwiki does not require a RCS to function. If you want to
  20   run a simple wiki without page history, it can do that too.
  21
  22 * Supports many markup languages
  23
  24   By default, pages in the wiki are written using the [[MarkDown]] format.
  25   Any page with a filename ending in ".mdwn" is converted from markdown to html
  26   by ikiwiki. Markdown understands text formatted as it would be in an email,
  27   and is quite smart about converting it to html. The only additional markup
  28   provided by ikiwiki on top of regular markdown is the [[WikiLink]] and
  29   [[PreprocessorDirective]].
  30
  31   If you prefer to use some other markup language, ikiwiki allows others to
  32   easily be added by [[plugins]]. For example it also supports traditional
  33   [[plugins/WikiText]] formatted pages, pages written as pure
  34   [[plugins/HTML]], or pages written in [[reStructuredText|plugins/rst]].
  35
  36 * support for other file types
  37
  38   ikiwiki also supports files of any other type, including plain text,
  39   images, etc. These are not converted to wiki pages, they are just copied
  40   unchanged by ikiwiki as it builds your wiki. So you can check in an image,
  41   program, or other special file and link to it from your wiki pages.
  42
  43 * Fast compiler
  44
  45   ikiwiki is fast and smart about updating a wiki, it only builds pages
  46   that have changed (and tracks things like creation of new pages and links
  47   that can indirectly cause a page to need a rebuild)
  48
  49 * [[blogging|blog]]
  50
  51   You can turn any page in the wiki into a [[blog]]. Pages matching a
  52   specified [[PageSpec]] will be displayed as a weblog within the blog
  53   page. And an RSS feed can be generated to follow the blog.
  54
  55   Ikiwiki's own [[TODO]], [[news]], and [[plugins]] pages are good examples
  56   of some of the flexible ways that this can be used.
  57
  58   Ikiwiki can also [[plugin/aggregate]] external blogs, feeding them into
  59   the wiki. This can be used to create a Planet type site that aggregates
  60   interesting feeds.
  61
  62 * [[tags]]
  63
  64   You can tag pages and use these tags in various ways. Tags will show
  65   up in the ways you'd expect, like at the bottom of pages, in blogs, and
  66   in rss feeds.
  67
  68 * valid html and css
  69
  70   ikiwiki aims to produce
  71   [valid XHTML 1.0](http://validator.w3.org/check?url=referer).
  72   ikiwiki generates html using [[templates]], and uses css, so you can
  73   change the look and layout of all pages in any way you would like.
  74
  75 * [[SubPages|SubPage]]
  76
  77   Arbitrarily deep hierarchies of pages with fairly simple and useful
  78   [[SubPage/LinkingRules]]
  79
  80 * [[BackLinks]]
  81
  82   Automatically included on pages. Rather faster than eg MoinMoin and
  83   always there to help with navigation.
  84
  85 * [[PageHistory]]
  86
  87   Well, sorta. Rather than implementing YA history browser, it can link to
  88   [[ViewCVS]] or the like to browse the history of a wiki page.
  89
  90 * [[RecentChanges]], editing pages in a web browser
  91
  92   Nearly the definition of a wiki, although perhaps ikiwiki challenges how
  93   much of that web gunk a wiki really needs. These features are optional
  94   and can be enabled by enabling [[CGI]].
  95
  96 * User registration
  97
  98   Can optionally be configured to allow only registered users to post
  99   pages; online user registration form, etc.
 100
 101 * Discussion pages
 102
 103   Thanks to subpages, every page can easily and automatically have a
 104   /Discussion subpage. By default, these links are included in the
 105   [[templates]] for each page.
 106
 107 * Smart merging and conflict resolution in your web browser
 108
 109   Since it uses a real RCS, ikiwiki takes advantage of its smart merging to
 110   avoid any conflicts when two people edit different parts of the same page
 111   at the same time. No annoying warnings about other editors, or locking,
 112   etc, instead the other person's changes will be automatically merged with
 113   yours when you commit.
 114
 115   In the rare cases where automatic merging fails due to the same part of a
 116   page being concurrently edited, regular commit conflict markers are
 117   shown in the file to resolve the conflict, so if you're already familiar
 118   with that there's no new commit marker syntax to learn.
 119
 120 * page locking
 121
 122   Wiki admins can lock pages so that only other admins can edit them.
 123
 124 * Full text search
 125
 126   ikiwiki can use the [[HyperEstraier]] search engine to add powerful
 127   full text search capabilities to your wiki.
 128
 129 * Commit mails
 130
 131   ikiwiki can be configured to send you commit mails with diffs of changes
 132   to selected pages.
 133
 134 * [[Plugins]]
 135
 136   Plugins can be used to add additional features to ikiwiki. The interface
 137   is quite flexible, allowing plugins to implement additional markup
 138   languages, register [[PreProcessorDirective]]s, hook into [[CGI]] mode,
 139   and more. Most of ikiwiki's features are actually provided by plugins.
 140   Ikiwiki's backend RCS support is also pluggable, so support for new
 141   revision control systems can be added to ikiwiki.
 142
 143 * [[todo/utf8]]
 144
 145   After rather a lot of fiddling, we think that ikiwiki correctly and fully
 146   supports utf8 everywhere.
 147
 148 * [[w3mmode]]
 149
 150   Can be set up so that w3m can be used to browse a wiki and edit pages
 151   without using a web server.
 152
 153 ----
 154
 155 It also has some [[TODO]] items and [[Bugs]].