The Exercises

Exercise 1: Add new content
Exercise 2: Change a piece of metadata
Exercise 3: Change the logo and colors
Exercise 4: Increase significance of titles in ranking hits
Exercise 5: Customize the advanced search form
Exercise 6: Change the fields displayed in search results
Exercise 7: Enable structural searching with sectionTypes
Exercise 8: Create a hierarchical facet
Exercise 9: Change footnote behavior

“Crib sheet” for the exercises

In the exercises that follow you’ll be asked to repeat several simple tasks. This crib sheet will tell you how to do these tasks, so it’s a good idea to open this document up in a separate window or print it out and keep it handy.

Content Index:

  • Note for Mac users
  • Shortcuts to folders (Windows)
  • Oxygen XML Editor
  • Text indexing in incremental mode
  • Text indexing in clean mode
  • Tomcat startup
  • Tomcat shutdown

Note for Mac users

This crib sheet was written for Windows users. For Mac users, the Windows-to-Mac translations are:

Windows Mac Description
%XTFWS% $XTFWS Workshop folder (below)

%XTF_HOME% $XTF_HOME XTF folder (below)
.bat .command File extension

Command Prompt Terminal Command line interface

Shortcuts to folders

The provided “.bat” or “.command” files will set environment variables for the main folders you are using, which will allow you to use shortcut references instead of typing out full paths Be sure to include the percent signs and quotes exactly as shown:

Name Description
%XTFWS% Your xtfWorkshop folder, e.g.:
My Documents\xtfWorkshop\
sample use: cd “%XTFWS%”
%XTF_HOME% XTF home directory, e.g.:
My Documents\xtfWorkshop\tomcat\webapps\xtf\
sample use: oxygen “%XTF_HOME%\brand\default.xml”

Oxygen XML Editor

In your xtfWorkshop folder:
→ double-click: cmdPrompt.bat
In the Command Prompt:
→ enter: runOxygen “FILE_NAME”
e.g.: runOxygen “%XTF_HOME%\data\ead\bell\bell.dc.xml”

Text indexing in incremental mode

In your xtfWorkshop folder:
→ double-click: cmdPrompt.bat
In the Command Prompt:
→ enter: textIndexer -index default

Text indexing in clean mode

In your xtfWorkshop folder:
→ double-click: cmdPrompt.bat
In the Command Prompt:
→ enter: textIndexer -clean -index default

Tomcat startup

In your xtfWorkshop folder:
→ double-click: runTomcat.bat

Tomcat shutdown

In the Command Prompt where Tomcat was started up:
→ type Ctrl-C (while holding down the Ctrl key, hit the C key)
→ reply to message “Terminate batch job (Y/N)?” (enter: y )
URL for XTF search
→ http://localhost:8080/xtf/search

Next tutorial step: Exercise 1: Add new content