The Web Generation Commands

The ImageDB web site generation commands are placed inside HTML comments - the general form of these comments is:

<!-- idb command [parameters] -->

Different commands are relevant to different templates. Note that these commands do almost no formatting such as setting fonts, bold, headings etc. all that is done in the template HTML code allowing you complete flexibility over the final appearance of your pages.

Top Level (Index) Template Page

Title

Parameters

Description

title   Uses your web site title as the HTML page title
web_title   Inserts the text of your web site title
web_description [columns] Inserts the text of your web site description. You can optionally specify the number of columns - the default is two for easier reading. It will only split into multiple columns if the description is quite long.
category_list   Inserts the category tree. See the category list command
 

Thumbnail Template Page

Title

Parameters

Description

title   Uses your web site title and a list of category titles from the index page through to the actual category of this page as the HTML page title
web_title   Inserts the text of your web site title
rows_and_cols nrows ncols Important this command is required and must appear before any commands dealing with pages numbers or the thumbnail table. It allows the correct number of pages for each category to be calculated and controls the set up of the thumbnail table. See thumbnail pages
category_caption   Inserts the text of this category's caption
full_category_caption   Inserts the text of this category's caption along with all parent categories back to the index page level
category_description [columns] Inserts the text of this category's description. You can optionally specify the number of columns - the default is two for easier reading. It will only split into multiple columns if the description is quite long.
category_list   Inserts the category tree. See the category list command.
full_category_list   Inserts the full category tree as though this were an index page. See the category list command.
thumbnail_page_no   Inserts the current thumbnail page number (in the current category). See thumbnail pages
total_thumbnail_pages   Inserts the total number of pages in this category. See thumbnail pages
previous_page_link text Inserts a link to the previous page with the text provided as the parameter the the link text. If there is no previous page then nothing is generated. This text may be anything, including valid HTML commands. For example the following would insert an image link:
<!-- idb previous_page_link <img src="leftarrow.gif" border=0> -->
next_page_link text As above except for the next page.
thumbnail_table  with_index
with_caption with_border
Inserts the actual thumbnail table. A table of images is generated using the rows and columns sepcified rows_and_cols command (see above). Each image will be a link to the actual image or the image page. If with_caption is used the image caption will be added below each thumbnail. if with_index is used the image index (filename) will be added below each thumbnail. If with_border is used each image will be surrounded by a border.
back_to_index text Inserts a link to the main top level index page with the text provided as the parameter as the link text.
 

Image Template Page

Note: this page is optional and if used a corresponding image HTML file will be generated for every thumbnail in every thumbnail page. This can be quite a large number of files though they are typically small. If not used then clicking a thumbnail in one of the thumbnail pages will just display the image with no other information or formatting.

Title

Parameters

Description

title   Uses your web site title and category titles as the HTML page title
image   Inserts the image
image_caption   Inserts the image caption
image_index   Inserts the image index (filename)
image_description [columns] Inserts the image description. You can optionally specify the number of columns - the default is two for easier reading. It will only split into multiple columns if the description is quite long.
image_previous_link text Inserts a link to the previous image with the text provided as the parameter as the link text. If there is no previous image then nothing is generated. This text may be anything, including valid HTML commands. For example the following would insert an image link:
<!-- idb image_previous_link <img src="leftarrow.gif" border=0> -->
image_next_link text As above except for the next image.
image_back_link text As above except except the link is back to the thumbnail page.

 

2004 Focus Software Solutions www.focussoftware.co.uk