Since it's almost time for a 7.x-1.0 release I think it would make sense to move the documentation out of the module's readme file and into proper drupal.org pages. I just need to find the time to get that effort started.

Comments

athanott’s picture

athanott commented

Is this issue still open? Because I found a link for the documentation ( https://drupal.org/node/2000300 ) on the module's page.

Thank you.

rjacobs’s picture

rjacobs commented

Hi athonott,

Thanks for checking-in on this. You are correct that I did move the docs to a drupal.org page (now all users can edit them!), but this issue is still open due to the fact that I've not yet pushed an update to the module's README file (to have it reference the new docs location). I plan to push that update shortly and will close this.

Cheers!

rjacobs’s picture

rjacobs commented
Title: Move documentation to d.o. pages » Move documentation to d.o. pages and finish API/theme tweaks (7.x-1.0 prep)

I think I'm going to also use this issue as a place to flag a couple pending API/theme tweaks that I've got on my todo list before making a 7.x-1.0 release. This means some small refactoring that would include:

  • Move the XML "rendering" process out of a theme function and into a custom function that uses SimpleXMLElement or DOMDocument. Rendering the XML with a theme function seemed logical at one point, but the more I think about it the more I see that it should not really be "themeable" output.
  • Create a hook that would allow other modules to alter the XML output produced by this module. The module provides a lot of nice configuration options that directly influence the Juicebox XML, but there may be custom things that others would want to add to the XML, and it would be nice to offer a hook for this.
  • Double-check and finalize some of the theme variables used in the embed code.

So anyway, these are just notes for myself. A lot of this is already done in my local copy, but I just need to do some additional tests and then push a commit.

rjacobs’s picture

rjacobs commented
Status: Active » Fixed

Ok, I was finally able to address this and make a commit:

http://drupalcode.org/project/juicebox.git/commit/3f5593a

This includes a whole bunch of refactoring and tweaks to address all the points noted in comment #3 in addition to the documentation updates.

Status: Fixed » Closed (fixed)

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