Dependencies

Permission is hereby granted to use the scripts in this suite for private or commercial use at no charge, and to distribute them with this documentation in their original form. You may modify the scripts for such purposes, but may not distribute the modified versions of the scripts.

The #indexTemplate Directive

The #indexEntryTemplate Directive

Directives Used By The Example (Default) Substitution Scripts

The #displayPageAutoGen Directive

Type: Boolean
Default value: FALSE

If defined and equal to TRUE, the THUMB substitution script, which generates replacement text for the [THUMB] substitution tag in the index entry template, will generate page source for the target image at the location indicated by the #displayPageBase directive using the template defined by #displayPageTemplate (or by user.htmlGallery.templates.displayPage if #displayPageTemplate is not defined), and will return the URL of that page rather than the URL of the actual image file.

This allows you to display the images on the background and with the page appearance of your choice, simply by modifying the display page template.

The location of the rendered page sources is defined by #displayPageBase, and each generated page is given the same short name as the image being displayed.

Note: After building your indices using htmlGallery.Index(), you must build the autogenerated display page entries. They can be built in the same way as other pages built from the ODB.

The #displayPageBase Directive

Type: String
Default: "disp/"

Defines the URL of the autogenerated display pages relative to the location of the gallery image folder and the location of the autogenerated page sources in the ODB. The autogenerated page sources will be stored in a site subtable whose name is the same as the #displayPageBase directive (without the trailing '/' character) at the same level as the gallery image table.

Ignored if #displayPageAutoGen is false or is undefined.

The #displayPageTemplate Directive

Type: String, wpText, or outline
Default: user.htmlGallery.templates.displayPage

The template used to generate display page source text (not rendered html text!) in the ODB. This template may contain the same range of substitution tags as the default index entry template used by htmlGallery.Index().

Ignored if #displayPageAutoGen is false or is undefined.

The #thumbnailBorder Directive

Type: Integer
Default: 0 (zero)

This directive is used only by the THUMB substitution text generation script (user.htmlGallery.scripts.THUMB). It specifies the size (in pixels) of the border surrounding thumbnail images in the generated index.

The thumbnails act as buttons leading to the full-size images. Although I prefer no border (border=0) around pictures (hence the default), some people like a border. This allows a border to be easily added, removed, or adjusted.

Index

This #images table is referred to in this documentation as the "gallery #images table" or "gallery image table."

The Index() script uses two templates, one for the overall index and one for the index entries. Index() processes the index template directly, and calls replacer.Process() to process (fill in) the index entry template.

The Index Template

This mechanism allows each gallery table within a website to have a unique index template, if desired. Alternately, you can place a single #indexTemplate directive at an appropriate location within the site table hierarchy to be shared by multiple galleries.

It is recommended that if you define the #indexTemplate directive you also define the #indexEntryTemplate directive at the same location.

The index template may contain the following substitution tag:

[ENTRIES]

Replaced by the aggregate of all the generated index entries.

The Index Entry Template

This mechanism allows each gallery table within a website to have a unique index entry template, if desired. Alternately, you can place a single #indexEntryTemplate directive at an appropriate location within the site table hierarchy to be shared by multiple galleries.

It is recommended that if you define the #indexEntryTemplate directive you also define the #indexTemplate directive at the same location.