<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link rel="home" title="HomePage" href="HomePage.html" />
<link rel="help" title="HowToUseWiki" href="HowToUseWiki.html" />
<link rel="copyright" title="GNU General Public License" href="http://www.gnu.org/copyleft/gpl.html#SEC1" />
<link rel="author" title="The PhpWiki Programming Team" href="http://phpwiki.org/ThePhpWikiProgrammingTeam" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-Language" content="en" />
<meta name="robots" content="noindex,nofollow" />
<meta name="language" content="en" />
<meta name="document-type" content="Public" />
<meta name="document-rating" content="General" />
<meta name="generator" content="PhpWiki" />
<meta name="PHPWIKI_VERSION" content="1.3.14" />

<base href="../" />
<link rel="stylesheet" type="text/css" charset="iso-8859-1" href="phpwiki-printer.css" />
<title>PhpWiki - Help  /  Photo Album Plugin</title>
</head>
<body>

<div id="header">
  
<!-- Page title -->
<h1>Help  /  Photo Album Plugin</h1>
</div>
<div id="content">



<div class="wikitext"><h2>Summary</h2>
<p class="tightenable top">Makes an 'album' by displaying a set of photos listed in a text file
with optional descriptions.</p>
<h2>Usage</h2>
<pre class="tightenable top">
&lt;?plugin PhotoAlbum
         src=http://server/textfile
         mode=[column|row]
         align=[center|left|right]
         desc=true
         sort=false
         height=100%
         width=100%
         weblocation=&gt;false
