This is part of the "Help File Fixup" that is for color.module. From original issue: http://drupal.org/node/537828
Here is the rendered text before
The color module allows a site administrator to quickly and easily change the color scheme of certain themes. Although not all themes support color module, both Garland (the default theme) and Minnelli were designed to take advantage of its features. By using color module with a compatible theme, you can easily change the color of links, backgrounds, text, and other theme elements.
It is important to remember that color module saves a modified copy of the theme's specified stylesheets in the files directory. This means that if you make any manual changes to your theme's stylesheet, you must save your color settings again, even if they haven't changed. This causes the color module generated version of the stylesheets in the files directory to be recreated using the new version of the original file.
To change the color settings for a compatible theme, select the "configure" link for the theme on the themes administration page.
For more information, see the online handbook entry for Color module.
Here is the rendered text after:
About
The color module allows a site administrator to quickly and easily change the color scheme of themes that have been built to be compatible with it. Drupal's default theme, Garland, and its subtheme, Minnelli, were designed to take advantage of the color module.
Uses
- Change theme colors
- Using the color module allows you to easily change the color of links, backgrounds, text, and other theme elements.
How to use
- Changing colors in a theme
- To change the color settings for a compatible theme, select the "configure" link for your theme on the themes administration page. If you don't see a color picker on that page, then your theme is not compatible with the color module. If you are sure that the theme does indeed support the color module, but the color picker does not appear, then follow these troubleshooting procedures.
- How it works and how that affects your customizations
- The color module saves a modified copy of the theme's specified stylesheets in the files directory. This means that if you make any manual changes to your theme's stylesheet, you must save your color settings again, even if they haven't changed. This causes the color module generated version of the stylesheets in the files directory to be recreated using the new version of the original file.
- Turn off if not in use
- If you will not be using the color module, it is advisable that you turn it off on the modules administration page.
For more information
For more information, see the online handbook entry for Color module.
Shai
Comment | File | Size | Author |
---|---|---|---|
#23 | help_color9.patch | 3.49 KB | arianek |
#19 | help_color8.patch | 3.49 KB | arianek |
#18 | help_color7.patch | 3.86 KB | arianek |
#14 | after_color_6.png | 63.53 KB | lisarex |
#10 | help_color6.patch | 3.47 KB | arianek |
Comments
Comment #1
arianek CreditAttribution: arianek commentedThis looks like a good start, a few notes:
- The content in the "How to use" and "For more information" section should be moved into the "About" and "Uses" sections, so that it conforms to the standard template (which has only those two sections).
- Try and keep the subheadings short, so maybe "Changing colours", "Color vs. themes", and "Disabling the module", or something like that.
Comment #2
arianek CreditAttribution: arianek commentedComment #3
Shai CreditAttribution: Shai commented@arianek, thanks for the review.
New patch attached. Here is the rendered output of the new patch:
About
The color module allows a site administrator to quickly and easily change the color scheme of themes that have been built to be compatible with it. Drupal's default theme, Garland, and its subtheme, Minnelli, were designed to take advantage of the color module.
Uses
Comment #4
Shai CreditAttribution: Shai commentedOops, I caught some problems in colorhelp-3.patch. Not all the URLs were wrapped in the url function. In addition, the relative urls for admin pages were root-relative instead of relative. I presume we want relative, yes?
I've attached a fixed version.
Shai
Comment #5
lisarex CreditAttribution: lisarex commentedFYI Minnelli may be yanked from D7; see #632030: Merge Garland and Minnelli into one theme, Tried to apply the patch but it failed ... testbot is still thinking about it?
Comment #6
arianek CreditAttribution: arianek commentedit's failing due to "can't find file to patch at input line 8"
i'm going to make some edits and reroll a new version shortly.
Comment #7
arianek CreditAttribution: arianek commentedI tidied up the em tags, and punctuation, and moved/removed some chunks, including removing the references to the D6 themes.
Comment #8
Shai CreditAttribution: Shai commented@arianek,
Thanks for the re-roll and the tidy-up. Looks good.
Shai
Comment #9
lisarex CreditAttribution: lisarex commentedPatch applies great.
Small suggestion to replacing the last sentence with "This step is required because the module stylesheets (in the files directory) need to be recreated from your changes."
but otherwise it's good. :)
Comment #10
arianek CreditAttribution: arianek commentedI made a slight change ('to include' instead of 'from'), is that ok? And added this, updated patch attached. "This step is required because the module stylesheets (in the files directory) need to be recreated to include your changes."
Comment #11
arianek CreditAttribution: arianek commentedoops, bad (old) screenshot on that last one! - sorry, just use the patch for now!
Comment #12
Shai CreditAttribution: Shai commentedLooks great.
Comment #13
arianek CreditAttribution: arianek commentedps. pls don't RTBC until http://drupal.org/node/537828#comment-2281990 is sorted - just give it a thumbs up and i can RTBC it after that has been settled. thanks!
Comment #14
lisarex CreditAttribution: lisarex commentedPatch applied and looks good! Attaching the screenshot from the latest patch.
Comment #15
arianek CreditAttribution: arianek commentedthanks lisa :-)
Comment #16
arianek CreditAttribution: arianek commentedok, that issue has been sorted... dare i rtbc? i think i dare.
Comment #17
jhodgdonThere is no closing DL tag in that patch.
Also, you don't need the url() function on a full URL, just on internal Drupal paths.
Comment #18
arianek CreditAttribution: arianek commentedeeeek! fixed those two issues as well as fixing some of the indenting. (no visual change from last screenshot.)
Comment #19
arianek CreditAttribution: arianek commentedfixed indents
Comment #20
lisarex CreditAttribution: lisarex commentedOK, this is looking good to me. Here's a RTBC :)
Comment #21
jhodgdonUmmm... I don't think it's correct HTML to have multiple DD's for one DT, is it?
Comment #22
Shai CreditAttribution: Shai commentedMultiple dd tags under a dt is fine.
Ref: http://xhtml.com/en/xhtml/reference/dl/
Shai
Comment #23
arianek CreditAttribution: arianek commentedcaps on module name for consistency - RTBC still
Comment #24
jhodgdonShai: Thanks, couldn't find that reference (my Google-fu wasn't turned on this morning apparently).
Comment #25
jhodgdonThe standard for capitalization is not being followed. See http://drupal.org/node/632280 -- should start with "The foo module" not "The Foo module" according to standard.
Comment #26
lisarex CreditAttribution: lisarex commentedThe caps can remain per consensus in #537828: Help text for core modules - update to conform to new standard
Comment #27
arianek CreditAttribution: arianek commentedcaps is a go - RTBC
Comment #28
Dries CreditAttribution: Dries commentedCommitted. Thanks!