doc/features.mdwn

   1 An overview of some of ikiwiki's features:
   2 [[toc ]]
   3
   4 ## Uses a real RCS
   5
   6 Rather than implement its own system for storing page histories etc,
   7 ikiwiki uses a real RCS. This isn't because we're lazy, it's because a
   8 real RCS is a good thing to have, and there are advantages to using one
   9 that are not possible with a standard wiki.
  10
  11 Instead of editing pages in a stupid web form, you can use vim and commit
  12 changes via svn. Or work disconnected using svk and push your changes out
  13 when you come online. Or use git to work in a distributed fashion all the
  14 time. (It's also possible to [[plugins/write]] a plugin to support other
  15 systems.)
  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 a RCS to function. If you want to
  21 run a simple wiki without page history, it can do that too.
  22
  23 ## Supports many markup languages
  24
  25 By default, pages in the wiki are written using the [[MarkDown]] format.
  26 Any 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 on top of regular markdown is the [[WikiLink]] and
  30 [[PreprocessorDirective]].
  31
  32 If you prefer to use some other markup language, ikiwiki allows others to
  33 easily be added by [[plugins]]. For example it also supports traditional
  34 [[plugins/WikiText]] formatted pages, pages written as pure
  35 [[plugins/HTML]], or pages written in [[reStructuredText|plugins/rst]].
  36
  37 ## support for other file types
  38
  39 ikiwiki also supports files of any other type, including plain text,
  40 images, etc. These are not converted to wiki pages, they are just copied
  41 unchanged by ikiwiki as it builds your wiki. So you can check in an image,
  42 program, or other special file and link to it from your wiki pages.
  43
  44 ## Fast compiler
  45
  46 ikiwiki is fast and smart about updating a wiki, it only builds pages
  47 that have changed (and tracks things like creation of new pages and links
  48 that can indirectly cause a page to need a rebuild)
  49
  50 ## [[blogging|blog]]
  51
  52 You can turn any page in the wiki into a [[blog]]. Pages matching a
  53 specified [[PageSpec]] will be displayed as a weblog within the blog
  54 page. And an RSS feed can be generated to follow the blog.
  55
  56 Ikiwiki's own [[TODO]], [[news]], and [[plugins]] pages are good examples
  57 of some of the flexible ways that this can be used.
  58
  59 Ikiwiki can also [[plugins/aggregate]] external blogs, feeding them into
  60 the wiki. This can be used to create a Planet type site that aggregates
  61 interesting feeds.
  62
  63 ## [[tags]]
  64
  65 You can tag pages and use these tags in various ways. Tags will show
  66 up in the ways you'd expect, like at the bottom of pages, in blogs, and
  67 in rss feeds.
  68
  69 ## valid html and css
  70
  71 ikiwiki aims to produce
  72 [valid XHTML 1.0](http://validator.w3.org/check?url=referer).
  73 ikiwiki generates html using [[templates]], and uses css, so you can
  74 change the look and layout of all pages in any way you would like.
  75
  76 ## [[SubPages|SubPage]]
  77
  78 Arbitrarily deep hierarchies of pages with fairly simple and useful
  79 [[SubPage/LinkingRules]]
  80
  81 ## [[BackLinks]]
  82
  83 Automatically included on pages. Rather faster than eg MoinMoin and
  84 always there to help with navigation.
  85
  86 ## [[PageHistory]]
  87
  88 Well, sorta. Rather than implementing YA history browser, it can link to
  89 [[ViewCVS]] or the like to browse the history of a wiki page.
  90
  91 ## [[RecentChanges]], editing pages in a web browser
  92
  93 Nearly the definition of a wiki, although perhaps ikiwiki challenges how
  94 much of that web gunk a wiki really needs. These features are optional
  95 and can be enabled by enabling [[CGI]].
  96
  97 ## User registration
  98
  99 Can optionally be configured to allow only registered users to post
 100 pages; online user registration form, etc.
 101
 102 ## Discussion pages
 103
 104 Thanks to subpages, every page can easily and automatically have a
 105 /Discussion subpage. By default, these links are included in the
 106 [[templates]] for each page.
 107
 108 ## Smart merging and conflict resolution in your web browser
 109
 110 Since it uses a real RCS, ikiwiki takes advantage of its smart merging to
 111 avoid any conflicts when two people edit different parts of the same page
 112 at the same time. No annoying warnings about other editors, or locking,
 113 etc, instead the other person's changes will be automatically merged with
 114 yours when you commit.
 115
 116 In the rare cases where automatic merging fails due to the same part of a
 117 page being concurrently edited, regular commit conflict markers are
 118 shown in the file to resolve the conflict, so if you're already familiar
 119 with that there's no new commit marker syntax to learn.
 120
 121 ## page locking
 122
 123 Wiki admins can lock pages so that only other admins can edit them.
 124
 125 ## Full text search
 126
 127 ikiwiki can use the [[HyperEstraier]] search engine to add powerful
 128 full text search capabilities to your wiki.
 129
 130 ## Commit mails
 131
 132 ikiwiki can be configured to send you commit mails with diffs of changes
 133 to selected pages.
 134
 135 ## [[Plugins]]
 136
 137 Plugins can be used to add additional features to ikiwiki. The interface
 138 is quite flexible, allowing plugins to implement additional markup
 139 languages, register [[PreProcessorDirective]]s, hook into [[CGI]] mode,
 140 and more. Most of ikiwiki's features are actually provided by plugins.
 141 Ikiwiki's backend RCS support is also pluggable, so support for new
 142 revision control systems can be added to ikiwiki.
 143
 144 ## [[todo/utf8]]
 145
 146 After rather a lot of fiddling, we think that ikiwiki correctly and fully
 147 supports utf8 everywhere.
 148
 149 ## [[w3mmode]]
 150
 151 Can be set up so that w3m can be used to browse a wiki and edit pages
 152 without using a web server.