1 <?php
 2 /**
 3  * Contextual Help
 4  *
 5  * @package     EDD
 6  * @subpackage  Admin/Settings
 7  * @copyright   Copyright (c) 2013, Pippin Williamson
 8  * @license     http://opensource.org/licenses/gpl-2.0.php GNU Public License
 9  * @since       1.4
10  */
11 
12 // Exit if accessed directly
13 if ( ! defined( 'ABSPATH' ) ) exit;
14 
15 /**
16  * Settings contextual help.
17  *
18  * @access      private
19  * @since       1.4
20  * @return      void
21  */
22 function edd_settings_contextual_help() {
23     $screen = get_current_screen();
24 
25     if ( $screen->id != 'download_page_edd-settings' )
26         return;
27 
28     $screen->set_help_sidebar(
29         '<p><strong>' . sprintf( __( 'For more information:', 'edd' ) . '</strong></p>' .
30         '<p>' . sprintf( __( 'Visit the <a href="%s">documentation</a> on the Easy Digital Downloads website.', 'edd' ), esc_url( 'https://easydigitaldownloads.com/documentation/' ) ) ) . '</p>' .
31         '<p>' . sprintf(
32                     __( '<a href="%s">Post an issue</a> on <a href="%s">GitHub</a>. View <a href="%s">extensions</a> or <a href="%s">themes</a>.', 'edd' ),
33                     esc_url( 'https://github.com/pippinsplugins/Easy-Digital-Downloads/issues' ),
34                     esc_url( 'https://github.com/pippinsplugins/Easy-Digital-Downloads' ),
35                     esc_url( 'https://easydigitaldownloads.com/extensions/' ),
36                     esc_url( 'https://easydigitaldownloads.com/themes/' )
37                 ) . '</p>'
38     );
39 
40     $screen->add_help_tab( array(
41         'id'        => 'edd-settings-general',
42         'title'     => __( 'General', 'edd' ),
43         'content'   => '<p>' . __( 'This screen provides the most basic settings for configuring your store. You can set the currency, page templates, and turn <em>Test Mode</em> on and off.', 'edd' ) . '</p>'
44     ) );
45 
46     $screen->add_help_tab( array(
47         'id'        => 'edd-settings-payment-gateways',
48         'title'     => __( 'Payment Gateways', 'edd' ),
49         'content'   =>
50             '<p>' . __( 'This screen provides ways to toggle payment gateways on or off, as well as configure gateway-specific settings. Any extra payment gateway extensions you have installed will appear on this page, and can be configured to suit your needs.', 'edd' ) . '</p>' . 
51             '<p>' . __( '<strong>Test Payment</strong> - This included gateway is great for testing your store, as it requires no payment, and leads straight to product downloads. However, please remember to turn it off once your site is live!', 'edd' ) . '</p>' .
52             '<p>' . __( '<strong>PayPal</strong> - A PayPal payment gateway is included as standard with Easy Digital Downloads. To test the PayPal gateway, you need a Sandbox account for PayPal and the site must be placed in Test Mode from the General settings tab. Please remember to enter your PayPal account email address in order for payments to get processed.', 'edd' ) . '</p>'
53     ) );
54 
55     $screen->add_help_tab( array(
56         'id'        => 'edd-settings-emails',
57         'title'     => __( 'Emails', 'edd' ),
58         'content'   =>
59             '<p>' . __( "This screen allows you to customize how emails act throughout your store. You can choose a premade template, set the sender's name, email address, and subject.", 'edd' ) . '</p>' .
60             '<p>' . __( 'A set of email tags has also been provided to allow the creation of personalized emails. A tag consists of a keyword surrounded by curly braces: <code>{tag}</code>. A description of each of these tags appear below the editor.', 'edd' ) . '</p>'
61     ) );
62 
63     $screen->add_help_tab( array(
64         'id'        => 'edd-settings-styles',
65         'title'     => __( 'Styles', 'edd' ),
66         'content'   => '<p>' . __( "This screen provides allows customization of your store's styles. For complete control, you can completely disable all styles generated by the plugin.", 'edd' ) . '</p>' 
67     ) );
68 
69     $screen->add_help_tab( array(
70         'id'        => 'edd-settings-taxes',
71         'title'     => __( 'Taxes', 'edd' ),
72         'content'   => '<p>' . __( 'This screen provides basic settings for adjusting how tax rules work for purchases.', 'edd' ) . '</p>' 
73     ) );
74 
75     $screen->add_help_tab( array(
76         'id'        => 'edd-settings-misc',
77         'title'     => __( 'Miscellaneous', 'edd' ),
78         'content'   =>
79             '<p>' . __( 'This screen provides other miscellaneous options such as disabling jQuery, allowing guest checkout, and configuring your terms of service.', 'edd' ) . '</p>' .
80             '<p>' . __( 'A description of all the options are provided beside their input boxes.', 'edd' ) . '</p>'
81     ) );
82 
83     do_action( 'edd_settings_contextual_help', $screen );
84 }
85 add_action( 'load-download_page_edd-settings', 'edd_settings_contextual_help' );

Easy Digital Downloads API documentation generated by ApiGen 2.8.0