TransXChange Publisher Beta Version 2.0d_1  

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

25 June 2004


============================================================
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 Make sure you have Java Runtime Environment (JRE) version 1.4.2 (or later) installed.
    
    2.2. Unzip the publisher distribution into a base directory on your machine.

         You should see the following top level contents.
         
         \TransXChangePublisher-app-0.1.jar
         \documents
         \schema
         \transforms
         \catalog.xml
         \publish.bat
         
         The \schema directory includes the TransXChange 3.d file s- tehse are used to validate documents
         before publishing them.
         
         The \documets directory includes some sample documents you can use to try out the 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   
    
             publish documents\2.0d\simple_registration.xml
             
        When running, the publisher produces lots of harmless error messages when publishing "ancillary" or "combined" timetables. 
        
        Unless otherwise specified, output is placed in the same directory as the input documet
        File name will be teh same with a .pdf suffix, for example
        
           \documents\2.0d\simple_registration.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  [ [-combination | -ancillary | -timetables] [-pdf | -docbook] -help ]
            transxchange_file [output_directory]

===================================================
5. Limitations 

This is a first beta version of The TXC publisher and has a number of limitations. 

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

5.1 Beta '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.
    - Only a single service can be published at a time at present.
    - FrequentService times are not supported yes.
    - ShortNoticeRegistation details not currently covered.
    - FlexibleServices not supported (Pending schema revision to allow hybrid services)
    - Some other documentary annotations are not included.
 
5.3 Planned Further improvements to presentation and usebility
    - Addition of Logo & Style - Some cosmetic improvements to appearance and layout are planned.
    - Supression of text values for optional elements (At the present these appear with empty values)
    - Addition of a completion message / suppression of diagnostics from log.
    - Embedding of supporting docs which are images (Pending minor schema revision to support these better)