products forums blog support careers about
  History | Log In     View a printable version of the current page.  
PRO USERS, to ensure 'PRIORITY SUPPORT' make sure that your ASAP account is "tagged" when you file the request. Click here for instructions on how to tag your account.
Issue Details (XML | Word | Printable)

Key: STU-3495
Type: Question Question
Status: Resolved Resolved
Resolution: Answered
Priority: Major Major
Assignee: Lori Hylan-Cho
Reporter: Andre Berg
Votes: 0
Watchers: 2
Operations

If you were logged in you would be able to see more operations.
Aptana Studio

Will Visual jQuery be included in Studio 1.3

Created: 19/Feb/09 07:22 PM   Updated: 01/May/09 05:58 PM
Component/s: Ajax Framework Inclusion
Affects Version/s: Aptana Studio 1.3.0RC1
Fix Version/s: Andretti Alpha #2 (1.4.0.024457)

File Attachments: 1. Zip Archive jquery_cheat_sheet.zip (337 kb)
2. Zip Archive jquery_cheat_sheet_update1.zip (368 kb)
3. Zip Archive visual_jquery_1_3_2.zip (610 kb)
4. Zip Archive visual_jquery_1_3_2_update1.zip (318 kb)


Impact on Workflow: Major
Studio Install Type: Standalone
Operating System: Mac OS X
Participants: Andre Berg and Lori Hylan-Cho
Issue Source: Customer


 Description  « Hide
In Aptana Studio 1.2 we had this very handy view called Visual jQuery with an interactive representation of jQuery 1.2.6. Upon installing 1.3RC2 I was wondering where this went. I understand that this also available on www.visualjquery.com but it was a major workflow boost having it cached locally inside Aptana for ultra fast switching.

I hope you will consider re-adding it to the jQuery plugin. Or if someone can nudge me in the right direction how one could include it DIY style I wouldn't mind a little extra work to get it working again.



 All   Comments   Change History      Sort Order: Ascending order - Click to sort in descending order
