Help+Manual News

Archive for category Scripting

Premium Pack 3.50 Maintenance Update

This update adds some significant improvements to Google Analytics configuration and handling to the V3 WebHelp skins. It also includes some other small improvements and fixes in the V3 WebHelp skins and the Toolbox utility.

How to get the Premium Pack update

You can download and install the updated version with the credentials you received when you purchased. If you no longer have this please contact support@ec-software.com and we will help you out. See the Premium Pack product page for more details on Premium Pack 3 and visit our online store to purchase if you do not yet have it.

V3 WebHelp Skins 

  • Google Analytics updated from the older gat.js system to the new analytics.js system. This should be more reliable. In addition to this you can now configure inclusion of the WebHelp path, named trackers and the titles of the search and keyword index events in your Google Analytics console. See Google Analytics in the V3 WebHelp skins chapter.
  • No Server Mode: Demo links in the header menus failed in some browsers because they used the shorthand // protocol instead of http:// or https://. Browsers have become stricter about resolving links using the shorthand protocol reference since this feature was created.
  • No Server Mode: Anchor links in the TOC and keyword index failed as an unintended result of another change in recent updates.
  • Permalink tool: The “:” colon character for the port reference was included even when the port was the standard port 80 and was not referenced. This was also caused by a change in browser behavior.
  • Smartphone mode: Tables tagged with the phone CSS class were hidden in phone mode because of changes in HM HTML output for tables. This is related to CSS for the X-Tables function that was then applied to other tables.
  • X-Tables function: Expanding rows lacked borders in some X-Tables in phone mode. This was also related to changes in Help+Manual HTML output for tables.

Toolbox utility

  • Baggage Files — Add File: After adding a Baggage File the column headers of the Baggage Files list were sometimes updated incorrectly.
  • Baggage Files — Export File: On some systems the prompt to save the baggage file could appear multiple times when exporting a baggage file.

No Comments

Premium Pack 3.49 Maintenance Update

We have just released a minor update of the Premium Pack with the improvements and fixes listed below.

How to Get the Premium Pack Update:

You can download and install the updated version with the credentials you received when you purchased. If you no longer have this please contact support@ec-software.com and we will help you out. See the Premium Pack product page for more details on Premium Pack 3 and visit our online store to purchase if you do not yet have it.

V3 Skins (WebHelp and eWriter versions)

  • Search highlighting: When the topic already containing search highlighting was selected in the search results after a new search the original highlighting was not removed.
  • Google Analytics: Occasionally it was possible for the first topic visited to be tracked twice.
  • Google Analytics: Ghostery and other similarly aggressive tracking blockers will no longer cause a critical error in WebHelp. These blockers simply kill the tracking function within the Google script instead of actually blocking the outgoing tracking calls, and this disruption of the script needs to be caught so that it does not terminate all other scripts on the page as well.
  • Image toggles: In response to many requests, image toggles are now closed by clicking outside the image in desktop mode. Tablet and phone modes remain unchanged.
  • Search results: Breadcrumb trail was not displayed in the header of a topic opened from search results (side-effect of a previous search update).
  • Anchor links: Anchor links sometimes did not scroll to the target anchor on internal topic links (side-effect of previous search update).
  • TOC: If the last item in the sibling chapter before the current chapter was a sub-chapter clicking the Top button would highlight that sub-chapter instead of the actual parent chapter.
  • Android devices: Small script error in some pages corrected. This probably had no effect on performance and only showed up as a JS console message.
  • EWriter skins: Removed Android and Google Analytics code that didn’t do anything.

Toolbox utility

  • Open new project: The current project will now only be closed if you actually open another project. If you cancel, the current project remains open.
  • Save Project button: The save project button now turns green when active for better visibility.

No Comments

Premium Pack 3.47 Maintenance Update

We are happy to announce the release of version 3.47 of the Help+Manual Premium Pack add-on. This is a minor maintenance update. It includes fixes for the issues described below in the V3 skins and the Toolbox utility. All other skins remain unchanged.

How to Get the Premium Pack Update:

