Prev Next

An Indexing Example

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.

Execute The Following Steps

index_example_1.omh
Use an editor of your choice to create the file index_example_1.omh in the test directory with the following contents:
     
$begin
index_example_1$$
     
     $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/$$
     
     $contents/
     	index_example_2.omh/$$
     
     $end
Note that you can copy and paste the commands above to your editor window. You may just copy the file with the same name from the getting started directory .

index_example_2.omh
Use an editor of your choice to create the file index_example_2.omh in the test directory with the following contents:
     
$begin
index_example_2$$
     $spell
     	Mindex
     $$
     
     $section An Example Using The Mindex Command$$
     $mindex child$$
     
     $end
     ----------------------------------------------------------------------
     $begin Index3Example$$
     $spell
     	Aindex
     	aindex
     $$
     $aindex section$$
     
     $comment Supress not have index entry corresponding to An Using or The$$
     $escape @$$
     
     $section @An Example @Using @The Aindex Command$$
     
     $end
     ----------------------------------------------------------------------


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

Execute OMhelp
In a command window and in the htm directory execute the following command
 
     omhelp ../index_example_1.omh -noframe

Example by Itself
Use a web browser of your choosing to view the file test/htm/index_example_1.htm .
Input File: getstarted/start_index.omh