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