Support from Acquia helps fund testing for Drupal Acquia logo

Comments

dbt102 created an issue. See original summary.

dbt102’s picture

Assigned: dbt102 » Unassigned
Status: Active » Needs review
hass’s picture

Title: Add_Google_Analytics_HELP » Add Google Analytics HELP
Status: Needs review » Needs work

I do not think there is a rule that help pages are required. The module is such simple...

Whatever I'm fine with adding your help, but please keep the lines you are removing here for google_analytics.admin_settings_form.

  1. +++ b/google_analytics.module
    @@ -40,8 +40,16 @@ function google_analytics_api() {
    +      $output = '';
    +      $output .= '<h3>' . t('About') . '</h3>';
    

    Can be a one-liner

  2. +++ b/google_analytics.module
    @@ -40,8 +40,16 @@ function google_analytics_api() {
    +      $output .= '<p>' . t('Google Analytics adds a web statistics tracking system to your website. This system incorporates numerous statistical features.  For an extensive listing of these features see the  <a href=":project">Google Analytics</a> project site.  Beyond that, additional information can be found at the <a href=":doco">online documentation</a>.', [':doco' => 'https://www.drupal.org/node/37694', ':project' => 'https://www.drupal.org/project/google_analytics']) . '</p>';
    

    double spaces need to be removed

  3. +++ b/google_analytics.module
    @@ -40,8 +40,16 @@ function google_analytics_api() {
    +      $output .= '<dt>' . t('Additional Features') . '</dt>';
    

    ucfirst than lowercase is the drupal rule. Exceptions are only on product names.

  4. +++ b/google_analytics.module
    @@ -40,8 +40,16 @@ function google_analytics_api() {
    +      $output .= '<dd>' . t('The Google Analytics module offers a bit more than basic tracking.  <em>Page Tracking</em> for instance allows you to provide a list of pages to track, or a list of pages not to track. Role and Link tracking features are also available.  For a comprehensive discussion on the setup and use of its many feature see the <a href=":doco">online documentation</a>.', [':doco' => 'https://www.drupal.org/node/37694']) . '</dd>';
    

    What should the abrivation "doco" mean?

dbt102’s picture

Assigned: Unassigned » dbt102

thanks for your comments @hass. I will make those changes.

Nitesh Sethia’s picture

Assigned: dbt102 » Unassigned
Status: Needs review » Reviewed & tested by the community

Have tested the patch and this works with the D8 version of Google Analytics. Changing the status of it to RTBC so that this can be merged with the next set of commits of Drupal 8.

Thanks,
Nitesh Sethia

hass’s picture

Status: Reviewed & tested by the community » Needs work
+++ b/google_analytics.module
@@ -40,8 +40,15 @@ function google_analytics_api() {
-    case 'google_analytics.admin_settings_form':
-      return t('<a href=":ga_url">Google Analytics</a> is a free (registration required) website traffic and marketing effectiveness service.', [':ga_url' => 'http://www.google.com/analytics/']);

incorrect change

  1. +++ b/google_analytics.module
    @@ -40,8 +40,15 @@ function google_analytics_api() {
    +      $output .= '<p>' . t('Google Analytics adds a web statistics tracking system to your website. This system incorporates numerous statistical features. For an extensive listing of these features see the <a href=":project">Google Analytics</a> project site. Beyond that, additional information can be found at the <a href=":doco">online documentation</a>.', [':doco' => 'https://www.drupal.org/node/37694', ':project' => 'https://www.drupal.org/project/google_analytics']) . '</p>';
    

    still unclear what "doco" means.

  2. +++ b/google_analytics.module
    @@ -40,8 +40,15 @@ function google_analytics_api() {
    +      $output .= '<dt>' . t('Additional features') . '</dt>'; ¶
    

    trailing space

dbt102’s picture

Thanks for the review @Nitesh Sethia ... and ... Thanks for the additional comments @hass

I've attached a new patch to address the #8 comments. This patch includes the following

+++ b/google_analytics.module
@@ -40,8 +40,15 @@ function google_analytics_api() {
-    case 'google_analytics.admin_settings_form':
-      return t('<a href=":ga_url">Google Analytics</a> is a free (registration required) website traffic and marketing effectiveness service.', [':ga_url' => 'http://www.google.com/analytics/']);

^-- It does not change the above code this time. (Note: This 'Page-specific help using only routes' works in D8.1 but not in D8.2. I'm not quite sure why. I've since found this to be true for all core and contrib modules. Just making note of it here so I can follow up on it later)

1. I used the abreviation "doco" to mean "documentation", and is changed "documentation" in this latest patch. This link points to the Drupal Community Documentation.

2. Removes the trailing space

This #8 patch also includes the additional @hass comments from #4

dbt102’s picture

Status: Needs work » Needs review
hass’s picture

Status: Needs review » Needs work

How you added a leading/trailing tab... :-)

Have you opened a bug case for the issue already we can subscribe, too?

  • hass committed ed939fd on 8.x-2.x authored by dbt102
    Issue #2728009 by dbt102, hass: Add Google Analytics HELP
    
hass’s picture

Status: Needs work » Fixed

  • hass committed 5e33a77 on 8.x-2.x
    Issue #2728009 by dbt102, hass: Add Google Analytics HELP
    

  • hass committed b86d692 on 8.x-2.x
    Issue #2728009 by hass: Add tests for HELP.
    

  • hass committed 0feea6d on 8.x-2.x
    Issue #2728009 by hass: Help module is required
    

  • hass committed ebe4e42 on 8.x-2.x
    Issue #2728009 by hass: Help does not appear for unknown reason
    

  • hass committed c7c278d on 8.x-2.x
    Issue #2728009 by hass: Disable assert until issue identified
    

Status: Fixed » Closed (fixed)

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

hass’s picture

Status: Closed (fixed) » Needs work

  • hass committed e9b5db0 on 8.x-2.x
    Issue #2728009 by hass: Add Google Analytics HELP
    
hass’s picture

Status: Needs work » Fixed

Status: Fixed » Closed (fixed)

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