Skip to:
Content

bbPress.org

Changeset 5314


Ignore:
Timestamp:
03/05/2014 08:39:26 PM (11 years ago)
Author:
johnjamesjacoby
Message:

Add contextual help for admin Tools. Props netweb. Fixes #1920.

Location:
trunk/src/includes/admin
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/includes/admin/actions.php

    r5269 r5314  
    7575
    7676// Contextual Helpers
    77 add_action( 'load-settings_page_bbpress', 'bbp_admin_settings_help' );
     77add_action( 'load-settings_page_bbpress',    'bbp_admin_settings_help' );
     78add_action( 'load-tools_page_bbp-repair',    'bbp_admin_tools_repair_help' );
     79add_action( 'load-tools_page_bbp-converter', 'bbp_admin_tools_converter_help' );
     80add_action( 'load-tools_page_bbp-reset',     'bbp_admin_tools_reset_help' );
    7881
    7982// Handle submission of Tools pages
  • trunk/src/includes/admin/tools.php

    r5300 r5314  
    9898        }
    9999    }
     100}
     101
     102/**
     103 * Contextual help for Repair Forums tools page
     104 *
     105 * @since bbPress (r5314)
     106 * @uses get_current_screen()
     107 */
     108
     109function bbp_admin_tools_repair_help() {
     110
     111    $current_screen = get_current_screen();
     112
     113    // Bail if current screen could not be found
     114    if ( empty( $current_screen ) ) {
     115        return;
     116    }
     117
     118    // Repair Forums
     119    $current_screen->add_help_tab( array(
     120        'id'      => 'repair_forums',
     121        'title'   => __( 'Repair Forums', 'bbpress' ),
     122        'content' => '<p>' . __( 'There is more detailed information available on the bbPress and BuddyPress codex for the following:', 'bbpress' ) . '</p>' .
     123                     '<p>' .
     124                        '<ul>' .
     125                            '<li>' . __( 'BuddyPress Group Forums: <a href="http://codex.buddypress.org/getting-started/installing-group-and-sitewide-forums/">Installing Group and Sitewide Forums</a> and <a href="http://codex.buddypress.org/getting-started/guides/migrating-from-old-forums-to-bbpress-2/">Migrating from old forums to bbPress 2.2+</a>.', 'bbpress' ) . '</li>' .
     126                            '<li>' . __( 'bbPress roles: <a href="http://codex.bbpress.org/bbpress-user-roles-and-capabilities/" target="_blank">bbPress User Roles and Capabilities</a>',                                                                                                                                                                        'bbpress' ) . '</li>' .
     127                        '</ul>' .
     128                    '</p>' .
     129                    '<p>' . __( 'Also see <a href="http://codex.bbpress.org/repair-forums/">bbPress: Repair Forums</a>.', 'bbpress' ) . '</p>'
     130    ) );
     131
     132    // Help Sidebar
     133    $current_screen->set_help_sidebar(
     134        '<p><strong>' . __( 'For more information:', 'bbpress' ) . '</strong></p>' .
     135        '<p>' . __( '<a href="http://codex.bbpress.org" target="_blank">bbPress Documentation</a>',    'bbpress' ) . '</p>' .
     136        '<p>' . __( '<a href="http://bbpress.org/forums/" target="_blank">bbPress Support Forums</a>', 'bbpress' ) . '</p>'
     137    );
     138}
     139
     140/**
     141 * Contextual help for Reset Forums tools page
     142 *
     143 * @since bbPress (r5314)
     144 * @uses get_current_screen()
     145 */
     146
     147function bbp_admin_tools_reset_help() {
     148
     149    $current_screen = get_current_screen();
     150
     151    // Bail if current screen could not be found
     152    if ( empty( $current_screen ) ) {
     153        return;
     154    }
     155
     156    // Reset Forums
     157    $current_screen->add_help_tab( array(
     158        'id'      => 'reset_forums',
     159        'title'   => __( 'Reset Forums', 'bbpress' ),
     160        'content' => '<p>' . __( 'Also see <a href="http://codex.bbpress.org/reset-forums//">bbPress: Reset Forums</a>.', 'bbpress' ) . '</p>'
     161    ) );
     162
     163    // Help Sidebar
     164    $current_screen->set_help_sidebar(
     165        '<p><strong>' . __( 'For more information:', 'bbpress' ) . '</strong></p>' .
     166        '<p>' . __( '<a href="http://codex.bbpress.org" target="_blank">bbPress Documentation</a>',    'bbpress' ) . '</p>' .
     167        '<p>' . __( '<a href="http://bbpress.org/forums/" target="_blank">bbPress Support Forums</a>', 'bbpress' ) . '</p>'
     168    );
     169}
     170
     171/**
     172 * Contextual help for Import Forums tools page
     173 *
     174 * @since bbPress (r5314)
     175 * @uses get_current_screen()
     176 */
     177
     178function bbp_admin_tools_converter_help() {
     179
     180    $current_screen = get_current_screen();
     181
     182    // Bail if current screen could not be found
     183    if ( empty( $current_screen ) ) {
     184        return;
     185    }
     186
     187    // Overview
     188    $current_screen->add_help_tab( array(
     189        'id'      => 'overview',
     190        'title'   => __( 'Overview', 'bbpress' ),
     191        'content' => '<p>' . __( 'This screen provides access to all of the bbPress Import Forums settings and resources.',                                      'bbpress' ) . '</p>' .
     192                     '<p>' . __( 'Please see the additional help tabs for more information on each individual section.',                                         'bbpress' ) . '</p>' .
     193                     '<p>' . __( 'Also see the main article on the bbPress codex <a href="http://codex.bbpress.org/import-forums/">bbPress: Import Forums</a>.', 'bbpress' ) . '</p>'
     194    ) );
     195
     196    // Database Settings
     197    $current_screen->add_help_tab( array(
     198        'id'      => 'database_settings',
     199        'title'   => __( 'Database Settings', 'bbpress' ),
     200        'content' => '<p>' . __( 'In the Database Settings you have a number of options:', 'bbpress' ) . '</p>' .
     201                     '<p>' .
     202                        '<ul>' .
     203                            '<li>' . __( 'The settings in this section refer to the database connection strings used by your old forum software. The best way to determine the exact settings you need is to copy them from your legacy forums configuration file or contact your web hosting provider.', 'bbpress' ) . '</li>' .
     204                        '</ul>' .
     205                    '</p>'
     206    ) );
     207
     208    // Importer Options
     209    $current_screen->add_help_tab( array(
     210        'id'      => 'importer_options',
     211        'title'   => __( 'Importer Options', 'bbpress' ),
     212        'content' => '<p>' . __( 'In the Options you have a number of options:', 'bbpress' ) . '</p>' .
     213                     '<p>' .
     214                        '<ul>' .
     215                            '<li>' . __( 'Depending on your MySQL configuration you can tweak the "Rows Limit" and "Delay Time" that may help to improve the overall time it takes to perform a complete forum import.', 'bbpress' ) . '</li>' .
     216                            '<li>' . __( '"Convert Users" will import your legacy forum members as WordPress Users.',                                                                                                    'bbpress' ) . '</li>' .
     217                            '<li>' . __( '"Start Over" will start the importer fresh, if your import failed for any reason leaving this setting unchecked the importer will begin from where it left off.',              'bbpress' ) . '</li>' .
     218                            '<li>' . __( '"Purge Previous Import" will remove data imported from a failed import without removing your existing forum data.',                                                            'bbpress' ) . '</li>' .
     219                        '</ul>' .
     220                    '</p>'
     221    ) );
     222    // Help Sidebar
     223    $current_screen->set_help_sidebar(
     224        '<p><strong>' . __( 'For more information:', 'bbpress' ) . '</strong></p>' .
     225        '<p>' . __( '<a href="http://codex.bbpress.org" target="_blank">bbPress Documentation</a>',    'bbpress' ) . '</p>' .
     226        '<p>' . __( '<a href="http://bbpress.org/forums/" target="_blank">bbPress Support Forums</a>', 'bbpress' ) . '</p>'
     227    );
    100228}
    101229
Note: See TracChangeset for help on using the changeset viewer.