[jboss-user] [JBoss Tools] - Project Examples Sites

[Max Rydahl Andersen]

Max Rydahl Andersen [http://community.jboss.org/people/maxandersen] modified the document:

"Project Examples Sites"

To view the document, visit: http://community.jboss.org/docs/DOC-14955

--------------------------------------------------------------
Project Examples is a JBoss Tools feature that provides creating and importing different Eclipse and Maven projects.
A project example contains one or more Eclipse/Maven projects archived in zip format.
Project examples of the type "mavenArchetype" and "mavenGit" don't require a zip file.  It is enough to declare them in the project examples xml file. 
h4. Project Examples Sites

Project examples are organized in sites. A site is a local or remote xml file that describes one or more project examples. 
 
 The sites can be defined in three ways: 
 
* using an extension point Below, it is shown an example of an extension point for defining the "JBoss Tools Community Examples" site:      



   <extension
        point="org.jboss.tools.project.examples.projectExamplesXml"
        name="JBoss Tools 32 Community_Examples">
        <url> http://download.jboss.org/jbosstools/examples/project-examples-3.2.xml http://download.jboss.org/jbosstools/examples/project-examples-3.2.xml</url>
        <experimental>false</experimental>
   </extension>



The extension point contains the name of the site, the URL on which the xml file is placed and a flag that indicates whether the file is experimental. Experimental sites aren't shown by default. 
 The user imports project examples using the *Help>Project Examples* menu, as shown in the following figure: 


 http://community.jboss.org/servlet/JiveServlet/showImage/102-14955-10-2268/projectExamples1.png  http://community.jboss.org/servlet/JiveServlet/downloadImage/102-14955-10-2268/450-596/projectExamples1.png 

 
* adding a user site within the Project Examples Dialog The user can add his own site using the Project Example Dialog as shown in the following figure: 
 http://community.jboss.org/servlet/JiveServlet/showImage/102-14955-10-2269/projectExamples2.png  http://community.jboss.org/servlet/JiveServlet/downloadImage/102-14955-10-2269/450-461/projectExamples2.png 

* by adding the "org.jboss.tools.project.examples.xml" system property when starting Eclipse For example: 
 -Dorg.jboss.tools.project.examples.xml=file:///E:/temp/MyProjects.xml 

User sites and a site added using the system property are always experimental.

The Project Examples Engine uses ECF to download zip archives which means that the sites (xml files) and project examples (zip archives) can be password protected.

The following sites are defined in the com.jboss.jbds.project.examples plugin:

* JBoss Developer Studio Examples -  http://download.jboss.org/jbosstools/examples/project-examples-3.0.xml http://download.jboss.org/jbosstools/examples/project-examples-3.0.xml
* JBoss Developer Studio 3.0 Examples -  http://download.jboss.org/jbosstools/examples/project-examples-jbds30.xml http://download.jboss.org/jbosstools/examples/project-examples-jbds30.xml

Project examples defined in these sites are shown only in JBDS.

The org.jboss.tools.community.project.examples plugin defines the following sites:

* JBoss Tools 3.1 Community Examples -  http://download.jboss.org/jbosstools/examples/project-examples-community-3.1.xml http://download.jboss.org/jbosstools/examples/project-examples-community-3.1.xml
* JBoss Tools Community BPEL Examples -  http://download.jboss.org/jbosstools/examples/project-examples-bpel-3.1.xml http://download.jboss.org/jbosstools/examples/project-examples-bpel-3.1.xml
* JBoss Tools 3.2 Community Maven Examples -  http://download.jboss.org/jbosstools/examples/project-examples-maven-3.2.xml http://download.jboss.org/jbosstools/examples/project-examples-maven-3.2.xml
* JBoss Tools 3.3 Community Maven Examples -  http://download.jboss.org/jbosstools/examples/project-examples-maven-3.3.xml http://download.jboss.org/jbosstools/examples/project-examples-maven-3.3.xml
The org.jboss.tools.project.examples plugin defines the following sites:

* JBoss Tools 3.2 Community Examples -  http://download.jboss.org/jbosstools/examples/project-examples-3.2.xml http://download.jboss.org/jbosstools/examples/project-examples-3.2.xml

Project examples defined in these sites are shown in both JBoss Tools and JBDS.

h4. Changes in JBDS 4.0.1/JBoss Tools 3.2.1

h5. JBDS 4.0.1

* JBoss Developer Studio 4.0 Examples -  http://download.jboss.org/jbosstools/examples/project-examples-jbds40.xml http://download.jboss.org/jbosstools/examples/project-examples-jbds40.xml

All the examples from JBDS 4.0.0 including the Teiid examples have been moved to the above site.
The site is defined in the com.jboss.jbds.project.examples plugin

h5. JBoss Tools 3.2.1

*  JBoss Tools 3.1 Community Examples -  http://download.jboss.org/jbosstools/examples/project-examples-community-3.1.xml http://download.jboss.org/jbosstools/examples/project-examples-community-3.1.xml
*  JBoss Tools Community BPEL Examples -  http://download.jboss.org/jbosstools/examples/project-examples-bpel-3.1.xml http://download.jboss.org/jbosstools/examples/project-examples-bpel-3.1.xml
*  JBoss Tools 3.2 Community Maven Examples -  http://download.jboss.org/jbosstools/examples/project-examples-maven-3.2.xml http://download.jboss.org/jbosstools/examples/project-examples-maven-3.2.xml
*  JBoss Tools 3.3 Community Maven Examples -  http://download.jboss.org/jbosstools/examples/project-examples-maven-3.3.xml http://download.jboss.org/jbosstools/examples/project-examples-maven-3.3.xml
*  JBoss Tools 3.2 Community Examples -  http://download.jboss.org/jbosstools/examples/project-examples-3.2.xml http://download.jboss.org/jbosstools/examples/project-examples-3.2.xml (the Teiid examples)


 These sites are defined in the org.jboss.tools.community.project.examples plugin.

 There isn't any site defined in the org.jboss.tools.project.examples plugin.

If an example needs to be in both, JBDS 4.0.1 and JBoss Tools 3.2.1, it should be added to :

 JBoss Developer Studio 4.0 Examples -  http://download.jboss.org/jbosstools/examples/project-examples-jbds40.xml http://download.jboss.org/jbosstools/examples/project-examples-jbds40.xml (JBDS)
and some of the JBoss Tools sites.

The Teiid examples, for instance, have been added to :

JBoss Developer Studio 4.0 Examples -  http://download.jboss.org/jbosstools/examples/project-examples-jbds40.xml http://download.jboss.org/jbosstools/examples/project-examples-jbds40.xml
and
JBoss Tools 3.2 Community Examples -  http://download.jboss.org/jbosstools/examples/project-examples-3.2.xml http://download.jboss.org/jbosstools/examples/project-examples-3.2.xml 

See  https://issues.jboss.org/browse/JBDS-1590 JBDS-1590 and  https://issues.jboss.org/browse/JBIDE-8516 JBIDE-8516.
--------------------------------------------------------------

Comment by going to Community
[http://community.jboss.org/docs/DOC-14955]

Create a new document in JBoss Tools at Community
[http://community.jboss.org/choose-container!input.jspa?contentType=102&containerType=14&container=2128]
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/jboss-user/attachments/20111107/f6f2481d/attachment-0001.html