This tutorial provides the following information about Directory Indexing using WebSite Director: 

• What is Directory Indexing? 
• Setting Up Directory Indexing
• Maintaining a Document's Index Position 
• Steps for Setting Up Directory Indexing (Details)

• Steps for Assigning Available Directory Indexing Templates to a Directory

What is Directory Indexing?

Directory Indexing is a method used by WSD to create site maps for your web site or individual site segments. This feature allows you to either index individual directory content or link subdirectories into a composite map for those directories that you want to integrate into a site map.

The WSD Directory Indexing screens allow you to create and maintain HTML documents that contain indexes of documents published to the public web site. WSD uses its Directory Indexing Templates to format this HTML document. You may use the WSD Header and Footer Templates to create headers and footers for each Index document.

The information in the index is obtained from information in the WSD database, each document's version history , and document content identified using WSD's template language. WSD can only index documents published by WSD and for which there is a Version History in the WSD Document Repository. If content was published BEFORE Directory Indexing was turned on, or if content was published outside of WSD (using FTP or a web design application), you can publish it via WSD, or you  can modify and run a sample script provided by CyberTeams. Contact CyberTeams at info@cyberteams.com for more information.

An index file is created and maintained within each selected directory. You select the index file name on the System Configuration screen. It will not be created within the directory until the first document is published into the directory, or you select Rebuild Index on the Maintain Web Site Screen. To make it easy to identify these index files, the same filename is used to identify each directory's index file. For example: 

• If you name your directory index file dirindex.html (entered on the System Configuration screen)  And you turn on indexing for two directories named /marketing and /sales (Create Directory or Directory Properties) 
• The files that contain each directory's index will be /marketing/dirindex.html and /sales/dirindex.html.

Setting Up Directory Indexing

To set up Directory Indexing for the first time, you need to complete the following steps. Detailed instructions for completing these steps can be found below. 

1. Turn Directory Indexing on by selecting "Yes" to the right of Maintain Directory Index files on the System Policies screen. 
   • You can turn this policy on and off at any time. 
   • Directory indexes created while the Maintain Directory Index files was turned on will not be removed if you turn the policy off. If you no longer want these index pages on your server, you must manually remove each index page using the Delete Document function on the Submit New Request screen.
2. Select whether files added to the directory are to be placed at the beginning or end of the index.
   •  Select "First" or "Last" for Default Index Position on the System Policies screen.
3. Create a Directory Index Template to configure your Index file 
   • To help you get started, WSD provides a sample index template (sample.Index) that you can copy and change to fit your requirements. See the Directory Index Templates tutorial for instructions on adding and editing Directory Index Templates. 
   • The Directory Index Template file for all indexes is maintained in the Template directory. To have a different format for a specific directory, the template file for that directory should reside within that directory and have the same name as the directory index Template file you selected on the System Configuration screen (see Step 4).
4. Select the Directory Index Filename on the System Configuration screen. 
   • Select the Directory Index Filename you want WSD to assign to each index file.  See the System Configuration screen for information about these options. 
   • You must click on your browser's "Reload" button the first time you return to the "System Configuration" screen after turning on the Directory Indexing on the System Policies screen.
5. Select the Default Directory Index Template you want WSD to use as the basis for creating each Directory Index file
   • Select this template from the Default Directory Index Template drop-down list  on the System Configuration screen
   • You must click on your browser's "Reload" button the first time you return to the "System Configuration" screen after turning on the Directory Indexing on the System Policies screen. 
6. Select the directories to be indexedon the on the Create Directory or Directory Properties screen. 
   • You may make one or more Directory Index Templates Available for use with the directory on the Directory Templates screen (accessed by clicking Templates on the Directory Properties screen).
   • If you do not want to use the default template (step 5) for your index, you may select another template via the Directory Index Template drop-down list on these screens.

