Manage HelpNDoc projects

How to create new HelpNDoc projects

How to create new HelpNDoc projects

Step 1 There are two ways to create a new project in HelpNDoc. Click “New project” in the “Common tasks” section of the “Welcome” screen Or click the “File” menu… then “New project” Step 2 The “New Project” dialog pops-up. We can enter a title for our new project And select the project language Step 3 We can also create an initial table of contents, using the TAB and SHIFT-TAB keyboard shortcuts to quickly organize the hierarchy.

Read More →

Manage the table of contents

How to create a new topic in HelpNDoc

How to create a new topic in HelpNDoc

Step 1 There are four ways to create a new topic: Click the top half of Add topic in the Home ribbon tab to add a new topic at the bottom of your table of contents Click the lower half of Add topic and choose where the topic should be added Right-click your table of contents and select Add topic Right-click your table of contents and hover over Add topic to choose where the topic should be added This creates a new topic in your table of contents.

Read More →

How to create a new child topic in HelpNDoc

How to create a new child topic in HelpNDoc

Step 1 There are two ways to create a new child topic: Click the lower half of Add topic in the Home ribbon tab and select Add child topic Right-click your table of contents and hover your mouse on Add topic. Then, select Add child topic This creates a new child topic in your table of contents. Step 2 The newly created topic is highlighted in your table of contents and ready to be renamed.

Read More →

How to rename a topic in HelpNDoc

How to rename a topic in HelpNDoc

Step 1 There are three ways to rename a topic: Click a topic in the table of contents and select Rename in the Table of contents group of the Home ribbon tab Right-click a topic in the table of contents and select Rename Click a topic in the table of contents and press the F2 keyboard shortcut The topic’s caption is highlighted in your table of contents and ready to be renamed.

Read More →

How to move topics in HelpNDoc

How to move topics in HelpNDoc

There are three ways you can move a topic: Option 1 Click the topic that you’d like to move. This highlights that topic in your table of contents. Then, use the arrows in the table of contents section of the Home ribbon tab to move the topic. When you use the up and down arrows, the topic moves up or down in the hierarchy of your table of contents When you use the right arrow, the selected topic becomes a child topic of the topic immediately above it When you select a child topic and use the left arrow, that child moves up a level in the table of contents hierarchy Option 2 Right-click a topic in your table of contents to display the contextual menu.

Read More →

How to delete topics in HelpNDoc

How to delete topics in HelpNDoc

Note: When you delete a topic, its content is deleted as well as its children topics. However, Library items that are used by those topics and keywords that are linked to them are not deleted. There are two ways to delete a topic: Option 1 Click the topic that you’d like to delete. This highlights that topic in your table of contents. Then, click Delete in the Table of contents section of the Home ribbon tab to remove the topic.

Read More →

Maintain properties of your topics

How to select a new icon for a topic in HelpNDoc

How to select a new icon for a topic in HelpNDoc

By default, HelpNDoc assigns a question mark icon to a new topic. There are two ways you can assign a new icon: Option 1 Select the topic to which you’d like to assign a new icon. Click Topic properties in the Home ribbon tab. Then, select Topic icon. This displays a wide variety of icons. Click the one you’d like to use. Option 2 Right-click the topic to which you’d like to assign a new icon.

Read More →

How to assign topic kind in HelpNDoc

How to assign topic kind in HelpNDoc

HelpNDoc offers four kinds of topics: Normal contains text and images that you develop Empty is used as a chapter heading. No text or images are shown when you publish your documentation Show external URL provides users a link to the URL you enter Include external file allows you to incorporate content that’s currently located in a file outside your HelpNDoc project By default, a new topic is assigned ‘Normal kind.

Read More →

How to define a header for a topic in HelpNDoc

How to define a header for a topic in HelpNDoc

By default, HelpNDoc assigns the topic name as the topic header. There are three ways to update the topic header: Option 1 Select the topic for which you’d like to update the header. Click Topic properties in the Home ribbon tab to display that menu. Select Topic header. By default, the topic header is the topic name. To update it, enter the header that you’d like to use in the box labeled, “Custom text”.

Read More →

How to define a footer for a topic in HelpNDoc

