ProtegeDocgen - Revision history

Berteh: /* Install */ added link to FAQ

2009-10-14T15:34:43Z

‎Install: added link to FAQ

Berteh: /* Description */

2009-10-14T15:21:18Z

‎Description

Berteh: not for OWL ontologies

2009-10-14T15:19:47Z

not for OWL ontologies

Berteh at 15:15, October 14, 2009

2009-10-14T15:15:35Z

Berteh: created Docgen plugin page

2009-10-14T15:05:43Z

created Docgen plugin page

New page

{{Plugin
|Description=Docgen plugin for Protege provides a quick export of all the content of an ontology (classes, instances and documentation) in various formats (html, pdf, fo...).
|PluginType=Export
|ForApplication1=Protege-Frames
|Screenshot=Screenshot-dhtml.gif
|HomepageURL=http://protege-docgen.sourceforge.net/
|LastUpdated=February 25, 2008
|Topic1=Export
|License=GPL v2 like
}}

== Description ==
Docgen plugin for Protege provides a quick export of all the content of an ontology (classes, instances and documentation) in various formats (html, pdf, fo...).

The Protege Docgen plugin interpretes the design form defined in Protege to determine the content and layout of the sections describing the instances: only visible slots are displayed, in the order they appear in the form (from upper left down to opposite).

This plugin is intended for "frames" ontologies only, it does not given any useful results with OWL ontologies, and probably never will.

This plugin relies on the [http://aurigadoc.sourceforge.net/ AurigaDoc] framework for generating its reports.

== Install ==
* Download and unzip the plugin in protege/plugin directory.
* copy the _xalan.jar library to your java install (typically java_1.X.X/jre/lib/endorsed)

== Generate a sample report ==
# run protege
# open newspaper.pprj (in protege/examples/newspaper)
# click file > export to format > other formats (export wizard)
# select docgen report > next
#* un-select pdf (it doesn't work with multiple heritance)
#* keep dhtml (it looks nice)
#* check output directory >finish

The report is generated by default in directory protege/AurigaDocReportdefault/ so open the file protege/AurigaDocReportdefault/newspaper_dhtml/admain.html in any browser

Many settings can be configured to change layout and content...read included documentation for more.

== Support ==
Questions or contributions can be discussed on the sourceforge forum: https://sourceforge.net/projects/protege-docgen/forums/

@@ Line 19: / Line 19: @@
 This plugin is intended for '''frames ontologies only''', it does not given any useful results with OWL ontologies, and probably never will.
-This plugin relies on the [http://aurigadoc.sourceforge.net/ AurigaDoc] framework for generating its reports, other output formats are therefore available using additional commands (incl. RTF, Java Help and HTML Help(.chm)).
+This plugin relies on the [http://aurigadoc.sourceforge.net/ AurigaDoc] framework for generating its reports, other output formats are therefore available using additional commands (incl. RTF, Java Help and HTML Help(.chm))
 == Install ==

← Older revision		Revision as of 15:15, October 14, 2009
Line 42:		Line 42:

	== Support ==		== Support ==
−	Questions or contributions can be discussed on the sourceforge forum: https://sourceforge.net/projects/protege-docgen/forums/	+	Questions or contributions can be discussed on the sourceforge forum: https://sourceforge.net/projects/protege-docgen/forums/ .

@@ Line 23: / Line 23: @@
 == Install ==
 * Download and unzip the plugin in protege/plugin directory.
-* copy the _xalan.jar library to your java install (typically java_1.X.X/jre/lib/endorsed)
+* copy the _xalan.jar library to your java install (typically java_1.X.X/jre/lib/endorsed) (see FAQ on project homepage: http://protege-docgen.sourceforge.net/ for more details)
 == Generate a sample report ==

@@ Line 1: / Line 1: @@
 {{Plugin
-|Description=Docgen plugin for Protege provides a quick export of all the content of an ontology (classes, instances and documentation) in various formats (html, pdf, fo...).
+|Description=Docgen plugin for (frame-based) Protege provides a quick export of all the content of an ontology (classes, instances and documentation) in various formats (html, pdf, fo...).
 |PluginType=Export
 |ForApplication1=Protege-Frames
@@ Line 13: / Line 13: @@
 == Description ==
-Docgen plugin for Protege provides a quick export of all the content of an ontology (classes, instances and documentation) in various formats (html, pdf, fo...).
+Docgen plugin for Protege provides a quick export of all the content of a frame ontology (classes, instances and documentation) in various formats (html, pdf, fo...).
 The Protege Docgen plugin interpretes the design form defined in Protege to determine the content and layout of the sections describing the instances: only visible slots are displayed, in the order they appear in the form (from upper left down to opposite).
-This plugin is intended for "frames" ontologies only, it does not given any useful results with OWL ontologies, and probably never will.
+This plugin is intended for '''frames ontologies only''', it does not given any useful results with OWL ontologies, and probably never will.
-This plugin relies on the [http://aurigadoc.sourceforge.net/ AurigaDoc] framework for generating its reports.
+This plugin relies on the [http://aurigadoc.sourceforge.net/ AurigaDoc] framework for generating its reports, other output formats are therefore available using additional commands (incl. RTF, Java Help and HTML Help(.chm)).