Table Of Content

ComponentOne Doc-To-Help 2014 User Guide Copyright © 2014 GrapeCity, inc. All rights reserved. Corporate Headquarters ComponentOne, a division of GrapeCity, inc. 201 South Highland Avenue 3rd Floor Pittsburgh, PA 15206 · USA Email: Contents Welcome to Doc-To-Help 2014! .................................................................... 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 File Style Sheets ............................................................................................ 10 Doc-To-Help Outputs and Deliverables .................................................................................. 11 Installing NetHelp ..................................................................................................... 16 Creating Section 508 Compliant Help ....................................................................... 18 Search Options for NetHelp ...................................................................................... 20 Source Document locations ....................................................................................... 23 Template and Style Sheet locations ......................................................................................... 23 Theme locations ....................................................................................................................... 24 Licensing and Technical Issues ............................................................................................... 24 License and Redistributable Files .............................................................................. 24 Technical Support ...................................................................................................... 24 System Requirements ................................................................................................ 25 Using Anti-virus Software with Doc-To-Help .......................................................... 25 Installing Doc-To-Help ............................................................................................. 26 Using Live Update ..................................................................................................... 26 Activating Doc-To-Help .......................................................................................................... 27 Deactivating Doc-To-Help ........................................................................................ 27 Setting Doc-To-Help Options .................................................................................... 28 Doc-To-Help Learning Library ............................................................................................... 29 Trademark Statement................................................................................................. 30 Migrating a Project....................................................................................... 31 Doc-To-Help Quick Reference Page ....................................................................................... 33 Doc-To-Help Workflow .......................................................................................................... 34 Doc-To-Help Quick Tour .............................................................................. 37 Building and Examining a Target ............................................................................................ 54 Inserting a Graphic .................................................................................................................. 56 Applying a Style ...................................................................................................................... 58 Creating a Topic Link .............................................................................................................. 60 Creating Inline Text ................................................................................................................. 62 Creating an Index Entry ........................................................................................................... 63 Defining Help Targets ............................................................................................................. 65 Creating Custom Topic Relations ............................................................................................ 67 Adding a Document ................................................................................................................. 69 Adding Glossary Entries .......................................................................................................... 73 Creating a Customized Table of Contents ............................................................................... 75 ComponentOne Doc-To-Help 2014 Contents  iii Adding Items to the Index and Creating Groups ..................................................................... 76 Additional Resources ............................................................................................................... 80 Navigating Doc-To-Help .............................................................................. 81 Quick Access toolbar ............................................................................................................... 82 Super ToolTips ........................................................................................................................ 82 Ribbons .................................................................................................................................... 83 File tab ....................................................................................................................... 83 Home tab ................................................................................................................... 84 Editor tab ................................................................................................................... 86 Paragraph ribbon group (Editor tab) .......................................................................... 87 Table tab .................................................................................................................... 89 Insert tab .................................................................................................................... 91 Components ribbon group (Insert tab) ....................................................................... 92 Topics tab .................................................................................................................. 93 Project tab .................................................................................................................. 94 Team Authoring tab ................................................................................................... 95 Translation tab ......................................................................................................................... 96 SharePoint Documents ribbon group (Translation tab) ............................................. 97 Navigation Panes ..................................................................................................................... 97 Documents pane ........................................................................................................ 98 Contents pane ............................................................................................................ 99 Index and Groups pane ............................................................................................ 100 Related Topics pane ................................................................................................ 101 Windows ................................................................................................................................ 102 Start Page window ................................................................................................... 102 Topics window ........................................................................................................ 102 Output window ........................................................................................................ 103 Content Editor window ............................................................................................ 103 Variables window .................................................................................................... 104 Team Authoring window ......................................................................................... 104 Translation window ................................................................................................. 104 Dynamic Help ........................................................................................................................ 105 Creating and Converting Projects ............................................................ 107 Converting RoboHelp HTML Notes ..................................................................................... 108 Converting RoboHelp Word Notes ........................................................................................ 112 Converting HTML Help Notes .............................................................................................. 117 Converting Doc-To-Help 2000 Notes .................................................................................... 118 Converting WinHelp Notes ................................................................................................... 119 Customizing Your Project ......................................................................... 123 Creating Help Targets ............................................................................................................ 123 NetHelp Targets ...................................................................................................... 124 HTML Help Targets ................................................................................................ 129 EPUB Targets .......................................................................................................... 132 Eclipse Help Targets................................................................................................ 134 JavaHelp Targets ..................................................................................................... 136 WinHelp Targets ..................................................................................................... 139 Manual Targets ........................................................................................................ 142 Microsoft Help Viewer Targets ............................................................................... 144 Microsoft Help 2.0 Targets ...................................................................................... 147 Utilizing Conditions ............................................................................................................... 150 Defining Attributes .................................................................................................. 152 iv  Contents ComponentOne Doc-To-Help 2014 Setting the Help Window Display ......................................................................................... 153 WinHelp Window .................................................................................................... 154 NetHelp Window ..................................................................................................... 155 HTML Help Window .............................................................................................. 155 Manual Window ...................................................................................................... 157 Microsoft Help Viewer Window ............................................................................. 157 EPUB Window ........................................................................................................ 157 Microsoft Help 2.0 Window .................................................................................... 157 JavaHelp Window ................................................................................................... 157 Defining Character/Paragraph Styles and Topic Types ......................................................... 158 Character Styles ....................................................................................................... 160 Paragraph Styles ...................................................................................................... 161 Topic Types ............................................................................................................. 164 Working with Scripts ............................................................................................... 165 Editing a CSS ......................................................................................................................... 166 Style List Window Tour .......................................................................................... 168 Creating Variables ................................................................................................................. 171 Setting Project Properties....................................................................................................... 173 Choosing a Source Folder ....................................................................................... 175 Compacting a Project File...................................................................................................... 175 Importing and Exporting Project Settings .............................................................................. 176 Implementing Context Sensitive Help ................................................................................... 177 Context Sensitive Help in JavaHelp ........................................................................ 179 Context Sensitive Help in Microsoft Help 2.0 ......................................................... 179 Context Sensitive Help in Microsoft Help Viewer .................................................. 179 Context Sensitive Help in NetHelp Classic ............................................................. 179 Context Sensitive Help in NetHelp 2.0.................................................................... 183 Mapping Context Sensitive Help using DynamicHelp Authoring Mode ................ 189 Customizing Themes with the Theme Designer .................................................................... 193 Adding a Theme or Theme Configuration ............................................................................. 194 Customizing NetHelp 2.0 Themes ............................................................ 195 Using the NetHelp 2.0 Theme Designer ................................................................................ 197 NetHelp 2.0 Theme Designer Settings (Responsive) .............................................. 198 NetHelp 2.0 Theme Designer Settings (Tabs and Accordion) ................................ 206 Adding Custom Icons to a NetHelp 2.0 Theme ....................................................... 211 Using the Settings List Editor for Localization and more ....................................... 212 Creating and Adding New Style Sheets ................................................................................. 213 Additional Theme Customizations ........................................................................................ 214 Examples: Changing the Style sheet ....................................................................... 215 Examples: Manual Customization ........................................................................... 217 Theme Configuration FAQ .................................................................................................... 222 Customizing Eclipse Help and EPUB Themes ........................................ 225 Using the Theme Editor ......................................................................................................... 226 Customizing NetHelp Classic, HTML Help, Microsoft Help Viewer, Microsoft Help 2.0, and JavaHelp Themes ....................................................................................... 231 Customizing Topics with the Transformation Wizard ............................ 247 Advanced XML Transformations .......................................................................................... 249 Working with Source Documents ............................................................. 251 Adding a Document to a Project ............................................................................................ 252 ComponentOne Doc-To-Help 2014 Contents  v Converting Existing Documents to HTML5 .......................................................................... 253 Editing HTML5 Documents .................................................................................................. 255 Adding Widgets in the Content Editor .................................................................... 256 Adding Comments in the Content Editor ................................................................ 263 Applying Styles in the Content Editor ..................................................................... 264 Managing Style Gallery Styles ................................................................................ 268 Inserting Images in the Content Editor .................................................................... 268 Creating Hyperlinks in the Content Editor .............................................................. 269 Creating Bookmarks in the Content Editor ............................................................. 269 Inserting Symbols in the Content Editor ................................................................. 270 Editing and Proofing in the Content Editor ............................................................. 270 Inserting Tables in the Content Editor ..................................................................... 270 Viewing and Modifying Table Cells, Rows, and Columns in the Content Editor ... 271 Working in the HTML5 Source Code View ............................................................ 272 Saving HTML5 Documents .................................................................................... 273 Editing Word Documents ...................................................................................................... 274 Applying Styles in Microsoft Word ........................................................................ 275 Adding, Renaming, and Deleting Topics ................................................................ 276 Creating Margin Notes ............................................................................................ 277 Inserting Cross References ...................................................................................... 278 Inserting an HTML Help ActiveX Control ............................................................. 278 Adding Terms to the Glossary ................................................................................. 279 Inserting a Standard Doc-To-Help Table ................................................................ 279 Shortcut Keys .......................................................................................................... 280 Editing HTML Documents .................................................................................................... 281 Applying Styles in Microsoft FrontPage and Adobe Dreamweaver ........................ 282 Inserting Flash Movies .......................................................................................................... 283 Creating Image Maps (graphics with links) ........................................................................... 284 Splitting a Graphic into Equal Regions ................................................................... 284 Setting Document Properties ................................................................................................. 285 Renaming Topics ..................................................................................................... 287 Creating a Glossary ................................................................................................................ 287 Using D2HML (Doc-To-Help Markup Language) ..................................... 289 Creating Links ....................................................................................................................... 292 Drag-and-Drop Linking ........................................................................................... 293 Creating Inline, Dropdown, or Popup Text ............................................................................ 294 Inserting an Index Entry ........................................................................................................ 295 Adding a Topic to a Group .................................................................................................... 296 Adding a Link Tag ................................................................................................................. 297 Setting D2HML Topic Properties .......................................................................................... 298 Marking Text as Conditional ................................................................................................. 299 Inserting a Variable ................................................................................................................ 300 Creating an Expanding/Collapsing Section ........................................................................... 301 Clearing D2HML Styles ........................................................................................................ 302 Showing Hidden Hotspots ..................................................................................................... 303 Managing Topics ....................................................................................... 305 Viewing/Changing Topic Properties ...................................................................................... 305 Printing and Exporting the Topic List ................................................................................... 307 Printing the Topic List ............................................................................................. 307 Exporting the Topic List .......................................................................................... 308 Setting Topic Conditions ....................................................................................................... 309 Managing Related Topics ...................................................................................................... 309 vi  Contents ComponentOne Doc-To-Help 2014 Creating an Index or Groups .................................................................................................. 311 Creating a Table of Contents ................................................................................................. 313 Extending Targets...................................................................................... 317 Adding DISQUS Commenting to NetHelp 2.0 Targets ......................................................... 317 Embedding NetHelp 2.0 Targets into Web Pages .................................................................. 319 Building a Target ....................................................................................... 323 Scheduling Builds with the Build Scheduler ......................................................................... 325 Setting Up a Scheduled Build .................................................................................. 326 Building Help Targets in Batch Mode ................................................................................... 326 Doc-To-Help Reports ................................................................................. 329 Help Contents Listing ............................................................................................................ 329 Help Index Listing ................................................................................................................. 329 Index Report by Group .......................................................................................................... 329 Index Report by Keyword...................................................................................................... 329 Index Report by Topic ........................................................................................................... 329 Script Listings ........................................................................................................................ 330 Style Definitions .................................................................................................................... 330 Topic Detail Report ............................................................................................................... 330 Unindexed Topic Report ........................................................................................................ 330 Collaborating with SharePoint .................................................................. 331 Uploading and Working with Documents in a SharePoint Library ....................................... 331 Adding SharePoint Library Documents to a Doc-To-Help Project ......................... 333 Working with Shared Documents ............................................................................ 334 Checking documents In and Out of the SharePoint Library .................................... 335 Synchronizing Documents ....................................................................................... 336 Merging Documents (Word documents only) ........................................................ 336 Working Offline ...................................................................................................... 338 Stop Sharing a Document ........................................................................................ 338 Uploading and Working with Documents in a SharePoint Translation Library .................... 339 Creating a SharePoint Translation Library .............................................................. 339 Uploading Documents to a SharePoint Translation Library .................................... 342 Working with a Translation Project ......................................................................... 349 Publishing to SharePoint .......................................................................... 351 Editing a SharePoint Wiki ..................................................................................................... 354 Working on a Team .................................................................................... 357 Setting Up a Team Project ..................................................................................................... 358 Sharing a Project to a Repository ............................................................................ 358 Connecting to a Team Project ................................................................................................ 360 The Team Authoring Environment ........................................................................................ 361 Working in a Team Project .................................................................................................... 363 Editing a Document ................................................................................................. 364 Adding a New File to the Team Project .................................................................. 364 Deleting a File from the Team Project .................................................................... 365 Checking out the Project File .................................................................................. 365 Working Offline ...................................................................................................... 366 ComponentOne Doc-To-Help 2014 Contents  vii Getting the Latest Version of a File ......................................................................... 366 Comparing Documents (TFS repositories only) ...................................................... 367 Viewing the Document History (TFS repositories only) ......................................... 367 Viewing File Properties (TFS repositories only) ..................................................... 367 Team Authoring Administrative Functions ........................................................................... 367 Removing Backup Files from the Repository.......................................................... 368 Unlocking Files in the Repository ........................................................................... 369 Unlocking the .dhv File ........................................................................................... 369 Upgrading a Team Authoring Project...................................................................... 370 Removing Team Authoring Support from a Working Copy ................................... 370 Changing Repository Settings ................................................................................. 370 Creating a Modular Help System .............................................................. 373 Modular Help System Deliverables ....................................................................................... 373 Standardizing Modular Help .................................................................................................. 374 File Organization ................................................................................................................... 375 Creating a Hub Project ........................................................................................................... 375 Creating a Child Project ......................................................................................................... 377 Cross-Project Linking .............................................................................................. 377 Modifying Context IDs in Modular Projects ........................................................... 378 Modular Help System Glossaries ............................................................................ 378 Modular TOC Utility ............................................................................................... 378 Creating a Modular Help System for Microsoft Help Viewer Targets .................................. 379 Documenting Your Class Library with Microsoft® Sandcastle ............. 383 Creating a Project with Sandcastle ........................................................................................ 383 Converting Documenter for .NET projects to Sandcastle projects ........................................ 384 Configuring the Sandcastle Reference Section with the Properties for Generating Reference dialog box .............................................................................................................................. 385 Import node ............................................................................................................. 386 Generation node ...................................................................................................... 386 Assemblies node ...................................................................................................... 387 Dependencies node .................................................................................................. 388 Element filter node .................................................................................................. 388 Visibility Filter node................................................................................................ 389 Output node ............................................................................................................. 390 Configure CodeBlock Component dialog box ....................................................................... 396 Configure PostTransform Component dialog box ................................................................. 397 CodeBlock and PostTransform components .......................................................................... 399 XSLT transformation of the source code comments XML .................................................... 400 Excluding elements without description ................................................................................ 400 Using styles to create links from narrative text to reference text ........................................... 400 Link Class Style ....................................................................................................... 401 Link Constructor Style ............................................................................................ 402 Link Delegate Style ................................................................................................. 402 Link Enumeration Style ........................................................................................... 403 Link Event Style ...................................................................................................... 403 Link Field Style ....................................................................................................... 404 Link Interface Style ................................................................................................. 404 Link Method Style ................................................................................................... 405 Link Namespace Style ............................................................................................. 405 Link Operator Style ................................................................................................. 406 Link Property Style.................................................................................................. 407 Link Structure Style ................................................................................................. 407 viii  Contents ComponentOne Doc-To-Help 2014 Special Characters in Link Text .............................................................................. 408 Argument List in Links ........................................................................................... 409 Link Colors and Appearance ................................................................................... 409 Using D2HML hot spots in XML comments to create links from reference text to narrative text ......................................................................................................................................... 410 Doc-To-Help Frequently Asked Questions .............................................. 411 FAQs: General Questions ...................................................................................................... 411 FAQ: File Size ....................................................................................................................... 413 FAQs: Styles .......................................................................................................................... 413 FAQs: Templates and CSSs ................................................................................................... 413 FAQs: Images ........................................................................................................................ 416 FAQs: Licensing .................................................................................................................... 416 FAQs: Support ....................................................................................................................... 417 FAQs: System Requirements ................................................................................................. 418 FAQs: Help Functionality ...................................................................................................... 419 FAQs: Manuals ...................................................................................................................... 420 FAQs: Authoring in Microsoft Word .................................................................................... 420 FAQs: Troubleshooting ......................................................................................................... 421 Glossary ..................................................................................................... 423 Index ........................................................................................................... 431 ComponentOne Doc-To-Help 2014 Contents  ix x  Contents ComponentOne Doc-To-Help 2014

