Configuration 5.3 Manual RWD Info Pak Configuration Version 5.3
Oct 09, 2014
Configuration 5.3 Manual
R W D I n f o P a k C o n f i g u r a t i o n V e r s i o n 5 . 3
PROPRIETARY RIGHTS NOTICE
This material is the property of RWD Technologies. The material represents substantial creative effort and contains confidential information, and other proprietary concepts, techniques, ideas, and expressions. This material may not be reproduced, altered, or transmitted in any form or by any means (including, without limitation, electronic, mechanical, photocopying, or recording means) or in connection with any information storage or retrieval system, and may not be used in any manner whatsoever, without the express written consent of RWD Technologies. Your possession or use of this material constitutes your acceptance of these conditions. If you do not agree with these conditions, return the material to RWD Technologies. This material is intended to be used as a sample course for training purposes only.
COPYRIGHT © 1999-2004 RWD TECHNOLOGIES
ALL RIGHTS RESERVED
RWD Technologies and RWD Info Pak are registered trademarks of RWD Technologies, Inc. All other product and company names referenced herein are the registered or unregistered trademarks of their
respective owners.
Table of Contents
RWD Info Pak - Configuration Version 5.3, 08/09/2004 1
CUSTOMIZING INFO PAK WITH THE CONFIGURATION TOOL 3
USING PROFILES AND PROJECT SETTINGS 4 WHY USE PROFILES AND PROJECT SETTINGS? 4 ARE PROFILES MANDATORY? 4 SYNCHRONIZING PROFILES AND PROJECT SETTINGS 5
AVAILABLE PROJECT SETTINGS 6 AVAILABLE PROFILE OPTIONS 8 SHOULD I CREATE A NEW PROJECT SETTINGS FILE? 10 CREATING A PROJECT SETTINGS FILE 11 SPECIFYING PROJECT SETTINGS 15 MAINTAINING PROJECT SETTINGS FILES 44
USING PROFILES 51
MAINTAINING PROFILES 52 AVAILABLE PUBLISHER PROFILE SETTINGS 52 CREATING A PROFILE 53 MODIFYING PROFILE PROPERTIES 55 OPENING A PROFILE 55 COPYING A PROFILE 56 IMPORTING AND EXPORTING PROFILES 57 REMOVING A PROFILE 61
CREATING PROFILES FOR A NEW PROJECT SETTINGS FILE 63
USING ALTERNATE DOCUMENTS AND TEMPLATES 69
TEMPLATES DELIVERED WITH INFO PAK 70 TYPICAL DOCUMENT SCENARIOS FOR ALTERNATE DOCUMENTS AND TEMPLATES 72 CREATING CUSTOM AUTO-TEXT OR STYLES FOR ALTERNATE DOCUMENTS 74 UPDATING STYLES FOR DOCUMENTS 75
UPDATING STYLES FOR AN ALTERNATE DOC TYPE WITH AN ASSOCIATED TEMPLATE 75 UPDATING STYLES FOR AN ALTERNATE DOC TYPE WITH NO ASSOCIATED TEMPLATE 75 UPDATING STYLES FOR ALL DOCUMENT TYPES 76
DISTRIBUTING NEW CONFIGURATION AND LOGO FILES 77
CUSTOMIZING THE LOGO 78 USING SYNC TO DISTRIBUTE FILES 79
WHAT IS SYNCHRONIZATION? 79 WHAT FILES ARE SYNCHRONIZED? 80 UPLOADING FILES WITH SYNC 81
USING AUTO SCHEDULER 87
WORKING WITH AUTO SCHEDULER TASKS 88 CREATING A TASK 88 STOPPING A TASK 93 VIEWING THE TASK LIST AND TASK LOG 93 DELETING A TASK 94
Table of Contents
RWD Info Pak - Configuration Version 5.3, 08/09/2004 2
EXITING AUTO SCHEDULER 95
FOR MORE INFORMATION - AVAILABLE RWD INFO PAK COURSES 97
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 3
Customizing Info Pak with the Configuration Tool
The RWD Info Pak - Configuration Tool allows for the customization of the Info Pak product suite. Changes made with the Configuration Tool are saved to an .ips file. The default .ips file delivered with Info Pak is infopak.ips. Any changes made are computer-specific and the new configuration information must be distributed to other users.
Refer to Distributing New Configuration and Logo Files for more information.
The Configuration Tool should only be installed on those computers whose users have authorization to make modifications to the Info Pak product suite. The Configuration Tool reads from and writes to the infopak.ips file, which contains project-wide settings.
User-level settings are established via each Info Pak component’s profile options. These settings are written only to the current user’s profiles.
The distinction between project and user-level settings also exists on an Info Pak administrator’s computer.
Before making changes to the configuration settings:
• The Administrator installation of Info Pak must be present on the local machine.
• The document version, category names and values, header/footer text, and any changes to the default template text must be decided upon as they relate to the specific needs of the company and project team.
The following subsections provide information regarding project settings and user-level settings (profiles).
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 4
Using Profiles and Project Settings
Profiles are files that enable you to store your individual preferences for specific Info Pak components. Profiles are used in the Publisher (Template/Recorder, and Converter), Glossary, and Web Architect components. For example, the Template/Recorder profile allows you to specify options such as paper size, default save location, and screen percent differential.
Profiles also include a reference to the corresponding project settings file. The Info Pak administrator creates a project settings file (using the Info Pak Configuration Tool) to enforce standards and consistency across all Info Pak components used on a project. Project settings allow the administrator to specify options such as screen insert type, company name, and project name.
Project settings files have an .ips extension.
Why Use Profiles and Project Settings?
Profiles and project settings provide the following potential benefits:
• Authors can specify their preferences for the current project. If you work on more than one documentation project, you can create a profile for each project to simplify switching between projects and to ensure consistency. For example, if Project A calls for publishing cue cards and PDF work instructions and Project B calls for publishing Microsoft Word BPPs, creating two profiles enables you to easily switch between the projects without specifying the publish options each time.
• Authors can save time and minimize mistakes by reusing profiles from previous or current projects.
• Administrators use project settings to ensure that information such as header and footer text and categories are used consistently across the project documentation. These settings are then automatically synchronized with authors.
• Administrators use profiles to enable auto scheduling. The auto scheduling functionality allows the administrator to execute Glossary, Publisher, and Web Architect tasks in unattended mode. Profiles inform the Info Pak - Auto Scheduler component where to find Info Pak documents for globalizing, what document types and formats to publish, and which .htx files to use for website creation.
Refer to Using Auto Scheduler for detailed information on the Auto Scheduler component.
Are Profiles Mandatory?
Profiles are not mandatory if authors simply need one configured project settings file. In this case, configure the infopak.ips delivered with Info Pak and distribute this project settings file to the authors.
Refer to Should I Create a New Project Settings File? for guidance on determining your project requirements.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 5
Synchronizing Profiles and Project Settings
Administrators must distribute new and updated project settings and/or profiles to authors. In previous versions of Info Pak, this typically required email notifications to authors who then had to locate and copy the files to their local machines.
Info Pak includes synchronization functionality to automate many of these file distribution tasks. Synchronization is the process of updating profile and project settings files with administrator-supplied files stored on a central server.
Synchronization occurs automatically when a component is launched. To avoid many synchronization processes in one day, a registry key is used to track the date and time of the last sync event. Using the Configuration Tool, the administrator can set the minimum time interval to wait (in hours) before a component attempts to synchronize.
Authors are prompted if a synchronized file from the server (for example, profiles, project settings, templates, logo, or GUIPro databases) is attempting to overwrite a newer file on the local computer. Older local files are automatically overwritten during synchronization.
Refer to Distributing New Configuration and Logo Files for detailed information on synchronization.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 6
Available Project Settings
The following table lists the project settings available in the Configuration Tool.
Configuration Tool Tab Project Setting Template Screen Insert Type
Use Glossary Parent document: Maximum screen shot width Use page breaks before screen shots Use R/O/C column Use new screen flow connector Use active connectors in Visio
Recorder Unknown Field Name Text
Versions Version name and sequence
Categories Category name and value
Client Info Company Name Project Name Header Text Footer Text Sync Interval (hours)
Publishing Build Folders Based Upon Select PostScript Folder Name Use filtered HTML Use new screen icon Child type heading box Child document locator page Include Intentional Blank page Use “Return to Procedure” for screen shots Logo filename HTML: Maximum screen shot width Use CSS Save as “index” Include procedural steps (in Test documents) Include Notes (in Quick Reference documents) Include Results (in Quick Reference documents) Include Comments (in Quick Reference documents)
User Text All user text settings
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 7
Configuration Tool Tab Project Setting Doc Types Enable and disable standard document types;
change standard document type name; add and edit custom document types; specify parent document types in use
Doc Settings Specify allowable document formats for publishing
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 8
Available Profile Options
The following table lists the profile settings available in the Info Pak components.
Refer to the specific Info Pak component manual for instructions on specifying and using these profile options.
Component Tab Preference/Profile Options Publisher Template Glossary location
Default save location
Paper size
Interface language
Working folder location Recorder Search HTML Title Tags
Prompt for Field Name
Screen Percent Differential
Hide toolbar when recording
Active window mode
Current application mode
Desktop mode Hot-keys All hot-keys Converter Publishing Select document type(s) and format(s)
Remove Screen Shots
Map Screenflow
Inbox
Outbox
Interface language
Restart rate
Paper size
Enable Express Publishing Glossary Glossary Location of the glossary database
Interface language
Location of the documents to be globalized
Term name and definition styles Web Architect N/A Location of the Web Architect database
Build Directory Structure Path
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 9
Component Tab Preference/Profile Options Import Location of documents to be imported
Category construction selection
Category hierarchy Links Content Verification Path
Document type and format sequence
Generate toolbar for related documents
Open documents in a new browser window
Remove documents not found during content verification
HTX Assignments
HTX Location HTX Assignment Options
Navigation Build Navigation Path
Build navigation folders by
Run content verification before building
Remove existing navigation pages Fastpath Build Fastpath Path
Properties to build from
Build fastpath pages from
Run content verification before building
Remove existing fastpath pages
Separate multiple property values by
Non-published child document text Interface
Language Interface language
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 10
Should I Create a New Project Settings File?
A project settings file is used to enforce consistency and standardization across a project and to allow an author to work on more than one documentation project at a time.
For example, if Project A uses the categories Module and Course and Project B uses the categories Application and Procedure, the administrator would create separate project settings files and profiles to distribute to authors.
If you have multiple project requirements similar to the above example, you will need to create and distribute multiple project settings (ips) files. If your project requirements are limited to one documentation effort, you can simply modify and distribute the default infopak.ips file delivered with Info Pak.
The following graphic illustrates typical single and multiple documentation project scenarios.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 11
Creating a Project Settings File
Perform the following steps to create a new project settings file using the Configuration Tool. When you create a new project settings file you are essentially creating a copy of the default project settings file (infopak.ips) delivered with Info Pak.
Refer to Should I Create a New Project Settings File? for guidance on creating a project settings file versus modifying the default project settings file (infopak.ips) delivered with Info Pak.
1. Start the application using the menu path Start Programs RWD Info Pak Configuration Tool.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 12
2. Select Project Settings New… .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 13
A dialog window will display prompting you to save any changes to the currently open project settings.
If you are planning multiple projects, use the Project Settings Save As… option to create a new project settings file based on the currently-open file.
3. As required, complete/review the following fields:
Field Name R/O/C Description
Name R Name of the project settings file
Description O Text describing the project settings file
4. Click .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 14
The new project settings file is created, and the title and description are displayed at the top of the RWD Info Pak - Configuration Tool window.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 15
Specifying Project Settings
1. Start the application using the menu path Start Programs RWD Info Pak Configuration Tool.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 16
2. Perform one of the following:
If Then
The desired project settings file is not open 1. Select Project Settings Open… .
2. Select the desired project settings.
3. Click
The desired project settings file is open ---
3. Perform one or more of the following:
If You Need To Configure Go To
Template options Step 4
Recorder options Step 6
Version options Step 8
Category options Step 10
Client Information options Step 14
Publishing options Step 16
User Text options Step 19
Doc Types options Step 22
Doc Settings options Step 25
4. Click .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 17
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 18
5. As required, perform one or more of the following:
If You Want To Then
Set the type of images inserted in the document when the recorder captures a screen shot; this option may be changed at anytime, even during recording.
Select one of the following three choices:
Full - A caption and full screen image:
Heading Only - A formatted caption of the screen title:
SAP Easy Access Screenbar Only - An image of the title bar:
Set the width of captured screenshots in parent documents
Enter a specific maximum width in inches or centimeters.
Images are inserted in the source document based on the specified width. Test your specified setting to ensure the image is readable after the reduction in size.
Activate the Glossary application in Info Pak -Publisher Click .
Activate the automatic insert of page breaks before screen shots in Info Pak - Publisher Click .
Activate the automatic insert of the R/O/C (Required/Optional/Conditional) column in Field Description tables
Click .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 19
If You Want To Then
For multi-page screen flows, use a circle connector symbol in the document instead of the square “Goto Page X” connector used in previous versions
Click .
Insert a hyperlink in Visio to connect a multi-page screen flow Click .
6. Click .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 20
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 21
7. As required, complete/review the following field:
Field Name R/O/C Description
Unknown Field Name Text
C The text that will be inserted if the following conditions are met: the user is recording, the recorder cannot resolve the field label, and the user selects Never in the Prompt for Field Name field in the Publisher Preferences. This text is only activated when Never is selected.
8. Click .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 22
The Versions tab displays the standard editorial versions used in differentiating drafts of Info Pak documents.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 23
9. As required, perform one of the following:
If You Want To Then
Add a version 1. Enter the version name in the Versions field.
2. Click .
The version will be added to the bottom of the list.
Change the order of the version 1. Select the version to be moved.
2. To move the version higher in the list,
click .
3. To move the version lower in the list, click
.
Delete a version 1. Select the version to be deleted.
2. Click .
The versions will display in the Document Information window of the Info Pak document in the same order they display in the Versions tab.
10. Click .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 24
11. Click beneath the Number field label to select the number of the category you need to configure. There are eight categories from which to choose.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 25
12. As required, complete/review the following fields:
Field Name R/O/C Description
Name (leave blank to disable category)
R The category type name. This is displayed in the Document Information window of the Info Pak document (see below). Example: Module
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 26
Field Name R/O/C Description
Values R The values or category names that display as choices in the drop-down list of the Document Information window. If you are using Web Architect, these values will become the folders in the Category Organizer window and, eventually, will form the navigational structure of the website. Example: Purchasing
13. As required, perform one of the following:
If You Need To Then
Add a category value 1. Enter the name of the category listing in the Values field.
2. Click .
Change the order of the category value 1. Select the category listing to be moved.
2. To move the category higher in the list,
click .
3. To move the version lower in the list, click
.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 27
If You Need To Then
Alphabetically sort the list of category values Click Sort alphabetically to sort values as they are entered or to sort a non-alphabetized list.
Delete a category value 1. Select the category listing to be deleted.
2. Click .
14. Click .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 28
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 29
15. As required, complete/review the following fields:
Field Name R/O/C Description
Company Name R This field defaults to the name of the company that has purchased Info Pak. This value is based on the company name entered during installation and cannot be changed.
Example: RWD Technologies
Project Name R Name of the documentation project; this name will display on the Info Pak - Publisher Document Information window.
Example: Info Pak Documentation
Header Text O Text that displays below the header line in documents.
Example: Project Office Education and Training
Footer Text O Text that displays above the footer line in documents.
Example: For RWD Internal Training Purposes Only
Sync Interval (hours) R Specify the minimum time interval to wait, in hours, before a component on a user’s computer will attempt to synchronize to a network location.
The default setting is 8 hours. A setting of 0 hours will cause components to synchronize on each startup.
16. Click .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 30
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 31
17. Complete/review the following fields:
Field Name R/O/C Description
Build Folders Based Upon
R The folder name format used when publishing documents. There are three choices:
filename - This is the typical and recommended setting. Content folder structure is based on document name, followed by document type, and then format.
Keep filenames succinct, and be mindful of any operating system limitations on spaces or capitalization when specifying a filename.
id - Content folder structure is built from the document ID number assigned by Web Architect, followed by document type, and then format. If this option is selected, it would only be possible to publish child documents after the documents have been imported into Web Architect.
The following error will occur if a document is published before being imported into Web Architect:
id_filename - Content folder structure is built from the document ID and the name of the document, followed by document type, and then format. If this option is selected, it would only be possible to publish documents after the documents have been imported into Web Architect.
Publishing by ID number or by ID number and filename are options used in earlier versions of Info Pak. These options are not recommended in Info Pak 5.0 because they prevent documents from being imported into multiple Web Architect databases.
Select PostScript Folder Name
R The name of the folder created when publishing a PostScript document format. There are two options:
postscript - The default setting if there is no limitation to file path length.
ps - The setting required if there is a character length limitation for the file path.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 32
18. As required, perform one or more of the following:
If You Want To Then
Remove Microsoft Office-specific markup tags from your published HTML content. These tags are typically used for round-trip editing between Microsoft Word and HTML; filtering the HTML results in smaller HTML files.
Click .
In published documents, insert a new screen
icon ( ) in place of the icon ( ) used in previous RWD Info Pak versions
Click .
Insert a formatted box with the name of the child type at the beginning of the child document
Click .
Create an HTML file that links to all of the different child types and formats that have been published for a specific parent. This file, located in the \content\child_ document_name folder, can be used to help quickly find published content.
Click .
Insert an intentional blank page in an odd numbered Microsoft Word parent document. This is useful when formatting double-sided documents.
Click .
Insert a “Return to Procedure” hyperlink to allow users to return to the cue card steps display after viewing a screen capture.
Click .
Specify a graphic file (.gif, .bmp, or .jpg) to be used as the logo in published documents. Click to locate and specify the file.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 33
If You Want To Then
Set the size of screenshots in published HTML files
Enter a specific maximum width in pixels, or select from the following three options:
Original Size – do not resize the screenshot
1024 – resize the screenshot to optimize for 1024x768 display resolution
800– resize the screenshot to optimize for 800x600 display resolution
Images are resized based on the specified width. The image is not changed in the source document, only the published document. Test your specified setting to ensure the image is readable after the reduction in size.
Implement a cascading style sheet (CSS) to specify the format of published HTML documents
Specify the desired implementation of the cascading style sheet:
No – use the Microsoft Word “Save as Web Page” option to create HTML child documents that reflect the look-and-feel of the parent document
Yes, global – format the HTML child document based on a central content.css style sheet stored in the ../My Documents/InfoPak/ Standard folder
Yes, local (portable) – format the HTML child document based on a local content.css style sheet stored in the child document subfolder; this option is useful if you need to send the child document to others
If you are currently using a custom cascading style sheet, it is recommended that you transfer your customizations to the delivered content.css file.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 34
If You Want To Then
Save published documents as “index”. If this option was not selected, the published documents would be named after the parent document with a two-letter extension representing the child document type. (For example, createpowi.htm is a Work Instruction published from the document named createpo.doc.) Alternate documents would be named after the source document.
Click .
Click .
Click .
You must save PostScript (PDF) documents, source format documents, and web documents as “index” to include these files in Web Architect websites.
Include the steps located in the Procedure section in a Test Information child document. Steps may be inserted or recorded directly into the Test Information section of a parent document, and these steps will always be included in the Test Information child document.
Click .
Include notes in a Quick Reference child document Click .
Include the Results heading in a Quick Reference child document Click .
Include the Comments heading in a Quick Reference child document. This option is only active if the Include Results option is selected.
Click .
19. Click .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 35
20. Click in the field, and select the section for which you would like to alter the default template text. The available sections are:
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 36
• Business Process Procedure (SAP only)
• Change History
• Configuration Information
• Exercise/Data Sheet
• Footer Text
• Introductory Text
• Procedure
• Test Information
• Field separator for grids (SAP only)
• BW Phrases (SAP only)
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 37
21. Enter the desired text in the Custom Text column.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 38
Default template text can only be edited, not deleted. To remove your custom text, delete the entry in the Custom Text column. If you delete custom text for a reference text field that is also used in another document section, the custom text in this other section will also be deleted.
Changes to template text are not retroactive; therefore, changes will only be reflected in new documents. In addition, custom template text will not be translated.
22. Click .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 39
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 40
23. As required, review the following fields:
Name R/O/C Description
Name R Name of the document type
Example: BPP Cue Card
Application R Name of the application used to open the document type
Example: Word
Number R Unique document identification number associated with the document type
Example: 11
Ext R Three-character file extension associated with the application
Example: .doc
24. As required, perform one or more of the following:
If You Need To Then
Permit the use of a specific document type Click in the Enabled column for that document type.
Edit the name of a standard document type 1. Select the document type to be edited.
2. Click .
3. Edit the document type name.
4. Click .
For the standard document types delivered with Info Pak, only the name field can be edited.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 41
If You Need To Then
Add a custom document type 1. Click .
2. Enter a name for the document type, and select the associated application.
3. Click .
Before you can create an alternate document or assimilate an existing document, you must first create a custom document type for the Microsoft Office application. If you will be creating a custom template for this document type, the template and document must have the same name and the template must be saved in the /Custom_Templates folder.
Edit a custom document type 1. Select the document type to be edited.
2. Click .
3. Edit the document type name or the associated application.
4. Click .
Disable the use of a specific document type Deselect in the Enabled column for that document type.
Enable or disable the use of a specific parent document type during document creation
Toggle for the SAP Parent, Oracle Parent, and Generic Parent options, as desired.
25. Click .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 42
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 43
26. Select or deselect to permit or disable the publishing of a particular document type and format combination. The following formats are available:
• - PostScript
• - SAP KW Word Document
• - Web Document (HTML)
• - Office Source Format
• - PowerPoint Slideshow
Non-supported or non-applicable document type and format combinations are grayed out ( ). Deselected items ( ) will display grayed out on author computers.
27. When you have completed the project settings configuration, click .
The project settings file displayed at the top of the window will receive the updated settings.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 44
Maintaining Project Settings Files
Perform the following steps to edit the project settings description and copy or remove a project settings file.
1. Start the application using the menu path Start Programs RWD Info Pak Configuration Tool.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 45
2. If the desired project settings file is not open, select Project Settings Open… .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 46
3. Select the desired project settings from the displayed list.
4. Click .
5. As required, perform one or more of the following:
If You Want To Go To
Edit the current project settings description Step 6
Save the current project settings with a new name Step 10
Delete a project settings file Step 14
6. Select Project Settings Properties… .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 47
7. Edit the text in the Description field.
8. Click .
9. Return to Step 5.
10. Select Project Settings Save As… .
The Save As option creates a copy of the current project settings file as a basis for the new file. Use the New option if you want to create a project settings file based on the default project settings shipped with the Info Pak product.
The Save As option is recommended if you are planning the use of additional project settings files due to multi-project requirements. Create your initial project settings file, include all anticipated document types, and then use the Save As option to create subsequent project settings files. Additional document types should be added to multiple project settings files in the same order. By aligning project settings files, you ensure consistent use and leveraging of custom document types and facilitate the inclusion of a custom document in multiple websites.
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 48
11. Enter a new name and description.
12. Click .
13. Return to Step 5.
14. Select Project Settings Remove… .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 49
15. Select the file to be removed from the list.
You cannot delete the currently-open project settings file. In addition, you cannot delete all project settings files. At least one file must remain in the list.
16. Click .
Customizing
RWD Info Pak - Configuration Version 5.3, 08/09/2004 50
This page is intentionally left blank.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 51
Using Profiles
The following subsections provide details on creating and maintaining profiles. If there is a requirement to document multiple projects, administrators may create and distribute multiple project settings and profiles to authors. In addition, authors can create their own profiles to specify and retain preference settings.
In these subsections, the Info Pak – Publisher component is used as an example to illustrate the use of profiles.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 52
Maintaining Profiles
Available Publisher Profile Settings
The following settings can be stored in the Publisher profiles:
Setting Information
Template Profile Settings
Publisher – Template Tab
• Glossary location
• Default save location
• Paper size
• Interface language
• Working folder location
Refer to the Preferences: Template and Recorder section in the Info Pak Publisher manual for detailed instructions on specifying these template profile options.
Recorder Profile Settings
Publisher – Recorder Tab
• Search HTML title tags
• Prompt for field name
• Screen percent differential
• Hide toolbar when recording
• Active window mode
• Current application mode
• Desktop mode
Refer to the Preferences: Template and Recorder section in the Info Pak Publisher manual for detailed instructions on specifying these recorder profile options.
Publisher – Hot-keys Tab
• All hot-keys
Refer to the Preferences: Template and Recorder section in the Info Pak Publisher manual for detailed instructions on specifying these hot-key profile options.
Converter Profile Settings
Publisher – Converter
• Select document type(s) and format(s)
• Remove screen shots
• Map screenflow
• Inbox
• Outbox
Refer to the Publish section in the Info Pak Publisher manual for detailed instructions on specifying these converter profile options.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 53
Setting Information
Publisher – Converter
• Interface language
1. Select Start Programs RWD Info Pak Publisher Converter.
2. Select Help Preferences… .
3. Specify the interface language from the Interface Language drop-down list.
Publisher – Converter
• Restart rate
1. Select Start Programs RWD Info Pak Publisher Converter.
2. Select Help Preferences… .
3. In the Restart Rate field, specify the number of source documents published before the Microsoft Office application is automatically closed and re-opened. The default number is 100.
If you are experiencing memory resource issues, decrease the number entered in this field.
Publisher – Converter
• Paper size
1. Select Start Programs RWD Info Pak Publisher Converter.
2. Select Help Preferences… .
3. Select the paper size (U.S. Letter or A4) from the Paper Size drop-down list.
Publisher – Converter
• Enable express publishing
1. Select Start Programs RWD Info Pak Publisher Converter.
2. Select Help Preferences… .
3. Select Enable Express Publishing to publish only those documents that have changed since the last publish process.
Creating a Profile
You may want to create a profile if you are working on multiple documentation projects. Creating separate profiles for these projects allows you to quickly and easily fulfill distinct project requirements. For example, you may have the following project scenarios that may be fulfilled using separate profiles:
Project Glossary Location Default Save Location Profile
Canada ERP implementation
\\canada\ERP\Glossary\canada.ipg
\\canada\ERP\parents ERP Template
Mexico CRM implementation
\\mexico\CRM\Glossary\mexico.ipg
\\mexico\CRM\parents CRM Mexico
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 54
Use the New option to create a profile based on the default profile shipped with the Publisher product. Use the Save As option if you want to base a new profile on an existing profile.
1. Select Profiles New… from the RWD Info Pak – Template toolbar or RWD Info Pak – Converter component.
2. As required, complete/review the following fields:
Field Name R/O/C Description
Profile name R Name of the new profile
Example: ERP Converter
Profile description O Text describing the new profile Example: For use with ERP parent documents.
3. Click .
4. As necessary, set the profile preferences listed in Available Publisher Profile Settings.
5. Select Profiles Save.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 55
Modifying Profile Properties
1. Select Profiles Properties… from the RWD Info Pak – Template toolbar or RWD Info Pak – Converter component.
2. As necessary, make changes to the Profile description field.
3. Click .
4. Select Profiles Save.
Opening a Profile
There are several instances when it may be necessary to open a profile:
• When authors receive a new project settings file and associated profile(s) from the administrator via the synchronization process. When an author opens the Publisher profile, he will be using the standardized settings established for the project.
• After an author imports a profile received by the administrator or coworker.
• When an author needs to switch between profiles to fulfill the requirements of different tasks or projects.
1. Select Profiles Open… from the RWD Info Pak – Template toolbar or RWD Info Pak – Converter component.
Alternately, you can select an existing profile from the list at the bottom of the Profiles drop-down menu. This list displays the last five profiles used.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 56
2. Select the profile to open.
3. Click .
Copying a Profile
It may be necessary to copy a profile in the following circumstances:
• If an author is using an administrator-supplied profile to which he has made modifications. In this case, the author copies the profile to a new name to prevent overwriting at the next synchronization.
• If an author wants to use a profile as a ‘starting point’ for a new profile.
Use the New option to create a profile based on the default profile shipped with the Publisher product.
To copy a profile, perform the following steps:
1. Open the profile to be copied.
2. Select Profiles Save As… from the RWD Info Pak – Template toolbar or RWD Info Pak – Converter component.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 57
3. As required, edit the following fields:
Field Name R/O/C Description
Profile name R Name of the profile
Profile description O Text describing the profile
4. Click .
The existing profile is copied to a new profile. As necessary, create and save settings to this new profile.
Importing and Exporting Profiles
In addition to synchronizing, profiles can be distributed via the import and export options. You may want to use these options to share profiles with other Publisher users.
1. Perform one of the following:
If You Want To Go To
Import a profile Step 2
Export a profile Step 8
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 58
2. Select Profiles Import… from the RWD Info Pak – Template toolbar or RWD Info Pak – Converter component.
3. Click .
4. Select the profile to be imported.
Only exported profiles may be imported. Exported profiles have an .ipk file extension.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 59
5. Click .
6. Click .
The profile is now available to be opened.
7. Return to Step 1.
8. Select Profiles Export… from the RWD Info Pak – Template toolbar or RWD Info Pak – Converter component.
9. Click to select from the available Template or Converter profiles on your computer.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 60
10. Click .
11. Navigate to the location to which the profile will be exported.
12. Click .
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 61
13. Click .
Inform your coworkers of the export location so that they may import the profile. Exported profiles have an .ipk file extension.
Removing a Profile
Perform the following steps to delete a profile:
1. Select Profiles Remove… from the RWD Info Pak – Template toolbar or RWD Info Pak – Converter component.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 62
2. Select the profile to be removed from the displayed list.
You cannot remove the currently-loaded profile.
3. Click .
If you delete an administrator-created profile that is still located in the network synchronize location, when you next open Publisher or force a synchronization the deleted profile will be downloaded to your computer.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 63
Creating Profiles for a New Project Settings File
If you create a new project settings file, you must create corresponding profiles for the various Info Pak components being used on your project. These profiles will “point to” your new project settings. Profiles must be created for the Template, Converter, Glossary, and Web Architect components.
The following steps illustrate the process of creating a profile for your new project settings file.
The functionality to associate a project settings file with a profile is only available with administrator installations. Users will not see the Project Settings tab on the Preferences window and will not be able to select a project setting to associate with a profile.
The Info Pak - Converter component is used as an example in the following procedure.
Refer to the relevant Info Pak component manual for information on specific profile options.
1. Start the application using the menu path Start Programs RWD Info Pak Publisher Converter.
2. Create a new profile or open an existing profile.
3. Select Help Preferences… .
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 64
4. Select the tab.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 65
5. Select the newly-created project settings.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 66
6. Click to save the project settings.
7. Close and re-open the Info Pak – Converter component.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 67
8. As desired, make the necessary profile settings.
Specify user-accessible directory paths (such as a central server) when specifying locations (for example, the outbox location and the location of the fastpaths directory). Use of mapped drive designations is not recommended.
Refer to Using Profiles for information on setting profile options.
9. Click Profiles Save or Profiles Save As… to save the profile.
10. Distribute the profiles and projects settings to your authors as described in Distributing New Configuration and Logo Files.
Using Profiles
RWD Info Pak - Configuration Version 5.3, 08/09/2004 68
This page is intentionally left blank.
Alternate Documents and Templates
RWD Info Pak - Configuration Version 5.3, 08/09/2004 69
Using Alternate Documents and Templates
In addition to standard parent and child documents, another type of document can be created with Info Pak – Publisher: alternate documents. Alternate documents are Microsoft Office documents that are given Info Pak properties. Alternate documents can be created using custom templates created by your company or the existing templates provided in the Microsoft Office suite. In addition, your existing Microsoft Office and HTML files can be assimilated into the Info Pak suite to become alternate documents. The assimilation process stamps the file with custom Info Pak properties.
Alternate document types are created by the administrator using the Configuration Tool and are then distributed to authors. Examples of possible custom documents include policy and procedure documents, conceptual presentations, checklists, and process flows.
Refer to the Info Pak Publisher manual for information on creating alternate documents and assimilating documents.
The following subsections provide information on the templates delivered with Info Pak and typical document scenarios for alternate documents.
Alternate Documents and Templates
RWD Info Pak - Configuration Version 5.3, 08/09/2004 70
Templates Delivered with Info Pak
Modifying the look-and-feel of standard Info Pak documents or creating new custom alternate documents may require creating or changing document templates.
If you create a template containing macros, you must assess the security implications for your users. Microsoft Word includes security levels to protect against the risk that macro viruses will infect computers. You should evaluate digitally signing your custom templates; RWD does not digitally sign any template other than infopak.dot, infopakasia.dot, and the GUIPro template toolbars.
The following templates are delivered with Info Pak:
Template Default Location Description
Infopak.dot C:\Documents and Settings\All Users\Application Data\RWD\Info Pak\Version 5.30
• Used to create and edit parent documents (SAP, Oracle, or generic)
• Contains macros that are digitally signed by RWD; to preserve the digital signature and consistent parent formatting, RWD recommends against modifying this template
Infopakasia.dot C:\Documents and Settings\All Users\Application Data\RWD\Info Pak\Version 5.30
• Used to convert an Info Pak for Asia document into an Info Pak parent document
• Contains macros that are digitally signed by RWD; to preserve the digital signature and consistent parent formatting, RWD recommends against modifying this template
Infopak_standard.dot C:\Documents and Settings\[username]\Application Data\Microsoft\Word\STARTUP
• Contains auto-text and styles; this template makes infopak auto-text and styles available to all files
• Global template available to all RWD Info Pak Microsoft Word documents
• Contains no macros or digital signatures
• Changes made to this template will affect all documents (parent and alternate)
• New or modified auto-text does not “morph” language based on the Interface Language specified in Publisher Preferences
Alternate Documents and Templates
RWD Info Pak - Configuration Version 5.3, 08/09/2004 71
Template Default Location Description
Infopak_custom.dot C:\Documents and Settings\[username]\Application Data\Microsoft\Word\STARTUP
• Global template that ships blank; intended to hold custom auto-text and styles
• Contains no macros or digital signatures
• For a single alternate document type, insert unique auto-text and styles in this template
• New auto-text does not “morph” language based on the Interface Language specified in Publisher Preferences
Templates can be created and modified using standard Microsoft Word functionality.
Detailed instructions on creating and modifying Microsoft Word templates are beyond the scope of this manual. Refer to the appropriate Microsoft documentation and online help for detailed information on advanced template functions.
Administrators should store custom document templates they create in a folder named Custom_Templates. The default location is: C:\Documents and Settings\All Users\Application Data\RWD\Info Pak\Version 5.30\Custom_Templates. Custom and standard templates are updated through the synchronization process.
Refer to Distributing New Configuration and Logo Files for instructions on distributing templates.
Alternate Documents and Templates
RWD Info Pak - Configuration Version 5.3, 08/09/2004 72
Typical Document Scenarios for Alternate Documents and Templates
The following subsections illustrate typical alternate document scenarios you may encounter. In addition, basic details regarding creating custom auto-text and styles for use with Info Pak are provided.
Refer to the following table for help in determining the required tasks based on your documentation needs:
If You Want To The Administrator Must The Author Must
Modify the paragraph and character styles or auto-text used in all documents
1. Consider simply using the “User Text” tab in the Configuration Tool if you need to alter the standard auto-text delivered with Info Pak.
2. If necessary, modify the infopak_standard.dot.
3. Upload the files for distribution via Sync.
Refer to Creating an Alternate Document in the Info Pak Publisher user manual.
Create a new Microsoft Office alternate document based on a “starter” template
1. Create the required document type in the Configuration Tool.
2. Create the associated document template. Note that the template name must match the document type (that is, a Recipe document type must have a corresponding templated named recipe.dot).
3. Upload the files for distribution via Sync.
Refer to Creating an Alternate Document in the Info Pak Publisher user manual.
Create a new, blank Microsoft Office alternate document
1. Create the required document type in the Configuration Tool.
2. Upload the project settings file for distribution via Sync.
Refer to Creating an Alternate Document in the Info Pak Publisher user manual.
Modify the paragraph and character styles or auto-text used in a single custom alternate document
1. Consider simply using the “User Text” tab in the Configuration Tool if you need to alter the standard auto-text delivered with Info Pak.
2. If necessary, modify the infopak_custom.dot or the associated custom template.
3. Upload the files for distribution via Sync.
Refer to Creating an Alternate Document in the Info Pak Publisher user manual.
Add document properties, publish, and import an existing non-Info Pak Microsoft Office document
1. Create the required document type in the Configuration Tool.
2. Upload the project settings file for distribution via Sync.
Refer to Assimilating a Microsoft Office or HTML Document in the Info Pak Publisher user manual.
Alternate Documents and Templates
RWD Info Pak - Configuration Version 5.3, 08/09/2004 73
If You Want To The Administrator Must The Author Must
Update an existing group of documents to incorporate new styles
Create and/or modify the appropriate template. Refer to the following subsection, Updating Styles for Documents, for additional details.
----
Upgrade an existing Info Pak for Asia document to an Info Pak parent document
---- 1. Open the Info Pak for Asia document on a computer with Info Pak 5.3 installed.
The process of opening the document will convert the document to a standard SAP parent.
2. Edit the document as desired.
In Info Pak for Asia documents, field names in the Field Name/Description tables were captured as images, not text. Consequently, Glossary will not recognize these field names in your new parent document. If you wish to use Glossary functionality with these former Info Pak for Asia documents, you must replace the images with text.
Alternate Documents and Templates
RWD Info Pak - Configuration Version 5.3, 08/09/2004 74
Creating Custom Auto-Text or Styles for Alternate Documents
Perform the following steps to create custom auto-text or styles to be used with alternate documents.
1. Determine the DocType_Number for the alternate document type. The DocType_Number is defined by the administrator via the Configuration Tool.
2. Copy the original style from infopak_standard.dot to infopak_custom.dot or to the alternate document template you have created.
3. Rename the style in infopak_custom.dot or the alternate document template according to the following convention:
Example DocType_Number 11005
Original Style Name P101_Step
New Style Name P11005_Step
4. Save the modified template.
When determining the proper appearance of a document, RWD Info Pak scans templates in the following sequence to apply styles and auto-text:
Document Type Sequence
Alternate documents 1. alternate document template
2. infopak_custom.dot
3. infopak_standard.dot
Parent documents infopak_standard.dot
Alternate Documents and Templates
RWD Info Pak - Configuration Version 5.3, 08/09/2004 75
Updating Styles for Documents
Updating Styles for an Alternate Doc Type with an Associated Template
If the style change is for one alternate document type with an associated template (other than normal.dot), perform the following steps:
1. Open the template.
2. Modify the style and save the template.
3. Open the documents requiring the update and perform the following steps in each document.
4. Select Tools Templates and Add-Ins... .
5. Ensure the attached template is the correct template.
6. Ensure Automatically update document styles is selected.
7. Click .
If Automatically update document styles was previously selected, the styles will automatically be updated when the document is opened.
Updating Styles for an Alternate Doc Type with No Associated Template
If the style change is for one alternate document type with no associated template (other than normal.dot), perform the following steps:
1. Open infopak_custom.dot.
2. In the Modify Style window, modify the style(s).
3. Save infopak_custom.dot
4. Select Tools Templates and Add-Ins... .
5. Click .
6. Select the Styles tab.
7. Ensure the infopak_custom.dot is open in the left portion of the Organizer window.
For each document requiring the update, perform the following steps:
8. Open the document in the right portion of the Organizer window.
9. Select the changed style(s) on the left.
10. Click .
11. Close the document on the right.
Alternate Documents and Templates
RWD Info Pak - Configuration Version 5.3, 08/09/2004 76
The style(s) will be updated immediately.
Updating Styles for All Document Types
If the style change is for all document types, perform the following steps:
1. Open infopak_standard.dot.
2. In the Modify Style window, modify the style(s).
3. Save infopak_standard.dot
4. Select Tools Templates and Add-Ins... .
5. Click ..
6. Select the Styles tab.
7. Ensure the infopak_standard.dot is open in the left portion of the Organizer window.
For each document requiring the update, perform the following steps:
8. Open the document in the right portion of the Organizer window.
9. Select the changed style(s) on the left.
10. Click .
11. Close the document on the right.
The style(s) will be updated immediately.
Distributing New Configuration
RWD Info Pak - Configuration Version 5.3, 08/09/2004 77
Distributing New Configuration and Logo Files
You can make new or updated project settings files (for example, infopak.ips) and profiles available to your documentation authors. There are three ways to distribute these files to Info Pak users:
• Use RWD Info Pak - Sync to upload new files to a central server location from which users can automatically synchronize their Info Pak components. This is the preferred method because it ensures that a documentation team uses a consistent and up-to-date set of files.
• Copy new files to a server location. Authors can then copy or import files from this location to their local computer.
• Include new files in an email. Authors can save attached files to their local computer.
Refer to Using Sync to Distribute Files for detailed instructions on the Sync application.
Distributing New Configuration
RWD Info Pak - Configuration Version 5.3, 08/09/2004 78
Customizing the Logo
The logo file is a graphic to be used as the company or project logo. Once customized, it will display in the header of non-HTML Info Pak child documents produced from a standard Oracle, SAP, or generic parent document. The logo may be color or black and white. A graphic editing program, such as Microsoft Paint, can be used to create and edit the logo.
The logo image does not display in the parent but, rather, is inserted into the child documents during the publishing routine.
1. Obtain the desired logo in electronic form.
2. Resize the logo to ¾” tall by 1-¾” wide (recommended).
3. Convert the logo file to a GIF, JPG, or BMP format.
4. On the Publishing tab in the Configuration Tool, specify the name and location of the logo file.
Specifying the logo file in the Configuration Tool copies the logo to the following folder on the administrator’s computer: C:\Documents and Settings\All Users\Application Data\RWD\Info Pak\Version 5.30\Logos. The logo will then be distributed to authors during synchronization.
Refer to Specifying Project Settings for instructions on editing project settings. Refer to Uploading Files with Sync for additional instructions on the Sync application.
5. Optionally, to include the new logo for subsequent Info Pak installations, save the logo file(s) in the support\config folder of the installation directory structure.
Distributing New Configuration
RWD Info Pak - Configuration Version 5.3, 08/09/2004 79
Using Sync to Distribute Files
What is Synchronization?
Synchronization is the process of aligning configuration files on a user’s computer with standardized, centrally-maintained files on a server. Synchronization is a two-step process:
1. Administrators upload configuration files to a server.
2. After users specify the server location to their installed Info Pak components, Info Pak automatically downloads the new or updated files to the local computer.
The Info Pak – Sync component is installed as part of the standard administrator installation. Sync allows administrators to upload new and updated configuration and template files, logo files, and GUIPro databases to a central server location. Users’ Info Pak components can be set up to ‘sync’ to this central server location for automatic download of required files. By automating what, in previous Info Pak versions, was a manual process, documentation teams have greater assurance that they are using up-to-date project settings, templates, logo, and databases.
Distributing New Configuration
RWD Info Pak - Configuration Version 5.3, 08/09/2004 80
If the administrator has specified a sync location for one or all Info Pak components on his computer, the synchronization process could occur when local data files are newer than those on the server. The administrator will be prompted to confirm the overwriting of the files and should disallow the synchronization. To avoid possible loss of customizations on the administrator’s computer, the administrator should either disable synchronization on his computer (by not specifying a sync location in the Info Pak components) or distribute updated, customized files via Sync prior to opening an Info Pak component on his computer.
What Files are Synchronized?
The following files may be uploaded using Sync and, subsequently, synchronized with the user’s computer:
Files must exist in the location specified below in order to be recognized for upload by Sync.
File Type Location and Filename Description Project Setting C:\Documents and Settings\All
Users\Application Data\RWD\Info Pak\Version 5.30\*.ips
Created by the administrator in the Configuration Tool to specify project-wide information such as company name and header and footer text.
Profile Current working folder; the default location is C:\Documents and Settings\[your user name]\My Documents\InfoPak\profiles\ [component name]\. *.xml
Specifies component-specific information such as glossary database location and inbox and outbox locations; these settings can be changed by the user.
Template Startup location specified in Microsoft Word (Tools Options…, File Locations tab) Infopak_standard.dot
Info Pak template containing auto-text and styles; this template makes infopak auto-text and styles available to all files
Refer to Templates Delivered with Info Pak for additional information on infopak_standard.dot.
Startup location specified in Microsoft Word (Tools Options…, File Locations tab) Infopak_custom.dot
Info Pak global template that ships blank; intended to hold custom auto-text and styles
Refer to Templates Delivered with Info Pak for additional information on infopak_custom.dot.
Distributing New Configuration
RWD Info Pak - Configuration Version 5.3, 08/09/2004 81
File Type Location and Filename Description Custom Template C:\Documents and Settings\All
Users\Application Data\RWD\Info Pak\Version 5.30\Custom_Templates\ *.dot *.pot *.xlt *.vst
Administrator-developed custom templates for use with Microsoft Word, Microsoft PowerPoint, Microsoft Excel, or Microsoft Visio.
Refer to Templates Delivered with Info Pak for additional information on custom templates.
GUIPro Database C:\Documents and Settings\All Users\Application Data\RWD\Info Pak\Version 5.30\Databases\GUIPro\*.mdb
Contains button images used with GUIPro and GUIPro Builder. GUIPro databases will be synchronized using the synchronization location selected in Publisher Template and Web Architect.
Custom Logo C:\Documents and Settings\All Users\Application Data\RWD\Info Pak\Version 5.30\Logos\*.gif, *.bmp, or *.jpg
Company or project logo displayed in header of non-HTML child documents.
The Web Architect and Glossary databases are not synchronized.
Automatic synchronization of the files in the previous table occurs when a user launches a suite component. The Info Pak component splash screen will be displayed during synchronization and will indicate the message “Synchronizing… .” The process is transparent to the user except for the minimal time delay involved with the synchronization.
To avoid many synchronization processes in one day, a registry key is used to track the date and time of the last sync event. Using the Configuration Tool, the administrator can set the minimum time interval to wait (in hours) before a component attempts to synchronize. A limit of one automatic synchronization per 8 hours is the default setting.
Info Pak users can also force a synchronization from within an Info Pak component using the Profiles Synchronize… menu option.
Uploading Files with Sync
1. As necessary, complete the required modifications to create or update the project settings, profile, template, logo, or database files.
Refer to Customizing Info Pak with the Configuration Tool and Using Profiles for additional details on creating project settings and profiles. Refer to Templates Delivered with Info Pak for additional information on templates. Refer to the Info
Distributing New Configuration
RWD Info Pak - Configuration Version 5.3, 08/09/2004 82
Pak GUIPro and GUIPro Builder manual for information on updating GUIPro databases.
2. Double-click on the desktop, or select Start Programs RWD Info Pak Sync.
The first time you access the Sync component, no items are displayed in the window. After specifying your server location, the items are displayed.
3. Click to locate the server destination.
Distributing New Configuration
RWD Info Pak - Configuration Version 5.3, 08/09/2004 83
4. Select the desired folder, and click .
Distributing New Configuration
RWD Info Pak - Configuration Version 5.3, 08/09/2004 84
5. Note the location specified in the Select the server location to place these documents field. Inform your users of this location to ensure they correctly set their synchronize location in the Info Pak component(s).
Distributing New Configuration
RWD Info Pak - Configuration Version 5.3, 08/09/2004 85
6. Complete/review the following fields:
All files stored on the administrator’s local machine that can be pushed to the server will be displayed each time.
Field Name Description
Item Click to select or deselect the file for uploading.
The following color-coding conventions are used: • Green – indicates the item either does not exist on the
server location or the server version is older than the version on the administrator’s computer. These files are checked by default. You may want to upload this item.
• Red – indicates the item exists on the server location and is more recent than the version on the administrator’s computer. These files are not checked by default. You may not want to upload this item unless you need to revert to an older version.
• Black – indicates the item exists on both the server location and the administrator’s computer and has the same ‘LastModified’ date. These files are not checked by default.
Description Description of the file. Example: This is a RWD Info Pak GUIPro database.
Newer Version “Local” indicates the version of the item on the administrator’s computer is the newest (or only) version of this file.
“Server” indicates the version of the item on the server is more recent than the version on the administrator’s computer.
“Same” indicates the version of the item on the server is the same as the version on the administrator’s computer.
Location Location of the item on the administrator’s computer.
All columns may be sorted by clicking on the column heading. By default, the list is sorted on the Newer Version column. Items that are new on the administrator’s computer are displayed at the top of the list, followed by items that are newer on the server and, finally, items that have not changed.
7. Click .
The selected items are uploaded to the specified server location. These items will be downloaded to the user’s computer when the user next launches an Info Pak component or forces a synchronization.
Distributing New Configuration
RWD Info Pak - Configuration Version 5.3, 08/09/2004 86
This page is intentionally left blank.
Using Auto Scheduler
RWD Info Pak - Configuration Version 5.3, 08/09/2004 87
Using Auto Scheduler
The RWD Info Pak – Auto Scheduler component is installed as part of the standard administrator installation. This component schedules and executes Info Pak – Glossary, Info Pak – Converter, and Info Pak – Web Architect tasks in unattended mode. By selecting profiles for each of these three components, the administrator can process a document folder to globalize the documents, publish the desired output documents, and import the documents and build navigation and fastpath pages for website generation.
Components can be included or excluded from the automated process. The following figure assumes that all three components are being included and that all Web Architect tasks are being executed. In addition, the optional inclusion of a batch file (*.bat) is also reflected in the figure.
Using Auto Scheduler
RWD Info Pak - Configuration Version 5.3, 08/09/2004 88
Working With Auto Scheduler Tasks
Creating a Task
Perform the following steps to create a task with Info Pak – Auto Scheduler:
1. Double-click on the desktop, or use the menu path Start Programs RWD Info Pak Auto Scheduler.
Using Auto Scheduler
RWD Info Pak - Configuration Version 5.3, 08/09/2004 89
2. As required, complete/review the following fields:
If you are adding or removing profiles while Auto Scheduler is open, select Manage Refresh Profile Lists to refresh the list of available profiles for a particular
component.
Name R/O/C Description
Task Name R Unique description of the task
Glossary Profile O Name of the Glossary profile to include in the task; if you do not select a profile, Glossary will not be included in the automated task.
The button can be used to display the properties of the specified profile.
Publisher – Converter Profile
O Name of the Converter profile to include in the task; if you do not select a profile, Converter will not be included in the automated task.
The button can be used to display the properties of the specified profile.
Web Architect Profile O Name of the Web Architect profile to include in the task; if you do not select a profile, Web Architect will not be included in the automated task.
The button can be used to display the properties of the specified profile.
User .bat File O Click to locate and specify a batch (.bat) file to be run as part of the Auto Scheduler process. Browse to locate the file instead of entering the path manually; this will help to ensure you accurately specify the location. After browsing and selecting the file, the location and name will be enclosed in quotes.
Batch files can be used to execute non-Info Pak actions such as copying published files to a server. The batch file will run as the last step in the task.
If you add command line parameters after the batch file designation, enclose each parameter in quotes.
Using Auto Scheduler
RWD Info Pak - Configuration Version 5.3, 08/09/2004 90
Name R/O/C Description
Import C Click to import documents into Web Architect.
You must specify a Web Architect profile to select this option.
Build Navigation Pages
C Click to build navigation pages using Web Architect.
You must specify a Web Architect profile to select this option.
Build Fastpath Pages C Click to build fastpath pages using Web Architect.
You must specify a Web Architect profile to select this option.
Continue to next component if one fails
O Click to ignore any fatal errors and continue to the next component within the task.
Verify selected profiles for consistency
O Click to have Auto Scheduler check the specified profiles to ensure there is a consistent project settings file specified in Converter and Web Architect; and the Glossary path to parents, the Converter inbox, and the Web Architect import path point to the same location.
If the profiles are not consistent, a warning message is displayed. You may schedule and execute an inconsistent task.
Next Run Time R Click to specify the run time, and use the arrows to increment the highlighted portion of the time.
Specify an adequate time interval between tasks. If a task is executing when another task is scheduled to start, the subsequent task execution will be delayed until the first task has finished executing.
Multiple tasks cannot run concurrently.
Next Run Date R Click to specify the run date, and use the button to select a month and day.
Using Auto Scheduler
RWD Info Pak - Configuration Version 5.3, 08/09/2004 91
Name R/O/C Description
Scheduled Frequency R Select a frequency for the task from the following five options:
Not Scheduled
Once
Daily
Weekly
Monthly
Comments O Optional description of the task
3. Select File Save Task, or click to add the task to the task list.
The Auto Scheduler will start a task automatically if the system time equals the scheduled time of that task.
During execution of an Auto Scheduler task, it is recommended you exit other applications to maximize system performance.
Using Auto Scheduler
RWD Info Pak - Configuration Version 5.3, 08/09/2004 92
4. Optionally, select File New Task to clear the screen fields and create another task.
If you need to create a task based on an existing task, select File Save Task As… .
Using Auto Scheduler
RWD Info Pak - Configuration Version 5.3, 08/09/2004 93
Stopping a Task
Click or the Cancel button on the currently-executing component dialog window.
The Auto Scheduler will stop after completing the current process and will not execute the remainder of the task.
Viewing the Task List and Task Log
The task list at the bottom of the Auto Scheduler window displays the list of saved tasks. Selecting a task will display the task’s settings in the upper portion of the window.
The task log displays any errors encountered during task execution and the number of documents processed during the task. The task log will indicate that a batch file (if included) was called and finished. However, Auto Scheduler does not check to ensure the batch file completed successfully.
1. As required, perform one or more of the following:
If You Want To Then Go To
Review information in the task list --- Step 2
Review a log detailing information about the previous run of a task
Select the desired task in the task list. Step 4
2. Review the following fields in the task list:
Name R/O/C Description
Task Name R Description of the task
Next Run R Displays the next date and time of the task; if the task is not scheduled to run again, Not Scheduled is displayed.
Scheduled Frequency R Specifies the frequency for the task; possible values are Not Scheduled, Once, Daily, Weekly, or Monthly.
Current Status R Displays the current status of the task; possible values are Pending, Running, No future runs scheduled, and Delayed - waiting.
Previous Status R Displays the status of the last run of the task; possible values are Completed, Finished with error(s), Stopped by user, Not applicable, Interrupted by error(s), and Unable to start.
3. Return to Step 1.
4. Select Manage View Previous Run Log to display the Auto Scheduler log.
Notepad is launched, and the log is displayed.
Using Auto Scheduler
RWD Info Pak - Configuration Version 5.3, 08/09/2004 94
The default location of the Auto Scheduler logs is the default working folder: C:\Documents and Settings\[username]\My Documents\InfoPak\ Scheduler\Logs.
5. Select File Exit to close Notepad after you have reviewed the log.
Deleting a Task
To delete one or more tasks from the task list, perform one of the following:
If You Want To Then
Delete a single task displayed in the task list.
1. Select the desired task in the task list.
2. Select Manage Delete Task.
Delete all tasks displayed in the task list.
Select Manage Delete All Tasks.
An error message is displayed if you attempt to delete a task that is currently running.
Using Auto Scheduler
RWD Info Pak - Configuration Version 5.3, 08/09/2004 95
Exiting Auto Scheduler
You must be logged into the computer running Auto Scheduler, and Auto Scheduler must be running in order to execute future scheduled tasks. You can minimize and maximize the application.
Select File Exit to exit Auto Scheduler.
If you exit the application and tasks exist in the list, a warning message displays indicating these tasks will not execute at the scheduled time. Instead, the next time Auto Scheduler is started, these tasks’ statuses will be updated to Delayed and the delayed tasks will start running automatically in scheduled order.
Using Auto Scheduler
RWD Info Pak - Configuration Version 5.3, 08/09/2004 96
This page is intentionally left blank.
For More Information
RWD Info Pak - Configuration Version 5.3, 08/09/2004 97
For More Information - Available RWD Info Pak Courses
Courses are available for each Info Pak product. See your Info Pak sales representative for more information on purchasing and scheduling these courses.
RWD Info Pak - Publisher (8-hour course)
A beginner course designed for the developers and the project management team, covering the basics of recording a procedural document, editing the document, and creating (or “publishing”) alternate formats. Includes instruction on using RWD Info Pak - Glossary functionality, creating Microsoft Visio screen flows, and inserting buttons and icons using RWD Info Pak - GUIPro.
RWD Info Pak - Simulator (4-hour course)
A course designed for the developers and the project management team, covering the basics of recording a simulation, editing the simulation, and generating interactive and static output formats.
RWD Info Pak - Web Architect (8-hour course)
An intermediate course for the lead developers and the project management team, covering the creation of a website using the content created by RWD Info Pak - Publisher. Includes importing documents into the database, creating a directory structure that will be used in the navigation of the website, and tracking and reporting documentation status.
Note: This course is not intended for web developers and does not cover HTML authoring or customization.
RWD Info Pak - Help Launchpad for the Administrator (for SAP only) (4-hour course)
An advanced course for the project management team or technical personnel, covering the setup and maintenance of customized context-sensitive help in SAP. Includes the creation of transaction and server tables in the SAP system, setup of notifications and alerts, and the viewing of statistical data.
RWD Info Pak - OmniHelp for the Administrator (8-hour course)
A course for the management and maintenance of the OmniHelp desktop and server components. Includes server configuration, client installation, use of notification and alert notes, and users’ help request options.
RWD Info Pak - Glossary for the Administrator (4-hour course)
An advanced course for the management and maintenance of the RWD Info Pak - Glossary database. Intended for a smaller number of users, primarily the lead developers or project management team. Includes importing terms and definitions into a database, editing terms in the database, and exporting (or “globalizing”) terms into end-user documentation.
For More Information
RWD Info Pak - Configuration Version 5.3, 08/09/2004 98
Configuration Management (8-hour course)
An advanced course for the project management team or Info Pak administrator. Includes the configuration of the Info Pak template options, logo, categories, and RWD Info Pak - Glossary setup. Not intended for all developers. The course also covers the use of RWD Info Pak® - Auto Scheduler and the RWD Info Pak® - Sync tool.