cb118f27d4eee5c1a8d050a432974dd034f5b8f9
[ikiwiki.git] / doc / features.mdwn
1 An overview of some of ikiwiki's features:
2 [[toc ]]
3
4 ## Uses a real RCS
5
6 Rather than implement its own system for storing page histories etc,
7 ikiwiki uses a real Revision Control System. This isn't because we're
8 lazy, it's because a real RCS is a good thing to have, and there are
9 advantages to using one that are not possible with a standard wiki.
10
11 Instead of editing pages in a stupid web form, you can use vim and commit
12 changes via [[Subversion]]. Or work disconnected using svk and push your
13 changes out when you come online. Or use [[git]], [[tla]], or [[mercurial]]
14 to work in a distributed fashion all the time. (It's also possible to
15 [[plugins/write]] a plugin to support other systems.)
16
17 ikiwiki can be run from a [[post-commit]] hook to update your wiki
18 immediately whenever you commit a change using the RCS.
19
20 Note that ikiwiki does not require a RCS to function. If you want to
21 run a simple wiki without page history, it can do that too.
22
23 ## A wiki compiler
24
25 ikiwiki is a wiki compiler; it builds a static website for your wiki, and
26 updates it as pages are edited. It is fast and smart about updating a wiki,
27 it only builds pages that have changed (and tracks things like creation of
28 new pages and links that can indirectly cause a page to need a rebuild)
29
30 ## Supports many markup languages
31
32 By default, pages in the wiki are written using the [[MarkDown]] format.
33 Any page with a filename ending in ".mdwn" is converted from markdown to html
34 by ikiwiki. Markdown understands text formatted as it would be in an email,
35 and is quite smart about converting it to html. The only additional markup
36 provided by ikiwiki on top of regular markdown is the [[WikiLink]] and 
37 [[PreprocessorDirective]].
38
39 If you prefer to use some other markup language, ikiwiki allows others to
40 easily be added by [[plugins]]. For example it also supports traditional
41 [[plugins/WikiText]] formatted pages, pages written as pure
42 [[plugins/HTML]], or pages written in [[reStructuredText|plugins/rst]].
43
44 ikiwiki also supports files of any other type, including plain text,
45 images, etc. These are not converted to wiki pages, they are just copied
46 unchanged by ikiwiki as it builds your wiki. So you can check in an image,
47 program, or other special file and link to it from your wiki pages.
48
49 ## [[Blogging|blog]]
50
51 You can turn any page in the wiki into a [[blog]]. Pages matching a
52 specified [[PageSpec]] will be displayed as a weblog within the blog
53 page. And RSS or Atom feeds can be generated to follow the blog.
54
55 Ikiwiki's own [[TODO]], [[news]], and [[plugins]] pages are good examples
56 of some of the flexible ways that this can be used. There is also an 
57 [[example_blog|examples/blog]] set up that you can copy into your own wiki.
58
59 Ikiwiki can also [[plugins/aggregate]] external blogs, feeding them into
60 the wiki. This can be used to create a Planet type site that aggregates
61 interesting feeds.
62
63 You can also mix blogging with podcasting by dropping audio files where
64 they will be picked up like blog posts. This will work for any files that
65 you would care to syndicate.
66
67 ## Valid html and [[css]]
68
69 ikiwiki aims to produce 
70 [valid XHTML 1.0](http://validator.w3.org/check?url=referer).
71 ikiwiki generates html using [[templates]], and uses [[css]], so you can 
72 change the look and layout of all pages in any way you would like.
73
74 ## [[Plugins]]
75
76 Plugins can be used to add additional features to ikiwiki. The interface
77 is quite flexible, allowing plugins to implement additional markup
78 languages, register [[PreProcessorDirective]]s, hook into [[CGI]] mode,
79 and more. Most of ikiwiki's features are actually provided by plugins.
80 Ikiwiki's backend RCS support is also pluggable, so support for new
81 revision control systems can be added to ikiwiki.
82
83 ## [[todo/utf8]]
84
85 After rather a lot of fiddling, we think that ikiwiki correctly and fully
86 supports utf8 everywhere.
87
88 ## Other features
89
90 The above are the core design goals and features of ikiwiki, but on that
91 foundation a lot of other important features are added. Here is an
92 incomplete list of some of them.
93
94 ### [[Tags]]
95
96 You can tag pages and use these tags in various ways. Tags will show
97 up in the ways you'd expect, like at the bottom of pages, in blogs, and
98 in RSS and Atom feeds.
99
100 ### [[SubPages|SubPage]]
101
102 Arbitrarily deep hierarchies of pages with fairly simple and useful
103 [[SubPage/LinkingRules]]
104
105 ### [[BackLinks]]
106
107 Automatically included on pages. Rather faster than eg MoinMoin and
108 always there to help with navigation.
109
110 ### Smart merging and conflict resolution in your web browser
111
112 Since it uses a real RCS, ikiwiki takes advantage of its smart merging to
113 avoid any conflicts when two people edit different parts of the same page
114 at the same time. No annoying warnings about other editors, or locking,
115 etc, instead the other person's changes will be automatically merged with
116 yours when you commit.
117
118 In the rare cases where automatic merging fails due to the same part of a
119 page being concurrently edited, regular commit conflict markers are
120 shown in the file to resolve the conflict, so if you're already familiar
121 with that there's no new commit marker syntax to learn.
122
123 ### [[RecentChanges]], editing pages in a web browser
124
125 Nearly the definition of a wiki, although perhaps ikiwiki challenges how
126 much of that web gunk a wiki really needs. These features are optional
127 and can be enabled by enabling [[CGI]].
128
129 ### User registration
130
131 Can optionally be configured to allow only registered users to post
132 pages; online user registration form, etc.
133
134 ### Discussion pages
135
136 Thanks to subpages, every page can easily and automatically have a
137 /Discussion subpage. By default, these links are included in the
138 [[templates]] for each page.
139
140 ### Page locking
141
142 Wiki admins can lock pages so that only other admins can edit them.
143
144 ### [[PageHistory]]
145
146 Well, sorta. Rather than implementing YA history browser, it can link to
147 [[ViewCVS]] or the like to browse the history of a wiki page.
148
149 ### Full text search
150
151 ikiwiki can use the [[HyperEstraier]] search engine to add powerful
152 full text search capabilities to your wiki.
153
154 ### Commit mails
155
156 ikiwiki can be configured to send you commit mails with diffs of changes
157 to selected pages.
158
159 ### [[w3mmode]]
160
161 Can be set up so that w3m can be used to browse a wiki and edit pages
162 without using a web server.