Doc-To-Help 2014 User
Guide
By MadCap Software, Inc.
Copyright © 2015 MadCap Software, Inc. All rights reserved.
Corporate Headquarters MadCap Software, Inc.
7777 Fay Avenue La Jolla, California 92037
Email:
Web site:
Sales Email:
Telephone:
1-888-MadCap1 or +1 858-320-0387
Technical Support Web site:
http://www.madcapsoftware.com/support
Trademarks
Doc-To-Help 2014 and the Doc-To-Help 2014 logo are registered trademarks of MadCap Software, Inc. Doc-To-Help is a registered trademark owned by MadCap Software, Inc. All other product and company names herein are the property of their respective owners.
This manual was produced using Doc-To-Help.™
Contents
- Welcome to Doc-To-Help 2014!
- 1
Introduction to Single Sourcing.................................................................................................3
How Doc-To-Help Makes Single Sourcing Easier......................................................3 Three Easy Steps to Single Sourcing...........................................................................4 Tips for Logical Output...............................................................................................5
Guide to Templates and Styles ..................................................................................................7
Word File Templates...................................................................................................8 HTML File Style Sheets............................................................................................11
Doc-To-Help Outputs and Deliverables ..................................................................................13
Installing NetHelp .....................................................................................................17 Creating Section 508 Compliant Help.......................................................................19 Search Options for NetHelp ......................................................................................21 Source Document locations.......................................................................................24 Template and Style Sheet locations...........................................................................24 Theme locations ........................................................................................................25
Doc-To-Help Quick Reference Page .......................................................................................27 Doc-To-Help Workflow ..........................................................................................................27 Licensing and Technical Issues ...............................................................................................31
License and Redistributable Files..............................................................................31 Technical Support......................................................................................................31 System Requirements................................................................................................31 Using Anti-virus Software with Doc-To-Help ..........................................................32 Installing Doc-To-Help .............................................................................................32 Using Live Update.....................................................................................................33 Activating Doc-To-Help............................................................................................33 Deactivating Doc-To-Help ........................................................................................34 Setting Doc-To-Help Options....................................................................................34 Doc-To-Help Learning Library .................................................................................36 Trademark Statement.................................................................................................36 Migrating a Project....................................................................................................36
- Doc-To-Help Quick Tour
- 41
Creating a Project ....................................................................................................................41 Importing a Document.............................................................................................................50 Building and Examining a Target............................................................................................57 Inserting a Graphic ..................................................................................................................59 Applying a Style ......................................................................................................................61 Creating a Topic Link..............................................................................................................62 Creating Inline Text.................................................................................................................64 Creating an Index Entry...........................................................................................................65 Defining Help Targets .............................................................................................................68 Creating Custom Topic Relations............................................................................................71 Adding a Document.................................................................................................................73 Adding Glossary Entries..........................................................................................................76 Creating a Customized Table of Contents ...............................................................................78
- Doc-To-Help 2014 User Guide
- Contents iii
Adding Items to the Index and Creating Groups .....................................................................79 Additional Resources...............................................................................................................83
- Creating and Converting Projects
- 87
Converting RoboHelp HTML Notes .......................................................................................88 Converting RoboHelp Word Notes..........................................................................................92 Converting HTML Help Notes................................................................................................97 Converting Doc-To-Help 2000 Notes......................................................................................98 Converting WinHelp Notes .....................................................................................................99
- Navigating Doc-To-Help
- 105
Quick Access toolbar.............................................................................................................106 Super ToolTips ......................................................................................................................106 Ribbons..................................................................................................................................107
File tab.....................................................................................................................107 Home tab .................................................................................................................108 Editor tab.................................................................................................................110 Table tab..................................................................................................................113 Insert tab..................................................................................................................115 Topics tab ................................................................................................................117 Project tab................................................................................................................118 Team Authoring tab.................................................................................................119 Translation tab.........................................................................................................120
Navigation Panes ...................................................................................................................122
Documents pane ......................................................................................................122 Contents pane ..........................................................................................................124 Index and Groups pane............................................................................................125 Related Topics pane ................................................................................................126
Windows................................................................................................................................127
Start Page window...................................................................................................127 Topics window ........................................................................................................127 Output window........................................................................................................128 Content Editor window............................................................................................128 Variables window....................................................................................................129 Team Authoring window.........................................................................................129 Translation window.................................................................................................129 Dynamic Help..........................................................................................................130
- Customizing Your Project
- 133
Creating Help Targets............................................................................................................133
NetHelp Targets ......................................................................................................134 HTML Help Targets................................................................................................139 EPUB Targets..........................................................................................................142 Eclipse Help Targets................................................................................................144 JavaHelp Targets .....................................................................................................146 WinHelp Targets .....................................................................................................149 Manual Targets........................................................................................................152 Microsoft Help Viewer Targets...............................................................................154 Microsoft Help 2.0 Targets......................................................................................157
Utilizing Conditions...............................................................................................................160
Defining Attributes..................................................................................................162
Setting the Help Window Display .........................................................................................163
WinHelp Window....................................................................................................163 NetHelp Window.....................................................................................................165
- iv Contents
- Doc-To-Help 2014 User Guide
HTML Help Window ..............................................................................................165 Manual Window......................................................................................................167 Microsoft Help Viewer Window.............................................................................167 EPUB Window........................................................................................................167 Microsoft Help 2.0 Window....................................................................................167 JavaHelp Window ...................................................................................................167
Defining Character/Paragraph Styles and Topic Types.........................................................168
Character Styles.......................................................................................................169 Paragraph Styles......................................................................................................171 Topic Types.............................................................................................................173 Working with Scripts...............................................................................................175
Editing a CSS.........................................................................................................................176
Style List Window Tour..........................................................................................178
Setting Project Properties.......................................................................................................182
Choosing a Source Folder .......................................................................................184
Compacting a Project File......................................................................................................184 Importing and Exporting Project Settings..............................................................................185 Implementing Context Sensitive Help...................................................................................186
Context Sensitive Help in JavaHelp ........................................................................187 Context Sensitive Help in Microsoft Help 2.0.........................................................188 Context Sensitive Help in Microsoft Help Viewer..................................................188 Context Sensitive Help in NetHelp Classic.............................................................188 Context Sensitive Help in NetHelp 2.0....................................................................192
Customizing Themes with the Theme Designer....................................................................199
Adding a Theme or Theme Configuration...............................................................199 Customizing NetHelp 2.0 Themes...........................................................................200 Customizing Eclipse Help and EPUB Themes........................................................230 Customizing NetHelp Classic, HTML Help, Microsoft Help Viewer, Microsoft Help 2.0, and JavaHelp Themes.......................................................................................235 NetHelp Theme Wizard...........................................................................................251
Customizing Topics with the Transformation Wizard...........................................................257
Advanced XML Transformations............................................................................259
- Working with Source Documents
- 263
Adding a Document to a Project............................................................................................264 Converting Existing Documents to HTML5..........................................................................265 Editing HTML5 Documents ..................................................................................................266
Adding Widgets in the Content Editor ....................................................................268 Adding Comments in the Content Editor ................................................................275 Applying Styles in the Content Editor.....................................................................276 Managing Style Gallery Styles................................................................................280 Inserting Images in the Content Editor....................................................................281 Creating Hyperlinks in the Content Editor..............................................................281 Creating Bookmarks in the Content Editor .............................................................282 Inserting Symbols in the Content Editor .................................................................282 Editing and Proofing in the Content Editor .............................................................282 Inserting Tables in the Content Editor.....................................................................282 Viewing and Modifying Table Cells, Rows, and Columns in the Content Editor...283 Working in the HTML5 Source Code View............................................................284 Saving HTML5 Documents ....................................................................................285
Editing Word Documents ......................................................................................................285
Applying Styles in Microsoft Word ........................................................................287 Adding, Renaming, and Deleting Topics ................................................................288 Creating Margin Notes ............................................................................................289 Inserting Cross References......................................................................................289
- Doc-To-Help 2014 User Guide
- Contents v
Inserting an HTML Help ActiveX Control .............................................................290 Adding Terms to the Glossary.................................................................................291 Inserting a Standard Doc-To-Help Table ................................................................291 Shortcut Keys ..........................................................................................................292
Editing HTML Documents....................................................................................................293
Applying Styles in Microsoft FrontPage and Adobe Dreamweaver........................294
Inserting Flash Movies ..........................................................................................................295 Creating Image Maps (graphics with links)...........................................................................296
Splitting a Graphic into Equal Regions ...................................................................296
Setting Document Properties .................................................................................................297
Renaming Topics.....................................................................................................299
Creating a Glossary................................................................................................................299
- Using D2HML (Doc-To-Help Markup Language)
- 303
Creating Links .......................................................................................................................305
Drag-and-Drop Linking...........................................................................................307
Creating Inline, Dropdown, or Popup Text............................................................................308 Inserting an Index Entry ........................................................................................................309 Adding a Topic to a Group ....................................................................................................310 Adding a Link Tag.................................................................................................................311 Setting D2HML Topic Properties..........................................................................................312 Marking Text as Conditional.................................................................................................313 Inserting a Variable................................................................................................................315 Creating an Expanding/Collapsing Section ...........................................................................316 Clearing D2HML Styles........................................................................................................317 Showing Hidden Hotspots .....................................................................................................317
- Managing Topics
- 321
Viewing/Changing Topic Properties......................................................................................321 Printing and Exporting the Topic List ...................................................................................323
Printing the Topic List.............................................................................................323 Exporting the Topic List..........................................................................................324
Setting Topic Conditions .......................................................................................................325 Managing Related Topics......................................................................................................325 Creating an Index or Groups..................................................................................................327 Creating a Table of Contents .................................................................................................329