Posted by arianek on November 23, 2009 at 4:03am
7 followers
| Project: | Drupal core |
| Version: | 7.x-dev |
| Component: | documentation |
| Category: | bug report |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | closed (fixed) |
| Issue tags: | d7docs, d7help, documentation, drupal7, Help text |
Issue Summary
Background: http://drupal.org/node/537828
Wow, that one was quite the job. My brains a little mushy, so someone give it a good run!
| Attachment | Size | Status | Test result | Operations |
|---|---|---|---|---|
| help_contact.patch | 6.78 KB | Idle | Passed on all environments. | View details |
| help_contact_before.png | 145.96 KB | Ignored: Check issue status. | None | None |
| help_contact_after.png | 144.97 KB | Ignored: Check issue status. | None | None |
Comments
#1
my remarks:
missing php dot in
$output = '
' . t('The Contact module allows site users to send email via
=>
$output .= '
' . t('The Contact module allows site users to send email via
"The Contact module allows site users to send email via a contact form"
=>
"The Contact module allows visitors to send email via a contact form"
"The Contact tab is only visible when viewing another user's profile (users do not see their own Contact tab)"
feels a bit redundant
"Messages are routed by selecting a category from a list of administrator-defined options; each category has its own set of e-mail recipients."
is a bit technical with "routing" and "adminstrator-defined"
=>
"You define different categories assign them recipients. Based on the category the visitor haas chosen the messages will be sent to the e-mail addresses assigned to the category"
still not very happy with that rephrasing ...
apart from that it is good
#2
+1 on batigolix's suggestions. I don't see any other issues off-hand.
#3
would be rad if someone can post a new patch with these changes - i am totally maxed out on time for this! if you need help, jump on IRC #drupal-contribute or #drupal-docs for help. the drupal thanks you!
#4
#5
Alrighty! Rerolled.
- incorporated comments from #1
- tidied up / rephrased, e.g. rewrote 'Site administrators have access to all personal contact forms (even if they have been disabled)' so hopefully it's clearer!
- Fixed link to contact page from Navigation section (as a rule, how many times do we need to link to the same page within one help file? Four times seems like overkill :))
Still see a few improvements, but will wait to see what other comments come in :)
#6
- removed/rewrote so that there are not a million links to the contact page.
- fixed indents - they should be 2 spaces in per indent (this and the last one i reviewed had 7 where there should be 6)
- added the .= on the line after the
+ $output = '';I think this is ready to go - can I get a review + RTBC lovely doc peeps? ;-)
#7
Capitalization convention (I think) is that the About section starts with the module name uncapitalized. Then in the link to the Handbook, the first word of the Handbook page title is capitalized.
Other than that, RTBC.
And if I'm wrong about the other patches that have been committed, please override me and RTBC.
...
Sigh. It looks like we haven't agreed on a standard for this. The original (node) was uncapitalized, see the style guidelines page.
But a couple of the committed patches had the module name capitalized.
So we need to figure out the standard. If we're changing it, we need to edit http://drupal.org/node/632280 and update a couple of previously-applied patches. If we're not changing it, we need to update this patch and a couple of previously-applied patches.
Any thoughts? The UX folks approved the design on http://drupal.org/node/632280....
#8
can i puts rtbc?
#9
Standard for capitalization was changed, see http://drupal.org/node/537828#comment-2303764 and http://drupal.org/node/632280 -- we are now saying the name of the module should be capitalized. Sorry for the inconvenience but we need a new patch...
Can just go back to the one in #6?
#10
WEBCHICK!!!please use the patch in #6 without the caps change http://drupal.org/files/issues/help_contact3.patch
#11
Darnit, I missed helping review this because it wasn't under contact.module category. :( Need help from the module maintainer? :)
#12
If we're in here changing contact_help() there are quite a few outdated things in the help text itself I'd like to help correct.
#13
Hey Dave - we're working to th Dec 1 deadline, so if you want to work on this yet, go for it! I'll be around for reviews/help (except tonight) ;-)
#14
#12: dave, i just checked the contents of contact_help from patch #6 (http://drupal.org/files/issues/help_contact3.patch) and it all seems quite up to date to. let us know what needs to be updated. if not, i think this can be marked rtbc
#15
This entire section no longer applies because this functionality was moved to a custom block and is not managed by contact module. Plus the maximum number of submissions is a hidden variable now and can be changed using a contrib module (Flood control).
+ $output .= '<dt>' . t('Customizing the contact page') . '</dt>';+ $output .= '<dd>' . t("You can customize contact forms with additional information (like physical location, mailing address, and telephone number) using the <a href='@contact-settings'>Contact form settings page</a>. You can also configure the contact form to enforce the maximum number of contact form submissions a user may send per hour, and the default status of users' personal contact forms.", array('@contact-settings' => url('admin/structure/contact/settings'), '@contact' => url('contact'))) . '</dd>';
We need to mention the 'access user contact forms' for the personal contact forms.
#16
Dave - do you still think you'll have time to roll a patch with your input?
#17
i pinged dave and he's not sure he's going to have time to get back to this, so feel free to try and roll a new version incorporating his comments!
#18
i removed the part Dave (#15) mentions
his other comment ("We need to mention the 'access user contact forms' for the personal contact forms.") was already dealt with in patch #3
#19
Applied patch, looks good, think this is RTBC!
#20
Looks great! Committed to HEAD.
#21
Automatically closed -- issue fixed for 2 weeks with no activity.