API Documentation?

The API documentation on the MODx site is pretty poor. Does anyone know of a better resource for learning the API?

Thanks in advance.

Quote from: Linus311 at Jul 28, 2007, 12:04 AM

The API documentation on the MODx site is pretty poor. Does anyone know of a better resource for learning the API?

Thanks in advance.

I can’t speak for the developers but my understanding is that large portions of the API will be changing in 9.7 so I don’t think that there is much incentive for people to flesh it out (I had just started on the 9.6 API when I found out, so I stopped). I intend on contributing to the doc project once 9.7 is out, but until then, I don’t imagine that you will see further activity on the 9.6 docs.

That said, I don’t know of any more complete docs on the API but I found it rather simple to use the API list on the wiki then review the the source code which often is documented or easy to see its function looking at the code.

DocumentParser API Functions

Blue links represent existing pages
Red links have not been documented yet.

As Whitefen stated, version 0.9.7 will contain a new API (with as much legacy support as possible of course), so I’ve withheld from finishing the wiki documentation (I’ve kinda just been documenting as I write add-ons). But if you look at the source code, and name of the function, it’s fairly simple to determine the functions purpose.

Stay tuned for 0.9.7!

Thanks for the replies. This begs the next obvious question: When is 0.9.7 supposed to be released? Weeks? Months?

Quote from: Linus311 at Jul 31, 2007, 11:37 PM

Thanks for the replies. This begs the next obvious question: When is 0.9.7 supposed to be released? Weeks? Months?

From what has been said on other threads, the first beta could be coming any day now but it seems to be held up on something. Basically, it will come when it comes but should be along "soon".

Quote from: Whitefen at Jul 31, 2007, 11:46 PM

From what has been said on other threads, the first beta could be coming any day now but it seems to be held up on something.

This statement was made about two months ago and 0.9.7 is not released yet.
It would be very helpful to get a statement wether the next release comes tomorrow or in the new year because when it comes tomorrow I don’t need to put so much work in modifying 0.9.6.

I do not want an exact release date. But I think it should be possible to say the month, when it’s going to be released.

Quote from: Towa at Oct 06, 2007, 11:13 AM

I do not want an exact release date. But I think it should be possible to say the month, when it’s going to be released.

One would like to think so, wouldn’t one? But I’ve said before that the actual release date is unknown as it represents a complete re-engineering of MODx, and as such, a lot of work is going into upgrade paths, rethinking the manager interfaces, and generally testing mercilessly. I have a project that is overdue and must be deployed on 0.9.7, so I am trying to make it sooner than later, but I also do not want to turn out all these changes before proper regression testing has been completed, and a few more add-ons have been converted.

Is there a particular feature you are waiting on?

If you’re considering hacking 0.9.6 for your purposes, perhaps you should be participating in 0.9.7 development instead? Anyone that wants to participate/collaborate in development can do so; all you have to do is ask to join the MODx team.