Forum OpenACS Q&A: FYI: Making links to api-doc

I'd just finished the package developer's guide to workflow, when I realized that it would be really nice if all mentions of workflow API were made links to the api-documentation.

So Peter helped me write this little Perl script, which does that. It's idempotent, meaning you can run it multiple times, and it won't mess up.

perl -pi -e 's#([^=])(workflow::[a-z_:]+)(?=[^a-z_:])(?!</a>)#\1<a href="/api-doc/proc-view?proc=\2">\2</a>\3#g' developer-guide.html

You'll need to modify it for your own needs. I'm searching for 'workflow::' here, only care about lowercase, and I deliberately only process the developer-guide file, which is in HTML.

It would be good if our docbook XSL contained a tag for API procs, which would do this.

/Lars

I have a procedure that does cross-linking and colorization in api-doc.  I haven't submitted it as a patch because of some known bugs, but I already find it invaluable during development.  See  http://empoweringminds.mle.ie/openacs/openacs_changes.html for the code.

That's right... I remember now. I had forgotten about Jamie's proc. That's exactly what I had in mind!

-Roberto

One other thing that I noticed while testing the proc: In ad_form, there is a call to report -code error; should that be return -code error?