Help/PhotoAlbumPlugin

The PhotoAlbum plugin makes an 'album' by displaying a set of photos listed in a text file with optional descriptions.

Usage

<<PhotoAlbum
         src=http://server/textfile
         mode=[column|row]
         align=[center|left|right]
         desc=true
         sort=false
         height=100%
         width=100%
>>

Arguments

Only the src parameter is required.

Argument

Description

Default value

src

Url or local path to a CSV textfile which separates filename and description of each photo. Photos listed in the text file have to be in same directory as the file. Descriptions are optional.

If the local path points to a directory, is relative from PHPWIKI_DIR, and the main script is in PHPWIKI_DIR, url must not be given, and all pictures from this directory are displayed.

url

Defines the webpath to the srcdir directory

mode

Specifies how the images are arranged.

  • "normal" - Normal table which shows photos full-size
  • "thumbs" - WinXP thumbnail style
  • "tiles" - WinXP tiles style
  • "list" - WinXP list style
  • "row" - inline thumbnails
  • "column" - photos full-size, displayed in 1 column
  • "slide" - slideshow mode, needs Javascript on client

normal

numcols

photos per row, columns

3

showdesc

  • "none" - No descriptions next to photos
  • "name" - Only filename shown
  • "desc" - Only description (from textfile) shown
  • "both" - If no description found, then filename will be used

both

link

true or false

If true, each image will be hyperlinked to a page where the single photo will be shown full-size. Only works when mode != 'normal'

true

attrib

attrib arg allows multiple attributes: attrib=sort,nowrap,alt

  • "sort" sorts alphabetically,
  • "nowrap" for cells,
  • "alt" to use descs instead of filenames in image ALT-tags

align

center, right or left

center

desc

Display any descriptions given in the text file

true

sort

Sort images by file name

By default the order in the text file is followed

bgcolor

cell bgcolor

#eae8e8 (lightgrey)

hlcolor

highlight color

#c0c0ff (lightblue)

height, width

Height and width are calculated compared to original metrics retrieved by php-function:getimagesize and can be absolute (50px) or a percentage (e.g. "50%").

attrib

attrib arg allows multiple attributes: attrib=sort,nowrap,alt 'sort' sorts alphabetically, 'nowrap' for cells, 'alt' to use descs instead of filenames in image ALT-tags

cellwidth

cell (auto|equal|image|75|100%)

Width of cells in table. Either absolute value in pixels, HTML style percentage, "auto" (no special action), "equal" (where all columns are equally sized) or "image" (take height and width of the photo in that cell).

tablewidth

table (75|100%)

false

p

"displaythissinglephoto.jpg" only

false

h

"highlightcolorofthisphoto.jpg" only

false

duration

in slide mode, duration in seconds

6

thumbswidth

width of thumbnails

80

Examples

Text file

Possible content of a valid text file:

photo-01.jpg; My girlfriend and I
photo-02.jpg
christmas.gif; Merry Christmas!

Sample Albums

local dir:

<<PhotoAlbum
         src="themes/Hawaiian/images/pictures/"
         mode=slide
         duration=1
>>
BeachPalmDusk.jpg

BeachPalmDusk.jpg

Coastline.jpg

Coastline.jpg

HawaiiMauiFromSpace.jpg

HawaiiMauiFromSpace.jpg

LavaTwilight.jpg

LavaTwilight.jpg

LoihiSeamount.jpg

LoihiSeamount.jpg

SteamVolcanoDusk.jpg

SteamVolcanoDusk.jpg

SubmersiblePiscesV.jpg

SubmersiblePiscesV.jpg

SwimmingPoolWater.jpg

SwimmingPoolWater.jpg

Waterfall.jpg

Waterfall.jpg

WhaleRainbow.jpg

WhaleRainbow.jpg

or via external URL:

<<PhotoAlbum
src="http://phpwiki.demo.free.fr/themes/Hawaiian/images/pictures/PhotoAlbum.csv"
mode=tiles
>>
WhaleRainbow.jpg

205 x 256 pixels
SwimmingPoolWater.jpg

171 x 256 pixels
Waterfall.jpg

170 x 256 pixels
LavaTwilight.jpg

168 x 256 pixels
SubmersiblePiscesV.jpg

256 x 174 pixels
SteamVolcanoDusk.jpg

256 x 170 pixels
LoihiSeamount.jpg

256 x 169 pixels
HawaiiMauiFromSpace.jpg
Coastline.jpg

256 x 206 pixels
BeachPalmDusk.jpg

256 x 168 pixels

Authors