How to define a footer for a topic in HelpNDoc

By default, HelpNDoc displays copyright information in footers. There are three ways to update the footer: Option 1 Select the topic for which you’d like to update the footer. Click Topic properties in the Home ribbon tab to display that menu. Select Topic footer. By default, the topic footer contains copyright information. To update it, enter the footer that you’d like to use in the box labeled, “Custom text”. Then, click Display custom text.

Read More →

How to manage your topic identifiers in HelpNDoc

How to manage your topic identifiers in HelpNDoc

When you create a new topic, HelpNDoc assigns two identifiers: Help ID is an alphanumeric code that uniquely identifies a specific topic in various documentation formats Help Context is a numeric index that uniquely identifies a specific CHM topic using the Windows API Both of these identifiers are mandatory for each topic; neither may contain a space. Note: By default, the Help ID is automatically updated when the topic caption is changed.

Read More →

Manage keywords

How to access the keywords panel

How to access the keywords panel

There are two simple ways to access the keywords panel: Option 1 Click Keywords along the side of your page. This displays your keyword panel. Option 2 Press the control key on your keyboard, and then press F5. This displays your Keyword Panel. To pin the keyword panel, click the thumbtack in the upper right-hand corner. To collapse the Keyword Panel, click the thumbtack again. Now that the keywords panel is accessible, let’s see how to create new keywords to provide organization in your help and documentation projects.

Read More →

How to create a keyword

How to create a keyword

When a user clicks keywords in the index, the topics associated with that keyword are displayed in two ways: If the keyword is associated with only one topic, that topic is displayed When the keyword is associated with multiple topics, a menu with links to the associated topics is displayed. HelpNDoc gives you four simple ways to create keywords. The steps for adding new parent keywords and child keywords are both outlined below.

Read More →

How to rename a keyword

How to rename a keyword

There are three easy ways to rename keywords in your HelpNDoc projects: Option 1 Click the keyword that you’d like to rename in your keywords Panel. This selects that keyword. Click Rename in your Home ribbon tab. This switches the keyword into “edit mode”, allowing you to update it. Enter the new name and press enter to save it. Option 2 Right-click the keyword that you’d like to rename in your Keyword Panel.

Read More →

How to delete a keyword

How to delete a keyword

If you need to delete a keyword, HelpNDoc gives you two simple ways to remove it: Option 1 Click the keyword that you’d like to remove from your keywords panel. Then, click Delete in your Home ribbon tab. This displays a message confirming that you’d like to delete the keyword and all of its children keywords. Click Yes. This deletes that keyword and its children from your keywords panel. Option 2 Right-click the keyword that you’d like to delete.

Read More →

How to define parent and child keywords

How to define parent and child keywords

You may use a simple parent-child structure or form a multi-tiered hierarchy. When you add a new keyword it is automatically classified as a parent keyword. You can make an existing keyword a child simply by moving it beneath its parent. There are two ways to define a parent-child relationship: 1. Move a child keyword when the parent is immediately above Option 1 Click the keyword that will become the child to select it.

Read More →

How to associate keywords with topics

How to associate keywords with topics

By default, when you create a keyword it is automatically associated with the topic currently displayed on your desktop. This association is indicated by the check mark next to the keyword. Create an association between a keyword and a topic To associate the keyword with additional topics, HelpNDoc gives you two easy options: Option 1 Confirm the keyword is selected in your Keyword Panel. Click the topic in your Table of Contents that you’d like to associate it with.

Read More →

How to manage the association between a keyword and topics

How to manage the association between a keyword and topics

Step 1 Select the keyword in the Keyword Panel. Then, click Associated topics in the Keywords section of the Home ribbon tab. This displays the “Manage Keyword Association” window. Step 2 Click a topic to create an association to the keyword. This displays a check mark, indicating an association between the topic and the keyword. You can create associations between a keyword and both parent- and child-level topics. To discontinue an association, click the topic to remove the check mark.

Read More →

Manage the library

How to access the library panel

How to access the library panel

