prep release

[ikiwiki.git] / doc / roadmap.mdwn

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

-The 1.x series changed a great deal over the more than 50 releases in its
-lifetime. It is now in maintenance mode, only security issues or really bad
-bugs will be fixed in 1.x going forward.
+The 1.X series is no longer supported.

 
 ----
 
 
 ----
 


@@ -29,21 +27,69 @@ bugs will be fixed in 1.x going forward.
 * Some support for other markup languages than markdown: rst, textile.
 * Unit test suite, with more than 300 tests.
 
 * Some support for other markup languages than markdown: rst, textile.
 * Unit test suite, with more than 300 tests.
 

-Will be released 29 April 2007.
+Released 30 April 2007.

 
 

-The 2.x series is expected to undergo continuing development for some time,
+The 2.x series is now in maintenance mode. Only security fixes and fixes for
+really bad bugs will be applied going forward.
+
+----
+
+# 3.0
+
+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
 adding improvements and new features, but avoiding changes that break

-backwards compatability.
+backwards compatibility.

 
 ----
 
 
 ----
 

+# compatibility breaking changes
+
+Probably incomplete list:
+
+* Drop old `--getctime` option.
+* Remove compatibility 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
 

-* Improved [[todo/html]] stylesheets and templates.
-  _(status: [[css_market]] exists; it could always provide more stylesheets.  No alternate templates yet, though.)_
-* More documentation in the basewiki, including documentation for all enabled plugins.  Probably need some solution for [[todo/conditional_underlay_files]], too.
-* 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.)
-* [[TODO]], [[bugs]], [[soc]], ...
+* Conversion support for existing other wikis. See [[convert]].
+* [[TODO]], [[bugs]], ...