Apache-Album

 view release on metacpan or  search on metacpan

README  view on Meta::CPAN


        Image   -> Bob_and_Jenny.jpg
        Caption -> Bob and Jenny       (the auto-generated caption)

        override in caption.txt
        Bob_and_Jenny.jpg: This is me with my sister <EM>Jenny</EM>.

      Here is a sample caption.txt file:

        <H1>My Birthday Party</H1>

        <center>This is me at my Birthday Party!.</center>

        __END__
        pieinface.gif: Here's me getting hit the face with a pie.
        john5.jpg: This is <A HREF="mailto:johndoe@nowhere.com">John</A>

    ThumbNail Types
      `ThumbNailUse' can either be set to "width" or "aspect". If
      `ThumbNailUse' is set to "width", thumbnails that need to be
      created will be `ThumbNailWidth' wide, and the height will be
      modified to keep the same aspect as the original image.

      If `ThumbNailUse' is set to "aspect", thumbnails that need to
      be created will be transformed by the value of
      `ThumbNailAspect'. `ThumbNailAspect' can be either a floating
      point number like 0.25 or it can be a ratio like 2 / 11.

      If an image file is updated, the corresponding thumbnail file
      will be updated the next time the page is accessed. In
      practice I have found that Netscape will used the cached
      images even if they are updated. I normally have to flush the
      cache and reload to see the new images.

      At any time you can `rm -f tn__*' in the
      `AlbumDir'/album_name/ directory, the next time the page is
      loaded all the thumbnails will be regenerated. (Naturally
      image names that start with tn__ should be renamed before
      placing them in the album directory.)

    ThumbSubDir
      If you want your thumbnails to be in a different directory
      than the original pictures, set `ThumbSubDir' which is the
      subdirectory the thumbnails will be created in and viewed
      from. (This could also be used to allow multiple sets of
      thumbnails).

    DefaultBrowserWidth
      A general number of how wide you want the final table to be,
      not an absolute number. If the next image would take it past
      this "invisible line", a new row is started.

    NumberOfColumns
      Instead of using DefaultBrowserWidth and a guess at the number
      of pixels, NumberOfColumns can be set to the maximum number of
      columns in a table. The default is 0 (which causes
      DefaultBrowserWidth to be used instead).

    BodyArgs
      This entire string is passed in the <BODY> tag. Useful for
      setting background images, background color, link colors, etc.
      If set in the httpd.conf file, you must put quotes around the
      value, and escape any quotes in the value. If this value is
      set in the .htaccess file, this is not necessary:

        In httpd.conf: PerlSetVar BodyArgs "BACKGROUND=gray.gif text=\"#FFFFFF\""
        In .htaccess : PerlSetVar BodyArgs BACKGROUND=gray.gif text="#FFFFFF"

    OutsideTableBorder
      This variable's value is passed to the outer table's BORDER
      attribute.

    InsideTablesBorder
      This variables's value is passed to all the inner table's
      BORDER attributes. Note that the name of the
      `InnerTablesBorder' has an 's' in it, as it modifes all the
      inner tables.

    Footer
      This text/html will placed at the bottom of the page after all
      the thumbnails, but before the end of the page. Useful for
      links back to a home page, mailto: tag, etc.

    EditMode
      Allows the user to create new albums and upload pictures.
      Obviously there are security implications here, so if EditMode
      is turned on that location should probably have some kind of
      security. Albums can share the same AlbumDir, so you can have
      something like:

      /albums - ReadOnly version, no security /albums_edit - Allow
      new album creation and picture uploads, require authentication

      both using the same AlbumDir.

    AllowFinalResize
      If this is set to true, the user will have 3 additional
      options when viewing the full sized picture. The thumbnail can
      still be selected to view the full picture, or Sm (Small), Med
      (Medium), or Lg(Large) can be selected to bring the picture
      down to fit better in a 640x480, 800x600, or 1024x758 screen.

    ReverseDirs
      When viewing albums, they will be sorted by name. If this is
      set to true the order will be reversed. (Useful if you want to
      use things like dates/months as the directory names, this will
      put the most recent albums first.

    ReversePics
      When viewing pictures, they will be sorted by name. If this is
      set to true, the order of the pictures will be reversed.

OTHER FEATURES
    For people with lots of bandwidth and memory, Apache::Album can
    generate a single page with all the full sized pictures (or all
    the Small(sm), Medium(med) or Large(lg) pictures if
    AllowFinalResize is turned on). This is enabled by passing
    ?all_full_images=sm|med|lg|full to the url of an album, for
    example:

      `http://your.web.server/albums/specific_album/?all_full_images



( run in 2.488 seconds using v1.01-cache-2.11-cpan-f56aa216473 )