An Indexing Example

An Indexing Example
Introduction
index_example.omh
index_children.omh
Execute Example
Example In This Web Site

Introduction
The index commands control the contents of the index , and search pages. In addition, they broadcast information about a particular web page to the internet search engines. This makes it easy for people to find information in your web site that is relevant to a particular topic.

index_example.omh
Use the editor of your choice to create the file index_example.omh in the xam directory with the following contents:

 
     $begin index_example$$
     $spell
     	omh
     $$
     
     $section Parent Section For Indexing Examples$$
     $index index, example$$
     
     $head Viewing Index$$
     Select the following link to view the index for this web site:
     $cref/Keyword Index/_index/$$
     
     $head index_children.omh$$
     $verbatim%omh/getstarted/index_children.omh%
     	5%BEGIN_INDEX_CHILDREN%END_INDEX_CHILDREN%0
     %$$
     
     $contents%
     	omh/getstarted/index_children.omh
     %$$
     
     $end

You can also just copy index_example.omh from the omh/getstarted directory .

index_children.omh
Copy omh/getstarted/index_children.omh from the omh/getstarted Directory to the xam directory . In the copy of index_example.omh, change omh/getstarted/index_children.omh to index_children.omh.

Execute Example
Once you have copied the files mentioned above, you can execute omhelp with example_name equal to index_example.

Example In This Web Site
You can view the result of making index_example.omh part of the OMhelp help web site by selecting index_example .

Input File: omh/getstarted/start_index.omh