svn commit: r1236721 - /incubator/jena/site/trunk/content/jena/documentation/tools/schemagen.mdtext

[ij...@apache.org]

Author: ijd
Date: Fri Jan 27 15:43:15 2012
New Revision: 1236721

URL: http://svn.apache.org/viewvc?rev=1236721&view=rev
Log:
Some formatting fixes

Modified:
    incubator/jena/site/trunk/content/jena/documentation/tools/schemagen.mdtext

Modified: incubator/jena/site/trunk/content/jena/documentation/tools/schemagen.mdtext
URL: http://svn.apache.org/viewvc/incubator/jena/site/trunk/content/jena/documentation/tools/schemagen.mdtext?rev=1236721&r1=1236720&r2=1236721&view=diff
==============================================================================
--- incubator/jena/site/trunk/content/jena/documentation/tools/schemagen.mdtext (original)
+++ incubator/jena/site/trunk/content/jena/documentation/tools/schemagen.mdtext Fri Jan 27 15:43:15 2012
@@ -27,41 +27,41 @@ Table 1: schemagen options
 
 Command line option | RDF config file property | Meaning
 ------------------- | ------------------------ | -------
--a <uri\> | sgen:namespace | The namespace URI for the vocabulary. Names with this URI as prefix are automatically included in the generated vocabulary. If not specified, the base URI of the ontology is used as a default (butnote that some ontology documents don't define a base URI).
--c <filename\><br />-c <url\> | | Specify an alternative config file.
---classdec <string\> | sgen:classdec | Additional decoration for class header (such as `implements`)
---classnamesuffix <string\> | sgen:classnamesuffix | Option for adding a suffix to the generated class name, e.g. "Vocab".
---classSection <string\> |  sgen:classSection | Section declaration comment for class section.
---classTemplate <string\>  | sgen:classTemplate | Template for writing out declarations of class resources.
---daml | sgen:daml | Specify that the language of the source ontology is DAML+OIL.
---declarations <string\> | sgen:declarations | Additional declarations to add at the top of the class.
---dos | sgen:dos | Use MSDOS-style line endings (i.e. \\r\\n). Default is Unix-style line endings.
--e <string\> | sgen:encoding | The surface syntax of the input file (e.g. RDF/XML, N3). Defaults to RDF/XML.
---footer <string\> | sgen:footer | Template for standard text to add to the end of the file.
---header <string\> | sgen:header | Template for the file header, including the class comment.
--i <filename\> <br />-i <url\> | sgen:input | Specify the input document to load
---include <uri\> | sgen:include | Option for including non-local URI's in vocabulary
---individualsSection <string\> | sgen:individualsSection | Section declaration comment for individuals section.
---individualTemplate <string\> | sgen:individualTemplate | Template for writing out declarations of individuals.
---inference | sgen:inference | Causes the model that loads the document prior to being processed to apply inference rules appropriate to the language. E.g. OWL inference rules will be used on a `.owl` file.
---marker <string\> | sgen:marker | Specify the marker string for substitutions, default is '%'
--n <string\> | sgen:classname | The name of the generated class. The default is to synthesise a name based on input document name.
---noclasses | sgen:noclasses Option to suppress classes in the generated vocabulary file
---nocomments | sgen:noComments | Turn off all comment output in the generated vocabulary
---noheader | sgen:noHeader | Prevent the output of a file header, with class comment etc.
---noindividuals | sgen:noindividuals | Option to suppress individuals in the generated vocabulary file.
---noproperties | sgen:noproperties | Option to suppress properties in the generated vocabulary file.
--o <filename\>  <br /> -o <dir\> | sgen:output | Specify the destination for the output. If the given value evaluates to a directory, the generated class will be placed in that directory with a file name formed from the generated (or given) class name with ".java" appended.
---nostrict | sgen:noStrict | Option to turn off strict checking for ontology classes and properties (prevents `ConversionExceptions`).
---ontology | sgen:ontology | The generated vocabulary will use the ontology API terms, inpreference to RDF model API terms.
---owl | sgen:owl | Specify that the language of the source is OWL (the default). Note that RDFS is a subset of OWL, so this setting also suffices for RDFS.
---package <string\> | sgen:package | Specify the Java package name and directory.
---propSection <string\> | sgen:propSection | Section declaration comment for properties section.
---propTemplate <string\> | sgen:propTemplate | Template for writing out declarations of property resources.
--r <uri\> | | Specify the uri of the root node in the RDF configuration model.
---rdfs | sgen:rdfs | Specify that the language of the source ontology is RDFS.
---strictIndividuals | sgen:strictIndividuals | When selecting the individuals to include in the output class, schemagen will normally include those individuals whose `rdf:type` is in the included namespaces for the vocabulary. However, if `strictIndividuals` is turned on, then all individuals in theoutput class must themselves have a URI in the included namespaces.
---uppercase  | sgen:uppercase Option for mapping constant names to uppercase (like Java constants). Default is to leave the case of names unchanged.
+`-a <uri\>` | `sgen:namespace` | The namespace URI for the vocabulary. Names with this URI as prefix are automatically included in the generated vocabulary. If not specified, the base URI of the ontology is used as a default (butnote that some ontology documents don't define a base URI).
+`-c <filename\>`<br />`-c <url\>` | | Specify an alternative config file.
+`--classdec <string\>` | `sgen:classdec` | Additional decoration for class header (such as `implements`)
+`--classnamesuffix <string\>` | `sgen:classnamesuffix` | Option for adding a suffix to the generated class name, e.g. "Vocab".
+`--classSection <string\>` |  `sgen:classSection` | Section declaration comment for class section.
+`--classTemplate <string\>`  | `sgen:classTemplate` | Template for writing out declarations of class resources.
+`--daml` | `sgen:daml` | Specify that the language of the source ontology is DAML+OIL.
+`--declarations <string\>` | `sgen:declarations` | Additional declarations to add at the top of the class.
+`--dos` | `sgen:dos` | Use MSDOS-style line endings (i.e. \\r\\n). Default is Unix-style line endings.
+`-e <string\>` | `sgen:encoding` | The surface syntax of the input file (e.g. RDF/XML, N3). Defaults to RDF/XML.
+`--footer <string\>` | `sgen:footer` | Template for standard text to add to the end of the file.
+`--header <string\>` | `sgen:header` | Template for the file header, including the class comment.
+`-i <filename\>` <br />`-i <url\>` | `sgen:input` | Specify the input document to load
+`--include <uri\>` | `sgen:include` | Option for including non-local URI's in vocabulary
+`--individualsSection <string\>` | `sgen:individualsSection` | Section declaration comment for individuals section.
+`--individualTemplate <string\>` | `sgen:individualTemplate` | Template for writing out declarations of individuals.
+`--inference` | `sgen:inference` | Causes the model that loads the document prior to being processed to apply inference rules appropriate to the language. E.g. OWL inference rules will be used on a `.owl` file.
+`--marker <string\>` | `sgen:marker` | Specify the marker string for substitutions, default is '%'
+`-n <string\>` | `sgen:classname` | The name of the generated class. The default is to synthesise a name based on input document name.
+`--noclasses` | `sgen:noclasses`|  Option to suppress classes in the generated vocabulary file
+`--nocomments` | `sgen:noComments` | Turn off all comment output in the generated vocabulary
+`--noheader` | `sgen:noHeader` | Prevent the output of a file header, with class comment etc.
+`--noindividuals` | `sgen:noindividuals` | Option to suppress individuals in the generated vocabulary file.
+`--noproperties` | `sgen:noproperties` | Option to suppress properties in the generated vocabulary file.
+`-o <filename\>`  <br /> `-o <dir\>` | `sgen:output` | Specify the destination for the output. If the given value evaluates to a directory, the generated class will be placed in that directory with a file name formed from the generated (or given) class name with ".java" appended.
+`--nostrict` | `sgen:noStrict` | Option to turn off strict checking for ontology classes and properties (prevents `ConversionExceptions`).
+`--ontology` | `sgen:ontology` | The generated vocabulary will use the ontology API terms, inpreference to RDF model API terms.
+`--owl` | `sgen:owl` | Specify that the language of the source is OWL (the default). Note that RDFS is a subset of OWL, so this setting also suffices for RDFS.
+`--package <string\>` | `sgen:package` | Specify the Java package name and directory.
+`--propSection <string\>` | `sgen:propSection` | Section declaration comment for properties section.
+`--propTemplate <string\>` | `sgen:propTemplate` | Template for writing out declarations of property resources.
+`-r <uri\>` | | Specify the uri of the root node in the RDF configuration model.
+`--rdfs` | `sgen:rdfs` | Specify that the language of the source ontology is RDFS.
+`--strictIndividuals` | `sgen:strictIndividuals` | When selecting the individuals to include in the output class, schemagen will normally include those individuals whose `rdf:type` is in the included namespaces for the vocabulary. However, if `strictIndividuals` is turned on, then all individuals in theoutput class must themselves have a URI in the included namespaces.
+`--uppercase`  | `sgen:uppercase` | Option for mapping constant names to uppercase (like Java constants). Default is to leave the case of names unchanged.
 `--includeSource` | `sgen:includeSource` | Serializes the source code of the vocabulary, and includes this into the generated class file. At class load time, creates a `Model` containing the definitions from the source
 
 ## What does schemagen do?
@@ -627,7 +627,7 @@ declarations.
  |
 --- | ---
 **Command line** | `--includeSource`
-**Config file** | `\<sgen:includeSource rdf:datatype="&xsd;boolean"\>true\</sgen:includeSource\>
+**Config file** | `\<sgen:includeSource rdf:datatype="&xsd;boolean"\>true\</sgen:includeSource\>`
 
 Schemagen's primary role is to provide Java constants corresponding to the names in
 a vocabulary. Sometimes, however, we may need more information from the vocabulary