You can download and install the updated version with the credentials you received when you purchased. If you no longer have this please contact support@ec-software.com and we will help you out. See the Premium Pack product page for more details on Premium Pack 3 and visit our online store to purchase.

V3 WebHelp and eWriter Skins

  • Anchors with keywords: Selecting anchors with keywords in the keyword index caused a JavaScript error and did not open a toggle associated with the anchor. This was a side-effect of the Google Analytics query feature added in 3.46.
  • Non-server mode: The optional q=search+term addition to the URL for Google Analytics for search and keyword index clicks added in 3.46 is now automatically disabled when V3 WebHelp is accessed without a web server. This caused errors in non-server mode and cannot be used there anyway.
  • Non-server mode: In some cases the use of a file name other than index.html for the main WebHelp file caused errors when viewing V3 WebHelp without a web server. This has been corrected, but use of index.html is still strongly recommended.
  • Search highlighting: In some configurations search terms were not correctly highlighted in the found topic pages.
  • Popups: Popups can now also be closed with the ESC key.
  • Popups: The title font from the popup title bar is no longer applied to the entire popup (the main font from the project is used).
  • Popups: Automatic positioning and sizing of popups have been improved.
  • Port reference in permalinks: The port reference is now included in permalinks if the web server is not running on the standard port 80.

Toolbox Utility

  • Editing warnings: Additional checks and warnings have been implemented to help prevent simultaneous editing of skins and projects in Help+Manual and Toolbox.
  • Non-active options: The program would exit if the user tried to activate a non-active option without first setting a value for the option (e.g. in HTML Options or Project Options).
  • Add Build Option: The Add Build Option tool in the Edit menu was not active in projects that did not yet have any build options defined.
  • Delete user-defined variable: Deleting the last user-defined variable in a skin or project did not refresh the variables list and the deleted variable was still displayed.

No Comments

Premium Pack 3.46 Maintenance update

Version 3.46 of the Help+Manual Premium Pack add-on is a general maintenance update including fixes for minor issues and some fine-tuning improvements.

How to Get the Premium Pack Update:

You can download and install the updated version with the credentials you received when you purchased. If you no longer have this please contact support@ec-software.com and we will help you out. See the Premium Pack product page for more details on Premium Pack 3 and visit our online store to purchase.

Toolbox utility

  • The Normalize Styles tool failed to identify some styles as paragraph styles and incorrectly reported that the style could not be found. The affected styles were styles based on other styles without explicit paragraph attributes of their own.
  • Some HM projects converted from Help+Manual 4 would cause Toolbox to crash and close when they were opened.
  • The Add/Remove Topic ID Prefixes function failed without completing on some projects with an unusual combination of settings.
  • The Rename Variable function didn’t update the display of the new variable name in some projects.

V3 WebHelp Skins

  • In the layout tables function the style name for identifying layout tables has been changed from layout-table to layout_table. This was necessary because you need to define a project style for this and Help+Manual no longer permits the definition of style names with dashes in the project stylesheet. Old projects using the hyphenated style name will still work; you just can’t create new styles with hyphens. The tap images function is not affected because the style for that does not need to be defined in Help+Manual.
  • Focus is now automatically set to the search input field in the Search pane whenever it is displayed.
  • User-defined menus in the page header would sometimes extend beyond the edge of the page.
  • If you are using Google Analytics, topic pages opened from search results or the keyword index will now include the search text or index keyword in the tracking reference. For example, if the user searched for red widgets or used the red widgets index keyword and clicked on the Introduction topic the tracking reference will be introduction.html?q=red+widgets (?q= is the standard reference for search terms in GA). You can turn this off with the new URL_QTRACKER configuration variable.
  • If you are using a non-standard port (anything except port 80) for your web server the permalink function will now include the port reference in the permalink to prevent the URL from being invalid.

V3 eWriter Skins

  • Focus is now automatically set to the search input field in the Search pane whenever it is displayed.
  • User-defined menus in the page header would sometimes extend beyond the edge of the page.

