We closed this forum 18 June 2010. It has served us well since 2005 as the ALPHA forum did before it from 2002 to 2005. New discussions are ongoing at the new URL http://forum.processing.org. You'll need to sign up and get a new user account. We're sorry about that inconvenience, but we think it's better in the long run. The content on this forum will remain online.
Page Index Toggle Pages: 1
Quick Reference tool (Read 2643 times)
Quick Reference tool
Apr 12th, 2010, 2:00pm
 
Quick Reference tool

http://github.com/fjenett/quickreferencetool

An inline reference window for the Processing IDE. It tries to show a reference entry for the code that you select or click.

Installation and usage:
http://wiki.github.com/fjenett/quickreferencetool/getting-started

Comments welcome!
Bugs & issues at github:
http://github.com/fjenett/quickreferencetool/issues

F
Re: Quick Reference tool
Reply #1 - Apr 12th, 2010, 4:31pm
 
The idea is great!
but i would like to add some ideas.
you are loading that information out of the xml file, i guess. and looks like you copied it frmo the reference.

It doesnt happen that often that i need to look in the reference but when i do, i actually does it because i need to know, how something is used and especially the examples are really helpful and i often quickly copy and paste them into my own code then.

so i this is just a thought, but wouldnt it be possible to make the little window a html browser, (http://workshop.evolutionzone.com/2007/08/30/jdic-embedding-a-web-browser-in-jav...)
and just use the reference files that are already stored on your harddrive, or even online. It would probably have a lot of benefits.
you dont need to create the xml file . you dont have to keep your xml file up to date. you could probably use a different css file to remove the header/footer and all the stuff that is not needed, but still use the color and style formating. and people would probably still be able to copy and paste the text, what is really useful in my eyes.

Keep up the good work, i really like your tools !
Re: Quick Reference tool
Reply #2 - Apr 12th, 2010, 10:45pm
 
Hey, thanks for your feedback!

I think fitting a website into the PDE is too much, the window needs to be small and still useful. But i agree it would be nice to be able to see and copy the examples. I was thinking about maybe adding tabs later.

Currently i'm using the original translation XMLs that are used to generate the reference files. They are much easier to parse and hopefully available in many languages at some point. This would allow for the Q\R tool to support other languages.

F
Re: Quick Reference tool
Reply #3 - Apr 12th, 2010, 11:43pm
 
A handy tool, I suppose someone will come along and bundle it up for textmate. I think it complements the standard reference tools quite well (and should make it easier to produce support in other languages).  
Re: Quick Reference tool
Reply #4 - Apr 13th, 2010, 1:29am
 
ok, if it is already available in xml it doesnt add some extra work. Makes sense. Is it still possible to the color and styles and formating of the reference pages, cause reading this bold block of text isnt easy. you have to read it to the end to get all the information you need.
Re: Quick Reference tool
Reply #5 - Apr 13th, 2010, 1:47am
 
yeah i know. formatting already is on the issues list:
http://github.com/fjenett/quickreferencetool/issues

Thanks guys for your feedback!
Re: Quick Reference tool
Reply #6 - Apr 13th, 2010, 1:49am
 
Cedric wrote on Apr 13th, 2010, 1:29am:
ok, if it is already available in xml it doesnt add some extra work.


... i have a ruby script that does all the dirty work for me. Smiley

F
Re: Quick Reference tool
Reply #7 - Apr 13th, 2010, 2:59am
 
sounds good...
looking at your issue list, i dont have anything to add for now Smiley
Re: Quick Reference tool
Reply #8 - Apr 16th, 2010, 2:37pm
 
Florian, FYI. We're planning to move away from the XML reference files shortly (a few months). We're in the process of moving documentation information into the source code. The XML files will remain for the example code, but the parameter information and description will only be in the source.
Re: Quick Reference tool
Reply #9 - Apr 16th, 2010, 10:25pm
 
K. Thanks for letting me know. I can harvest the HTML files as well. Currently using Hpricot which is pretty much okay with any kind of marked up structure.
Page Index Toggle Pages: 1