Download & Extend
Chaos tool suite (ctools) » Issues

CTools Plugin Example module provided for inclusion with CTools

Posted by rfay on August 2, 2009 at 2:53am
Project:Chaos tool suite (ctools)
Version:6.x-1.0-rc1
Component:Documentation
Category:task
Priority:normal
Assigned:Unassigned
Status:closed (fixed)

Issue Summary

The attached (as both patch and tgz) is a coder's example module for Ctools. It provides example argument, context, content type, access, and relationship plugins, along with a demo panel and advanced help. It also shows how a module can provide a default panel. I hope it can be useful.

AttachmentSize
ctools_plugin_example_module.patch68.07 KB
ctools_plugin_example_module.tgz14.01 KB
Login or register to post comments

Comments

#1

Posted by merlinofchaos on August 11, 2009 at 10:43pm

I've attached the .module file, which I've cleaned up for several style issues. You can use it as a guide for some things that need to be looked at.

  • It should always be ctools or CTools, never Ctools.
  • Avoid heredoc for text since that can't be properly run through t().
  • Titles should only be capitalized on the first word. i.e, "This is a title" not "This is a Title" or "This Is A Title".
  • Mostly avoid two blank lines.
  • Try not to have the @file section accidentlly be the doxy block for a function. A couple of the .inc files have this.
  • This is an artifact of the growth of the plugin system, but the main function of the .inc file should not define an array with a key. Instead it should just return the single array. There are a few in CTools that still do this the old way; I change them as I see them. (patches to fix that would be accepted!).
  • The content types are using an older format. Content types can do a lot more to infer names, particularly on render and settings. Compare to the current content types.
  • Use this format:
    * @param $variable
    *   definition
AttachmentSize
ctools_plugin_example.module.txt 3.43 KB

#2

Posted by Nick Lewis on August 11, 2009 at 11:37pm

This is very useful, thx!

#3

Posted by izmeez on August 16, 2009 at 7:29am

Yes this is useful, and the explanation includes useful tips in general

#4

Posted by rfay on August 17, 2009 at 9:17pm
Title:Ctools Plugin Example module provided for inclusion with Ctools» CTools Plugin Example module provided for inclusion with CTools
Status:active» needs review

Here is another rev of the module that (I hope) addresses the issues in #1. Thanks.

AttachmentSize
ctools_plugin_example.20090817.tgz 12.01 KB

#5

Posted by merlinofchaos on August 17, 2009 at 10:03pm
Status:needs review» fixed

Ok, committed. Let's run with this and we can patch to refine it as we go.

#6

Posted by rfay on August 17, 2009 at 10:07pm

#7

Posted by adamo on August 21, 2009 at 9:00pm

Thank you so much!!!

#8

Posted by System Message on September 4, 2009 at 9:10pm
Status:fixed» closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.

nobody click here