File indexing completed on 2024-04-28 04:21:05

0001 // krazy:skip
0002 //  SPDX-FileCopyrightText: 2009 Jesper K. Pedersen <blackie@kde.org>
0003 //
0004 //  SPDX-License-Identifier: LicenseRef-KDE-Accepted-GPL OR CC-BY-SA-4.0
0005 /**
0006    \page html-themes HTML themes
0007 
0008    Static web pages can be generated with selectable sized images.
0009    HTMLGenerator allows using of themes to produce differently styled web
0010    pages.
0011 
0012    Themes use template files that are used as basis for static HTML files.
0013    There are currently two template files used:
0014    \li mainpage.html
0015    \li imagepage.html
0016 
0017    Maingpage is used to generate index.html and image size specific index
0018    pages ( index-800x600.html ). imagepage.html is used to create one HTML
0019    page for each image and for each requested image size.
0020 
0021    Any other files within a theme directory are copied as is to the target
0022    web page. This way javascript, style files and theme specific images can
0023    easily be used.
0024 
0025    One more file included in a theme is file called kphotoalbum.theme. This
0026    file contains information about the theme author and theme name.
0027 
0028    <h2>Mainpage</h2>
0029    Template file mainpage.html can use the following tags that are then
0030    repplaced by KPA   with export specific data:
0031    \li **DESCRIPTION**
0032 
0033    Description given in configuration dialog
0034 
0035    \li **TITLE**
0036 
0037    Title given in configuration dialog
0038 
0039    \li **COPYRIGHT**
0040 
0041    Copyright owner / author given in configuration dialog
0042 
0043    \li **KIMFILE**
0044 
0045    Link to Kim file that can be generated for other people to import KPA
0046    keywords and other data associated with each image.
0047 
0048    \li **THUMBNAIL-TABLE**
0049 
0050    HTML formatted table containing all thumbnails to be exported to HTML
0051    page.
0052 
0053    \li **JSIMAGES**
0054 
0055    JavaScript formatted array initialization containing all images to be
0056    exported to HTML page. JS variables size and tsize are initialized to
0057    reflect sizes of images and thumbnails within the selected index page.
0058    Each array element consists of full sized image name (of currently
0059    selected image size), thumbnail image name, link to image specific HTML
0060    page and description field (containing information selected in HTML
0061    configuration dialog).
0062 
0063    \li **FIRST**
0064 
0065    Page name for first image in album.
0066 
0067    \li **LAST**
0068 
0069    Page name for last image in album.
0070 
0071    \li **RESOLUTIONS**
0072 
0073    Selected resolutions within the page with links to respective index
0074    pages.
0075 
0076 
0077    <h2>Imagepage</h2>
0078    Template file imagepage.html can use the following tags that are then
0079    replaced by KPA with export specific data:
0080    \li **TITLE**
0081 
0082    Image file name.
0083 
0084    \li **IMAGE_OR_VIDEO**
0085 
0086    Image or video with a link to next page.
0087 
0088    \li **PREV**
0089 
0090    Link to previous page.
0091 
0092    \li **PREVFILE**
0093 
0094    Name of previous file.
0095 
0096    \li **NEXT**
0097 
0098    Link to next page.
0099 
0100    \li **NEXTFILE**
0101 
0102    Name of next file.
0103 
0104    \li **INDEX**
0105 
0106    Link to index file.
0107 
0108    \li **INDEXFILE**
0109 
0110    Name of index file.
0111 
0112    \li **NEXTPAGE**
0113 
0114    Next page or index page if current page is last.
0115 
0116    \li **RESOLUTIONS**
0117 
0118    Selected resolutions within the page with links to respective index
0119    pages.
0120 
0121    \li **COPYRIGHT**
0122 
0123    Copyright owner / author given in configuration dialog
0124 
0125    \li **DESCRIPTION**
0126    Description contains what is selected to be included in
0127    HTMLGenerator dialog. E.g. keywords and image description.
0128 
0129 **/
0130 // vi:expandtab:tabstop=4 shiftwidth=4: