TransXChange Publisher Version 2.1_1

(c) 2005 Crown Copyright.
Developed by Kizoom limited. http://www.kizoom.com

30 September 2005

============================================================
1. Prerequisites
    
    Java Runtime Environment (JRE) version 1.4.2 (or later) 
    Available from http://java.sun.com/j2se/1.4.2/download.html. 
    
    To check your current Java version
      (a) Open a command prompt.
      (b) Type "java -version" at a command prompt. 
          If you have java correctly installed, you should see a message telling you the version of Java currently installed.
  
2. Installation
    
    2.1. Unzip the publisher distribution into a base directory on your machine.

         You should see the following top level contents.
         
         /TransXChangePublisher-app-2.1_1.jar
         /apidocs/
         /documents/
         /images/
         /schema/
         /transforms/
         /catalog.xml
         /default_rules.txt
         /publish.bat
         /validate.bat
         
         The /schema directory includes the TransXChange XSD schema files - these are used to validate documents
         before publishing them.
         
         The /documents directory includes a sample document you can use to try out the publisher.
         
         The /apidocs directory contains JavaDoc for the public API for the TransXChange Publisher.
    
3. Running the publisher
    
    3.1. Open a command prompt and change directory to the base directory where you installed the publisher.
    
    3.2 Invoke the publisher by typing:
    
            publish document_name 
            
        For example, to run the publisher on one of the shipped examples:
    
             publish documents\2.1\linear.xml
        
        Unless otherwise specified, output is placed in the same directory as the input document
        The file name will be the same with a .pdf suffix, for example
        
             documents\2.1\linear.pdf
                          
    3.3. You can type "publish -help" to see the allowed command values.
    
4. Command line parameters

    The publisher has a number of optional command line parameters

	publish [-vosa|-full|-timetableOnly] [-novalidation] [-help] transxchange_file [output_directory]
    
    Type "publish -help" for more information.
    
===================================================
5. Limitations 

Please report defect reports and other feedback to schemer@kizoom.com

5.1 'As is' Status 
    - The publisher has only been tested on a Windows 2000 and XP platforms. 
    - Only a limited set of test cases has been run so far.

5.2 Limitations on current use.
    - No known major limitations.
 
5.3 Planned Further improvements to presentation and usability
	- No planned improvements.
     
6.0 Changes in 2.1_1
	- Added a public API for programmatic generation of Timetables. See /apidocs directory for more information.
	- Changed Timetable stop name format to include Locality, if specified.