V2 Webhelp/eWriter skins

  • Focus is now automatically set to the search input field in the Search pane whenever it is displayed.
  • The Open topic in a new tab function displayed an incorrect message that the topic is already open in a new tab on some touchscreen Windows devices (MS Surface and similar).

No Comments

New share buttons on our news blog

Today we implemented the social media plugin Shariff, which enables website users to share their favorite content without compromising their privacy.

Facebook, Google+ and Twitter supply official sharing code snippets. These original share buttons automatically transmit data of your visitors to the social network sites as soon as they visit your website. Visitors do not even need to click on a share button for this and therefore have no choice, if they want their data to be sent.

The German computer magazine CT has developed Shariff (/ˈʃɛɹɪf/), a social media plugin that fulfills the strict data protection laws in Germany and the European Union.

For more information about the Shariff project check out the original GitHub project page.

These social media buttons below are for your convenience – a single click will share this post to your favorite social media site. But as long as you don’t click any of these buttons, they won’t leak visitor information to 3rd party sites. In other words: Facebook has no idea that you are currently viewing this page. If we used the regular Facebook share button, they would know.

Enjoy your privacy while reading this blog!

No Comments

Premium Pack 3.42/3.43 Maintenance Update

Versions 3.42/3.43 of the Help+Manual Premium Pack add-on is primarily a maintenance update. It is recommended for all Premium Pack users because it corrects several small but potentially annoying issues.

How to Get the Premium Pack Update:

You can download and install the updated version with the credentials you received when you purchased. If you no longer have this please contact support@ec-software.com and we will help you out. See the Premium Pack product page for more details on Premium Pack 3 and visit our online store to purchase.

3.43 Additional Corrections

[showhide type=”updated” more_text=”Click for details” less_text=”Click to hide”]

  • Incorrect comma-separated skip words in search options (Skins and Toolbox)
    Due to an old bug in Help+Manual itself, some skins contained comma-separated excluded words in the search settings. The WebHelp indexer ignored these skip words. This has been corrected to space separated in all skins. Toolbox will now automatically check for and correct this setting when any skin or Help+Manual project is opened.
  • Popup help window was exclusive (Toolbox)
    An error in 3.42 made the popup help window for settings exclusive so that you needed to close it to move to another setting.
  • Editor not found check (Toolbox)
    Toolbox now checks whether your selected editors for code files and graphics have become unavailable before using them.
  • Configuration variable validity checking (Toolbox)
    The performance of the validity checks for non Premium Pack settings and non-configured settings has been improved.
  • WebHelp templates in CHM skins (V2 CHM skins)
    The unnecessary WebHelp templates have been disabled in the CHM skins so that they can no longer be accidentally selected in Toolbox.

[/showhide]

V3 Skins Maintenance Update

[showhide type=”fixes” more_text=”Click for details” less_text=”Click to hide”]

  • Add/Remove Topic ID Prefixes function (Toolbox)
    In some cases, the Add/Remove Topic ID Prefixes function would hang and fail to complete, particularly with older projects. This has been corrected. The function now also aborts with a warning if a topic containing invalid XML code is encountered and checks whether duplicate topic IDs would be created when removing topic ID prefixes.
  • Configuration help window too far on top (Toolbox)
    The popup help window for variable configuration etc. was displayed on top of all programs on the Windows screen. It is now only on top of Toolbox itself.
  • Variables to adjust navigation tab positions (V3 skins)
    The V3 skins now have new variables in the TOC, Index and Search section which allow you to fine-adjust the vertical position of the navigation tabs. This can be necessary if you change the base font of your project, which can change the physical size of the relative rems units used in the layout.
  • Bug in Edge browser when viewing WebHelp without a web server (V3 WebHelp skins)
    The V3 WebHelp skins allow you to view WebHelp locally, without a web server. This was not possible in the new Microsoft Edge browser in Windows 10 due to a bug in Edge. A workaround has now been added to deal with this bug.
  • Scrolling to anchors (V3 skins)
    The scroll position of an external link targeting an anchor could be wrong if the width of the navigation pane had been previously changed by the user, or if the help window was narrow enough so that the navigation pane overlaps the topic pane. Scrolling now waits for completion of topic positioning.
  • Multiple clicks on keyword index entries and search results (V3 skins)
    A second click on a keyword index or search results topic link caused the breadcrumb trail to change to >No TOC entry for this topic<. This was a side-effect of another recent correction.
  • Multiple clicks on search results – visual side-effects (V3 skins)
    In some cases, multiple clicks on the same search results topic link could make part of the breadcrumb navigation to become progressively more transparent and less legible. Another side effect of this was that it was sometimes necessary to click twice on a search result to display highlights on the found search terms in the topic.
  • Overlapping TOC scrollbar (V3 skins)
    In the EWriter skins and in the WebHelp skins when displayed in Internet Explorer the vertical scrollbar in the table of contents and the keyword index panes sometimes overlapped its border slightly at the top and bottom.
  • JavaScript warning in search results (V3 skins)
    In some configurations it was possible for the warning text that JavaScript must be on to view the help to be displayed in the context excerpt text for topics in the search results.
  • Opening toggles for search results (CHM skins)
    A change in Windows stopped toggles on the page from opening to show the highlighted search items in CHM files when jumping to a topic from the CHM search results.