Your library is always at your fingertips. If it is not displayed on your desktop, there are two simple ways to access it: Option 1 Click Library along the side of your page. This displays your Library panel. Option 2 Press the control key on your keyboard, and then press F4. This displays your Library panel. To pin the Library panel, click the thumbtack in the upper right-hand corner. To collapse the Library Panel, click the thumbtack again.

Read More →

How to add an item to the library

How to add an item to the library

Your library supports several multimedia file formats, including: Images and photographs (e.g. PNG, JPEG) Movies (e.g. MOV, MPEG4, AVI) Documents (e.g. DOC, DOCX, RTF, TXT) Raw HTML code Variables which are placeholders for simple textual data Snippets which are placeholders for complex formatted texts There are two steps to add an item to your library. Both are outlined below. Step 1 You have two options to complete the first step:

Read More →

How to rename a library item

How to rename a library item

There are four easy ways to rename a library item: Option 1 Select the item in your library panel and then click Rename in the Library section of the Home ribbon tab. This switches the item name into “edit mode” allowing you to update it. Enter the new name and press enter to save it. Note: Some items such as system variables can’t be renamed. Therefore, if you select a system variable in the library panel, Rename remains gray, prohibiting you from clicking it.

Read More →

How to delete a library item

How to delete a library item

When you need to remove a library item, there are two easy ways to delete it: Option 1 Select the item in your library panel and then click Delete in the Library section of the Home ribbon tab. This displays a window, confirming that you’d like to permanently delete the item. Click Yes. This removes the item from your library panel. Option 2 Right-click the item in your library panel that you’d like to remove.

Read More →

How to update a library item

How to update a library item

To update an item, you have three simple options. Option 1 Select the item in your library panel and then click Item properties in the Home ribbon tab. This opens the window that displays the properties you had defined for that item. Enter your update and click OK to save your change. Option 2 Right-click the item in your library panel that you’d like to update. This displays a popup menu.

Read More →

How to insert a library item into a topic

How to insert a library item into a topic

Note: When you insert a library item into your topics, you are actually inserting a pointer to that item in your library. As a result, when you update an item in the library, all occurrences of that item automatically reflect that update. You do not need to manually update each occurrence. You have three easy options when inserting an item from your library into your documentation: Option 1 Place your cursor in the topic editor where you’d like the library item to be inserted.

Read More →

How to create an image map

How to create an image map

Note: Image maps are only compatible with the CHM and HTML documentation formats as well as some ePub readers. Step 1: Access image map editor You have two options to complete the first step: Option 1 Click Add item in the Home ribbon tab. This displays a menu. Select Add image map. Option 2 Right-click your library panel to display a menu. Select Add item. This displays a menu. Select Add image map.

Read More →

Generate documentation

How to publish your documentation

How to publish your documentation

There are two ways to generate your documentation. You can use ‘Quick generate’ to publish one output at a time. Or, you can use your build list to publish documentation in one or many formats simultaneously. Option 1: Quick generate Click the lower half of Generate help in the Home ribbon tab to display a menu of the default publishing options offered by HelpNDoc. Click the one that you’d like to use to generate your documentation in that format.

Read More →

How to create a new documentation output to be published

How to create a new documentation output to be published

There are two simple steps for creating a new publishing output. Step 1 Click the top half of Generate help in the Home ribbon tab. This displays the Generate Documentation window. Each output and its format is listed along the left-hand side in your build list. The outputs with check marks will be published the next time you generate the documentation from your build list. Step 2 In this next step you’ll select the format for your new output.

Read More →

How to rename a publishing output in HelpNDoc

How to rename a publishing output in HelpNDoc

There are three easy steps for renaming outputs. Step 1 Click the top half of Generate help in the Home ribbon tab. This displays the Generate Documentation window. The names of your outputs are listed along the left-hand side in your build list. These names are displayed when you generate your documentation. Step 2 Next, you’ll select the output that you’d like to rename. There are three ways to do this: Option 1 Click the name of the output that you’d like to update.

Read More →

How to delete a build in HelpNDoc

How to delete a build in HelpNDoc

There are two simple steps for deleting an obsolete output. Step 1 Click the top half of Generate help in the Home ribbon tab. This displays the Generate Documentation window. All of your outputs are listed along the left-hand side in your build list. Step 2 Next, you’ll select the output that you’d like to delete. There are two ways to do this: Option 1 Click the build that you’d like to remove.

