oXygen Author-mode document comparison plugin
We have developed an oXygen plugin that shows the changes between any two versions of a document as oXygen 'tracked changes', which is available for evaluation download from http://www.deltaxml.com/products/oxygen-plugin/download.html. Please use oXygen's Author mode to view, accept and reject the changes. We are looking for feedback from anyone using oXygen, who might find such a plugin useful, say to author structured documents. If you use DITA, this plugin can also create a DITA topic with status and rev attributes inserted to show the changes between two versions of your topic. Similarly, if you use DocBook, this plugin can create a DocBook document with revisionflag attributes inserted to show the changes between two versions of your document. The DeltaXML oXygen Plugin provides authors of structured documents with that essential 'compare documents' feature found in ordinary word-processors. We are in final beta stages and would appreciate any comments from oXygen users on this mailing list - please download an evaluation version and we look forward to hearing your feedback. Please feel free to provide feedback via this mailing-list, to me directly, or the plugin's own support forum (http://www.deltaxml.com/forum/index/14). Thanks for your help, Anthony -- -- ------------------------------------------------------------------------- Michael Anthony Smith, DeltaXML Ltd "Change control for XML" T: +44 1684 578751 E: anthony.smith@deltaxml.com http://www.deltaxml.com Registered in England 02528681 Reg. Office: Monsell House, WR8 0QN, UK
Trying it now. Thanks a lot: we were just discussing the need for this with TEI P5 documents in our journals' workflows. On 11-07-06 02:57 AM, Michael Anthony Smith wrote:
We have developed an oXygen plugin that shows the changes between any two versions of a document as oXygen 'tracked changes', which is available for evaluation download from http://www.deltaxml.com/products/oxygen-plugin/download.html. Please use oXygen's Author mode to view, accept and reject the changes.
We are looking for feedback from anyone using oXygen, who might find such a plugin useful, say to author structured documents.
If you use DITA, this plugin can also create a DITA topic with status and rev attributes inserted to show the changes between two versions of your topic.
Similarly, if you use DocBook, this plugin can create a DocBook document with revisionflag attributes inserted to show the changes between two versions of your document.
The DeltaXML oXygen Plugin provides authors of structured documents with that essential 'compare documents' feature found in ordinary word-processors.
We are in final beta stages and would appreciate any comments from oXygen users on this mailing list - please download an evaluation version and we look forward to hearing your feedback.
Please feel free to provide feedback via this mailing-list, to me directly, or the plugin's own support forum (http://www.deltaxml.com/forum/index/14).
Thanks for your help, Anthony
-- *Daniel Paul O'Donnell, PhD Professor of English, University of Lethbridge <http://www.uleth.ca/> Co-President, Society for Digital Humanities/Société pour l'étude des médias interactifs <http://www.sdh-semi.org/> Co-Editor, /Digital Studies/Le champ numérique <http://www.digitalstudies.org/>/ Founding Editor, /Digital Medievalist <http://www.digitalmedievalist.org/journal>/ *
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Very nice! I haven't tested it with content that contains entities or xincludes yet. How does it treat those in the result of the comparison? Does it produce one big document with all entities and xincludes resolved? Or does it preserve those in the result? Two bugs to report: 1. The file chooser dialog shows no files unless I change the "Files of type" field to "All files" (the default "Any file, *, *.*, *.XML..." doesn't seem to match anything). 2. If you have a document with a DOCTYPE statement but with no DTD, it fails to parse the document. This situation arises when you use a schema to validate the document but add a DOCTYPE to declare entities. For example, if you attempt to load two versions of the following valid DocBook 5.x document, it fails to load the first one complaining that "book" has not been defined: <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE book [ <!ENTITY FOO 'base'> ]> <book version="5.0" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> <title>All your &FOO; are belong to us</title> <chapter> <title>blah</title> <para>blah</para> </chapter> </book> - ------------------------------------------- The plugin complains: Compare failed Problem loading the A input (com.deltaxml.framework.c_a.c_b) Caused by: Problem loading the A input (com.deltaxml.docbook.c_h) Element type "book" must be declared. (org.xml.sax.SAXParseException) - ------------------------------------------- My Environment: <oXygen/> XML Author 12.2, build 2011051714 Linux anatine 2.6.38-8-generic #42-Ubuntu SMP Mon Apr 11 03:31:24 UTC 2011 x86_64 x86_64 x86_64 GNU/Linux David On 07/06/2011 03:57 AM, Michael Anthony Smith wrote:
We have developed an oXygen plugin that shows the changes between any two versions of a document as oXygen 'tracked changes', which is available for evaluation download from http://www.deltaxml.com/products/oxygen-plugin/download.html. Please use oXygen's Author mode to view, accept and reject the changes.
We are looking for feedback from anyone using oXygen, who might find such a plugin useful, say to author structured documents.
If you use DITA, this plugin can also create a DITA topic with status and rev attributes inserted to show the changes between two versions of your topic.
Similarly, if you use DocBook, this plugin can create a DocBook document with revisionflag attributes inserted to show the changes between two versions of your document.
The DeltaXML oXygen Plugin provides authors of structured documents with that essential 'compare documents' feature found in ordinary word-processors.
We are in final beta stages and would appreciate any comments from oXygen users on this mailing list - please download an evaluation version and we look forward to hearing your feedback.
Please feel free to provide feedback via this mailing-list, to me directly, or the plugin's own support forum (http://www.deltaxml.com/forum/index/14).
Thanks for your help, Anthony
-----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.11 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iQEcBAEBAgAGBQJOFHphAAoJEMHeSXG7afUhgnQIAILqrXQKh+YCLS91xI1oB75P 22CrKmtzirzSOE5+Ma8cDxAEJuSKpUCE0odOK5hJ35yChB6kIn93XbakiGeefQ5n 23GwOOv8etNUABN7A3EE5JyYYaCFdjpj152ejNEN3MLIk5MJV0n5Wo0OAjGfL5Il YZDx++NTF+wDJa1YVDPpXdhjXPvd0RWoi6jH4bzj5bmTTVbc8j9jjFRytYyHuKOk hLdDSGM+TmjYQoCgqvsqHcH4f2EjpPBuxXXn+dip/zbj1WWWlTvWM2yS1pMzEe9y jQmpI65mklrj7dCkhj0IbROQNrW3nQRQlNNjhHQgGbzLKaT1Fj+enMha+FEVjhs= =6rbR -----END PGP SIGNATURE-----
David, Thanks for your feedback.
I haven't tested it with content that contains entities or xincludes yet. How does it treat those in the result of the comparison? Does it produce one big document with all entities and xincludes resolved? Or does it preserve those in the result? We have some configuration options relating to entity and xi:include expansion.
Currently entities are only preserved in the general XML comparison mode (which produces oXygen tracked changes). This default behavior can be configured by changing the value of the 'Preservation Mode' parameter. Note that the general XML comparison mode's configuration parameters are made available by pressing the 'Configure' button on the Comparison file/window selection panel. The DITA and DocBook comparison modes always expand entity references, as their revision flag markup is not intended for round-trip processing. The DocBook specific comparison mode, by default, expands xi:includes elements. This can be turned off by 'unchecking' the 'Enable XInclude' parameter. The general XML and DITA comparison modes do not expand xi:include elements.
Two bugs to report:
1. The file chooser dialog shows no files unless I change the "Files of type" field to "All files" (the default "Any file, *, *.*, *.XML..." doesn't seem to match anything).
We are currently working with oXygen to solve this bug. For more details please refer to the oXygen-user mailing list topic 'How to turn of file filtering when using the workspace.chooseFile method'.
2. If you have a document with a DOCTYPE statement but with no DTD, it fails to parse the document. This situation arises when you use a schema to validate the document but add a DOCTYPE to declare entities. For example, if you attempt to load two versions of the following valid DocBook 5.x document, it fails to load the first one complaining that "book" has not been defined:
We will address this bug, which arises due to the inappropriate use of DTD validation. One work-around is to compare these documents by turning off the 'Validation' configuration parameter. Alternatively, the general XML comparison successfully compares these files. Regards, Anthony. -- -- ------------------------------------------------------------------------- Michael Anthony Smith, DeltaXML Ltd "Change control for XML" T: +44 1684 578751 E:anthony.smith@deltaxml.com http://www.deltaxml.com Registered in England 02528681 Reg. Office: Monsell House, WR8 0QN, UK
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Hi Michael, Thanks for the information. This is a very interesting tool and I think it will be useful for many people. I've put follow-up questions inline below.
Currently entities are only preserved in the general XML comparison mode (which produces oXygen tracked changes). This default behavior can be configured by changing the value of the 'Preservation Mode' parameter. Note that the general XML comparison mode's configuration parameters are made available by pressing the 'Configure' button on the Comparison file/window selection panel.
The DITA and DocBook comparison modes always expand entity references, as their revision flag markup is not intended for round-trip processing.
I'm not seeing a "Preservation Mode" field in the "Preferences for Compare DocBook" window.
The DocBook specific comparison mode, by default, expands xi:includes elements. This can be turned off by 'unchecking' the 'Enable XInclude' parameter. The general XML and DITA comparison modes do not expand xi:include elements.
I see. I guess it would be quite a complex process to compare two files and their xincluded contents while preserving the xincludes. The tool would have to name and save new versions of all the xincluded files in a new directory and update all the hrefs on the xinclude elements. I could imagine situations that would be hard to process (say if an element were moved from the main file to an xincluded file with no other changes). But for a more limited case, say where all the xincluded files are code listings, this could work.
2. If you have a document with a DOCTYPE statement but with no DTD, it fails to parse the document. This situation arises when you use a schema to validate the document but add a DOCTYPE to declare entities. For example, if you attempt to load two versions of the following valid DocBook 5.x document, it fails to load the first one complaining that "book" has not been defined:
We will address this bug, which arises due to the inappropriate use of DTD validation. One work-around is to compare these documents by turning off the 'Validation' configuration parameter. Alternatively, the general XML comparison successfully compares these files.
Ok, thanks. Turning off validation works around the issue for now. David -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.11 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iQEcBAEBAgAGBQJOFc34AAoJEMHeSXG7afUhyT0H/21R8Qp+4jeExaQ4gqCCQF8/ Z9uvB2KeQsdvPhrVQB8beC0eyAAvataJjZVRyN7fsqsW6/SUV9zKF6FAuzwDOwVj IwzgZm/9OXE61dIT6bEKQyMvCxxme1rwdA0sn08Mbtzbt/FwwJesgniKYV2JeTPQ tr/pVswiHlH3NRtddBJRumHm63GiWZ77vM/Y0lvdetAV4M9qCMlq3awO6aP3PJGl UpGNLw7o+ULeyQ+ecx8GibivgCrVB41tprbsetZcfLz6fh0TcLVTvBHVIyqlOnpv kUgUyG7Ir58ZK3IYN+gEBRGiMEcGj2GPzjVDPZ5bGEdllDoXhAgwSXScNSaglgY= =UI0I -----END PGP SIGNATURE-----
Hi David,
I'm not seeing a "Preservation Mode" field in the "Preferences for Compare DocBook" window.
The "Preservation Mode" field is currently only available for general XML comparisons (accessed using the "XML Compare..." menu item). We are working on how best to apply entity preservation to the DocBook and DITA Comparisons and any comments on what you need would be useful. It might be worth sending these comments to me directly or our support forum (http://www.deltaxml.com/nk4um/forum/14/), so as not to clutter this mailing list. Regards, Anthony.
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Ok, I'll post further questions on your forum. Btw., I think folks on the docbook-apps [1] and dita-users [2] lists would be interested in your beta announcement. Thanks, David [1] http://wiki.docbook.org/DocBookDiscussion [2] http://tech.groups.yahoo.com/group/dita-users/ On 07/08/2011 09:44 AM, Michael Anthony Smith wrote:
Hi David,
I'm not seeing a "Preservation Mode" field in the "Preferences for Compare DocBook" window.
The "Preservation Mode" field is currently only available for general XML comparisons (accessed using the "XML Compare..." menu item).
We are working on how best to apply entity preservation to the DocBook and DITA Comparisons and any comments on what you need would be useful.
It might be worth sending these comments to me directly or our support forum (http://www.deltaxml.com/nk4um/forum/14/), so as not to clutter this mailing list.
Regards, Anthony.
-----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.11 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iQEcBAEBAgAGBQJOFx1GAAoJEMHeSXG7afUh7U4H/29OuPDfdmxdt4btr461QJYa gyJlyoJSDqyI1cUWToeyef785lvu+1yqlSjvScRpsa1cGktjKlzUp0sUG6r2IguB iRW9TWbefmziAWaWB3fHvQdp4TiaREsPFZXbFkQxJG7nZQBOof8kcHjWj+7FsHsl 7MxftR1dG5yfJzjNgXlDYGXKr/VHaTMm+KkMwGcdsN8YgJCgXR5Ox3bS36HneXYy pJOtcPQKZzsfaccsM1P/KEzh5/9XDqHmD+xzQQpoppPuGzsd8UW4utFc92mdTpEs i+WdisHWqmVD+aKh6P38H604t1bRN/SFLhjKT10ccyOZ3bcbJESN6WqIRT3p+ms= =dvRW -----END PGP SIGNATURE-----
I wonder if the DocBook and Dita approaches couldn't also be extended to TEI, using tei:add and tei:del? George just posted some code to tei-l that converts the Oxygen PI's to markup (and there were different solutions to the same problem there yesterday). I can think of a number of people in that community that could have use for robust difference checking that produced TEI compatible XML. Including me ;) On 11-07-08 09:07 AM, David Cramer wrote:
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1
Ok, I'll post further questions on your forum.
Btw., I think folks on the docbook-apps [1] and dita-users [2] lists would be interested in your beta announcement.
Thanks, David
[1] http://wiki.docbook.org/DocBookDiscussion [2] http://tech.groups.yahoo.com/group/dita-users/
On 07/08/2011 09:44 AM, Michael Anthony Smith wrote:
Hi David,
I'm not seeing a "Preservation Mode" field in the "Preferences for Compare DocBook" window.
The "Preservation Mode" field is currently only available for general XML comparisons (accessed using the "XML Compare..." menu item).
We are working on how best to apply entity preservation to the DocBook and DITA Comparisons and any comments on what you need would be useful.
It might be worth sending these comments to me directly or our support forum (http://www.deltaxml.com/nk4um/forum/14/), so as not to clutter this mailing list.
Regards, Anthony.
-----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.11 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iQEcBAEBAgAGBQJOFx1GAAoJEMHeSXG7afUh7U4H/29OuPDfdmxdt4btr461QJYa gyJlyoJSDqyI1cUWToeyef785lvu+1yqlSjvScRpsa1cGktjKlzUp0sUG6r2IguB iRW9TWbefmziAWaWB3fHvQdp4TiaREsPFZXbFkQxJG7nZQBOof8kcHjWj+7FsHsl 7MxftR1dG5yfJzjNgXlDYGXKr/VHaTMm+KkMwGcdsN8YgJCgXR5Ox3bS36HneXYy pJOtcPQKZzsfaccsM1P/KEzh5/9XDqHmD+xzQQpoppPuGzsd8UW4utFc92mdTpEs i+WdisHWqmVD+aKh6P38H604t1bRN/SFLhjKT10ccyOZ3bcbJESN6WqIRT3p+ms= =dvRW -----END PGP SIGNATURE----- _______________________________________________ oXygen-user mailing list oXygen-user@oxygenxml.com http://www.oxygenxml.com/mailman/listinfo/oxygen-user
-- *Daniel Paul O'Donnell, PhD Professor of English, University of Lethbridge <http://www.uleth.ca/> Co-President, Society for Digital Humanities/Société pour l'étude des médias interactifs <http://www.sdh-semi.org/> Co-Editor, /Digital Studies/Le champ numérique <http://www.digitalstudies.org/>/ Founding Editor, /Digital Medievalist <http://www.digitalmedievalist.org/journal>/ *
Hi Michael, We have evaluated deltaXML in the past and found it suitable enough for our purposes - our only issue was that the cost was prohibitive. Do you expect that your oXygen plugin will be any cheaper considering that buyers will not be using it in a general purpose way and only using it within oXygen? Thanks -----Original Message----- From: oxygen-user-bounces@oxygenxml.com [mailto:oxygen-user-bounces@oxygenxml.com] On Behalf Of Michael Anthony Smith Sent: Wednesday, July 06, 2011 1:58 AM To: oxygen-user@oxygenxml.com Subject: [oXygen-user] oXygen Author-mode document comparison plugin We have developed an oXygen plugin that shows the changes between any two versions of a document as oXygen 'tracked changes', which is available for evaluation download from http://www.deltaxml.com/products/oxygen-plugin/download.html. Please use oXygen's Author mode to view, accept and reject the changes. We are looking for feedback from anyone using oXygen, who might find such a plugin useful, say to author structured documents. If you use DITA, this plugin can also create a DITA topic with status and rev attributes inserted to show the changes between two versions of your topic. Similarly, if you use DocBook, this plugin can create a DocBook document with revisionflag attributes inserted to show the changes between two versions of your document. The DeltaXML oXygen Plugin provides authors of structured documents with that essential 'compare documents' feature found in ordinary word-processors. We are in final beta stages and would appreciate any comments from oXygen users on this mailing list - please download an evaluation version and we look forward to hearing your feedback. Please feel free to provide feedback via this mailing-list, to me directly, or the plugin's own support forum (http://www.deltaxml.com/forum/index/14). Thanks for your help, Anthony -- -- ------------------------------------------------------------------------- Michael Anthony Smith, DeltaXML Ltd "Change control for XML" T: +44 1684 578751 E: anthony.smith@deltaxml.com http://www.deltaxml.com Registered in England 02528681 Reg. Office: Monsell House, WR8 0QN, UK _______________________________________________ oXygen-user mailing list oXygen-user@oxygenxml.com http://www.oxygenxml.com/mailman/listinfo/oxygen-user
Hi Dylan, On 06/07/2011 17:33, Dylan Dawson wrote: ...
Do you expect that your oXygen plugin will be any cheaper considering that buyers will not be using it in a general purpose way and only using it within oXygen?
Yes the oXygen plugin is significantly cheaper than our API products, please see http://www.deltaxml.com/products/oxygen-plugin/buy.html for details. Regards, Anthony. -- -- ------------------------------------------------------------------------- Michael Anthony Smith, DeltaXML Ltd "Change control for XML" T: +44 1684 578751 E:anthony.smith@deltaxml.com http://www.deltaxml.com Registered in England 02528681 Reg. Office: Monsell House, WR8 0QN, UK
participants (4)
-
David Cramer -
Dylan Dawson -
Michael Anthony Smith -
O'Donnell, Dan