NP_gallery/tags/v0.95/gallery/templatetags.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
   2 <html xmlns="http://www.w3.org/1999/xhtml">\r
   3 <head>\r
   4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />\r
   5 <title>Untitled Document</title>\r
   6 </head>\r
   7 \r
   8 <body>\r
   9 <h3>Templates</h3>\r
  10 <p>The plugin is displayed using a template system very similar to nucleus skins and templates.</p>\r
  11 <p>The first step in the display is when the plugin calls the nucleus NPGallery skin. This provides the general look, ie banner, side menus, footers, whatever. The &lt;%gallery(link)%&gt; tag in the NPGallery skin is where the gallery page (list, album or picture) is displayed. To display the requested gallery page the appropriate gallery template is used. These templates are freely editable in the gallery admin area and are a powerful way to control how gallery is displayed</p>\r
  12 <p>In general, each template has a header, body and footer segment. With pages with repeated information such as thumbnails in an album, the header is displayed, followed by repitions of the body, then the footer. For example if we call the header H, the body B and footer F, an album page would be contructed H B B (repeated) B B F. Following is list of template tags and the information they represent</p>\r
  13 Gallery List: Displayed by &lt;%gallery(link)%&gt; and by clicking on Gallery in the breadcrumb<br/>\r
  14 <table>\r
  15   <thead>\r
  16     <tr>\r
  17       <th>Tag</th>\r
  18       <th>Description</th>\r
  19       <th>Section</th>\r
  20     </tr>\r
  21   </thead>\r
  22   <tbody>\r
  23     <tr>\r
  24       <td>breadcrumb</td>\r
  25       <td>Displays Breadcrumb navigation (in gallery list only the word Gallery)</td>\r
  26       <td>All</td>\r
  27     </tr>\r
  28     <tr>\r
  29       <td>sortbytitle</td>\r
  30       <td>Generates a <b>link</b> to display gallery list sorted by album title, ie &lt;a href=&quot;&lt;%sortbytitle%&gt;&quot;&gt;</td>\r
  31       <td>Header</td>\r
  32     </tr>\r
  33     <tr>\r
  34       <td>sortbydescription</td>\r
  35       <td>Generates a <b>link</b> to display gallery list sorted by album description.</td>\r
  36       <td>Header</td>\r
  37     </tr>\r
  38     <tr>\r
  39       <td>sortbyowner</td>\r
  40       <td>Generates a <b>link</b> to display gallery list sorted by album owner.</td>\r
  41       <td>Header</td>\r
  42     </tr>\r
  43     <tr>\r
  44       <td>sortbymodified</td>\r
  45       <td>Generates a <b>link</b> to display gallery list sorted by date last modified.</td>\r
  46       <td>Header</td>\r
  47     </tr>\r
  48     <tr>\r
  49       <td>sortbynumber</td>\r
  50       <td>Generates a <b>link</b> to display gallery list sorted by number of images in album.</td>\r
  51       <td>Header</td>\r
  52     </tr>\r
  53     <tr>\r
  54       <td>albumlink</td>\r
  55       <td><b>link</b> to album</td>\r
  56       <td>Body</td>\r
  57     </tr>\r
  58     <tr>\r
  59       <td>albumthumbnail</td>\r
  60       <td>absolute reference to the album thumbnail (assignable in admin area|gallery|configuration). Usage: &lt;img src=&quot;&lt;%albumthumbnail%&gt;&quot; /&gt;</td>\r
  61       <td>Body</td>\r
  62     </tr>\r
  63     <tr>\r
  64       <td>centeredtopmargin(height,adjustment)</td>\r
  65       <td>CSS inline style used to vertically align thumbnail (if using albumthumbnail). Height is the height of the thumbnail container, adjustment is a number: a negative value to shift the thumbnail up, positive to shift down. Used to make space for text under thumbnail. Usage: </td>\r
  66       <td>Body</td>\r
  67     </tr>\r
  68     <tr>\r
  69       <td>title</td>\r
  70       <td></td>\r
  71       <td>Body</td>\r
  72     </tr>\r
  73     <tr>\r
  74       <td>description</td>\r
  75       <td></td>\r
  76       <td>Body</td>\r
  77     </tr>\r
  78     <tr>\r
  79       <td>ownerid</td>\r
  80       <td></td>\r
  81       <td>Body</td>\r
  82     </tr>\r
  83     <tr>\r
  84       <td>ownername</td>\r
  85       <td></td>\r
  86       <td>Body</td>\r
  87     </tr>\r
  88     <tr>\r
  89       <td>modified</td>\r
  90       <td></td>\r
  91       <td>Body</td>\r
  92     </tr>\r
  93     <tr>\r
  94       <td>numberofimages</td>\r
  95       <td></td>\r
  96       <td>Body</td>\r
  97     </tr>\r
  98     <tr>\r
  99       <td>addalbumlink</td>\r
 100       <td></td>\r
 101       <td>H/F</td>\r
 102     </tr>\r
 103     <tr>\r
 104       <td>addpictureslink</td>\r
 105       <td></td>\r
 106       <td>H/F</td>\r
 107     </tr>\r
 108     <tr>\r
 109       <td>if(canaddpicture)</td>\r
 110       <td></td>\r
 111       <td>All</td>\r
 112     </tr>\r
 113     <tr>\r
 114       <td>if(canaddalbum)</td>\r
 115       <td></td>\r
 116       <td>All</td>\r
 117     </tr>\r
 118   </tbody>\r
 119 </table>\r
 120 <br/>\r
 121 Album: Displayed by clicking on album link in gallery list<br/>\r
 122 <table>\r
 123   <thead>\r
 124     <tr>\r
 125       <th>Tag</th>\r
 126       <th>Description</th>\r
 127       <th>Section</th>\r
 128     </tr>\r
 129   </thead>\r
 130   <tbody>\r
 131     <tr>\r
 132       <td>breadcrumb(sep)</td>\r
 133       <td>Displays Breadcrumb navigation with the specified seperator, default is &gt;. For example to change the breadcrumb to Gallery -&gt; Album change the tag to &lt;%breadcrumb(-&gt;)%&gt;</td>\r
 134       <td>All</td>\r
 135     </tr>\r
 136     <tr>\r
 137       <td>albumtitle</td>\r
 138       <td></td>\r
 139       <td></td>\r
 140     </tr>\r
 141     <tr>\r
 142       <td>albumdescription</td>\r
 143       <td></td>\r
 144       <td></td>\r
 145     </tr>\r
 146     <tr>\r
 147       <td>picturedescription</td>\r
 148       <td></td>\r
 149       <td></td>\r
 150     </tr>\r
 151     <tr>\r
 152       <td>picturelink</td>\r
 153       <td></td>\r
 154       <td></td>\r
 155     </tr>\r
 156     <tr>\r
 157       <td>thumbnail</td>\r
 158       <td></td>\r
 159       <td></td>\r
 160     </tr>\r
 161     <tr>\r
 162       <td>centeredtopmargin</td>\r
 163       <td></td>\r
 164       <td></td>\r
 165     </tr>\r
 166     <tr>\r
 167       <td>pictureviews</td>\r
 168       <td></td>\r
 169       <td></td>\r
 170     </tr>\r
 171     <tr>\r
 172       <td>editalbumlink</td>\r
 173       <td></td>\r
 174       <td></td>\r
 175     </tr>\r
 176     <tr>\r
 177       <td>addpicturelink</td>\r
 178       <td></td>\r
 179       <td></td>\r
 180     </tr>\r
 181     <tr>\r
 182       <td>picturetitle</td>\r
 183       <td></td>\r
 184       <td></td>\r
 185     </tr>\r
 186     <tr>\r
 187       <td>pages</td>\r
 188       <td></td>\r
 189       <td></td>\r
 190     </tr>\r
 191     <tr>\r
 192       <td>albumlink</td>\r
 193       <td></td>\r
 194       <td></td>\r
 195     </tr>\r
 196     <tr>\r
 197       <td>if(canaddpicture)</td>\r
 198       <td></td>\r
 199       <td></td>\r
 200     </tr>\r
 201     <tr>\r
 202       <td>if(caneditalbum)</td>\r
 203       <td></td>\r
 204       <td></td>\r
 205     </tr>\r
 206   </tbody>\r
 207 </table>\r
 208 <br/>\r
 209 Picture: Displayed by clicking on thumbnail in album<br/>\r
 210 <table>\r
 211   <thead>\r
 212     <tr>\r
 213       <th>Tag</th>\r
 214       <th>Description</th>\r
 215       <th>Section</th>\r
 216     </tr>\r
 217   </thead>\r
 218   <tbody>\r
 219     <tr>\r
 220       <td>breadcrumb(sep)</td>\r
 221       <td>Displays Breadcrumb navigation with the specified seperator, default is &gt;. For example to change the breadcrumb to Gallery -&gt; Album change the tag to &lt;%breadcrumb(-&gt;)%&gt;</td>\r
 222       <td>All</td>\r
 223     </tr>\r
 224     <tr>\r
 225       <td>albumlink</td>\r
 226       <td></td>\r
 227       <td></td>\r
 228     </tr>\r
 229     <tr>\r
 230       <td>albumtitle</td>\r
 231       <td></td>\r
 232       <td></td>\r
 233     </tr>\r
 234     <tr>\r
 235       <td>description</td>\r
 236       <td></td>\r
 237       <td></td>\r
 238     </tr>\r
 239     <tr>\r
 240       <td>fullsizelink</td>\r
 241       <td></td>\r
 242       <td></td>\r
 243     </tr>\r
 244     <tr>\r
 245       <td>intermediatepicture</td>\r
 246       <td></td>\r
 247       <td></td>\r
 248     </tr>\r
 249     <tr>\r
 250       <td>title</td>\r
 251       <td></td>\r
 252       <td></td>\r
 253     </tr>\r
 254     <tr>\r
 255       <td>height</td>\r
 256       <td></td>\r
 257       <td></td>\r
 258     </tr>\r
 259     <tr>\r
 260       <td>width</td>\r
 261       <td></td>\r
 262       <td></td>\r
 263     </tr>\r
 264     <tr>\r
 265       <td>owner</td>\r
 266       <td></td>\r
 267       <td></td>\r
 268     </tr>\r
 269     <tr>\r
 270       <td>date</td>\r
 271       <td></td>\r
 272       <td></td>\r
 273     </tr>\r
 274     <tr>\r
 275       <td>editpicturelink</td>\r
 276       <td></td>\r
 277       <td></td>\r
 278     </tr>\r
 279     <tr>\r
 280       <td>deletepicturelink</td>\r
 281       <td></td>\r
 282       <td></td>\r
 283     </tr>\r
 284     <tr>\r
 285       <td>nextlink</td>\r
 286       <td></td>\r
 287       <td></td>\r
 288     </tr>\r
 289     <tr>\r
 290       <td>previouslink</td>\r
 291       <td></td>\r
 292       <td></td>\r
 293     </tr>\r
 294     <tr>\r
 295       <td>comments</td>\r
 296       <td></td>\r
 297       <td></td>\r
 298     </tr>\r
 299     <tr>\r
 300       <td>commentform</td>\r
 301       <td></td>\r
 302       <td></td>\r
 303     </tr>\r
 304     <tr>\r
 305       <td>if(caneditpicture)</td>\r
 306       <td></td>\r
 307       <td></td>\r
 308     </tr>\r
 309     <tr>\r
 310       <td>if(commentsallowed)</td>\r
 311       <td></td>\r
 312       <td></td>\r
 313     </tr>\r
 314     <tr>\r
 315       <td>if(next)</td>\r
 316       <td></td>\r
 317       <td></td>\r
 318     </tr>\r
 319     <tr>\r
 320       <td>if(prev)</td>\r
 321       <td><p>&nbsp;</p></td>\r
 322       <td></td>\r
 323     </tr>\r
 324   </tbody>\r
 325 </table>\r
 326 <br/>\r
 327 Comments<br/>\r
 328 <table>\r
 329   <thead>\r
 330     <tr>\r
 331       <th>Tag</th>\r
 332       <th>Description</th>\r
 333       <th>Section</th>\r
 334     </tr>\r
 335   </thead>\r
 336   <tbody>\r
 337     <tr>\r
 338       <td></td>\r
 339       <td></td>\r
 340       <td></td>\r
 341     </tr>\r
 342     <tr>\r
 343       <td></td>\r
 344       <td></td>\r
 345       <td></td>\r
 346     </tr>\r
 347   </tbody>\r
 348 </table>\r
 349 <br/>\r
 350 Promo post template<br/>\r
 351 <table>\r
 352   <thead>\r
 353     <tr>\r
 354       <th>Tag</th>\r
 355       <th>Description</th>\r
 356       <th>Section</th>\r
 357     </tr>\r
 358   </thead>\r
 359   <tbody>\r
 360   </tbody>\r
 361 </table>\r
 362 <h3><a name="version" id="version"></a>Version History</h3>\r
 363 <ul>\r
 364   <li>Version 0.1: initial testcaseversion</li>\r
 365   <li>Version 0.0: pre-initial version ;-)</li>\r
 366 </ul>\r
 367 </body>\r
 368 </html>\r