[Volute] r3543 - in trunk/projects/dm/vo-dml: . models/templates

Volute commit messages volutecommits at g-vo.org
Wed Oct 26 18:05:07 CEST 2016


Author: mdittmar
Date: Mon Sep 12 23:14:46 2016
New Revision: 3543

Log:
clean up build.properties; add template vo-dml.properties file for new models

Added:
   trunk/projects/dm/vo-dml/models/templates/vo-dml.properties
Modified:
   trunk/projects/dm/vo-dml/build.properties

Modified: trunk/projects/dm/vo-dml/build.properties
==============================================================================
--- trunk/projects/dm/vo-dml/build.properties	Mon Sep 12 21:36:37 2016	(r3542)
+++ trunk/projects/dm/vo-dml/build.properties	Mon Sep 12 23:14:46 2016	(r3543)
@@ -1,44 +1,53 @@
-# folder containing vo-dml.properties file used to configure generation
-# BE CAREFUL WITH TRAILING SPACES, SHOULD BE TRIMMED HERE!!!
-# input defines one or more (comma separated) folders containing a vo-dml.properties file
-# If multiple models are defined, there must be no trailing or internal whitespaces!
-# having multiple models requires existence of ant.contrib.jar, which is added under ./xslt/libs/
+#------------------------------------------------------------------------------
+# build.properties
+#   control file for ant project targets
+#    + specifies areas to be processed
+#    + provides important external information for the various targets.
+#
 # TODO licensing???
-#models=./models/ivoa,./models/source,./models/photdm-alt
-#,./models/source,./models/photdm-alt
+#
+# BE CAREFUL WITH TRAILING SPACES, SHOULD BE TRIMMED HERE!!!
+#------------------------------------------------------------------------------
+#
+# Defines one or more (comma separated) folders containing a vo-dml.properties
+# file.  If multiple models are defined, there must be no trailing or internal
+# whitespaces!  Having multiple models requires existence of ant.contrib.jar,
+# which is added under ./xslt/libs/
+#
+#models=./models/ivoa,./models/source,./models/ds
 models=./models/source
-#models=./models/STC2/2015-05-04
+#
 #--------------------------------------
 # when generating html: run_vo-dml2html
 #--------------------------------------
-# if GraphViz is installed on the system, define the location of the dot.exe file here
-# this allows the HTML generator script to generate a diagram of the model, with links form the boxes to the 
-# description in the HTML documentation
-#graphviz.path = <full-path-to>/dot.exe"
+# If GraphViz is installed on the system, define the location of the 'dot'
+# executable here.  This allows the HTML generator script to generate a
+# diagram of the model, with links from the boxes to the description in
+# the HTML documentation.
+# User MUST provide the full path to the executable
+#graphviz.path = /usr/bin/dot
 graphviz.path = "C:/Program Files (x86)/Graphviz2.38/bin/dot.exe"
 
-
-# when generating schemas ...
+#--------------------------------------
+# when generating schemas: run_vo-dml2xsd
+#--------------------------------------
 schemalocation_root=https://volute.googlecode.com/svn/trunk/projects/dm/vo-dml/models-xsd/
 
-
 #-------------------------------------------------------------
-# when generating java: vo-dml2pojo
-# uncomment the include of build_java.xml at end of build.xml!
+# when generating java: run_vo-dml2pojo
+#   uncomment the include of build_java.xml at end of build.xml!
 #-------------------------------------------------------------
-#file defining which models should be translated to Java, including custom mapping declarations
-###mapping.file=./models/mapping_file.xml
+# File defining which models should be translated to Java, including custom 
+# mapping declarations
 mapping.file=./java/gen/mapping_file.xml
-# root package with vodml base classes, used by run_vodml2pojo
-# should no be changed!
+
+# Defines the root package with vodml base classes
+# SHOULD NOT BE CHANGED!
 vodml.package=org.ivoa.vodml.model
 
-#
-# when generating 
-#
-# location of jaxb .jar files
-# required for xjc generation from XML schemas, and paths generation (needs to parse VO-DML docs using JAXB)
-# need special version for ...
+# Location of jaxb .jar files
+#   required for xjc generation from XML schemas, and paths generation
+#   (needs to parse VO-DML docs using JAXB)
 # see http://jaxb.kava.net
 jaxb.dir=C:/software/java/jaxb-ri-2.2.11/lib
 

Added: trunk/projects/dm/vo-dml/models/templates/vo-dml.properties
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ trunk/projects/dm/vo-dml/models/templates/vo-dml.properties	Mon Sep 12 23:14:46 2016	(r3543)
@@ -0,0 +1,28 @@
+# -----------------------------------------------------------------------------
+# Properties defining the project and configuring the generation pipeline. 
+#
+# Users should copy this file to the appropriate destination directory
+# and replace the existing values with those relevant for that model.
+# -----------------------------------------------------------------------------
+#
+# prefix used in all generated file names
+# - format convention <ModelName>-<Version>  eg: DatasetMetadata-1.0
+# 
+dm.filename.prefix = Sample-1.0
+#
+# data model XMI source file.  used only in xmi2vo-dml 
+xmi.source          = sample_uml2.4.1.xmi
+# 
+# the "profile" according to which the XMI is built. 
+# MUST be one of:
+#xmi.source.profile = Altova_UML2.1.2
+#xmi.source.profile = MD_CE_12.1
+xmi.source.profile = Modelio_UML2.4.1
+# 
+# HTML generation
+# if HTML should be generated with a "preamble", here indicate the source
+# of that preamble.  If empty or does-not-exist, HTML is generated without
+# preamble.  Preamble is expected to have structure like top of typical
+# IVOA documents, ending with abstract.
+# A sample preamble can be found in [TBD]
+html.preamble = 


More information about the Volutecommits mailing list