HelpNDoc User Manual Copyright © 2021 by IBE Software. All Rights Reserved. HelpNDoc User Manual Table of contents Welcome to HelpNDoc .......................................................................................... 11 Getting started with HelpNDoc ......................................................................... 11 Introduction ......................................................................................................... 11 About HelpNDoc .............................................................................................. 12 System requirements ....................................................................................... 12 Getting help ..................................................................................................... 12 HelpNDoc editions and licenses ........................................................................ 13 HelpNDoc license agreement ............................................................................ 14 What's new in HelpNDoc 7 ............................................................................... 17 How to buy HelpNDoc ...................................................................................... 19 Overview of the user interface .............................................................................. 20 File menu ........................................................................................................ 22 Ribbon tabs ..................................................................................................... 22 Styles editor .................................................................................................... 24 Find and replace window .................................................................................. 25 Options window ............................................................................................... 27 Quick start guides ................................................................................................ 29 Launching HelpNDoc ........................................................................................ 30 Create a new project ........................................................................................ 30 Adding topics ................................................................................................... 30 Setting up topic content ................................................................................... 30 2 / 229 HelpNDoc User Manual Generating documentation ............................................................................... 30 Writing documentation ......................................................................................... 31 Create a new project ........................................................................................ 31 Open an existing project .................................................................................. 32 Import other formats ........................................................................................ 32 Split imported documents ............................................................................. 33 Project options ................................................................................................. 33 Date and time format settings ...................................................................... 34 Managing the table of contents ......................................................................... 38 Create topics ............................................................................................... 38 Delete topics ............................................................................................... 39 Rename topics ............................................................................................. 39 Change topic properties ............................................................................... 40 Move topics ................................................................................................. 42 Using the topic editor ....................................................................................... 43 Topic kind ................................................................................................... 43 Headers and footers .................................................................................... 43 Font properties ............................................................................................ 44 Paragraph properties ................................................................................... 45 Working with styles ...................................................................................... 47 Working with hyperlinks ............................................................................... 48 Link to a specific topic .............................................................................. 48 3 / 229 HelpNDoc User Manual Link to a relative topic ............................................................................. 49 Link to an Internet or e-mail address ........................................................ 50 Link to a file ............................................................................................ 51 Link to a counter ..................................................................................... 52 Working with tables ..................................................................................... 52 Working with pictures .................................................................................. 53 Working with the image map editor .............................................................. 53 Using the library .............................................................................................. 54 Import files dialog ........................................................................................ 55 Folder library item ....................................................................................... 57 Picture library item ...................................................................................... 57 Image map library item ................................................................................ 62 Image map editor .................................................................................... 64 Movie library item ........................................................................................ 65 Document library item ................................................................................. 69 HTML code library item ................................................................................ 72 Variable library item .................................................................................... 73 Snippet library item ..................................................................................... 74 Snippet editor .......................................................................................... 75 Barcode library item ..................................................................................... 76 Barcode editor ......................................................................................... 77 Counter library item ..................................................................................... 78 4 / 229 HelpNDoc User Manual Using the keywords editor ................................................................................ 82 Manage keyword association ........................................................................ 83 Using the spell checker ..................................................................................... 84 Publishing documentation ..................................................................................... 86 Template settings ............................................................................................ 87 Advanced usages ................................................................................................. 88 Keyboard shortcuts .......................................................................................... 89 Keyboard auto-completion ........................................................................... 92 Customizing keyboard shortcuts ................................................................... 94 Topic status ..................................................................................................... 94 Conditional content generation ......................................................................... 95 Analyzing a project .......................................................................................... 96 General information ..................................................................................... 98 Visualize the project's structure .................................................................... 99 Analyzing hyperlinks ................................................................................... 100 Analyzing anchors ...................................................................................... 101 Analyzing library items ............................................................................... 102 Analyzing keywords .................................................................................... 104 Analyzing conditions ................................................................................... 105 Analyzing spelling ...................................................................................... 106 Vacuuming