FCL/sftools/dev/build: metatools/sysdeftools/docs/readme.txt@c22eff170fac (annotated)

624 f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	1	# Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	2	# All rights reserved.
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	3	# This component and the accompanying materials are made available
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	4	# under the terms of "Eclipse Public License v1.0"
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	5	# which accompanies this distribution, and is available
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	6	# at the URL "http://www.eclipse.org/legal/epl-v10.html".
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	7	#
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	8	# Initial Contributors:
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	9	# Nokia Corporation - initial contribution.
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	10	# Contributors:
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	11	# Description:
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	12
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	13	Run any .bat or .pl file with no arguments to get syntax and command line options.
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	14
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	15	Directory structure
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	16
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	17	Main directory contains XLST and Perl scripts and the .bat files that call them
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	18	docs contains this file
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	19	lib contains common XSLT modules
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	20	xalanj contains an implementation of Xalan-J, an XSLT processor implemented in Java
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	21
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	22
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	23	The tools
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	24
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	25	Filtering tools:
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	26	filtering.xsl - Filter a sysdef in the 2.0 or 3.0 syntax
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	27	filtering.bat - Call filtering.xsl using xalan-j
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	28
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	29	Joining tools:
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	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.
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	31	joinsysdef.bat - Call joinsysdef.pl
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	32	joinsysdef.xsl - Create a stand-alone sysdef from a linked set of fragments
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	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.
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	34
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	35	Merging tools:
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	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.
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	37	mergesysdef.bat - Call mergesysdef.xsl using xalan-j
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	38
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	39	Other tools:
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	40	sysdefdowngrade.xsl - Convert a 3.0.x sysdef to 2.0.1 sytnax
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	41	sysdefdowngrade.bat - Call sysdefdowngrade.xsl using xalan-j
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	42	rootsysdef.pl - Generate a root system definition from a template root sysdef and a set of wildcard paths to look for pkgdef files
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	43	rootsysdef.bat - Call rootsysdef.pl
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	44
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	45	Validation tools:
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	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.
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	47	checklinks.bat - call checklinks.pl
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	48	validate-sysdef.xsl - Validate a sysdef file, reporting any errors as plain text
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	49	validate-sysdef.bat - Call validate-sysdef.xsl using xalan-j
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	50
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	51	Modules (in lib):
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	52	filter-module.xsl - XSLT module which contains the logic to process the filter attribute in the system definition
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	53	joinsysdef-module.xsl - XSLT module which contains the logic to join a system definition file
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	54	mergesysdef-module.xsl - XSLT module for merging only two sysdef files according to the 3.0.0 rules
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	55	test-model.xsl - XSLT module for validating sysdef files
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	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"?>
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	57
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	58
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	59	XSLT Processing (in xalanj):
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	60	xalan.jar
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	61	xercesImpl.jar
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	62	xml-apis.jar
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	63	serializer.jar
f70b728ea30c Move sysdeftools from buildtools package into build package Bob Rosenberg <bob.rosenberg@nokia.com> parents: diff changeset	64

author	lorewang
	Mon, 22 Nov 2010 10:56:31 +0800
changeset 700	c22eff170fac
parent 624	f70b728ea30c
permissions	-rw-r--r--