Doc-To-Help 2014 User Guide
Total Page:16
File Type:pdf, Size:1020Kb
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: [email protected] Web site: http://www.madcapsoftware.com Sales Email: [email protected] 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 .......................................................................................................