PDA

View Full Version : Docs for GotAPI.com



aconran
7 Feb 2007, 7:20 AM
I found a great new site yesterday called gotapi.com. It allows you to add various API's in a tabbed interface and provides you with an easy to search interface. For me I have JS DOM, CSS, ColdFusion and YUI. However there is not a YUI-ext tab yet. Once I have this I will only need one API Reference while at work!

Can we make this happen? I don't know if Jack wants to do with the JSDoc tool so that it stays consistent with the documentation here or maybe I could write a simple parser to keep the xml up to date.

Here are instructions on how the xml should be formed:
http://gotapi.com/contribute/index.html

And here is some example xml for YUI-ext 0.33 (no methods, just classes):


<pages>
<page title="YAHOO" type="package">
<page title="ext" type="package">
<page title="grid" type="package">
<page title="AbstractColumnModel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.AbstractColumnModel.html" type="class" />
<page title="AbstractColumnModel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.AbstractDataModel.html" type="class" />
<page title="CellEditor" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.CellEditor.html" type="class" />
<page title="CheckboxEditor" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.CheckboxEditor.html" type="class" />
<page title="DateEditor" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.DateEditor.html" type="class" />
<page title="DefaultColumnModel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.DefaultColumnModel.html" type="class" />
<page title="DefaultDataModel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.DefaultDataModel.html" type="class" />
<page title="DefaultSelectionModel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.DefaultSelectionModel.html" type="class" />
<page title="EditorAndSelectionModel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.EditorAndSelectionModel.html" type="class" />
<page title="EditorGrid" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.EditorGrid.html" type="class" />
<page title="EditorSelectionModel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.EditorSelectionModel.html" type="class" />
<page title="Grid" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.Grid.html" type="class" />
<page title="GridDD" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.GridDD.html" type="class" />
<page title="GridView" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.GridView.html" type="class" />
<page title="JSONDataModel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.JSONDataModel.html" type="class" />
<page title="LoadableDataModel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.LoadableDataModel.html" type="class" />
<page title="NumberEditor" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.NumberEditor.html" type="class" />
<page title="PagedGridView" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.PagedGridView.html" type="class" />
<page title="SelectEditor" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.SelectEditor.html" type="class" />
<page title="SingleSelectionModel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.SingleSelectionModel.html" type="class" />
<page title="TextEditor" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.TextEditor.html" type="class" />
<page title="XMLDataModel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.grid.XMLDataModel.html" type="class" />
</page>
<page title="state" type="package">
<page title="CookieProvider" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.state.CookieProvider.html" type="class" />
<page title="Manager" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.state.Manager.html" type="class" />
<page title="Provider" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.state.Provider.html" type="class" />
</page>
<page title="util" type="package">
<page title="Browser" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.util.Browser.html" type="class" />
<page title="CSS" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.util.CSS.html" type="class" />
<page title="Config" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.util.Config.html" type="class" />
<page title="DelayedTask" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.util.DelayedTask.html" type="class" />
<page title="JSON" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.util.JSON.html" type="class" />
<page title="MixedCollection" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.util.MixedCollection.html" type="class" />
<page title="Observable" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.util.Observable.html" type="class" />
</page>
<page title="Actor" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.Actor.html" type="class" />
<page title="Animator" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.Animator.html" type="class" />
<page title="AnimatorComposite" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.AnimatorComposite.html" type="class" />
<page title="BasicDialog" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.BasicDialog.html" type="class" />
<page title="BorderLayout" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.BorderLayout.html" type="class" />
<page title="Button" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.Button.html" type="class" />
<page title="CompositeElement" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.CompositeElement.html" type="class" />
<page title="CompositeElementLite" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.CompositeElementLite.html" type="class" />
<page title="ContentPanel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.ContentPanel.html" type="class" />
<page title="DialogManager" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.DialogManager.html" type="class" />
<page title="DomHelper" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.DomHelper.html" type="class" />
<page title="DomHelper.Template" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.DomHelper.Template.html" type="class" />
<page title="Element" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.Element.html" type="class" />
<page title="EventManager" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.EventManager.html" type="class" />
<page title="EventObject" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.EventObject.html" type="class" />
<page title="GridPanel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.GridPanel.html" type="class" />
<page title="JsonView" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.JsonView.html" type="class" />
<page title="KeyMap" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.KeyMap.html" type="class" />
<page title="LayoutDialog" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.LayoutDialog.html" type="class" />
<page title="LayoutManager" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.LayoutManager.html" type="class" />
<page title="LayoutRegion" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.LayoutRegion.html" type="class" />
<page title="NestedLayoutPanel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.NestedLayoutPanel.html" type="class" />
<page title="Resizable" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.Resizable.html" type="class" />
<page title="SplitBar" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.SplitBar.html" type="class" />
<page title="SplitBar.AbsoluteLayoutAdapter" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.SplitBar.AbsoluteLayoutAdapter.html" type="class" />
<page title="SplitBar.BasicLayoutAdapter" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.SplitBar.BasicLayoutAdapter.html" type="class" />
<page title="SplitLayoutRegion" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.SplitLayoutRegion.html" type="class" />
<page title="TabPanel" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.TabPanel.html" type="class" />
<page title="TabPanelItem" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.TabPanelItem.html" type="class" />
<page title="Toolbar" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.Toolbar.html" type="class" />
<page title="ToolbarButton" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.ToolbarButton.html" type="class" />
<page title="UpdateManager" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.UpdateManager.html" type="class" />
<page title="UpdateManager.BasicRenderer" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.UpdateManager.BasicRenderer.html" type="class" />
<page title="View" url="http://yui-ext.com/deploy/yui-ext/docs/output/YAHOO.ext.View.html" type="class" />
</page>
<page title="Function" url="http://yui-ext.com/deploy/yui-ext/docs/output/Function.html" type="class" />
</page>
</pages>

jack.slocum
8 Feb 2007, 12:49 AM
As soon as the new build and docs are out I will take a look at this. Bump this thread if I forget? :)

dfenwick
21 Mar 2007, 12:21 PM
As soon as the new build and docs are out I will take a look at this. Bump this thread if I forget? :)

Bumping this so you don't forget. :)

dfenwick
24 Apr 2007, 10:13 PM
And bumping again so you don't forget!

brian.moeskau
25 Apr 2007, 2:33 AM
That site is pretty cool, but what's up with that split bar? At least on the Mac (FF & Safari) the entire content section turns solid blue and the splitter disappears, and on Safari the tree view disappears after moving the split! They could use a little Ext BorderLayout or something :) Nice idea having all those references in one place though.

aconran
25 Apr 2007, 6:07 PM
Guess someone else there could always use the same data format and create something nicer :-) I agree an Ext front end would be much better!

JeffHowden
26 Apr 2007, 11:21 AM
Not to mention it horks out pretty bad in FF if you're not really nice to it.