Difference between revisions of "Org.simantics.document"

From Developer Documents
Jump to navigation Jump to search
(Created page with "'''org.simantics.document''' (SVN) and its associated ontology '''org.simantics.document.ontology''' ([[svn:fou...")
 
Line 1: Line 1:
'''org.simantics.document''' ([[svn:foundation/document/trunk/org.simantics.simantics.document|SVN]]) and its associated ontology '''org.simantics.document.ontology''' ([[svn:foundation/document/trunk/org.simantics.simantics.document.ontology|SVN]]) are used to define documents in the Simantics platform.
 
  
The document data model is a '''scene graph''' which is loaded with the '''scene graph loader'''.
+
The Simantics document subsystem is defined in various plugins including
  
A standard document scene graph implements '''org.simantics.document.WikiDocumentNode''' which supports translation into Wiki text.
+
* Headless documentation model
 +
*# '''org.simantics.document''' ([[svn:foundation/document/trunk/org.simantics.simantics.document|SVN]])
 +
*# '''org.simantics.document.ontology''' ([[svn:foundation/document/trunk/org.simantics.simantics.document.ontology|SVN]])
 +
* Document editor
 +
*# '''org.simantics.document.ui''' ([[svn:foundation/document/trunk/org.simantics.simantics.document.ui|SVN]])
 +
*# '''org.simantics.document.ui.ontology''' ([[svn:foundation/document/trunk/org.simantics.simantics.document.ui.ontology|SVN]])
 +
* Scene graph
 +
*# '''org.simantics.scenegraph''' ([[svn:foundation/2d/trunk/org.simantics.scenegraph|SVN]])
 +
*# '''org.simantics.scenegraph.ontology''' ([[svn:foundation/2d/trunk/org.simantics.scenegraph.ontology|SVN]])
 +
*# '''org.simantics.scenegraph.loader''' ([[svn:foundation/2d/trunk/org.simantics.scenegraph.loader|SVN]])
  
Standard user interface editor is defined in '''org.simantics.document.ui''' ([[svn:foundation/document/trunk/org.simantics.simantics.document.ui|SVN]]) and its associated ontology '''org.simantics.document.ui.ontology'''
+
The document data model is a '''scene graph''' which is loaded with the '''scene graph loader''' [[org.simantics.scenegraph.loader]].
 +
 
 +
Document scene graphs can be loaded into multiple representations. The default implementation (via plain '''org.simantics.scenegraph.loader.ScenegraphLoader''' adaption) can be used to transform the document model into a Wiki document via the interface '''org.simantics.document.WikiDocumentNode'''.
 +
 
 +
<pre>
 +
 
 +
ScenegraphLoaderProcess loader = new ScenegraphLoaderProcess(new Composite());
 +
WikiDocumentNodeImpl node = loader.load(graph, desc, ScenegraphLoaderUtils.getRuntime(graph, context));
 +
 
 +
</pre>
 +
 
 +
 
 +
Standard user interface editor is defined in  and its associated ontology '''org.simantics.document.ui.ontology'''

Revision as of 06:33, 3 November 2011

The Simantics document subsystem is defined in various plugins including

  • Headless documentation model
    1. org.simantics.document (SVN)
    2. org.simantics.document.ontology (SVN)
  • Document editor
    1. org.simantics.document.ui (SVN)
    2. org.simantics.document.ui.ontology (SVN)
  • Scene graph
    1. org.simantics.scenegraph (SVN)
    2. org.simantics.scenegraph.ontology (SVN)
    3. org.simantics.scenegraph.loader (SVN)

The document data model is a scene graph which is loaded with the scene graph loader org.simantics.scenegraph.loader.

Document scene graphs can be loaded into multiple representations. The default implementation (via plain org.simantics.scenegraph.loader.ScenegraphLoader adaption) can be used to transform the document model into a Wiki document via the interface org.simantics.document.WikiDocumentNode.


ScenegraphLoaderProcess loader = new ScenegraphLoaderProcess(new Composite());
WikiDocumentNodeImpl node = loader.load(graph, desc, ScenegraphLoaderUtils.getRuntime(graph, context));


Standard user interface editor is defined in and its associated ontology org.simantics.document.ui.ontology