A document library item will be included where it has been placed at generation time. It can be useful in multiple situations:

  • A piece of content needs to be repeated multiple times within the project
  • The document is managed by someone else without access to the HND project file

Note: HelpNDoc can import the following documentation formats:

  • TXT text files;
  • RTF rich text documents;
  • HTML web pages;
  • Markdown files;
  • DOC and DOCX Word documents. This might require as specific Microsoft Office Compatibility Pack: see Doc or DocX files can't be imported 

Overview of the user interface

1. Library item name

Choose a unique name for that library item.

2. Customize item

A document can either be stored within the project or linked from an external location based on the project's requirements. Choosing how it is stored can be decided individually for each item based on pros and cons for that specific item and / or overall documentation project.

Storage

Description

Pros

Cons

Include File

Item file is stored within the project archive
  • Item is always available even when the project is moved to a different location
  • Sharing project is easier as the HND project file contains the item's content
  • The item is always available to the end-user as it is stored with or within the generated documentation file
  • HND project file becomes larger with each included item
  • Replacing an item involves locating it in the library and updating it
  • Items can't be shared between multiple projects
  • Generation time is slower as the file needs to be copied / included in the generated documentation

External File

Item file is stored anywhere on the hard drive or a network location, and included at generation time. Note: The external file path can be absolute, or relative to the HND project file location
  • HND project file is smaller as only the path to the external file is stored
  • Updating the item on the hard drive or network location will update it the next time the documentation is built
  • Items can be shared between multiple projects: each project will include it when needed
  • The item is always available to the end-user as it is stored with or within the generated documentation file
  • Item location must be updated in the library when the HND project file is moved, or the item must be moved with the project
  • Sharing a project requires all external items to be shared too
  • Sharing a project might require an update of all external items' paths
  • Generation time is slower as the file needs to be copied / included in the generated documentation

3. Commands and fields

Include File

  • Insert / Replace file: Locate a file on the hard drive or a network location to 
  • Remove file from project: Remove the content of the file from the project
  • Export file: Export the content of the file to the hard drive

External File

  • File path: Absolute or relative path of the file to include at generation time

4. Preview

For included files, an icon of the library item is displayed. It is possible to drag and drop a file from a third party application such as the Windows Explorer into the preview to include it or replace the existing file.