Guide, FAQ or API document?

DarScott · Post by **DarScott** » Fri Jul 28, 2006 5:27 pm

Is there a guide, FAQ or API document for extending the IDE (other than creating plugins)?

malte · Post by **malte** » Fri Jul 28, 2006 6:50 pm

Not that I know of.But it would be helpful.

Maybe we could collect some thoughts here. Would be good if Rev jumped in. though.

All the best,

Malte

DarScott · Post by **DarScott** » Fri Jul 28, 2006 7:56 pm

Maybe we could collect some thoughts here.

Some folks have earned their way into this and have gotten a head start by doing a detailed analysis.

Some thoughts:

1.
Perhaps RunRev can note here at each release whether some key rev properties have changed or whether unsupported features have changed. The changes and whatsnew for recent releases did mention some new unsupported features.

2.
It would be nice to see some supported features and documentation supporting extending the IDE.

3.
Engine documentation:

3.1
Error Syntax
It looks straightforward to figure out, but it would be good to have documented (and supported) the format of what get's thrown in an error. (This is closely related to documenting the IDE error message table and even making an API for getting or even adding error messages in the IDE.) There should be a way to know if this gets changed.

3.2
executionContexts
It would be good to have this documented. Even supported. I'm OK with the caveat that this might change.

4.
Script-related properties
This can be figured out, but it would be good to have these documented.

5.
If there are IDE API commands, that would be good to know about.

6.
It might be that a good source of an API is through extensions. For example, an alternate script editor might have an API to allow filtering at different stages in the process.

7.
We know some from the plug-in examples.

8.
Maybe the guide is simply a couple of sentences: "Abide by your license. You are on your own."

That's way to many thoughts for me at one time.

malte · Post by **malte** » Fri Jul 28, 2006 9:08 pm

Nice thoughts. I think some kind of guide would also be good, like

-How to play nice with frontscripts
(pass messages or not, etc.)
-Naming conventions

Tere is some info about this spread across different resources, however it would be nice to have it in one document.

All the best,

Malte

Mark · Post by **Mark** » Mon Aug 07, 2006 9:03 am

Error Syntax
It looks straightforward to figure out, but it would be good to have documented (and supported) the format of what get's thrown in an error. (This is closely related to documenting the IDE error message table and even making an API for getting or even adding error messages in the IDE.) There should be a way to know if this gets changed.

Economy-x-Talk has a shareware library available which parses and displays execution errors. The library and the documentation should be sufficient for you to even create your own error dialog windows. Download it from the developers page at http://economy-x-talk.com .