Read More →

How to reorder your publishing outputs in HelpNDoc

How to reorder your publishing outputs in HelpNDoc

There are two steps for reordering your outputs. Step 1 Click the top half of Generate help in the Home ribbon tab. This displays the Generate Documentation window. Your outputs are listed along the left-hand side in your build list. Step 2 The order in which your outputs are listed in the build list is the order in which they will be created when you generate your documentation using your build list.

Read More →

How to enable your publishing outputs in HelpNDoc

How to enable your publishing outputs in HelpNDoc

There are two steps to managing the status of your builds. Step 1 Click the top half of Generate help in the Home ribbon tab. This displays the Generate Documentation window. Your builds are listed along the left-hand side in your build list. Step 2 The check marks next to your builds indicates which builds would be published the next time you generate documentation using your build list. If a build does not have a check mark, it would not be generated.

Read More →

How to define build settings in HelpNDoc

How to define build settings in HelpNDoc

To access the settings HelpNDoc uses to publish documentation, click the top half of Generate help in the Home ribbon tab. This displays the Generate Documentation window. Your builds are listed along the left-hand side in your build list. To view the settings for a build, click its name. This highlights that build and displays its current output file and template. The steps for maintaining the output file and template as well as the settings for the output are outlined below.

Read More →

How to localize your documentation output

How to localize your documentation output

Step 1 Click the top half of Generate help in the Home ribbon tab. Step 2 This displays your build list along the left-hand side of the ‘Generate Documentation’ window. Some standard build kinds allow you the option of translating some of the hard-coded titles: HTML Word PDF ePub Kindle Click the build that you’d like to customize in the build list. If the template settings tab is not displayed, click Customize.

Read More →

How to change the initial expand or collapse status of the HTML table of contents

How to change the initial expand or collapse status of the HTML table of contents

Step 1: Define HTML setting Click the top half of Generate help in the Home ribbon tab. This displays the ‘Generate Documentation’ window. Select the HTML build to modify in the build list on the left-hand side. If the Template settings tab is not displayed, click Customize to view it. Click the ‘Expand table of contents tree’ box to remove the check mark. This will generate your documentation in HTML format with a collapsed table of contents.

Read More →

How to add a cover image to ePub and Kindle eBooks

How to add a cover image to ePub and Kindle eBooks

Step 1 Place the cover picture you’d like to use in your library. It’s recommended that you use a .jpg or .png that is either 600x800 or 300x400 pixels. See: How to add an item to the library Step 2 Click the top half of the Generate help button in the Home ribbon tab. This displays the ‘Generate documentation’ window. Step 3 Select the ePub or Mobi/Kindle build you’d like to modify in the build list.

Read More →

How to start each topic on a new page when publishing Word and PDF documents

How to start each topic on a new page when publishing Word and PDF documents

Step 1: Create a new Word or PDF Template Click the Templates Editor button in the Templates section of the Tools ribbon tab. This displays the ‘Edit Report Template’ window. Then Create a new Word or PDF template so that you can customize its settings. Note: The following steps use a sample Word Template to demonstrate but the process is the same when defining PDF Templates. Step 2: Define settings for Topics Titles in your Template Click the Topic titles group in the ‘Edit template…’ section.

Read More →

How to generate an encrypted password-protected PDF document

How to generate an encrypted password-protected PDF document

After you’ve completed your documentation, you can activate encryption and generate a password-protected PDF Document in three easy steps: Step 1: Generate help Click the top half of the Generate help button in the Home ribbon tab. Step 2: Select a PDF build This displays the ‘Generate Documentation’ window. The builds created for this project are listed along the left-hand side in your build list. Click a PDF build to access its settings.

Read More →

How to download and install Microsoft's HTML Help Workshop compiler

How to download and install Microsoft’s HTML Help Workshop compiler

Step 1 - Download the installer In HelpNDoc, click File then select Options. This displays the ‘HelpNDoc Options’ window. Click Download to the right of ‘Microsoft HTML Help Workshop’ path to download the installation software from Microsoft’s web-site. Alternatively, it can be downloaded from: Microsoft HTML Help Workshop This will download the htmlhelp.exe software installer. Step 2 - Install Microsoft HTML Help Workshop Run the htmlhelp.exe software you’ve downloaded.

