Difference between revisions of "Tigerstripe Tips-n-Tricks"

From Eclipsepedia

Jump to: navigation, search
m
 
(9 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
{{backlink|Tigerstripe}}
 
{{backlink|Tigerstripe}}
 
__TOC__
 
__TOC__
 +
 +
=Diagramming Features=
 +
==Setting drawing options and preferences==
 +
In Class and instanec diagrams, there are a number of means of controlling how information is displayed. Some of these features are set on a case-by-case basis, but some are also available as a set of preferences. For more details read the[[Tigrestripe Diagram Options]] article.
 +
 +
=Tigerstripe Annotations Framework=
 +
==How-to create and register a new annotation scheme==
 +
The Tigerstripe Annotation Framework is a mechanism to annotate any artifact in a Tigerstripe model to drive code generation. As opposed to typical Stereotypes, Annotations are <strong>not</strong> stored in the model itself. As a result, annotations can be kept, distributed and maintained separately from the model itself, without cluttering it.
 +
 +
To see an example of how you can define your own annotation scheme and use it against Eclipse resource, Java elements or Tigerstripe artifacts, read the [[Define Tigerstripe Annotations]] article.
 +
 +
== Integrate Tigerstripe Annotations ==
 +
The Tigerstripe Annotation Framework is completely generic and has no dependency on Tigerstripe itself. In fact, the Tigerstripe Annotation Feature can be installed without other Tigerstripe components and will allow to annotate Eclipse Workspace resources and Java Elements out of the box (see section above to define an annotation scheme).
 +
 +
Integrating the annotation framework with any other source can be done through a few steps. This article, "[[Integrate Tigerstripe Annotations]]", will highlight the details.
  
 
=Tigerstripe Generation Plugins=
 
=Tigerstripe Generation Plugins=
==Generation Plugin Migration Tips from Commercial to Open-Source version==
+
==Use Objects (not classes) to drive generation==
TBD
+
Since the very early nightly builds of the [[Tigerstripe 0.3 stream|0.3 Stream]], it is possible to create M0-Generation Plugins that allow to generate content based on the instances (M0-Level) of opposed to Classes (M1-Level).
 +
 
 +
For more information about this please visit the [[Tigerstripe M0-Based Generation]] article.
 +
 
 +
==Export XML Generator==
 +
Generates an XML export of a Tigerstripe model. The XML Export Generator iterates over a model (all parts of the meta-model) and generates an XML representation of it. The Generator includes XML Schema for the export XML and simple XSL to transform to HTML.
 +
 
 +
For more information about this please visit the [[Tigerstripe XML Export Generation]] article.
 +
 
 +
==Documentation Generator==
 +
The Tigerstripe Documentation Generator generates HTML documentation of a Tigerstripe Model. The Generator produces an index page from which to navigate to view details of all artifacts of a Tigerstripe model.
 +
 
 +
For more information about this please visit the [[Tigerstripe Documentation Generation]] article.
 +
 
 +
=Tigerstripe in a Headless Build Environment=
 +
Tigerstripe may be used to run automated builds using either command line scripts, or by using the maven-tigerstripe-plugin. Please see [[Tigerstripe Headless Generation Tutorial]] for more information on using Tigerstripe in headless build environments.
  
 +
=Buckminster Integration=
 +
Tigerstripe provides a plug-in that extends the Buckminster component resolution & materialization framework. See the [[Buckminster_Integration_Tutorial|Buckminster Integration Tutorial]] for more information.
 
[[Category:Tigerstripe]]
 
[[Category:Tigerstripe]]

Latest revision as of 04:51, 1 November 2010

This page hosts a set of articles about Tigerstripe Workbench.

< To: Tigerstripe

Contents


[edit] Diagramming Features

[edit] Setting drawing options and preferences

In Class and instanec diagrams, there are a number of means of controlling how information is displayed. Some of these features are set on a case-by-case basis, but some are also available as a set of preferences. For more details read theTigrestripe Diagram Options article.

[edit] Tigerstripe Annotations Framework

[edit] How-to create and register a new annotation scheme

The Tigerstripe Annotation Framework is a mechanism to annotate any artifact in a Tigerstripe model to drive code generation. As opposed to typical Stereotypes, Annotations are not stored in the model itself. As a result, annotations can be kept, distributed and maintained separately from the model itself, without cluttering it.

To see an example of how you can define your own annotation scheme and use it against Eclipse resource, Java elements or Tigerstripe artifacts, read the Define Tigerstripe Annotations article.

[edit] Integrate Tigerstripe Annotations

The Tigerstripe Annotation Framework is completely generic and has no dependency on Tigerstripe itself. In fact, the Tigerstripe Annotation Feature can be installed without other Tigerstripe components and will allow to annotate Eclipse Workspace resources and Java Elements out of the box (see section above to define an annotation scheme).

Integrating the annotation framework with any other source can be done through a few steps. This article, "Integrate Tigerstripe Annotations", will highlight the details.

[edit] Tigerstripe Generation Plugins

[edit] Use Objects (not classes) to drive generation

Since the very early nightly builds of the 0.3 Stream, it is possible to create M0-Generation Plugins that allow to generate content based on the instances (M0-Level) of opposed to Classes (M1-Level).

For more information about this please visit the Tigerstripe M0-Based Generation article.

[edit] Export XML Generator

Generates an XML export of a Tigerstripe model. The XML Export Generator iterates over a model (all parts of the meta-model) and generates an XML representation of it. The Generator includes XML Schema for the export XML and simple XSL to transform to HTML.

For more information about this please visit the Tigerstripe XML Export Generation article.

[edit] Documentation Generator

The Tigerstripe Documentation Generator generates HTML documentation of a Tigerstripe Model. The Generator produces an index page from which to navigate to view details of all artifacts of a Tigerstripe model.

For more information about this please visit the Tigerstripe Documentation Generation article.

[edit] Tigerstripe in a Headless Build Environment

Tigerstripe may be used to run automated builds using either command line scripts, or by using the maven-tigerstripe-plugin. Please see Tigerstripe Headless Generation Tutorial for more information on using Tigerstripe in headless build environments.

[edit] Buckminster Integration

Tigerstripe provides a plug-in that extends the Buckminster component resolution & materialization framework. See the Buckminster Integration Tutorial for more information.