releasing version 1.1
[ikiwiki.git] / doc / features.mdwn
1 Some of ikiwiki's features:
2
3 * [[Subversion]]
4
5   Rather than implement its own system for storing page histories etc,
6   ikiwiki simply uses subversion. (It's also possible to [[plugins/write]] support for other systems.)
7
8   Instead of editing pages in a stupid web form, you can use vim and commit
9   changes via svn. Or work disconnected using svk and push your changes out
10   when you come online.
11
12   ikiwiki can be run from a [[post-commit]] hook to update your wiki
13   immediately whenever you commit.
14
15   Note that ikiwiki does not require subversion to function. If you want to
16   run a simple wiki without page history, it can do that too.
17
18 * [[MarkDown]]
19
20   ikiwiki supports pages using [[MarkDown]] as their markup language. Any
21   page with a filename ending in ".mdwn" is converted from markdown to html
22   by ikiwiki. Markdown understands text formatted as it would be in an email,
23   and is quite smart about converting it to html. The only additional markup
24   provided by ikiwiki aside from regular markdown is the [[WikiLink]] and 
25   [[PreprocessorDirective]]
26
27 * support for other file types
28
29   ikiwiki also supports files of any other type, including plain text,
30   images, etc. These are not converted to wiki pages, they are just copied
31   unchanged by ikiwiki as it builds your wiki. So you can check in an image,
32   program, or other special file and link to it from your wiki pages.
33
34 * [[SubPage]]s
35
36   Arbitrarily deep hierarchies of pages with fairly simple and useful [[SubPage/LinkingRules]]
37
38 * [[blog]]s
39
40   You can turn any page in the wiki into a [[blog]]. Pages with names 
41   matching a specified [[GlobList]] will be displayed as a weblog within
42   the blog page. And an RSS feed can be generated to follow the blog.
43
44   Ikiwiki's own [[TODO]], [[news]], and [[plugins]] pages are good examples of some of
45   the flexible ways that this can be used.
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 * valid html and css
54
55   ikiwiki aims to produce 
56   [valid XHTML 1.0](http://validator.w3.org/check?url=referer).
57   ikiwiki generates html using [[templates]], and uses css, so you can 
58   change the look and layout of all pages in any way you would like.
59
60 * [[BackLinks]]
61
62   Automatically included on pages. Rather faster than eg MoinMoin and
63   always there to help with navigation.
64
65 * [[PageHistory]]
66
67   Well, sorta. Rather than implementing YA history browser, it can link to
68   [[ViewCVS]] or the link to browse the history of a wiki page.
69
70 * [[RecentChanges]], editing pages in a web browser
71
72   Nearly the definition of a wiki, although perhaps ikiwiki challenges how
73   much of that web gunk a wiki really needs. These features are optional
74   and can be enabled by enabling [[CGI]].
75
76 * User registration
77
78   Can optionally be configured to allow only registered users to post
79   pages; online user registration form, etc.
80
81 * Discussion pages
82
83   Thanks to subpages, every page can easily and automatically have a
84   /Discussion subpage. By default, these links are included in the
85   [[templates]] for each page.
86
87 * Smart merging and conflict resolution in your web browser
88
89   Since it uses subversion, ikiwiki takes advantage of its smart merging to
90   avoid any conflicts when two people edit different parts of the same page
91   at the same time. No annoying warnings about other editors, or locking,
92   etc, instead the other person's changes will be automatically merged with
93   yours when you commit.
94
95   In the rare cases where automatic merging fails due to the same part of a
96   page being concurrently edited, regular subversion commit markers are
97   shown in the file to resolve the conflict, so if you're already familiar
98   with that there's no new commit marker syntax to learn.
99
100 * page locking
101
102   Wiki admins can lock pages so that only other admins can edit them.
103
104 * Full text search
105
106   ikiwiki can use the [[HyperEstraier]] search engine to add powerful
107   full text search capabilities to your wiki.
108
109 * Commit mails
110
111   ikiwiki can be configured to send you commit mails with diffs of changes
112   to selected pages.
113
114 * [[Plugins]]
115
116   Plugins can be used to add additional features to ikiwiki. The interface is quite flexible, allowing plugins to register [[PreProcessorDirective]]s, hook into [[CGI]] mode, and more. Ikiwiki's backend RCS support is also pluggable, so support for new revision control systems can be added to ikiwiki. 
117
118 ----
119
120 It also has some [[TODO]] items and [[Bugs]].