cdec6e7e811aa3752c6fbc5f81af44161384b026
[ikiwiki.git] / doc / roadmap.mdwn
1 This is the roadmap for ikiwiki development.
2
3 # 1.0
4
5 * No severe [[security]] bugs.
6 * All the basic [[features]] people would expect in a wiki.
7
8 Released 29 April 2006.
9
10 The 1.X series is no longer supported.
11
12 ----
13
14 # 2.0
15
16 * New improved URLs to pages via `usedirs`.
17 * [[plugins/OpenID]] support, enabled by default.
18 * Plugin [[interface|plugins/write]] added, with some 60 [[plugins]] available,
19   greatly expanding the capabilities of ikiwiki.
20 * [[Tags]], atom feeds, and generally full-fledged blogging support.
21 * Fully working [[todo/utf8]].
22 * Optimisations, approximately 3.5 times as fast as version 1.0.
23 * Improved scalability to large numbers of pages.
24 * Improved scalable [[logo]].
25 * Support for additional revision control systems besides svn: git,
26   tla, mercurial.
27 * Some support for other markup languages than markdown: rst, textile.
28 * Unit test suite, with more than 300 tests.
29
30 Released 30 April 2007.
31
32 The 2.x series is now in maintenance mode. Only security fixes and fixes for
33 really bad bugs will be applied going forward.
34
35 ----
36
37 # 3.0
38
39 Version 3.0 is an opportunity to make significant transitions.
40 Read [[tips/upgrade_to_3.0]] for the steps you will need to
41 follow when upgrading your wiki to this version.
42
43 The highlights of the changes in version 3.0 include:
44
45 * Support for uploading [[attachments|plugins/attachment]].
46 * Can [[plugins/rename]] and [[plugins/remove]] pages and files via the web.
47 * [[Web_based_setup|plugins/websetup]].
48 * Blog-style [[plugins/comments]] as an alternative to Discussion pages.
49 * Many other new plugins including [[plugins/htmlbalance]], [[plugins/format]],
50   [[plugins/progress]], [[plugins/color]], [[plugins/autoindex]],
51   [[plugins/cutpaste]], [[plugins/hnb]], [[plugins/creole]], [[plugins/txt]],
52   [[plugins/amazon_s3]], [[plugins/pinger]], [[plugins/pingee]],
53   [[plugins/edittemplate]]
54 * The RecentChanges page is compiled statically, not generated from the CGI.
55 * Support for additional revision control systems: [[rcs/bzr]],
56   [[rcs/monotone]]
57 * Support for [[tips/untrusted_git_push]].
58 * A new version (3.00) of the plugin API, exporting additional
59   commonly used functions from `IkiWiki.pm`.
60 * Nearly everything in ikiwiki is now a plugin, from WikiLinks to page
61   editing, to RecentChanges.
62 * Far too many bug fixes, features, and enhancements to list here.
63
64 Released 31 December, 2008.
65
66 The 3.x series is expected to undergo continuing development for some time,
67 adding improvements and new features, but avoiding changes that break
68 backwards compatability.
69
70 ----
71
72 # compatability breaking changes
73
74 Probably incomplete list:
75
76 * Drop old `--getctime` option.
77 * Remove compatability code in `loadindex` to handle old index data layouts.
78 * Make pagespecs match relative by default? (see [[discussion]])
79 * Flip wikilinks? (see [[todo/link_plugin_perhaps_too_general?]])
80 * YADA format setup files per default?
81 * Enable tagbase by default (so that tag autocreation will work by default).
82   Note that this is already done for wikis created by `auto-blog.setup`.
83 * [[tips/html5]] on by default (some day..)
84 * Remove support for old `.ikiwiki/comments_pending` from comment plugin.
85
86 In general, we try to use [[ikiwiki-transition]] or forced rebuilds on
87 upgrade to deal with changes that break compatability. Some things that
88 can't help with.
89
90 # future goals
91
92 * Conversion support for existing other wikis.
93   (Being worked on for MoinMoin and TWiki by [[Josh_Triplett|JoshTriplett]]
94   and Jamey Sharp; support for other wikis should fit into the same
95   framework.)
96 * [[TODO]], [[bugs]], ...