HelpStudio & Document! X 2024.2 Release Notes

Published by on

HelpStudio & Document! X 2024.2  has focussed on enhancing the search functionality that is embedded in the Browser Help output, along with a number of other quality improvements.

Feature Improvements

Web Help Search 

 

  • The build time indexing of the document has been improved to allow for:
    •  Better results when searching for phrases
    • Inclusion of code syntax and examples
    • Improvements for other character sets such as Kanji
  • The search logic in the output has been overhauled. This provides:
    •  More accurate results
    •  Full support of diacritic characters
    •  Full support for phrases – will find only exact phrase when term is enclosed by double quotes (“)
    •  Improved weighting of results
    •  Improved logic for AND / OR
    • Improved weighting algorithm with priority given to:
      •  Search results in Topic titles.
      • Entire phrases
      • Exact matches
      • Frequency
  • The presentation of Search results has been totally overhauled giving:
    •  More traditional search engine style display
    • Displays the Topic Title
    • Displays excerpt of text with highlighted terms
    • Count of occurrences of search terms
    • Improved ordering of results based upon the enhanced weighting
    • Improved support for Dark Mode
    • Improvements to search results navigation
  • When navigating to a search result the highlighting of found results in that page has been improved.:
    • Highlight Search terms check box allows highlighting of found results to be switched on/off
    • Diacritics highlighting fixed
    • Support added to highlight whole phrase results
    • Improved support for dark mode
    • Search terms applied even if page was already opened

 

Quality Improvements

Improved the Template Update process

Simplified the selection of templates with a bulk update option and fixed an issue where a failed template update would keep prompting when the application was opened.

Added support for additional datatypes for Open API schema Parameters

Displaying of Data Types has been enhanced when documenting an Open API schema

Added support for additional Tags in XML Comment File generation

Additional XML Tag Elements are now supported by the XML Comment Generation

Read-Only Error Message When Adding New Topics to Source Control in TFS

New topics can be added to a source controlled project and are automatically checked out and editable

Null Reference Exception During Command Line Build

Updated the Command Line application to handle content access.

Improved Notifications for GIT operation failures

Added additional handling for environmental or conflict based issues, notifying the user to remedy the issue with the repository

Check box for Return Values In Content Files

Correctly wired the check box against return values so it updates correctly when values are entered
Tags: , ,

Related Articles