[/showhide]

Extended support for the full version of the Zoom web search indexer

[showhide type=”zoomsupport” more_text=”Click for details” less_text=”Click to hide”]If you are using the full version of the Zoom web indexer from Wrensoft instead of the integrated version included with Help+Manual you can now use the advanced features listed below with both the V3 skins and the V2 WebHelp skins. In addition to this the layout of the search pages in all skins has been reworked and improved.

With the exception of thumbnail images these features are also supported in Help+Manual’s standard skins, but just “as is”. They have now been explicitly integrated in the layout of the V2 and V3 WebHelp skins, where some of them did not appear correctly before because of the customized layouts.

  • Thumbnail images
    You can associate images with individual topics to be displayed as a thumbnail next to the topic listing in the search results. This needs to be configured in your project to associate images with your topics. See the V3 WebHelp skins and the V2 WebHelp skins topics for instructions.
  • Autocomplete
    The full version of Zoom features an autocomplete feature that shows a list of terms included in the help as the user is typing in the search box.
  • Categories
    You can assign categories to your topics and search will then allow you to filter your search results by these categories.
  • Date range search
    Restrict the search results to topics with dates falling within a specific range (desktop browsers only).
  • Recommended links
    Display predefined links to external web pages for specific search keywords, optionally with a thumbnail image sourced from the web page.
  • Search optimization
    Further enhance your search results with weighting, filtering, synonyms, recommended links

[/showhide]

More information

See the Premium Pack information page for general details and purchase information and the Premium Pack web-based documentation for full instructions.

No Comments

Premium Pack 3 and Help+Manual 7.0.8 Released

We are proud to announce the release of the all-new Premium Pack 3 with advanced responsive skins. This is accompanied by Help+Manual 7.0.8 with new features to support the new skins and a set of demo Premium Pack 3 skins. Help & Manual 7.0.7 or higher is required to use the new responsive skins.

See the Premium Pack product page for more details on Premium Pack 3 and visit our online store to purchase.

Premium Pack 3: Responsive. Fast. Embedded. WebHelp.

A single WebHelp site now works smoothly on desktop, tablet and smartphone browsers, with an optimized user interface for each device type. Even large TOCs and keyword indexes are handled well on smartphones. And browsing has been optimized for lightning-fast topic loading. These skins represent the first iteration of our new online help format, which we call WebHelp 3. This has been made possible by a number of new technologies that we have been working on for the last eighteen months.

Key Features

  • Fully responsive – create one WebHelp site for desktop, tablet and phone browsers
  • Frameless topics – no more index.html layout page, the topic pages are your pages and their names are your URLs
  • Embedded WebHelp – embed your help in existing web pages with a snippet of code like a YouTube video
  • Field-level popups – display formatted popups from your help in your own web pages with simple links
  • Responsive X-tables – add a single setting to data tables to make them reformat automatically on mobile devices
  • Local WebHelp – deploy WebHelp locally without a web browser, even for Google Chrome and Internet Explorer
  • Fast browsing – highly optimized topic loading for extremely fast browsing
  • Scalable – user-adjustable text size for the best possible user experience.

