Initial revision

[helm.git] / helm / DEVEL / pxp / pxp / compatibility / README

diff --git a/helm/DEVEL/pxp/pxp/compatibility/README b/helm/DEVEL/pxp/pxp/compatibility/README
new file mode 100644 (file)
index 0000000..5008673
--- /dev/null
+++ b/helm/DEVEL/pxp/pxp/compatibility/README
@@ -0,0 +1,21 @@
+This directory contains the modules for Markup-0.2.10
+compatibility. The modules consist mainly of wrapper classes for the
+new PXP classes, and translate the old methods to the new ones.
+
+Please note that the compatibility is not perfect. Sometimes there are
+new methods which do not exist in Markup-0.2.10, and sometimes even
+existing methods changed their signature. I have tried to avoid that,
+but there are some ugly cases which are hard to solve without such
+modifications. 
+
+Translating old methods into new methods costs time and
+memory. Because of this, it is best to consider the compatibility
+modules as migration path to PXP: You can test whether PXP parses your
+input files, and you can compare the old API with the new API
+directly. (However, it is hard to test new features of PXP with the
+compatibility modules; the old API does not reflect the new features.)
+
+The compatibility modules are currently maintained, but that will stop
+once PXP has been established.
+
+(Gerd)