doc/features.mdwn

   1 [[WhyIkiWiki]]?
   2
   3 Currently implemented:
   4
   5 * [[Subversion]]
   6
   7   Rather than implement its own system for storing page histories etc,
   8   ikiwiki simply uses subversion. (Supporting other revision control
   9   systems is also possible, ikiwiki only needs $FOO add, $FOO commit, and
  10   $FOO log).
  11
  12   Instead of editing pages in a stupid web form, you can use vim and commit
  13   changes via svn. Or work disconnected using svk and push your changes out
  14   when you come online. Deal with edit conflicts with others in a sane
  15   environment. Take advantage of subversion's smart merges.
  16
  17   ikiwiki can be run from a [[post-commit]] hook to update your wiki
  18   immediately whenever you commit.
  19
  20   Note that ikiwiki does not require subversion to function. If you want to
  21   run a simple wiki without page history, it can do that too.
  22
  23 * [[MarkDown]]
  24
  25   ikiwiki supports pages using [[MarkDown]] as their markup language. Any
  26   page with a filename ending in ".mdwn" is converted from markdown to html
  27   by ikiwiki. Markdown understands text formatted as it would be in an email,
  28   and is quite smart about converting it to html. The only additional markup
  29   provided by ikiwiki aside from regular markdown is the [[WikiLink]].
  30
  31 * support for other file types
  32
  33   ikiwiki also supports files of any other type, including raw html, text,
  34   images, etc. These are not converted to wiki pages, they are just copied
  35   unchanged by ikiwiki as it builds your wiki. So you can check in an image,
  36   program, or other special file and link to it from your wiki pages.
  37
  38 * [[SubPage]]s
  39
  40   Arbitrarily deep hierarchies of pages with fairly simple and useful [[SubPage/LinkingRUles]]
  41
  42 * Fast compiler
  43
  44   ikiwiki is fast and smart about updating a wiki, it only builds pages that have changed (and tracks things like creation of new pages and links that can indirectly cause a page to need a rebuild)
  45
  46 * [[Templates]]
  47
  48   ikiwiki generates html using templates so you can change the look and
  49   layout of all pages in any way you would like.
  50
  51 * [[BackLinks]]
  52
  53   Automatically included on pages. Rather faster than eg [[MoinMoin]] and always there to help with navigation.
  54
  55 * [[PageHistory]]
  56
  57   Well, sorta. Rather than implementing YA history browser, it can link to
  58   [[ViewCVS]] or the link to browse the history of a wiki page.
  59
  60 * [[RecentChanges]], editing pages in a web browser
  61
  62   Nearly the definition of a wiki, although perhaps ikiwiki challenges how
  63   much of that web gunk a wiki really needs. These features are optional
  64   and can be enabled by enabling [[CGI]].
  65
  66 * User registration
  67
  68   Can optionally be configured to allow only registered users to post
  69   pages; online user registration form, etc.
  70
  71 * Discussion pages
  72
  73   Thanks to subpages, every page can easily and automatically have a
  74   /Discussion subpage. By default, these links are included in the
  75   [[templates]] for each page.
  76
  77 ----
  78
  79 It also has lots of [[TODO]] items and [[Bugs]]. This wiki is not ready for production!