Lori Hylan-Cho - 19/Feb/09 09:54 PM
I purposely left it out of the jQuery 1.3.1 plugin because it hadn't been updated from 1.2.6. I can add it back in if you think it'd be useful (and not weird that its version doesn't match that of the library).

FWIW, no Ajax library plugins will ship with Studio 1.3. Instead you'll be able to choose which ones to install on first launch (and whenever after that by choosing Help > Install Aptana Features...


Andre Berg - 19/Feb/09 10:22 PM
In my opinion the Visual jQuery browser is still very useful even when a little behind of the actual jQuery version. There isn't really that much missing - not for your everyday work at least. So it stil lserves a strong purpose.

Yeah, it was hard to miss that the AJAX libraries have been left out... with one being greeted by the Install Feature dialog first. However, I was under the impression that the visual jQuery view came with the jQuery plugin bundle .jar file. so if it's not too much of a hassle maybe you can sneak it back in? It helped me alot when first starting out with jQuery and it really was one of the primary features why I chose Aptana Studio for my learning - because the jQuery support felt quite complete and naturally.

Now with the $/jQuery Code-Assist bug (no Code Assist for '$' but only for 'jQuery') and the visual jQuery browser gone this feels much less naturally. If you prefer you could also just tell me how to infuse the current jQuery plugin bundle in my local Aptana copy with the Visual jQuery view - like where to change some values so that it will appear in Aptana. That would work fine for me too.


Lori Hylan-Cho - 19/Feb/09 10:36 PM
I will add it back in, but in the meantime, you'll need to do a couple things:

1. Change the .jar extension on the jquery 1.2 and 1.3 plugins to .zip and double-click to unzip them.
2. Copy the view folder from the 1.2 plugin folder to the 1.3 plugin folder.
3. Open the plugin.xml file from the 1.3 folder in a text editor.
4. Find the commented-out org.eclipse.ui.views extension point and replace it (and the comment markers) with this:

<extension
         point="org.eclipse.ui.views">
      <view
            category="com.aptana.ide.documentation"
            class="com.aptana.ide.core.ui.views.browser.DefaultBrowserView"
            icon="views/visual_jquery/images/favicon.png"
            id="com.aptana.ide.documentation.jquery.visualjquery"
            name="Visual jQuery">
         <description>bundleresource://com.jquery.1.2/views/visual_jquery/1.2.6.htm</description>
      </view>
   </extension>

5. Save the plugin.xml file.
6. Select all the files in the jquery 1.3 plugin folder (not the folder itself!) and zip them up again.
7. Change the extension from .zip to .jar.
8. Move that .jar to the top level of the plugins folder (if it's currently inside the jquery 1.3 folder).
9. Repeat steps 6-8 if you want to use the 1.2 plugin, too.
10. Delete (or move out of the plugins folder) the jquery 1.2 and 1.3 folders, leaving only the .jars.

Hopefully that'll get you what you want; I'll try to post a new jQuery plugin (it'll be 00002) tomorrow.


Andre Berg - 20/Feb/09 10:33 AM
Hi again,

Had to rest for a moment was a long night. I followed your instructions to the letter and it worked perfectly. The Visual jQuery view is back in.
A tiny problem remains: both Visual views (Visual jQuery and Visual ScriptDoc) show up blank... and now that I remember it I had this problem from the start with Visual ScriptDoc and Aptana Studio 1.3RC2.

I was able to work around this by opening the internal browser and navigating to the 1.2.6.htm manually so it shouldn't be tied to the view itself. Maybe those views are looking at some wrong URLs...


Lori Hylan-Cho - 20/Feb/09 10:36 AM
Oy, OK. I knew about the Visual ScriptDoc bug, but I didn't realize it affected Visual jQuery as well. Let me test and see what's up there.

Andre Berg - 22/Feb/09 06:13 PM
btw, according to the jquery-api-browser AIR desktop application the only things added to the API in terms of new functions etc are:

closest(expr)
context (Core/jQuery Object Accessors)
selector (Core/jQuery Object Accessors)
die(type, fn)
live(type, fn)
toggle(switch)
toggleClass(class, switch)
$.fx.off
$.isArray(obj)
$.support

It doesn't show what was changed however...


Andre Berg - 23/Feb/09 03:11 AM
I updated Visual jQuery to v1.3.1 and v1.3.2. I will try to include a zip archive with the new versions fir the Attach File feature...
I am not quite sure where else to post it.

Lori Hylan-Cho - 23/Feb/09 08:46 AM
I got it already. When I added Visual jQuery back in, I also updated the library to 1.3.2. (This also requires updating the sample.) I'm just waiting to post until we figure out what we're going to do about the Visual jQuery view not showing problem.

For the changes between jQ 1.2.6 and 1.3, I got those from the jQuery API browser as well – I used it as a reference to update the docs.


Andre Berg - 23/Feb/09 11:46 AM
The thing with the API browser is that it doesn't show you what was changed just a little and thus does not have any a 'added 1.3.2' tag associated with it.

I was never sure if I got it all in, thats why I decided to change the api-loader.js and api-docs.js scripts included with Visual jQuery a little so that they would use the XML docs that I generated from jQuery's SVN trunk with the createjQueryXMLDocs.py Python script. That way I was absolutely certain that every bit is in. I also got rid of the older unused jQuery libraries that where still included for no apparent reason. I also changed the exmaple URL to use at least jQuery 1.3.1 instead of 1.2.6 since when viewing the API for 1.3.x it only makes sense that the actual examples use the version one is viewing the docs for. I also slightly changed some CSS code so that the application would behave more nicely on smaller display sizes.

Finally, I also wrote a little readme/how-to about how one can automatically update the XML docs for future versions quite easily. That way other user do not have to wait for us to update to the latest version. I believe it is the superior way to go since the functionality was there already and it doesn't take a whole lot of effort or knowledge to update for future versions.


Andre Berg - 23/Feb/09 11:51 AM
forgot to add:

As a workaround for the Visual jQuery display bug one could use a Monkey script to open the Internal Browser at the URL thats pointing to the Visual jQuery htm file...


Lori Hylan-Cho - 23/Feb/09 11:53 AM
My bad – I misunderstood what you'd said in your previous comment. I thought you were saying that you updated the library from 1.3.1 to 1.3.2, but I now see that you were saying that you updated Visual jQuery to 1.3.2. Thanks for that.

Andre Berg - 25/Feb/09 07:21 PM
I just downloaded the updated 1.3.2.00001 package.

For the visual_jquery view it looks like you added 1.3.2.htm and replaced the api-docs.js with the new version without including the data/jquery-docs.xml file.
Unfortunately, this broke both versions.

Because 1.2.6 relies on the full documentation passed as JSON object in api-docs.js' loadDocs() function and I had to remove the JSON data from loadDocs() so that the ajax request in api-loader.js to the jquery-docs.xml file would instead be triggered.

If you look at api-loader.js on line 22 there is the line
url: xmldoc || 'data/jquery-docs.xml', // generated from jquery source: /tools/wikiapi2xml/createjQueryXMLDocs.py

so for 1.3.2 to work it needs the jquery-docs.xml file in a /data dir.

I am not quite sure why 1.2.6.htm is included for a 1.3.2 release of the jquery support plugin.


Lori Hylan-Cho - 25/Feb/09 07:24 PM
Oy, let me check. I might have messed up my SVN commands.

Lori Hylan-Cho - 25/Feb/09 07:38 PM - edited
Yeah, I did; I missed the data folder when I checked in. (Obviously it worked when I tested locally, because I had a local copy.) The 1.2.6.htm file was scheduled for deletion and should have been removed with the last commit. Checking on that now.

Btw, I hadn't meant for the plugin to be "live" yet; it has to go up for testing, but I didn't intend for it to be downloaded by users. I'd forgotten that technically it would be live because jQuery 1.3 as a feature is live.


Andre Berg - 25/Feb/09 08:04 PM
Ah Ok I understand.

If you want you can also just include the cleaned up folder structure from the zip above but that's up to you of course.

Cheers


Lori Hylan-Cho - 25/Feb/09 08:07 PM
Yes, that's what I did – but it has to get checked into SVN in order to get into the build process.... and that's where things went wrong.

Andre Berg - 28/Feb/09 09:58 PM
here's a small monkey script which open the web view with Visual jQuery:

/*

function main() { webView = views.getView("VisualJQueryView"); webView.showView(true); webView.setTitle("Visual jQuery v1.3.2"); webView.url = "/Users/andre/Documents/Aptana Studio Workspace/Aptana Studio Extensions/views/visual_jquery/1_3_2/1.3.2.htm"; }

of course the webView.url will have to be changed to the URL where the downloaded visual_jquery_1_3_2 and it's 1.3.2.htm file resides.
and you can change the Key comment property to something other than CMD/CTRL+ALT+1.

I also think I know what's wrong with the internal web browser and the Visual... views:

I have the impression that they tend to break when a URLencoded URI is provided.
Note that in the webView.url above I provide the pathname as copied directly from the properties dialog of my visual_jquery project.

However, when I enter this instead it won't work:

"file:///Users/andre/Documents/Aptana%20Studio%20Workspace/Aptana%20Studio%20Extensions/views/visual_jquery/1_3_2/1.3.2.htm"

The same with other URLs that I enter into the internal web browser...


Andre Berg - 28/Feb/09 10:13 PM
very, small update...

changed the googleapis jquery link for the examples iframe to use the 1.3.2 version now that it is updated.
changed the included version of jquery to use the minified 1.3.2 version instead.


Lori Hylan-Cho - 03/Mar/09 09:46 AM
Hi Andre - The script and update will probably need to wait until we rev the library again. Version 1.3.2.00002 of the library will be up shortly.

Andre Berg - 03/Mar/09 10:14 AM
Hi Lori,

Sure. Take whatever you need from it, when you need it


Andre Berg - 12/Mar/09 01:53 PM
I updated the freely available jQuery Cheat Sheet PNG from 1.2 to 1.3 and created a view from it.
I'll attach it as I can imagine it may useful to some, especially new users of jQuery.

As before, if anyone finds uses for it, then by all means, take whatever you need from it...


Lori Hylan-Cho - 12/Mar/09 02:15 PM
Thanks Andre! It's great to have an advocate for the jQuery developers among Aptana Studio users.

Andre Berg - 17/Mar/09 09:10 AM
A small update to the cheat sheet...
I fixed some errors:
  • $.browser et al. and $.support.boxModel are not functions
  • prependTo() and appendTo() now correctly show that they need a selector and not some content as function arguments
  • minor adjustment to the layout
  • included a favicon.png that matches the new jQuery 1.3 logo

Cheers,

André


Lori Hylan-Cho - 13/Apr/09 03:12 PM
Marking Answered because 1.3.2 is out.