]> sipb.mit.edu Git - ikiwiki.git/blob - doc/features.mdwn
- finish user registration and password request email
[ikiwiki.git] / 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, ikiwiki      simply uses subversion. (Supporting other revision control systems is also possible, ikiwiki only needs $FOO add, $FOO commit, and $FOO log).
8
9   Instead of editing pages in a stupid web form, you can use vim and commit changes via svn. Or work disconnected using svk and push your changes out when you come online. Deal with edit conflicts with others in a sane environment. Take advantage of subversion's smart merges.
10
11  ikiwiki can be run from a [[post-commit]] hook to update your wiki immediately whenever you commit.
12
13 * [[MarkDown]]
14
15   ikiwiki supports pages using [[MarkDown]] as their markup language. Any
16   page with a filename ending in ".mdwn" is converted from markdown to html
17   by ikiwiki. Markdown understands text formatted as it would be in an email,
18   and is quite smart about converting it to html. The only additional markup
19   provided by ikiwiki aside from regular markdown is the [[WikiLink]].
20
21 * support for other file types
22
23   ikiwiki also supports files of any other type, including raw html, text,
24   images, etc. These are not converted to wiki pages, they are just copied
25   unchanged by ikiwiki as it builds your wiki. So you can check in an image,
26   program, or other special file and link to it from your wiki pages.
27
28 * [[SubPage]]s
29
30   Arbitrarily deep hierarchies of pages with fairly simple and useful [[SubPage/LinkingRUles]]
31
32 * Fast compiler
33
34   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)
35
36 * [[Templates]]
37
38   ikiwiki generates html using templates so you can change the look and 
39   layout of all pages in any way you would like.
40
41 * [[BackLinks]]
42
43   Automatically included on pages. Rather faster than eg [[MoinMoin]] and always there to help with navigation.
44
45 * [[PageHistory]]
46
47   Well, sorta. Rather than implementing YA history browser, it can link to
48   [[ViewCVS]] or the link to browse the history of a wiki page.
49
50 * [[RecentChanges]], editing pages in a web browser
51
52   Nearly the definition of a wiki, although perhaps ikiwiki challenges how
53   much of that web gunk a wiki really needs. These features are optional
54   and can be enabled by enabling [[CGI]].
55
56 * User registration
57
58   Can optionally be configured to allow only registered users to post
59   pages; online user registration form, etc.
60
61 ----
62
63 It also has lots of [[TODO]] items and [[Bugs]]. This wiki is not ready for production!