[development] Taking a wee bit of the black magic out of Panels

Sam Boyer drupal at samboyer.org
Mon Jun 2 09:37:27 UTC 2008

Hi fellow devs,

	Despite being pedal-to-the-metal trying to get Panels2 to RC, and from
there, ported to D6, I do occasionally find time to at least _think_
about doing other things. Like, say, documentation! Documentation is,
after all, just about the only thing that'll help clear away some of
that aura of mystery shrouding the Panels API.

	So, with that in mind, I've made what I hope will be a useful first
step in that direction. I've written up some pretty thorough
documentation of the Panels 'Content Type' plugin; the documentation
includes pretty detailed discussion and samples for all twenty of the
properties available to content types in the current version of the
Panels API. That includes the handful of new ones we added in Beta4.

	It's a gen-u-ine first draft, but I hope that folks might find it
useful, and maybe even comment! The entire system is doxygen-generated,
so it's got all those standard code documentation-type features you
could hope for, plus a bunch more. The main page of the API docs is at
http://doxy.samboyer.org/panels2/ , and the direct link to the content
types docs is
http://doxy.samboyer.org/panels2/panels_api_plugins_content_types.html .

	Since everything's generated by doxygen from directly from the source
files in the Panels project itself, you can diff/patch and hit the queue
like you would with any other code. The doxyfile is included as well,
for those who are curious. Or at least it will be tomorrow, once I
commit it. Right now, I need sleep.


More information about the development mailing list