Active
Project:
Color.module: SoC 2008
Version:
6.x-1.x-dev
Component:
Code
Priority:
Normal
Category:
Task
Assigned:
Reporter:
Created:
23 Oct 2008 at 01:38 UTC
Updated:
12 Mar 2009 at 00:16 UTC
The code looks pretty decent in the module, but your docs and inline comments are pretty bad, dude. I can tell you're not an English major. ;-)
replacement methods like 'shift' can accept different options and behave differently.
Um… yeah. Different things are different. Got it. :-)
Ok, now that I've “trash talked” your docs, let me say kudos for even having docs! Most contrib modules don't even have any docs.
I'm willing to help re-write them. If you agree, I've already got Docs permissions on d.o. and I'll re-work the online ones. And then we can work on improving the inline comments and the docs included with the download. Sound good?
Comments
Comment #1
tonyn commentedIt's a favor to me that you looked because it's important that people understand them.
I'm going to get back into fixing this issues around today! :) I have a pretty big todo list to get to because we want this to work good.
You seem to be getting pretty comfortable with this module and understand where it's going and what needs to be fixed! So by all means, do you need commit access (DO, Github)?
Comment #2
johnalbinCommit access would be awesome, but I think I need to understand your workflow first. How does the code in Github work with the code in CVS? FYI, I would consider myself an expert in SVN and above-average in CVS, but I don’t have any Git experience.
Comment #3
tonyn commentedI can meet you halfway John.
Currently I'm doing mini-commits to Github, and when things look OK, a commit to DO. It's not really a big. However, it'd be nice if you could get me on gtalk and we can work something out. skiquel gmail.
Comment #4
tonyn commentedYou got CVS now. If you don't want to do the GIT (or anything extra) part it's fine, it's just another layer.
Here are some issues that Dmitri reccomended we get done, so I may start working on these (some of these are already on my github) http://drupal.org/node/325487
Comment #5
Flying Drupalist commentedFirst page, quick setup:
Say what? It feels like it both misses a few important words, and what theme? what folder? This is hard to understand. Can someone please clarify?
Comment #6
tonyn commentedSorry for your difficulty Miraploy.
Color.module comes with example themes that demonstrate its functionality. They are stored in the /examples/ directory of this module.
In Drupal,
/themes/enginesstores essential theme data -- it cannot be deleted because it stores phptemplate.Comment #7
Roi Danton commentedFYI: I've made good experiences with the Advanced Help module for that documentation you want to include into the module's archive. E.g. I could copy & paste (almost) all of the html files of my contrib module to the drupal.org documentation and vice versa. It supports multiple language.
Comment #8
Flying Drupalist commentedThank you for your clarification skiquel, now that I did more hands on investigating I feel like I understand this module a bit more now, and I actually think the documentation is quite good.
But: Inside each of these themes is a well-commented color.inc file.
For the life of me I cannot find this file.
Also, I think Splender is using shift, not shift and tag.
Edit: Contrary to documentation there is no theme using only tag.
I just found color.inc insider splender, but not every theme though.
Comment #9
tonyn commentedHi. For the tag-only theme, it's located in
cleanstate/cleanstate_tagWhere did you find the color.inc mentioning? We are using a function called hook_color() in template.php now.
Comment #10
Flying Drupalist commentedHi, they are on the front page of the docs, in this section.
Themers
Inside this module are example themes. Inside each of these themes is a well-commented color.inc file. They are diverse and meant to display the many ways you can use the module to replace colors. For those who learn best by example, these are a great resource to look over.
Comment #11
tonyn commentedfixed
Comment #12
Flying Drupalist commentedCan one tag correspond to multiple selectors?
ie
#top {
border: #000000; /* t:top */
text: #000000; /* t:top */
}
Comment #13
tonyn commentedAbsolutely.
Comment #14
Flying Drupalist commentedHi, along the same lines, color.inc is also mentioned in the module settings.
Comment #15
tonyn commentedFixed
Thank you
Comment #16
Flying Drupalist commentedIs development still ongoing?
Comment #17
tonyn commentedYup. Coding is resuming!
Comment #18
Flying Drupalist commentedThanks, I see that it's undergoing a code merge with style module. Will the created color themes still be operational with the new module?