API documentation for Sitellite's core API can be found here:
http://www.sitellite.org/docs/
API documentation for a specific app can be generated and accessed through the AppDoc app under ControlPanel > Tools > AppDoc and then selecting the specific app.
If API documentation has been made for that app, there will be a link called "API Documentation" on the app detail screen. If not, then there will be the text "No API Documentation" and a "Build" link next to it.
To build API documentation click "Build" (or "Rebuild" if the documentation has been generated before and the API has subsequently changed). This will begin the process of generating documentation for the selected app, which can take some time depending on the number of files in the API for that app.
Box/Form Details
You can also view details about each box or form in an app from this screen. Below the app summary you'll see a list of boxes and forms. You can click each one to see its details.
For example, in the News app if I select the "RSS Viewer" box I'm told that this box allows me to view RSS feeds from other websites. I'm given a syntax highlighted usage example as an XT template tag that shows the RSS Viewer requires a "newsfeed" parameter and also has an optional "limit" parameter. Below that I see the access settings and then the details of each parameter expected by this box. Further below that I'm shown the source code of the box with its syntax highlighted to make it easier to read.
In this way, AppDoc can be another helpful place to refer to when you need developer documentation about any specific piece of your Sitellite website.
Revised on December 20, 2005 5:24 AM by anonymous
Back in time (1 more) | Linked from: Apps