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. (Supporting other revision control
   7   systems is also possible, ikiwiki only needs $FOO add, $FOO commit, and
   8   $FOO log).
   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 raw html, 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 * [[blog]]s
  41
  42   You can turn any page in the wiki into a [[blog]]. Pages with names
  43   matching a specified [[GlobList]] will be displayed as a weblog within
  44   the blog page. And an RSS feed can be generated to follow the blog.
  45
  46   Ikiwikit's own [[TODO]] and [[news]] pages are good examples of some of
  47   the flexible ways that this can be used.
  48
  49 * Fast compiler
  50
  51   ikiwiki is fast and smart about updating a wiki, it only builds pages
  52   that have changed (and tracks things like creation of new pages and links
  53   that can indirectly cause a page to need a rebuild)
  54
  55 * valid html and css
  56
  57   ikiwiki aims to produce
  58   [valid XHTML 1.0](http://validator.w3.org/check?url=referer).
  59   ikiwiki generates html using [[templates]], and uses css, so you can
  60   change the look and layout of all pages in any way you would like.
  61
  62 * [[BackLinks]]
  63
  64   Automatically included on pages. Rather faster than eg MoinMoin and
  65   always there to help with navigation.
  66
  67 * [[PageHistory]]
  68
  69   Well, sorta. Rather than implementing YA history browser, it can link to
  70   [[ViewCVS]] or the link to browse the history of a wiki page.
  71
  72 * [[RecentChanges]], editing pages in a web browser
  73
  74   Nearly the definition of a wiki, although perhaps ikiwiki challenges how
  75   much of that web gunk a wiki really needs. These features are optional
  76   and can be enabled by enabling [[CGI]].
  77
  78 * User registration
  79
  80   Can optionally be configured to allow only registered users to post
  81   pages; online user registration form, etc.
  82
  83 * Discussion pages
  84
  85   Thanks to subpages, every page can easily and automatically have a
  86   /Discussion subpage. By default, these links are included in the
  87   [[templates]] for each page.
  88
  89 * Smart merging and conflict resolution in your web browser
  90
  91   Since it uses subversion, ikiwiki takes advantage of its smart merging to
  92   avoid any conflicts when two people edit different parts of the same page
  93   at the same time. No annoying warnings about other editors, or locking,
  94   etc, instead the other person's changes will be automatically merged with
  95   yours when you commit.
  96
  97   In the rare cases where automatic merging fails due to the same part of a
  98   page being concurrently edited, regular subversion commit markers are
  99   shown in the file to resolve the conflict, so if you're already familiar
 100   with that there's no new commit marker syntax to learn.
 101
 102   For all the gory details of how ikiwiki handles this behind the scenes,
 103   see [[commit-internals]].
 104
 105 * page locking
 106
 107   Wiki admins can lock pages so that only other admins can edit them.
 108
 109 * Full text search
 110
 111   ikiwiki can use the [[HyperEstraier]] search engine to add powerful
 112   full text search capabilities to your wiki.
 113
 114 * Commit mails
 115
 116   ikiwiki can be configured to send you commit mails with diffs of changes
 117   to selected pages.
 118
 119 * [[Plugins]]
 120
 121   A plugin system allows extending ikiwiki in arbitrary ways.
 122
 123 ----
 124
 125 It also has some [[TODO]] items and [[Bugs]].