Read More →

How to download and install Amazon's KindleGen software

How to download and install Amazon’s KindleGen software

Step 1 - Download the installer In HelpNDoc, click File then select Options. This displays the ‘HelpNDoc Options’ window. Click Download to the right of the ‘Amazon KindleGen’ path to download the installation software from Amazon’s web-site. Alternatively, it can be downloaded from: kindlegen_win32_v2_9.zip Step 2 - Unzip the compiler Using your favorite compression software, unzip the newly downloaded KindleGen to a location of your choice. Step 3 - Complete the setup Return to the ‘HelpNDoc Options’ window.

Read More →

Use the live spell checker

How to check the spelling in HelpNDoc

How to check the spelling in HelpNDoc

As you enter content in your editor, HelpNDoc highlights potential spelling errors with a red underline. HelpNDoc also checks spelling as you enter new topics in your table of contents, create new keywords, post new items to your library… Potential spelling errors are underlined red in these features as well. HelpNDoc allows you to correct any spelling error on your own. Or you can also right-click the underlined word to display a popup menu that gives you three options:

Read More →

How to activate and deactivate a dictionary in HelpNDoc

How to activate and deactivate a dictionary in HelpNDoc

The dictionaries that are currently being used by the spell checker for your project are listed in the lower left-hand corner of your page. There are two ways to activate and deactivate dictionaries. Options 1 Click the downward arrow to the right of the currently activated dictionaries, which are displayed in the lower left-hand corner of your page. This displays a menu of dictionaries that you may use in your projects.

Read More →

How to install a new dictionary in HelpNDoc

How to install a new dictionary in HelpNDoc

Step 1 The currently activated dictionaries are displayed in the lower left-hand corner of your page. To install a new dictionary, click the downward arrow to the right of these dictionaries. This displays a popup menu of dictionaries that are currently available. Step 2 Click Install more dictionaries at the bottom of this menu. This displays a window that helps you download open source dictionaries from the OpenOffice.org web-site and install them in HelpNDoc.

Read More →

How to maintain your spell check settings in HelpNDoc

How to maintain your spell check settings in HelpNDoc

Step 1 Click the change spelling options in the lower left-hand corner of HelpNDoc’s main window. Step 2 This displays your spell check settings. General options Select the options that you’d like to apply when HelpNDoc checks spelling. This displays a check mark in the box, indicating that the condition is active. To deactivate a condition, click the check mark to remove it. Edit custom dictionary Click Edit to view, add, update, and remove words in your custom dictionary.

Read More →

How to insert anchors

How to insert anchors

Step 1 Place your cursor in the text editor where you’d like to insert the anchor. You can click a word or place your cursor immediately before it. Or, you can highlight text. The anchor will be placed immediately above this location. Step 2 Click Insert / Remove anchor in the Links section of the Insert ribbon tab. This displays the “Insert an anchor” window. Step 3 After you assign a name to the anchor, click OK.

Read More →

How to create and update hyperlinks

How to create and update hyperlinks

It is easy to take full advantage of this simple yet powerful feature. HelpNDoc gives you tremendous flexibility in defining four types of hyperlinks: Specific topics links readers to a specific topic of your documentation Navigation links readers to topics relative to the current topic Internet/E-mail displays a web page or creates an e-mail message File displays or downloads a document There are two ways to begin: 1. Highlight displayed text You can enter and then highlight the word or phrase that you’d like to use in the link.

Read More →

How to define hyperlinks to specific topics

How to define hyperlinks to specific topics

Using the “Hyperlink” button in the “Insert” ribbon tab, you can access the hyperlink dialog. Click Specific topic in the menu along the left-hand side of the window. This displays your table of contents. You can expand and collapse topics, and scroll up and down to view your entire table of contents. Click the topic that you’d like to link to. If you selected a topic that contains anchors, those anchors are displayed in “Anchor to link to.

Read More →

How to define hyperlinks to relative topics

How to define hyperlinks to relative topics

