Building a plugin best practices

[donnoman]

• Create a short name for your plugin
• Prepend functions and variables that exist outside of functions with that shortname.
  This prevents name collisions amongst other plugins. ie two plugins naming  functions 'displayimage'; The second function to use the same name will cause an abort as PHP is unable to declare the second 'displayimage' function.
• Keep files lowercase
• Use Coppermine $CONFIG variables where applicable.
  Your plugin might work on YOUR system if you hardcode the fullpath, but it may not work on everybody elses system.

Feel free to add on lessons learned creating plugins to this thread, I'll move the good ones up to the bulleted list.

[Paver]

Has anyone started on official plugin documentation yet?  If not or even if so, I'd like to help out.  How would I go about creating or adding such documentation?  Should I post here?

[Joachim Müller]

yes, please post it - would be very welcome.

[Sami]

waiting for official plugin documentatin 
please paver post it!

[Paver]

waiting for official plugin documentatin 

You and me both.   

A large chunk of it is written.  But it's still not fleshed out (sections here & there are blank).  I have been working fairly non-stop on another Coppermine project, and I do realize this is hanging over my head.  I chip away at it when I can, but I need to find a block of time to hammer out the last sections.

With my previous accuracy in giving an expected date, I must not give another projected date.

I really, really want to get this done, so that's my incentive - to hand it off and let others read & hopefully learn & maybe even contribute with more examples or sample code to add.

All I can say is: soon . . .  :-\

[Sami]

Thank you Pavar, we all see that you work hard on some vulnerability issue and some other CPG project , take your time , as joachim said we are human 

[Dr Preacox]

That would be a very handy doc, as I also am trying with difficulty to create my plugin

[etienne_sf]

Has anyone started on official plugin documentation yet?  If not or even if so, I'd like to help out.  How would I go about creating or adding such documentation?  Should I post here?

Did you had time to work on this one ?

  I'm building a plugin (jupload, an upload mod). Several users had problems using it, because they used functions I didn't know or check.


A idea, to build this doc, is to create a wiki. Every one could give the information he has.

It would be really nice to build a documentation this way! Would it be possible to create one on the coppermine web site ?


Etienne

[Joachim Müller]

Creating a wiki has been discussed many times over, and several efforts have been started (in vain alas) to build one. Should be discussed in another thread imo.

[Hot Rides]

...
A large chunk of it is written. 

...

All I can say is: soon . . .  :-\