pgsrc/Help%2FPhotoAlbumPlugin

   1 Date: Wed, 28 May 2008 19:06:37 +0200
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 Content-Type: application/x-phpwiki;
   4   pagename=Help%2FPhotoAlbumPlugin;
   5   flags="";
   6   markup=2;
   7   charset=iso-8859-1
   8 Content-Transfer-Encoding: binary
   9
  10 !!! Summary
  11 Makes an 'album' by displaying a set of photos listed in a text file
  12 with optional descriptions.
  13
  14 !!! Usage
  15 <verbatim>
  16 <?plugin PhotoAlbum
  17          src=http://server/textfile
  18          mode=[column|row]
  19          align=[center|left|right]
  20          desc=true
  21          sort=false
  22          height=100%
  23          width=100%
  24          weblocation=>false
  25 ?>
  26 </verbatim>
  27
  28 !!! Arguments
  29 _Only the ='src'= parameter is mandatory._
  30
  31 *src*:
  32   Url or local path to a CSV textfile which separates filename and
  33   description of each photo. Photos listed in the text file have to be in same
  34   directory as the file. Descriptions are optional.
  35   If the the local path points to a directory, is relative from PHPWIKI_DIR,
  36   and the main script is in PHPWIKI_DIR, weblocation must not be given, and
  37   all pictures from this directory are displayed.
  38
  39 *url*:
  40   defines the the webpath to the srcdir directory (formerly called weblocation)
  41
  42 *mode*:
  43   Specifies how the images are arranged.
  44
  45   * "normal" - Normal table which shows photos full-size
  46   * "thumbs" - WinXP thumbnail style
  47   * "tiles"  - WinXP tiles style
  48   * "list"   - WinXP list style
  49   * "slide"  - slideshow mode, needs javascript on client
  50
  51 *showdesc*:
  52   "none"   - No descriptions next to photos %%%
  53   "name"   - Only filename shown %%%
  54   "desc"   - Only description (from textfile) shown %%%
  55   "both"   - If no description found, then filename will be used %%%
  56
  57 *link*:
  58   true or false
  59   If true, each image will be hyperlinked to a page where the single
  60   photo will be shown full-size. Only works when mode != 'normal'
  61
  62 *align*:
  63   center|right|left. Default is ='center'=.
  64
  65 *desc*:
  66   Display any descriptions given in the text file. Default is true.
  67
  68 *sort*:
  69   Sort images by file name. By default the order in the text file is
  70   followed.
  71
  72 *bgcolor*:
  73   Default: #eae8e8  cell bgcolor (lightgrey)
  74
  75 *hlcolor*:
  76   Default: #c0c0ff  highlight color (lightblue)
  77
  78 *height*, *width*:
  79   Height and width are calculated compared to original metrics
  80   retrieved by [php-function:getimagesize] and can be absolute (50px)
  81   or a percentage (e.g. "50%").
  82
  83 *attrib*:
  84   attrib arg allows multiple attributes: attrib=sort,nowrap,alt
  85   'sort' sorts alphabetically, 'nowrap' for cells, 'alt' to use
  86   descs instead of filenames in image ALT-tags
  87
  88 *cellwidth*:
  89   cell (auto|equal|image|75|100%)
  90
  91   Width of cells in table. Either absolute value in pixels, HTML
  92   style percentage, "auto" (no special action), "equal" (where
  93   all columns are equally sized) or "image" (take height and
  94   width of the photo in that cell).
  95
  96 *tablewidth*: (Optional)
  97   table (75|100%)
  98
  99 *p*:    (Optional)
 100   "displaythissinglephoto.jpg" only
 101
 102 *h*: (Optional)
 103   "highlightcolorofthisphoto.jpg" only
 104
 105 !!! Examples
 106 !! Text file
 107 Possible content of a valid text file:
 108
 109 <verbatim>
 110 photo-01.jpg; My girlfriend and I
 111 photo-02.jpg
 112 christmas.gif; Merry Christmas!
 113 </verbatim>
 114
 115 !! Sample Albums
 116 local dir:
 117 <?plugin PhotoAlbum
 118          src="themes/Hawaiian/images/pictures/"
 119 ?>
 120 or via external url:
 121 <verbatim>
 122 <?plugin PhotoAlbum
 123          src="http://phpwiki.sourceforge.net/demo/themes/Hawaiian/images/pictures/PhotoAlbum.csv"
 124 </verbatim>
 125 ?>
 126
 127 [ /Slides ]
 128
 129 !!! Plugin Authors
 130 * [Ted Vinke|mailto:teddy@jouwfeestje.com] Original author
 131 * [Reini Urban|PhpWiki:ReiniUrban] local fs
 132 * [Thomas Harding|PhpWiki:ThomasHarding] slides and thumbs
 133
 134 ----
 135 [PhpWikiDocumentation] [WikiPlugin|Help:WikiPlugin]