****************************************************************** ***** ***** ***** ***** ***** ReadMe.txt ***** ***** ***** ***** ***** ***** QuiP ***** ***** ***** ***** Version 1.3.1 ***** ***** ***** ***** ***** ***** This file last updated: 2001-05-17 ***** ***** ***** ***** ***** ***** Software AG ***** ***** Uhlandstrasse 12 ***** ***** D-64297 Darmstadt ***** ***** Germany ***** ***** ***** ***** Telephone: +49-6151-92-0 ***** ***** Fax: +49-6151-92-1191 ***** ***** email: tamino@softwareag.com ***** ***** WWW: http://www.softwareag.com/tamino ***** ***** ***** ***** ***** ****************************************************************** Authors: Patrick Lehti (Java parts) Sven Eric Panitz (Clean parts) Jürgen Kindler (nightly build) Prerequisites ============= You must have a Java virtual machine (version 1.3). (You also need a computer running some Windows operating system, but I guess you expected that!) Installation ============ You have already unpacked the file 'quip.zip'. That's all! First Steps =========== Open a command shell (also known as a command prompt or DOS-box). Change to the directory where you found this 'ReadMe.txt' file (the .\QuiP directory). Start the command '.\QuipGui.cmd' A Java program is started, which is a GUI frontend for QuiP. a) Queries for data stored in the file system: - Tick the radio button 'Filesystem' (default) - Enter 'examples' in the field 'Directory:' (this value is preselected) - Select the 'open' item of the file menu (or click the 'open folder' icon) and open any of the *.xquery files for example 'TREEQ6.xquery'. An XQuery query should appear. - Press the execute button and see what happens: + If you see some output displayed in the output window, then simply enjoy! + Otherwise hopefully a helpful error message is displayed in the output window. b) Queries for data stored in a Tamino database: - Create a collection with the name 'theater' in your database. - Define the doctype 'PLAY' from the DTD 'examples/play.dtd' in the collection 'theater'. (You can also use 'examples/TaminoSchemaPLAY.xml', where indices are defined for Tamino.) - Load the documents found in 'examples/theater' into your database. - In the QuiP GUI, tick the radio button 'Tamino' and enter the name of your server, for example: 'pcmymachine', and the name of the database. - Load any query whose name starts with 'PLAY', for example 'PLAY04.xquery', from the examples directory into QuiP. - Press execute. Enjoy! Command Line ============ In addition to the GUI tool, there is also a command-line version of QuiP. The script file RunQuip.cmd is an example that shows how the command-line interface can be used. Limitations =========== Not implemented are: - dereference symbol - namespace functions etc. - static type checking or any schema evaluation In addition, the test for equality on nodes compares strings (this corresponds to the implementation in XPath). Other features are only partially implemented. Known Problems ============== 1. QuiP is currently rather nitpicking about path names. In some situations it only accepts true Windows path notation (only backslashes are accepted, slashes are not valid). 2. Large quantities of results returned by queries may block the GUI frontend. Non-Standard Additions ====================== Note: There are not yet any standards! function: 'fromCollection(name)' with a String argument 'name'. This selects all documents found in a collection. When working with Tamino, it refers to the Tamino collection named 'name' in the database. When working with the file system, it refers to all documents in the directory 'name'. Very simple higher-order functions. see prelude.xquery as example. Troubleshooting =============== Your computer may not have enough memory to store the heap if the heap size is set to its default value (or larger). You can change the size of the heap in the GUI frontend ('options' menu). Addresses ========= Software AG XQuery forum: forums.tamino.com W3C XQuery working group: www.w3.org/XML/Query Quilt homepage: www.almaden.ibm.com/cs/people/chamberlin/quilt.html Quip's XML parser and pretty printer are taken from the HaXml system from the University of York: www.cs.york.ac.uk/fp/HaXml/ They have been ported from Haskell to Clean (www.cs.kun.nl/~clean/).