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