Forum OpenACS Q&A: ad_proc documentation

Collapse
1: ad_proc documentation
Posted by Brian Fenton on 08/23/02 12:43 PM
Hi all,
I'm starting my first foray into OpenACS 4 development, having
previously programmed with ACS 3. My question is: where can I find
the documentation for ad_proc? I've looked at the source in the api-
doc (minimal description )and I know from looking at other programs
that I can use flags such a required, but I'd love to see a complete
description of its full interface. Can anyone point me to one?

many thanks and best wishes

Collapse
2: Response to ad_proc documentation (response to 1)
Posted by Brian Fenton on 08/27/02 03:55 PM
Nobody knows? Maybe it's so obvious that my question sounds ridiculous. If so, I'd really appreciate it if someone could tell me. If nobody really does know, I'll post what I find back here.
Collapse
3: Response to ad_proc documentation (response to 1)
Posted by Janine Ohmer on 08/27/02 04:05 PM
The only documentation I know of for ad_proc is at http://yoursite/api-doc/proc-view?proc=ad%5fproc

In general, /api-doc is your friend.  Not everything is documented well, but what is documented can usually be found there.

Collapse
4: Response to ad_proc documentation (response to 1)
Posted by Brian Fenton on 08/27/02 04:17 PM
Thanks Janine. I've already looked at that. I was just wondering was there a description anywhere before I dived into the code.
Collapse
5: Response to ad_proc documentation (response to 1)
Posted by Lars Pind on 08/27/02 04:25 PM
I don't think there is one, actually.

The closest thing I know of is this:

https://openacs.org/doc/openacs-4/tcl-doc.html

If somebody would volunteer to write that up ... :)

/Lars

Collapse
6: Response to ad_proc documentation (response to 1)
Posted by Michael A. Cleverly on 09/04/02 06:47 AM
There are hidden secrets within ad_proc that afaik have never been documented anywhere other than the source code (viewable via /api-doc/). Like,
ad_proc foobar {-foo:boolean} { ... }
can be invoked as: foobar -foo=$some_boolean_value

I have custom ACS 4.2 code that's littered in places with: 

    if {$flush_p} {
        some_proc -flush $key
    } else {
        some_proc $key
    }
Much cleaner to know you can say: some_proc -flush=$flush_p $key