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