HTMLGenerator/theme-syntax.h

   1 /**
   2    \page html-themes HTML themes
   3
   4    Static web pages can be generated with selectable sized images.
   5    HTMLGenerator allows using of themes to produce differently styled web
   6    pages.
   7
   8    Themes use template files that are used as basis for static HTML files.
   9    There are currently two template files used:
  10    \li mainpage.html
  11    \li imagepage.html
  12
  13    Maingpage is used to generate index.html and image size specific index
  14    pages ( index-800x600.html ). imagepage.html is used to create one HTML
  15    page for each image and for each requested image size.
  16
  17    Any other files within a theme directory are copied as is to the target
  18    web page. This way javascript, style files and theme specific images can
  19    easily be used.
  20
  21    One more file included in a theme is file called kphotoalbum.theme. This
  22    file contains information about the theme author and theme name.
  23
  24    <h2>Mainpage</h2>
  25    Template file mainpage.html can use the following tags that are then
  26    repplaced by KPA   with export specific data:
  27    \li **DESCRIPTION**
  28
  29    Description given in configuration dialog
  30
  31    \li **TITLE**
  32
  33    Title given in configuration dialog
  34
  35    \li **COPYRIGHT**
  36
  37    Copyright owner / author given in configuration dialog
  38
  39    \li **KIMFILE**
  40
  41    Link to Kim file that can be generated for other people to import KPA
  42    keywords and other data associated with each image.
  43
  44    \li **THUMBNAIL-TABLE**
  45
  46    HTML formatted table containing all thumbnails to be exported to HTML
  47    page.
  48
  49    \li **JSIMAGES**
  50
  51    JavaScript formatted array initialization containing all images to be
  52    exported to HTML page. JS variables size and tsize are initialized to
  53    reflect sizes of images and thumbnails within the selected index page.
  54    Each array element consists of full sized image name (of currently
  55    selected image size), thumbnail image name, link to image specific HTML
  56    page and description field (containing information selected in HTML
  57    configuration dialog).
  58
  59    \li **FIRST**
  60
  61    Page name for first image in album.
  62
  63    \li **LAST**
  64
  65    Page name for last image in album.
  66
  67    \li **RESOLUTIONS**
  68
  69    Selected resolutions within the page with links to respective index
  70    pages.
  71
  72
  73    <h2>Imagepage</h2>
  74    Template file imagepage.html can use the following tags that are then
  75    replaced by KPA with export specific data:
  76    \li **TITLE**
  77
  78    Image file name.
  79
  80    \li **IMAGE_OR_VIDEO**
  81
  82    Image or video with a link to next page.
  83
  84    \li **PREV**
  85
  86    Link to previous page.
  87
  88    \li **PREVFILE**
  89
  90    Name of previous file.
  91
  92    \li **NEXT**
  93
  94    Link to next page.
  95
  96    \li **NEXTFILE**
  97
  98    Name of next file.
  99
 100    \li **INDEX**
 101
 102    Link to index file.
 103
 104    \li **INDEXFILE**
 105
 106    Name of index file.
 107
 108    \li **NEXTPAGE**
 109
 110    Next page or index page if current page is last.
 111
 112    \li **RESOLUTIONS**
 113
 114    Selected resolutions within the page with links to respective index
 115    pages.
 116
 117    \li **COPYRIGHT**
 118
 119    Copyright owner / author given in configuration dialog
 120
 121    \li **DESCRIPTION**
 122    Description contains what is selected to be included in
 123    HTMLGenerator dialog. E.g. keywords and image description.
 124
 125 **/