webworks automap 9.0 · microsoft winhelp, webworks help, sun javahelp (versions 1.x and 2.x), and...

WebWorks AutoMap 9 User Guide: Copyright Information

1

WEBWORKS AUTOMAP 9 USER GUIDE


2

COPYRIGHT INFORMATION

Copyright © 2001-2006 Quadralay® Corporation. All rights reserved.

Quadralay and WebWorks are registered trademarks of Quadralay Corporation. FrameMaker is a registered trademark of Adobe Systems, Inc. Microsoft and Windows are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. Sun, Java and JavaHelp are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. RoboHelp is a registered trademark of Macromedia. Doc-To-Help is a registered trademark of ComponentOne LLC. All other trademarks used herein are the properties of their respective owners and are used for identification purposes only.

Portions of this software are copyrighted by others, as follows:

Ghostscript API wrapper Copyright © 2004, Pelagon Limited. All rights reserved.

ImageMagick Copyright © 2002 ImageMagick Studio, a non-profit organization dedicated to making software-imaging solutions freely available.

International Components for Unicode (ICU) Copyright © 1995-2003 International Business Machines Corporation and others. All rights reserved.

Java and JavaHelp Copyright © 2003 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Sun, Sun Microsystems, the Sun Logo, Solaris, Java, the Java Coffee Cup Logo, JDK, Java Foundation Classes (J.F.C.), Java Plug-in and JavaHelp are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.

JGL - The Generic Collection Library for Java™ Copyright © 1997 ObjectSpace, Inc. All Rights Reserved.

Microsoft Help Workshop Copyright © 2004 Microsoft Corporation, One Microsoft Way, Redmond, Washington 98052-6399 U.S.A. All rights reserved.

NetAdvantage Copyright ©1992-2005 Infragistics, Inc., Windsor Corporate Park, 50 Millstone Road, Building 200 - Suite 150, East Windsor, NJ 08520. All rights reserved.

Oracle Help Copyright © 2002 Oracle Corporation. All Rights Reserved.

