pgsrc/PhotoAlbumPlugin

   1 Date: Sat, 4 Jan 2003 23:05:22 -0500
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.4)
   3 X-Rcs-Id: $Id: PhotoAlbumPlugin,v 1.2 2004-04-18 00:19:29 rurban Exp $
   4 Content-Type: application/x-phpwiki;
   5   pagename=PhotoAlbumPlugin;
   6   flags="";
   7   pgsrc_version="2 $Revision: 1.2 $";
   8   markup=2;
   9   charset=iso-8859-1
  10 Content-Transfer-Encoding: binary
  11
  12 !!! Summary
  13 Makes an 'album' by displaying a set of photos listed in a text file
  14 with optional descriptions.
  15
  16 !!! Usage
  17 <verbatim>
  18 <?plugin PhotoAlbum
  19          src=http://server/textfile
  20          mode=[column|row]
  21          align=[center|left|right]
  22          desc=true
  23          sort=false
  24          height=100%
  25          width=100%
  26          weblocation=>false
  27 ?>
  28 </verbatim>
  29
  30 !!! Arguments
  31 ''Only the ='src'= parameter is mandatory.''
  32
  33 __src__:
  34   Url or local path to a CSV textfile which separates filename and
  35   description of
  36   each photo. Photos listed in the text file have to be in same
  37   directory as the file. Descriptions are optional.
  38   If the the local path points to a directory, is relative from PHPWIKI_DIR,
  39   and the main script is in PHPWIKI_DIR, weblocation must not be given, and
  40   all pictures from this directory are displayed.
  41
  42 __weblocation__:
  43   Optional path if the src points to a local dir, and the links on the
  44   photos don't work.
  45
  46 __mode__:
  47   Specifies how the images are arranged, ='column'= means vertically,
  48   ='row'= means horizontally. Default is ='row'=.
  49
  50 __align__:
  51   Only applicable to column mode. Default is ='center'=.
  52
  53 __desc__:
  54   Display any descriptions given in the text file. Default is true.
  55
  56 __sort__:
  57   Sort images by file name. By default the order in the text file is
  58   followed.
  59
  60 __height__, __width__:
  61   Height and width are calculated compared to original metrics
  62   retrieved by [php-function:getimagesize] and can be absolute or a
  63   percentage (e.g. "50%").
  64
  65 !!! Examples
  66 !! Text file
  67 Possible content of a valid text file:
  68
  69 <verbatim>
  70 photo-01.jpg; My girlfriend and I
  71 photo-02.jpg
  72 christmas.gif; Merry Christmas!
  73 </verbatim>
  74
  75 !! Sample Album
  76 local dir:
  77 <?plugin PhotoAlbum
  78          src="themes/Hawaiian/images/pictures/"
  79 ?>
  80 or via external url:
  81 <verbatim>
  82 <?plugin PhotoAlbum
  83          src="http://phpwiki.sourceforge.net/demo/themes/Hawaiian/images/pictures/PhotoAlbum.csv"
  84 </verbatim>
  85 ?>
  86
  87 !!! Plugin Author
  88 [Ted Vinke|mailto:teddy@jouwfeestje.com] <teddy@jouwfeestje.com>
  89 ----
  90 PhpWikiDocumentation WikiPlugin