Summary | API calls definitions automatically rendered as wiki pages |
Queue | Wicked |
Type | Enhancement |
State | Accepted |
Priority | 1. Low |
Owners | chuck (at) horde (dot) org, jan (at) horde (dot) org |
Requester | duck (at) obala (dot) net |
Created | 01/21/2008 (6323 days ago) |
Due | |
Updated | 02/22/2009 (5925 days ago) |
Assigned | 02/14/2008 (6299 days ago) |
Resolved | |
Milestone | |
Patch | No |
New Attachment: explain[4].tgz
- Show default values of parameters if available
- Add Test template to tell us if a documentation is missing and if a
function with default values produces warnings - it must not.
New Attachment: params.jpeg
and returning them as an XMLRPC response.
I forgot to mention that now renders even if a parameter is
optional/required or not.
New Attachment: explain[3].tgz
- Moved render subclasses in templates (next step is to move them a
Horde_View)
- Clean up templates and removed CSS, use horde instead
- Added online on the fly documentation documentation renderer
- Allow command line script to render pages in any format
- Added Form renderer (creates a form from method parameters)
- Show example output results from from api calls (results in php,
json, xml format) like on developers corner of facebook (still need to
finish parameter handler)
New Attachment: cli.png
New Attachment: explain[2].tgz
- Added command line script to use CLI implemtation (see
bug #6278)All other attaches can be deleted.
New Attachment: collection.php
documentation even for apis without "provides" configured in registry
and notify that this methods can be called only locally with
callByPackage().
everything in explain.tgz?
more configurable.
State ⇒ Feedback
everything in explain.tgz?
Version ⇒
Queue ⇒ Wicked
State ⇒ Accepted
New Attachment: api.php
the page prefix and to add or not the api version to pagename. Of
course you should change it to swit your wishes.
State ⇒ Feedback
framework, including proper credits to Sergio Carvalho and a few
coding style tweaks. The Wiki driver should still be changed to *not*
mess with the method names. I see why this is necessary for the
(external) API documentation, but it doesn't help if this should
become a general purpose package. Instead, a subclass could hook into
the method name processing.
I changed my mind and would like to see this script added to
wicked/scripts/. By default, it could be run in any Horde installation
to autogenerate API docs of the currently installed Horde apps.
I would like it to generate the following wiki page structure. The
prefix should be editable in the script header, so that we would
create everything below /Doc/Dev/Apis/, a sane default might be
/HordeApis/:
Apis (or HordeApis) - contains the instructions how to call the api
methods. The RPC package has more example that have just been added by
Chuck. Additionally in contains a list to all application sub-pages,
e.g.:
Apis/KronolithApi - contains a list of versions. The idea is to allow
to keep track of different application versions. Thus the script
should not rewrite this page completely, but only add new versions as
it detects them.
Apis/KronolithApi/2.2-cvs - contains the actual API docs. This could
safely be overwritten. If run on a stable version, it won't change
anyway, and if run on a cvs version, it properly updates the docs.
Queue ⇒ Horde.org Servers
State ⇒ Assigned
New Attachment: explain[1].tgz
- Avoid warnings with no documentation.
- Tell if method has missing documentation.
though.
or browse around for docs as they can find it on our partner pages. So
I think it can be done the same here. Add them in the already existing
crontab documentation update to update Horde Wiki pages or/and add
them on the webpages as "External methods" in the documentation
section (something like http://www.horde.org/imp/docs/?f=api.html)
State ⇒ Feedback
though. And you probably need to update it because I changed the API
methods a bit. The CSS links are no longer returned by the display
method.
New Attachment: wiki.jpg
Priority ⇒ 1. Low
State ⇒ New
New Attachment: explain.tgz
Queue ⇒ Wicked
Type ⇒ Enhancement
Summary ⇒ API calls definitions automatically rendered as wiki pages
modules API documentation in HTML or WIKI format. Using together with
#6130patch (also included) you can easy update/create wiki pages withAPI call descriptions.