95e3bcfc7c98bd78e9a4a3bd067800c580f48f94
[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,
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 * Fast compiler
48
49   ikiwiki is fast and smart about updating a wiki, it only builds pages
50   that have changed (and tracks things like creation of new pages and links
51   that can indirectly cause a page to need a rebuild)
52
53 * [[Templates]]
54
55   ikiwiki generates html using templates so you can change the look and 
56   layout of all pages in any way you would like.
57
58 * [[BackLinks]]
59
60   Automatically included on pages. Rather faster than eg [[MoinMoin]] and always there to help with navigation.
61
62 * [[PageHistory]]
63
64   Well, sorta. Rather than implementing YA history browser, it can link to
65   [[ViewCVS]] or the link to browse the history of a wiki page.
66
67 * [[RecentChanges]], editing pages in a web browser
68
69   Nearly the definition of a wiki, although perhaps ikiwiki challenges how
70   much of that web gunk a wiki really needs. These features are optional
71   and can be enabled by enabling [[CGI]].
72
73 * User registration
74
75   Can optionally be configured to allow only registered users to post
76   pages; online user registration form, etc.
77
78 * Discussion pages
79
80   Thanks to subpages, every page can easily and automatically have a
81   /Discussion subpage. By default, these links are included in the
82   [[templates]] for each page.
83
84 * Smart merging and conflict resolution in your web browser
85
86   Since it uses subversion, ikiwiki takes advantage of its smart merging to
87   avoid any conflicts when two people edit different parts of the same page
88   at the same time. No annoying warnings about other editors, or locking,
89   etc, instead the other person's changes will be automaticaly merged with
90   yours when you commit.
91
92   In the rare cases where automatic merging fails due to the same part of a
93   page being concurrently edited, regular subversion commit markers are
94   shown in the file to resolve the conflict, so if you're already familiar
95   with that there's no new commit marker syntax to learn.
96
97 * page locking
98
99   Wiki admin can [[lock]] pages so that only other admins can edit them.
100
101 ----
102
103 It also has some [[TODO]] items and [[Bugs]].