| Class | OwlDoc |
| In: |
vocdoc.rb
|
| Parent: | Object |
This is the main class of VocDoc, and will be instantiated once every time the programme is run.
| VERSION | = | '0.0.1' |
| LATEX | = | 'latex' |
| HTML | = | 'html' |
| DOT | = | 'dot' |
| DEPRECATED | = | "deprecated" |
| config | [R] | |
| options | [R] |
Transforms a string into code format. The actual return value of this method depends on which output format was set in the command line arguments (e.g. html or latex).
Generates a hyperlink within the documentation based on the input string. The actual return value of this method depends on which output format was set in the command line arguments (e.g. html or latex).
parses the prefix definitions from the ontology source TODO: currently only works with Turtle syntax, should implement other syntaxes as well (especially rdf/xml).
Generates documentation in LaTeX syntax (only class and property lists, no general documentation), which will be written into the file "classes.tex" and "properties.tex" in the output folder specified in the command line arguments. The LaTeX files cannot be compiled on their own, but need to be included in another LaTeX document.