pgsrc/Help%2FPhotoAlbumPlugin

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