Case study: REACT single-source methodology

We worked with the United States Institute of Peace to develop pre-deployment training to ensure that people selected for REACT are prepared to immediately begin work when they reach a field operation. We created a single-source methodology that allows a single Word document to act as the source for each module of the web-based training. These documents are used to create HTML, JavaScript navigation, and PDF files.

 

Process

The following list describes the process for converting a Word file to various formats.

1. Update Word files with new content
2. Export Word to PDF
3. Export Word to XML
4. Chomp XML
5. Upload to web server

 

1. Update Word files

Microsoft Word files allow great flexibility in content and collaboration. By using Word as our single-source, we are able to incorporate an Information Mapping format with text, graphics, and links. By using the Track Changes feature of Word we can easily view each other's changes and suggestions.

 

2. Export to PDF

The content of the course is available to students in downloadable PDF files. This allows students to read the content of the course on a printed page, rather than the screen; and also allows offline viewing, which is important for students with limited Internet or computer access.

The USIP has a unique agreement with the Associated Press (AP) where they are allowed to use AP images free of charge, but only in the online version, not in the PDF files. In order to accommodate this agreement, we created Word macros that allow us to "hide" AP images and their associated captions before the file is exported to PDF.

 

3. Export to XML

XML allows us to format and arrange content in ways that were previously laborious. To export from Word to XML we use Information Mapping's Formatting Solutions software. This solution results in a clean XML file that is easily manipulated.

 

4. Chomp XML

Some of the Word files for the course are up to 130 pages long. This is much too long for a webpage, so we divide the XML files into individual HTML files for each subsection. This is accomplished using the "Chomper" tool that we created using Visual Basic. The Chomper applies a custom XSL stylesheet to the XML files, creates individual HTML files, and creates the JavaScript navigation file.Throughout the course there are "check-your-learning" style mini-quizzes that have been authored in HTML/JavaScript. These files cannot be included in the Word single-source file, so the Chomper replaces "Mini-Quiz" sections found in the XML file with the appropriate HTML/JavaScript file.

 

5. Upload to web server

After the files have been "chomped" they are ready to be uploaded to the web server. By replacing the HTML files and the navigation file, the content can be completely updated in just a few steps. Any changes to the overall flow, headings, navigation, content, etc. are reflected on the new site without any programming.