pgsrc/Help%2FPhotoAlbumPlugin

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