[jdf-dev] Need help with cheat sheet issues
Sande Gilda
sgilda at redhat.com
Mon Jul 29 08:19:20 EDT 2013
On 07/27/2013 04:58 PM, Snjezana Peco wrote:
> On 7/26/2013 6:54 PM, Sande Gilda wrote:
>> Snjezana made some comments in the pull, so I investigated further
>> and discovered some interesting behavior.
>>
>> * I checked out Snjezana's pull to my local file system.
>> * I copied his 'quickstarts/kitchensink' quickstart project to my
>> 'workspace/' directory.
>> * I imported the existing Maven 'workspace/kitchensink' project
>> into JDBS
>> o Note that the project name is 'kitchensink'. (see the
>> attached workspace-kitchensink screen shot)
>> o I clicked on the default.xhtml icon in the cheat sheet and an
>> error appeared in the status bar 'Cannot open the
>> /jboss-as-kitchensink/../default.xhtml' file.'
>> o The file failed to open.
>> * I imported the existing Maven 'quickstarts/kitchensink'
>> quickstart project into JDBS
>> o Note that the project name is 'jboss-as-kitchensink'. (see
>> the attached quickstart-kitchensink screen shot)
>> o I clicked on the default.xhtml icon in the cheat sheet and an
>> error still appeared in the status bar 'Cannot open the
>> /jboss-as-kitchensink/../default.xhtml' file.'.
>> o I'm not clear why it's displaying that error because the file
>> opened and the lines of code were selected, which is the
>> expected behavior.
>>
>> So it appears the cheat sheet was created for a quickstart that is a
>> subproject for all quickstarts and will not work when the project is
>> moved to a different location.
>>
>> My questions are:
>>
>> 1. Is this the expected behavior or am I doing something wrong here?
>> As I said, I'm new to cheat sheets. :-)
>>
>
> When you test a cheat sheet that will be defined as a Maven project
> example, you have to import it using New>Import>Maven>Existing Maven
> Projects. The Project Examples plugin will create a project based on
> the project's artifactId in the pom.xml.
> You can also use the project name as a variable which is especially
> important when adding a cheat sheet to an archetype. See
> https://issues.jboss.org/browse/JBIDE-14333 i
> http://docs.jboss.org/tools/whatsnew/examples/examples-news-4.1.0.Beta1.html
> You can create a test project example using a Project Example user
> site and test the cheat sheet with the Project Examples wizard.
>
That is exactly how I import the project. I choose New --> Import -->
Maven --> Existing Maven Projects.
I am working with your cheat sheet in pull
https://github.com/jboss-jdf/jboss-as-quickstart/pull/363.
When I import the 'kitchensink' project from the
'quickstarts/kitchensink' directory where I checked out your pull, the
project name appears as 'jboss-as-kitchensink' and the paths to the
source files work.
If I copy your 'kitchensink' project from my 'quickstarts/kitchensink'
directory to 'workspace/kitchensink' and import it from there, the
project name is 'kitchensink', so the paths to the source files do not
work because they are hard-coded as 'jboss-as-kitchensink'.
I'm sorry if I'm not being clear here, but the files in both
'kitchensink' projects are exactly the same. The location of the folder
appears to affect the project name in JDBS, even though the POM files
are exactly the same. Please view the screen shots I sent previously to
see what I mean. If you give me your IRC nick and a channel, I can try
to explain better. :-)
>> 1.
>>
>>
>>
>>
>> 2. Does JDBS do something differently in the case where there is a
>> parent pom in the higher level directory, in this case, the root
>> quickstart pom file?
>>
>
> No, it doesn't.
>
Can you explain why it displays 'jboss-as-kitchensink' when I import it
from one location and 'kitchensink' when I import it from another
location? Have you tried this?
>>
>> 1. Does this mean cheat sheets will not work if a developer copies a
>> quickstart project to a different location?
>>
>
> The Project Examples plugin imports a maven project using the Maven
> API. Location isn't important.
>
>> 1. In the near future, we plan to let developer download specific
>> quickstarts independently. Will the cheat sheets work in this
>> situation?
>>
>
> That shouldn't be a problem.
>
> Snjeza
>
>> Thanks,
>> Sande
>>
>>
>> On 07/25/2013 12:12 PM, Sande Gilda wrote:
>>> Problem solved. The path in the cheat sheet doesn't match the
>>> quckstart path name. I will make a comment in the pull.
>>>
>>> Thanks!
>>>
>>> On 07/25/2013 10:02 AM, Sande Gilda wrote:
>>>> Hi Nick,
>>>>
>>>> I didn't even notice the error message in the status bar. I was
>>>> looking for errors in the "Problems" window.
>>>>
>>>> I have not renamed anything. I got that link from this open
>>>> quickstart pull request I need to review:
>>>> https://github.com/jboss-jdf/jboss-as-quickstart/pull/363
>>>>
>>>> It sounds like the cheat sheet may be referring to the artifactId
>>>> rather than the folder name. I will investigate.
>>>>
>>>> Thanks for the response.
>>>> Sande
>>>>
>>>> On 07/25/2013 09:01 AM, Nick Boldt wrote:
>>>>> The error message shown, "Cannot open the
>>>>> /jboss-as-kitchensink/..." suggests that either you created the
>>>>> project w/ a non-standard name, renamed it, or the cheatsheet
>>>>> assumes the wrong project name.
>>>>>
>>>>> At any rate, there's a mismatch, but I'm not sure if it's user
>>>>> error (you renamed something) or cheatsheet error (invalid
>>>>> assumption on project path). Perhaps Snjezana can comment as to
>>>>> what happened.
>>>>>
>>>>> Just out of curiosity, where are you finding links to Snjeza's
>>>>> github fork? Surely the *published* content for JBDS doesn't link
>>>>> to these intermediate / developer-owned resources, but to content
>>>>> in https://github.com/jbosstools/ ?
>>>>>
>>>>> N
>>>>>
>>>>> On 07/25/2013 08:22 AM, Sande Gilda wrote:
>>>>>> I downloaded the final JDBS 7.0 GA yesterday and am making more
>>>>>> progress, but it's still not working as I would expect. I am
>>>>>> testing the
>>>>>> kitchensink ".cheatsheet.xml" file located here:
>>>>>> https://github.com/snjeza/quickstart/tree/jbide-12915/kitchensink
>>>>>>
>>>>>> 'Click to perform' now works with no error.
>>>>>> When I first expand a file in the cheatsheet, there are no icons to
>>>>>> indicate you can do anything, only blank spaces (see 'index.xhtml').
>>>>>>
>>>>>> I clicked in another panel and when I clicked back in the
>>>>>> cheatsheet, I
>>>>>> see icons for Click to perform and Click to skip' for the
>>>>>> 'default.xhtml' file. When I 'Click to perform', nothing happens. I
>>>>>> would expect it to open the file and go to the line number. Am I
>>>>>> using
>>>>>> this incorrectly or expecting the wrong results? Screenshot is
>>>>>> below.
>>>>>>
>>>>>> Thanks,
>>>>>> Sande
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>> On 07/22/2013 05:54 PM, Sande Gilda wrote:
>>>>>>> Thanks Snjezana and Nick! I'm relieved to know that a JDBS upgrade
>>>>>>> will help. Now I know who to contact for help. :-)
>>>>>>>
>>>>>>> On 07/22/2013 04:52 PM, Snjezana Peco wrote:
>>>>>>>> The
>>>>>>>> org.jboss.tools.project.examples.cheatsheet.getProjectForCheatsheet
>>>>>>>>
>>>>>>>> command has been introduced in JBT 4.1/JBDS 7.0.
>>>>>>>> This command can't be used in JBDS 6.0.1.GA.
>>>>>>>> See https://issues.jboss.org/browse/JBIDE-14333.
>>>>>>>>
>>>>>>>> Snjeza
>>>>>>>>
>>>>>>>> On 7/22/2013 9:20 PM, Rodney Russ wrote:
>>>>>>>>> [adding jboss tools list - external-exadel]
>>>>>>>>>
>>>>>>>>> ------------------------------------------------------------------------
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> I am new to cheat sheets. I ran into issues testing
>>>>>>>>> quickstart
>>>>>>>>> pull 363, so I decided to take a step back and look at Max's
>>>>>>>>> basic cheatsheet-helloworld example. The source is here:
>>>>>>>>> https://github.com/maxandersen/cheatsheet-helloworld
>>>>>>>>>
>>>>>>>>> I imported his quickstart into JDBS 6.0.1 GA, went to Help
>>>>>>>>> -->
>>>>>>>>> Cheat Sheets. and opened the
>>>>>>>>> cheatsheet-helloworld/cheatsheet.xml file.
>>>>>>>>>
>>>>>>>>> The cheatsheet.xml source file contains this XML:
>>>>>>>>> <item
>>>>>>>>> skip="false"
>>>>>>>>> title="Welcome to this project">
>>>>>>>>> <description>
>>>>>>>>> It is important to force this to be run to make the
>>>>>>>>> variable resolved - a simple way to make that happen is to
>>>>>>>>> add
>>>>>>>>> an required command as seen below.
>>>>>>>>> </description>
>>>>>>>>> <command
>>>>>>>>> required="true"
>>>>>>>>> returns="currentProject"
>>>>>>>>> serialization="org.jboss.tools.project.examples.cheatsheet.getProjectForCheatsheet"/>
>>>>>>>>> </item>
>>>>>>>>>
>>>>>>>>> In the cheat sheet in the right pane, I clicked on the
>>>>>>>>> "Click to
>>>>>>>>> perform" under the description above:
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> I get this error:
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> I also don't see any link under the "Open a file" section
>>>>>>>>> either. I believe there should be one based on this command:
>>>>>>>>>
>>>>>>>>> <command
>>>>>>>>> required="false"
>>>>>>>>> serialization="org.jboss.tools.project.examples.cheatsheet.openFileInEditor(path=/${currentProject}/cheatsheet.xml,fromLine=27,toLine=29)"/>
>>>>>>>>>
>>>>>>>>> Does anyone have any idea what I'm doing wrong?
>>>>>>>>>
>>>>>>>>> Thanks,
>>>>>>>>> Sande
>>>>>>>>>
>>>>>>>>> _______________________________________________
>>>>>>>>> jdf-dev mailing list
>>>>>>>>> jdf-dev at lists.jboss.org
>>>>>>>>> https://lists.jboss.org/mailman/listinfo/jdf-dev
>>>>>>>>>
>>>>>>>>>
>>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> _______________________________________________
>>>>>>> jdf-dev mailing list
>>>>>>> jdf-dev at lists.jboss.org
>>>>>>> https://lists.jboss.org/mailman/listinfo/jdf-dev
>>>>>>
>>>>>
>>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> jdf-dev mailing list
>>> jdf-dev at lists.jboss.org
>>> https://lists.jboss.org/mailman/listinfo/jdf-dev
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/jdf-dev/attachments/20130729/4a41b8a0/attachment-0001.html
More information about the jdf-dev
mailing list