You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2006/01/07 00:48:27 UTC

svn commit: r366600 - in /forrest/trunk: site-author/content/xdocs/tools/xxe.xml tools/xxe/README.txt

Author: crossley
Date: Fri Jan  6 15:48:19 2006
New Revision: 366600

URL: http://svn.apache.org/viewcvs?rev=366600&view=rev
Log:
Issue: FOR-722 "tools/xxe/README.txt should be added into the docs; and broken link"
Contributed by: Sjur N. Moshagen

Modified:
    forrest/trunk/site-author/content/xdocs/tools/xxe.xml
    forrest/trunk/tools/xxe/README.txt

Modified: forrest/trunk/site-author/content/xdocs/tools/xxe.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/tools/xxe.xml?rev=366600&r1=366599&r2=366600&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/tools/xxe.xml (original)
+++ forrest/trunk/site-author/content/xdocs/tools/xxe.xml Fri Jan  6 15:48:19 2006
@@ -23,7 +23,6 @@
   </header>
 
   <body>
-    <note>This requires XXE version 2.5p3 or higher</note>
     <note>This is not a particular endorsement of XXE over other xml editors.
       It is just that we provide this tool to take advantage of XXE.</note>
 
@@ -33,16 +32,30 @@
     XXE support or mailing lists.</p>
 
     <section>
+      <title>Requirements</title>
+
+      <ul>
+        <li>XXE 3.0p1+ (version 1.3 of the tool works with XXE version 2.5p3 -
+        3.0)</li>
+        <li>Forrest 0.5+</li>
+      </ul>
+    </section>
+
+    <section>
       <title>Upgrade</title>
 
       <ol>
         <li>Delete the <code>forrest</code> directory from the XXE application
         config directory. (e.g. <code>D:\Program
-        Files\XMLmind_XML_Editor\config</code>)
+        Files\XMLmind_XML_Editor\config</code>)<br/>
+        <strong>OR</strong></li>
+        <li>Delete the 'forrest' directory from your user XXE config directory:
         <ul>
-          <li>if you have installed the config in your XXE user directory (see
-          below), this step is not necessary</li>
+          <li>*nix-es: <code>~/.xxe/addon/</code></li>
+          <li>Windows: <code>%SystemDrive%\Documents and
+          Settings\user\Application Data\XMLmind\XMLeditor\</code></li>
         </ul>
+        depending on where you installed the previous version of the tool
         </li>
 
         <li>Install normally</li>
@@ -58,8 +71,11 @@
         <strong>OR</strong></li>
         <li>Extract into your XXE user directory (e.g.
         <code>~/.xxe/addon/config</code>) (only in version 1.3+ of this config).
-        From version 1.3, this is the recommended installation location, as it
-        permits upgrading XXE without having to reinstall this config</li>
+        For version 1.3+, this is the recommended installation location, as it
+        permits upgrading XXE without having to reinstall this config
+        <note>This location is new for XXE 2.10, and is not tested with earlier
+        releases!</note>
+        </li>
       </ol>
     </section>
 
@@ -78,16 +94,26 @@
 
       <p>To work directly with the SVN version, check out
       http://svn.apache.org/repos/asf/forrest/trunk/tools/xxe/ into the
-      <code>forrest</code> folder in the XXE <code>config</code> folder. Run the
+      <code>forrest</code> folder in the XXE <code>addon</code> folder. Run the
       build there to copy the DTDs</p>
 
       <p><link
-      href="http://www.xmlmind.com/xmleditor/_distrib/docs/configure/index.html">XXE
+      href="http://www.xmlmind.com/xmleditor/_distrib/doc/configure/index.html">XXE
       Custom Configuration Info</link></p>
     </section>
 
     <section>
       <title>History</title>
