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

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

arianek’s picture

This 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.

arianek’s picture

Status: Needs review » Needs work
Shai’s picture

Status: Needs work » Needs review
FileSize
4.01 KB

@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

Changing colors
Using the color module allows you to easily change the color of links, backgrounds, text, and other theme elements. 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.
Color vs. themes
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.
Disable the module
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’s picture

FileSize
4.03 KB

Oops, 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

lisarex’s picture

FYI 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?

arianek’s picture

it'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.

arianek’s picture

FileSize
89.88 KB
3.5 KB

I tidied up the em tags, and punctuation, and moved/removed some chunks, including removing the references to the D6 themes.

Shai’s picture

@arianek,

Thanks for the re-roll and the tidy-up. Looks good.

Shai

lisarex’s picture

Patch applies great.

+++ modules/color/color.module	18 Nov 2009 22:23:20 -0000
@@ -7,11 +7,13 @@
+      $output .= '<dd>' . t("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, <em>you must save your color settings again, even if they haven't changed</em>. 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.") . '</dd>';

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. :)

arianek’s picture

I 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."

arianek’s picture

oops, bad (old) screenshot on that last one! - sorry, just use the patch for now!

Shai’s picture

Looks great.

arianek’s picture

ps. 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!

lisarex’s picture

FileSize
63.53 KB

Patch applied and looks good! Attaching the screenshot from the latest patch.

arianek’s picture

thanks lisa :-)

arianek’s picture

Status: Needs review » Reviewed & tested by the community

ok, that issue has been sorted... dare i rtbc? i think i dare.

jhodgdon’s picture

Status: Reviewed & tested by the community » Needs work

There 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.

arianek’s picture

Status: Needs work » Needs review
FileSize
3.86 KB

eeeek! fixed those two issues as well as fixing some of the indenting. (no visual change from last screenshot.)

arianek’s picture

FileSize
3.49 KB

fixed indents

lisarex’s picture

Status: Needs review » Reviewed & tested by the community

OK, this is looking good to me. Here's a RTBC :)

jhodgdon’s picture

Status: Reviewed & tested by the community » Needs work

Ummm... I don't think it's correct HTML to have multiple DD's for one DT, is it?

Shai’s picture

Status: Needs work » Reviewed & tested by the community

Multiple dd tags under a dt is fine.

Ref: http://xhtml.com/en/xhtml/reference/dl/

Shai

arianek’s picture

FileSize
3.49 KB

caps on module name for consistency - RTBC still

jhodgdon’s picture

Shai: Thanks, couldn't find that reference (my Google-fu wasn't turned on this morning apparently).

jhodgdon’s picture

Status: Reviewed & tested by the community » Needs work

The 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.

lisarex’s picture

Status: Needs work » Reviewed & tested by the community
arianek’s picture

caps is a go - RTBC

Dries’s picture

Status: Reviewed & tested by the community » Fixed

Committed. Thanks!

Status: Fixed » Closed (fixed)
Issue tags: -Documentation, -help system, -d7help

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