Add patch, and fix directive

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

diff --git a/doc/roadmap.mdwn b/doc/roadmap.mdwn
index d8c80b234369111dec9a344d3194204bf62686a0..f2ff5802ec30747584ba9510fcad679e4213e3af 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.

 
 ----
 
 
 ----
 


@@ -42,25 +42,26 @@ follow when upgrading your wiki to this version.
 
 The highlights of the changes in version 3.0 include:
 
 
 The highlights of the changes in version 3.0 include:
 

-* Blog-style [[plugins/comments]] as an alternative to Discussion pages.

 * Support for uploading [[attachments|plugins/attachment]].
 * Can [[plugins/rename]] and [[plugins/remove]] pages and files via the web.
 * [[Web_based_setup|plugins/websetup]].
 * Support for uploading [[attachments|plugins/attachment]].
 * Can [[plugins/rename]] and [[plugins/remove]] pages and files via the web.
 * [[Web_based_setup|plugins/websetup]].

-* Many new plugins including [[plugins/htmlbalance]], [[plugins/format]],
+* 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]]
   [[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 additional revision control systems: [[rcs/bzr]],
   [[rcs/monotone]]

-* Support for [[tips/trusted_git_push]].
-* The RecentChanges page is compiled statically, not generated the the CGI.
+* Support for [[tips/untrusted_git_push]].

 * A new version (3.00) of the plugin API, exporting additional
 * 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.
+  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.
 
 * Far too many bug fixes, features, and enhancements to list here.
 

-Release is planned for fall^Wlate, 2008.
+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


@@ -68,10 +69,24 @@ 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` from comment plugin.
+
+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]], ...