The search index file format
Table of Contents
Each book should contain a file named help_search_index.xml. This file contains the searchable text for a book. If this file is omitted from a book, the book will not be searchable.
This section describes the format and tags of the help_search_index.xml file.
The help_search_index.xml file must meet standard XML requirements and must contain the following document prolog:
<?xml version="1.0" encoding="UTF-8"?>
Download a sample help_search_index.xml file
book
Description
The root element of the help_search_index.xml file.
Attributes
title, directory
title The title of the book as it should appear in the Help panel TOC.
directory The directory of the book.
Contents
This tag must contain one or more page tags.
Container
None.
Example
<book title="Getting Started with Flash" directory="GettingStarted"> ... </book>
page
Description
The root element of the help_search_index.xml file.
Attributes
href, title, text
href The relative URL of the topic's associated HTML page.
title The title of the book as it should appear in the Help panel TOC.
text The searchable text for the topic, with all markup removed. Double quotes and brackets should be replaced with the named entities ", <, >.
Contents
None.
Container
This tag must be contained by a book tag.
Example
<page href="01_GettingStarted.html" title="Getting started overview" text="Getting started overview Welcome to Macromedia Flash MX 2004..." />