Jump to: navigation, search

Difference between revisions of "JET Transforms/Wizards for creating project meta data"

(Documentation)
(Getting the source)
 
(11 intermediate revisions by the same user not shown)
Line 23: Line 23:
  
 
====JET Transforms / Wizards====
 
====JET Transforms / Wizards====
* [[Image:Glass.gif]] .releng project
+
* [[Image:Ok_green.gif]] .releng project
* [[Image:Progress.gif]] .test feature/plugin
+
* [[Image:Ok_green.gif]] .test feature/plugin
 
* [[Image:Ok_green.gif]] .examples feature/plugin
 
* [[Image:Ok_green.gif]] .examples feature/plugin
 
* [[Image:Glass.gif]] .sdk feature
 
* [[Image:Glass.gif]] .sdk feature
Line 41: Line 41:
 
== Documentation ==
 
== Documentation ==
  
Just to quickly outline how this project is used, consider the following screen shots for creating a generic examples project:
+
First of all, the wizards are located in the ''Metadata Generation'' category which can be found by navigating to ''File > New > Project...''.
  
'''1. Start a new project (File > New > Project...) and locate the ''Metadata Generation'' category'''
+
====Metadata Project Wizard====
:[[Image:Metagen_wizardCategory.png]]
+
  
'''2. Launch the New Examples Plugin Wizard'''
+
This wizard allows one to optionally generate up to four projects ("examples" and "tests" plug-ins/features) at once based on a given project name. Default values are provided which allow one to quickly create the projects without needing to flip through and customize each page.
:[[Image:Metagen_examplesWizard.png]]
+
  
:As seems to be the case with many of these skeleton projects, little information is required from the user.
+
The following screens illustrate what one might see when using the wizard.
  
'''3. Enjoy a newly created examples project'''
 
:[[Image:Metagen_examplesWizard_output.png]]
 
  
:You now have a generic examples project skeleton ready to be further customized to your needs.
+
'''1. Select and name the projects to generate.'''
  
This is the general process that one will be able to follow for each of the project types mentioned earlier.
+
[[Image:Meta1.png]]
 +
 
 +
 
 +
'''2. Customize the plug-in fields.'''
 +
 
 +
[[Image:Meta2.png]]
 +
 
 +
 
 +
'''3. Customize the feature fields.'''
 +
 
 +
[[Image:Meta3.png]]
 +
 
 +
 
 +
'''4. The newly generated projects are added to the workspace.'''
 +
 
 +
[[Image:Meta4.png]]
 +
 
 +
====Releng Project Wizard====
 +
 
 +
This wizard allows one to create a [http://wiki.eclipse.org/Modeling_Project_Releng/Releng_Module Releng Module] by filling out a few fields as shown below.
 +
 
 +
 
 +
'''1. Customize the releng project fields.'''
 +
 
 +
[[Image:Releng1.png]]
 +
 
 +
 
 +
'''2. The newly generated releng project is added to the workspace.'''
 +
 
 +
[[Image:Releng2.png]]
  
 
== Getting the source ==
 
== Getting the source ==
Line 65: Line 90:
 
* Repository:  ''':pserver:anonymous@dev.eclipse.org:/cvsroot/technology'''
 
* Repository:  ''':pserver:anonymous@dev.eclipse.org:/cvsroot/technology'''
 
* Module: '''/org.eclipse.soc/athena/'''
 
* Module: '''/org.eclipse.soc/athena/'''
 +
* [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.soc/athena/metagen-misc/projectSet.psf?root=Technology_Project&view=co Team Project Set]
 +
 +
== References ==
 +
 +
* [http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/dialogs.htm Dialogs and wizards]
 +
* [http://help.eclipse.org/ganymede/index.jsp?nav=/27 JET Developer Guide]

Latest revision as of 17:24, 21 August 2008

Abstract

Starting a new project requires a lot of common code & meta data. For example: (1) .doc plug-ins/features, (2) .examples plug-ins/features, (3) .test examples/features, (4) .sdk feature, (5) .releng project.

Being able to generate these things from JET templates via wizards would make it much easier to get a project up and running. Such is the aim of this project.

This project is part of the 2008 Google Summer of Code.

Participants:

  • Student: Michael Robb
  • Mentor: Nick Boldt

Goals

Legend

Glass.gif Needs some investigation/research

Progress.gif Work in progress

Ok green.gif Bug fixed / Feature added

JET Transforms / Wizards

  • Ok green.gif .releng project
  • Ok green.gif .test feature/plugin
  • Ok green.gif .examples feature/plugin
  • Glass.gif .sdk feature
  • Glass.gif .runtime feature
  • Glass.gif .doc feature/plugin (including sources & javadoc)

Generic JET-based wizard framework

As per Philippe's suggestion: Create a general purpose, extensible Sample project wizard, to create new samples for a language and a framework. Think of the new PDE plugin wizard (but general purpose) and based on JET.

The basic just with a few extension markup to be able to:

  • present the title and description for the sample
  • create a new project for the correct natures
  • copy the sample files
  • optionally process them through Jet based on input of extra custom pages

Documentation

First of all, the wizards are located in the Metadata Generation category which can be found by navigating to File > New > Project....

Metadata Project Wizard

This wizard allows one to optionally generate up to four projects ("examples" and "tests" plug-ins/features) at once based on a given project name. Default values are provided which allow one to quickly create the projects without needing to flip through and customize each page.

The following screens illustrate what one might see when using the wizard.


1. Select and name the projects to generate.

Meta1.png


2. Customize the plug-in fields.

Meta2.png


3. Customize the feature fields.

Meta3.png


4. The newly generated projects are added to the workspace.

Meta4.png

Releng Project Wizard

This wizard allows one to create a Releng Module by filling out a few fields as shown below.


1. Customize the releng project fields.

Releng1.png


2. The newly generated releng project is added to the workspace.

Releng2.png

Getting the source

ViewVC: http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.soc/athena/?root=Technology_Project

CVS

  • Repository: :pserver:anonymous@dev.eclipse.org:/cvsroot/technology
  • Module: /org.eclipse.soc/athena/
  • Team Project Set

References