A better r2rml.properties example/starting-point

Author: nkons

r2rml.properties

@@ -1,33 +1,36 @@
 #---------------------------------------------------------------#
-#-------------------- General configuration --------------------#
+#------------- R2RML Parser General configuration --------------#
 #---------------------------------------------------------------#
 
+# The R2RML mapping file
 mapping.file=dspace/epersons-mapping.rdf
 
-# Valid types are RDF/XML, N-TRIPLE, TURTLE, TTL, N3.
+# The syntax of the mapping file. Valid values are RDF/XML, N-TRIPLE, TURTLE (or TTL), N3.
 mapping.file.type=TURTLE
 
+# The default namespace for the resulting graph
 default.namespace=http://example.com/base#
 
-# Uncomment the following to log inserted triples.
+# Uncomment the following to log inserted triples and debug messages.
 default.verbose=false
 
 # File where last run is logged.
 default.log=status.rdf
 
-#Whether triple generation will be incremental or no.
-#Taken into account only when jena.storeOutputModelInDatabase is false.
-#If this is true, the file status.rdf should not be altered manually.
+#Whether triple generation will be incremental or not.
+#Taken into account only when outputting to the hard disk (i.e. when jena.storeOutputModelUsingTdb is false).
+#If this parameter (default.incremental) is true, the file status.rdf should not be altered manually.
+#Leave this to false unless you have full understanding of what you are doing. See http://dx.doi.org/10.1145/2611040.2611082
 default.incremental=false
 
 #---------------------------------------------------------------#
 #------------------------- Input Model -------------------------#
 #---------------------------------------------------------------#
 
+# R2RML Parser allows merging an RDF file (an input model) to the output of the execution.
 input.model=dspace/dcterms-empty.rdf
 
-# Valid types are RDF/XML, N-TRIPLE, TURTLE, TTL, N3.
-#input.model.type=TURTLE
+# The syntax of the input model. Valid values are RDF/XML, N-TRIPLE, TURTLE (or TTL), N3.
 input.model.type=RDF/XML
 
 #---------------------------------------------------------------#
@@ -56,17 +59,21 @@ db.driver=org.postgresql.Driver
 #---------------------- Jena  TDB Output -----------------------#
 #---------------------------------------------------------------#
 
-# Store the resulting triples using TDB.
+# Store the resulting triples using TDB. Scales way more than storing on the hard disk, but the output is not human-understandable
 jena.storeOutputModelUsingTdb=true
+
 # Clean TDB on startup is taken into account only when jena.storeOutputModelUsingTdb is true.
 jena.cleanTdbOnStartup=true
+
 # The directory containing the dataset
 jena.tdb.directory=tdb
 
 #---------------------------------------------------------------#
 #---------------------- Jena File Output -----------------------#
 #---------------------------------------------------------------#
 
-#in case we will output the resulting triples in a file. This matters if property jena.storeOutputModelUsingTdb is false.
+# Whether we will output the resulting triples in a file. This is taken into account only when property jena.storeOutputModelUsingTdb is false.
 jena.destinationFileName=dump.rdf
+
+# The syntax of the destination file. Valid values are RDF/XML, N-TRIPLE, TURTLE (or TTL), N3.
 jena.destinationFileSyntax=N3