pgsrc/Help%2FPhotoAlbumPlugin

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