Initial revision
[TestXSLT.git] / Distribution / readme.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2
3 <!-- $id$ -->
4
5 <readme>
6 <title>Readme for TestXSLT</title>
7
8 <author>Written by Marc Liyanage <email>liyanage@access.ch</email></author>
9
10 <description>
11 <para>TestXSLT is a small tool for experimenting with XSLT in a convenient way
12 on Mac OS X. It uses the Sablotron XSL processor from <url>http://www.gingerall.com/charlie/ga/xml/p_sab.xml</url> and the Gnome libxslt processor from <url>http://xmlsoft.org/XSLT/</url>.</para>
13
14 <para>The program takes an .xml and an .xsl file and either displays the result of the transformation in an output window or writes it to a file.</para>
15
16 <para>You can either edit the XML and XSLT code directly in the program or you can load them from files on disk. Try drag and drop for the latter.</para>
17
18 <para>There are some examples included to get you started. The first is this Readme document that you are reading now. It was written and is maintained in XML. I have included two stylesheets which convert the XML input file into an RTF document and into an HTML page. Study the input, the stylesheets and the output files carefully to learn some basics. The stylesheets are commented.</para>
19
20 <para>There are also various other example files to get you started with XSLT. Just play around with the files and see what happens...</para>
21
22 <para>Comments, feedback and feature suggestions are welcome to the address above.</para>
23
24 <para>If you own BBEdit, I suggest that you check out my "BBEdit XSLT Glossary" package, available from my homepage. TestXSLT has been
25 optimized to work well together with BBEdit. You can edit and save an XSLT file in BBEdit, switch back to TestXSLT and
26 the XSLT code will be updated from disk immediately.</para>
27
28 <para>The latest version of this software is available at <url>http://www.entropy.ch/software/macosx/</url></para>
29
30 </description>
31
32 <requirements>
33 Mac OS X 10.2., Safari 1.0 must be installed on your system.
34 </requirements>
35
36 <history>
37
38 <entry>
39         <version>2.7</version>
40         <date>05-AUG-2003</date>
41         <item>Embedded Apple's WebKit/KHTML/Safari HTML rendering engine. This means you can now view the result of a transformation which produces HTML output directly in the "Result" pane of the application, no need to go to an external browser anymore.</item>
42         <item>Now includes the Java Saxon XSLT processor, made possible by the Java/Objective-C bridge. Fun stuff...</item>
43         <item>Added a new, short and interesting example XSLT file. It converts a Safari Bookmarks.plist XML file to an HTML page.</item>
44 </entry>
45
46 <entry>
47         <version>2.6</version>
48         <date>01-APR-2003</date>
49         <item>When a file used as XML or XSLT source in TestXSLT is modified on disk externally, e.g. in another editor like BBEdit, and TestXSLT is brought back to the front, it will reload the file contents from disk, unless there are local, unsaved changes. In that case, the program will prompt the user if the unsaved changes should be preserved or discarded. This also has the effect that if the same file on disk is loaded into two different document windows and is edited and saved in one of them, the data will be updated in the other windows using the same file when they are brought to the front.</item>
50         <item>Very complex stylesheets with lots of relative file dependencies like the Docbook XSLT kit from <url>http://docbook.sourceforge.net/projects/xsl/</url> now work correctly, but only with the Libxslt processor. Sablotron seems to be broken in this regard, I'm investigating. (The actual changes for Libxslt: Now initializing the XML and XSLT libraries correctly)</item>
51         <item>The XSLT processor type is now selectable via AppleScript. The "Demo Applescript" has been updated to give an example of this new capability. (Thanks to Damien Johnston and Bill Turner for the suggestion.)</item>
52         <item>Fixed a bug where the file path for XML or XSLT source files was only updated when the files were dragged, not when using the "Open" buttons.</item>
53         <item>Fixed incorrect invocation of sheets for "Jump To Line" and "Find" panels. This could lead to strange behavior of the error message drawer.</item>
54         <item>Only of interest to developers: The Project Builder setup has been reorganized quite a bit (All libraries (libiconv, libexpat, libsablot, libxml2, libxslt) are now embedded frameworks, and were updated to the latest releases).</item>
55 </entry>
56
57 <entry>
58         <version>2.5</version>
59         <date>15-OCT-2002</date>
60         <item>The "Find" machinery is now connected to the system-wide find pasteboard. This means that the current find string is communicated to and from most other Cocoa applications, and some Carbon applications like BBEdit.</item>
61         <item>Relative references in xsl:import and xsl:include statements can now be resolved if the content of the XSLT pane was loaded from or has been saved to a file on disk.</item>
62         <item>The filenames for the XML, XSLT and result panes are now saved in the workset document, along with the content itself.</item>
63 </entry>
64
65 <entry>
66         <version>2.4</version>
67         <date>26-SEP-2002</date>
68         <item>Fixed bug where clipping files were not treated as such during drag and drop into the text views.</item>
69         <item>Now distributing the demo AppleScript in .sit format because CVS eats it otherwise.</item>
70         <item>Added autocompletion when you type the start of a closing tag (Thanks to Fabio Vena for the suggestion).</item>
71         <item>Added a short flash of the opening tag name on autocompletion.</item>
72         <item>Added a processing time indicator so you can get an idea about the performance impact of changes (Thanks to Michael Wechner for the suggestion).</item>
73         <item>Added "Jump To Line" command.</item>
74         <item>Added Undo support.</item>
75         <item>Added "Find" command.</item>
76         <item>Added Online Help containing the XSLT and XPath specification documents.</item>
77 </entry>
78
79 <entry>
80         <version>2.3</version>
81         <date>05-AUG-2002</date>
82         <item>Now includes the Gnome Libxslt processor in addition to Sablotron. You can choose which one is used with a popup-menu at the bottom of the window.</item>
83         <item>Added a cool tag-completion feature. Type an opening tag and hit the ESC key and the program will automatically insert the closing tag.</item>
84         <item>Added a small icon in the XML and XSLT panes that indicates if the code you entered is well-formed XML while you type. You can immediately see if the code is correct. Leave the mouse positioned over the icon to get more information in the Tool Tip.</item>
85         <item>Added "Save" function to XML and XSLT panes. This means you can re-save after you saved once with "Save As...", or after importing text with drag-and-drop from a file.</item>
86         <item>Added beep when a transformation fails (Thanks to Severin Klaus for some UI improvement suggestions).</item>
87 </entry>
88
89 <entry>
90         <version>2.2</version>
91         <date>20-JUL-2002</date>
92         <item>Added drag and drop support for the XML and XSLT panes (Thanks to VersionTracker user ximian420 for the suggestion).</item>
93         <item>Added "auto save" and "auto show" check boxes to the result pane (Thanks to Matthias Aebi for the suggestion).</item>
94         <item>I finally found out how to get at the error messages of the XSLT processor, so errors are now displayed and you do not need to use the Console application any more.</item>
95         <item>Fired up Photoshop and added an icon :-)</item>
96 </entry>
97
98 <entry>
99         <version>2.1.1</version>
100         <date>06-JUL-2002</date>
101         <item>Bug fix release as 2.1 wouldn't even launch on most machines because of a link mistake.</item>
102 </entry>
103
104 <entry>
105         <version>2.1</version>
106         <date>06-JUL-2002</date>
107         <item>This version adds AppleScript support, you can now use it to run XSLT transformations in AppleScript.</item>
108 </entry>
109
110 <entry>
111         <version>2.0</version>
112         <date>10-MAR-2002</date>
113         <item>This is a complete rewrite in from scratch in Objective-C using the Cocoa frameworks on Mac OS X. It has much more features, is no longer a Java application and is now based on a different XSLT processor (Sablotron instead of Xalan).</item>
114         <item>The only thing that's missing are meaningful error messages in the program. You have to open the console to see the error messages.</item>
115 </entry>
116
117 <entry>
118         <version>1.5</version>
119         <date>12-DEC-2001</date>
120         <item>Improved error reporting. Now prints exact location of errors in input XML and XSL files.</item>
121 </entry>
122
123 <entry>
124         <version>1.4</version>
125         <date>11-DEC-2001</date>
126         <item>udpated to Xalan-J 2.2_D13</item>
127         <item>Now using JAXP / TrAX APIs so the parser and XSL processor could be switched</item>
128         <item>Included Readme XML and XSL Files</item>
129 </entry>
130
131 <entry>
132         <version>1.3</version>
133         <date>29-APR-2001</date>
134         <item>added "Choose" buttons so it no longer relies exclusively on DnD</item>
135 </entry>
136
137 <entry>
138         <version>1.2</version>
139         <date>13-APR-2001</date>
140         <item>Mac OS X-only, added own output window instead of using console</item>
141 </entry>
142
143 <entry>
144         <version>1.1</version>
145         <date>10-FEB-2001</date>
146         <item>added save to file functionality</item>
147 </entry>
148
149 <entry>
150         <version>1.0</version>
151         <date>04-FEB-2001</date>
152         <item>first version</item>
153 </entry>
154
155
156
157
158 </history>
159
160 </readme>