projects/lcsim/trunk/detector-framework/src/site/apt
--- projects/lcsim/trunk/detector-framework/src/site/apt/index.apt 2014-02-22 01:09:58 UTC (rev 3017)
+++ projects/lcsim/trunk/detector-framework/src/site/apt/index.apt 2014-02-22 01:10:31 UTC (rev 3018)
@@ -1,5 +0,0 @@
- The lcsim-detector-description package provides detector and geometry services for {{{http://www.lcsim.org/software/lcsim}lcsim}}.
-
- {{{http://confluence.slac.stanford.edu/display/ilc/Converting+to+LCDD+or+HepRep+using+GeomConverter}Converting to LCDD or HepRep}}.
-
- {{{https://jira.slac.stanford.edu/browse/GC}Jira Bug Tracker}}
projects/lcsim/trunk/detector-framework/src/site/apt
--- projects/lcsim/trunk/detector-framework/src/site/apt/usage.apt.vm (rev 0)
+++ projects/lcsim/trunk/detector-framework/src/site/apt/usage.apt.vm 2014-02-22 01:10:31 UTC (rev 3018)
@@ -0,0 +1,31 @@
+ ---
+LCSim - Detector Framework - Converting Compact Descriptions
+ ---
+
+Converting Compact Descriptions to Other Formats
+
+* Overview
+
+ The Detector Framework module can be used to convert compact.xml files to other output formats including LCDD files
+ for the SLIC detector simulation application.
+
+* Basic Usage
+
+ Assuming that the entire trunk of LCSim was built successfully, then the Detector Framework jar can be executed from
+ the command line as follows:
+
++--
+cd lcsim/trunk
+java -jar ./${project.name}/target/${project.artifactId}-${project.version}-bin.jar
++--
+
+ This will show a GUI that allows you to select an input compact.xml file, a conversion format target, and the name of the
+ output file.
+
+* Converting to LCDD
+
+ The LCDD output target can be used to generated a GDML based format for input to the SLIC simulation application.
+
++--
+java -jar ./${project.name}/target/${project.artifactId}-bin.jar -o lcdd compact.xml MyDetector.lcdd
++--
projects/lcsim/trunk/detector-framework/src/site
--- projects/lcsim/trunk/detector-framework/src/site/site.xml (rev 0)
+++ projects/lcsim/trunk/detector-framework/src/site/site.xml 2014-02-22 01:10:31 UTC (rev 3018)
@@ -0,0 +1,9 @@
+<project>
+
+ <body>
+ <menu name="Documentation">
+ <item name="Usage" href="usage.html"/>
+ </menu>
+ </body>
+
+</project>