Customizing User Documentation

If your company makes changes to an ENOVIA product, ENOVIA cannot ensure the accuracy of the documentation. You can change the user documentation that accompanies ENOVIA products to reflect changes made to the applications.

See Custom User Documentation for details about the types of changes. This section describes how to change the PDF and online help output files; if you want to use the FrameMaker or XML source files to make extensive changes, contact your Professional Services Representative.

This task shows you how to:

Change the Online Help Output

You can change text in the online help output files.

  1. Locate the files for the needed online help system in this directory: 

    ENOVIAHOME/doc/APPLICATION_NAME/LANG_ABBREVIATION

    Each online help system consists of many different files, including HTML, GIF, XML, and JS files. The written content for the help system is in the HTML files.

  2. Make a backup copy of the original output files,

  3. Run the help system directly from the Web server directory structure as a standalone system and not from the application. Use Internet Explorer (IE). To run the help system, open ENOVIAHOME/doc/APPLICATION_NAME//LANG_ABBREVIATION/wwhelp/ wwhimpl/js/ html/wwhelp.htm in IE.

  4. Go to the topic you want to edit.

  5. In Internet Explorer, right-click on the right frame and choose View Source.

    Another way to find the HTML file that contains the text you want to edit is to use the Find feature of Windows Explorer (or the equivalent for UNIX) to search for the file that contains a particular text string.

  6. From the text editor, edit the content as needed.

    Only people familiar with HTML should edit the files. Make sure you edit only the help text and do not change HTML tags, especially anchor and paragraph IDs (such as <a name="146224"> or <p id="145937" class="Body">). Changing HTML tags may create errors in the context-sensitive help or cross-references.

  7. Save the file using the same name as the original file. Make sure the extension is html and not txt. The file name must be exactly the same as the original or the help system will not find the file.

  8. To change an image:

    1. Right-click on the image.
    2. In Internet Explorer, choose Properties and find the file name for the image at the end of the URL field.

      Or

      In Mozilla/Firefox, the file name is shown next to the View Image option of the right-click menu.

    3. Find the file in ENOVIAHOME/doc/APPLICATION_NAME/ LANG_ABBREVIATION/images. Open it in an image editor, make changes to it, and save it, or replace the file with an image of the same name.
    4. Launch the help system again or refresh the current page to display the changed graphic.

  9. If you changed the heading for the topic, make the same change to the Contents tab by changing the heading in ENOVIAHOME/doc/APPLICATION_NAME/ LANG_ABBREVIATION/ wwhdata/js/toc.js and files.js and ENOVIAHOME/doc/ APPLICATION_NAME/LANG_ABBREVIATION/APPLICATIONNAMEtoc.xml.

  10. Make a list of the changes you made so you can make the same changes when you receive an updated version of the help system.

Change the PDF Output

You can make changes to the PDF file for an application's user's guide.

Before you begin: To edit text in a PDF file, you must have Adobe Acrobat.

  1. Locate the user guide for the needed ENOVIA application.

    The user guide for each application is located in ENOVIAHOME/studio/Apps/APPNAME/VERSION/pdf.

  2. Open the PDF file in Acrobat and make text changes as needed. Make a list of the changes you made so you can make the same changes when you receive an updated version of the user guide.