metatools/sysdeftools/docs/readme.txt
changeset 624 f70b728ea30c
equal deleted inserted replaced
621:96fee2635b19 624:f70b728ea30c
       
     1 # Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     2 # All rights reserved.
       
     3 # This component and the accompanying materials are made available
       
     4 # under the terms of "Eclipse Public License v1.0"
       
     5 # which accompanies this distribution, and is available
       
     6 # at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 #
       
     8 # Initial Contributors:
       
     9 # Nokia Corporation - initial contribution.
       
    10 # Contributors:
       
    11 # Description:
       
    12 
       
    13 Run any .bat or .pl file with no arguments to get syntax and command line options.
       
    14 
       
    15 *Directory structure*
       
    16 
       
    17 Main directory contains XLST and Perl scripts and the .bat files that call them
       
    18 docs contains this file
       
    19 lib contains common XSLT modules
       
    20 xalanj contains an implementation of Xalan-J, an XSLT processor implemented in Java
       
    21 
       
    22 
       
    23 *The tools*
       
    24 
       
    25 Filtering tools: 
       
    26 filtering.xsl - Filter a sysdef in the 2.0 or 3.0 syntax
       
    27 filtering.bat - Call filtering.xsl using xalan-j
       
    28 
       
    29 Joining tools: 
       
    30 joinsysdef.pl - Create a stand-alone sysdef from a linked set of fragments. Supports confguring via an .hrh file. By default this also embeds any linked metadata.
       
    31 joinsysdef.bat - Call joinsysdef.pl
       
    32 joinsysdef.xsl - Create a stand-alone sysdef from a linked set of fragments
       
    33 joinandparesysdef.xsl - Create a stand-alone sysdef from a linked set of fragments, paring down to just a set of items of the desired rank.
       
    34 
       
    35 Merging tools: 
       
    36 mergesysdef.xsl - Merge two 3.x syntax stand-alone system definitions. It can process two standalone sysdefs or two sysdef fragments which describe the same system model item.
       
    37 mergesysdef.bat - Call mergesysdef.xsl using xalan-j
       
    38 
       
    39 Other tools:
       
    40 sysdefdowngrade.xsl - Convert a 3.0.x sysdef to 2.0.1 sytnax
       
    41 sysdefdowngrade.bat - Call sysdefdowngrade.xsl using xalan-j
       
    42 rootsysdef.pl - Generate a root system definition from a template root sysdef and a set of wildcard paths to look for pkgdef files
       
    43 rootsysdef.bat - Call rootsysdef.pl
       
    44 
       
    45 Validation tools:
       
    46 checklinks.pl - Checks that all referenced files in a system definition exist at the specified locations. If there are any linked system definition fragments, it will recursively check them as well.
       
    47 checklinks.bat - call checklinks.pl
       
    48 validate-sysdef.xsl - Validate a sysdef file, reporting any errors as plain text
       
    49 validate-sysdef.bat - Call validate-sysdef.xsl using xalan-j
       
    50 
       
    51 Modules (in lib):
       
    52 filter-module.xsl - XSLT module which contains the logic to process the filter attribute in the system definition
       
    53 joinsysdef-module.xsl - XSLT module which contains the logic to join a system definition file
       
    54 mergesysdef-module.xsl - XSLT module for merging only two sysdef files according to the 3.0.0 rules
       
    55 test-model.xsl - XSLT module for validating sysdef files
       
    56 modelcheck.xsl - Validates a sysdef file, reporting any errors in HTM format. Can validate a sysdef in a web browser by using <?xml-stylesheet type="text/xsl" href="modelcheck.xsl"?>
       
    57 
       
    58 
       
    59 XSLT Processing (in xalanj):
       
    60 xalan.jar
       
    61 xercesImpl.jar
       
    62 xml-apis.jar
       
    63 serializer.jar
       
    64