ebook img

Doc-To-Help 2014 User Guide PDF

444 Pages·2014·8.71 MB·English
by  
Save to my drive
Quick download
Download
Upgrade Premium
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview Doc-To-Help 2014 User Guide

ComponentOne Doc-To-Help 2014 User Guide Copyright © 2014 GrapeCity, inc. All rights reserved. Corporate Headquarters ComponentOne, a division of GrapeCity, inc. 201 South Highland Avenue 3rd Floor Pittsburgh, PA 15206 · USA Email: Contents Welcome to Doc-To-Help 2014! .................................................................... 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 File Style Sheets ............................................................................................ 10 Doc-To-Help Outputs and Deliverables .................................................................................. 11 Installing NetHelp ..................................................................................................... 16 Creating Section 508 Compliant Help ....................................................................... 18 Search Options for NetHelp ...................................................................................... 20 Source Document locations ....................................................................................... 23 Template and Style Sheet locations ......................................................................................... 23 Theme locations ....................................................................................................................... 24 Licensing and Technical Issues ............................................................................................... 24 License and Redistributable Files .............................................................................. 24 Technical Support ...................................................................................................... 24 System Requirements ................................................................................................ 25 Using Anti-virus Software with Doc-To-Help .......................................................... 25 Installing Doc-To-Help ............................................................................................. 26 Using Live Update ..................................................................................................... 26 Activating Doc-To-Help .......................................................................................................... 27 Deactivating Doc-To-Help ........................................................................................ 27 Setting Doc-To-Help Options .................................................................................... 28 Doc-To-Help Learning Library ............................................................................................... 29 Trademark Statement................................................................................................. 30 Migrating a Project....................................................................................... 31 Doc-To-Help Quick Reference Page ....................................................................................... 33 Doc-To-Help Workflow .......................................................................................................... 34 Doc-To-Help Quick Tour .............................................................................. 37 Building and Examining a Target ............................................................................................ 54 Inserting a Graphic .................................................................................................................. 56 Applying a Style ...................................................................................................................... 58 Creating a Topic Link .............................................................................................................. 60 Creating Inline Text ................................................................................................................. 62 Creating an Index Entry ........................................................................................................... 63 Defining Help Targets ............................................................................................................. 65 Creating Custom Topic Relations ............................................................................................ 67 Adding a Document ................................................................................................................. 69 Adding Glossary Entries .......................................................................................................... 73 Creating a Customized Table of Contents ............................................................................... 75 ComponentOne Doc-To-Help 2014 Contents  iii Adding Items to the Index and Creating Groups ..................................................................... 76 Additional Resources ............................................................................................................... 80 Navigating Doc-To-Help .............................................................................. 81 Quick Access toolbar ............................................................................................................... 82 Super ToolTips ........................................................................................................................ 82 Ribbons .................................................................................................................................... 83 File tab ....................................................................................................................... 83 Home tab ................................................................................................................... 84 Editor tab ................................................................................................................... 86 Paragraph ribbon group (Editor tab) .......................................................................... 87 Table tab .................................................................................................................... 89 Insert tab .................................................................................................................... 91 Components ribbon group (Insert tab) ....................................................................... 92 Topics tab .................................................................................................................. 93 Project tab .................................................................................................................. 94 Team Authoring tab ................................................................................................... 95 Translation tab ......................................................................................................................... 96 SharePoint Documents ribbon group (Translation tab) ............................................. 97 Navigation Panes ..................................................................................................................... 97 Documents pane ........................................................................................................ 98 Contents pane ............................................................................................................ 99 Index and Groups pane ............................................................................................ 100 Related Topics pane ................................................................................................ 101 Windows ................................................................................................................................ 102 Start Page window ................................................................................................... 102 Topics window ........................................................................................................ 102 Output window ........................................................................................................ 103 Content Editor window ............................................................................................ 103 Variables window .................................................................................................... 104 Team Authoring window ......................................................................................... 104 Translation window ................................................................................................. 104 Dynamic Help ........................................................................................................................ 105 Creating and Converting Projects ............................................................ 107 Converting RoboHelp HTML Notes ..................................................................................... 108 Converting RoboHelp Word Notes ........................................................................................ 112 Converting HTML Help Notes .............................................................................................. 117 Converting Doc-To-Help 2000 Notes .................................................................................... 118 Converting WinHelp Notes ................................................................................................... 119 Customizing Your Project ......................................................................... 123 Creating Help Targets ............................................................................................................ 123 NetHelp Targets ...................................................................................................... 124 HTML Help Targets ................................................................................................ 129 EPUB Targets .......................................................................................................... 132 Eclipse Help Targets................................................................................................ 134 JavaHelp Targets ..................................................................................................... 136 WinHelp Targets ..................................................................................................... 139 Manual Targets ........................................................................................................ 142 Microsoft Help Viewer Targets ............................................................................... 144 Microsoft Help 2.0 Targets ...................................................................................... 147 Utilizing Conditions ............................................................................................................... 150 Defining Attributes .................................................................................................. 152 iv  Contents ComponentOne Doc-To-Help 2014 Setting the Help Window Display ......................................................................................... 153 WinHelp Window .................................................................................................... 154 NetHelp Window ..................................................................................................... 155 HTML Help Window .............................................................................................. 155 Manual Window ...................................................................................................... 157 Microsoft Help Viewer Window ............................................................................. 157 EPUB Window ........................................................................................................ 157 Microsoft Help 2.0 Window .................................................................................... 157 JavaHelp Window ................................................................................................... 157 Defining Character/Paragraph Styles and Topic Types ......................................................... 158 Character Styles ....................................................................................................... 160 Paragraph Styles ...................................................................................................... 161 Topic Types ............................................................................................................. 164 Working with Scripts ............................................................................................... 165 Editing a CSS ......................................................................................................................... 166 Style List Window Tour .......................................................................................... 168 Creating Variables ................................................................................................................. 171 Setting Project Properties....................................................................................................... 173 Choosing a Source Folder ....................................................................................... 175 Compacting a Project File...................................................................................................... 175 Importing and Exporting Project Settings .............................................................................. 176 Implementing Context Sensitive Help ................................................................................... 177 Context Sensitive Help in JavaHelp ........................................................................ 179 Context Sensitive Help in Microsoft Help 2.0 ......................................................... 179 Context Sensitive Help in Microsoft Help Viewer .................................................. 179 Context Sensitive Help in NetHelp Classic ............................................................. 179 Context Sensitive Help in NetHelp 2.0.................................................................... 183 Mapping Context Sensitive Help using DynamicHelp Authoring Mode ................ 189 Customizing Themes with the Theme Designer .................................................................... 193 Adding a Theme or Theme Configuration ............................................................................. 194 Customizing NetHelp 2.0 Themes ............................................................ 195 Using the NetHelp 2.0 Theme Designer ................................................................................ 197 NetHelp 2.0 Theme Designer Settings (Responsive) .............................................. 198 NetHelp 2.0 Theme Designer Settings (Tabs and Accordion) ................................ 206 Adding Custom Icons to a NetHelp 2.0 Theme ....................................................... 211 Using the Settings List Editor for Localization and more ....................................... 212 Creating and Adding New Style Sheets ................................................................................. 213 Additional Theme Customizations ........................................................................................ 214 Examples: Changing the Style sheet ....................................................................... 215 Examples: Manual Customization ........................................................................... 217 Theme Configuration FAQ .................................................................................................... 222 Customizing Eclipse Help and EPUB Themes ........................................ 225 Using the Theme Editor ......................................................................................................... 226 Customizing NetHelp Classic, HTML Help, Microsoft Help Viewer, Microsoft Help 2.0, and JavaHelp Themes ....................................................................................... 231 Customizing Topics with the Transformation Wizard ............................ 247 Advanced XML Transformations .......................................................................................... 249 Working with Source Documents ............................................................. 251 Adding a Document to a Project ............................................................................................ 252 ComponentOne Doc-To-Help 2014 Contents  v Converting Existing Documents to HTML5 .......................................................................... 253 Editing HTML5 Documents .................................................................................................. 255 Adding Widgets in the Content Editor .................................................................... 256 Adding Comments in the Content Editor ................................................................ 263 Applying Styles in the Content Editor ..................................................................... 264 Managing Style Gallery Styles ................................................................................ 268 Inserting Images in the Content Editor .................................................................... 268 Creating Hyperlinks in the Content Editor .............................................................. 269 Creating Bookmarks in the Content Editor ............................................................. 269 Inserting Symbols in the Content Editor ................................................................. 270 Editing and Proofing in the Content Editor ............................................................. 270 Inserting Tables in the Content Editor ..................................................................... 270 Viewing and Modifying Table Cells, Rows, and Columns in the Content Editor ... 271 Working in the HTML5 Source Code View ............................................................ 272 Saving HTML5 Documents .................................................................................... 273 Editing Word Documents ...................................................................................................... 274 Applying Styles in Microsoft Word ........................................................................ 275 Adding, Renaming, and Deleting Topics ................................................................ 276 Creating Margin Notes ............................................................................................ 277 Inserting Cross References ...................................................................................... 278 Inserting an HTML Help ActiveX Control ............................................................. 278 Adding Terms to the Glossary ................................................................................. 279 Inserting a Standard Doc-To-Help Table ................................................................ 279 Shortcut Keys .......................................................................................................... 280 Editing HTML Documents .................................................................................................... 281 Applying Styles in Microsoft FrontPage and Adobe Dreamweaver ........................ 282 Inserting Flash Movies .......................................................................................................... 283 Creating Image Maps (graphics with links) ........................................................................... 284 Splitting a Graphic into Equal Regions ................................................................... 284 Setting Document Properties ................................................................................................. 285 Renaming Topics ..................................................................................................... 287 Creating a Glossary ................................................................................................................ 287 Using D2HML (Doc-To-Help Markup Language) ..................................... 289 Creating Links ....................................................................................................................... 292 Drag-and-Drop Linking ........................................................................................... 293 Creating Inline, Dropdown, or Popup Text ............................................................................ 294 Inserting an Index Entry ........................................................................................................ 295 Adding a Topic to a Group .................................................................................................... 296 Adding a Link Tag ................................................................................................................. 297 Setting D2HML Topic Properties .......................................................................................... 298 Marking Text as Conditional ................................................................................................. 299 Inserting a Variable ................................................................................................................ 300 Creating an Expanding/Collapsing Section ........................................................................... 301 Clearing D2HML Styles ........................................................................................................ 302 Showing Hidden Hotspots ..................................................................................................... 303 Managing Topics ....................................................................................... 305 Viewing/Changing Topic Properties ...................................................................................... 305 Printing and Exporting the Topic List ................................................................................... 307 Printing the Topic List ............................................................................................. 307 Exporting the Topic List .......................................................................................... 308 Setting Topic Conditions ....................................................................................................... 309 Managing Related Topics ...................................................................................................... 309 vi  Contents ComponentOne Doc-To-Help 2014 Creating an Index or Groups .................................................................................................. 311 Creating a Table of Contents ................................................................................................. 313 Extending Targets...................................................................................... 317 Adding DISQUS Commenting to NetHelp 2.0 Targets ......................................................... 317 Embedding NetHelp 2.0 Targets into Web Pages .................................................................. 319 Building a Target ....................................................................................... 323 Scheduling Builds with the Build Scheduler ......................................................................... 325 Setting Up a Scheduled Build .................................................................................. 326 Building Help Targets in Batch Mode ................................................................................... 326 Doc-To-Help Reports ................................................................................. 329 Help Contents Listing ............................................................................................................ 329 Help Index Listing ................................................................................................................. 329 Index Report by Group .......................................................................................................... 329 Index Report by Keyword...................................................................................................... 329 Index Report by Topic ........................................................................................................... 329 Script Listings ........................................................................................................................ 330 Style Definitions .................................................................................................................... 330 Topic Detail Report ............................................................................................................... 330 Unindexed Topic Report ........................................................................................................ 330 Collaborating with SharePoint .................................................................. 331 Uploading and Working with Documents in a SharePoint Library ....................................... 331 Adding SharePoint Library Documents to a Doc-To-Help Project ......................... 333 Working with Shared Documents ............................................................................ 334 Checking documents In and Out of the SharePoint Library .................................... 335 Synchronizing Documents ....................................................................................... 336 Merging Documents (Word documents only) ........................................................ 336 Working Offline ...................................................................................................... 338 Stop Sharing a Document ........................................................................................ 338 Uploading and Working with Documents in a SharePoint Translation Library .................... 339 Creating a SharePoint Translation Library .............................................................. 339 Uploading Documents to a SharePoint Translation Library .................................... 342 Working with a Translation Project ......................................................................... 349 Publishing to SharePoint .......................................................................... 351 Editing a SharePoint Wiki ..................................................................................................... 354 Working on a Team .................................................................................... 357 Setting Up a Team Project ..................................................................................................... 358 Sharing a Project to a Repository ............................................................................ 358 Connecting to a Team Project ................................................................................................ 360 The Team Authoring Environment ........................................................................................ 361 Working in a Team Project .................................................................................................... 363 Editing a Document ................................................................................................. 364 Adding a New File to the Team Project .................................................................. 364 Deleting a File from the Team Project .................................................................... 365 Checking out the Project File .................................................................................. 365 Working Offline ...................................................................................................... 366 ComponentOne Doc-To-Help 2014 Contents  vii Getting the Latest Version of a File ......................................................................... 366 Comparing Documents (TFS repositories only) ...................................................... 367 Viewing the Document History (TFS repositories only) ......................................... 367 Viewing File Properties (TFS repositories only) ..................................................... 367 Team Authoring Administrative Functions ........................................................................... 367 Removing Backup Files from the Repository.......................................................... 368 Unlocking Files in the Repository ........................................................................... 369 Unlocking the .dhv File ........................................................................................... 369 Upgrading a Team Authoring Project...................................................................... 370 Removing Team Authoring Support from a Working Copy ................................... 370 Changing Repository Settings ................................................................................. 370 Creating a Modular Help System .............................................................. 373 Modular Help System Deliverables ....................................................................................... 373 Standardizing Modular Help .................................................................................................. 374 File Organization ................................................................................................................... 375 Creating a Hub Project ........................................................................................................... 375 Creating a Child Project ......................................................................................................... 377 Cross-Project Linking .............................................................................................. 377 Modifying Context IDs in Modular Projects ........................................................... 378 Modular Help System Glossaries ............................................................................ 378 Modular TOC Utility ............................................................................................... 378 Creating a Modular Help System for Microsoft Help Viewer Targets .................................. 379 Documenting Your Class Library with Microsoft® Sandcastle ............. 383 Creating a Project with Sandcastle ........................................................................................ 383 Converting Documenter for .NET projects to Sandcastle projects ........................................ 384 Configuring the Sandcastle Reference Section with the Properties for Generating Reference dialog box .............................................................................................................................. 385 Import node ............................................................................................................. 386 Generation node ...................................................................................................... 386 Assemblies node ...................................................................................................... 387 Dependencies node .................................................................................................. 388 Element filter node .................................................................................................. 388 Visibility Filter node................................................................................................ 389 Output node ............................................................................................................. 390 Configure CodeBlock Component dialog box ....................................................................... 396 Configure PostTransform Component dialog box ................................................................. 397 CodeBlock and PostTransform components .......................................................................... 399 XSLT transformation of the source code comments XML .................................................... 400 Excluding elements without description ................................................................................ 400 Using styles to create links from narrative text to reference text ........................................... 400 Link Class Style ....................................................................................................... 401 Link Constructor Style ............................................................................................ 402 Link Delegate Style ................................................................................................. 402 Link Enumeration Style ........................................................................................... 403 Link Event Style ...................................................................................................... 403 Link Field Style ....................................................................................................... 404 Link Interface Style ................................................................................................. 404 Link Method Style ................................................................................................... 405 Link Namespace Style ............................................................................................. 405 Link Operator Style ................................................................................................. 406 Link Property Style.................................................................................................. 407 Link Structure Style ................................................................................................. 407 viii  Contents ComponentOne Doc-To-Help 2014 Special Characters in Link Text .............................................................................. 408 Argument List in Links ........................................................................................... 409 Link Colors and Appearance ................................................................................... 409 Using D2HML hot spots in XML comments to create links from reference text to narrative text ......................................................................................................................................... 410 Doc-To-Help Frequently Asked Questions .............................................. 411 FAQs: General Questions ...................................................................................................... 411 FAQ: File Size ....................................................................................................................... 413 FAQs: Styles .......................................................................................................................... 413 FAQs: Templates and CSSs ................................................................................................... 413 FAQs: Images ........................................................................................................................ 416 FAQs: Licensing .................................................................................................................... 416 FAQs: Support ....................................................................................................................... 417 FAQs: System Requirements ................................................................................................. 418 FAQs: Help Functionality ...................................................................................................... 419 FAQs: Manuals ...................................................................................................................... 420 FAQs: Authoring in Microsoft Word .................................................................................... 420 FAQs: Troubleshooting ......................................................................................................... 421 Glossary ..................................................................................................... 423 Index ........................................................................................................... 431 ComponentOne Doc-To-Help 2014 Contents  ix x  Contents ComponentOne Doc-To-Help 2014

See more

The list of books you might like

Upgrade Premium
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.
DMCA & Copyright: Dear all, most of the website is community built, users are uploading hundred of books everyday, which makes really hard for us to identify copyrighted material, please contact us if you want any material removed.
Copyright @ PDFdrive.to, 2022 | We love our users