Table of Contents
  • Welcome to HelpNDoc
    • Getting started with HelpNDoc
  • Introduction
    • About HelpNDoc
    • System requirements
    • Getting help
    • HelpNDoc editions and licenses
    • HelpNDoc license agreement
    • What's new in HelpNDoc 10
      • What's new in HelpNDoc 9
      • What's new in HelpNDoc 8
      • What's new in HelpNDoc 7
      • What's new in HelpNDoc 6
      • What's new in HelpNDoc 5
    • How to buy HelpNDoc
  • Overview of the user interface
    • File menu
    • Ribbon tabs
    • Styles editor
    • Find and replace window
    • Options window
  • Quick start guides
    • Launching HelpNDoc
    • Create a new project
    • Adding topics
    • Setting up topic content
    • Generating documentation
  • Writing documentation
    • Create a new project
      • New project wizard
    • Open an existing project
    • Project options
      • Date and time format settings
    • Managing the table of contents
      • Create topics
      • Delete topics
      • Rename topics
      • Move topics
      • Change topic properties
      • Topic properties panel
        • Topic aliases
    • Using the topic editor
      • Topic kind
      • Headers and footers
      • Font properties
      • Paragraph properties
      • Working with styles
      • Working with hyperlinks
        • Link to a specific topic
        • Link to a relative topic
        • Link to an Internet or e-mail address
        • Link to a file
        • Link to a counter
      • Working with tables
      • Working with pictures
      • Working with the image map editor
    • Using the library
      • Import files dialog
      • Folder library item
      • Barcode library item
        • Barcode editor
      • Counter library item
      • Document library item
      • Dynamic content library item
      • Equation library item
      • HTML code library item
      • Image map library item
        • Image map editor
      • Movie library item
      • Picture library item
        • Image editor
      • Snippet library item
        • Snippet editor
      • Variable library item
    • Using the keywords editor
      • Manage keyword association
    • Import other formats
      • Split imported documents
      • HelpNDoc project importer
      • Import folders
      • Custom hyperlink types
    • Using the spell checker
  • Publishing documentation
    • Generate CHM help files
      • CHM settings
      • Customize CHM documentation settings
    • Generate HTML documentation
      • Customize HTML documentation settings
        • Inline table of contents
        • Setup Google tag manager
    • Generate Word documentation
      • Customize Word documentation settings
      • Sign Word documents
      • Encrypt Word documents
    • Generate PDF documentation
      • PDF settings
      • Customize PDF documentation settings
      • Sign PDF documents
      • Encrypt PDF documents
    • Generate ePub eBooks
      • Customize ePub documentation settings
    • Generate Kindle eBooks
      • Customize Kindle documentation settings
    • Generate Qt help documentation
      • Customize Qt help documentation settings
    • Generate Markdown documentation
      • Customize Markdown documentation settings
        • GitHub wiki Markdown documentation settings
        • Single page Markdown documentation settings
    • Generate Code for programming languages
    • Manage documentation builds
    • Define build settings
      • Template settings
      • Conditional generation
      • Options override
      • Override library items
      • Override styles
      • Sign documents
      • Encrypt documents
      • Build assets
      • Build actions
        • Build actions samples
          • Call an API to display the current date time using build actions
          • Copy files using the run program action
          • Compress output using the run program action
          • Show a warning message using build actions
          • Store last generation date and time using build actions
  • Advanced usages
    • Keyboard shortcuts
      • Keyboard auto-completion
      • Customizing keyboard shortcuts
    • Topic status
    • Conditional content generation
    • Analyzing a project
      • General information about the project
      • Visualize the project's structure
      • Analyzing hyperlinks in the project
      • Analyzing anchors in the project
      • Analyzing library items in the project
      • Analyzing keywords in the project
      • Analyzing conditions in the project
      • Analyzing spelling in the project
      • Analyzing characters in the project
    • Analyzing a topic
      • General information about a topic
      • Analyzing hyperlinks within a topic
      • Analyzing anchors within a topic
      • Analyzing library items within a topic
      • Analyzing keywords linked to a topic
      • Analyzing conditions within a topic
      • Analyzing spelling within a topic
      • Analyzing characters within a topic
    • Vacuuming a project
    • Working with templates
      • Using the template editor
        • HTML based templates
          • General settings
          • Variables
          • Script files
          • Assets
            • Editing assets
          • HTML tags
          • Hooks script
        • Word and PDF templates
          • Text layout
      • Low-level template details
        • Best practices
        • Template configuration file
        • Template inheritance
        • Code templates
        • CHM and HTML templates
          • Handle the generated topic links
          • Methods available in templates
          • Generate multiple files from a single template file
          • Template variables
          • Assets
          • HTML tags
        • Samples
          • Building a single page HTML template
      • Template specifics
        • Default HTML template: JavaScript on page change
        • GitHub wiki Markdown template
      • Migrating scripts and templates
        • Migrating scripts from V4 to V5
        • Migrating scripts from V5.0 to V5.1
        • Migrating scripts from V6 to V7
    • Usage from the command line
      • Legacy command line syntax for 5.3 and older
    • Customize default project styles
    • Scripting in HelpNDoc
      • Object pascal subset
        • Basic syntax and language elements
        • Base types
        • Object type system
        • Built-in functions
        • JSON support
      • HelpNDoc API methods
      • Using the Script Editor
    • Using the integrated web server
    • Using the AI Assistant
    • Backing up projects
    • Documentation formats specifics
      • CHM files and programming languages
        • .NET (C#) integration
        • Delphi integration
          • Older versions of Delphi
        • Java integration
        • Microsoft Access integration
        • Visual Basic integration
        • WinDev integration
      • HTML help URL parameters
      • Context sensitive HTML help
    • License key management
      • Named licenses
        • Grace period
      • Floating licenses
        • Activating the floating license server
        • Check the floating license server's status
        • Check that the floating license server is listening to incoming connections
        • Check the connection to the server from HelpNDoc
        • How to handle dead leases
        • Listen to HTTPS communication
        • Deactivating the floating license server
  • FAQ and troubleshooting
    • Error and warning messages
      • HelpNDoc shows an exception when launched
      • Project already opened by another software
      • Project is too old to open
    • Help compilers
      • What compilers of libraries do I need to install?
      • Installing the Microsoft HTML Help Compiler displays a warning message?
    • CHM help files
      • The CHM viewer indicates that the page cannot be displayed
      • CHM content is not displayed after Internet Explorer update
      • Despite modifying the navigation pane's width the CHM file is not updated
      • The search feature is not working in the CHM documentation
      • Missing files when generating a CHM file in the same directory as HTML
    • HTML help websites
      • Google Chrome shows an error when searching HTML documentation
      • The HTML help is broken when hosted by CloudFlare
      • The HTML documentation is not loading or behaving incorrectly
      • Table of contents is empty or loading in default HTML template
      • HTML documentation hosted on GitHub are broken
      • Windows reserved file names
    • PDF documentation
      • Adobe Reader won't print with "drawing error" message
    • Microsoft Word documents
      • Table of contents page numbers are wrong in Word documents
    • Qt Help
      • Modifications made to a Qt help file are not updated in assistant.exe
    • Sales and license information
      • What is HelpNDoc's update policy?
      • How much does HelpNDoc costs
      • Do you provide a discounted Educational license ?
      • I need a special license: site license or global license?
      • What kind of payment devises and currencies do you accept?
      • How can I request a written quote before ordering?
    • Miscellaneous
      • HelpNDoc download problem
      • Doc or DocX files can't be imported
      • Some panels are missing or HelpNDoc's Window is hidden
      • The table of contents is missing topics or behaving strangely