Ticket #4613: 4613.patch

bp-core-functions.php

@@ -396 +396 @@
         do_action( 'bp_admin_tabs' );
 }
 
-?>
+/**
+ * adds contextual help to BuddyPress admin pages
+ *
+ * @since BuddyPress (1.7)
+ * 
+ */
+function bp_core_add_contextual_help( $screen ){
+        
+        $screen = get_current_screen();
+        
+        switch( $screen->id ){
+                // compontent page
+                case 'settings_page_bp-components' :
+                        // help tabs
+                    $screen->add_help_tab( array(
+                        'id'    => 'bp-comp-overview',
+                        'title' => __('Overview'),
+                        'content'       => bp_core_add_contextual_help_content('bp-comp-overview'),
+                ));             
+                // help panel - sidebar links
+                $screen->set_help_sidebar(
+                        '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
+                        '<p>' . __( '<a href="http://codex.buddypress.org/getting-started/configure-buddypress-components/#settings-buddypress-components">Managing Components</a>', 'buddypress' ) . '</p>' .
+                        '<p>' . __( '<a href="http://buddypress.org/support/">Support Forums</a>', 'buddypress' ) . '</p>'
+                        );
+                break;
+                
+                //  pages page
+                case 'settings_page_bp-page-settings' :
+                        // help tabs
+                    $screen->add_help_tab( array(
+                        'id'    => 'bp-page-overview',
+                        'title' => __('Overview'),
+                        'content'       => bp_core_add_contextual_help_content('bp-page-overview'),
+                ));             
+                // help panel - sidebar links
+                $screen->set_help_sidebar(
+                        '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
+                        '<p>' . __( '<a href="http://codex.buddypress.org/getting-started/configure-buddypress-components/#settings-buddypress-pages">Managing Pages</a>', 'buddypress' ) . '</p>' .
+                        '<p>' . __( '<a href="http://buddypress.org/support/">Support Forums</a>', 'buddypress' ) . '</p>'
+                        );
+                break;
+        
+                // settings page
+                case 'settings_page_bp-settings' :
+                        // help tabs
+                    $screen->add_help_tab( array(
+                        'id'    => 'bp-settings-overview',
+                        'title' => __('Overview'),
+                        'content'       => bp_core_add_contextual_help_content('bp-settings-overview'),
+                ));             
+                // help panel - sidebar links
+                $screen->set_help_sidebar(
+                        '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
+                        '<p>' . __( '<a href="http://codex.buddypress.org/getting-started/configure-buddypress-components/#settings-buddypress-settings">Managing Settings</a>', 'buddypress' ) . '</p>' .
+                        '<p>' . __( '<a href="http://buddypress.org/support/">Support Forums</a>', 'buddypress' ) . '</p>'
+                        );
+                break;
+                
+                // forums page
+                case 'settings_page_bb-forums-setup' :
+                        // help tabs
+                    $screen->add_help_tab( array(
+                        'id'    => 'bp-forums-overview',
+                        'title' => __('Overview'),
+                        'content'       => bp_core_add_contextual_help_content('bp-forums-overview'),
+                ));             
+                // help panel - sidebar links
+                $screen->set_help_sidebar(
+                        '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
+                        '<p>' . __( '<a href="http://codex.buddypress.org/getting-started/configure-buddypress-components/#settings-buddypress-forums">Managing Forums</a>', 'buddypress' ) . '</p>' .
+                        '<p>' . __( '<a href="http://buddypress.org/support/">Support Forums</a>', 'buddypress' ) . '</p>'
+                        );
+                break;
+                
+                // profile fields page
+                case 'users_page_bp-profile-overview' :
+                        // help tabs
+                    $screen->add_help_tab( array(
+                        'id'    => 'bp-profile-overview',
+                        'title' => __('Overview'),
+                        'content'       => bp_core_add_contextual_help_content('bp-profile-overview'),
+                ));             
+                // help panel - sidebar links
+                $screen->set_help_sidebar(
+                        '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
+                        '<p>' . __( '<a href="http://codex.buddypress.org/getting-started/configure-buddypress-components/#users-profile-fields">Managing Profile Fields</a>', 'buddypress' ) . '</p>' .
+                        '<p>' . __( '<a href="http://buddypress.org/support/">Support Forums</a>', 'buddypress' ) . '</p>'
+                        );
+                break;
+                
+                default:
+                        return false;
+                break;
+        }               
+}
+add_action('contextual_help', 'bp_core_add_contextual_help');
+
+
+/**
+ * renders contextual help content to contextual help tabs
+ *
+ * @since BuddyPress (1.7)
+ * 
+ */
+function bp_core_add_contextual_help_content( $tab = '' ){
+
+         switch( $tab ) {
+                case 'bp-comp-overview' :
+                        return '<p>' . __( 'By default, all BuddyPress components are enabled. You can selectively disable any of the components by using the form. Your BuddyPress installation will continue to function. However, the features of the disabled components will no longer be accessible to anyone using the site.', 'buddypress' ) . '</p>';
+                break;
+                
+                case'bp-page-overview' :
+                        return '<p>' . __( 'BuddyPress Components are rendered as WordPress Pages in BuddyPress. You’ll recall that the component Pages were created and associated to respective BuddyPress components in Step 2 of the Installation Wizard. Here you can choose to change the associated pages.', 'buddypress' ) . '</p>';
+                break;
+                
+                case 'bp-settings-overview' :
+                        return '<p>' . __( 'Extra configuration settings.', 'buddypress' ) . '</p>';    
+                break;
+        
+                case 'bp-forums-overview' :
+                        return '<p>' . __( 'You can choose to install Group Forums only, Sitewide Forums only, or Group and Sitewide Forums. For the best user experience you should choose only one option.', 'buddypress' ) . '</p>'; 
+                break;
+                
+                case 'bp-profile-overview' :
+                        return '<p>' . __( 'Your users will distinguish themselves through their profile page. Create relevant profile fields that will show on each users profile.</br></br>Note: Any fields in the first group will appear on the signup page.', 'buddypress' ) . '</p>';     
+                break;
+                
+                default:
+                return false;
+            break;
+    }
+}
+
+?>
+ No newline at end of file