================================================================

=== Project Name: Kepler Actor Documentation (In Progress)   ===

=== Team Head: Ilkay Altintas  Student: Nandita Mangal =========

================================================================



This README contains the following topics:



1. Distribution of Documentation Process Source and Output Files 

   as in Kepler Package.

2. Source Files Neede.

3. Compiling source files and generating output documentation.





1. File Distribution:

	

Dir: HomeDir/Kepler/docs/user/docbook/actor

		--> all the XML files (build file copies from src dir)

		--> all the XSL files (build file copies from src dir)



Dir: HomeDir/Kepler/docs/user/actor

		--> Actor Documentation HTML file (output file)



Dir: HomeDir/Kepler/docs/user/docbook

		--> build.xml



Dir: HomeDir/Kepler/docs/user/docbook/src

		--> all the XML source input files

		--> all the OWL source input files

		--> all the XSL source input files

	

2. Source Files:



	ConceptFormation.xsl

	ActorFormation.xsl

	DocumentFormation.xsl

	ontology.owl

	annotations.owl

	basicKeplerActorLibrary.xml

	build.xml 





3. Documentation Process:

	

	Place files as per the file distribution requirements as discussed

	previously in the first topic.



	> cd HomeDir/Kepler/docs/user/docbook

	> ant 

		<expected output>

		$ ant

		Buildfile: build.xml



		genActorDoc:

  		  	[mkdir] Created dir: C:\Project\kepler\docs\user\docbook\actor

    			[mkdir] Created dir: C:\Project\kepler\docs\user\actor

     			[copy] Copying 9 files to C:\Project\kepler\docs\user\docbook\actor



		build:

   			[echo] Compiling the XSLT Processor in ./actor

     			[xslt] Processing C:\Project\kepler\docs\user\docbook\actor\KeplerConcepts.

			xml to C:\Project\kepler\docs\user\docbook\actor\ConceptActorOutput.xml

     			[xslt] Loading stylesheet C:\Project\kepler\docs\user\docbook\actor\ActorFo

			rmation.xsl

     			[xslt] Processing C:\Project\kepler\docs\user\docbook\actor\ConceptActorOut

			put.xml to C:\Project\kepler\docs\user\actor\KeplerDocumentation.html

     			[xslt] Loading stylesheet C:\Project\kepler\docs\user\docbook\actor\Documen

			tationFormation.xsl



	        BUILD SUCCESSFUL

	

	

	The Documentation output is produced in  HomeDir/Kepler/docs/user/actor as per file distribution requirements.





	To remove/ reproduce documentation:-

	

	> ant clean

		<expected output>

		$ ant clean

		Buildfile: build.xml



		genActorDoc:



		build:

     			[echo] Compiling the XSLT Processor in ./actor



		clean:

  			 [delete] Deleting directory C:\Project\kepler\docs\user\docbook\actor

  			 [delete] Deleting directory C:\Project\kepler\docs\user\actor



		BUILD SUCCESSFUL

		

	

			