/[drupal]/contributions/modules/acidfree/README
ViewVC logotype

Contents of /contributions/modules/acidfree/README

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.13 - (show annotations) (download)
Sun Nov 26 14:07:40 2006 UTC (3 years ago) by vhmauery
Branch: MAIN
CVS Tags: HEAD
Branch point for: DRUPAL-5, DRUPAL-6--1
Changes since 1.12: +10 -22 lines
updated documentation
modified UPGRADE for 4.7->5.0 transition
modified README for 5.0
modified acidfree/test for 5.0
1 /* $Id: README,v 1.12 2006/09/14 22:09:01 vhmauery Exp $ */
2
3 Acidfree Albums
4 Author - Vernon Mauery <vernon At mauery d0t com>
5 Copyright 2005 Vernon Mauery
6 Licensed under the GPL v2.0
7
8 About
9 -----------------------------
10 Acidfree albums were designed with simplicity in mind. There are as many
11 web based photo albums as there are people with digital pictures, yet when
12 Acidfree albums were written, they all were found lacking. Some were too
13 fancy, others were too ugly, and others (gasp!) were not even written in php.
14
15 To this end, Acidfree albums were created. This version is the fourth revision
16 of the albums. While functionally the same in each version, this is the first
17 modular enough to be easily distributed and used by others. Previous versions
18 have been in use by websites for several years now, but tailoring them into the
19 various websites was not easy. But then I found Drupal and fell in love with
20 it. But it too was missing a good photo album. So here it is.
21
22 Features
23 -----------------------------
24 * easy to install (well it was for me, but others may report differently)
25 * very configurable via the various admin venues
26 * node based -- tied into Drupal's core
27 * full featured, yet simple
28 * uses Image, Video, Taxonomy, and Views modules
29 * fully themeable
30 * best darn looking photo album you have ever seen
31 * handles images using Drupal's image toolkit
32 * can handle most video types (with different thumbnail options)
33 * handles node_access grants gracefully (think Organic Groups)
34 * has a built in filter for adding images to other node content
35 with tags like [acidfree:nnnn...] (see instructions below)
36
37 Install
38 -----------------------------
39 1. install the Views module
40 2. enable Views and Taxonomy modules
41 3. for image albums, enable the Image module and make sure settings are correct
42 (this includes setting the appropriate paths at admin/settings/file-system
43 and admin/settings/image)
44 2. untar acidfree directory into your modules directory
45 3. enable the acidfree module on the admin/build/modules page
46 4. go to http://yoursite.dom/acidfree/test (or
47 http://yoursite.dom/?q=acidfree/test) to check your install and settings.
48 Follow any instructions it offers.
49 5. create albums and content!!
50
51 Advanced Options
52 -----------------------------
53 Acidfree has a filter so you can add thumbnails of your images to the body
54 of other nodes with a tag like [acidfree:nnnn ...]. Before using this feature,
55 you must enable it by going to Administer -> Input Formats (admin/filters) and
56 configure each input type you want to have the [acidfree:nnnn] tags in. Hit
57 configure for the type (e.g. admin/filters/1) and check the box by
58 Acidfree Inline Filter. Hit save and you will see
59 'You may use [acidfree:xx] tags to display acidfree videos or images inline.'
60 in the 'Formatting guidelines' section on the node edit pages. Read the online
61 documentation at http://vernon.mauery.com/content/acidfree_manual/advanced_topics
62 or the inline help provided by your installed acidfree/drupal site.
63
64 Now that Acidfree uses the drupal image toolkit to do its image processing, you
65 can use whatever toolkit you desire. I have written one that works with
66 php-imagick (libMagick for php) which uses the same libraries ImageMagick does,
67 but without needing to fork and exec a new process. To use it, install the
68 php-imagick libraries, enable them in the php.ini file and copy the
69 image.imagick.inc file to the drupal includes directory and select it from the
70 admin/settings image manipulation section. Another option for this is the
71 image.imagemagick.inc file that is distributed with the image.module. If you
72 like the forky-execy method and don't want to install php-imagick or set up gd
73 (which is th e default toolkit), you can use the binaries you used with
74 previous versions of Acidfree with the ImageMagick toolkit.
75
76 Of course, Acidfree also offers the option for lossless jpeg rotation via
77 exiftran or jpegtran. Set the path of your preferred option in
78 admin/settings/acidfree and Acidfree will use it to rotate images instead of
79 the image toolkit option. This is provided for all you jpeg artifact snobs
80 (myself included.)
81
82 Better mime handling (hopefully). We can use PECL's fileinfo extension (for
83 those fearful of exec'ing `file -ib`), file -ib, or a guess based on file
84 extensions recognized by Acidfree. Take your pick. Acidfree will automatically
85 use its best guess depending on which options it can find and use. No setup
86 required (unless you are using fileinfo extension and then you obviously have
87 to install it and enable it in php.ini)

  ViewVC Help
Powered by ViewVC 1.1.2