+      <section>
+        <title>1.4</title>
+        <ul>
+          <li>Updated the tool to work with XXE 3.0p1. (FOR-779)
+            <note>This change is backwards INCOMPATIBLE, therefore the tool
+            now <em>requires</em> XXE 3.0p1+.</note>
+          </li>
+          <li>Added XXE-provided default rendering of tables</li>
+        </ul>
+      </section>
       <section>
         <title>1.3</title>
         <ul>

Modified: forrest/trunk/tools/xxe/README.txt
URL: http://svn.apache.org/viewcvs/forrest/trunk/tools/xxe/README.txt?rev=366600&r1=366599&r2=366600&view=diff
==============================================================================
--- forrest/trunk/tools/xxe/README.txt (original)
+++ forrest/trunk/tools/xxe/README.txt Fri Jan  6 15:48:19 2006
@@ -17,16 +17,28 @@
 XXE Forrest Config
 ==================
 
-Works with:
-===========
-* XXE V3.0p1+ (version 1.3 of the tool works with XXE V2.5p3+)
+NOTE: This is not a particular endorsement of XXE over other xml editors.
+      It is just that we provide this tool to take advantage of XXE.
+
+XMLmind XML Editor is a validating XML editor featuring a word processor-like
+view. We support the Forrest plugin for XXE only, please direct all XXE-related
+questions to XXE support or mailing lists.
+
+
+Requirements:
+=============
+* XXE 3.0p1+ (version 1.3 of the tool works with XXE version 2.5p3 - 3.0)
 * Forrest 0.5+
 
 
 Upgrading
 =========
-* Delete the 'forrest' directory from the XXE application config directory. (e.g. D:\Program Files\XMLmind_XML_Editor\config)
-  * if you have installed the config in your XXE user directory (see below), this step is not necessary
+* Delete the 'forrest' directory from the XXE application config directory (e.g. D:\Program Files\XMLmind_XML_Editor\config)
+  OR
+  Delete the 'forrest' directory from your user XXE config directory:
+    * *nix-es: ~/.xxe/addon/
+    * Windows: %SystemDrive%\Documents and Settings\user\Application Data\XMLmind\XMLeditor\
+  depending on where you installed the previous version of the tool
 * Install normally
 
 
@@ -35,21 +47,29 @@
 
 * Extract into the XXE application config directory (e.g. D:\Program Files\XMLmind_XML_Editor\config)
   OR
-* Extract into your XXE user directory (e.g. ~/.xxe/addon/config) (only in version 1.3+ of this config)
-  For version 1.3+ of this tool, it is the recommended installation location, as it permits upgrading XXE without having to reinstall the tool
+* Extract into your XXE user directory (e.g. ~/.xxe/addon/config) (only for version 1.3+ of this config)
+  For version 1.3+ of this tool, this is the recommended installation location, as it permits upgrading XXE without having to reinstall the tool
+  NOTE: This location is new for XXE 2.10, and is not tested with earlier releases!
 
-Building
-========
+
+Developer Instructions
+======================
 To build the configuration:
 * set the FORREST_HOME environment variable
 * run 'ant' in this directory
 
+To work directly with the SVN version, check out
+http://svn.apache.org/repos/asf/forrest/trunk/tools/xxe/ into the 'forrest'
+folder in the XXE 'addon' folder. Run the build there to copy the DTDs
+
+
 History
 =======
 
 1.4:
 ----
-- Updated the tool to work with XXE 3.0p1. This change is backwards INCOMPATIBLE, therefore the tool now requires XXE 3.0p1+
+- Updated the tool to work with XXE 3.0p1 (FOR-779).
+  NOTE: This change is backwards INCOMPATIBLE, therefore the tool now requires XXE 3.0p1+
 - Added XXE-provided default rendering of tables
 
 1.3:
@@ -70,4 +90,4 @@
 Instructions for other Forrest XML Editors
     http://forrest.apache.org/docs/catalog.html
 XXE Custom Configuration Info
-    http://www.xmlmind.com/xmleditor/_distrib/docs/configure/index.html
+    http://www.xmlmind.com/xmleditor/_distrib/doc/configure/index.html
\ No newline at end of file