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