View Source: Help/PhotoAlbumPlugin

Note: You are viewing an old revision of this page. View the current version.
The **~PhotoAlbum** [[Help:WikiPlugin|plugin]] makes an 'album' by displaying a set of photos listed in a text file with optional descriptions.

== Usage ==

{{{
<<PhotoAlbum arguments>>
}}}

== Arguments ==

Only the ##src## parameter is required.

{| class="bordered"
|-
! 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.
| //empty//
|-
| **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**
|
Boolean. If true, each image will be hyperlinked to a page where
the single photo will be shown full-size. Only works when mode
is different from '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
|-
| **bgcolor**
| Cell background color
| #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
>>
}}}

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

or via external URL:
{{{
<<PhotoAlbum
src="http://phpwiki.demo.free.fr/themes/Hawaiian/images/pictures/PhotoAlbum.csv"
mode=tiles
>>
}}}

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

== Authors ==

* [[mailto:teddy@jouwfeestje.com|Ted Vinke]]: original author
* [[Help:Reini Urban|Reini Urban]]: local fs
* Thomas Harding: slides and thumbs

<noinclude>
----
[[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
</noinclude>
View Source: Help/PhotoAlbumPlugin

Search
