Doc-To-Help 2011 User Guide Copyright © 2011 Componentone LLC
Total Page:16
File Type:pdf, Size:1020Kb
ComponentOne Doc-To-Help 2011 User Guide Copyright © 2011 ComponentOne LLC. All rights reserved. Corporate Headquarters ComponentOne LLC 201 South Highland Avenue 3rd Floor Pittsburgh, PA 15206 · USA Email: [email protected] Web site: http://www.componentone.com Sales E-mail: [email protected] Telephone: 1.800.858.2739 or 1.412.681.4343 (Pittsburgh, PA USA Office) Technical Support See Technical Support in this manual for information on obtaining technical support. Trademarks ComponentOne Doc-To-Help 2011 and the ComponentOne Doc-To-Help 2011 logo are trademarks, and ComponentOne is a registered trademark of ComponentOne LLC. Microsoft, FrontPage, Vista, NT, XP, Visual Studio, Team Foundation Server, SharePoint, Sandcastle, and Windows are either registered trademarks or trademarks of Microsoft Corporation. Adobe, Dreamweaver, and RoboHelp are either registered trademarks or trademarks of Adobe Systems Corporation. Intel and Pentium are either registered trademarks or trademarks of Intel Corporation. Java is a registered trademark of Sun Microsystems, Inc. Google Chrome is a trademark of Google. Safari is a registered trademark of Apple, Inc. All other product and company names herein are the property of their respective owners. Warranty ComponentOne warrants that the original CD (or diskettes) are free from defects in material and workmanship, assuming normal use, for a period of 90 days from the date of purchase. If a defect occurs during this time, you may return the defective CD (or disk) to ComponentOne, along with a dated proof of purchase, and ComponentOne will replace it at no charge. After 90 days, you can obtain a replacement for a defective CD (or disk) by sending it and a check for $25 (to cover postage and handling) to ComponentOne. Except for the express warranty of the original CD (or disks) set forth here, ComponentOne makes no other warranties, express or implied. Every attempt has been made to ensure that the information contained in this manual is correct as of the time it was written. We are not responsible for any errors or omissions. ComponentOne’s liability is limited to the amount you paid for the product. ComponentOne is not liable for any special, consequential, or other damages for any reason. Copying and Distribution While you are welcome to make backup copies of the software for your own use and protection, you are not permitted to make copies for the use of anyone else. We put a lot of time and effort into creating this product, and we appreciate your support in seeing that it is used by licensed users only. Please read End User License Agreement for ComponentOne Doc-To-Help and License and Redistributable Files before copying and redistributing any ComponentOne Doc-To-Help 2011 files. 2011 V2 Contents Welcome to Doc-To-Help 2011! 1 Introduction to Single Sourcing.................................................................................................2 How Doc-To-Help Makes Single Sourcing Easier......................................................2 Three Easy Steps to Single Sourcing...........................................................................3 Tips for Logical Output...............................................................................................4 Guide to Templates and Styles ..................................................................................................4 Word File Templates ...................................................................................................7 HTML and XHTML File Style Sheets ......................................................................10 Doc-To-Help Outputs and Deliverables ..................................................................................11 NetHelp Installation Requirements ...........................................................................15 Section 508 Compliant NetHelp................................................................................17 Natural Search Requirements ....................................................................................19 Source Document locations.......................................................................................19 Template and Style Sheet locations...........................................................................20 Theme locations.......................................................................................................................20 Licensing and Technical Issues ...............................................................................................20 License and Redistributable Files..............................................................................20 Technical Support......................................................................................................21 System Requirements ................................................................................................21 Using Anti-virus Software with Doc-To-Help ..........................................................22 Installing Doc-To-Help .............................................................................................22 Using Live Update.....................................................................................................22 Deactivating Doc-To-Help ........................................................................................23 Setting Doc-To-Help Options....................................................................................23 Trademark Statement.................................................................................................25 Doc-To-Help Quick Reference Page .......................................................................................25 Doc-To-Help Workflow ..........................................................................................................26 Doc-To-Help Quick Tour 29 Building and Examining a Target............................................................................................46 Inserting a Graphic ..................................................................................................................48 Applying a Style ......................................................................................................................51 Creating a Topic Link..............................................................................................................53 Creating Inline Text.................................................................................................................55 Creating an Index Entry...........................................................................................................56 Defining Help Targets .............................................................................................................58 Creating Custom Topic Relations............................................................................................60 Adding a Document.................................................................................................................62 Adding Glossary Entries..........................................................................................................66 Creating a Customized Table of Contents ...............................................................................68 Adding Items to the Index and Creating Groups .....................................................................69 Additional Resources...............................................................................................................73 ComponentOne Doc-To-Help 2011 User Guide Contents iii Navigating Doc-To-Help 75 Quick Access toolbar...............................................................................................................76 Super ToolTips ........................................................................................................................76 Ribbons....................................................................................................................................77 File tab.......................................................................................................................77 Home tab ...................................................................................................................78 Editor tab...................................................................................................................80 Table tab....................................................................................................................82 Insert tab....................................................................................................................84 Topics tab ..................................................................................................................86 Project tab..................................................................................................................87 Team Authoring tab...................................................................................................88 Translation tab .........................................................................................................................89 SharePoint Documents ribbon group (Translation tab) .............................................90 Navigation Panes .....................................................................................................................90 Documents pane ........................................................................................................91