Using the “Hyperlink” button in the “Insert” ribbon tab, you can access the hyperlink dialog. Click Navigation in the menu along the left-hand side of the window. This displays six relative locations to which readers will be taken when they click on the hyperlink: Default topic as defined in Project options on your Home ribbon tab First topic in your table of contents Last topic in your table of contents Parent topic relative to the topic currently being viewed Previous topic that had been visited immediately prior to clicking the hyperlink Next topic in your table of contents When Sibling topic only is checked, links will go to the previous or subsequent topics of the same hierarchal level as the ones currently being viewed.

Read More →

How to define hyperlinks to web pages and e-mail

How to define hyperlinks to web pages and e-mail

Using the “Hyperlink” button in the “Insert” ribbon tab, you can access the hyperlink dialog. Click Internet/E-mail in menu along the left-hand side of your window. This displays two options: Internet link: Enter or paste the URL for the web page. To display the web page in a separate window, click ‘Open link in a new window.’ E-mail address: Enter the e-mail address to which the message will be sent and the subject heading of the message.

Read More →

How to define hyperlinks to your files

How to define hyperlinks to your files

Using the “Hyperlink” button in the “Insert” ribbon tab, you can access the hyperlink dialog. Click File in menu along the left-hand side of your window. Select the file to link to by clicking the browse button to the far right of ‘File path’ and navigate to the document. After you select it, the document name and path are displayed. In order for readers to access the file, you must place it the correct folder when you deploy your documentation:

Read More →

Using the report template editor

How to create a new report template

How to create a new report template

To begin, click Template Editor in the Tools ribbon tab. This displays the “Edit report template” window. Click the green plus button to select the type of template that you’d like to create. This displays the “New template name” window. Enter a unique name for the new template and click OK. This returns you to the “Edit report template” window where the name of the new template is selected in the Template menu.

Read More →

How to duplicate an existing report template

How to duplicate an existing report template

To begin, click the Template Editor button in the Tools ribbon tab. This displays the “Edit report template” window. Click the downward arrow to select the template that you’d like to copy. Then, click the duplicate template button to duplicate that template. This displays the “Duplicate template” window. Select the type of template that you’d like to create (i.e. PDF or Word). Enter the name of the new template and click Duplicate.

Read More →

How to rename a template

How to rename a template

To begin, click the Template Editor button in the Tools ribbon tab. This displays the “Edit report template” window. Click the downward arrow for the Template menu to select the template that you’d like to rename. Then, click the rename button to the right. This displays the “New template name” window. Enter the new name for the template and click OK. This returns you to the “Edit report template” window.

Read More →

How to delete a template

How to delete a template

To begin, click the Template Editor button in the Tools ribbon tab. This displays the “Edit report template” window. Click the downward arrow for the Template menu to select the template that you’d like to delete. Then, click the Delete button to the right. This displays a warning message. Click Yes. This displays a confirmation message that the template was deleted. Click OK to return to the “Edit report template” window.

Read More →

How to update your templates

How to update your templates

To begin, click the Template Editor button in the Tools ribbon tab. This displays the “Edit report template” window. Click the downward arrow to select the template that you’d like to update. Then, use the menu along the left-hand side to define properties: Page settings Select paper size, orientation of the page, margins, and the location of headers and footers. Cover page Click Edit cover page to access the “Content Editor” window.

Read More →

Using the project analyzer

How to analyze your project

How to analyze your project

To access the Project Analyzer, click Analyze Project in the Project section on the Home ribbon tab. Then click Analyze in the lower left-hand corner to view project stats and other helpful information on four tabs. 1. General information This tab displays various information on your project and key statistics such as the number of: Topics Paragraphs Characters Hyperlinks Library items by type 2. Charts This tab provides a visual representation of the organizational structure of your project.

Read More →

How to analyze hyperlinks

How to analyze hyperlinks

