[jbosstools-issues] [JBoss JIRA] (JBIDE-10658) find place where description for category should live

[Snjezana Peco (JIRA)]

    [ https://issues.jboss.org/browse/JBIDE-10658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12664292#comment-12664292 ] 

Snjezana Peco edited comment on JBIDE-10658 at 2/4/12 7:52 PM:
---------------------------------------------------------------

I have fixed this issue in the following way:

- the Project Examples engine recognizes a new tag - "priority" that enables project examples to be sorted within a category
- there is a new ext. point - org.jboss.tools.project.examples.categories
It enables adding the category.xml file that is searched when creating a tutorials list
There are three such extension points in JBT/JBDS
- the o.j.t.project.examples plugin defines the http://download.jboss.org/jbosstools/examples/project-examples-category-3.3.xml URL that is common for JBT/JBDS
- the o.j.t.comunity.project.examples plugin defines the http://download.jboss.org/jbosstools/examples/project-examples-category-jbosstools-3.3.xml URL used only for JBoss Tools
- the com.jboss.jbds.project.examples plugin defines the http://download.jboss.org/jbosstools/examples/project-examples-category-jbds-3.3.xml URL that is used for JBDS only

Currently, only two categories that are used in both JBT and JBDS, are defined in the http://download.jboss.org/jbosstools/examples/project-examples-category-3.3.xml URL 
The following is an example of the definition:

{code}
<?xml version="1.0" encoding="UTF-8"?>
<categories>

  <category name="JBoss Quickstarts"
  	description="These quickstarts are aimed to get you up to writing applications with minimal fuss. We recommend that you work through the quickstarts in the order they are presented in this guide, however if you have previous experience with Java EE 6, you may wish to skip some or all of the quickstarts."
  	priority="1" />
  	
  <category name="Java EE 6 Quickstarts"
    priority="2" />
    
</categories>
{code}
The name attribute must be the same as the category element in the project example file.
 Description and priority can be defined.
 
 !jbide-10658.png!
                
      was (Author: snjeza):
    I have fixed this issue in the following way:

- the Project Examples engine recognizes a new tag - "priority" that enables project examples to be sorted within a category
- there is a new ext. point - org.jboss.tools.project.examples.categories
It enables adding the category.xml file that is searched when creating a tutorials list
There are three such extension points in JBT/JBDS
- the o.j.t.project.examples plugin defines the http://download.jboss.org/jbosstools/examples/project-examples-category-3.3.xml URL that is common for JBT/JBDS
- the o.j.t.comunity.project.examples plugin defines the http://download.jboss.org/jbosstools/examples/project-examples-category-jbosstools-3.3.xml URL used only for JBoss Tools
- the com.jboss.jbds.project.examples plugin defines the http://download.jboss.org/jbosstools/examples/project-examples-category-jbds-3.3.xml URL that is used for JBDS only

Currently, only two categories that are used in both JBT and JBDS, are defined in the http://download.jboss.org/jbosstools/examples/project-examples-category-3.3.xml URL 
The following is an example of the definition:

{code}
<?xml version="1.0" encoding="UTF-8"?>
<categories>

  <category name="JBoss Quickstarts"
  	description="These quickstarts are aimed to get you up to writing applications with minimal fuss. We recommend that you work through the quickstarts in the order they are presented in this guide, however if you have previous experience with Java EE 6, you may wish to skip some or all of the quickstarts."
  	priority="1" />
  	
  <category name="Java EE 6 Quickstarts"
    priority="2" />
    
</categories>
{code}
The name attribute must be the same as the category element in the project example file.
 Description and priority can be defined.
 
 !jbide10658.png!
                  
> find place where description for category should live
> -----------------------------------------------------
>
>                 Key: JBIDE-10658
>                 URL: https://issues.jboss.org/browse/JBIDE-10658
>             Project: Tools (JBoss Tools)
>          Issue Type: Bug
>          Components: project-examples
>            Reporter: Max Rydahl Andersen
>            Assignee: Snjezana Peco
>             Fix For: 3.3.0.Beta1
>
>         Attachments: jbide-10658.png
>
>
> Suggestion is that we add a category.xml that allows you to define category description to be used.
> category.xm will basically work like a 'forced overwrite' of what is in the project examples.xml
> if a category is found that does not exist in category.xml it still shows up.
> if a category is found that does exist in category.xml it shows up with info from category.xml no matter what project example otherwise state.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira