pgsrc/Help%2FPhotoAlbumPlugin

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