TransXChange Publisher Beta Version 2.0e_2

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

8 September 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. Unzip the publisher distribution into a base directory on your machine.

         You should see the following top level contents.
         
         \TransXChangePublisher-app-2.0e_2.jar
         \documents
         \schema
         \transforms
         \catalog.xml
         \publish.bat
         
         The \schema directory includes the TransXChange XSD schema files - these are used to validate documents
         before publishing them.
         
         The \documents 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.0e\linear.xml
             
        When running, the publisher produces lots of harmless error messages when publishing "VOSA" or "full" timetables. 
        
        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.0e\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] [-pdf | -docbook] -help]
            transXChange_file [output_directory]
    
    Type "publish -help" for more information.
    
    
    a. Output Option values
      -vosa : Causes only elements needed for VOSA registration to be published
        - Single registered service
        - Timing points only
        
      -timetableOnly: only matrix published  
      
      -full : additional elements and info points included
      
    b. Output format value 
        -pdf : pdf format
        -docbook : docbook format
        
    c. Help
        -help
        
    d. Input file name
    
    e. Output directory: file name will be same as input file, with .pdf suffix
         
         
    
===================================================
5. Changes Since version 2.0e_1

    - Support for inherited links
    - A number of bugs fixed
    - Some additional content elements covered
    - Addition of Registration (VOSA) and General switch
    

6. Limitations 

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

Known issues: 
    The Publisher needs a valid TXC schema to use when running:
    it currently locates the schema using the schemalocation element in the
    in a input document.  
    If this schema (which should be 2.0e for the 2.0e publisher versions) 
    cannot be found, it will not publish. 
    In future we will revise this to use a schema shipped along with the publisher regardless.

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.
    - Some content elements 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 usability
    - Revision of form to correspond to VOSA order and labelling
    - Addition of Logo & Style - Some cosmetic improvements to appearance and layout.
    - Coverage of some additional elements
    - Suppression of text values for optional elements (At the present these appear with empty values)
    - Addition of a completion message / suppression of diagnostics from log.