Textpattern CMS support forum
You are not logged in. Register | Login | Help
- Topics: Active | Unanswered
[wiki] Proposal: TXP Plugin Developer's Reference
There are a couple sites out there that have collected together some information, but I’m proposing a section in the TextBook that can contain all the TXP specifc functions available to plugin developers (I know there must be tons of them) and a brief description of each one.
Another option is to include phpDoc comments in the source code so that we can create phpDocs (similar to JavaDocs) for the entire project. I wouldn’t ask the core developers to do this, but rather anyone who has some spare time. I’m not even sure how the process works. Can I take a source file add all the proper comments and submit it as a “patch”?
Offline
Re: [wiki] Proposal: TXP Plugin Developer's Reference
That would be a good idea, a central repo of plugin docs.
In the mean time what links are out there?
We Love TXP . TXP Themes . TXP Tags . TXP Planet . TXP Make
Offline
Re: [wiki] Proposal: TXP Plugin Developer's Reference
I have started such a page a while ago and asked on the developer mailing list for support, but got zero responses.
http://textpattern.net/wiki/index.php?title=Plugin_Development_Topics
specifc functions available to plugin developers (I know there must be tons of them) and a brief description of each one.
I think there’s probably between 5 and 10 that are secific to plugin developers. You can find them in the example-plugin (in the plugin template) from zem, and the spam-specific ones in the Combatting Spam article: How to write a spam-plugin. (The idea is to move this stuf to the other page, once there are a couple of plugins available).
There are additionally a lot of function in core (like in lib) that are very handy and recommended, to use, though not specific to plugin developers. Some help on those pages would certainly help.
Offline
Re: [wiki] Proposal: TXP Plugin Developer's Reference
variaas wrote: I’m proposing a section in the TextBook
As Sencer pointed out, this has been acted upon already, and just needs expanded upon by you and anyone else that wants to contribute to it. I trust the Devs to guide the expansion of those wiki pages as best needed.
Offline
Re: [wiki] Proposal: TXP Plugin Developer's Reference
Awesome, so the plugin development topics is great start, and I just asked destry for a login so I can start adding stuff to it. I also discovered a cool page with PHPXRef.
here is a list of ALL the variables, classes, constants, tables, functions defined by Textpattern, where they are declared, and referenced. I’m not sure which ones are available to plugin developers, but it’s a great starting list for writing documentation on them.
I’ll start adding documentation once I have a login.
Last edited by variaas (2006-01-28 20:49:55)
Offline
Re: [wiki] Proposal: TXP Plugin Developer's Reference
variaas,
I started a PHPXref repository of all the major PHP apps.
The variables page is a really cool feature as is the Xref utility.
I’ll be keeping all the apps current as new releases come out.
We Love TXP . TXP Themes . TXP Tags . TXP Planet . TXP Make
Offline