doc/features.mdwn

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