Adobe Technical Communication Suite 4: Generating Dynamic User-Centric Content with Adobe AIR Authored by: Nick Iati
Table of Contents Introduction to Dynamic User-Centric Content ........................................................... .........1 Single-Sourcing in Adobe Technical Communication Suite 4............................................... ...........1 Supporting Informational Nuances between Audiences........................................................ ...........1 Implementing Dynamic User-Centric Content ........................................................................... ...........1 Linear versus Multi-linear Informational Flows ........................................................................... ...........2 Dynamic User-Centric Content Applied ........................................................................................ ...........3 Get Started with the PDF Version ............................................................................................. ...........4 Compare to the Dynamic User-Centric Content Built-into the HTML Help Viewer ...........4 Introduction .................................................................................................................... .........5 Hardware Diagram ................................................................................................................................ ...........5 Installation Order-of-Operations Checklist ................................................................................... ...........6 Install the Printer Software............................................................................................ .........7 Install the Printer Driver for Printco Printer Model A .................................................. ...... 10 Install the Printer Driver for Printco Printer Model B .................................................. ...... 17 Install the Printer Driver for Printco Printer Model C .................................................. ...... 24 Calibrate the Printco Printer Model A........................................................................... ...... 31 Calibrate the Printco Printer Model B ........................................................................... ...... 35 Calibrate the Printco Printer Model C ........................................................................... ...... 39
Introduction to Dynamic User-Centric Content Single-Sourcing in Adobe Technical Communication Suite 4 In a rapidly changing technological landscape, it is crucial that technical communication can be authored in a format which can be deployed to myriad media from print to Online help systems. Single-source authoring in Adobe Technical Communication Suite 4 supports publishing content to a number of output options from a single master file. This provides content authors a method for saving time and adds flexibility to the content they author by maximizing its application. Source content is typically authored in Adobe Framemaker. From Framemaker, the content can be published in a number of formats including PDF, HTML, and XML. Additionally, the Framemaker source files can be linked to a RoboHelp project in which entire Online help systems may be generated, either as HTML help or as an Adobe AIR help application.
Supporting Informational Nuances between Audiences In addition to the varying types of necessary output, many different types of audiences are emerging as information technologies are increasingly adopted by mainstream consumer markets. The knowledge each audience seeks or requires often times overlaps with the needs and wants of the next audience so it’s imperative that single-sourced output can be dynamically filtered in such a way that it is relevant to each audience based on criteria such as role, department, geographic location, operating system, and product usage. For instance, a software application may differ based on the type of user - more functionality is available to administrative users than to standard users. Rather than authoring two separate user guides tailored specifically to each type of user, content can be sourced in an all-inclusive Framemaker book. Topics can be arranged in book documents and conditional text may be applied to the content based on output formats and audience types.
Implementing Dynamic User-Centric Content Tight integration between Framemaker and RoboHelp allows content authors to take information dissemination a step further with Online help. Linking content sourced in Framemaker to a RoboHelp project is quite simple. The Framemaker formats, including conditional text, can be ingested by RoboHelp and applied to the project. In RoboHelp, the author may now setup Content Categories which arrange all of the multiple layouts (generated from conditional build tags and expressions) into categories such as Administrative Users and Standard Users. When the RoboHelp project is published, users can decide which layout they wish to access from a drop-down menu and the help system populates only the topics and information the author assigned to that particular content category. So effectively, users who select Standard User from the drop-down menu will access only the information relevant to standard users, omitting information on the additional functionality available to administrative users. The resulting output can look vastly different than traditional output such as a user guide published in PDF format because it is dynamically generated based on audience identification and packaged in a robust help viewer or Adobe AIR application.
Page 1
Linear versus Multi-linear Informational Flows Much like a fictional novel, traditional technical documentation follows a logical linear informational flow that introduces basic concepts first and follows a narrow, linear trajectory towards more advanced concepts. Although linear informational flows may still be appropriately implemented, feature-rich applications most often require technical documentation that branches off onto a number of different paths - multi-linear informational flows. As the need to support multi-linear informational flows expands, most authoring programs have evolved to better support the type of branching required. Although traditional publishing formats (those that translate well to print such as PDF and DOC formats) can support multi-linear flows, they do not provide a solid methodology for users who find themselves on a specific informational branch to return to the main path from which they started - even when viewed in their digital formats. For instance, Jane is installing printer software on her computer. She has completed the initial software installation steps and now she must install the printer driver. The printer manufacturer may have provided an installation guide dedicated exclusively to the printer model Jane is installing and, therefore, the instructions can be authored in a linear flow: Figure 1: Linear Informational Flow
Consider, however, that the manufacturer has three similar models in this specific line of printers. Although there may be installation steps that are common between the three models, there may be a point at which the instructions must branch-off into three separate directions in order to support the nuances between them. The instructions must therefore be authored in a multi-linear flow: Figure 2: Multi-Linear Informational Flow
Page 2
The multi-linear informational flow provides the printer manufacturer the benefit of managing only one installation manual for an entire line of printers while still providing the end user with all of the necessary information to successfully install his or her new printer. It is not without its drawbacks however. If Jane is viewing the installation guide in printed format, she will most likely have to fumble between pages to access the information she needs in order to install the proper printer driver for the specific model she is installing. If at any point she must revisit a previous section, she must fumble through the pages of the hard copy once again just to get back to the information she seeks. Jane encounters the same type of inconveniences when viewing a traditional digital version of the installation guide such as a PDF. Although hyperlink support makes it easier to navigate forward to the information she needs in order to install the proper printer driver for her specific printer model, it does not provide an intuitive methodology for going backwards or revisiting the specific page from which she made her jump. The solution to the issues Jane is encountering with both the print and digital versions of the installation guide is a digital version - either packaged as an HTML help viewer or as an Adobe AIR application - which is authored with Dynamic User-Centric Content built-in. Upon opening the digital guide, Jane can select her printer model and follow a linear trajectory towards completion of the necessary installation steps for her specific model. This robust digital version also provides a number of extra features which allows Jane to easily navigate backwards, search for content using keywords, and even easily navigate to a completely different path in the event she finds herself on an incorrect path (i.e. she selected the wrong printer model). Figure 3: Dynamic User-Centric Content - Selecting a Path
Dynamic User-Centric Content Applied Let’s take Jane’s multi-linear printer installation scenario a step further and examine how it behaves in both a traditional digital output (PDF) and a packaged HTML help viewer with built-in Dynamic User-Centric Content.
Page 3
Get Started with the PDF Version Read through the remainder of pages in this document - they will serve as the sample Printer Installation Guide PDF Jane is using to install her Printco Printer Model B.
Compare to the Dynamic User-Centric Content Built-into the HTML Help Viewer When finished perusing this version, move on to the HTML help viewer version and see how the built-in Dynamic User-Centric Content streamlines the steps to successfully install a Model B printer while still providing access to the information necessary to install other models.
Page 4
Introduction Installing your new Printco Printer is fast and easy. Prior to performing the steps provided in this guide, remove the printer hardware and all of its associated parts from its packaging and ensure that all necessary parts are included in the package. The printer unit includes a separate hardware manual. Please refer to the printer hardware manual when taking inventory of all parts and follow the hardware setup instructions provided. Once printer unit assembly is complete, proceed to the Installation Order-of-Operations Checklist on page 6 and follow the software installation steps corresponding to your specific Printco Printer Model.
Hardware Diagram Setup the printer hardware using the hardware instruction manual packaged with the printer unit.
Figure 1: Printer Diagram
Page 5
Installation Order-of-Operations Checklist Model A 1.
Install the Printer Software - see page 7.
2.
Install the Printer Driver for Printco Printer Model A - see page 10.
3.
Calibrate the Printco Printer Model A - see page 31.
Model B 1.
Install the Printer Software - see page 7.
2.
Install the Printer Driver for Printco Printer Model B - see page 17.
3.
Calibrate the Printco Printer Model B - see page 35.
Model C 1.
Install the Printer Software - see page 7.
2.
Install the Printer Driver for Printco Printer Model C - see page 24.
3.
Calibrate the Printco Printer Model C - see page 39.
Page 6
Install the Printer Software 1.
Power-off the printer and ensure the rear cover is securely closed.
2.
Insert the Printco Printer Software for Models A, B, & C installation CD into the computer’s CD/DVD ROM drive. Note: The installation CD should automatically run. If the CD/DVD ROM drive does not automatically open in a browser window, open a browser window and navigate to the CD/DVD ROM drive.
3.
Double-click the Setup.exe file. The installer automatically launches. The Printco Printer Series Installer - InstallShield Wizard opens and the Choose Setup Language screen is displayed.
4.
Select a language.
5.
Click Next. A progress screen displays.
Page 7
The Welcome screen is displayed.
6.
Click Next. The Ready to Install the Program screen is displayed.
7.
Click Install.
Page 8
Software installation begins and progress is displayed on the screen. Installation may take a few minutes to complete.
8.
Once the installation is complete, an InstallShield Wizard Complete screen is displayed.
9.
Remove the installation CD from the CD-ROM drive.
10. Ensure that the Yes, I want to restart my computer now. radio button is selected. 11. Click Finish. The system restarts. 12. Proceed to the appropriate next section corresponding to the Printco Printer model you are installing: •
Install the Printer Driver for Printco Printer Model A - see page 10.
•
Install the Printer Driver for Printco Printer Model B - see page 17.
•
Install the Printer Driver for Printco Printer Model C - see page 24.
Page 9
Install the Printer Driver for Printco Printer Model A 1.
Ensure the Printco Printer Model A is powered-on and connected to your computer via the USB cable.
2.
Insert the Printco Printer Software for Models A, B, & C installation CD into the computer’s CD/DVD ROM drive.
3.
From the Windows desktop, select Start > Devices and Printers.
The Windows Control Panel opens on the Devices and Printers screen.
4.
Click Add a printer at the top of the window.
Page 10
The Add Printer dialog box opens.
5.
Select the Add a local printer option.
6.
Click Next. The Choose a printer port screen is displayed.
7.
Ensure the Use an existing port radio button is selected.
8.
Click Next.
Page 11
The Install the printer driver screen is displayed.
9.
Click the Have Disk... button. An Install From Disk dialog box opens.
10. Click the Browse... button to open a Locate File dialog box.
Page 12
11. Navigate to the computer’s CD/DVD ROM drive in which the Printco Printer Software for Models A, B, & C installation CD is inserted. 12. Select the xPrintModA.inf file.
13. Click Open. The Install From Disk dialog box returns to focus with the path to the xPrintModA.inf file populating the Copy manufacturer’s files from field.
14. Click OK. The Install the printer driver dialog box returns to focus.
Page 13
15. From the Printers list box, select Printco Model A Printer Driver PS. 16. Click Next. The Add Printer > Type a printer name screen is displayed with Printco Model A Printer Driver PS populating the Printer name field.
17. Click Next. The printer driver is installed.
Once installation is complete, the Add Printer > Printer Sharing screen is displayed.
Page 14
18. Select the Do not share this printer radio button.
19. Click Next. The Add Printer > You’ve successfully added Printco Model A Print Driver PS screen is displayed.
20. Click the Print a test page button. A dialog box opens stating that A test page has been sent to your printer. The test page is printed.
21. Click Close.
Page 15
The Add Printer > You’ve successfully added Printco Model A Print Driver PS screen returns to focus.
22. Click Finish. The wizard closes and the Devices and Printers window returns to focus with the Printco Model A Print Driver PS displayed in the Printers and Faxes list. The printer driver files are loaded.
23. Proceed to the next section - Calibrate the Printco Printer Model A on page 31.
Page 16
Install the Printer Driver for Printco Printer Model B 1.
Ensure the Printco Printer Model B is powered-on and connected to your computer via the USB cable.
2.
Insert the Printco Printer Software for Models A, B, & C installation CD into the computer’s CD/DVD ROM drive.
3.
From the Windows desktop, select Start > Devices and Printers.
The Windows Control Panel opens on the Devices and Printers screen.
4.
Click Add a printer at the top of the window.
Page 17
The Add Printer dialog box opens.
5.
Select the Add a local printer option.
6.
Click Next. The Choose a printer port screen is displayed.
7.
Ensure the Use an existing port radio button is selected.
8.
Click Next.
Page 18
The Install the printer driver screen is displayed.
9.
Click the Have Disk... button. An Install From Disk dialog box opens.
10. Click the Browse... button to open a Locate File dialog box.
Page 19
11. Navigate to the computer’s CD/DVD ROM drive in which the Printco Printer Software for Models A, B, & C installation CD is inserted. 12. Select the xPrintModB.inf file.
13. Click Open. The Install From Disk dialog box returns to focus with the path to the xPrintModB.inf file populating the Copy manufacturer’s files from field.
14. Click OK. The Install the printer driver dialog box returns to focus.
Page 20
15. From the Printers list box, select Printco Model B Print Driver PS. 16. Click Next. The Add Printer > Type a printer name screen is displayed with Printco Model B Print Driver PS populating the Printer name field.
17. Click Next. The printer driver is installed.
Once installation is complete, the Add Printer > Printer Sharing screen is displayed.
Page 21
18. Select the Do not share this printer radio button.
19. Click Next. The Add Printer > You’ve successfully added Printco Model B Print Driver PS screen is displayed.
20. Click the Print a test page button. A dialog box opens stating that A test page has been sent to your printer. The test page is printed.
21. Click Close.
Page 22
The Add Printer > You’ve successfully added Printco Model B Print Driver PS screen returns to focus.
22. Click Finish. The wizard closes and the Devices and Printers window returns to focus with the Printco Model B Print Driver PS displayed in the Printers and Faxes list. The printer driver files are loaded.
23. Proceed to the next section - Calibrate the Printco Printer Model B on page 35.
Page 23
Install the Printer Driver for Printco Printer Model C 1.
Ensure the Printco Printer Model C is powered-on and connected to your computer via the USB cable.
2.
Insert the Printco Printer Software for Models A, B, & C installation CD into the computer’s CD/DVD ROM drive.
3.
From the Windows desktop, select Start > Devices and Printers.
The Windows Control Panel opens on the Devices and Printers screen.
4.
Click Add a printer at the top of the window.
Page 24
The Add Printer dialog box opens.
5.
Select the Add a local printer option.
6.
Click Next. The Choose a printer port screen is displayed.
7.
Ensure the Use an existing port radio button is selected.
8.
Click Next.
Page 25
The Install the printer driver screen is displayed.
9.
Click the Have Disk... button. An Install From Disk dialog box opens.
10. Click the Browse... button to open a Locate File dialog box.
Page 26
11. Navigate to the computer’s CD/DVD ROM drive in which the Printco Printer Software for Models A, B, & C installation CD is inserted. 12. Select the xPrintModC.inf file.
13. Click Open. The Install From Disk dialog box returns to focus with the path to the xPrintModC.inf file populating the Copy manufacturer’s files from field.
14. Click OK. The Install the printer driver dialog box returns to focus.
Page 27
15. From the Printers list box, select Printco Model C Print Driver PS. 16. Click Next. The Add Printer > Type a printer name screen is displayed with Printco Model C Print Driver PS populating the Printer name field.
17. Click Next. The printer driver is installed.
Once installation is complete, the Add Printer > Printer Sharing screen is displayed.
Page 28
18. Select the Do not share this printer radio button.
19. Click Next. The Add Printer > You’ve successfully added Printco Model C Print Driver PS screen is displayed.
20. Click the Print a test page button. A dialog box opens stating that A test page has been sent to your printer. The test page is printed.
21. Click Close.
Page 29
The Add Printer > You’ve successfully added Printco Model C Print Driver PS screen returns to focus.
22. Click Finish. The wizard closes and the Devices and Printers window returns to focus with the Printco Model C Print Driver PS displayed in the Printers and Faxes list. The printer driver files are loaded.
23. Proceed to the next section - Calibrate the Printco Printer Model C on page 39.
Page 30
Calibrate the Printco Printer Model A 1.
From the Windows desktop, select Start > Control Panel. The Windows Control Panel opens.
2.
Select Color Management.
Page 31
The Color Management dialog box opens.
3.
Click the Advanced tab. The Advanced tab is displayed.
4.
Click the Change system defaults... button. The Color Management - System Defaults dialog box opens.
Page 32
5.
From the Device drop-down menu, select Printer: Printco Model A Print Driver PS.
6.
From the Profile selection drop-down menu, select Manual.
7.
Click the Add... button under the Profiles associated with this device list box. The Associate Color Profile dialog box opens.
8.
Scroll the list and select the Printco_Mod_A_PK.icm profile from the list.
9.
Click OK.
The Associate Color Profile dialog box closes and the Color Management - System Defaults dialog box returns to focus with the Printco_Mod_A_PK.icm profile displayed in the Profiles associated with this device list. 10. Select the Printco_Mod_A_PK.icm profile displayed in the Profiles associated with this device list. 11. Click the Set as Default Profile button. The Printco_Mod_A_PK.icm profile displayed in the Profiles associated with this device list is now appended with (default). 12. Click Close.
Page 33
The Color Management - System Defaults dialog box closes and the Color Management dialog box returns to focus. 13. Click Close. The Color Management dialog box closes and the Windows Control Panel returns to focus. 14. Close the Windows Control Panel. 15. Restart the computer.
Page 34
Calibrate the Printco Printer Model B 1.
From the Windows desktop, select Start > Control Panel. The Windows Control Panel opens.
2.
Select Color Management.
Page 35
The Color Management dialog box opens.
3.
Click the Advanced tab. The Advanced tab is displayed.
4.
Click the Change system defaults... button. The Color Management - System Defaults dialog box opens.
Page 36
5.
From the Device drop-down menu, select Printer: Printco Model B Print Driver PS.
6.
From the Profile selection drop-down menu, select Manual.
7.
Click the Add... button under the Profiles associated with this device list box. The Associate Color Profile dialog box opens.
8.
Scroll the list and select the Printco_Mod_B_PK.icm profile from the list.
9.
Click OK.
The Associate Color Profile dialog box closes and the Color Management - System Defaults dialog box returns to focus with the Printco_Mod_B_PK.icm profile displayed in the Profiles associated with this device list. 10. Select the Printco_Mod_B_PK.icm profile displayed in the Profiles associated with this device list. 11. Click the Set as Default Profile button. The Printco_Mod_B_PK.icm profile displayed in the Profiles associated with this device list is now appended with (default). 12. Click Close.
Page 37
The Color Management - System Defaults dialog box closes and the Color Management dialog box returns to focus. 13. Click Close. The Color Management dialog box closes and the Windows Control Panel returns to focus. 14. Close the Windows Control Panel. 15. Restart the computer.
Page 38
Calibrate the Printco Printer Model C 1.
From the Windows desktop, select Start > Control Panel. The Windows Control Panel opens.
2.
Select Color Management.
Page 39
The Color Management dialog box opens.
3.
Click the Advanced tab. The Advanced tab is displayed.
4.
Click the Change system defaults... button. The Color Management - System Defaults dialog box opens.
Page 40
5.
From the Device drop-down menu, select Printer: Printco Model C Print Driver PS.
6.
From the Profile selection drop-down menu, select Manual.
7.
Click the Add... button under the Profiles associated with this device list box. The Associate Color Profile dialog box opens.
8.
Scroll the list and select the Printco_Mod_C_PK.icm profile from the list.
9.
Click OK.
The Associate Color Profile dialog box closes and the Color Management - System Defaults dialog box returns to focus with the Printco_Mod_C_PK.icm profile displayed in the Profiles associated with this device list. 10. Select the Printco_Mod_C_PK.icm profile displayed in the Profiles associated with this device list. 11. Click the Set as Default Profile button. The Printco_Mod_C_PK.icm profile displayed in the Profiles associated with this device list is now appended with (default). 12. Click Close.
Page 41
The Color Management - System Defaults dialog box closes and the Color Management dialog box returns to focus. 13. Click Close. The Color Management dialog box closes and the Windows Control Panel returns to focus. 14. Close the Windows Control Panel. 15. Restart the computer.
Page 42