To access the Project Analyzer, click Analyze Project in the Project section on the Home ribbon tab. Then click Analyze in the lower left-hand corner to view project stats and other helpful information. You can then click the Hyperlinks to review hyperlinks created in the current project. Hyperlink properties are displayed in multiple columns: Kind displays the type of the hyperlink Caption contains the words that readers click to activate the hyperlink Action displays the location readers are taken to when they click the hyperlink Extra provides supplemental information, as appropriate (e.

Read More →

How to analyze the items in your library

How to analyze the items in your library

To access the Project Analyzer, click Analyze Project in the Project section on the Home ribbon tab. Then click Analyze in the lower left-hand corner to view project stats and other helpful information. You can then click the Library items tab to review library items in the current project. Each library item, its properties, and its usage are displayed in four columns: Kind displays the type of library item Caption is the name assigned to the item in the library Source refers to the way in which the library item is rendered.

Read More →

Conditional content generation

How to manage build tags

How to manage build tags

Conditional content generation can be helpful in many ways, here are two: Multiple outputs: If you publish documentation in several formats, you can generate conditional content to tailor text that is specific to each format. For example, instructions for the use of electronic help are different than scrolling PDF or reading hardcopy. Multiple versions: Rather than maintaining multiple versions of a project to support multiple versions of your product, you can instead maintain one project and use conditional output to generate documentation that is tailored to each version.

Read More →

How to maintain tags associated with output builds

How to maintain tags associated with output builds

Click the top half of the Generate help button in the Project group of the Home ribbon tab to display the ‘Generate Documentation’ window. Select the build in the list for which you’d like to view and update tags. If details about the build are not displayed, click Customize. Click the Included tags tab to view tags associated with that specific build output. Associated tags are checked and the standard tag associated with the build format is grayed out to indicate that it will always be used for that build.

Read More →

How to setup conditional topic generation

How to setup conditional topic generation

To define conditional generation for a specific topic, you’ll need to assign build tags to that specific topics. HelpNDoc provides default build tags for documentation formats (CHM, HTML, Word, PDF, ePub, Kindle) and you can create your own build tags if needed. Step 1: Access the build tag menu The “Included in builds” menu is where tags associated with a topic are defined. There are two ways to access this menu.

Read More →

How to setup conditional content generation

How to setup conditional content generation

Defining these rules is simple; you don’t need to be a programmer. HelpNDoc provides a user-friendly way to define and insert the rules. The rules contain ‘If,’ ‘Else,’ and ‘End’ logic statements that outline the conditions for including specific sections in selected builds. HelpNDoc uses these instructions when generating documentation. To begin, place your cursor at the location within the topic where you’d like to insert the rule. Then, click Insert/Edit condition in the Items section of the Insert ribbon tab.

Read More →

Use the script editor

How to use the script editor

How to use the script editor

To access the script editor, click Script Editor on HelpNDoc’s Tools ribbon tab. This opens the ‘Script authoring and execution’ window. You have two options: Enter a new script manually, or Load an existing script by clicking Load Script in the upper left-hand corner of the window to import the script. HelpNDoc’ API offers a variety of functions and procedures to help you automate tasks. See a list of available API methods.

Read More →

Manage styles

How to customize the default styles for new projects

How to customize the default styles for new projects

Step 1: Customize your styles Once a project is opened in HelpNDoc, click the arrow in the lower-right hand corner of the Styles section of the Write ribbon tab. This displays your Styles settings window where you can customize existing styles and create new ones. Step 2: Export Styles Once you’re done customizing the styles, click the Export button to save them to an external file. This opens a window that allows you to select the location and name of the file.

Read More →

How to create a style to display a note or a warning message

How to create a style to display a note or a warning message

Step 1: Add a new Style Click the arrow in the lower-right hand corner of the Styles section of the Write ribbon tab. This displays your Styles settings window. Click Add in the lower left-hand corner. Select Add Custom Style. Step 2: Assign name Enter the name of the new style so that it can easily spotted in the list. For example: “Notes”. Step 3: Define Paragraph Settings Click Edit to the right of Paragraph to opens the ‘Paragraph’ Settings window.

Read More →

Image Editor

How to open HelpNDoc's image editor

How to open HelpNDoc’s image editor

Step 1 To open the image editor, you first need to access the image library item’s properties dialog. There are multiple ways to achieve this: From the topic editor: Double click on the image in the topic editor From the library panel: Double click on the image library item Right-click on the image library item; then click “Item properties” Select the image library item; then from the “Home” ribbon tab, in the “Library” group, click “Item properties” This displays the library item’s properties dialog.

Read More →

Format conversion

How to convert a HLP (WinHelp) help file to a CHM (HTML Help) help file

How to convert a HLP (WinHelp) help file to a CHM (HTML Help) help file

Step 1 Click Import on the File ribbon tab. This displays the ‘Import files and folders’ window. Step 2 To navigate to the file that you’d like to import, click the button to the far right. This displays a window that allows you to locate the file. Select the file and then click Open. This displays the path to that file on your page. Then, click Import. This imports the selected file into your project.

Read More →

How to convert a CHM help file to a PDF document

How to convert a CHM help file to a PDF document

Step 1 Click Import on the File ribbon tab. This displays the ‘Import files and folders’ window. Step 2 To navigate to the file that you’d like to import, click the button to the far right. This displays a window that allows you to locate the file. Select the file and then click Open. This displays the path to that file on your page. Then, click Import. This imports the selected file into your project.

Read More →

How to convert a CHM help file to an ePub or Kindle eBook

How to convert a CHM help file to an ePub or Kindle eBook

Step 1 Click Import on the File Home ribbon tab. This displays the ‘Import files and folders’ window. Step 2 To navigate to the file that you’d like to import, click the button to the far right. This displays a window that allows you to locate the file. Select the file and then click Open. This displays the path to that file on your page. Then, click Import. This imports the selected file into your project.

Read More →

How to convert a Word DocX file to an ePub or Kindle eBook

How to convert a Word DocX file to an ePub or Kindle eBook

Step 1 Click Import on the File Home ribbon tab. This displays the ‘Import files and folders’ window. Step 2 To navigate to the document that you’d like to import, click the button to the far right. This displays a window that allows you to locate the document. Select the document and then click Open. This displays the path to that document on your page. Then, click Import. This imports the selected document into your project.

Read More →

How to convert an ePub eBook to a PDF or Word DocX document

How to convert an ePub eBook to a PDF or Word DocX document

Step 1 Click Import on the File menu. This displays the ‘Import files and folders’ window. Step 2 To navigate to the file that you’d like to import, click the button to the far right. This displays a window that allows you to locate the document. Select the ePub file and then click Open. This displays the path to that document on your page. Then, click Import. This imports the selected ePub eBook into your project.

Read More →

License management

How to activate a named license of HelpNDoc

How to activate a named license of HelpNDoc

There are two ways of activating HelpNDoc: Online Activation is the fastest and easiest way of activating HelpNDoc. You enter the product key, and HelpNDoc will contact the server to validate that key. Done. Offline Activation can be used for computers not connected to the Internet. This requires additional back and forth between you and the support team. Online Activation Note: Make sure that the following domains are accessible from your computer (e.

Read More →

How to deactivate a named license of HelpNDoc

How to deactivate a named license of HelpNDoc

Warning: There is a limit of 5 deactivations allowed per license key. This number can be raised upon request: contact the support team with your order ID if you need to raise that limit. If you need to frequently move your license, you should consider upgrading to a floating license. Launch HelpNDoc on the computer where it needs to be deactivated, and click the “File” menu. Click the “Help” tab to access license details.

Read More →

How to install and activate the floating license server

How to install and activate the floating license server

Warning: The floating license server needs to be installed on a real physical Windows machine. Installing the floating license server on a virtual machine will frequently trigger the anti-piracy algorithm as virtual hardware often changes, thus preventing the use of HelpNDoc. Note: Make sure that the following domains are accessible from your server (e.g. white-listed on your Firewall / Proxy) for both HTTP and HTTPS protocols: wyday.com ; limelm.com ; ibe-software.

Read More →

How to connect HelpNDoc to the floating license server

How to connect HelpNDoc to the floating license server

Warning: The floating license server needs to be properly installed and activated. It must also be accessible on the network from the computer where the floating license of HelpNDoc will be used. Log in using your IBE Software / HelpNDoc customer credentials to retrieve the full version of your software as well as your personal license key. Your customer’s section credentials where sent to you when your order was completed.

Read More →