# File Information

HTML slide and index files may contain the following types of information:

Title
Description: | The title of the HTML file. This will appear in the index associated with this file.
Type: | Static, user modifiable. ¹
HTML Tag: | `<TITLE>`title`</TITLE>`
Note: | The characters &, <, and > must be encoded as HTML character entities.

Description
Description: | A short sentence which describes the content of the HTML file. This will appear in the index associated with this file.
Type: | Static, user specified. ¹
HTML Tag: | `<META NAME="DESCRIPTION" CONTENT="`description`">`
Note: | The characters &, <, >, and " must be encoded as HTML character entities.

Keyword List
Description: | A comma-delimited list of keywords which describe this item. The keywords may contain spaces.
Type: | Static, user specified. ¹
HTML Tag: | `<META NAME="KEYWORDS" CONTENT="`keyword, keyword, ...`">`
Note: | The characters &, <, >, and " must be encoded as HTML character entities.

Sort Order
Description: | A decimal number (integer) which specifies the order in which this file should appear in the index. Lower numbers appear first in the index. If two files contain the same number then sorting will be based on their titles. The default value is normally 50 if no sort order is specified, but this can be changed (see the defaultOrder configuration option).
Type: | Static, user specified. ¹
HTML Tag: | `<META NAME="SORTORDER" CONTENT="`number`">`

Supplimentary Information
Description: | Additional descriptive information that is generated automatically by the program that created this file. This information normally appears after the description in the index, enclosed in square brackets.
Type: | Automatically generated.
HTML Tag: | `<META NAME="FILEINFO" CONTENT="`information`">`
Note: | The characters &, <, >, and " must be encoded as HTML character entities.

Generator
Description: | The program (including the version number) that was used to generate this file.
Type: | Automatically generated.
HTML Tag: | `<META NAME="GENERATOR" CONTENT="`program`">`

Forward Reference
Description: | This file is a forward reference to a different HTML file. The index which would contain a link to this file will instead contain a link to the specified URL. The file information used in the index will be obtained from this file, however, and not from the specified URL. The URL can be a relative URL to a local file, or an full URL to an external web site. This tag should not be used in automatically generated files (it is not preserved).
Type: | Static, user specified.
HTML Tag: | `<META NAME="FORWARD" CONTENT="`URL`">`
Note: | The characters &, <, >, ", space, and all other unsafe characters must be URL encoded (e.g. & encoded as %26).

All tags should appear in the header section (`<HEAD>`) of the HTML file. Tags must not span multiple lines. META tag names must be all uppercase.

¹ | Static information is always preserved when a file is rebuilt.

Table of Contents