PDA

View Full Version : User Documentation



wbabich
6 Jan 2016, 7:38 AM
Is there user documentation somewhere?
I can find installation documentation and documentation on how to create things (projects,etc.) but nothing on what you can do when your editing a file.
I'm seeing autocomplete functionality in some situations, but no syntax checking nor ability to navigate to definitions (like Java F3), nor help (F1) other than navigation to the basic docs.sencha page.
Is there any support in.scss pages?
What does this plugin do?

Chris.OBrien
6 Jan 2016, 8:33 AM
We do have a user guide for our Eclipse Plugin available here (http://docs.sencha.com/ide_plugins/eclipse_ide_plugin.html). You can also access this guide from the Help menu in Eclipse (Sencha Ext JS Plugin Guide).

If you scroll to the Features section (http://docs.sencha.com/ide_plugins/eclipse_ide_plugin.html#Features), it lists the various features you can perform with our plugin, like Open Definition (Shift+F3), Documentation lookup (F1), wizards, Sencha App Watch run configurations, etc.

Opening documentation via F1 is context sensitive, and will return different results depending where your cursor is. For example, when implementing a Ext.form.Panel, you can select the url config and you should be taken to the appropriate Ext JS API docs for that property (http://docs.sencha.com/extjs/6.0/6.0.0-classic/#!/api/Ext.form.Panel-cfg-url) relative to your Ext JS SDK. Are you seeing something different?

We currently don't have scss or sass support. Looking online, you might be able to use the built-in CSS Editor in Eclipse, but I didn't have any success with that.

wbabich
6 Jan 2016, 8:51 AM
Thanks Chris, this is a big help.
I was having trouble with open-definition because I was using F3 (which is the shortcut used in Java files) instead of shift-F3.

F1 seems to be taking me to the home page of http://docs.sencha.com/extjs/6.0/6.0.1-modern/#!/api all the time. I don't know why. (For example, I have a class that extends Ext.form.Panel, and I F1 on the "controller" attribute, or the config/url attribute.)

Also, I was hoping for some JavaScript syntax checking, but that isn't happening. Probably, I've got something wrong in my Eclipse EE JavaScript perspective, unrelated to the Sencha plugin. I'd really like to get some comma-checking.
Thanks for your help.

wbabich
6 Jan 2016, 11:42 AM
I think I figured out why I wasn't getting JavaScript syntax checking.
My Eclipse "problems" error view was filled with hundreds of syntax errors on the non-debug sdk classes in ext/build (ext-modern-all.js, ext-modern-all-sandbox.js, ext-modern.js). I deleted those, leaving only the debug versions, and am no longer getting syntax errors in the console, and I'm now getting basic syntax checking in my JavaScript text editor.I do not know why this solved the problem, but it did.

Chris.OBrien
6 Jan 2016, 12:07 PM
Yes, F3 is the standard open definition lookup, but the Eclipse JSDT already binds to that, so we implemented Shift+F3 to avoid conflicts. We're hoping to fix this in a future release.



F1 seems to be taking me to the home page of http://docs.sencha.com/extjs/6.0/6.0.1-modern/#!/api all the time. I don't know why. (For example, I have a class that extends Ext.form.Panel, and I F1 on the "controller" attribute, or the config/url attribute.)

Was this a new application you generated with the Eclipse Plugin, or an existing Ext JS application you previously had?



I think I figured out why I wasn't getting JavaScript syntax checking.My Eclipse "problems" error view was filled with hundreds of syntax errors on the non-debug sdk classes in ext/build (ext-modern-all.js, ext-modern-all-sandbox.js, ext-modern.js). I deleted those, leaving only the debug versions, and am no longer getting syntax errors in the console, and I'm now getting basic syntax checking in my JavaScript text editor.I do not know why this solved the problem, but it did.


Eclipse's JSDT tooling seems to struggle with the Ext JS SDK files. Deleting the files as you did might work for Eclipse, but I'm not sure if you'll run into problems later when using Sencha Cmd.

An alternative that might work for you is to exclude the the Ext JS SDK from Eclipse's JavaScript parsing - see the Excluding Ext JS SDK from Eclipse’s JavaScript section of the guide (http://docs.sencha.com/ide_plugins/eclipse_ide_plugin.html#Excluding_Ext_JS_SDK_from_Eclipse_s_JavaScript__optional_)). For some reason, some of our files are so large that Eclipse's JavaScript parsing gets hung up and sometimes never completes (or I guess fails in your instance).

Since we do not rely on the JSDT for code-completion or documentation/definition lookup, removing our SDKs from JSDT will not affect your Sencha plugin experience with your own JavaScript code.