?&gt;</pre>
<h2>Arguments</h2>
<p class="tightenable top"><i>Only the <tt>'src'</tt> parameter is mandatory.</i></p>
<dl><dt class="tightenable bottom"><b>src</b></dt>
<dd class="tightenable top">Url or local path to a CSV textfile which separates filename and
description of each photo. Photos listed in the text file have to be in same
directory as the file. Descriptions are optional.
If the the local path points to a directory, is relative from PHPWIKI_DIR,
and the main script is in PHPWIKI_DIR, weblocation must not be given, and
all pictures from this directory are displayed.</dd>
<dt class="tightenable bottom"><b>url</b></dt>
<dd class="tightenable top">defines the the webpath to the srcdir directory (formerly called weblocation)</dd>
<dt class="tightenable bottom"><b>mode</b></dt>
<dd class="tightenable top"><p class="tightenable top">Specifies how the images are arranged.</p>
<ul><li class="tightenable bottom">&quot;normal&quot; - Normal table which shows photos full-size</li>
<li class="tightenable top bottom">&quot;thumbs&quot; - WinXP thumbnail style</li>
<li class="tightenable top bottom">&quot;tiles&quot;  - WinXP tiles style</li>
<li class="tightenable top bottom">&quot;list&quot;   - WinXP list style</li>
<li class="tightenable top bottom">&quot;slide&quot;  - slideshow mode, needs javascript on client</li>
</ul>
</dd>
<dt class="tightenable bottom"><b>showdesc</b></dt>
<dd class="tightenable top">&quot;none&quot;   - No descriptions next to photos <br />
&quot;name&quot;   - Only filename shown <br />
&quot;desc&quot;   - Only description (from textfile) shown <br />
&quot;both&quot;   - If no description found, then filename will be used <br /></dd>
<dt class="tightenable bottom"><b>link</b></dt>
<dd class="tightenable top">true or false
If true, each image will be hyperlinked to a page where the single
photo will be shown full-size. Only works when mode != 'normal'</dd>
<dt class="tightenable bottom"><b>align</b></dt>
<dd class="tightenable top">center|right|left. Default is <tt>'center'</tt>.</dd>
<dt class="tightenable bottom"><b>desc</b></dt>
<dd class="tightenable top">Display any descriptions given in the text file. Default is true.</dd>
<dt class="tightenable bottom"><b>sort</b></dt>
<dd class="tightenable top">Sort images by file name. By default the order in the text file is
followed.</dd>
<dt class="tightenable bottom"><b>bgcolor</b></dt>
<dd class="tightenable top">Default: #eae8e8  cell bgcolor (lightgrey)</dd>
<dt class="tightenable bottom"><b>hlcolor</b></dt>
<dd class="tightenable top">Default: #c0c0ff  highlight color (lightblue)</dd>
<dt class="tightenable bottom"><b>height</b>, <b>width</b></dt>
<dd class="tightenable top">Height and width are calculated compared to original metrics
retrieved by <a href="http://www.php.net/getimagesize" class="interwiki"><span style="white-space: nowrap"><img src="images/interwiki.png" alt="" class="linkicon" border="0" />php-function:</span><span class="wikipage">getimagesize</span></a> and can be absolute (50px)
or a percentage (e.g. &quot;50%&quot;).</dd>
<dt class="tightenable bottom"><b>attrib</b></dt>
<dd class="tightenable top">attrib arg allows multiple attributes: attrib=sort,nowrap,alt
'sort' sorts alphabetically, 'nowrap' for cells, 'alt' to use
descs instead of filenames in image ALT-tags</dd>
<dt class="tightenable bottom"><b>cellwidth</b></dt>
<dd class="tightenable top"><p class="tightenable top">cell (auto|equal|image|75|100%)</p>
<p class="tightenable bottom">Width of cells in table. Either absolute value in pixels, HTML
style percentage, &quot;auto&quot; (no special action), &quot;equal&quot; (where
all columns are equally sized) or &quot;image&quot; (take height and
width of the photo in that cell).</p>
</dd>
</dl>
<p class="tightenable bottom"><b>tablewidth</b>: (Optional)</p>
<blockquote class="tightenable top"><p class="tightenable top bottom">table (75|100%)</p>
</blockquote>
<p class="tightenable bottom"><b>p</b>:    (Optional)</p>
<blockquote class="tightenable top"><p class="tightenable top bottom">&quot;displaythissinglephoto.jpg&quot; only</p>
</blockquote>
<p class="tightenable bottom"><b>h</b>: (Optional)</p>
<blockquote class="tightenable top"><p class="tightenable top bottom">&quot;highlightcolorofthisphoto.jpg&quot; only</p>
</blockquote>
<h2>Examples</h2>
<h3>Text file</h3>
<p class="tightenable top">Possible content of a valid text file:</p>
<pre class="tightenable">
photo-01.jpg; My girlfriend and I
photo-02.jpg
christmas.gif; Merry Christmas!</pre>
<h3>Sample Albums</h3>
<p class="tightenable top bottom">local dir:</p>
<span class="plugin" id="PhotoAlbumPlugin"><div align="center"><table border="0" cellpadding="5" cellspacing="2" class="photoalbum" width="100%">
<tr>
<td align="center" valign="top" class="photoalbum cell" bgcolor="#eae8e8" width="auto"><a id="BeachPalmDusk.jpg"><a href="Help/PhotoAlbumPlugin.html?p=BeachPalmDusk.jpg#BeachPalmDusk.jpg"><img src="/phpwiki/themes/Hawaiian/images/pictures//BeachPalmDusk.jpg" border="0" alt="BeachPalmDusk.jpg" /></a></a><span class="gensmall"><p>BeachPalmDusk.jpg</p>
</span></td>
<td align="center" valign="top" class="photoalbum cell" bgcolor="#eae8e8" width="auto"><a id="Coastline.jpg"><a href="Help/PhotoAlbumPlugin.html?p=Coastline.jpg#Coastline.jpg"><img src="/phpwiki/themes/Hawaiian/images/pictures//Coastline.jpg" border="0" alt="Coastline.jpg" /></a></a><span class="gensmall"><p>Coastline.jpg</p>
</span></td>
<td align="center" valign="top" class="photoalbum cell" bgcolor="#eae8e8" width="auto"><a id="HawaiiMauiFromSpace.jpg"><a href="Help/PhotoAlbumPlugin.html?p=HawaiiMauiFromSpace.jpg#HawaiiMauiFromSpace.jpg"><img src="/phpwiki/themes/Hawaiian/images/pictures//HawaiiMauiFromSpace.jpg" border="0" alt="HawaiiMauiFromSpace.jpg" /></a></a><span class="gensmall"><p>HawaiiMauiFromSpace.jpg</p>
</span></td>
</tr>
<tr>
<td align="center" valign="top" class="photoalbum cell" bgcolor="#eae8e8" width="auto"><a id="LavaTwilight.jpg"><a href="Help/PhotoAlbumPlugin.html?p=LavaTwilight.jpg#LavaTwilight.jpg"><img src="/phpwiki/themes/Hawaiian/images/pictures//LavaTwilight.jpg" border="0" alt="LavaTwilight.jpg" /></a></a><span class="gensmall"><p>LavaTwilight.jpg</p>
</span></td>
<td align="center" valign="top" class="photoalbum cell" bgcolor="#eae8e8" width="auto"><a id="LoihiSeamount.jpg"><a href="Help/PhotoAlbumPlugin.html?p=LoihiSeamount.jpg#LoihiSeamount.jpg"><img src="/phpwiki/themes/Hawaiian/images/pictures//LoihiSeamount.jpg" border="0" alt="LoihiSeamount.jpg" /></a></a><span class="gensmall"><p>LoihiSeamount.jpg</p>
</span></td>
<td align="center" valign="top" class="photoalbum cell" bgcolor="#eae8e8" width="auto"><a id="SteamVolcanoDusk.jpg"><a href="Help/PhotoAlbumPlugin.html?p=SteamVolcanoDusk.jpg#SteamVolcanoDusk.jpg"><img src="/phpwiki/themes/Hawaiian/images/pictures//SteamVolcanoDusk.jpg" border="0" alt="SteamVolcanoDusk.jpg" /></a></a><span class="gensmall"><p>SteamVolcanoDusk.jpg</p>
</span></td>
</tr>
<tr>
<td align="center" valign="top" class="photoalbum cell" bgcolor="#eae8e8" width="auto"><a id="SubmersiblePiscesV.jpg"><a href="Help/PhotoAlbumPlugin.html?p=SubmersiblePiscesV.jpg#SubmersiblePiscesV.jpg"><img src="/phpwiki/themes/Hawaiian/images/pictures//SubmersiblePiscesV.jpg" border="0" alt="SubmersiblePiscesV.jpg" /></a></a><span class="gensmall"><p>SubmersiblePiscesV.jpg</p>
</span></td>
<td align="center" valign="top" class="photoalbum cell" bgcolor="#eae8e8" width="auto"><a id="SwimmingPoolWater.jpg"><a href="Help/PhotoAlbumPlugin.html?p=SwimmingPoolWater.jpg#SwimmingPoolWater.jpg"><img src="/phpwiki/themes/Hawaiian/images/pictures//SwimmingPoolWater.jpg" border="0" alt="SwimmingPoolWater.jpg" /></a></a><span class="gensmall"><p>SwimmingPoolWater.jpg</p>
</span></td>
<td align="center" valign="top" class="photoalbum cell" bgcolor="#eae8e8" width="auto"><a id="Waterfall.jpg"><a href="Help/PhotoAlbumPlugin.html?p=Waterfall.jpg#Waterfall.jpg"><img src="/phpwiki/themes/Hawaiian/images/pictures//Waterfall.jpg" border="0" alt="Waterfall.jpg" /></a></a><span class="gensmall"><p>Waterfall.jpg</p>
</span></td>
</tr>
<tr>
<td align="center" valign="top" class="photoalbum cell" bgcolor="#eae8e8" width="auto"><a id="WhaleRainbow.jpg"><a href="Help/PhotoAlbumPlugin.html?p=WhaleRainbow.jpg#WhaleRainbow.jpg"><img src="/phpwiki/themes/Hawaiian/images/pictures//WhaleRainbow.jpg" border="0" alt="WhaleRainbow.jpg" /></a></a><span class="gensmall"><p>WhaleRainbow.jpg</p>
</span></td>
</tr>
</table>
</div>
</span><p class="tightenable top bottom">or via external url:</p>
<pre class="tightenable top bottom">
&lt;?plugin PhotoAlbum
         src=&quot;http://phpwiki.sourceforge.net/demo/themes/Hawaiian/images/pictures/PhotoAlbum.csv&quot;</pre>