WSD allows you to select a document's relative position in an index list. Default placement in the list can be either First or Last, and is controlled by a System Policy. This position can be changed for individual requests by going to the request's Properties screen, and resetting the  Index Position: field.This field is present only when the "Maintain Directory Index Files" System Policy is turned on. Choices in the drop-down box are: None, First, Last, and Other. For Other, a position number must be entered in the data entry box to the right of the drop-down box.

• None - If this position is selected, the document will not be included in the Index list. 
  • If Directory Indexing is turned on AFTER the document is published, this will be the default position. It must be changed to First, Last or Other if you want the document to be included in the index list.

• First  - If this position is selected, the document will always be the first document in the index list. You do not need to enter a number in the numerical position box. 
  • After you select this option and click [UPDATE INFO], these fields will be changed as follows: Other displays as the position name, and "1" displays as the numerical position.
• Last  - If this position is selected, the document will be the last document in the index list. 
  • After you select this option and click [UPDATE INFO], these fields will be changed as follows: Other displays as the position name, and the numerical position displays the last number in the list. 
    For example, if there are currently five documents in the directory, and you assign a document's position as Last, the numerical position box will display a '5'
  • If another document is subsequently added to the directory with a position of Last, it will supersede any document that had previously been assigned as Last. 
  • To ensure that a document is always Last, use the Other position selection (see below) with a numerical position of 999, or any easily remembered value greater than the maximum number of documents you expect to have in the directory.
• Other  - If this position is selected, you must also enter a position number in the box displayed to the right of Other. 
  • If you do not enter a position number in the Numerical Position box, the Position will revert to None, and the document will not be included in the index list. 
  • If you add a new document to the directory, and assign a position that has been previously assigned, WSD will increment all previously assigned documents' positions by 1. For example, if you have Documents A through E  that are numbered 1 through 5 as follows: 
     

    File Name  Document A  Document B  Document C  Document D  Document E

    Position      1       2       3       4       5

    If you add a new Document F and assign a numerical position of 3, then the documents will be listed as follows: 
     

    Document A  Document B  Document F  Document C  Document D  Document E

    1       2       3       4       5       6

Steps for Setting Up Directory Indexing

The remainder of this document describes the individual steps required to set up and maintain Directory Indexes on your web server.

1.  Turn Directory Indexing On (and Off) and Assign Default Index Position 

1. From the Application Desktop, click [SYSTEM ADMINISTRATION] 
2. On the System Administration screen, click [SYSTEM POLICIES] 
   • WSD displays the System Policies screen. 
   • Locate Maintain Directory Index files: on the right portion of the screen.
3. Click "Yes" to turn Directory Indexing ON or click "No" to turn Directory Indexing OFF (default is "No") 
4. Select "First" or "Last" for the Default Index Position to be applied to new content added to the directory.
5. Click [SAVE POLICIES] 
   • WSD displays a "System Policies Saved" confirmation screen.
6. Click [OK] 
   • WSD displays the System Administration screen.

• From the Application Desktop, click [SUBMIT REQUEST] 
  • WSD displays the Submit New Request screen.
• On the Submit New Request Screen, select Templates from the "Request Category" drop-down list.
• Select Index from the Current Directories list, and click Change Directory.
• Next, click Add/Upload Template.
  • Screen 1 of Add/Upload Template displays.
• Type the filename for the new template and click Continue.
  • Screen 2 of Add/Upload Template displays
• Complete the information required for create the new template and click Submit.
  • The new template has now been placed into the WSD workflow/approval process.

Note for System Administrators: You may also create a Directory Index Template without going through the workflow approval process, as follows:

• On the WSD Application Desktop, select Maintain Web Site.
• On the Maintain Web Site screen, select Maintain Templates.
• On the Maintain Templates screen, select Index Templates in the "Select Template Group" list, and click Continue.
• You may now Add a new template, or View, Edit, Delete, or Apply a listed template. 
  • WSD provides a sample template that you can edit to fit your site' requirements.
