The descriptions on the configuration page need to be improved. The text we have has been added to over the years and has evolved into a mess. It also contains contradictory advice. The improvements are as follows:

  1. Give an example of the time now in the current saved date format
  2. List the date and time letters separately
  3. Provide an active link to the php.net date formatting page
  4. Give more relevant details about Date Popup depending on whether that module is enabled or not
  5. Provide an active link to the Date project page on Drupal
  6. Remove the list of popup time formats as this will change, and they are shown during a validation message anyway
  7. Provide an active link to the Date Popup configuration page (if that module is enabled)

Jonathan

CommentFileSizeAuthor
#3 interdiff.txt2.37 KBpfrenssen
#3 2123223_3.improve_config_descriptions.patch2.75 KBpfrenssen
#2 config before.png164.1 KBjonathan1055
#2 config after without date.png141.9 KBjonathan1055
#2 config after with date.png147.55 KBjonathan1055
#1 2123223_1.improve_config_descriptions.patch2.77 KBjonathan1055

Comments

jonathan1055’s picture

jonathan1055 commented
Status: Active » Needs review
StatusFileSize
new 2123223_1.improve_config_descriptions.patch2.77 KB

Here's the patch which does the above, rolled against 1.1+35

Jonathan

jonathan1055’s picture

jonathan1055 commented
StatusFileSize
new config after with date.png147.55 KB
new config after without date.png141.9 KB
new config before.png164.1 KB

Here is the config page currently

New page (when date popup is not available)

New page (with date popup available)

pfrenssen’s picture

pfrenssen
Location Sofia
commented
Issue summary: View changes
StatusFileSize
new 2123223_3.improve_config_descriptions.patch2.75 KB
new interdiff.txt2.37 KB

This is a good improvement. I also noticed that the descriptions needed an overhaul.

I have replaced the hardcoded links in the descriptions with calls to the l() function to generate the links, so that any alterations done to links by modules and themes are respected.

I was wondering if the following sentence might be improved still. If the popups are already working then the site administrator is likely not interested that this particular feature is depending on the Date module. If the site has been built by someone else the administrator might even not understand what it means.

The Date Project Date Popup module is enabled so you may use the popup calendar for your field type. See the Date Popup config page for more details.

jonathan1055’s picture

jonathan1055 commented

Thanks for changing the links. I think there must be some conflicting advice on how to have links within a t() function. I followed the rule that suggested keeping the a tag within the main string so that translators have the context for the text of the link available when making the translation, and can alter the entire string in one go. But I am fine with the way you have changed it.

Yes, that sentence can be reduced. But I think having the link to the date popup config page is helpful. How about

Date Popup is enabled - see the config page for details

pfrenssen’s picture

pfrenssen
Location Sofia
commented
Status: Needs review » Fixed

Sounds good! Committed to 7.x-1.x: a1afb0b. Thanks!

jonathan1055’s picture

jonathan1055 commented

Great. The commit is taking time to appear on the project page. Might be a case of #2125405: Not all commits showing up

jonathan1055’s picture

jonathan1055 commented

The commit and new dev release are still not showing 3 days after you did the work. Also the front project page seems to be cached as the status of this issue is still showing as yellow 'needs review'. I have reported this case on https://drupal.org/node/2125405#comment-8214387

Status: Fixed » Closed (fixed)

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