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