Background

XTF is an XML publication framework. For our purposes, there are basically two processes we need to understand in order to set it up and work with it:

Detailed step-by-step instructions are given below for getting XTF up and running. In places where the instructions say “issue the command...” this just means you should type the given command into your terminal window (which will be launched when you start up XTF).

We have provided a test data set that includes 100 TEI-encoded articles from the DHQ journal. You should feel free to use your own data instead, but XTF has a few quirks you should be aware of in preparing that data:

Basic XTF Instructions

  1. Get the appropriate XTF package
  2. Launch XTF by opening cmdPrompt.command (Mac or Linux) or cmdPrompt.bat (Windows). If you are on a Mac and you receive an error message saying "cmdPrompt.command can't be opened because it is from an unidentified developer", control-click on the cmdPrompt.command icon and then choose Open.
  3. TEMPORARY: for Mac or GNU/Linux, fix the permissions by issueing the command chmod a+x textIndexer tomcat/bin/* tomcat/webapps/xtf/bin/textIndexer
  4. Index the XML data it contains by entering either
    ./textIndexer -index default   (Mac or Linux)
    or
    textIndexer -index default   (Windows)
    This makes XTF aware of the XML files that are in its data folder, XTF_exercise/tomcat/webapps/xtf/data/ (we’ve preloaded this with 100 articles from Digital Humanities Quarterly). You’ll know the indexing process is done when the command window says “Indexing complete.”
  5. Launch tomcat by opening tomcat.command (Mac or Linux) or tomcat.bat (Windows). You’ll know this process is complete when the tomcat window says “INFO: server startup in NUM ms”
  6. In a web browser, visit the address:
    http://localhost:8080/xtf/search
    If you get an XTF browser interface, things are going well!
  7. Try a search (hint: the texts in this collection are from a digital humanities journal)
  8. To replace the default data with your own data:
    1. go to XTF_exercise/tomcat/webapps/xtf/data/. You’ll see a list of files with names like 000001.xml (these are DHQ articles).
    2. Delete these and replace them with your own XML files.
    3. Next, shut down tomcat by typing control-c (??)
    4. Then run the indexer again to reindex the data: in the command window type ./textIndexer -index default
    5. Restart tomcat (see step 5 above) (??)
    6. Reload the XTF browser: http://localhost:8080/xtf/search

Troubleshooting

Tutorials and documentation

A full XTF tutorial with step-by-step exercises is available at http://xtf.cdlib.org/getting-started-tutorials/. Note that all the filepaths mentioned in the tutorial start at XTF_HOME, which is equivalent to the XTF_exercise_Windows/tomcat/webapps/xtf/ directory in our self-contained XTF Workshop installation.

Full XTF documentation (aimed at a fairly advanced audience) is available at http://xtf.cdlib.org/documentation/ (same proviso as above).