• If you have existing documents that use the template(s) you have added or modified, click [APPLY TEMPLATE] before leaving the Maintain Index Templates screen.

3.  Select the Directory Index Filename

1. On the System Administration screen, click [SYSTEM CONFIG] 
   • WSD displays the System Config screen.
2. Locate and select the Directory Index Filename: field. This is the name of the Directory Index file that will contain the listing of all subdirectories you select for indexing. 
   • If the field does not display, click Reload to redisplay the screen. 
   • If you have manually created "index.html" pages for certain subdirectories, we suggest use a different name for your WSD Directory Index. This will prevent your own "index.html" pages from being overwritten when you want both a manual index and an automatic Directory Index file for the same subdirectory. We recommend using "dirindex.html" as the Directory Index Filename.
3. Click [UPDATE CONFIG] to save any changes you made to this field, or proceed to Step 4 before you update the configuration.

1. On the System Administration Screen, click [SYSTEM CONFIG] 
   • WSD displays the System Config screen.
2. Locate and select the Directory Index Template: field. This drop-down list contains names of Template files you defined for Directory Indexing (see above). 
   • If the field does not display, click Reload to redisplay the screen. 
   • WSD uses the selected Template for all directory index files. If you want to use a different directory index template for a specific directory, go to that directory and create a Directory Index Template File with the same name as the template file specified in this field. WSD will use the "local" copy of the template file when indexing files in that directory. 
   • You can define more than one index template file for your system, but only ONE template can be active in the current version of WSD. Future releases will allow you to specify different templates for different subdirectories using the graphical user interface to WSD.
3. Click [UPDATE CONFIG] to save any changes you made.

5.  Select the Default Index Position for new content

1. On the System Administration Screen, click [SYSTEM POLICIES] 
   • WSD displays the System Policies screen.
2. Locate the Default Index Position field and select "First" or "Last" as the default position in the index for new content.
3. Click [SAVE POLICIES] to save your selection and return to the System Administration screen.

1. Click [MAINTAIN WEB SITE] 
   • WSD displays the Maintain Web Site screen.
2. In the Directories and Documents list, select/highlight the directory for which you want Indexing turned ON or OFF. 
   • The WSD Help system provides specific instructions for navigation and selection of directories on this screen.
3. Click [PROPERTIES] 
   • WSD displays the Directory Properties screen.
4. Navigate to the Flags box and select or clear the checkbox by Maintain Index for this directory to turn Directory Indexing ON or OFF for this directory 
5. To change the Directory Index Template for a directory, select the new template filename from the "Directory Index Template" drop-down list.
6. Click [UPDATE] to save your changes 
   • WSD displays an Update Confirmation screen.
7. Click [OK] to confirm your update 
   • WSD displays the Maintain Web Site screen.
8. If you turned on Directory Indexing, you must click [REBUILD INDEX] to build the index for the directory you just updated.

Steps for Assigning Available Directory Indexing Templates to a Directory

1. Click [MAINTAIN WEB SITE] 
   • WSD displays the Maintain Web Site screen.
2. In the Directories and Documents list, select/highlight the directory for which you are assigning available templates. 
   • The WSD Help system provides specific instructions for navigation and selection of directories on this screen.
3. Click [PROPERTIES] 
   • WSD displays the Directory Properties screen for the directory.
4. On the Directory Properties screen, click TEMPLATES.
   • WSD displays the Directory Templates screen. 
5. Go down to the Index Templates area and use the action keys (>>, >ALL>, <<, <ALL<) to move template names between the Not Available and Available lists. 
6. Click [UPDATE].
   • WSD displays the Directory Properties screen.  

Copyright 2000-2005 CyberTeams, Inc., http://www.cyberteams.com All rights reserved.
CyberTeams and WebSite Director are registered trademarks of CyberTeams, Inc. All other marks are the property of their respective owners.