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.
  15
  16   ikiwiki can be run from a [[post-commit]] hook to update your wiki
  17   immediately whenever you commit.
  18
  19   Note that ikiwiki does not require subversion to function. If you want to
  20   run a simple wiki without page history, it can do that too.
  21
  22 * [[MarkDown]]
  23
  24   ikiwiki supports pages using [[MarkDown]] as their markup language. Any
  25   page with a filename ending in ".mdwn" is converted from markdown to html
  26   by ikiwiki. Markdown understands text formatted as it would be in an email,
  27   and is quite smart about converting it to html. The only additional markup
  28   provided by ikiwiki aside from regular markdown is the [[WikiLink]].
  29
  30 * support for other file types
  31
  32   ikiwiki also supports files of any other type, including raw html, text,
  33   images, etc. These are not converted to wiki pages, they are just copied
  34   unchanged by ikiwiki as it builds your wiki. So you can check in an image,
  35   program, or other special file and link to it from your wiki pages.
  36
  37 * [[SubPage]]s
  38
  39   Arbitrarily deep hierarchies of pages with fairly simple and useful [[SubPage/LinkingRules]]
  40
  41 * [[blog]]s
  42
  43   You can turn any page in the wiki into a [[blog]]. Pages with names
  44   matching a specified [[GlobList]] will be displayed as a weblog within
  45   the blog page. And an RSS feed can be generated to follow the blog.
  46
  47   Ikiwikit's own [[TODO]] and [[news]] pages are good examples of some of 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 always there to help with navigation.
  65
  66 * [[PageHistory]]
  67
  68   Well, sorta. Rather than implementing YA history browser, it can link to
  69   [[ViewCVS]] or the link to browse the history of a wiki page.
  70
  71 * [[RecentChanges]], editing pages in a web browser
  72
  73   Nearly the definition of a wiki, although perhaps ikiwiki challenges how
  74   much of that web gunk a wiki really needs. These features are optional
  75   and can be enabled by enabling [[CGI]].
  76
  77 * User registration
  78
  79   Can optionally be configured to allow only registered users to post
  80   pages; online user registration form, etc.
  81
  82 * Discussion pages
  83
  84   Thanks to subpages, every page can easily and automatically have a
  85   /Discussion subpage. By default, these links are included in the
  86   [[templates]] for each page.
  87
  88 * Smart merging and conflict resolution in your web browser
  89
  90   Since it uses subversion, ikiwiki takes advantage of its smart merging to
  91   avoid any conflicts when two people edit different parts of the same page
  92   at the same time. No annoying warnings about other editors, or locking,
  93   etc, instead the other person's changes will be automatically merged with
  94   yours when you commit.
  95
  96   In the rare cases where automatic merging fails due to the same part of a
  97   page being concurrently edited, regular subversion commit markers are
  98   shown in the file to resolve the conflict, so if you're already familiar
  99   with that there's no new commit marker syntax to learn.
 100
 101 * page locking
 102
 103   Wiki admins can lock pages so that only other admins can edit them.
 104
 105 * Full text search
 106
 107   ikiwiki can use the [[HyperEstraier]] search engine to add powerful
 108   full text search capabilities to your wiki.
 109
 110 ----
 111
 112 It also has some [[TODO]] items and [[Bugs]].