Premium Pack Toolbox Configuration Utility

The Premium Pack now also comes with a configuration utility with direct help for every configuration setting when you select it. This also works with older Premium Pack skins and comes with a large number of additional advanced features for power users. For example, you can add features to skins that are normally only available in your project settings. And you can edit your templates and baggage files directly in your favorite code and graphics editors.

Help+Manual 7.0.8

Help+Manual 7.0.8 comes with a set of demo Premium Pack 3 skins that you can try out, plus support for the new features in the Premium Pack 3 skins. Help+Manual 7.0.7 or higher is required for using the responsive skins in Premium Pack 3.

No Comments

Premium Pack 2.72 Maintenance Update

Help & Manual Premium Pack 2 has been updated to version 2.72 for Help & Manual versions 7 and 6. There are bug fixes for the CHM and Smartphone skins and minor corrections for the WebHelp and Classic version 1 skins. In addition to this, Premium Pack 1 for Help & Manual 6 and 7 has been updated to version 1.65 to handle the new popup link format in hotspots in Help & Manual 7 (this update is not needed for Help & Manual 6 users).

How to get the update:

You can download and install the updated version with the same download link and installation password from the mail you received when you purchased your copy of the Premium Pack. If you no longer have this please contact support@ec-software.com and we will help you out.

Popup links in image hotspots:

Help & Manual 7 has a new format for popup links in image hotspots, which was not identified by the Premium Pack scripts. As a result, the standard HM popups were displayed instead of the Premium Pack’s draggable, resizeable and automatically positioned popups. This has been corrected in the Premium Pack 2 WebHelp and CHM skins and the Premium Pack 1/Classic Dual Mode skins.

Bug fix in the CHM skins

On some high-resolution Windows devices the topic body could sometimes be positioned a little too high so that its top edge was behind the bottom of the topic header.

Bug fixes in the smartphone skins

Changes in the code generated by Help & Manual 7 caused problems with the links in the keyword index and search results. This has been corrected.

A new bug introduced in Apple iOS 9 prevents the slide transition between the TOC and topic panes from working correctly on the iPhone. Instead of sliding, the page would appear to turn away and twist with a strange 3D transition. This has been changed to a fade transition. The slide transition is still used on Android and Windows Phone.

No Comments

Premium Pack 2.71 Maintenance Update

Help & Manual Premium Pack 2 has been updated to version 2.71 for Help & Manual versions 7 and 6. This is just a minor maintenance update with corrections for a couple of issues reported by users of version 2.70. The only changes are in the WebHelp skins and the CHM skins. There have been no changes to the Smartphone skins, the iPad and Android tablet skins or the Dual-Mode Classic skins in this update.

How to get the update:

You can download and install the updated version with the same download link and installation password from the mail you received when you purchased your copy of the Premium Pack. If you no longer have this please contact support@ec-software.com and we will help you out.

WebHelp Skins changes:

Problems in Chrome with Index or Search disabled

On some computers and Windows versions WebHelp displayed in the Google Chrome browser would seem to hang or respond slowly when the timed browser cache feature was activated and the keyword index or search tab was deactivated. This has been corrected.

Unicode encoding for mail feedback

The mail feedback function now supports Unicode encoding and should work better with languages with Unicode character sets like Russian, Greek and Asian languages. (This is not supported in CHM because the Microsoft CHM viewer is not a Unicode program.)

Keyword index search improvements

You can now disable and hide the instant search feature for very large indexes, where it could cause unpleasant delays. The search is now automatically reset when you change the search mode (instant on/off, first word, word anywhere, full text).

CHM Skins changes:

Links in graphics hotspots

A problem with links in image hotspots in CHM files on some systems has been corrected. (Clicking on hotspot links would not work.)

Height of topic header

The topic header was not high enough in some cases if the logo image was turned off or smaller than the default image.

No Comments