Programming documentation

[gglynn]

There are obviously some plans to publish some documentation for Cerb4's API/framework, given the skeleton page on the Wiki here (http://wiki.cerberusdemo.com/index.php/API), but what are they (the plans)? Because I think some of us could probably help out more with "community development" of the product via code contributions if we had even some minimal docs to get us pointed in the right direction. Then Jeff could take some time off without assholes like me asking where he's been for all of nine days (gasp!).

How about it, WGM? Help us to help you :D

[dvanwinkle]

I have to agree with this... I am just itching to start building some plugins....

[Hildy]

Oh, we hear ya. Doc just needs to wait til the code is done, cause otherwise we're redoing work. We might be able to get some more specifics to you earlier if you need them. Specifically, are you talking about docs for using the REST api, or related to developing plugins with Devblocks and the core Cerberus framework?

[gglynn]

I was referring to the latter (plugins and core), personally.

[Hildy]

They're not totally up to date, but have you looked through the docs here: http://wiki.cerberusdemo.com/index.php/Development ? The API section is rather sparse at the moment (understatement of the year), but the plugin dev section may have enough to get your feet wet.

I'll try to get some better / more up-to-date stuff out there for you guys, too.

[gglynn]

Yeah, there's really not enough there at the moment to get us started.

[jstanden]

I will brave my allergy to documentation and help Dan flesh things out for you guys. ;)

[gglynn]

Any progress on that documentation?

[joeberg]

Any progress on that documentation?

What he said... :-)

[chewtoy]

Ditto... :-)

[ChrisF]

What I'd really like to see is some hints to:
- Authenticate to an external database or session variable when using the Support Center/contact form

- howto create a plugin for the Forum Explorer to use it with another forum software

EDIT:

I found the Forum Explorer documentation at:
http://wiki.cerberusdemo.com/index.php/Forum_Explorer_(Plugin)

I created a version for ubb.threads 6.5.x. Let me know if you want to put that on the wiki.

[dsugita]

What I'd really like to see is some hints to:
- Authenticate to an external database or session variable when using the Support Center/contact form


I don't believe Dan has any updated info on doing something like that yet, but the wiki will get updated as it progresses: http://wiki.cerberusdemo.com/index.php/Web-API



- howto create a plugin for the Forum Explorer to use it with another forum software

EDIT:

I found the Forum Explorer documentation at:
http://wiki.cerberusdemo.com/index.php/Forum_Explorer_(Plugin)

I created a version for ubb.threads 6.5.x. Let me know if you want to put that on the wiki.



That'd be great to share :)

[ChrisF]

Just tell me where I should send that file or should I just upload it there?

Regarding the authentciation: I was looking for an howto for "authenticaters" as Jeff calls them here: http://www.cerb4.com/forums/showthread.php?t=43

I don't want to write an entirely new Support Center using the Web-API. So basically disable the registration in the Support-Center and doing some kind of auto-registering if a user is already logged in to our application. We know his email, so we simply can pass it to Cerberus.

[Hildy]

Chris, uploading the file to the wiki should be fine. (If you can't, send it to hildy at webgroupmedia donttypethis dot com.)

As far as the SC goes, I recently finished a Proof of Concept SC that was totally done through the Web-API and should be easily customizeable, if you want to build off of that (instead of rolling your own from the start). It's linked from the WEB-API wiki page now: http://wiki.cerberusdemo.com/index.php/Web-API

[ChrisF]

I send you an email with the plugin. The PoC looks promising! I just browsed through the code, but it looks like a great start. Are there any plans to enhance this?
I haven't started with a own implementation, last time I checked, there still have been problem with umlaut characters and encoding. I don't plan to use Cerb4 until this is fixed

[Hildy]

Thanks, Chris! I got your email, and I've got an item on my todo list to post the file up, too.

There aren't specific plans to enhance that SC, though we're not saying we won't, either. ;-) What did you want to see in it?