Ext 2 documentation application

[Collin Miller]

I haven't seen anything like this, does it exist?

Is there any chance of releasing the Extjs documentation app, or even turning the app into a community resource so we can easily provide consistent documentation for user extensions?

I've got a handful of extensions I'd love to start sharing.

I ported http://johndyer.name/post/2007/09/PhotoShop-like-JavaScript-Color-Picker.aspx to an Ext Panel.

I've been working on a docking border layout(like IDE/photoshop)

Yet another Ext page builder

Database front-end configurator

and some others

It's a bit overwhelming to get all this into the community : /

[brian.moeskau]

We don't have any plans around this currently, although providing a way to generate API docs for user extensions is probably a good idea. You definitely can't go wrong following the same doc conventions that Ext uses regardless -- even if someone has to read them in the code, it will be consistent. We'll see if we can come up with a strategy for ux docs.

[Collin Miller]

Would following the documentation conventions in the base code be a good step to prepare ux code to get sucked into any ux documentation app?

Are there any internal documentation guidelines we users could have access to to meet halfway?

[brian.moeskau]

Would following the documentation conventions in the base code be a good step to prepare ux code to get sucked into any ux documentation app?

Yep ;)


Are there any internal documentation guidelines we users could have access to to meet halfway?

No, but for the most part, if you follow the existing Ext source it should be pretty self-explanatory. If you're not sure about something, just ask here.

[RWaters]

Just wanted to second this request. ;)

[mxracer]

Collin,

Do you have demos for your extensions that we can view?

Would be very appreciated.

[Collin Miller]

I don't have any publicly hosted demos right now.

:((


This is something I'm working on this next week though.

[CableDawg]

I third this request.

I need to be able to document our internal app so that other developers can interact with it as easily as I am able to.

[browngeek]

Fourth this request. ExtJS docs is jsdocs++.

[steenj]

I've been working on a docking border layout(like IDE/photoshop)


Colin, please, could you tell us more about this? It sounds really exciting :)

[Joe Maisel]

Hey all.

I'm new to ext and am working on a new project. I would like to be able to run something like javadoc which would output xml so that I can generate java enums in my ant build for the various layers of config options related to each Ext control. This feels like a good way to bridge the config options available in ext with java, though perhaps there's a better way. My java api is exposed via DWR. I want to be able to persist a users view state so that when they return the UI has the same appearance they left it with.

I've been reading on JSDoc, etc, and looking through the ext source code, but I can't see an easy way to do this based on the existing docs. If anyone has any suggestions on how this can be accomplished I would be excited to hear them as well as any "best practices" advice on the matter.

[brian.moeskau]

Hi Joe,

For persisting UI state, you will most likely want to look at the StateManager/Provider architecture in Ext. In the 2.0 examples directory there is a "state" folder that includes a sample implementation of a custom Ext.state.SessionProvider for storing state on the server. I would look at that and try to extend that concept to cover what you're trying to do.

I'm not really sure exactly what you're getting at with JSDoc and generating XML/enums from configs though. You should be able to read/write config data directly to the state API provided by Ext, but maybe I don't fully understand what you're after.

[mschering]

I too would like to see a tool to generate documentation. I've written a lot of extensions and would like to document them.

Is there any news on this?

[wm003]

I ported http://johndyer.name/post/2007/09/PhotoShop-like-JavaScript-Color-Picker.aspx to an Ext Panel.


Would you mind to share the ported source? :)



I've been working on a docking border layout(like IDE/photoshop)


Would love to see this also.

[Collin Miller]

Would you mind to share the ported source? :)



Would love to see this also.

Me too! Whats going on with this is I found I didn't know enough about the architecture of ExtJS and worked myself into a corner. Now I'm doing a full read-through of the source to figure out where I went wrong.

And lord is the Ext source awesome. I'd recommend it to all. Makes you smarter just reading it.

Kudos to the Ext team.

As for the color picker: I'm working on getting that available. Time is precious, so this is as far as I am right now:

http://code.google.com/p/extjstoolkit/wiki/Color

Source is available too.