=== Image Formatr ===
Contributors: eyn, huntermaster
Tags: images, caption, formatting, post, page
Requires at least: 2.0
Tested up to: 2.9
Donate link: http://www.channel-ai.com/blog/donate.php?plugin=image-caption
Stable tag: trunk

Formats all content images on a page / post giving them borders and captions.

== Credits ==

Image Formatr is Copyright 2010 [Steven Almeroth](sroth77@gmail.com) and licensed under the GPL-v3 license

Based on: [image-caption](http://wordpress.org/extend/plugins/image-caption/) by [Yaosan Yeo](http://www.channel-ai.com/blog/)

Highslide: (not included in this release) The JavaScript [Image thumbnail viewer](http://highslide.com/) library by Torstein Hønsi and the [integration plugin](http://wordpress.org/extend/plugins/highslide-integration/) by [Christoph Dietrich](http://wordpress.org/extend/plugins/profile/scrollleiste) are both licensed under a [Creative Commons Attribution-NonCommercial 2.5 License](http://creativecommons.org/licenses/by-nc/2.5/). This means you need the author's permission to use it on commercial websites.

== Description ==

Image Formatr is a very simple, one-file plugin that goes through all the content images on a post/page:

  1. gives them a standardized thumbnail format using CSS
  2. puts a caption underneath each one using the title
  3. makes them linked so they popup in full size

Note: thumbnails are not generated, the actual image is displayed in a smaller size.

= Usage =

*This only applies to the images you put in your content, not theme graphics.*

    <img
      src="/images/picture.jpg"
      class="alignright"
      title="A sample caption"
      link="http://example.com/"
      hint="Image borrowed from example.com"
    />

After the plugin runs, the output to the browser looks like:

    <div class="img alignright" style="width: 140px;">
    <a
      href="/images/picture.jpg"
      class="highslide"
      onclick="return hs.expand(this, { slideshowGroup: 'main' })"
    ><img
      src="/images/picture.jpg"
      title="Image borrowed from example.com" alt=""
      width="140" height="90"
    ></a>
    <div style="width: 100%;">
      <a href="http://example.com/" target="_blank">A sample caption</a>
    </div>
    </div>

&nbsp;

= Requirements =

[Highslide Integration plugin](http://wordpress.org/extend/plugins/highslide-integration/) ([Deutsch](http://www.scrollleiste.de/online/highslide-integration-in-wordpress)) provides the JavaScript popup image zoom.  Without this plugin Image Formatr will still show the captions and format the thumbnails but you should disable the popup Effects setting in the administration.

= Features =

  * generates image captions using the image `title` or `alt`
  * shows all content images on the blog as small thumbnails 
  * standardizes all thumbnails with zero post changes
  * automatically adds width, height and alt attributes to your images
  * zooms image to large size when clicked (with HighSlide plugin installed, not included)
  * supports custom CSS class for div image container
  * outputs standard XHTML compliant markup

== Overrides ==

The actions of the plugin are enabled and disabled with administration settings but can be overridden on each individual image.

  * `usemysize` - *true/false* - true = do not ignore an image width and height
  * `usemya`    - *true/false* - true = do not ignore a parent anchor tag
  * `nocap`     - *true/false* - true = do not create a caption
  * `nofx`      - *true/false* - true = no popup effect
  * `link`      - *string url* - make the caption a link to the url
  * `hint`      - *string txt* - this will be the new image title which most browsers popup as a mouseover hint
  * `asis`      - *true/false* - true = don't change nuthin

If you want to surround an image with an anchor tag `<a>`, then you should add a `usemya` attribute within the image tag or else your anchor will be ignored and replaced.  If you do not want the popup effect at all, add a `nofx` attribute to the image.  If you do not want any caption, you can specify `nocap`, or just leave the title blank. And to have the plugin completely ignore an image and output the content directly from the post, use the `asis` attribute.

**Example**

    <a href="http://www.example.com/">
    <img
      src="/images/picture.jpg"
      title="Click to visit website"
      nocap="true"
      usemya="true"
    /></a>

== Installation ==

  1. Download and extract the plugin
  2. Upload the extracted directory (image-formatr) to your WordPress plugin directory, probably wp-content/plugins
  3. Activate the plugin through the 'Plugins' menu in WordPress admin
  4. Verify the settings with the 'Setting' menu

  Note: the [Highslide](http://downloads.wordpress.org/plugin/highslide-integration.zip) plugin is recommended as a way to popup images when you click on them.  If you do not want the Highslide plugin, then go to the Image-formatr settings in Wordpress admin and disable the popup Effects by unchecking the box, then Update Options.

== Screenshots ==

  1. Image Formatr administration screen

== Style ==

CSS classes supported "out of the box" are: center, alignleft, alignright.

  <img src="/images/picture.jpg" class="alignright"/>

== Changelog == 

= 0.9.2 - 2010-4-16 =
  * Smiley/emoticon display patch
  * Changed: Smileys like :) were causing errors so I added a check to make sure we are not effecting emoticon graphics within the post.  Now smileys display fine, thanks to http://blog.andrewkinabrew.com/

= 0.9.1 - 2010-3-9 =
  * Standard thumnail dimensions patch
  * Changed: Allow for zero length long or short thumbnail dimension in the administration settings

= 0.9 - 2010-1-26 =
  * Initial beta release
  * Renamed the `usemyanchor` image modifier attribute to `usemya` with no deprecated support for the old one
  * Fixed: caption administration setting not working
  * Added: force-root image location mangler administration setting
  * Added: administration setting to standardize all thumbnail sizes
  * Added: `usemysize` attribute to allow for individual image sizing
  * Changed: no longer supports MyCSS plugin

= 0.8 - 2010-1-5 =
  * Initial alpha release