unconfuse

[git.ikiwiki.info.git] / doc / roadmap.mdwn

diff --git a/doc/roadmap.mdwn b/doc/roadmap.mdwn
index c85c6de5bf48ce624b721927e90a864b5b1af0ee..bc8f4d82416aa3afef54a7b3d09662d2833dad17 100644 (file)
--- a/doc/roadmap.mdwn
+++ b/doc/roadmap.mdwn
@@ -7,7 +7,7 @@ This is the roadmap for ikiwiki development.
 
 Released 29 April 2006.
 
 
 Released 29 April 2006.
 

-The 1.x series is no longer supported.
+The 1.X series is no longer supported.

 
 ----
 
 
 ----
 


@@ -36,18 +36,32 @@ really bad bugs will be applied going forward.
 
 # 3.0
 
 
 # 3.0
 

-Version 3.0 is an opportunity to make significant transitions, and also adds
-many new features.
-
-* See [[tips/upgrade_to_3.0]] for the steps you will need to follow
-  when upgrading to this version.
-* Finalise a new version of the plugin API, exporting additional commonly
-  used functions from IkiWiki.pm. See [[todo/firm_up_plugin_interface]]
-
-It will include a vast number of new features, bugfixes, and other
-improvements, far too many to list here.
-
-Release is planned for fall^Wlate, 2008.
+Version 3.0 is an opportunity to make significant transitions.
+Read [[tips/upgrade_to_3.0]] for the steps you will need to
+follow when upgrading your wiki to this version.
+
+The highlights of the changes in version 3.0 include:
+
+* Support for uploading [[attachments|plugins/attachment]].
+* Can [[plugins/rename]] and [[plugins/remove]] pages and files via the web.
+* [[Web_based_setup|plugins/websetup]].
+* Blog-style [[plugins/comments]] as an alternative to Discussion pages.
+* Many other new plugins including [[plugins/htmlbalance]], [[plugins/format]],
+  [[plugins/progress]], [[plugins/color]], [[plugins/autoindex]],
+  [[plugins/cutpaste]], [[plugins/hnb]], [[plugins/creole]], [[plugins/txt]],
+  [[plugins/amazon_s3]], [[plugins/pinger]], [[plugins/pingee]],
+  [[plugins/edittemplate]]
+* The RecentChanges page is compiled statically, not generated from the CGI.
+* Support for additional revision control systems: [[rcs/bzr]],
+  [[rcs/monotone]]
+* Support for [[tips/untrusted_git_push]].
+* A new version (3.00) of the plugin API, exporting additional
+  commonly used functions from `IkiWiki.pm`.
+* Nearly everything in ikiwiki is now a plugin, from WikiLinks to page
+  editing, to RecentChanges.
+* Far too many bug fixes, features, and enhancements to list here.
+
+Released 31 December, 2008.

 
 The 3.x series is expected to undergo continuing development for some time,
 adding improvements and new features, but avoiding changes that break
 
 The 3.x series is expected to undergo continuing development for some time,
 adding improvements and new features, but avoiding changes that break


@@ -55,10 +69,27 @@ backwards compatability.
 
 ----
 
 
 ----
 

+# compatability breaking changes
+
+Probably incomplete list:
+
+* Drop old `--getctime` option.
+* Remove compatability code in `loadindex` to handle old index data layouts.
+* Make pagespecs match relative by default? (see [[discussion]])
+* Flip wikilinks? (see [[todo/link_plugin_perhaps_too_general?]] and [[todo/do_not_make_links_backwards]])
+* Enable tagbase by default (so that tag autocreation will work by default).
+  Note that this is already done for wikis created by `auto-blog.setup`.
+* [[tips/html5]] on by default (some day..)
+* Remove support for old `.ikiwiki/comments_pending` and for
+  pending comments located in the srcdir, rather than transient underlay,
+  from comment plugin. That support makes comment moderation slow as
+  it has to check all the old locations.
+
+In general, we try to use [[ikiwiki-transition]] or forced rebuilds on
+upgrade to deal with changes that break compatability. Some things that
+can't help with.
+

 # future goals
 
 # future goals
 

-* Conversion support for existing other wikis.
-  (Being worked on for MoinMoin and TWiki by [[Josh_Triplett|JoshTriplett]]
-  and Jamey Sharp; support for other wikis should fit into the same
-  framework.)
+* Conversion support for existing other wikis. See [[convert]].

 * [[TODO]], [[bugs]], ...
 * [[TODO]], [[bugs]], ...