HelpNDoc User Manual 1 / 64 Table of contents Welcome to HelpNDoc ................................................................................................................ 4 Getting started with HelpNDoc .............................................................................................. 4 Introduction .................................................................................................................................... 5 About HelpNDoc ..................................................................................................................... 5 System requirements .............................................................................................................. 5 Getting help .............................................................................................................................. 5 HelpNDoc editions .................................................................................................................. 6 HelpNDoc license agreement ............................................................................................... 7 What's new in HelpNDoc 3 .................................................................................................... 9 How to buy HelpNDoc .......................................................................................................... 10 Overview of the user interface .................................................................................................. 11 File menu ............................................................................................................................... 12 Ribbon tabs ........................................................................................................................... 12 Styles editor ........................................................................................................................... 13 Find and replace window ..................................................................................................... 14 Quick start guides ...................................................................................................................... 16 Launching HelpNDoc ........................................................................................................... 16 Create a new project ............................................................................................................ 16 Adding topics ........................................................................................................................ 16 Setting up topic content ........................................................................................................ 16 Generating documentation .................................................................................................. 16 Writing documentation .............................................................................................................. 17 Create a new project ............................................................................................................ 17 Open an existing project ...................................................................................................... 17 Import other formats .............................................................................................................. 18 Project options ...................................................................................................................... 18 Managing the table of contents ........................................................................................... 19 Create topics .................................................................................................................... 19 Delete topics .................................................................................................................... 19 Rename topics ................................................................................................................. 20 Change topic properties ................................................................................................. 20 Move topics ...................................................................................................................... 22 Using the topic editor ........................................................................................................... 22 Topic kind ......................................................................................................................... 22 Headers and footers ........................................................................................................ 22 Working with hyperlinks ................................................................................................... 23 Link to a specific topic ............................................................................................... 23 Link to a relative topic ................................................................................................ 24 Link to an Internet or e-mail address ........................................................................ 24 Link to a file ................................................................................................................. 25 Working with styles .......................................................................................................... 26 Working with tables ......................................................................................................... 26 Working with pictures ...................................................................................................... 26 Using the library .................................................................................................................... 27 Using the keywords editor ................................................................................................... 27 Using the spell checker ........................................................................................................ 28 Publishing documentation ......................................................................................................... 29 Advanced usages ...................................................................................................................... 30 Conditional content generation ........................................................................................... 30 Working with templates ........................................................................................................ 30 2 / 64 Best practices .................................................................................................................. 31 Template configuration file .............................................................................................. 32 Template inheritance ....................................................................................................... 32 Code templates ............................................................................................................... 33 CHM and HTML templates ............................................................................................. 33 Handle the generated topic links ............................................................................... 34 Methods available in templates ................................................................................. 34 Generate multiple files from a single template file .................................................. 48 Template variables ..................................................................................................... 49 Word and PDF templates ............................................................................................... 51 Samples ............................................................................................................................ 53 Building a single page HTML template .................................................................... 54 Use index.html as the default HTML page ............................................................... 57 Usage from the command line ............................................................................................ 58 CHM files and programming languages ............................................................................ 59 Delphi integration ............................................................................................................. 59 Java integration ................................................................................................................ 60 Microsoft Access integration .......................................................................................... 60 Visual Basic integration .................................................................................................. 60 FAQ and troubleshooting .......................................................................................................... 61 Help compilers ...................................................................................................................... 61 What compilers of libraries do I need to install? ........................................................... 61 Installing the Microsoft HTML Help Compiler displays a warning message? ........... 61 CHM and HTML help ............................................................................................................ 61 The