WordPress.org

Plugin Directory

Changeset 634495


Ignore:
Timestamp:
12/05/12 18:57:21 (17 months ago)
Author:
mitchoyoshitaka
Message:

readme changes describing thumbnail changes

Location:
yet-another-related-posts-plugin/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • yet-another-related-posts-plugin/trunk/readme.txt

    r634233 r634495  
    88Requires at least: 3.3 
    99Tested up to: 3.5 
    10 Stable tag: 4.0 
     10Stable tag: 4.0.1 
    1111License: GPLv2 or later 
    1212 
     
    8484If your question isn't here, ask your own question at [the WordPress.org forums](http://wordpress.org/support/plugin/yet-another-related-posts-plugin). *Please do not email with questions.* 
    8585 
     86= How can I move the related posts display? = 
     87 
     88If you do not want to show the Related Posts display in its default position (right below the post content), first go to YARPP options and turn off the "automatically display" options in the "website" section. If you would like to instead display it in your sidebar and you have a widget-aware theme, YARPP provides a Related Posts widget which you can add under "Appearance" > "Widgets". 
     89 
     90If you would like to add the Related Posts display elsewhere, edit your relevant theme file (most likely something like `single.php`) and add the PHP code `related_posts();` within [The Loop](http://codex.wordpress.org/The_Loop) where you want to display the related posts. 
     91 
     92= I'm using the Thumbnails display in YARPP 4. How can I change the thumbnail size? = 
     93 
     94The thumbnail size can be specified programmatically by adding `add_image_size( 'yarpp-thumbnail', $width, $height, true );` to your theme's `functions.php` file with appropriate width and height variables. In the future I may add some UI to the settings to also set this... feedback is requested on whether this is a good idea. 
     95 
     96Each time you change YARPP's thumbnail dimensions like this, you will probably want to have WordPress regenerate appropriate sized thumbnails for all of your images. I highly recommend the [Regenerate Thumbnails](http://wordpress.org/extend/plugins/regenerate-thumbnails/) plugin for this purpose. See also the next question. 
     97 
     98= I'm using the Thumbnails display in YARPP 4. Why aren't the right size thumbnails being served? = 
     99 
     100By default if an appropriately sized thumbnail is not available in WordPress, a larger image will be served and will be made to fit in the thumbnail space via CSS. Sometimes this means images will be scaled down in a weird way, so it is not ideal... what you really want is for YARPP to serve appropriately-sized thumbnails. 
     101 
     102There are two options for doing so: 
     103 
     104* First, you can use the [Regenerate Thumbnails](http://wordpress.org/extend/plugins/regenerate-thumbnails/) plugin to generate all these thumbnail-sized images in a batch process. This puts you in control of when this resizing process happens on your server (which is good because it can be processor-intensive). New images which are uploaded to WordPress should automatically get the appropriate thumbnail generated when the image is uploaded. 
     105 
     106* Second, you can turn on a feature in YARPP to auto-generate appropriate size thumbnails on the fly, if they have not yet been created. Doing this type of processing on the fly does not scale well, so this feature is turned off by default. But if you run a smaller site with less traffic, it may work for you. Simply add `define('YARPP_GENERATE_THUMBNAILS', true);` to your theme's `functions.php` file. 
     107 
    86108= How can I use the custom template feature? = 
    87109 
    88110YARPP's [custom templates feature](http://mitcho.com/blog/projects/yarpp-3-templates/) allows you to uber-customize the related posts display using the same coding conventions and [Template Tags](http://codex.wordpress.org/Template_Tags) as in WordPress themes. Custom templates must be in your *active theme's main directory* in order to be recognized by YARPP. If your theme did not ship with YARPP templates, move the files in the `yarpp-templates` directory which ships with YARPP into your active theme's main directory. Be sure to move the *files* (which must be named `yarpp-template-`...`.php`) to your theme, not the entire directory. 
    89  
    90 = How can I move the related posts display? = 
    91  
    92 If you do not want to show the Related Posts display in its default position (right below the post content), first go to YARPP options and turn off the "automatically display" option in the "website" section. If you would like to instead display it in your sidebar and you have a widget-aware theme, YARPP provides a Related Posts widget which you can add under "Appearance" > "Widgets". 
    93  
    94 If you would like to add the Related Posts display elsewhere, edit your relevant theme file (most likely something like `single.php`) and add the PHP code `related_posts();` within [The Loop](http://codex.wordpress.org/The_Loop) where you want to display the related posts. This method can also be used to display YARPP on pages other than single-post displays, such as on archive pages. 
    95111 
    96112= Does YARPP slow down my blog/server? = 
     
    244260= 4.0.1 = 
    245261* Improvements to thumbnail handling 
    246     * Thumbnail size can be specified by adding `add_image_size( 'yarpp-thumbnail', $width, $height, true );` to your theme's `functions.php` file. In the future I may add some UI to the settings to also set this... feedback is requested on whether this is a good idea. 
    247     * YARPP now registers its thumbnail size properly. To have WordPress build thumbnails of the right size, use the [Regenerate Thumbnails](http://wordpress.org/extend/plugins/regenerate-thumbnails/) plugin. 
     262    * See new FAQ entry for practical details 
     263    * Thumbnail size can be specified programmatically (see FAQ) 
     264    * YARPP now registers its thumbnail size properly as `yarpp-thumbnail` 
    248265    * Fixed a typo and simplified an item in the dynamic `styles-thumbnails.php` styles 
    249     * Thumbnails of appropriate size can be generated on the fly, if they do not already exist, by calling `yarpp_set_option('generate_thumbnails', true);`. This is turned off by default and hidden for due to performance concerns. 
     266    * Code to generate thumbnails of appropriate size on the fly has been added, but is turned off by default for performance reasons (see FAQ) 
    250267* Bugfix: a class of `yarpp-related-` with a stray hyphen was sometimes being produced. Now fixed so it produces `yarpp-related`. 
    251268* [Bugfix](http://wordpress.org/support/topic/bug-in-sql-function-in-yarpp_cache): `term_relationships` table was being joined when unnecessary 
  • yet-another-related-posts-plugin/trunk/yarpp.php

    r634171 r634495  
    44Plugin URI: http://yarpp.org/ 
    55Description: Returns a list of related entries based on a unique algorithm for display on your blog and RSS feeds. Now with Now with thumbnail support built-in! 
    6 Version: 4.0.1b3 
     6Version: 4.0.1 
    77Author: mitcho (Michael Yoshitaka Erlewine) 
    88Author URI: http://mitcho.com/ 
     
    1010*/ 
    1111 
    12 define('YARPP_VERSION', '4.0.1b3'); 
     12define('YARPP_VERSION', '4.0.1'); 
    1313define('YARPP_DIR', dirname(__FILE__)); 
    1414define('YARPP_NO_RELATED', ':('); 
Note: See TracChangeset for help on using the changeset viewer.