Various .Net Utilities Portions copyright © 2002-2004 The Genghis Group (http://www.genghisgroup.com/)

Xerces Copyright © 1999-2004 The Apache Software Foundation. All rights reserved.


3

TABLE OF CONTENTS

WebWorks AutoMap 9 User Guide ............................................................................................................... 1 Copyright Information.................................................................................................................................... 2 Table of Contents ........................................................................................................................................... 3 Welcome......................................................................................................................................................... 5 About the WebWorks AutoMap documentation ............................................................................................ 5 Who should read this documentation?............................................................................................................ 5 What is in this documentation? ...................................................................................................................... 5 Documentation screenshot notes .................................................................................................................... 5 What is new in this release? ........................................................................................................................... 6 Conventions.................................................................................................................................................... 6 AutoMap 9.2 Notes ........................................................................................................................................ 7 Getting Started................................................................................................................................................ 8 Overview of WebWorks AutoMap 9.............................................................................................................. 8

What is WebWorks AutoMap?............................................................................................................... 8 Benefits of using WebWorks AutoMap ................................................................................................. 9 Revision control integration ................................................................................................................... 9

System Requirements ................................................................................................................................... 10 Minimum System Requirements .......................................................................................................... 10 Recommended System Requirements .................................................................................................. 10

Compatibility with Microsoft Windows Server............................................................................................ 11 Compatibility with previous versions of WebWorks AutoMap ................................................................... 11 Installing WebWorks AutoMap 9................................................................................................................. 11

Installing the software: ......................................................................................................................... 11 Uninstalling the Software ..................................................................................................................... 13

Running WebWorks AutoMap with Norton AntiVirus Software ................................................................ 13 WebWorks AutoMap with WebWorks ePublisher Pro ................................................................................ 15 WebWorks product workflow ...................................................................................................................... 15 Preparing source documents......................................................................................................................... 16 Working with formats, stationery, projects, and jobs ................................................................................... 16

What are formats?................................................................................................................................. 17 What are user formats? ......................................................................................................................... 17 What is stationery? ............................................................................................................................... 18 What are the differences between formats and stationery?................................................................... 18 What are projects? ................................................................................................................................ 18 What are jobs? ...................................................................................................................................... 19 What happened to WebWorks templates? ............................................................................................ 19

WebWorks AutoMap job types .................................................................................................................... 20 Project-based jobs................................................................................................................................. 20 Stationery-based jobs............................................................................................................................ 20

WebWorks AutoMap User Interface ............................................................................................................ 21 Starting WebWorks AutoMap ...................................................................................................................... 21

Opening WebWorks AutoMap............................................................................................................. 21 Configuring license keys ...................................................................................................................... 22

Overview of the WebWorks AutoMap user interface .................................................................................. 23 WebWorks AutoMap menus ................................................................................................................ 23 WebWorks AutoMap contextual menus............................................................................................... 26 WebWorks AutoMap toolbar ............................................................................................................... 26 WebWorks AutoMap status information.............................................................................................. 27

Setting application preferences..................................................................................................................... 28 General Preferences.............................................................................................................................. 29 File Mappings....................................................................................................................................... 35 Output Destinations .............................................................................................................................. 37 Notification........................................................................................................................................... 38

German, Japanese, and French support ........................................................................................................ 40


4

WebWorks AutoMap Jobs ........................................................................................................................... 41 Creating and working with project-based jobs ............................................................................................. 41

Job type................................................................................................................................................. 42 Job info ................................................................................................................................................. 43 Target Selection.................................................................................................................................... 43 Project-based job deployment .............................................................................................................. 44

Creating and working with stationery-based jobs......................................................................................... 44 Job type................................................................................................................................................. 45 Job info ................................................................................................................................................. 45 Documents............................................................................................................................................ 46 Target Selection.................................................................................................................................... 48 Target Configuration ............................................................................................................................ 49

Scheduling a job ........................................................................................................................................... 56 Windows task scheduler summary ....................................................................................................... 57

Working with existing jobs .......................................................................................................................... 58 Editing an existing job.......................................................................................................................... 58 Deleting an existing job........................................................................................................................ 58 Scheduling an existing job.................................................................................................................... 58 View job log file................................................................................................................................... 59 Duplicate an existing job ...................................................................................................................... 59 Run an existing job............................................................................................................................... 59 Cancelling a job.................................................................................................................................... 59

Script Editor ................................................................................................................................................. 61 Writing scripts .............................................................................................................................................. 62

Working folder ..................................................................................................................................... 62 Scripting examples ....................................................................................................................................... 62

Show time and date .............................................................................................................................. 63 Using scripting variables ...................................................................................................................... 63

Revision control ........................................................................................................................................... 64 CVS checkout....................................................................................................................................... 65

Scripting variables ........................................................................................................................................ 67 WebWorks AutoMap Command Line Interface........................................................................................... 69 Running WebWorks AutoMap on the command line................................................................................... 69 Command line usage .................................................................................................................................... 70 Command line options.................................................................................................................................. 70 Specifying command line options ................................................................................................................ 72 Format Settings............................................................................................................................................. 73 Glossary........................................................................................................................................................ 76 Index............................................................................................................................................................. 81

WebWorks AutoMap 9 User Guide: Welcome

5

WELCOME

Welcome to WebWorks AutoMap 9!

WebWorks AutoMap is a powerful application for converting and scheduling automatic conversion of Adobe FrameMaker or Microsoft Word documents to a variety of online formats. Using WebWorks AutoMap, you can convert your Adobe FrameMaker or Microsoft Word documents to HTML, XHTML, and XML, as well as two leading eBook formats (Microsoft Reader and Palm Reader), the five most popular online Help formats: Microsoft HTML Help, Microsoft WinHelp, WebWorks Help, Sun JavaHelp (versions 1.x and 2.x), and Oracle Help, and PDF for printing.

WebWorks AutoMap contains all of the functionality of WebWorks ePublisher Pro and adds automatic pre and post-processing functionality to complete production processes.

The following sections contain important information you should review before you begin to work with WebWorks AutoMap:

• About the WebWorks AutoMap documentation • Who should read this documentation? • What is in this documentation? • Documentation screenshot notes • What is new in this release? • Conventions • AutoMap 9.2 Notes

About the WebWorks AutoMap documentation

The WebWorks AutoMap documentation includes information necessary for users to understand how to use WebWorks AutoMap. The documentation introduces you to WebWorks AutoMap and gives step-by-step instructions for using the features of the software.

Who should read this documentation?

To become a productive WebWorks AutoMap user, you do not need to invest much time in learning and understanding how the software works. WebWorks AutoMap is easy to use. However, whether you are a beginner or an advanced user, there is information available for you in the WebWorks AutoMap documentation and online help.

What is in this documentation?

This documentation is intended for all users, regardless of their skill levels. It explains how to install the software and perform common tasks, such as creating jobs, working with jobs, setting preferences, and using the command line. See the Table of Contents for the chapters and information contained in this documentation.

Documentation screenshot notes

Due to parallel development of this documentation, artwork, and the product, there may be some minor discrepancies between a few of the screenshots contained in this documentation and those actually displayed in the product. These few discrepancies will be minor and should not affect the reader’s understanding.


6

What is new in this release?

WebWorks AutoMap 9 contains all features of previous versions and introduces a wide range of new features to help streamline the process of converting your Adobe FrameMaker and Microsoft Word documents to a variety of online output formats. The following is a brief summary of the new features in this release.

Compatibility with WebWorks ePublisher Pro WebWorks AutoMap is now compatible with WebWorks ePublisher Pro allowing scheduling of jobs based on the latest WebWorks technology and products.

WebWorks ePublisher Pro Project Scheduling You can now schedule WebWorks ePublisher Pro projects directly. Previous versions of WebWorks AutoMap required creating a job and redefining many of the settings and properties of an existing project. Although that capability still exists, it is now possible to schedule and an existing WebWorks ePublisher Pro project eliminating the need to repeat work already completed.

Updated New Job creation The New Job Wizard has been updated and includes functionality for creating new jobs based on existing WebWorks ePublisher Pro projects or stationery. The new wizard helps you set up everything necessary to create a complete and ready to run WebWorks AutoMap job.

Ability to combine FrameMaker and Word files in single job As with WebWorks ePublisher Pro, WebWorks AutoMap can now schedule jobs including both Adobe FrameMaker and Microsoft Word documents.

The above feature requires both Adobe FrameMaker and Microsoft Word adapter keys.

Improved Pre and Post processing It is now possible to specify unique pre and post processing scripts for each job as well as each target in a project.

New Script Editor with Environment Variables A simple text editor is now available for writing scripts directly in WebWorks AutoMap. Scripts can be written directly in this editor or cut and pasted from other text-based editors. Included in the built in editor is a list of useful environment variables that can be easily added to the script for improved processing.

New Target Configuration Panel This new panels allows configuring the job info, conditions, variables, format settings, and merge settings on a per-target basis giving more flexibility on customizing multiple outputs and taking advantage of WebWorks single-sourcing capabilities.

File Mappings Panel As with WebWorks ePublisher Pro, the File Mappings panel allows custom file extensions to be mapped to either Adobe FrameMaker or Microsoft Word.

Conventions

This documentation uses the following conventions:

Convention Use

Bold Highlights items you can select in the WebWorks AutoMap interface, including buttons and menus. Also used to emphasis key words.


7

Convention Use

Italic Highlights book titles, variables, and terms that are defined in the glossary.

→ The arrow indicates a menu choice. For example, “choose File → Open” means “click the File menu, and then click Open.”

+ The plus sign indicates that you must hold down multiple keys simultaneously. For example, “Ctrl + Alt + N” means you must hold down the “Ctrl” “Alt” and “N” keys on your keyboard at the same time.

AutoMap 9.2 Notes

WebWorks AutoMap 9.2 is a required update in order to maintain compatibility with WebWorks ePublisher Pro 9.2. This update maintains compatibility with the WebWorks ePublisher Pro 9.2 content transformation engine and incorporates new 9.2 features including:

• Support for the WebWorks ePublisher Pro 9.2 project format

• Updated conditions and variables settings

• Format Setting groups

• All related WebWorks ePublisher Pro 9.2 defect fixes

Existing WebWorks AutoMap 9 jobs do NOT have to be re-created. However, it is necessary to update any projects and/or stationeries to the 9.2 format before WebWorks AutoMap 9.2 will convert them. To do this, simply double click the job name in the WebWorks AutoMap user interface and answer Yes when prompted to update the project or stationery. Alternatively, you can convert the project and/or stationery in WebWorks ePublisher Pro 9.2.

Note: The automatic conversion will only update the project format. It will not automatically update any XSL customizations. Please review your WebWorks ePublisher Pro 9.2 Release Notes for more information on XSL customizations.

WebWorks AutoMap 9 User Guide: Getting Started

8

GETTING STARTED

Choosing WebWorks ePublisher Pro and either Adobe FrameMaker and/or Microsoft Word to produce technical documents and online content is the first step in building a powerful single sourcing environment. Incorporating WebWorks AutoMap into your conversion process gives you the ability to schedule your conversions of multiple source files.

Using your source files, WebWorks AutoMap allows you to produce all of your information—print, HTML, XHTML, XML, eBooks, WebWorks Help, WinHelp, HTML Help, JavaHelp 1 and 2, Oracle Help, and PDF—in a single authoring environment. You create content in either Adobe FrameMaker or Microsoft Word and then use WebWorks AutoMap to convert your documents to whichever online output formats you need.

This section gives you important information to get you started with WebWorks AutoMap. It includes the following sections:

• Overview of WebWorks AutoMap 9 • System Requirements • Compatibility with Microsoft Windows Server • Compatibility with previous versions of WebWorks AutoMap • Installing WebWorks AutoMap 9 • Running WebWorks AutoMap with Norton AntiVirus Software

Overview of WebWorks AutoMap 9

This section describes the purpose and benefits of using WebWorks AutoMap and includes the following sections:

• What is WebWorks AutoMap? • Benefits of using WebWorks AutoMap • Revision control integration

What is WebWorks AutoMap?

WebWorks AutoMap is a powerful application eliminating the maintenance of multiple WebWorks ePublisher Pro projects, saving your company countless hours. WebWorks AutoMap allows you to automatically create and convert WebWorks ePublisher Pro projects without manually opening either WebWorks ePublisher Pro or your source file applications. Source file applications currently include Adobe FrameMaker and Microsoft Word. Depending on how you create your job, WebWorks AutoMap does one of the following:

• Schedules and converts an existing WebWorks ePublisher Pro project directly

• Applies custom WebWorks stationery to multiple source files, creates a WebWorks ePublisher Pro project automatically, and then converts the project

Note: Previous versions of WebWorks AutoMap could not schedule an existing WebWorks Publisher project directly. This is a new feature of WebWorks AutoMap 9.

To create a job based from stationery, you start with one of the default WebWorks ePublisher Pro formats, create a project and then customize the WebWorks styles and other aspects of the format to add your company's own look and feel to your output. You then save the project as stationery to be used in creating and converting your WebWorks AutoMap jobs. The more


9

consistent you make your custom WebWorks ePublisher Pro stationery, the more predictable your output will be with WebWorks AutoMap.

The formats that are supplied with WebWorks ePublisher Pro provide only a starting point from which to make your own stationery that contain all the necessary customizations of your Adobe FrameMaker or Microsoft Word styles to the styles defined in the WebWorks ePublisher Pro format. By default, styles that are not customized in the format will be mapped to those used in the source document. If your online output uses a different look and feel than your printed content, this discrepancy will be reflected in your online output.

Benefits of using WebWorks AutoMap

WebWorks AutoMap automates the process of converting your Adobe FrameMaker or Microsoft Word documents into online output formats. It lets you create and convert documents at the times you schedule and works seamless with several content management and revision control systems.

The following are just a few of the features of WebWorks AutoMap that will save you time and effort:

• Automates your conversions

• Eliminates maintenance of WebWorks ePublisher Pro projects

• Calls the specified WebWorks ePublisher Pro format or stationery and applies it to your content

• Creates merged output from multiple books

• Redirects output automatically

• Interfaces with content management and revision control systems

• Offers great flexibility in scheduling conversions

• Notifies relevant people on conversion success or failure

• Automatically updates your online documentation, help, or other web-based information

Revision control integration

WebWorks AutoMap allows you to specify scripts for retreiving files from revision control and content management systems such as:

• CVS

• ClearCase

• Visual Source Safe

• Documentum

In addition, WebWorks AutoMap can work with any revision control or content management systems that are scriptable from the command line. For more information, please see the Revision control section and the CVS checkout example.


10

System Requirements

The following are the minimum and recommended system and product requirements for WebWorks AutoMap 9. These are the same requirements as those for WebWorks ePublisher Pro.

• Minimum System Requirements • Recommended System Requirements

Minimum System Requirements

• Microsoft Windows 2000 (Service Pack 4) or greater

• Microsoft Internet Explorer 5.5 or greater, with JavaScript enabled1

• Adobe FrameMaker 6.0 or greater

• Microsoft Word 2000 or greater

• At least 512 MB RAM

• Approximately 100 MB free hard disk space

• Pentium IV or AMD processor

• 800 x 600 display screen resolution

• Microsoft .NET Framework 2.02

Recommended System Requirements

• Microsoft Windows XP

• Microsoft Internet Explorer 6.0 with JavaScript enabled3

• Adobe FrameMaker 7.2

• Microsoft Word 2003

• At least 1 GB RAM

• Approximately 200 MB free hard disk space

• 3 GHz or faster Pentium IV or AMD processor

1 To enable JavaScript: select Start → Settings → Control Panel → Internet Options → Security. Click the Custom Level button in this dialog box. From the next dialog box, select the radio button next to Enable under Active Scripting. 2 To obtain and install the Microsoft .NET Framework 2.0, please visit: http://www.microsoft.com/downloads/details.aspx?FamilyID=0856EACB-4362-4B0D-8EDD-AAB15C5E04F5&displaylang=en 3 To enable JavaScript: select Start → Settings → Control Panel → Internet Options → Security. Click the Custom Level button in this dialog box. From the next dialog box, select the radio button next to Enable under Active Scripting.


11

• 1280 x 1024 display screen resolution (dual monitors supported)

• Microsoft .NET Framework 2.04

Note: Memory requirements can vary with the size of the job including number of files to convert, size of each file, number of graphics, tables, charts, etc. Generally, performance will increase with available memory. The values indicated above give good performance for an average job.

Note: Running WebWorks AutoMap on a virtual machine (such as VMWare) is not recommended.

Compatibility with Microsoft Windows Server

WebWorks AutoMap 9 has been tested and compatibility verified on Microsoft Windows Server 2003 Standard Edition and Microsoft Windows Server 2003 Enterprise Edition. There are no additional requirements when running WebWorks AutoMap on Microsoft Windows Server.

Compatibility with previous versions of WebWorks AutoMap

WebWorks AutoMap 9 will not convert existing WebWorks AutoMap 2003 jobs. Since WebWorks AutoMap 9 is based on the new WebWorks ePublisher Pro technology, new jobs must be created using WebWorks ePublisher Pro based projects or stationery.

Note: Running multiple versions of WebWorks AutoMap is supported allowing you to run older jobs in a previous versions of WebWorks AutoMap without interferring with the correct operaion of WebWorks AutoMap 9.

Installing WebWorks AutoMap 9

You can install the software from a CD-ROM or by downloading it from the WebWorks Download Center at http://www.webworks.com/support. You will also find updates to any Quadralay products in the Download Center on the website.

Be sure to register your software after installing it. To register, open WebWorks AutoMap and choose Product Registration under the Help menu.

Note: Unlike previous versions of WebWorks AutoMap, WebWorks AutoMap 9 does not require a WebWorks License Manager or Server in order to run and convert jobs.

Installing the software:

You must have the Microsoft .NET framework version 2.0 installed on your computer before you can install WebWorks ePublisher Pro. For information about installing .NET, visit the following Web site:

http://www.microsoft.com/downloads/details.aspx?FamilyID=0856EACB-4362-4B0D-8EDD-AAB15C5E04F5&displaylang=en

4 To obtain and install the Microsoft .NET Framework 2.0, please visit: http://www.microsoft.com/downloads/details.aspx?FamilyID=0856EACB-4362-4B0D-8EDD-AAB15C5E04F5&displaylang=en


12

Note: This product requires Microsoft .NET Framework 2.0. Microsoft does support installation of both .NET 1.1 and 2.0 simultaneously.

To install WebWorks AutoMap 9: Note: Before you install WebWorks AutoMap, ensure that you have the appropriate Windows access privileges to install new programs. See your system administrator for details or reference the user accounts section of Microsoft’s documentation for your operating system if you are unsure.

1. Ensure all applications are closed.

2. If you are installing from a CD-ROM, place the WebWorks AutoMap CD-ROM in your CD-ROM drive, and pause briefly while the installation program loads automatically. If you are installing a downloaded version of the software, double-click the downloaded WebWorks AutoMap 9.0.msi file.

Note: By default, the WebWorks AutoMap installer will be presented in the English locale. If you prefer to view the installer screens in one of the other supported locales including German, Japanese, or French you should start the installer using the provided Setup.exe file and not by double clicking WebWorks AutoMap 9.0.msi. Please see German, Japanese, and French support for more information.

Note: The actual installer filename may vary slightly depending on the version of the software you have.

Installation Wizard Follow the instructions that appear on the screen to help you quickly and easily install the WebWorks AutoMap software on your system.

Welcome The first dialog box welcomes you and tells you it will help guide you through the steps required to install WebWorks AutoMap on your computer. Click Next to continue.

License Agreement Read the WebWorks AutoMap license agreement. If you accept the terms of the license agreement, choose I Agree and then click Next to continue to the next dialog box. If you do not accept the terms of the license agreement, choose Cancel to exit the Installation Wizard. If you do not accept the license agreement, you cannot proceed with the installation.

Install WebWorks Transit In this dialog box, you can choose whether you want the installer to add the WebWorks Transit menu to Microsoft Word. WebWorks Transit brings additional functionality to Microsoft Word, letting you apply conditions and markers to your content that can help you customize the appearance of your online content. Quadralay recommends that you leave the checkbox checked and install the menu. If you do not want to install the WebWorks Transit menu, uncheck the Install the WebWorks Transit menu plug-in for Microsoft Word checkbox. Click Next to continue to the next dialog box.

Note: If Microsoft Word is not installed on the system, Transit for Word will not install it’s components for Microsoft Word.

Create Application Shortcuts Choose whether you want the installer to add shortcuts for WebWorks AutoMap to your quick launch taskbar and/or desktop. Choose Add a Shortcut to Quick Launch to add a WebWorks AutoMap shortcut to your quick launch taskbar. Choose Add a Shortcut to the Desktop to add a WebWorks AutoMap shortcut to your desktop. Click Next to continue.


13

Select installation folder Enter the location where you want to install WebWorks AutoMap on your system. If you want a different location from the default location shown in the dialog box, click Browse and specify a new location.

The Disk Cost button enables you to see the drives available to you for installing WebWorks AutoMap, along with each drive’s available and required disk space, and the difference between the two.

Additionally, you are prompted to specify whether you want anyone who uses this computer or just yourself to have access to WebWorks AutoMap. Choose Everyone or Just me, and then click Next to continue.

Confirm Installation The installer is ready to install WebWorks AutoMap on your computer. Click Next to begin the installation.

Installing WebWorks ePublisher Pro The Installation Wizard installs WebWorks AutoMap onto your computer.

During the installation, a dialog box appears asking if you want to install HTML Help Workshop 1.3. HTML Help Workshop is required only if you plan to use the HTML Help format. If you choose to install the Microsoft HTML Help components and you are running Microsoft Windows 2000 or Windows XP, the Setup program may display a message that says, “This computer already has a newer version of HTML Help.” You can click OK and safely ignore this message.

License Information In the Key field, enter your license key(s) for WebWorks AutoMap, and then click the Add Key button. Repeat for each license key you purchased. Click OK to complete the installation.

Note: License keys can be added and managed at a later time directly in the application. See Configuring license keys for more information.

Installation Complete A final dialog box lets you know that the installation was successful. Click Close to exit the Installation Wizard.

3. After installation is complete, launch WebWorks AutoMap by selecting WebWorks → AutoMap 9.0 → WebWorks AutoMap 9.0 from the Start menu. If you installed the software to a location other than this default location, launch the software from that location.

Uninstalling the Software

To uninstall the WebWorks AutoMap software, select Control Panel → Add/Remove Programs from the Start menu. Select WebWorks AutoMap 9. Click Remove and then click Yes. The software uninstalls.

The uninstall process does not remove any existing WebWorks AutoMap job folders. If you want to delete the job folders and related files, you must delete them manually.

Running WebWorks AutoMap with Norton AntiVirus Software

The Norton AntiVirus Office plug-in has been known to cause problems when using parts of the Microsoft Office Suite. You may encounter problems when attempting to create and generate


14

online content using Microsoft Word and WebWorks AutoMap, if you have installed any of Symantec’s Norton AntiVirus software.

If you encounter any error messages indicating compatibility issues while working with WebWorks AutoMap, refer to the following Microsoft Knowledge Base article:

http://support.microsoft.com/kb/329820

WebWorks AutoMap 9 User Guide: WebWorks AutoMap with WebWorks ePublisher Pro

15

WEBWORKS AUTOMAP WITH WEBWORKS EPUBLISHER PRO

WebWorks AutoMap and WebWorks ePublisher Pro provide an integrated system for designing and automating the online content process. It is important to understand the relationship between these two products in order to take full advantage the WebWorks product workflow.

This chapter includes the following sections defining terminology and explaining the interactions and capabilities of each product including:

• WebWorks product workflow • Preparing source documents • Working with formats, stationery, projects, and jobs • WebWorks AutoMap job types

WebWorks product workflow

WebWorks products are designed to work together, complimenting each others features and providing an integrated solution for delivering online content. Whether that is product documentation, policies and procedures, internal communication, or any information intended to be published for online presentation.

The core of the WebWorks product workflow is WebWorks ePublisher Pro. WebWorks ePublisher Pro is a designer tool providing an easy to use interface for quickly customizing numerous web-based look and feel properties. In addition, WebWorks ePublisher Pro provides capabilities supporting single source content delivery so that a single set of source documents can be converted to multiple online formats including print, HTML, XHTML, XML, eBooks, and online Help systems such as WebWorks Help, JavaHelp, Oracle Help, and Microsoft Windows based Help systems – in a single authoring environment.

Working with source document creation tools such as Adobe FrameMaker and Microsoft Word, along with WebWorks ePublisher Pro, users create customized content and convert to any of the supported or user customized outputs. However, conversions using WebWorks ePublisher Pro are a manual process and in some cases can take some time to complete. This is where WebWorks AutoMap comes in.

WebWorks AutoMap takes over where WebWorks ePublisher Pro capabilities end. Once an output format has been configured as desired in WebWorks ePublisher Pro, additions and changes to the source documents may continue. This requires constant re-generation of the output files which would be a tedious and manual process to do in WebWorks ePublisher Pro, especially when the formats no longer require modifications.

WebWorks AutoMap solves this problem by providing a scheduler to automatically convert WebWorks ePublisher Pro projects or new jobs based on WebWorks ePublisher Pro stationery. As many jobs as necessary can be scheduled to convert at any time increasing productivity, removing the need for manual processes, and ensuring accuracy by always have the latest content available when needed.

For example, once a format is configured, a WebWorks AutoMap job is created to automatically convert source documents using the custom styles and settings as defined in WebWorks ePublisher Pro. This job can be scheduled to run on a regular basis, for example every morning at 2:00am. Work on the source Adobe FrameMaker or Microsoft Word files can continue and


16

every morning the job runs converting the new changes. This ensures that at the start of each workday, output is available that is not only formatted properly but also includes the very latest source document changes from the previous day.

WebWorks AutoMap is not limited to scheduling existing WebWorks ePublisher Pro projects. In fact, WebWorks AutoMap can create new projects based on WebWorks ePublisher Pro stationery. This provides an even greater potential for increasing productivity and accuracy for delivering your online content.

WebWorks AutoMap jobs can be created based on WebWorks ePublisher Pro stationery and then source documents assigned to the job. Configurations can be made directly in WebWorks AutoMap, or retain them from the stationery. This capability allows creating a single stationery including all format customization and then assigning it to many online output jobs to generate. This concept not only speeds productivity by reusing the same stationery for many outputs but also ensure conformity across outputs increasing accuracy and consistency between publications.

For example, an organization may be creating four separate books for online publication. Although the topic of each book differs greatly, the organization wants the format, look, and feel to be the same across all four. Further, the four books will be developed on different schedules and delivered at different times by different teams of writers. This common scenario is easily addressed using WebWorks ePublisher Pro and WebWorks AutoMap. A single stationery is created using WebWorks ePublisher Pro. Four separate jobs are created and scheduled in WebWorks AutoMap using the WebWorks ePublisher Pro stationery. These jobs run every night and the outputs are ready for review at the start of each morning. Work on each book progresses independently and any modifications to the stationery are seamlessly reflected in each book.

Note: For more information on using WebWorks ePublisher Pro, please see the documentation guide included with that product, or contact Quadralay for more information.

Preparing source documents

WebWorks AutoMap and WebWorks ePublisher Pro are capable of converting source documents from Adobe FrameMaker and Microsoft Word with no special modifications necessary. By default, WebWorks AutoMap will use the paragraph formatting as defined in the source document(s).

However, more flexibility and control can be obtained when paragraph styles are used. Further, WebWorks AutoMap is capable of understanding markers, fields, variables, and conditions, and provides controls for customizing those values on a per job basis.

For more information on properly preparing your source documents or including special WebWorks fields in your source documents, please refer to the WebWorks ePublisher Pro documentation. Information on setting field, variable, and condition values in WebWorks AutoMap is available in WebWorks AutoMap Jobs.

Working with formats, stationery, projects, and jobs

WebWorks AutoMap works with different files and structures to perform its tasks along with accomplishing integration with WebWorks ePublisher Pro. Understanding these interactions requires learning some terminology and the differences between each of these structures and file types. Some of these files have common capabilities but are used in different situations to meet a specific need. Others only serve a single purpose for a particular product.

This section explains the terminology and helps define when to use each including:


17

• What are formats? • What are user formats? • What is stationery? • What are the differences between formats and stationery? • What are projects? • What are jobs? • What happened to WebWorks templates?

What are formats?

Formats refer to the base outputs included with WebWorks AutoMap and WebWorks ePublisher Pro. They are the starting point for all WebWorks AutoMap jobs and WebWorks ePublisher Pro projects. Each format produces a specific type of output.

The formats are provided and maintained by Quadralay. Although formats can be customized and new formats may be created by end users, the format terminology refers to those formats as delivered by Quadralay in WebWorks AutoMap and WebWorks ePublisher Pro.

The following is a list of formats currently provided in WebWorks products:

• Dynamic HTML

• Simple HTML

• Microsoft HTML Help

• Oracle Help

• Sun JavaHelp 1.3

• Sun JavaHelp 2.0

• WebWorks Help 5.0

• WinHelp

• Microsoft Reader

• Palm Reader

• XML+XSL

Where are format files?

Formats reside in a ‘Formats’ folder at the root of your WebWorks AutoMap and WebWorks ePublisher Pro installation directory. They are implemented as many different files serving various purposes; therefore, specifying a single file or file extension is not relevant to formats.

Note: In general, an understanding of formats is not necessary for the regular use of WebWorks AutoMap.

What are user formats?

User formats are either formats that have been modified by end users or brand new formats created by end users. In this sense, modifying a format does not refer to changes made in a WebWorks AutoMap job or WebWorks ePublisher Pro project. Rather it refers to


18

customizations to the underlying XSL or other structure in the format folder. Customizing a format is an advanced concept and requires an understanding of the WebWorks ePublisher Pro processing engine. Any change made within the product itself does not constitute a customization to the format.

Further, it is possible for users to create brand new formats not based on those provided by Quadralay. This allows targeting a new or custom output but still utilizing all of the advantages provided by the WebWorks product workflow.

Note: Advanced customizations are not covered in this manual. A separate Developer manual will be available explaining this process. Please contact Quadralay for more information concerning availability of this information, or for a quote to build a custom format to meet your needs.

Where are user format files?

User formats may be installed anywhere other than the formats folder. WebWorks AutoMap provides an application preference for specifying the User Formats Folder.

What is stationery?

Stationery contains all WebWorks ePublisher Pro project configurations except for document overrides and source documents themselves. Stationery includes style configurations, variables, conditions, targets, etc. By saving a project as stationery, configurations for a format can be repeatedly reused by WebWorks AutoMap and WebWorks ePublisher Pro for converting any source documents.

Where are stationery files?

Stationery can be installed anywhere accessible to the project or job including a network or shared volume. Stationery files include a .wsp (WebWorks Stationery Project) extension and are saved in their own folders.

Note: Individual stationery folders should be copied to new locations in their entirety to prevent lost information or unexpected results.

What are the differences between formats and stationery?

Formats are base outputs as provided by Quadralay. They contain no user specified configurations or settings. Stationery may be associated with one or many formats and include all user adjusted settings and configurations.

Formats can be viewed as the starting point identifying a base output type. Stationery are configurations of a format meeting specific user needs which are reused as often as necessary. This removes the requirement of re-specifying every configuration each time a new project or job is created.

What are projects?

Projects in this context refer specifically to projects created and maintained by WebWorks ePublisher Pro. For detailed information on creating and working with WebWorks ePublisher Pro projects, please see the documentation included with that product.

Note: Although WebWorks AutoMap may create projects, these are generally used by WebWorks AutoMap behind the scenes and should not be manipulated directly.


19

Where are project files?

By default, WebWorks ePublisher Pro creates and stores project files in:

\Documents and Settings\username\My Documents\ePublisher Pro Projects

username represents the login name of the current user and not the actual value as written. The default path can be changed in the WebWorks ePublisher Pro application preferences. Project files have a .wep (WebWorks ePublisher Project) extension. Project files depend on other files located in the project folder and should not be moved or copied independently.

What are jobs?

Jobs are entries that WebWorks AutoMap schedules for conversion. There are two different types of jobs in WebWorks AutoMap:

• Project-based jobs • Stationery-based jobs

Where are job files?

By default, job files are created in:

\Documents and Settings\username\My Documents\WebWorks Automap\Jobs

username represents the login name of the current user and not the actual value as written. The default path can be changed in the WebWorks AutoMap application preferences. Job files have a .waj (WebWorks AutoMap Job) extension. Job files depend on other files located in the job folder and should not be moved or copied independently.

Note: In general, the location of job files and their extensions are unimportant in the daily use of WebWorks AutoMap. This information is included for completeness or in the event that you wish to move your job files to a new location.

What happened to WebWorks templates?

WebWorks templates refer to the older WebWorks Publisher based model and have no meaning in WebWorks AutoMap or WebWorks ePublisher Pro, although formats and stationery accomplish what templates did.

The problem with the old templates is that they did not distinguish between the original output formats provided by Quadralay, user customized versions of those formats, and the Publisher project itself. Since it was impossible to distinguish what Quadralay provided from what users customized, it was impossible to migrate templates when new versions of WebWorks Publisher were made available.

This was obviously a major problem. The new project/format/stationery methodology ensures proper migration when future versions of WebWorks products are released. Further, this allows Quadralay to provide updates to existing formats which will instantly update previously configured stationery. This was never possible using templates.

Note: The elimination of the templates nomenclature is to provide clarification through the use of the more specific project, format, and stationery terms. This prevents confusion between WebWorks ePublisher Pro and legacy Publisher based products. No capabilities are lost using the template replacements.


20

WebWorks AutoMap job types

Starting with WebWorks AutoMap 9, two different but very useful jobs types can be created and scheduled:

• Project-based jobs • Stationery-based jobs

Note: Previous versions of WebWorks AutoMap could only create stationery (template) jobs. Project based jobs are new to WebWorks AutoMap 9.

Project-based jobs

Project-based jobs are the simpler of the two WebWorks AutoMap job types. In essence, when using project-based jobs, WebWorks AutoMap acts only as a scheduler for a WebWorks ePublisher Pro project.

This is a highly convenient feature when you have a configured WebWorks ePublisher Pro project and it just needs to be scheduled for regular conversions. The only information necessary is a job name, the project to schedule, and which project targets are intended to be converted. Optionally, pre-build and post-build scripts can be specified.

Project-based jobs are useful for when you have a single project that is unlikely to require other similar projects. It is also a fast and easy way to quickly set up a project for scheduled conversions utilizing everything already specified in the project.

For information on creating project-based jobs, see Creating and working with project-based jobs.

Stationery-based jobs

Stationery-based jobs reflect the real value of WebWorks AutoMap and provide very powerful reuse and productivity increasing capabilities.

Stationery-based jobs start with choosing a WebWorks ePublisher Pro stationery that has already been configured. Then, source documents are associated. These source documents could be the same ones that the stationery was configured with in WebWorks ePublisher Pro but they do not have to be – that is the value of using stationery. New or different source documents can be associated with the job and converted by the rules specified in the stationery. The same stationery can be used to create other new jobs associating other source documents reusing the design work done in WebWorks ePublisher Pro and saved in the stationery.

WebWorks AutoMap stationery-based projects also provide functionality for setting variables, conditions, formats settings, and merge settings for building complex outputs. These are all managed on a per job basis and can be scheduled for conversion at any time.

Stationery-based jobs are useful when multiple output content is required but all should have the same look, feel, and behavior. Stationery-based projects also provide much finer control over conversion parameters and settings than project-based jobs.

For information of creating stationery-based jobs, see Creating and working with stationery-based jobs.

WebWorks AutoMap 9 User Guide: WebWorks AutoMap User Interface

21

WEBWORKS AUTOMAP USER INTERFACE

This section describes how to start and work with the WebWorks AutoMap user interface. It contains the following sections:

• Starting WebWorks AutoMap • Overview of the WebWorks AutoMap user interface • Setting application preferences

Starting WebWorks AutoMap

WebWorks AutoMap features an easy-to-use Graphical User Interface (GUI) that allows you to effortlessly set up WebWorks AutoMap conversions of your documents to run either immediately or at any time.

This section gives you the basic information you need in order to start using WebWorks AutoMap including:

• Opening WebWorks AutoMap • Configuring license keys

Opening WebWorks AutoMap

The WebWorks AutoMap application can be started in the following ways:

• Choose WebWorks AutoMap from the Start menu.

• Choose the WebWorks AutoMap icon from the Windows Quick Launch bar.

• Choose the WebWorks AutoMap icon from the Windows Desktop

Note: The WebWorks AutoMap icons will only be available in the Windows Quick Launch bar and Windows Desktop if you chose to install them during installation. By default, these options were enabled in the installer.

To open WebWorks AutoMap: • Choose Start → All Programs → WebWorks → AutoMap 9.0 → WebWorks AutoMap

9.0

When you open WebWorks AutoMap, you will be presented with the WebWorks AutoMap main window:


22

Configuring license keys

During installation, it was possible to enter license keys for each adapter including Adobe FrameMaker and Microsoft Word. It is possible to manage your installed license keys directly in the WebWorks AutoMap user interface.

Note: WebWorks AutoMap no longer requires a separate License Manager application or server.

To add a license key: 1. Choose Help → License Keys…

2. Enter or paste a new license key into the Key field.

3. Click the Add Key button.

4. Repeat as necessary for other keys.

5. Click OK to save your changes.

To delete a license key: 1. Choose Help → License Keys…

2. Select the existing license key from the list.

3. Click the Delete Key button.


23

4. Repeat for each key you want to delete.

5. Click OK to save your changes.

Overview of the WebWorks AutoMap user interface

WebWorks AutoMap includes an updated user interface, making set up, and scheduling jobs easier than ever before.

The WebWorks AutoMap window gives you control of all aspects of your WebWorks AutoMap jobs. With WebWorks AutoMap, you can create, run, and modify your jobs quickly and easily. You can also see the status of each job, including when it last ran and when it will run again.

This section describes all of the controls in WebWorks AutoMap and includes the following sections:

• WebWorks AutoMap menus • WebWorks AutoMap contextual menus • WebWorks AutoMap toolbar • WebWorks AutoMap status information

WebWorks AutoMap menus

WebWorks AutoMap contains four menus for creating, editing, managing, and scheduling WebWorks AutoMap jobs. The following menu items will be discussed in more detail:

• File menu • Edit menu • Job menu • Help menu

Note: Depending on WebWorks AutoMap status, some menu items may be disabled. Only operations that are possible at a given time will be enabled.

File menu

Icon Menu item Description

Menus Toolbar Jobs


24


New Job Creates a new job.

Exit Exits the WebWorks AutoMap application.

Edit menu


Copy Copy contents to the system clipboard.

Paste Paste contents from the system clipboard.

Preferences... Manage application preferences.

Job menu


Run Run the selected job(s).

Stop Cancel the selected job.

Edit Edit the selected job.

Duplicate Duplicate the selected job.

Rename Rename the selected job.

Delete Delete the selected job(s).


25


Schedule Job Schedule the selected job in the Windows Scheduler.

Suspend Job Schedule

Suspend the selected job in the Windows Scheduler.

Resume Job Schedule

Resume the selected job in the Windows Scheduler.

View Log Display the last log for the selected job in Windows Notepad.

Explore Job Location

Opens the folder containing the selected job in the Windows file explorer.

Explore Output for Target

Opens the folder containing the selected targets output in the Windows file explorer.

Explore Jobs Folder

Opens the WebWorks AutoMap jobs folder as specified in the application preferences.

Help menu

Menu item Description

License Keys… Opens the license key configuration manager.

Contents Displays the WebWorks AutoMap online user guide table of contents.

Index Displays the WebWorks AutoMap online user guide index.

Search Displays the WebWorks AutoMap online user guide search.

WebWorks.com Go to the main WebWorks home page.

Technical Support Go to the main WebWorks Support home page.

Update Center Go to the WebWorks Update Center home page.

About AutoMap… Displays the WebWorks AutoMap version information.


26

WebWorks AutoMap contextual menus

WebWorks AutoMap also contains a contextual menu available by selecting a job or multiple jobs and right clicking. This menu contains the same options as the Job menu making it easier to select options when working with jobs.

Note: Depending on the type and number of jobs selected, some contextual menu items may be disabled. Only operations that are possible for the current selection will be enabled.

Using the contextual menu 1. Select the job(s) desired.

2. Click the right mouse button.

3. Select the job operation from the contextual menu.

WebWorks AutoMap toolbar

WebWorks AutoMap gives you quick access to most of the menu items via the tool bar. The following table describes each of the toolbar buttons.

Note: Depending on the type and number of jobs selected, some toolbar buttons may be disabled. Only operations that are possible for the current selection will be enabled.

WebWorks AutoMap toolbar buttons

Tool bar button Description

Create a new job.


27

Tool bar button Description

Open the selected job for editing.

Delete the selected job(s).

Schedule the selected job.

Open the log file for the selected job.

Duplicate the selected job.

Run the selected job.

Cancel the selected job.

Open the Preferences dialog.

WebWorks AutoMap status information

WebWorks AutoMap contains several columns that give you information about the status of your jobs. The following table describes each of these columns:

Column Name Description

Name Displays the name of each job.

Last Result Displays the result of the last conversion.

OK = Job completed successfully.

WARNINGS = Job completed with warnings.

ERROR = Job encountered general errors.

DEPLOYMENT ERROR = The job could not deploy to the output location specified.

LICENSE ERROR = Job attempted to run but could not locate a valid license key.


28

Column Name Description

ABORTED = The job was aborted by the user.

Status Displays the current status of the job.

Running = Job is currently running.

Ready = Job is not currently running.

Last Run Displays the date and time of the last conversion.

“Never” means that the job has never converted.

Next Run Displays the date and time the job will run next.

“Never” means the job is not scheduled to run a conversion.

Scheduled Displays whether the job is scheduled.

Yes = Job is scheduled.

No = Job is not scheduled.

Suspended = Job is scheduled but currently suspended.

Setting application preferences

The Preferences dialog box lets you set application preferences. Application preferences are settings which affect the behavior globally for the entire application.

The application preferences that you can set from this panel include:

• General Preferences • File Mappings • Output Destinations • Notification


29

To open the application preferences:

1. Select Edit → Preferences… or choose the Preferences… toolbar button.

General Preferences

The following sections describe each setting in the General tab:

• Setting the Job Folder location • Setting the Staging Folder location • Setting the User Formats Folder location • Automatic scanning for conditions, media types, and variables • Keeping/deleting temporary files


30

Setting the Job Folder location

The Job Folder field specifies the directory path where WebWorks AutoMap stores its job information. The Job folder contains the log file and a job file.

The log file contains information concerning the last conversion. This is a plain text file (.txt) and can be viewed with any text editor. The job file is in a proprietary XML format and includes all information describing the job. The job filename will be the same as the job with a .waj (WebWorks AutoMap Job) extension.

The default Job Folder is located at:

\Documents and Settings\username\My Documents\WebWorks Automap\Jobs

username represents the login name of the current user and not the actual value as written.

Note: WebWorks AutoMap creates the job file from information entered through the graphical user interface and utilizes this file in generating the online output. Do not edit the job file directly! Doing so can make the file unreadable by WebWorks AutoMap.

Note: The log file will only exist after the job has run at least one conversion.


31

To set the default job folder: 1. Open the application Preferences.

2. If necessary, choose the General preferences tab.

3. In the Job Folder: field, type the path to the directory or network share where you want WebWorks AutoMap to store job information, or click Browse and navigate to the directory or network share.

4. Click OK to save your settings.

Setting the Staging Folder location

The Staging Folder field specifies the default directory path where jobs store information necessary for converting the job. This includes the automatically generated WebWorks ePublisher Pro project, intermediate data files, and the output files. In essence, the staging folder is a working directory for processing the job.

The output of your project will also be written to the target output destination specified when the project was created.

The default Staging Folder is located at:

\Documents and Settings\username\My Documents\WebWorks Automap\Staging


Note: WebWorks AutoMap creates the staging folder contents from information entered through the graphical user interface and utilizes this information in generating the online output. Do not edit these files directly! Doing so may corrupt the WebWorks AutoMap job.


32

To set the default staging folder: 1. Open the application Preferences.


3. In the Staging Folder field, type the path to the directory or network share where you want WebWorks AutoMap to store the Job projects and output created during your conversions, or click Browse and navigate to the directory or network share.


Setting the User Formats Folder location

The User Formats Folder field specifies the default directory path that WebWorks AutoMap searches for custom user formats.

The default User Formats Folder is located at:

C:\Documents and Settings\username\My Documents\ePublisher Pro User Formats



33

To set the default user formats directory: 1. Open the application Preferences.


3. In the User Formats Folder field, type the path to the directory or network share where you want WebWorks AutoMap to find the custom user formats you want to use for creating jobs, or click Browse and navigate to the directory or network share.


Automatic scanning for conditions, media types, and variables

The Always scan for variables and conditions checkbox specifies whether WebWorks AutoMap should automatically scan for updated conditions and variables when panels displaying these values are presented.

By default, WebWorks AutoMap does not automatically scan for conditions and variables. To manually scan your documents for these values, click the Scan Documents button in the corresponding panels. The initial setting is disabled to prevent time wasted scanning when conditions or variables may not have changed since last opening the conditions or variables panels.

If you prefer that these panels always display updated condition and variable values, you may enable this setting. Depending on the number and size of files included in the job enabling this setting could take up to several minutes to complete the scan whenever presenting the conditions and variables panels.


34

To set automatic scanning: 1. Open the application Preferences.


3. Select the Always scan for variables and conditions checkbox.


Keeping/deleting temporary files

The Delete temporary files after generating checkbox tells WebWorks AutoMap whether it should retain or clean up files created in the Staging folder.

By default, this option is disabled and should be enabled only as a means for examining the actual project and intermediate files created and used during the conversion process. If you do not wish to examine these files, then you can disable this option and reduce the amount of disk space consumed.


35

To delete temporary files: 1. Open the application Preferences.


3. Enable the Delete temporary files after generating checkbox.


File Mappings

WebWorks ePublisher Pro 9 introduced the concept of file mappings to allow mapping a file through its extension to a source document adapter. This was done for several reasons including:

• Determine which source application should process a file that can be handled by multiple source applications. For example, text files with a .txt extension can be processed with both Adobe FrameMaker and Microsoft Word. The File Mappings panel allows you to choose which application to use in cases where multiple applications can be used.

• Use custom or proprietary file extensions. You may give your Adobe FrameMaker or Microsoft Word source file a non-standard file extension. For example, instead of using .doc for Microsoft Word files you may wish to use a more meaningful extension to your organization such as .word or .src. The File Mappings panel allows you to add your custom extension and map it to the appropriate source application adapter.

• Facilitates new input formats in the future. Quadralay plans to add more input formats in the near future, including XML formats. Since XML is a common format, the source files are usually given unique and descriptive file extensions. The File Mappings panel ensures that your projects are ready to handle any future input sources.

Note: Only the source application adapters installed will be shown in the File Mappings user interface.


36

Note: A license key is required for converting files mapped to an adapter. WebWorks AutoMap and WebWorks ePublisher Pro will allow creating and managing jobs and projects to use an adapter; but if a valid key is not available, the files will not convert.

To add a new file mapping: 1. Open the application Preferences.

2. Choose the File Mappings preferences tab.

3. Click the Add button.

4. Type a file extension to be mapped into the File extension field.

5. Select one of the installed source adapters from the Adapter (Tool) popup.

6. Click OK to save the new mapping.


To modify an existing file mapping: 1. Open the application Preferences.


3. Select a file extension from the File Extension column.

4. Choose the appropriate source application adapter from the Adapter column.


To delete a file mapping: 1. Open the application Preferences.


37


3. Select a file extension from the File Extension column.

4. Click the Delete button.


Output Destinations

WebWorks AutoMap allows managing and editing output locations independent of a job. This gives the ability to set up some or all of your output locations and then select the one that you want to use when new jobs are created.

Note: It is still possible to create new output locations as the last step in the new job wizard.

WebWorks AutoMap supports outputting to a folder or to a WebDAV server. Folder refers to a local or a shared file system (for example C:\helpdocs or \\server\share). HTTP/WebDAV refers to a web-based location supporting the WebDAV protocol.

Note: WebWorks AutoMap only supports basic authentication for WebDAV. For more information on the WebDAV protocol, please see http://www.webdav.org/.

Note: Project-based jobs only deploy if a deploy target is set in the project itself. This is specified in the Format Settings in WebWorks ePublisher Pro. WebWorks AutoMap only reads the deploy target name from the WebWorks ePublisher Pro project; therefore, you must create that same deploy target name and define its location in WebWorks AutoMap. Failure to do this will result in a deploy error. See Creating and working with project-based jobs.

To add an ouput destination: 1. Open the application Preferences.

2. Choose the Output Destinations preferences tab.


38

3. Choose the type of destination from the Add button popup.

4. Give the location a name in the Name field.

5. Provide the relevant information depending on the type of destination chosen.

6. Click OK to add the new destination.


To modify output destination: 1. Open the application Preferences.


3. Select a deploy target from the Name column.

4. Click the Edit button to open the Deploy Target Editor.

5. Make your modifications in the provided fields.

6. Click OK to dismiss the Deploy Target Editor.


To delete an output destination: 1. Open the application Preferences.


3. Select a deploy target from the Name column.

4. Click the Delete button to delete the entry.


Notification

WebWorks AutoMap includes functionality to send an email notification after running a job conversion. The notification provides information about whether the job ran successfully or if it encountered any errors. Optionally, you can specify to include the log file from the job as a text file attachment to the email.


39

To configure email notification: 1. Open the application Preferences.

2. Choose the Notification preferences tab.

3. Enter the email address(es) for the recipients in the To Address field.

Note: Separate multiple email addresses using semi-colons. Alternatively, the email address may be an alias to a group, if multiple recipients are required. Please see your system administrator for setting up an email alias.

4. Enter the sender’s email address in the From Address field.

Note: The From Address specifies the email address that the email will be sent from. This is the address that will be in the To field if someone replies to a WebWorks AutoMap email notification (by hitting the Reply button in their email client).

5. Enter the Mail Server Login Information in the provided fields.

Note: WebWorks AutoMap email notification requires an SMTP email server to send emails. Please see your system administrator for more information.

Note: All WebWorks products store passwords using encryption technology built into Microsoft Windows. Although this technology is proven effective, there are no guarantees that any encryption technology cannot be compromised. If you do not want your password to be encrypted and stored, please do not use this feature.

6. Enable Always attach log to email if you wish to attach the job’s text log to the email notification.

7. Select the Enable email notification checkbox to turn on email notification.



40

Note: Email notification may be enabled and disabled at will without having to modify the actual settings. Simply toggle the Enable email notification checkbox shown below:

German, Japanese, and French support

In addition to the English language, the WebWorks AutoMap user interface has been translated into German, Japanese, and French languages. When WebWorks AutoMap starts, it will detect the operating system locale and automatically present the corresponding WebWorks AutoMap user interface.

It is possible to force WebWorks AutoMap to display a locale that is not the operating system default. For example, you can display the German user interface on an English version of Windows. However, this requires modifying an installed file which must follow a specific format. If you wish to take advantage of this capability, please contact the Quadralay Technical Support Department for detailed instructions.

Note: Quadralay worked very closely with the localization company to ensure proper translation of the WebWorks AutoMap user interface. We hope that we have accomplished this goal to your satisfaction. We would like to apologize in advance if anything was missed or translated improperly.

WebWorks AutoMap 9 User Guide: WebWorks AutoMap Jobs

41

WEBWORKS AUTOMAP JOBS

This section describes how to create and manage WebWorks AutoMap jobs which can run immediately or be scheduled to run at a later time. Topics covered include:

• Creating and working with project-based jobs • Creating and working with stationery-based jobs • Scheduling a job • Working with existing jobs

For more information on the two types of jobs and when each should be used, please refer to Project-based jobs and Stationery-based jobs respectively.

It is also worth noting that the WebWorks AutoMap main window makes a visual distinction between project-based and stationery-based jobs. Each job name is preceded by the corresponding WebWorks ePublisher Pro icon for project and stationery accordingly:

Creating and working with project-based jobs

This section describes how to create and work with project-based jobs. Project-based jobs are new to WebWorks AutoMap 9. Previous versions of WebWorks AutoMap could only create stationery (template) based jobs.

Although stationery-based jobs are much more flexible and are responsible for a huge increase in efficiency and reuse, project-based jobs are highly convenient when all you want to do is schedule an existing WebWorks ePublisher Pro project that has already been configured.

For example, let us assume that you have been working on a WebWorks ePublisher Pro project which contains some documents and a customized format. You are able to produce the output you want but would like to automate the project conversion. You could save your WebWorks ePublisher Pro project as stationery, create a stationery-based job in WebWorks AutoMap, and assign your source files to the new job and schedule it. In fact, this was the only way in previous versions of WebWorks AutoMap to do this.

With the new project-based job feature, you simply schedule the existing project itself in AutoMap! Here is how:

Project-based job icon

Stationery-based job icon


42

To create a new WebWorks AutoMap project-based job: • To create a new project-based job chose File → New Job (Ctrl+N) or click the New Job

button on the toolbar.

This will display the New Job dialog:

Job type

The first step in creating a new WebWorks AutoMap job is to choose the job type. For now, we are discussing WebWorks AutoMap project-based jobs. Stationery-based jobs are covered in Creating and working with stationery-based jobs.

Choosing the job type: 1. From the New Job dialog, choose the ePublisher Pro project radio button.

2. Type the path or click the Browse Folder icon to select the WebWorks ePublisher Pro project you want to schedule.

3. Click OK to continue.


43

Job info

The Job Info dialog provides fields to specify the name of the job and any scripts to run before and after conversion.

Entering job info: 1. Type the desired job name into the Job Name field.

2. Notice that the WebWorks ePublisher Pro project chosen in the first step is displayed in the Choose ePublisher Pro project field. If necessary, the project for a job can be changed by typing a new path to the stationery, or click the Browse Folder icon to select the desired WebWorks ePublisher Pro project file.

3. If you would like to run a pre or post build script to invoke before and after a job runs, click the corresponding Edit Script buttons. Type or paste your script into the editor as described in the Script Editor section of this documentation.

Note: It is not necessary to specify both pre and post build scripts.

4. Click Next to continue.

Target Selection

Depending on your project, there will be one or more targets specified in the Target Selection dialog panel. Targets can either be customized versions of the same format or different formats altogether.

The Target Selection panel lets you choose which targets will be converted as part of this WebWorks AutoMap job. To get any useful output, at least one target should be selected.

Note: Please refer to the WebWorks ePublisher Pro documentation for a more thorough explanation of creating and managing targets.


44

To enable and disable targets: 1. Click the checkbox in the Build column to toggle enabling/disabling for each target

displayed.

2. Click Finish to continue.

3. Scheduled the job. See Scheduling a job for more information.

Project-based job deployment

Project-based jobs only deploy if a deploy target is set in the project itself. This is specified in the Format Settings in WebWorks ePublisher Pro. WebWorks AutoMap only reads the deploy target name from the WebWorks ePublisher Pro project; therefore, you must create that same deploy target name and define its location in WebWorks AutoMap. Failure to do this will result in a deploy error. See Output Destinations for information on settings up deploy targets.

Creating and working with stationery-based jobs

This section describes how to create and work with stationery-based jobs. Stationery-based jobs exercise the real power of WebWorks AutoMap and can be a tremendous timesaver increasing productivity and reducing errors when generating online and print content.

WebWorks AutoMap stationery-based jobs allow you to associate Adobe FrameMaker or Microsoft Word documents with a configured WebWorks ePublisher Pro stationery. This combination lets you apply a single stationery to many different source documents, reusing the work required to build the presentation. This method ensures accuracy and consistency across many different outputs from an organization.

To create a new WebWorks AutoMap stationery-based job: • To create a new stationery-based job chose File → New Job (Ctrl+N) or click the New Job

button on the toolbar.


45

This will display the New Job dialog.

Job type

The first step in creating a new WebWorks AutoMap job is to choose the job type. For now, we are discussing WebWorks AutoMap stationery-based jobs. Project-based jobs are covered in Creating and working with project-based jobs.

Choosing the job type: 1. From the New Job dialog, choose the ePublisher Pro stationery radio button.

2. Type the path or click the Browse Folder icon to select the WebWorks ePublisher Pro stationery upon which to base this job.

3. Click OK to continue.

Job info

The Job Info dialog provides fields to specify the name of the job and any scripts to run before and after conversion.


46

Entering job info: 1. Type the desired job name into the Job Name field.

2. Notice that the WebWorks ePublisher Pro stationery chosen in the first step is displayed in the Choose ePublisher Pro stationery field. If necessary, the stationery for a job can be changed by typing a new path to the stationery or click the Browse Folder icon to select the desired WebWorks ePublisher Pro stationery file.

3. If you would like to run a pre or post build script to invoke before and after a job runs, click the corresponding Edit Script buttons. Type or paste your script into the editor as described in the Script Editor section of this documentation.



Documents

The Documents dialog lets you configure the groups and documents that you want to convert in this job. Optionally, you may invoke a script to retrieve documents on a per group basis. For example, you may want to retrieve documents from a version control or content management system. If so, you can provide a script to retrieve and prepare your documents accordingly.

This script will run before a conversion, thereby ensuring that you always have the most current version of your content without having to perform a manual update before each conversion.


47

Note: Starting with WebWorks ePublisher Pro 9 and WebWorks AutoMap 9, it is possible for projects and jobs to mix content from multiple sources. For example, above you see both Adobe FrameMaker and Microsoft Word documents in a single job.

Note: Although it is possible to create a single job with mixed source content, you must have license keys to convert files of a given content. Please contact Quadralay for more information on obtaining license keys.

Note: Adding groups and documents are covered more thoroughly in the WebWorks ePublisher Pro documentation. See the sections related to the Document Manager for more information on what groups are and how they are handled in WebWorks ePublisher Pro and WebWorks AutoMap.

To add documents manually:

1. Click the New Group button to create a new group.

2. Give the group a name.

3. Click the Add Document button to browse and choose your source documents.

4. Repeat steps to add more groups and source documents.


To add documents using a script:

1. Click the New Group button to create a new group.

2. Give the group a name.

3. Click the Edit Script button to invoke the script editor.


48

4. Type or paste your script into the editor as described in the Script Editor section of this documentation.


To delete groups or source documents: 1. Click to select a group or file name.

2. Click the Delete button or hit the Delete key on the keyboard.

3. Click Yes or No to the confirmation dialog.

To rename a group: 1. Select the group name.

2. Hit the F2 key on the keyboard or click again on the group name.

3. Type the new group name.

4. Hit the Enter key on the keyboard or click outside the group to accept the new name.

Target Selection

Depending on your stationery, there will be one or more targets specified in the Target Selection dialog panel. Targets can either be customized versions of the same format or different formats altogether.

The Target Selection panel lets you choose which targets will be converted as part of this WebWorks AutoMap job. To get any useful output, at least one target should be selected.

Note: Please refer to the WebWorks ePublisher Pro documentation for a more thorough explanation of creating and managing targets.


49

To enable and disable targets: 1. Click the checkbox in the Build column to toggle enabling/disabling for each target

displayed.


Target Configuration

The Target Configuration panel allows adjusting conversion parameters on a per target basis. Depending on the format of the target chosen, the Target Configuration panel may include up to five tabs for adjusting various settings including:

• Target Info • Target Conditions • Target Variables • Format Settings • Merge Settings

The information presented in each tab is relative to the target name selected in the left hand column. In other words, target values can be adjusted independently. For example, you may have two WebWorks Help 5.0 targets where the conditions are set differently depending on the target audience.

Target Info

The target Info tab provides for some general settings related to the target, including where to deploy the output after generation, whether the previous output files should be deleted before generating, and the ability to specify a pre and post build script before and after each target is converted.


50

To configure deployment: 1. Select the target to configure by clicking on its name in the Target Name column.

2. Select a pre-configured deploy location from the Deploy to popup list.

Note: Deploy targets can be pre-configured using the Output Destinations in the application Preferences.

3. To add a new deploy location click the Add Deploy Target button and configure it as explained in Output Destinations. Once added, the new location will be available from the Deploy to popup list.

4. Enable the Delete files in output location before deployment checkbox if you would like to delete any pre-existing files before converting the target.

To specify pre or post build scripts per target: 1. Select the target to configure by clicking on its name in the Target Name column.

2. Click the Edit Script button for pre or post build to invoke the script editor.

3. Type or paste your script into the editor as describe in the Script Editor section of this documentation.


Target Conditions

Conditions refer to conditional text in the Adobe FrameMaker or Microsoft Word documents. The Conditions panel provides controls for scanning and displaying the documents’ conditions as well as specifying the values to use during the conversion.


51

To scan for conditions: 1. Ensure that the correct target is selected in the Target Name column.

2. Click the Scan button to scan for all conditions in all source documents included in the job.

Note: If you have the Always scan for variables and conditions setting turned on in the application Preferences, the conditions and variables will automatically scan when entering the Target Configuration panel.

Note: The process of scanning for conditions and variables is the same. Therefore, if you scan for conditions, the variables panel will also be updated. Likewise, if you scan for variables, the conditions panel will be updated.

Choosing to show or hide conditional text: 1. Ensure that the correct target is selected in the Target Name column.

2. If necessary, click the Scan button to scan for all conditions in all source documents.

3. Click the Visible checkbox for each condition to show or hide the content represented by the given condition.

Target Variables

Variables refer to text in the Adobe FrameMaker or Microsoft Word documents that may receive their value dynamically during the job conversion. The Variables panel provides controls for scanning and displaying the documents’ variables as well as specifying the values to use during the conversion.


52

To scan for variables: 1. Ensure that the correct target is selected in the Target Name column.

2. Click the Scan button to scan for all variables in all source documents included in the job.

Note: If you have the Always scan for variables and conditions setting turned on in the application Preferences, the conditions and variables will automatically scan when entering the Target Configuration panel.

Note: The process of scanning for conditions and variables is the same. Therefore, if you scan for conditions, the variables panel will also be updated. Likewise, if you scan for variables, the conditions panel will be updated.

To change variable values: 1. Ensure that the correct target is selected in the Target Name column.

2. If necessary, click the Scan button to scan for all variables in all source documents.

3. Select the variable name to adjust by clicking on it in the Name column.

4. Edit the value in the large edit pane on the right side of the variable list.

Format Settings

Format Settings are parameters that affect how a WebWorks provided format behaves. For example, there are format settings in WebWorks Help 5.0 that determine whether the favorites tab is displayed or how to collapse the table of contents. Other fields include turning on accessibility reporting or specifying document encodings and locale.


53

In addition to settings that determine how a format should look and feel, Format Settings also include information fields for customizing your output. For example, it is possible to specify information such as a company name, logo, address, phone number, and other custom fields in effort to generate output that is customized to an organization’s presentation goals.

The Format Settings in WebWorks AutoMap are displayed and adjusted identically to that in WebWorks ePublisher Pro.

Format Settings provide a brief summary of the format settings available. For details and more information on using format settings, please refer to the WebWorks ePublisher Pro.

Note: Format Settings are saved and stored in WebWorks ePublisher Pro stationery. When selecting stationery in WebWorks AutoMap, these values will already be configured if they were changed in WebWorks ePublisher Pro. This allows a single designer to adjust the Format Settings and simply provide stationery for everyone to use. However, it is possible to override the stationery settings on a per-target basis for each job in WebWorks AutoMap.

To change a format setting: 1. Ensure that the correct target is selected in the Target Name column.

2. Select the format setting you want to change in the Setting column.

3. Change the value in the Value column.

Note: Depending on the types of values, different controls may be available. For example, if a setting can have a value of Enabled or Disabled these will be presented in a combo box. On the other hand, a URL field will be a text field for typing the link.

Merge Settings

The Merge Settings panel is used to set up multi-volume help systems. This tab is only available and displayed when using a format that supports merging helpsets. Currently this includes:


54

• WebWorks Help 5.0

• HTML Help

• Oracle Help

• JavaHelp

Multi-volume help comprises of a single set of files that combine output from multiple groups. When you merge the output files from the groups within your job, you are taking the table of contents, index, and search data from each top-level group’s generated entry-point file, and combining that information into a single, consolidated system. Currently, when you generate output for your job, each first-level group will generate its own entry-point file. In order to create one cohesive helpset, you need to merge the individual entry-point files and content.

Multi-volume helpset example

The image below demonstrates a multi-volume help system example and explains how to properly set up a merged helpset.


55

In this example, there are ten document groups that were set up in the Documents tab. The groups’ names will appear in the hierarchy when you open the Merge Settings tab. In this case, these groups reflect the names of the individual specific departments in a company (Development, Internal Sales, Legal, Hiring, etc.) They are represented as the children in the hierarchy above.

To build a single company handbook, it may be convenient to assemble these specific departments into more general categories as shown above. In this case, top-level department names were added such as Engineering, Support, Sales and Marketing, and Human Resources. These categories can be created and nested as necessary to create the desired hierarchy. Notice the Support category nested beneath Engineering. This hierarchy will determine how the table of contents is created in the merged helpset. The groups are then dragged and dropped beneath these categories accordingly.

The Title field is for assigning the name of your multi-volume helpset. This name will be displayed in the title bar when users first open the helpset. The Table of contents title lets you specify a localized name for each group name to be displayed in the table to contents. Finally, the Group context lets you specify a localized name to use as the topic context when building online help systems with context sensitive help.

Note: Group names are used to generate output filenames; therefore, they must follow the Windows file naming conventions. However, this may unnecessarily limit your choice of names to display in the table of contents. That is the purpose of being able to specify a localized name in the Table of contents title field. Similarly, the Group context works the same way.

Setting up a merged helpset:

1. Click the Add button to add new categories.

2. Arrange the categories by dragging and dropping them as required.

3. To nest categories, drag the intended child category on top of the intended parent category.

Note: Categories can only be nested beneath other categories. You cannot nest a category beneath a group name.

Category

Nested category

Groups


56

4. Arrange the groups be dragging and dropping them as required.

5. To nest groups, drag the intended group on top of the intended category.

Note: Groups can only be nested beneath categories. You cannot nest a group beneath another group name.

6. Specify a master title for the helpset in the Title text field.

7. If desired, click each group name and specify a localized Table of contents title and Group context.

Note: If values are not given for Table of contents title and Group context then the original group name will be used. It is not necessary to specify localized names for these fields.

To remove a category: 1. Click a category name to select it.

2. Click the remove button.

To rename a category: 1. Click a category name to select it.

2. Hit the F2 keyboard button or click the name again.

3. Edit the name and click the Enter keyboard button to save your changes.

Job panel navigation

When using the New Project setup panels, it is possible to navigate forward and back through the job configuration panels by clicking the Next and Previous buttons accordingly. This allows returning to panels that have already been configured to adjust values as needed.

Once the job has been configured, return to the Target Configuration panel and click the Finish button to save your changes and schedule the job. See Scheduling a job for more information on scheduling your new job.

Note: For information on editing an existing job, please see Working with existing jobs.

Scheduling a job

Immediately after creating a new job, the Windows Scheduler is invoked so that you may schedule your job to convert.

WebWorks AutoMap uses the Windows Scheduler built into the Microsoft Windows operating system. The Windows Scheduler allows scheduling a job to run at pre-determined times and repeating intervals.

If you do not wish to schedule the job at this time, click the Cancel button. The Windows Scheduler can be re-invoked at any time. If you do schedule the job, you will be prompted for your Windows login user name and password when you click OK in the Windows Scheduler dialog.


57

Windows task scheduler summary

Detailed instructions and a step-by-step guide on using the Microsoft Windows task scheduler can be found in the Windows operating system online help. To invoke the Windows online help, choose Start → Help and Support.

The following is a short summary of how to schedule a job using the Windows task scheduler. These instructions assume that you just configured a new job and hit the Finish button or selected an existing job and chose to schedule it.

How to schedule a job: 1. Click the New button in the Schedule panel.

2. Adjust the Schedule Task, Start Time, and Schedule Task Daily parameters.

3. Click OK.

Since you are scheduling a task in the Windows Scheduler, you must provide authentication to add the task.

4. Enter your user name into the User Name field. Be sure to include the domain name as shown if your organization uses a Windows domain type server.


58

Note: WebWorks AutoMap will try to detect whether it is on a domain and pre-populate this field if possible.

5. Enter your password into the Password field.

6. Click OK to schedule the job or Cancel to abort.

Working with existing jobs

The following sections describe how to edit and manage jobs including:

• Editing an existing job

• Deleting an existing job

• Scheduling an existing job

• View job log file

• Duplicate an existing job

• Run an existing job

• Cancelling a job

Editing an existing job

If you have created a job, then you already know how to edit a job. The panels for editing an existing job are identical to those used to create a job. The only exception is that there are no Next and Previous buttons. You simply select the tabs containing the information that you want to modify.

To edit an existing job: 1. Select the job to edit in the WebWorks AutoMap main window.

2. Choose Job → Edit… (Ctrl+E) or click the Edit… toolbar button.

Deleting an existing job

If a job is no longer needed, it can be deleted from the WebWorks AutoMap main window.

To delete an existing job: 1. Select the job(s) to delete in the WebWorks AutoMap main window.

2. Choose Job → Delete (Delete key) or click the Delete toolbar button.

3. Answer Yes or No to confirm whether your want to delete the job(s).

Scheduling an existing job

It is possible to change the schedule for an existing job without having to recreate the job.


59

To change the schedule of an existing job: 1. Select the job to schedule in the WebWorks AutoMap main window.

2. Choose Job → Schedule Job (Ctrl+E) or click the Schedule Job toolbar button.

3. Schedule the job as explain in Scheduling a job.

View job log file

Whenever a job generates, a log file is created documenting the generation steps performed. You may view this log file whenever one exists.

Note: WebWorks AutoMap 9 only retains the log file for the last job generation. Previous log files are no longer retained.

To view a log file: 1. Select the job in the main window.

2. Choose Job → View Log or click the View Log toolbar button.

Duplicate an existing job

Sometimes it is more convenient to make a copy of an existing job and adjust its parameters instead of creating a new job from scratch. WebWorks AutoMap provides functionality for duplicating an existing job.

To duplicate an existing job: 1. Select the job to be duplicated in the WebWorks AutoMap main window.

2. Choose Job → Duplicate (Ctrl+D) or click the Duplicate toolbar button.

3. Give the new job a name in the dialog provided.

4. Schedule the job as explained in Scheduling a job.

Run an existing job

It is possible to run a job generation at any time whether it is scheduled or not. This is a convenient way to test the job while configuring it or for impromptu generation.

To run an existing job: 1. Select the job to run in the WebWorks AutoMap main window.

2. Choose Job → Run (Ctrl+R) or click the Run toolbar button.

Cancelling a job

While a job is running, it is possible to cancel it.


60

Note: When a job is cancelled, WebWorks AutoMap, Microsoft Windows, Adobe FrameMaker, and Microsoft Word must do some clean-up work. This may take a few seconds to complete. During this process, the standard Microsoft Windows End Program dialog may appear as shown below. Please do NOT click the End Now or Cancel buttons. The dialog will dismiss itself once everything has cancelled properly (usually less than 15 seconds).

To cancel a running job: 1. Select the running job from the WebWorks AutoMap main window.

2. Choose Job → Stop or click the Stop toolbar button.

WebWorks AutoMap 9 User Guide: Script Editor

61

SCRIPT EDITOR

WebWorks AutoMap 9 includes a simple editor for specifying and writing job scripts. This new editor includes a text area for writing or pasting your script and a list of useful WebWorks AutoMap variables that can be used in your scripts or passed to other scripts/applications to enhance its capabilities.

Script writing is not required to use WebWorks AutoMap. However, they provide a way to enhance WebWorks AutoMap’s capabilities and integration with other products or custom workflows.

Scripts can be specified to run before and after a job generates, before and after each target generates, and used to retrieve source documents on a per group basis. For more information on setting up jobs, please see Creating and working with project-based jobs and Creating and working with stationery-based jobs respectively.

To open the script editor: 1. Select and open a job to edit if one is not already opened.

2. Click the appropriate Edit Script button to open the script editor window.

To edit the script: 1. Click in the text editing area.

2. Type your script or paste (CTRL+V) from the clipboard.

To insert a WebWorks AutoMap scripting variable: 1. Click in the editor window where you want the variable to appear.


62

2. Double click the variable name in the Script Variables pane to insert it

3. Alternatively, you may type the variables name surrounded with ${ }. For example, to include the project directory variable in your script type ${ProjectDir}.

Writing scripts

Scripts may be written directly in the WebWorks AutoMap script editor window or cut and pasted from another text editor. Only text-based scripts are valid. Any formatting or additional information available in a third-party script editor will be lost when the script is pasted into the WebWorks AutoMap script editor window.

In essence, a script specified in WebWorks AutoMap is treated like a DOS batch file. The script must be complete and valid otherwise it will fail when the job generates. Although in many cases, the entire script can be written directly in the WebWorks AutoMap script editor window; this may not always be the best choice.

When calling complex scripts, it may be better to leave the heavy lifting in files stored on the file system and simply call those files from the WebWorks AutoMap script editor window. Since the WebWorks AutoMap script editor window treats the scripts like DOS batch files, you may call other batch files, applications, or scripts written in any scripting language such as VBS, Perl, Python, etc. Further, you may pass parameters to the files that you are calling including passing script variables as parameters.

Some variables only have meaning for certain types of scripts. For example, the DeployFolder variable is specific to a target and will not having meaning in a pre-build or post-build job script.

Note: Please see Using scripting variablesfor more details on using WebWorks AutoMap scripting variables.

Working folder

Batch files on Windows are associated with a working folder. A working folder is the current working directory used by an application (or batch file) for processing. For example, if a batch file creates a new file without specifying a path, it will be created in the working folder. Similarly, if it attempts to read a file without a specifying a path, it is assumed to be in the working folder.

The working folder for a WebWorks AutoMap batch file is the job folder itself. This can always be located using the job directory ${JobDir} scripting variable. See Using scripting variables for more information on using WebWorks AutoMap scripting variables.

Scripting examples

The following are some scripting examples to show how the WebWorks AutoMap script editor may be used. This section includes the following examples:

• Show time and date • Using scripting variables • Revision control


63

Show time and date

The first example is trivial and simply displays the time and date in the log file by calling the time and date commands built into the DOS command line interface. In this case, the script was added as a pre-build step for the job running before the first target starts generating output.

In the output below, notice that the time and date appear before the first target begins generating. This information could be used to automatically timestamp a job log file or used in conjunction with other scripting to log elapsed time, make decisions, etc.

Using scripting variables

This example will create a simple “mini-report” inside the log file for each target in the job. It is a simple example demonstrating the use of the scripting variables. In this case, the values of the variables are displayed as part of the report using the echo command built into the DOS command line interface.

Note: The example below shows some of the variable names surrounded by single quotes. This was done only to show emphasis on the variable values in the “mini-report” example. It is not required to surround the variable names with quotes.


64

Notice the “mini-report” displayed immediately after the target starts to build. This same script could be added as a post-build step for the target and a similar “mini-report” would be generated upon completion of the target generated.

Revision control

The previous example scripts demonstrated some simple capabilities of using scripts in WebWorks AutoMap. This next script is an example of how to do something very useful when building WebWorks AutoMap jobs – checking out source files from a revision control system.

Revision control systems let you store files and retain information concerning different version of those files. Among other things, revision control systems provide for robust backups, reverting to previous versions of files, and sharing files among large groups of people. The advantage of using a revision control script to retrieve source files rather than adding them


65

directly ensures that your job is always working with the latest available version of the source files.

There are many different revision control solutions each working a bit differently. WebWorks AutoMap is not tied to a specific revision control solution but rather provides an abstract way of retrieving a file list of source files to be converted. There are a few rules concerning how this list is named and formatted but the actual creation of the file list is left entirely up to the script and scriptwriter.

In fact, the scripting capabilities in the Documents panel are not limited to checking files out of a revision control system. The only requirement is that FileList.txt includes a list of file paths of files to be included. You may access the FileList.txt file and the path to it using the WebWorks AutoMap ${FileListName} and ${FileListPath} scripting variables accordingly. For more information on WebWorks AutoMap scripting variables, see Using scripting variables.

CVS checkout

The following script example calls getfilesaction_cvs.vbs which is installed as part of the WebWorks AutoMap installation. By default, this script is located in the follow path:

\Program Files\WebWorks\AutoMap 9.0\Scripts\getfilesaction_cvs.vbs

Note: If you chose to install WebWorks AutoMap to a location other than the default location, you will need to adjust the above path accordingly.

getfilesaction_cvs.vbs is written using the Visual Basic Scripting (VBS) capabilities built into Microsoft Windows to check out files from a CVS (Concurrent Version System) server and create a file list to be processed by WebWorks AutoMap. This script is not meant to be used “as is” but is a starting point including everything necessary to set up a working script for your particular environment.

The getfilesaction_cvs.vbs script is completely documented and can be followed by someone who has scripting experience. Again, it is only a starting point. Minimally, you will need to set the CVS attributes for your user name, server name, and type of authentication, and adjust for how CVS is installed and called on your system. These areas of the script are highlighted below:


66

Below is a screenshot showing an example call of the getfilesaction_cvs.vbs script. The parameters passed indicate the module to checkout and to filter on the .doc extension. When this script runs, it checks out the indicated module from CVS, filters those files based on the .doc extension, and adds those .doc files to FileList.txt. That file list is then used for the AutoMap job conversion.


67

This is only one possible way of creating a file list of files to convert. Once you understand the mechanism that WebWorks AutoMap uses to retrieve its list of source documents to convert, you may create that list using any means you like. Whether that is a script or application, as long as it is accessible to WebWorks AutoMap, it may be invoked from the Script Editor panel.

Scripting variables

The following is a summary of the available script variables.

Variable Description Scope

FileListName Returns the name of the file containing the source documents list.

Document scripts only.

FileListPath Returns the directory path of the file containing the source documents list.


GroupName Returns the documents group name that is currently being processed.


BuildAction Returns whether the current build action is PreBuild or PostBuild.

Job scripts, target scripts, and document scripts.

JobDir Returns the directory path of the job (.waj) file.


JobFile Returns the directory path to the job file.


JobName Returns the name of the job. Job scripts, target scripts, and document scripts.

ProjectDir Returns the directory path of the temporary project file that WebWorks AutoMap created for the job.


ProjectFile Returns the file path of the temporary project file that WebWorks AutoMap created for the job.


DeployFolder Returns the deployment directory path.

Target scripts only.

ErrorCount Returns the number of errors reporting during generation.


TargetDeployKey Returns the deploy target name.



68

Variable Description Scope

TargetName Returns the name of the target being generated.


TargetOutputDir Returns the target’s directory path of the output.


WebWorks AutoMap 9 User Guide: WebWorks AutoMap Command Line Interface

69

WEBWORKS AUTOMAP COMMAND LINE INTERFACE

Although WebWorks AutoMap includes a graphical user interface (GUI) to create, edit, and schedule jobs, a command line interface is also available and included with the standard WebWorks AutoMap product release. The command line interface enables scripting control of WebWorks AutoMap from the Windows command line interface.

This chapter includes the following information:

• Running WebWorks AutoMap on the command line • Command line usage • Command line options • Specifying command line options

Note: This chapter is specific to running WebWorks AutoMap from the command line. It is not a guide on using the Windows command line interface or writing command line scripts.

Running WebWorks AutoMap on the command line

WebWorks AutoMap is accessed from the command line as any Windows command line application would be. In fact, the WebWorks AutoMap command line application is called WebWorks.Automap.exe. This application is installed at the root of your WebWorks AutoMap installation. The default location is:

C:\Program Files\WebWorks\AutoMap 9.0\WebWorks.AutoMap.exe

Note: If you chose a different location when you installed WebWorks AutoMap, then WebWorks.Automap.exe will be installed to that location and your paths should be adjusted accordingly.

Note: WebWorks.Automap.exe depends on other files installed in the WebWorks AutoMap directory. You cannot move or copy WebWorks.Automap.exe independently.


70

Running WebWorks.AutoMap.exe: 1. Open a Windows command line interface (DOS window).

2. Type cd “C:\Program Files\WebWorks\AutoMap 9.0”.

Note: If you installed WebWorks AutoMap to a directory other than the default, use the corresponding path.

3. Type WebWorks.AutoMap.exe and hit the Enter key.

Command line usage

If you run the command line interface without options or parameters, WebWorks AutoMap will return a typical usage clause:

WebWorks Automap 9.0.6536.1 Usage: WebWorks.Automap.exe [-f|--nonotify] [-s|--stagingdir directory] [-u|--userformats directory] [-t|--target target1,target2] [-n|--nodeploy] [-c|--clean] [-l|--cleandeploy] [-k|--keys] ePublisher Pro project or Automap job file

The first line displays the application name followed by the version number. In this case, the version is 9.0.6536.1. This information is useful to determine the exact version of the product that you have installed.

Next, is the usage clause itself describing how to run WebWorks AutoMap. Shown is the WebWorks AutoMap command line application WebWorks.AutoMap.exe followed by the options that can be passed to the command line, and the expected application parameter.

The WebWorks AutoMap command line options are described in more detailed in the next section. The command line parameter in this case is either a WebWorks ePublisher Pro project (.wep) or WebWorks AutoMap job file (.waj). Just as the WebWorks AutoMap GUI interface can schedule a project-based or stationery-based job, the WebWorks AutoMap command line can schedule a WebWorks ePublisher Pro project or WebWorks AutoMap job.

The following is an example of how the WebWorks AutoMap command line application may be called:

WebWorks.AutoMap.exe -s=”c:\Jobs\Staging” –t=”WebWorks Help” “c:\Projects\MyProject.wep”

In this case, WebWorks AutoMap will run the MyProject.wep job located in c:\Projects. The staging folder is set to c:\Jobs\Staging and only the WebWorks Help target will be generated.

Command line options

As with any command line application, WebWorks AutoMap includes command line options to specify how WebWorks.AutoMap.exe should run. The table below lists all of the available WebWorks AutoMap command line options.

Option Function

-u --userformats=directory path

The directory containing the user formats. This setting overrides the value in the WebWorks AutoMap preferences. See


71

Setting the User Formats Folder location.

The default value is taken from the WebWorks AutoMap preferences.

-t --target=target1, target2,…

Builds the specified targets only. This option is only used when passing a WebWorks ePublisher Pro project (.wep). See Target Selection.

The default value is to build all targets.

-n --nodeploy

Do not deploy output, only generate. This setting overrides any Deploy setting in the WebWorks AutoMap job or WebWorks ePublisher Pro project. See Target Info.

The default value is to use the Deploy setting specified in the WebWorks AutoMap job or WebWorks ePublisher Pro project.

-c --clean

Build from scratch and throw away any cached information. This option is only used when passing a WebWorks ePublisher Pro project (.wep). This option is equivalent to performing a Regenerate All in WebWorks ePublisher Pro.

The default value is to only generate what is necessary and use any available cached information.

-l --cleandeploy

Delete everything in the deploy location before deploying the next generation. This is to ensure that everything located in the deploy folder is only from the last generation.

-s --stagingdir=directory path

Specifies the staging directory to use. This option is only used when passing a WebWorks AutoMap job (.waj). This setting overrides the value in the WebWorks AutoMap preferences. See Setting the Staging Folder location.


-f --nonotify

Do not send an email notification when this job completes. This setting overrides the value in the WebWorks AutoMap preferences. See Notification.


-k Displays the list of license keys installed in


72

Specifying command line options

Command line options are specified on the command line after the application name as with any command line application. Multiple command line options are separated by a space. Here are some additional notes concerning WebWorks AutoMap command line options:

• The command line options have both shortened and verbose formats. For example, the clean option can be specified as –c or --clean. Both mean exactly the same thing and it is possible to mix the shortened and verbose formats across the options.

• Some options require specifying additional information. For example, the staging folder option is specified as --stagingdir=directory path. The equal sign must be included without spaces on either side.

• In cases where directory paths are specified, it is recommended, but not required, to include those paths in double quotes. This is to handle any paths that may contain spaces. For example, c:\projects will work as expected; however, c:\my projects will fail. The correct format for the latter is “c:\my projects”.

• The --target option is capable of taking one or more target names. Multiple target names are separated with commas but no spaces. For example, --target=one, two, three will fail. The correct format is --target=one,two,three (no spaces).

--keys WebWorks AutoMap. See Configuring license keys.

WebWorks AutoMap 9 User Guide: Format Settings

73

FORMAT SETTINGS

The follow table summarizes the common collection of format settings spanning the currently supported formats included with WebWorks ePublisher Pro and WebWorks AutoMap. This table gives a brief summary of each format setting and is not meant as a complete description or usage instructions.

For more information on using and setting format settings, please refer to the WebWorks ePublisher Pro documentation.

Note: The following table summarizes all format settings. Not all settings are available in every format. However, the purpose of a format setting remains consistent between those that are shared across multiple formats. For example, Encoding means the same thing in WebWorks Help as it does in HTML Help and all other formats that use this setting.

Format Setting Summary

Automatically synchronize the TOC

Determines whether the table of contents will redraw its focus when clicking in the content pane.

Collapse table of contents Determines how the table of contents is built and displayed.

Company email address Email address to display in the company information. (Example: [email protected]).

Company fax number Fax phone number to display in the company information.

Company logo image Logo image to display in the company information. The image must be placed in the User Files folder before it can be chosen.

Company name Name to display in the company information.

Company phone number Phone number to display in the company information.

Company webpage URL to display in the company information. This URL must be fully qualified (ex. http://www.webworks.com)

Enable search tab Determines whether the search tab should be displayed in the output viewer.

Encoding Determines the text encoding of the files to be generated.

External URL target Determines how external URLS are opened when clicked in the output.

Generate a combined PDF per top level group

Determines whether a single PDF file should be generated for each group in the Document Manager.

Generate a PDF per document Determines whether a PDF file should be generated for each file in the Document Manager.

Generate accessibility report Determines whether an accessibility report should be generated.

Generate index Determines whether an index should be generated.


74


Generate table of contents Determines whether a table of contents should be generated.

Helpset title Determines the title of the Helpset.

HTML Help binary index Determines the binary index of the Microsoft HTML Help helpset.

HTML Help custom map file Determines the map file to be used for generating the Microsoft HTML Help helpset.

HTML Help Location Determines the location to find the installed Microsoft HTML Help.

Include visible [D] links to images with long descriptions

Determines whether [D] links should be included.

Index filename Determines the file name of the generated index file.

JavaHelp location Determines the location to find the installed JavaHelp.

JDK location Determines the location to find the installed Java JDK.

Locale Determines the locale for which output is being generated.

Page break handling Determines how pages should break in the generated output.

PDF job settings Determines how PDFs will be generated.

Show bookmark toolbar button Determines whether the bookmark button should be displayed in the toolbar of the output.

Show favorites tab Determines whether the favorites tab should be displayed in the output.

Show PDF button Determines whether the PDF button should be displayed in the toolbar of the output.

Show previous & next toolbar buttons

Determines whether the previous and next buttons should be displayed in the toolbar of the output.

Show print toolbar button Determines whether the print button should be displayed in the toolbar of the output.

Show related topics inline button Determines whether the related topics button should be displayed inline with the content.

Show related topics toolbar button Determines whether the related topics button should be displayed in the toolbar of the output.

Show search tab Determines whether the search tab should be displayed in the output.

Table of Contents filename Determines the file name of the generated table of contents file.

Theme Determines the theme to use in the generated output.

Top level filename Determines the file name of the top level (entry point) to the generated


75


output.

Use browser cookies Determines whether browser cookies should be used.

Validate accessibility image alternate tags

Determines whether accessibility image alternate tags should be validated when an accessibility report is generated.

Validate accessibility image long descriptions

Determines whether accessibility image long descriptions should be validated when an accessibility report is generated.

Validate accessibility table summaries

Determines whether accessibility table summaries should be validated when an accessibility report is generated.

Validate image map alternate tags Determines whether accessibility image map alternate tags should be validated when an accessibility report is generated.

WebWorks Help accessibility Determines the accessibility behavior of WebWorks Help.

Author name Determines the author’s name.

Document title Determines the document title.

Oracle Help Location Determines the location to find the installed Oracle Help.

Copyright date Determines the copyright date.

Dropbook location Determines the location to find the installed Dropbook application.

Edition Determines the edition.

Result filename Determines the result filename file.

WinHelp custom map file Determines the map file to be used for generating the Microsoft WinHelp helpset.

WinHelp title Determines the WinHelp title to use.

WebWorks AutoMap 9 User Guide: Glossary

76

GLOSSARY

accessible content Content that conforms to the W3C Web Content Accessibility Guidelines 1.0 (WCAG), Section 508 of the U.S. Rehabilitation Act of 1998, and the Americans with Disabilities Act (ADA).

adapter An integral component of WebWorks products bridging the gap between a source document application and a WebWorks product solution. Currently, adapters exist for Adobe FrameMaker and Microsoft Word applications to communicate and share information with WebWorks ePublisher Pro and WebWorks AutoMap. An adapter is licensed individually and an activation key is required to enable each.

character encoding A mapping of binary values to code positions used to represent text and symbols in online documents. For example, the Latin-1 (ISO-8859-1) character encoding can be used to represent the characters and symbols used in most Western languages.

character style Formatting applied at the character level. Character styles specify characteristics like font size and style for an individual character or a group of characters. For example, these characters use an italic font style. WebWorks ePublisher Pro scans the source document, duplicates the character styles used in the source document, and adds them to the project. Use the Style Designer to manipulate these character styles.

composite image An image that is composed of multiple images. The following are examples of composite images: an image pasted into a document to which you have added callouts, a drawing created with the drawing tools in which you have included more than one shape, and two images pasted in the same location.

conditional text Content written for certain audiences and maintainable within the same document – for example, when creating printed material to be distributed to multiple audiences. Parts of the document will be common to all audiences; by applying conditions to the differing content you can maintain a single document for all audiences.

Document Designer Accessible through View → Document Designer, enables users to touch-up online content by allowing the application of overrides.

Document Manager Accessible through View → Document Manager, it gives users capability to open source documents from WebWorks ePublisher Pro and add, remove, and modify groups for a single project.

eBook format A digital format for books, offering the user the mobility of a book in a PDA and flexibility to control the look and feel of the book. WebWorks ePublisher Pro offers support for the Microsoft Reader and the Palm Reader formats.


77

format The starting point for all WebWorks ePublisher Pro projects. Each format produces a specific type of output files.

frameset file An HTML file used to provide sub-windows to keep certain information visible, while other views are scrolled or replaced. For example, the WebWorks Help 5.0 frameset file (index.htm) divides the browser window into three frames: one for the navigation tabs, one for the toolbar buttons, and one for the Help topics.

generate Act of converting source documents to create a set of output files based on user-defined style properties, style options, and format settings.

generation log A record of the events that occur while output files are being generated. For example, each time an HTML or graphics file is successfully generated, WebWorks ePublisher Pro adds an entry to the generation log.

graphic style Formatting applied to an image. Graphic styles specify characteristics like type of graphic – JPG, JPEG, GIF, etc. WebWorks ePublisher Pro scans the source document, duplicates the graphic styles used in the source document, and adds them to the project. Use the Style Designer to manipulate these graphic styles.

group Refers to the first level in the hierarchy represented in the Document Manager. It is the primary container for source documents, subgroups, and the entry-point file to the Help system. Each group generates a separate Help system. Use groups to represent entities such as products or departments within a company or file folders on a computer system.

image map An image with clickable regions or hotspots that link to relevant information. For example, an image of a map of Europe might provide links to resources related to each country.

irregular heading hierarchy A table of contents hierarchy in which one or more heading levels have been skipped. For example, a table of contents in which a fourth-level heading immediately follows a second-level heading uses an irregular table of contents hierarchy.

marker A element users apply to a paragraph, topic, or image in the source document to provide additional processing instructions. Markers associate information such as a filename or topicIDs with a paragraph, topic, or image. For example, filename marker information is used to specify the names of output files and TopicAlias markers are used for creating context-sensitive Help.

marker style Refers to the type of marker that is inserted in the source document. WebWorks ePublisher Pro will scan the source document for markers, populate the project with the marker styles and associate each marker style with the proper functionality.

multivolume Help system Multiple first-level groups’ output files combined to create a Help system that functions as a single unit.


78

navigation frame A frame that hosts some navigation items for online content. This may include a table of contents, an index, search, favorites, and/or a glossary.

subgroup A virtual folder used to organize source documents within a first-level group. It serves as a means of arranging and categorizing source documents and does not represent an actual volume or TOC level for a generated set of files.

online Help format Creates the necessary files for a complete online Help system. Online Help formats included with WebWorks ePublisher Pro are WebWorks Help5.0, Microsoft HTML Help 1.x, Microsoft WinHelp, Sun JavaHelp 1.1.3, Sun JavaHelp 2, and Oracle Help.

output directory Accessible through View → Output Directory. It houses generated output files. Every WebWorks ePublisher Pro project a user creates has an output directory.

Output Explorer Accessible through View → Output Explorer, it gives users the capability to open the generated output files from WebWorks ePublisher Pro.

output file Any file generated by WebWorks ePublisher Pro. Output files are housed in the project’s output directory.

override A change made with the Document Designer to the preview of a single document. Overrides can be applied to a paragraph or a table and it supersedes any values or properties set in either the source document or the Style Designer. Overrides appear only in the online output; they do not affect the source document. Overrides cannot be saved to stationery.

page style Defines the appearance and additional elements of the online content on a page level. Page styles are used to specify page background properties, corporate logos and contact information, and navigation controls.

paragraph style Defines the appearance and additional elements of the online content on a paragraph level. Paragraph styles are used to specify formatting characteristics like fonts and indents. For example, a Heading 1 paragraph style may use a larger font that a Body paragraph style. WebWorks ePublisher Pro reads in the paragraph styles used in the source document and lets the user specify how they should appear in the online content.

popup topic A Help topic displayed in a popup window. Typically used to display small amounts of information, such as definitions of terms. Popup topics are supported in the following formats: WebWorks Help 5.0, Microsoft HTML Help 1.x, Microsoft WinHelp, and Sun JavaHelp 1.1.3 and 2.0.

Preview Provides an approximation of the way the online content will appear without requiring the user to generate the project.

project The set of files necessary for successful project generation.


79

project file The .wep file that WebWorks ePublisher Pro creates when a project is saved.

project directory The top-level directory for a single project. The default location of the project directory is C:\Documents and Settings\username\My Documents\ePublisher Pro Projects\projectname, where username is the name you use to sign on to your computer, and projectname is the name of your project.

regular heading hierarchy A table of contents hierarchy in which no heading levels have been skipped.

stationery Contains all project configurations except overrides and source documents. Overrides are not saved in stationery because this information is specific to a certain document. Stationery can be used create new projects.

stationery file The .wsp file that WebWorks ePublisher Pro creates when a project is saved as stationery.

Style Designer Accessible through View → Style Designer, enables users to globally configure paragraph, character, table, page, graphic and marker styles and their associated properties and options for online content.

style options Attributes such as popups, table of contents level, breadcrumbs, marker type, etc., that are associated with a particular style. Paragraph, character, table, page, graphic and marker styles all have options appropriate to the style type.

style properties Attributes such as horizontal indentation, horizontal alignment, vertical spacing, etc., that are associated with a particular style. Paragraph, character, table, page, and graphic styles all have properties associated with them.

table style Defines the appearance of a table. Table styles are used to specify formatting characteristics like border and background properties for tables in online content. WebWorks ePublisher Pro reads in the table styles used in your documents and lets you specify how they should appear in the generated output.

template WebWorks template refers to the older WebWorks Publisher based model and have no meaning in the WebWorks ePublisher Pro model. WebWorks projects, formats, and stationery accomplish what templates previously did.

thumbnail A copy of an image much smaller than the original, often displayed in place of the original image to conserve space on the screen. The clickable thumbnail displays the full-size original when clicked.

toolbar frame The frame that hosts navigation buttons for online content. This may include next and previous, related topics, print, etc. buttons.


80

topic frame The frame that hosts the topics for the online content.

User Files directory Contains the user’s files that have been added to a project. This may include a custom CSS file, multimedia files and/or other documents that are referenced in the online content.

variable A placeholder for information that is likely to change. For example, a version number of a product. The user can specify a value for the variable in WebWorks ePublisher Pro that is different than the value used in the source document.

W3C World Wide Web Consortium. The Consortium is the principal standard-setting organization for Web technologies. The Web site of the W3C is maintained at http://w3.org.

WCAG Web Content Accessibility Guidelines. These guidelines are available from the World Wide Web Consortium at http://www.w3.org/TR/WAI-WEBCONTENT/.

WebDAV Web-based Distributed Authoring and Versioning. A set of extensions to the HTTP protocol that allows users to edit and manage files collaboratively on remote Web servers.

WebWorks Transit A plug-in that adds marker and conditional text functionality to Microsoft Word.


81

INDEX

Accessibility, 51, 78, 80, 81, 85 Accessible, 17, 81, 83, 84 accessible conten

definition, 81 Adapter, 6, 21, 34, 35, 81 administrator

status information, 22, 26 antivirus software

using with WebWorks ePublisher Pro using with WebWorks ePublisher Pro, 13

Author, 80 Breadcrumbs, 84 character encoding

definition definition, 81

character style definition

style types character

definition, 81 ClearCase, 9 command line options, 74, 75 composite image

definition, 81 conditional text

definition, 81 Conditions, 6, 12, 15, 17, 19, 28, 32, 33, 48, 49,

50, 51, 81 Development, 5 Discussions

Discussion, 5 Document, 9, 14, 15, 17, 34, 46, 51, 78, 80, 81,

82, 83, 84, 85 Document Designer

definition, 81 Document Manager

definition, 81 Document settings

Variables, 7 Documentation, 5, 6, 9, 11, 14, 15, 17, 42, 45,

46, 47, 49, 78 Documentum, 9 eBook, 5, 81 eBook format

definition, 81 Editor, 6, 29, 37, 42, 45, 46, 47, 49 Encoding, 78, 81 Engine, 17 Explorer, 10, 83 file

WebWorks ePublisher Pro.msi, 12 FinalDraft, 6 format, 5, 6, 8, 9, 14, 15, 16, 17, 18, 19, 31, 32,

34, 42, 47, 78, 81, 83, 84

format definition, 82

Format, 6, 8, 9, 13, 14, 15, 16, 17, 18, 28, 29, 31, 32, 34, 40, 42, 47, 48, 51, 52, 75, 78, 81, 82, 83

Format setting, 6, 51, 52, 78, 82 FrameMaker, 2, 5, 6, 8, 9, 10, 14, 15, 21, 34, 43,

46, 49, 50 frameset file

definition, 82 generate

definition, 82 Generate, 13, 15, 52, 78, 79, 82, 83 generation log

definition, 82 Glossary, 7, 81, 83 Goals, 52 graphic style

definition style types

graphic definition, 82

Graphics, 11, 82, 84 group

definition, 82 Group, 2, 38, 45, 46, 47, 78, 81, 82, 83 Help, 5 Image, 78, 79, 80, 81, 82, 84 image map

definition, 82 Index, 24, 78, 79, 82, 83, 86 Installer, 12, 13, 20 irregular heading hierarchy

definition irregular heading hierarchy

definition, 82 Java, 2, 79 JavaHelp, 2, 5, 8, 14, 16, 79, 83 job

last run, 27 name, 26 next run, 27

Job, 5, 6, 8, 11, 13, 14, 15, 16, 17, 18, 19, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 47, 50, 51, 52, 55, 56, 57, 58, 59, 79

jobs scheduling, 40, 43, 55, 58

Keys, 6, 7, 13, 20, 21, 24, 46 last run, 27 License, 2, 11, 12, 13, 20, 21, 24, 26, 35, 46, 76 Log, 24, 26, 29, 37, 38, 82 Mappings, 6, 27, 34, 35, 36, 81 marker


82

definition, 82 Marker, 12, 15, 82, 84, 85 marker style


marker definition, 82

Merge, 6, 19, 48, 52 Migration, 18 multi-volume help, 52 multivolume Help system

definition, 82 navigation frame

definition, 83 next run, 27 Norton, 8, 13 online Help format

definition definition, 83

Open, 7 output directory

definition, 83 Output Explorer

definition, 83 output file

definition, 83 override

definition, 83 page style


page definition, 83

paragraph style definition

style types paragraph

definition, 83 PDF, 5, 8, 78, 79 Plan, 13 popup, 84 Popup, 35, 37, 49, 83 popup topic

definition, 83 preferences

setting, 20, 27 Preferences, 5 preview

definition, 83 Preview, 83 project

definition, 83 Project, 5, 6, 8, 9, 11, 14, 15, 16, 17, 18, 19, 30,

31, 33, 34, 35, 36, 40, 41, 42, 44, 46, 54, 60, 81, 82, 83, 84, 85

project directory definition, 84

project file definition, 84

Quadralay, 2, 11, 12, 15, 16, 17, 18, 34, 46 Related Topic, 79, 84 Requirements, 8, 10, 11, 17 Reviewer, 5 revision control, 9 RoboHelp, 2 Schedule, 6, 8, 9, 19, 24, 26, 40, 41, 55, 56, 57 scheduling, 40, 43, 55, 58 Script, 6, 42, 45, 46, 47, 48, 49, 60 setting

preferences, 20, 27 stationery

definition, 84 Stationery, 6, 8, 9, 11, 14, 15, 16, 17, 18, 19, 40,

41, 42, 43, 44, 45, 47, 52, 60, 83, 84 stationery file

definition, 84 Style, 8, 9, 14, 15, 17, 81, 82, 83, 84 Style Designer, 81, 82, 83, 84 Style Designer

definition, 84 style options

definition, 84 style properties

definition, 84 subgroup

definition, 83 system requirements, 8, 10 table of contents

regular heading hierarchy definition, 84

Table of Contents, 3, 5, 78, 79, 83 table style


table definition, 84

Tables, 3, 5, 11, 24, 25, 26, 51, 78, 79, 80, 82, 83, 84

Templates, 16, 18, 84 temporary files

keeping/deleting, 28, 33 thumbnail

definition, 84 TOC, 78, 83 toolbar frame

definition, 84 topic frame

definition, 85 Transit, 12, 85 Unicode, 2 uninstall, 13 User Files directory

definition, 85 variable

definition, 85 Variables, 6, 7, 15, 17, 19, 28, 32, 33, 48, 50, 51,

85 Version, 12, 13, 24, 45, 85


83

Visual Source Safe, 9 W3C, 81, 85

definition guidelines

W3C, 85 WCAG

definition guidelines

WCAG, 85 WebDAV, 36, 85 WebDAV

definition, 85 Website, 11 WebWorks, 2, 6, 8, 11, 12, 13, 14, 15, 16, 17,

18, 20, 24, 29, 30, 38, 48, 51, 53, 78, 80, 81, 82, 83, 84, 85 AutoMap, 1, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15,

16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 29, 30, 31, 32, 33, 35, 36, 37, 38, 40, 41, 42, 43, 44, 46, 47, 52, 55, 57, 74, 78

License Manager, 11, 21 Publisher, 8, 13, 18, 81, 82, 83, 84, 85 WebWorks Help, 5, 8, 14, 16, 48, 51, 53, 78,

80, 82, 83 WebWorks AutoMap

benefits, 8, 9 opening, 20 what is WebWorks AutoMap, 8

WebWorks Automap 2003, 5 WebWorks AutoMap 2003

backwards compatibility, 8, 11 WebWorks Publisher Professional 7.0, 8, 11 WebWorks Transit

definition, 85 Windows, 2, 10, 11, 13, 14, 20, 24, 38, 55, 56 Word, 5, 6, 8, 9, 10, 12, 13, 14, 15, 21, 34, 43,

46, 49, 50, 85 XML, 2, 5, 8, 14, 16, 29, 34 XSL, 16, 17