[Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print...

39
Single Sourcing with TCS: Using FrameMaker to Manage Print and Help Authoring Matt Sullivan, GRAFIX Training & Consulting 888 882-2819 [email protected] http:// www.grafixtraining.com/doctrainwe

description

Presented by Matt Sullivan at Documentation and Training West, May 6-9, 2008 in Vancouver, BCSee how the Adobe Technical Communication Suite (TC) helps you incorporate video and manage your help, print, and web projects from a single Adobe FrameMaker book. Learn to use the TC Suite to rapidly update multiple outputs using FrameMaker files with conditional text and structured or unstructured information.

Transcript of [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print...

Page 1: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Single Sourcing with TCS: Using FrameMaker

to Manage Print and Help Authoring

Matt Sullivan, GRAFIX Training & Consulting

888 882-2819 [email protected]

http://www.grafixtraining.com/doctrainwest

Page 2: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

2-day TCS Integration Classes

• Available at the STC meeting in Philly, see– http://www.stc.org/55thConf/precon/certAdobe.

asp• Available in southern California, see

– http://grafixtraining.com/pages/schedule.html• Available remotely

– Only a 2-student minimum for live online training!

– http://grafixtraining.com/pages/remote.html

Page 3: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Goal• To show how traditional

documentation methods can be used to control custom and conditionalized output including (not limited to):– Print– A variety of Help formats– Adobe AIR

Page 4: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

AIM Concept• aim.com concept

– Short video marketing message

– “Ego-based” customers

– Chroma-keyed video floats over existing web page (like a weather reporter)

– Delivered from streaming server

Page 5: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Overview of Session• Concepting and Initial Doc Setup

– Highlight Key FrameMaker Topics• Acrobat 3D Toolkit• Captivate Hybrid Project(Break)• RoboHelp Setup• Outputs• Revisions

Page 6: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Adobe Technical Communication Suite

• Integrated versions of applications– FrameMaker 8– Acrobat 3D

• A superset of Acrobat 8 Professional– Captivate 3– RoboHelp 7– (RoboHelp Packager for AIR)

• New License $1,599• Upgrade to TCS from any version of these four

products for $999– Don’t forget the Maintenance Contract and VLP Discounts

• 30-day fully functioning downloads available

Page 7: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Initial Organization in Outlining Program

• Natara Bonsai www.natara.com– Allows easy

reorganization of bullet points

– Bullets convert to Heading1, Heading2, etc.

– Output to RTF– Syncs with Palm-

based devices

Page 8: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

DTP and Help Naming Conventions

• Strive for no format overrides– Format with Paragraph and Character styles only

• Consistent Naming Conventions for– Paragraph Formats– Character Formats– Conditions– Cross Reference Formats– Master and Reference Pages– Colors

• Styles– InitialCap– ALLCAP– lower_case

Page 9: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

FrameMaker• Assign Master Pages automatically

– Ex: CoverPage, RotatedTables, FullPageGraphics

– MasterPageMaps Reference Page• Cross-reference formats

– Complete units (Para’s or Sentences)– Leverage Character Formats to highlight

Hyperlink• Conditional Text

– Including Build Expressions

Page 10: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Graphics Import Options• By reference, except screen captures• Native files if possible

– Illustrator– Photoshop

• 3D objects– With poster for print output

• Captivate demos– With poster for print output

Page 11: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Output from Frame• Print

– Create PDF, then print (frees up FrameMaker faster)

• PDF (loosely grouped into3 types)– Screen only– Laser/bubble jet output– Commercial print

• HTML/XML– Native HTML conversion– Commercial solutions available

Page 12: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Extra FM Topics• Use Character Tags on the TOC

Reference Page to normalize TOC page numbers

• Create an extra List of Paragraphs to check overall organization of all Heading levels

Page 13: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Acrobat 3D• Works with many

native 3d formats output– See Edit > Preferences

> Convert to PDF

Page 14: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Acrobat 3D Toolkit• Drag & Drop onto a shortcut or the

open application to start editing• Full control over selecting and

viewing 3D structure• Select using Scene Tree or any Tool

– Group Feature helps with organization

Page 15: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Acrobat 3D Controls and Toolbars

• Commonly used toolbars shown to the right

• Ensure Folders are visible

Page 16: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Map surfaces in Acrobat 3D

• With Folders visible, view Materials– If necessary, select the Generate

Thumbnails icon

• Drag surface onto selected object(s)

Page 17: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Save/Save As dialog in Acrobat 3D

• Save as Universal 3D (.u3d) format to ensure compatibility with Frame 8

• In Save dialog box select Settings– General Tab

• Choose ECMA 1st Edition– Animation Tab

• Select Export Animation

Page 18: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Create Standalone Version of 3D PDF

• Drag U3D into Acrobat 3D

Page 19: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Place in FrameMaker• Place as any other .ai, .psd, or export

format• Converts to PDF as fully articulating

object• Double-click Frame image to re-edit

in Acrobat 3D Toolkit

Page 20: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Break

Page 21: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Captivate output• Simultaneously captures actions and

descriptions in multiple deliverables– Demonstration– Training Simulation– Assessment Simulation– Hybrid as needed

• Delivered as SWF

Page 22: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Captivate• Write script• Record action• Add/modify helper elements

– Captions– Buttons– Click boxes

Page 23: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Captivate Scripts• Develop scripts from outlines and

print docs• Place scripts into Notes area

– Break script into object level chunks• Record audio chunks from Captivate

– Allows naming of small, discreet files• Edit in Captivate, or open directly in

Soundbooth

Page 24: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Captivate Details• Buttons and Click boxes explained

– Active and Inactive areas– Actions– Fade in, not out

• Apply to All is your friend

Page 25: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Captivate Print ImageCan show the result of steps• Select best slide background of finished steps• Export to .gif image• Select Edit > Preferences > Project > Start and

End• Click ellipse for Loading Screen & select .gif

exported above

Page 26: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Add Playbar to SWF• Force Captivate to produce single SWF

including playbar– Select Project > Skin > Borders– Uncheck Show Borders

• Increase project height to accommodate player– Select Project > Resize Project– Deselect Maintain Aspect Ratio– Increase Height by 32 pixels– Do not scale, place in Top Center, use White

background

Page 27: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

RoboHelp• Import FM by reference

– Option currently available as right-click on HTML directory in Project Manager

Page 28: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Map Critical Styles• Edit Style

Mappings for headings that split into topics

Page 29: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

fmstyles.css• Create placeholder topic

– Conditionalize if desired• Verify fmstyles.css is applied to

placeholder– Forces fmstyles to show in project manager

• All Frame-generated CSS files use fmstyles for base

• Edit fmstyles.css as needed– Reuse or replace the CSS as needed

Page 30: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Conditional Builds• Use Conditional Build Expressions to

create multiple projects– WebHelp-Verbose– WebHelp-Minimal Text

Page 31: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Output from RoboHelp• Create unique SSL’s for

– FlashHelp– WebHelp

• Send To RoboHelp Packager for AIR

Page 32: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Duplicating Layouts• Right-Click the format to duplicate• Confirm format type

– Set options as needed– Create Conditional Build Expressions

from Conditions used in document

Page 33: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Batch Generate• Right-Click on a layout

– Select SSL’s as needed• Click Generate• Batch Generate settings are saved

with XPJ

Page 34: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Adobe Integrated Runtime (AIR)

• Input is WebHelp from RoboHelp 7• Output is an Application Installer• A bit like PDF and Flash rolled into

content that autoupdates when connected to the web

Page 35: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

RoboHelp Packager for AIR

• Must have output from RoboHelp 7 as the source material

• Uses the WebHelp folder from SSL as target

• Requires Digital ID, but allows low-tech bypass

Page 36: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

AIR Formatting Options• Ships with 2

skins & 2 themes

Page 37: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

AIR Content Settings• Controls output

of – MiniTOC– Search

Capability– Custom

Resource Tabs• Has Live

Preview

Page 38: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring
Page 39: [Workshop] Single Sourcing with the Technical Communication Suite: Using FrameMaker to Manage Print and Help Authoring

Revise Content• Change common and conditional text

in FrameMaker• Update/Force Update in RoboHelp• Batch Generate in RoboHelp• Convert to AIR and post new version• Access AIR app to see update