[emboss] Checklist for submitting a new 3rd party module?
|
mikemayer67
Joined: 2012-01-10
Posts: 42 |
Posted: Fri, 2012-02-10 15:59
|
|
Not quite satisfied with the inability of the watermark module to mark the full size image, I wrote an alternate watermarking module (named emboss). I have been reading through the forums and gallerymodules.com trying to find some sort of checklist or instructions to follow when submitting a 3rd party module. Does any such thing exist? If so, where? If not, could someone give me the quick/dirty low-down on what steps I should take to submit, what policies I should follow, etc.? Thanks much. p.s. In my real life, I work in software development with a very heavy fisted CM department. I realize that I may be overthinking this, but I've had my hands slapped enough times for not following correct process that I like to know up front what is expected. |
|
Posts: 1642
Hi,
Thanks for the contribution. I assume this is a G2 module and not a G3 module as your post is in the G2 section of the forum.
If so, you can simply provide a link on the G2 codex for people to get at it. I have created a skeleton page for it there. Go in, register and edit as required: http://codex.gallery2.org/Gallery2:Modules:emboss
There is a second more involved process in which the module is added to the G2 servers and would appear on the admin page of individual G2 installations but simply use the codex to put a link for now as only officially added contributors have the access needed for that.
If it is a G3 module, you can similarly add a G3 codex page: http://codex.gallery2.org/Gallery3:Modules:emboss
--
dakanji.com
Posts: 42
Actually, this is for Gallery 3.
There does not appear to be a 3rd party modules forum under Gallery 3 like there is under Gallery 2.
I flipped a mental coin as to if this was the better place to put my post.
Thanks for the direction... I'll try to post it in the next couple days.
Posts: 1642
The forum structure can be a bit confusing but I think this board is in a section clearly marked "G2 Support" which is why I assumed the query was G2 related at first.
Anyway, glad you are sorted and hopefully one of the mods will move this thread over to the G3 section later
--
dakanji.com
Posts: 27300
Thanks for the contribution!
As with most projects docs are lacking, if you can create a codex page http://codex.gallery2.org/Gallery3:Modules:emboss (just use your forums username/password) and you should be able to edit as you see fit.
If you get stuck let us know.
Just attach a zip file of the module to a forum post or on the codex page. If you feel up to it creating a fork of the gallery-contrib repository and adding your module there is a bit more work but the team will update it as needed with API changes or similar coding changes.
We are not very formal here as some formalities hinder contributions.
Dave
_____________________________________________
Blog & G2 || floridave - Gallery Team
Posts: 42
I am attaching a copy with this post.
I will try to get to the Wiki documentation shortly.
I also have attempted to get started with git-hub.
I created an account and forked the gallery-contrib repository and am now "stuck".
What is the difference between the 3.0 and 3.1 directories?
How do I know which to add my module to? Or do I add it to both?
Posts: 27300
You can add it to both 3.0 and 3.1. When the work on 3.1 begins and as API changes are made then the developer can update the 3.1 modules as compatibility changes are made.
Dave
_____________________________________________
Blog & G2 || floridave - Gallery Team
Posts: 42
Thanks... I've added to both.
Sorry for being so needy, but I have yet another question on creating the codex page. I want to add some screenshot images. I went to the upload file link and it gave directions to use irc.freenode.net to find the real URL (send the string "~url codex-upload" in the #gallery channel and wait for the bot to respond with the URL). I connected to the #gallery channel and sent the magic string. No response from a bot....
Any pointers on how to actually upload a screenshot file to the wiki?
mike
Posts: 27300
You are not needy, I'm glad you are helping out and getting the docs done as well. That normally falls by the wayside in most cases.
The gallery bot on IRC must be broken or sleeping.
I sent you a PM of the url to use.
Thanks!
Dave
_____________________________________________
Blog & G2 || floridave - Gallery Team
Posts: 42
Bad, shoddy, or missing documentation has become a growing pet peeve of mine over the 10-15 years.
I have found that even if nobody else ever reads it, good documentation makes life much easier for me when I need to go back and fix things.
I have also found that those who do read my documentation are usually very appreciative as well... and that this has contributed highly to my success at persuading my colleagues (and subsequently my management) that I might just be a valuable go-to person in a pinch. (20% of success is a good product. 80% is good packaging)
Posts: 27300
The community and and my real employer needs more guys like you!
My real job would be much easier if there was some docs.
Dave
_____________________________________________
Blog & G2 || floridave - Gallery Team
Posts: 693
+1!!
+1!!
U-G
Posts: 121
When I used this module everything seemed to work all right. It stalled and I am left with a warning that 59 images require to be re embossed. When I try this I get the following error message @todo EMPTY_INPUT_FILE. I cannot get the module to work since then.
Any help appreciated.
Posts: 42
Do you have any additional information?
Perhaps a stack trace or the corresponding entry(s) in the log file (gallery/var/logs/[date].log.php...
If not, I'll send you a "debug" version of emboss to dump some additional info.
I also found a report of a potentially similar error in another module:
http://gallery.menalto.com/node/99998
Does that stack trace look anything like what you're seeing?
Posts: 42
Attached is my debug version of emboss. If you cannot find additional information in either the logs database (g3_logs) or the logs directory (gallery/var/logs), please install this version, hit the "Dump Delog" button on the Content->Emboss menu, and email me the output dump file (gallery/var/logs/emboss_debug_[timestamp].log)
Posts: 121
It looks similar, however it has messed up my photos. It applied the watermark but no embossing.Left with no alternative but to reinstall Gallery 3
DGF
Posts: 42
It surprises me that you needed to reinstall all of Gallery 3. Worse case scenario should have been reloading the photos... but even that should not have been necessary.
If you did blow away the gallery directory, then you also blew away the folder that backs up your original photos and you will be left with no alternative than to reload your images unless your hosting provider runs routine backups. If you have not yet blown your directory away, then we may be able to save you some time/effort and restore it.
Also, I am confused by your statement:
The watermark overlays ARE the embossing. The power of emboss is that it does (or at least should) NOT destroy your original image. If you don't like how the watermark/emboss looks, you can move it around, change location, change size, change transparency and reapply... or, if you completely change your mind, turn all of the overlays off to restore your original image.
I understand that you may be frustrated right now, but if you want to make this work for you, I'm more than willing to look at your site and any logs you can forward me (especially those created with the attached debug version) to make this work.
Finally, can you let me know what operating system your gallery service is running on?
mike