Bug #5608 for Imager: Documentation suggestions

----- Forwarded message from Dave Rolsky <autarch@urth.org> ----- Date: Tue, 9 Mar 2004 17:10:48 -0600 (CST) From: Dave Rolsky <autarch@urth.org> To: Tony Cook <tony@develop-help.com> cc: mason <mason-users@lists.sourceforge.net> Subject: Re: [Mason] Working with PerlMagick [now way OT] On Wed, 10 Mar 2004, Tony Cook wrote: Show quoted text
There's just no list of methods! Look at the SYNOPSIS, which references methods like "scale". But where is scale documented besides the synopsis? Basically, you need to list every method and exported constant/var (like %Imager::formats) and say what they do, what arguments they take, and what they return. A few quick examples is simply not sufficiient. It also needs a lot more high-level "here's how you do task X" type of documentation. Right now it's mostly very low-level, and doesn't make much sense unless you already know what the method you want is named. An Imager::Cookbook would be really helpful. Here's a list of things you could cover (taken from the Image Magick home page ;): Convert an image from one format to another (e.g. TIFF to JPEG) Resize, rotate, sharpen, color reduce, or add special effects to an image Create a montage of image thumbnails Create a transparent image suitable for use on the Web Turn a group of images into a GIF animation sequence Create a composite image by combining several separate images Draw shapes or text on an image Decorate an image with a border or frame Describe the format and characteristics of an image Obviously, Imager may not do all of these things, but I know it does some of those. That'd be a great start for a cookbook, I think. Browsing the rest of the Image Magick docs and example will probably give you more ideas for cookbook topics. -dave /*======================= House Absolute Consulting www.houseabsolute.com =======================*/ Show quoted text