Differences

This shows you the differences between two versions of the page.

Link to this comparison view

ttg_ce2_auto_index_usage [2011/12/09 18:31]
matthew
ttg_ce2_auto_index_usage [2011/12/09 18:45] (current)
matthew
Line 40: Line 40:
  
 While designing your gallery index within Lightroom, the images in your filmstrip will be used as ephemeral representations of indexed content. The items you see listed in the index within Lightroom are for design purposes only, and will not appear in your exported gallery index (which wil be empty until you add real image galleries). While designing your gallery index within Lightroom, the images in your filmstrip will be used as ephemeral representations of indexed content. The items you see listed in the index within Lightroom are for design purposes only, and will not appear in your exported gallery index (which wil be empty until you add real image galleries).
 +
 +===== Adding Galleries to a Published Index =====
 +
 +The purpose of the auto index is to make the task of adding image galleries to your site an easy one. 
 +
 +TTG CE2 Auto Index will automatically detect supported gallery types residing in the index’s folder on your web server. To add a gallery to the index, export the gallery from Lightroom, then upload the image gallery folder into the index folder on your server via FTP. For more information on using an FTP client, see the article [[ File Transfer Protocol (FTP) ]].
 +
 +Because we are uploading galleries to the web, we should keep some basic naming conventions in mind. Gallery folder names should not include spaces or punctuation. Naming your gallery folders properly is important for index functionality. Web folder names should not include spaces, nor any punctuation. Allowed exceptions are hyphens ( – ) and underscores ( _ ), which may safely be used in folder names to replace spaces.
 +
 +===== Manually Adding Galleries =====
 +
 +TTG CE2 Auto Index is not limited to indexing supported gallery types. Other galleries, or any other type of media, can be added to the album index manually.
 +
 +The album index will create entries for any nested folder containing an ''%%autoindex.xml%%'' file and a ''%%/thumbnails/%%'' folder containing thumbnail images. The XML file should be formatted as follows:
 +
 +<code>
 +<?xml version="1.0" encoding="UTF-8"?>
 +<album>
 +   <thumbnail>Path to thumbnail image</thumbnail>
 +   <title>Album Title</title>
 +   <description>Album Description</description>
 +   <url>Path to content</url>
 +</album>
 +</code>
 +
 +The ''%%autoindex.xml%%'' file can be created manually using a plain text-editor, or can be created using Lightroom with [[http://shop.theturninggate.net/collections/all/products/ttg-xml-maker|TTG XML Maker]]. To better understand how to use the XML file, see Understanding Auto Index Behavior, below.
 +
 +===== Understanding Auto Index Behavior =====
 +
 +To make the most of TTG CE2 Auto Index, advanced users may want to know how it works.
 +
 +On load, the album index searches through all of its sub-folders to a depth of one level. For each folder in which it finds an ''%%autoindex.xml%%'' file, it will create an album entry. The album entry will be created according to the following guidelines:
 +
 +1) If a thumbnail image is specified, that thumbnail will be displayed. If no thumbnail is specified, the album index will select an image at random from the ''%%/thumbnails/%%'' folder contained within that sub-folder. If no thumbnails exist, the album item will display a default thumbnail image.
 +
 +When specifying a thumbnail image, the thumbnail path should be written relative to the image gallery root, usually in tihe format ''%%thumbnails/filename.jpg%%''.
 +
 +2) If a title is specified, that title will be displayed. If no title is specified, no title will be displayed.
 +
 +3) If a description is specified, that description will be displayed. If no description is specified, no description will be displayed.
 +
 +4) If a relative or absolute URL is specified, the album entry will link to that URL. If no URL is specified, the album entry will default to the sub-directory. The browser will serve index.html or index.php by default. If no URL is specified, and no index file exists, the album entry will probably lead to a Page Not Found error.
 +
 +5) Detected image galleries will appear in the index listed in numeric, then alphabetic order ( i.e. 0 – 9, then A – Z ), the same way that a system folder would sort by name on your computer. You may control the list order of your galleries by naming your folders to list in the desired order. Display order may be reversed; see below.
 +
 +===== Reversing Album Order =====
 +
 +Album list order can be reversed by opening the ''%%/resources/autoindex/autoindex-view.php%%'' file and changing the boolean value of $reverseit on line 12.
 +
  
  
Print/export