<p class="tightenable top">?&gt;</p>
<p class="tightenable"><a href="Help/PhotoAlbumPlugin/Slides.html" class="wiki">/Slides</a></p>
<h2>Plugin Authors</h2>
<ul><li class="tightenable top bottom"><a href="mailto:teddy@jouwfeestje.com" target="" class="namedurl"><span style="white-space: nowrap"><img src="images/mailto.png" alt="" class="linkicon" border="0" />Ted</span> Vinke</a> Original author</li>
<li class="tightenable top bottom"><a href="http://phpwiki.sourceforge.net/phpwiki/ReiniUrban" class="named-interwiki"><span style="white-space: nowrap"><img src="images/interwiki.png" alt="" class="linkicon" border="0" />ReiniUrban</span></a> local fs</li>
<li class="tightenable top"><a href="http://phpwiki.sourceforge.net/phpwiki/ThomasHarding" class="named-interwiki"><span style="white-space: nowrap"><img src="images/interwiki.png" alt="" class="linkicon" border="0" />ThomasHarding</span></a> slides and thumbs</li>
</ul>
<hr />
<p class="tightenable top bottom"><a href="PhpWikiDocumentation.html" class="wiki">PhpWikiDocumentation</a> <a href="Help/WikiPlugin" class="interwiki"><span style="white-space: nowrap"><img src="images/interwiki.png" alt="" class="linkicon" border="0" />Help:</span><span class="wikipage">WikiPlugin</span></a></p>
</div>

<div id="footer">  <hr class="printer" noshade="noshade" />
<p class="editdate">Owner: &quot;admin&quot;  Last edited on August 14, 2007  7:11 am by &quot;The PhpWiki programming team&quot;</p>
</div>

</div>
<!-- Add your Disclaimer here -->
</body>
</html>
