Changeset 3119 for branches/plugin/bbp-admin/bbp-settings.php

Timestamp:

05/08/2011 09:05:44 AM (15 years ago)

Author:

johnjamesjacoby

Message:

Add contextual help to forums, topics, replies, and settings. Fixes #1510. Props ryanimel for original patch.

File:

• branches/plugin/bbp-admin/bbp-settings.php (modified) (1 diff)

branches/plugin/bbp-admin/bbp-settings.php

@@ -326 +326 @@
 <?php
 }
-?>
+
+/**
+ * Contextual help for bbPress settings page
+ *
+ * @since bbPress (r3119)
+ */
+function bbp_admin_settings_help() {
+
+    $bbp_contextual_help[] = __('This screen provides access to basic bbPress settings.', 'bbpress' );
+    $bbp_contextual_help[] = __('In the Main Settings you have a number of options:',     'bbpress' );
+    $bbp_contextual_help[] =
+        '<ul>' .
+            '<li>' . __( 'You can choose to lock a post after a certain number of minutes. "Locking post editing" will prevent the author from editing some amount of time after saving a post.',              'bbpress' ) . '</li>' .
+            '<li>' . __( '"Throttle time" is the amount of time required between posts from a single author. The higher the throttle time, the longer a user will need to wait between posting to the forum.', 'bbpress' ) . '</li>' .
+            '<li>' . __( 'You may choose to allow favorites, which are a way for users to save and later return to topics they favor. This is enabled by default.',                                            'bbpress' ) . '</li>' .
+            '<li>' . __( 'You may choose to allow subscriptions, which allows users to subscribe for notifications to topics that interest them. This is enabled by default.',                                 'bbpress' ) . '</li>' .
+            '<li>' . __( 'You may choose to allow "Anonymous Posting", which will allow guest users who do not have accounts on your site to both create topics as well as replies.',                          'bbpress' ) . '</li>' .
+        '</ul>';
+
+    $bbp_contextual_help[] = __( 'Per Page settings allow you to control the number of topics and replies will appear on each of those pages. This is comparable to the WordPress "Reading Settings" page, where you can set the number of posts that should show on blog pages and in feeds.', 'bbpress' );
+    $bbp_contextual_help[] = __( 'The Forums section allows you to control the permalink structure for your forums. Each "base" is what will be displayed after your main URL and right before your permalink slug.', 'bbpress' );
+    $bbp_contextual_help[] = __( 'You must click the Save Changes button at the bottom of the screen for new settings to take effect.', 'bbpress' );
+    $bbp_contextual_help[] = __( '<strong>For more information:</strong>', 'bbpress' );
+    $bbp_contextual_help[] =
+        '<ul>' .
+            '<li>' . __( '<a href="http://bbpress.org/documentation/">bbPress Documentation</a>', 'bbpress' ) . '</li>' .
+            '<li>' . __( '<a href="http://bbpress.org/forums/">bbPress Support Forums</a>',       'bbpress' ) . '</li>' .
+        '</ul>' ;
+
+    // Empty the default $contextual_help var
+    $contextual_help = '';
+
+    // Wrap each help item in paragraph tags
+    foreach( $bbp_contextual_help as $paragraph )
+        $contextual_help .= '<p>' . $paragraph . '</p>';
+
+    // Add help
+    add_contextual_help( 'settings_page_bbpress', $contextual_help );
+}
+
+?>