WordPress.org

Plugin Directory

Changeset 512382


Ignore:
Timestamp:
02/29/12 14:53:18 (2 years ago)
Author:
studiograsshopper
Message:

Final tweaks to contextual help wording.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • dynamic-content-gallery-plugin/trunk/lib/includes/dcg-admin-ui-help.php

    r483286 r512382  
    5353        'callback' => 'dfcg_help_general' 
    5454    )); 
    55  
     55     
     56    $current_screen->add_help_tab( array( 
     57        'id'      => 'dfcg-help-theme', 
     58        'title'   => __( 'Theme integration', DFCG_DOMAIN ), 
     59        'callback' => 'dfcg_help_theme' 
     60    )); 
     61     
    5662    $current_screen->add_help_tab( array( 
    5763        'id'      => 'dfcg-help-quick', 
    5864        'title'   => __( 'Quick Start', DFCG_DOMAIN ), 
    5965        'callback' => 'dfcg_help_quick' 
    60     )); 
    61      
    62     $current_screen->add_help_tab( array( 
    63         'id'      => 'dfcg-help-theme', 
    64         'title'   => __( 'Theme integration', DFCG_DOMAIN ), 
    65         'callback' => 'dfcg_help_theme' 
    6666    )); 
    6767 
     
    145145    <h3><?php _e( 'Dynamic Content Gallery - Quick Help', DFCG_DOMAIN ); ?></h3> 
    146146     
    147     <p><?php _e( 'This Quick Help provides basic tips, accessed via the menu on the left, to help you understand how the plugin works and how to set up the Settings page. Additionally, detailed guides to Documentation, Configuration and other resources can be found via the links in the sidebar -->', DFCG_DOMAIN ); ?></p> 
     147    <p><?php _e( 'This Quick Help provides basic tips, accessed via the menu on the left, to help you understand how the plugin works and how to set up the Settings page. Additionally, detailed guides to Documentation, Configuration and other resources can be found via the DCG Resources links in the sidebar ---->', DFCG_DOMAIN ); ?></p> 
    148148     
    149149    <p><strong><?php _e( "Inline Help: ", DFCG_DOMAIN ); ?></strong><?php _e( "Many options in the Settings page have a helpful 'Tip' pop-up wherever you see this symbol:", DFCG_DOMAIN ); ?> <img class="inline" src="<?php echo  DFCG_LIB_URL . '/admin-css-js/cluetip/images/help.png'; ?>" alt="" /></p> 
     
    152152    <h4><?php _e( 'Understanding the basics', DFCG_DOMAIN ); ?></h4> 
    153153     
    154     <p><?php _e( 'Each image in the DCG gallery is associated with a Post or a Page. The selection of posts/Pages is made in the Gallery Method tab. The Image Management options determine how the plugin associates images with Posts/Pages, either using the Featured Image or manually by entering an image URL in the in-post DCG Metabox.', DFCG_DOMAIN ); ?></p> 
     154    <p><?php _e( 'Each image in the DCG gallery is associated with a Post or a Page. The selection of posts/Pages is made in the Gallery Method tab. The Image Management options determine how the plugin selects the image for each Post/Page, either using the Featured Image or a manually chosen image URL entered in the in-post DCG Metabox.', DFCG_DOMAIN ); ?></p> 
     155     
     156    <h4><?php _e( 'Please support future development!', DFCG_DOMAIN ); ?></h4> 
     157     
     158    <p><?php _e( 'If you have found this plugin useful and wish to help support its future development, please consider making a donation via the link in the righthand sidebar. Thank you.', DFCG_DOMAIN ); ?></p> 
     159 
     160<?php 
     161} 
     162 
     163 
     164/** 
     165 * Theme Integration - add_help_tab() callback 
     166 * See dfcg_plugin_help() 
     167 * 
     168 * @since 4.0 
     169 */ 
     170function dfcg_help_theme() { 
     171?> 
     172    <h3><?php _e( 'Dynamic Content Gallery - Quick Help - Theme Integration', DFCG_DOMAIN ); ?></h3> 
     173     
     174    <p><?php _e( 'Before doing anything else you need to integrate the DCG in your theme using either the DCG Widget or the DCG Template Tag.', DFCG_DOMAIN ); ?></p> 
     175     
     176    <h4>DCG Widget</h4> 
     177     
     178    <p><?php _e( 'Assuming your theme has widget areas on your home page, using the DCG Widget is the simplest method to use as no coding is required. Go to Dashboard > Appearance > Widgets and drag the DCG Widget to an appropriate widget area. You can then add a title (optional) and even some "after" text which will display below the DCG.', DFCG_DOMAIN ); ?> <em><?php _e( 'Note that even if using the DCG Widget, you must set up the various options on the DCG Settings page.', DFCG_DOMAIN ); ?></em></p> 
     179     
     180    <h4><?php _e( 'DCG Template Tag', DFCG_DOMAIN ); ?></h4> 
     181     
     182    <p><?php _e( 'Alternatively, you can use the template tag in a theme template, like this:', DFCG_DOMAIN ); ?></p> 
     183     
     184    <code>&lt;php dynamic_content_gallery(); ?&gt;</code><br /><br /> 
     185     
     186    <p><?php _e( 'Check out this tutorial:', DFCG_DOMAIN ); ?> <a class="off-site" target="_blank" href="<?php echo DFCG_HOME; ?>configuration-guide/#template-code"><?php _e( 'How to choose the correct theme template when using the DCG Template Tag', DFCG_DOMAIN ); ?></a></p> 
    155187 
    156188<?php 
     
    169201     
    170202    <h4><?php _e( '90 second configuration', DFCG_DOMAIN ); ?></h4> 
     203     
     204    <p><?php printf( '%s <a href="%s">%s</a> %s', __( 'The following assumes that you have followed the', DFCG_DOMAIN ), '#tab-panel-dfcg-help-theme', __( 'Theme Integration', DFCG_DOMAIN ), __( 'instructions.', DFCG_DOMAIN ) ); ?></p> 
    171205     
    172206    <p><?php _e( 'When first installed, the plugin is pre-configured with default settings designed to get you up and running very quickly. For simplicity, the Gallery Method is set to "One category" with 5 posts, and Image Management is set to "Featured Images".', DFCG_DOMAIN ); ?></p> 
     
    181215 
    182216/** 
    183  * Theme Integration - add_help_tab() callback 
    184  * See dfcg_plugin_help() 
    185  * 
    186  * @since 4.0 
    187  */ 
    188 function dfcg_help_theme() { 
    189 ?> 
    190     <h3><?php _e( 'Dynamic Content Gallery - Quick Help - Theme Integration', DFCG_DOMAIN ); ?></h3> 
    191     <p><?php _e( 'There are two methods you can use for integrating (ie displaying) the DCG in your theme - either the DCG Widget or a Template Tag.', DFCG_DOMAIN ); ?></p> 
    192     <h4>DCG Widget</h4> 
    193     <p><?php _e( 'Assuming your theme has widget areas on your home page, using the DCG Widget is the simplest method to use as no coding is required. Go to Dashboard > Appearance > Widgets and drag the DCG Widget to an appropriate widget area. You can then add a title (optional) and even some "after" text which will display below the DCG.', DFCG_DOMAIN ); ?> <em><?php _e( 'Note that even if using the DCG Widget, you must set up the various options on the DCG Settings page.', DFCG_DOMAIN ); ?></em></p> 
    194     <h4><?php _e( 'Template Tag', DFCG_DOMAIN ); ?></h4> 
    195     <p><?php _e( 'For the template tag, add this to your theme:', DFCG_DOMAIN ); ?></p> 
    196     <code>&lt;php dynamic_content_gallery(); ?&gt;</code><br /><br /> 
    197     <p><?php _e( 'Check out this tutorial:', DFCG_DOMAIN ); ?> <a class="off-site" target="_blank" href="<?php echo DFCG_HOME; ?>configuration-guide/#template-code"><?php _e( 'How to choose the correct theme template when adding the plugin code', DFCG_DOMAIN ); ?></a></p> 
    198  
    199 <?php 
    200 } 
    201  
    202  
    203 /** 
    204217 * Gallery Method - add_help_tab() callback 
    205218 * See dfcg_plugin_help() 
     
    211224    <h3><?php _e( 'Dynamic Content Gallery - Quick Help - Gallery Method', DFCG_DOMAIN ); ?></h3> 
    212225     
    213     <p><?php _e( 'For many users the best option is One Category. It is great as a "set and forget" option, because it will always pull in the latest posts from your chosen category. The Custom Post option works in a similar way to the One Category method and is, obviously, the best option for pulling in posts from one Custom Post type. In server performance terms, these two methods are probably the quickest and most efficient ones to use.', DFCG_DOMAIN ); ?></p> 
     226    <p><?php _e( 'For many users the best option is One Category. It is great as a "set and forget" option, because it will always pull in the latest posts from your chosen category. The Custom Post option works in a similar way to the One Category method and is, obviously, the best option for pulling in posts from one Custom Post type. In server performance terms, these two methods are probably the most efficient ones to use.', DFCG_DOMAIN ); ?></p> 
     227     
    214228    <p><?php _e( 'The Multi-Option method is perfect for when you want to mix posts from different categories, for example if you want to feature the latest post from a number of different categories.', DFCG_DOMAIN ); ?></p> 
     229     
    215230    <p><?php _e( 'The ID Method is the most flexible because you can pull in any type of post (normal of Custom) and Pages, and mix them in any order you wish using the Sort Order field in the DCG metabox.', DFCG_DOMAIN ); ?></p> 
    216231 
     
    230245     
    231246    <p><?php _e( 'Quite simply, the Featured Images option is the best and easiest to use. The manual methods (Full and Partial) are primarily there for reasons of backwards compatibility, for those users who have been using the DCG since its earliest versions.', DFCG_DOMAIN ) ;?></p> 
    232     <p><?php _e( 'Note: it is quite possible that the manual image management options will be removed in future. Therefore users are encouraged to use the Featured Image option - it is easier and more flexible.', DFCG_DOMAIN ); ?></p> 
     247     
     248    <p><em><?php _e( 'Note: it is quite possible that the manual image management options will be removed in future. Therefore users are encouraged to use the Featured Image option - it is easier and more flexible.', DFCG_DOMAIN ); ?></em></p> 
    233249     
    234250    <p><?php _e( 'If you select the Partial URL option you will be prompted to enter the URL to the root folder for your images. You must enter a URL here otherwise the DCG will not find your images.', DFCG_DOMAIN ); ?></p> 
     
    250266    <p><?php _e( 'The Description is the text which appears below the post/Page title in the gallery Slide Pane.</p> 
    251267    <p>Four different options for creating the description are available: two "auto" options, one "manual" option, and one option to disable the description altogether.', DFCG_DOMAIN ); ?></p> 
     268     
    252269    <p><?php _e( 'If you want total control over the text, check the <span class="bold-italic">Manual</span> option and enter the descriptions in the in-post DCG Metabox for each post/Page. This option also allows you to set up a fallback description which will be displayed if a DCG Metabox description does not exist.', DFCG_DOMAIN ); ?></p> 
     270     
    253271    <p><?php _e( 'The recommended "auto" option is <span class="bold-italic">Auto</span>. This automatically creates a description from the post/Page content and allows you to specify the length of the description and customise its Read More link.', DFCG_DOMAIN ); ?></p> 
     272     
    254273    <p><?php _e( 'The alternative "auto" option is the <span class="bold-italic">Excerpt</span> option. This will display the post/Page Excerpt - either the handcrafted one if it exists, or an automatic Excerpt of the first 55 words of the post/Page. Bear in mind using an automatic Excerpt will probably result in too much text for the Slide Pane, though this can be dealt with by using the WordPress excerpt filter. You can learn more about this filter <a href="http://www.studiograsshopper.ch/code-snippets/customising-the_excerpt/" target="_blank">here</a>.', DFCG_DOMAIN ); ?></p> 
    255274 
     
    268287    <h3><?php _e( 'Dynamic Content Gallery - Quick Help - Gallery CSS', DFCG_DOMAIN ); ?></h3> 
    269288     
    270     <p>The <span class="bold-italic">DCG Settings > Gallery CSS</span> tab gives lots of options for customising the gallery's CSS.</p> 
    271     <p>The most important options here are those for the gallery height and gallery width. Not only do these settings determine the size of the gallery on the page, they also set the size of the images that the DCG automatically creates during the media upload process. Some points to note:</p> 
     289    <p><?php _e( 'The DCG Settings > Gallery CSS tab gives lots of options for customising the gallery\'s CSS.', DFCG_DOMAIN ); ?></p> 
     290     
     291    <p><?php _e( 'The most important options here are those for the gallery height and gallery width. Not only do these settings determine the size of the gallery on the page, they also set the size of the images that the DCG automatically creates during the media upload process. Some points to note:', DFCG_DOMAIN ); ?></p> 
    272292    <ul> 
    273293        <li><?php _e( 'Once the gallery size settings have been saved, automatically sized images will only be created for new images uploaded from that point on.', DFCG_DOMAIN ); ?></li> 
    274         <li>To create DCG sized versions of images that are already in the Media Library, use the excellent <a href="http://wordpress.org/extend/plugins/regenerate-thumbnails/" target="_blank">Regenerate Thumbnails</a> plugin.</li> 
    275         <li>You will be prompted to run the Regenerate Thumbnails plugin whenever you change the gallery dimensions in the <span class="bold-italic">DCG Settings > Gallery CSS</span> tab.</li> 
     294         
     295        <li><?php printf( '%s <a href="%s" target="_blank">%s</a> %s', __( 'To create DCG sized versions of images that are already in the Media Library, use the excellent', DFCG_DOMAIN ), 'http://wordpress.org/extend/plugins/regenerate-thumbnails/', __( 'Regenerate Thumbnails' ), __( 'plugin' ) ); ?>.</li> 
     296         
     297        <li><?php _e( 'You will be prompted to run the Regenerate Thumbnails plugin whenever you change the gallery dimensions in the DCG Settings > Gallery CSS tab.', DFCG_DOMAIN ); ?></li> 
    276298    </ul> 
    277     <p>The default settings of the <span class="bold-italic">Gallery CSS</span> tab have been designed to be a good starting point. Apart from the gallery height and width mentioned earlier, the other important setting here is the Slide Pane height setting. Note that when using the jQuery script option, the Slide Pane height is set automatically.</p> 
     299     
     300    <p><?php _e( 'The default settings of the Gallery CSS tab have been designed to be a good starting point. Apart from the gallery height and width mentioned earlier, the other important setting here is the Slide Pane height setting. Note that when using the jQuery script option, the Slide Pane height is set automatically.', DFCG_DOMAIN ); ?></p> 
    278301 
    279302<?php 
     
    291314    <h3><?php _e( 'Dynamic Content Gallery - Quick Help - Javascript and Load Scripts', DFCG_DOMAIN ); ?></h3> 
    292315     
    293     <p>Go to the <span class="bold-italic">DCG Settings > Javascript Options</span> tab to set the choice of mootools (default) or jQuery scripts. Note that after changing this settings, click Save, then return to the Javascript Options tab to configure the other options in this tab. You have to do this because the javascript options are not identical for both scripts.</p> 
    294      
    295     <p>The <span class="bold-italic">Load Scripts</span> tab allows you to specify in which pages the javascript and gallery CSS are loaded. These settings ensure that the javascript and CSS are only loaded where needed, and therefore won't slow down the page load on all the other pages on your site.</p> 
    296     <p>In 99.9% of cases users will display the DCG on their home page. Therefore, if this is the case you for, select the <span class="bold-italic">Home page</span> option.</p> 
     316    <p><?php _e( 'Go to the DCG Settings > Javascript Options tab to set the choice of mootools (default) or jQuery scripts. Note that after changing this settings, click Save, then return to the Javascript Options tab to configure the other options in this tab. You have to do this because the javascript options are not identical for both scripts.', DFCG_DOMAIN ); ?></p> 
     317     
     318    <p><?php _e( 'The DCG Settings > Load Scripts tab allows you to specify in which pages the javascript and gallery CSS are loaded. These settings ensure that the javascript and CSS are only loaded where needed, and therefore will not slow down the page load on all the other pages on your site.', DFCG_DOMAIN ); ?></p> 
     319     
     320    <p><?php _e( 'In 99.9% of cases users will display the DCG on their home page. Therefore, if this is the case you for, select the Home page option in the DCG Settings > Load Scripts tab.', DFCG_DOMAIN ); ?></p> 
    297321 
    298322<?php 
     
    311335     
    312336    <ul> 
    313         <li>Go to <span class="bold-italic">DCG Settings > Tools</span> tab and turn on Error Messages. Then refresh your browser and look at the Page Source of the page that contains the DCG. The Error Messages are displayed as HTML comments in the DCG markup and will help you identify where the problem lies.</li> 
    314     <li>For those not using Featured Images, 99% of problems are caused by incorrect image URLs entered in the DCG Metabox. Check those URLs!</li> 
    315     <li><?php _e( 'If nothing is displayed where you expect to see the DCG, you probably have not integrated the DCG properly into your theme.', DFCG_DOMAIN ); ?></li> 
    316     <li>If the gallery is there on your page, but appears "stuck" with only the loading bar visible, first click open the thumbnail carousel and see if images are there. If you can see the thumbnails in the carousel, then the problem is most likely the URL of the first image in the gallery. If the thumbnails are not visible and/or the carousel isn't visible, you probably have a javascript conflict with another plugin. Go to the <span class="bold-italic">DCG Settings > Javascript Options</span> tab and switch to jQuery and see what happens.</li> 
    317     <li>If all else fails, and you have read all the documentation and checked your settings, try posting a question on the plugin's <a href="http://studiograsshopper.ch/forum/" target="_blank">support forum</a>.</li></ul> 
    318  
    319 <?php 
    320 } 
     337        <li><?php _e( 'First, go to the DCG Settings > Tools tab and turn on Error Messages. Then refresh your browser and look at the Page Source of the page that contains the DCG. The Error Messages are displayed as HTML comments in the DCG markup and will help you identify where the problem lies.', DFCG_DOMAIN ); ?></li> 
     338         
     339        <li><?php _e( 'For those not using Featured Images, 99% of problems are caused by incorrect image URLs entered in the DCG Metabox. Check those URLs!', DFCG_DOMAIN ); ?></li> 
     340     
     341        <li><?php _e( 'If nothing is displayed where you expect to see the DCG, you probably have not integrated the DCG properly into your theme.', DFCG_DOMAIN ); ?></li> 
     342     
     343        <li><?php _e( 'If the gallery is there on your page, but appears "stuck" with only the loading bar visible, first click open the thumbnail carousel and see if images are there. If you can see the thumbnails in the carousel, then the problem is most likely the URL of the first image in the gallery. If the thumbnails are not visible and/or the carousel isn\'t visible, you probably have a javascript conflict with another plugin. Go to the DCG Settings > Javascript Options tab and switch to jQuery and see what happens.', DFCG_DOMAIN ); ?></li> 
     344     
     345        <li><?php printf( '%s <a href="%s" target="_blank">%s</a>.', __( 'If all else fails, and you have read all the documentation and checked your settings, post a question on the', DFCG_DOMAIN ), 'http://studiograsshopper.ch/forum/', __( 'support forum', DFCG_DOMAIN ) ); ?></li> 
     346    </ul> 
     347 
     348<?php 
     349} 
Note: See TracChangeset for help on using the changeset viewer.