Documentation Insight supports Help+Manual

Documentation Insight from DevJet Software is a Delphi and RAD Studio plugin that helps you to document source code. It produces Webhelp, compiled HTML Help and, with the latest 2.6.9.5 update, Help+Manual project files.

Documentation Insight integrates directly into the Delphi/RAD Studio IDE. This is a huge advantage over other source code documentation tools like Microsoft Sandcastle for Visual Studio. It scans your project, whether it is a Win32 application, a DLL or a component suite, builds a documentation skeleton from properties, functions and events.

Project in the Delphi IDE

Project in the Delphi IDE

 

The Documentation Inspector is a rich text editor to document classes and procedures in place. You put the cursor to a class defined in your source code and the editor window, which as an overlay window or docks into the IDE, updates automatically to that class, function or event that you pointed to. It offers an easy editing layout for standard code documentation. Changes to the documentation are stored directly in the source code.

Documentation Inspector Window

Documentation Inspector Window

 

When you are done with editing, you set the publishing options and start generating the documentation. Though you can tweak the templates, most of the process is automatic and the resulting Webhelp, CHM or HxS file has the look and feel of classic Visual Studio documentation.

 

Publish dialog of Documentation Insight

Publish dialog of Documentation Insight

 

There is however, one limitation that has to do with source code documentation in general: formatting is limited and additional topics/chapters that are not directly related to a source code unit are impossible, because the documentation is stored in the source files, where it belongs. The new version of Documenation Insight overcomes this limitation with another publishing format: it generates the documenation in Help+Manual project format. The result doesn’t open in a browser, you can open it directly in Help+Manual, complete and formatted.

 

 

The formatted project opened in Help+Manual

The formatted project opened in Help+Manual

 

You might want to use Help+Manual to edit the project with the environment you are familiar with, before you publish it as Webhelp, compiled help or PDF manual. Or you might want to integrate the source documentation into a larger scope, as part of your application documentation, for internal use. The merge function in Help+Manual can easily integrate a separate project into a master documentation.

 

Features at a glance:

  • WYSIWYG xml documentation editor
  • Live Documentation Explorer
  • Live Spell Check
  • Generates Webhelp
  • Generates compiled HTML Help (.chm)
  • Generates Microsoft Help V2 file and integrate into RAD Studio Documentation
  • Generates Help+Manual files
  • Documentation Formatter
  • Documentation Validation
  • Support most common XML tags
  • Support collapsible region to manage documentation
  • Synchronization between code and documentation
  • Integration with VCL API Documentation
  • Integration with Help Insight
  • Hyperlink Navigation
  • Customizable Region styles
  • Several note styles
  • Code Snippet editor

Supported IDEs:

Delphi 7, RAD Studio 2007/2009/2010/XE/XE2/XE3

 Supported versions of Help+Manual:

Version 5 and 6, Basic, Professional and Server

Cost:

Documentation Insight 2 (Enterprise Edition) is €249.

Summary from the editor:

Combines the best of source code documentation and external documentation and perfectly integrates into Delphi/RAD Studio as well as Help+Manual.

Website:

http://www.devjetsoftware.com/products/documentation-insight/?source=hm

Share this post:

No Comments

Premium Pack 2.02 Maintenance Update

We have just released a small maintenance update of Premium Pack 2, version 2.02. New customers will get the new version automatically. All registered users can update with the download link and installation password from their purchase confirmation.

Coming in September: Local iPad Documentation as WebApp

To whet your appetite: When we return from vacation at the beginning of September the iPad skin is going to get a major update with a new WebApp option. This means that you will be able to store your iPad documentation directly on the the iPad for offline access, including full support for search, index etc. You just create a shortcut on the iPad home screen and all the content is downloaded automatically. When the iPad is online any new material is downloaded in the background with a progress indicator for the user (browsing can continue normally while this is happening).

Changes in Premium Pack 2.02:

  • Spaces in paths in permalinks
    Some stubborn browsers like Safari do not automatically correct spaces in invalid path names to %20. The permalink scripts now do this automatically. (WebHelp)
  • Relative links to HTML files in WebHelp
    Relative links to external HTML files in WebHelp topics did not open in an external window if this was specified in the link in the topic. (WebHelp)
  • Toggle jump with toggles inside a table
    If toggles were inside a table links to anchors in toggles inside the table would sometimes open the first toggle in the table instead of the correct toggle. (WebHelp and CHM)
  • Header backgrounds in CHM skins
    In some CHM skins the header of the background did not expand enough when very long multi-line topic headings made the header box taller than the background.
  • Videos in popups
    If you have problems with videos in popups that keep playing when the popup is closed (audio can still be heard) you can now activate an option to kill the video when the popup is closed. There is a new POP_KILLVIDEO configuration variable in the affected skins. Just set this to “true” to automatically kill the background video on closing a popup.
Share this post:

No Comments

Help+Manual 6.1.0 released – All about Search!

We are glad to announce the release of Help+Manual 6.1.0, a free update for all customers who already purchased version 6! This update is all about “search” … a new search panel in the main window and search engine optimization. 

The first change is obvious, although it is an unobstrusive new feature: a search entry field in the status bar of the main window, that searches program functions and data, like Windows does in the Start menu. Just give it a try and you will wonder how you could ever do without it!

Help+Manual search box

SEO with Help+Manuals Webhelp

The second set of changes and new features improves search engine visibility of Help+Manuals Webhelp output. We made a lot of changes with version 6 already, now we are going to fine-tune them. Let’s have a closer look…

  • Topic title entry field in the topic options panel: this entry field is normally synchronized when you make changes to the TOC or to the (formatted) topic header. But necessary, it can be manually edited. The content of this field typically goes into the <TITLE> tag of the HTML page. Google displays the title tag as the caption of the search result, but only the first 65 characters. To make this limit obvious, the topic title entry field changes its color to red, when the title exceeds this limit. An easy way to check your topic titles for SEO compatibility!
  • New variables for topic templates: if the content of your documentation is not English, you will appreciate the new variable <%XMLLANG%>, which returns the language of the help project, to include it into the topic template. More importantly, there is a new variable for the description meta tag: <%TOPIC_DESCRIPTION%>. This variable returns the HTML encoded plain text content of your topic and includes the first 1-2 paragraphs. Minium 50 characters, maximum 180 characters, truncated properly after the last word with an elipsis.
  • Sitemaps: the optional sitemap, that Help+Manual creates with the Webhelp output, no longer includes the navigation pages (TOC, index, search). Instead, it contains a complete list of all topics. We strongly recommend to use the sitemap feature, if you publish your documentation on your website.
  • Image titles and captions: all images and image toggles have both, a caption and an optional title attribute. For better search engine visibility, we changed the rules and prefer the image caption for the title attribute, if available. This generates a more appropriate description when a screenshot from your documentation shows up in Google image search.

New variable <%TOPIC_DESCRIPTION%>

More new features…

  • Custom word list for the automatic hyphenation in PDF and print: the spell checker configuration dialog has a new option for a custom hyphenation word list. You can define your own hyphenation rules for certain words including phrases and names that you do not want to be hyphenated.
  • Project report: new filter options to find topics with include option “None” (e.g. topics that are used as snippets).
  • Resizable lightboxes: image toggles, when displayed in lightboxes, now don’t expand to their original size, if the browser (or help) window is too small. The lightbox increases and reduces its size dynamically, when the window gets resized. In other words: we do it like Facebook handles images.
  • HTML code objects: when inserting HTML code in topics, a #MERGE command enables merging of external HTML files and snippets. The question, whether the merged HTML code gets its own <p> or <div> tag or is a paragraph on its own, was determined before the HTML code got merged. This has been modified, so that it properly works with external code as well. Furthermore, the HTML #merge command takes the encoding of the external file into account and converts it properly (UTF8 vs. ANSI).
  • Table and figure counters: we have introduced table and figure counters with version 6, now they have been extended – you can have as many counters as you want and there is an additional reset option. More about counters here.
  • Webhelp full text search: when using the full version of the Zoom indexer instead of the built-in command line version, you can specify a custom configuration file for the indexer. This setting now handles variables for better automation.
  • The default topic (that one that opens automatically, when you open the help file) now supports variables.
  • User interface: a new Close All command is available on the quick access toolbar.

Bug fixes…

This update also includes several minor bug fixes. None of these bugs was severe, but we recommend to update.

  • Recent files dialog was slow when it contained links to files on disconnected drives
  • Multi-monitor configuration: negative screen coordinates caused H&M to start on the main monitor again next time.
  • HXS (Visual Studio help) registration problem fixed
  • Videos in lighboxes: if the poster image contained a space, it was not correctly displayed
  • Repositories: invalid bindings caused an access violation when closing H&M
  • Problem with modifying and publishing bulleted lists on Chinese Windows XP fixed
  • Command line builds with an external variables file: these variables were treated as text variables, now they keep their project defined setting as text/HTML variables
  • PDF export: automatic hyphenation for Russian texts within conditional defines fixed. Image hotspots in PDF were not properly aligned when the image had a caption and was scaled.
  • Right-to-left languages: indentation of bullet lists was wrong, TOC icons glitch in Webhelp fixed.
  • Dropdown toggles are tested for errors during export. If the toggle body is missing for some reason, you’ll see this in the compiler report.
  • Russian Winhelp projects did not import correctly
  • Minor CSS changes to standard templates
  • Our mini webserver HM2Go did not serve UTF8 encoded HTML files on Chinese Windows systems.
  • UI glitches in Insert Video dialog box fixed
  • Webhelp: cursor over chapter icons changed to hand pointer
  • Webhelp: GA tracking did not work correctly for topics
  • Built-in screen capture: on Win7, some fixed-sized dialog windows were not correctly framed

Lots of news… It’s really time to write a more detailed article on how you can take advantage of all the search engine optimization with your own Webhelp content. Most of the modifications work automatically, but some need to implementated per project. Stay tuned – you will read it in this blog!

Download Help+Manual 6.1.0:

http://www.helpandmanual.com/downloads.html

Share this post:

3 Comments

Case study: Process documentation at SERVICE&MORE

SERVICE&MORE is a service provider to medium-sized interior design consultancies and furniture retailers who, through 2 purchasing associations, looks after more than 230 members all over Austria.

SERVICE&MORE’s extensive range of services is what predominantly sets them apart. Besides the centralized purchasing of furniture and interior décor, they also support most small and middle-sized companies in their core competencies. SERVICE&MORE provides not only service, marketing and business management, but also a diverse range of specialized services, including an extensive training program with an e-learning platform.

Assimilated process documentation

The sheer amount of information in a company makes nowadays makes it necessary to document the internal processes and procedures. What used to be depicted in Word documents, Excel sheets and HTML sites should now all be consolidated and managed centrally by two employees. Therefore, the first particular challenge was to enable a seamless integration with the internal Content Management System. The second important task was to restructure the documentation procedure in order to avoid repeating content that appears several times – quality management, also for internal documentation. The last but most important task was to make a complex system user friendly with no teething problems – simple for even those employees whose main occupation doesn’t deal with documentation.

Close collaboration with the creator of the CMS

The people who were responsible became quickly convinced by the user friendliness of Help & Manual because it made it easier for the users to concentrate on writing the content. But could the program be incorporated into the current Content Management System?

This concern was successfully addressed with “Webhelp” and the PDF Export from Help & Manual. The company’s internal CMS is a customer specific solution which delivers database driven contents, as well as, static documents (HTML sites, PDF and Word data, spreadsheets, etc.) via the internal browser network. It succeeded in achieving a space in CMS for the extensive HTML documentation to be completely incorporated into the general layout of the intranet.

Documentation workflow, CMS delivers integrated content

Re-use of existing content

Even internal processes often cross over and parts of a process are then found in other processes. In order to maintain the volume of documentation to a manageable level, these should be consolidated to avoid duplication.

That’s where Help & Manual was able to assist with a highly modular structure of the documentation project. Segments were moved to separate projects and then added again as components into the superior process documentation.

Process documentation at SERVICE&MORE

Process documentation at SERVICE&MORE

 

Implementation period: just a few weeks

In summary, we can say that integration was very successful. The software fulfills all of the stipulated technical requirements and, for the employee, all of the visible documentation is seamlessly embedded in the Content Management System.

Whereas projects of this size normally take months to implement, we were able to implement the combination with Help & Manual within just a few weeks – from the completed planning phase to going live; an advantage not to be underestimated.

About SERVICE&MORE

As a professional partner in the interior design sector, SERVICE&MORE offers medium sized companies everything they need in order to remain successful in the age of mass production providers. With the purchasing associations GARANT-MÖBEL Austria and WOHNUNION, SERVICE&MORE looks after more than 230 furniture retailers and interior designers.

Share this post:

No Comments

Premium Pack 2 released with 45 skins

We are proud to announce the release of the Premium Pack 2 skin pack for Help & Manual 6. It comes with a total of 45 skins and a wealth of new features. In addition to great layouts you get a huge range of powerful functions like auto-generated topic contents menus, permalink and user feedback tools, print preview and more. Visit the announcement page for full details and video demos.

Dedicated skins for WebHelp, CHM, Smartphones and iPad

The new skins are very mature, with separate skins for different outputs. You now have separate skins for WebHelp, CHM output, Smartphphones (iPhone, Android, Windows Phone 7 and BlackBerry OS6+) and the Apple iPad. See further below for screenshots.

WebHelp skins with toolbar and tabbed browsing (14 skins)

The new WebHelp skins are actually a complete user interface for accessing documentation on the Web. They introduce a toolbar for quick access to all functions, tabbed browsing with the ability to undock tabs and park topics in tabs, and customizable drop-down menus for integration in your website. You can configure automatic redirects to take mobile devices to your smartphone version.

Smartphone skins for delivering mobile help (8 skins)

The smartphone skins provide an intuitive touch interface with support for tap, swiping and pinch to zoom. Images are resized automatically to fit the screen. You can swipe to switch between the Contents and topics or use the toolbar. You can define “tap tables” for displaying large-format content in scrollable overlays that can be displayed or hidden with a single tap. Automatic redirects for desktop browsers are available.

CHM skins for efficient Windows application help (8 skins)

The CHM skins make efficient use of the limited available space in the topic header by putting access to functions in drop-down menus. The new “file link fixer” feature makes it possible to link to external files with relative paths. These links now just work.

Dedicated iPad skin

This skin provides a slick iPad style interface with smooth single-finger scrolling regions. It’s a great way to deliver web-based documentation for iPad access. Here too, you can configure automatic redirects for other devices.

Visit the announcement page for full details and video demos.

Screenshots

WebHelp skin:

Premium Pack 2 WebHelp skin

WebHelp skin with tabbed browsing and toolbar

Smartphone skin:

Smartphone skin

Contents and topic panes in the smartphone skin

CHM Skin:

CHM skin

A CHM skin showing the new menu tools

iPad skin:

iPad skin

iPad skin with single-finger scrolling areas

Share this post:

No Comments

WordPress integration for Help+Manual!

Quite a few Help & Manual users have asked about options for integrating WordPress with Help & Manual output. Marc Beneteau of WordPress Academy has now responded to these requests with a third-party WordPress plugin that integrates WebHelp using the Premium Pack skins with WordPress membership sites. 
 
The plugin is primarily designed for authors and vendors who need to provide paid access to information online. You can maintain your content with Help & Manual and use the features of WordPress membership sites for providing paid access. You can see it in action in Marc’s own implementation on his WordPress Academy site here:
 

WordPress integration for Webhelp - click on the image to see it live

 
The plugin does not require any changes to the Help & Manual skins, projects or output. You just put your HM WebHelp content online, and the plugin pulls it into your WordPress site.  
 
Write to Marc Beneteau at marc@wpacademy.tv for more information on the plugin and have a look at the main WordPress Academy website at http://wpacademy.tv/.
 
 
Share this post:

, ,

No Comments

Premium Pack 1.52 Maintenance Update Released

Users of the Help & Manual Premium Pack for Help & Manual 6 can now download the 1.52 maintenance update. This update adds two small new features and corrects a number of isolated issues that were reported by some users.

New Features:

  • Topic title in browser title bar. The title of the current topic is automatically displayed in the browser title bar together with the name of the project (WebHelp only).
  • Accented characters in sortable tables. You can now set sortable tables to sort text containing accented characters correctly. This can be turned off for languages that sort accented characters after Z.

Fixes:

Fixes have been implemented for better handling of very large sortable tables and topics containing a very large number of expanding text toggles. Printing topics from WebHelp in Internet Explorer has been improved and some CSS improvements have been added for Internet Explorer 9 in both standard and compatibility mode. Microsoft’s standard warning banner is now displayed when help is opened using Internet Explorer 6.

Share this post:

No Comments

Help+Manual 6.0.3 regular maintenance update



Help+Manual 6.0.3 is available as a regular maintenance update from our download page. This update mostly deals with minor glitches, but several small UI improvements have been implemented as well. We recommend to update to version 6.0.3!

Detailed list of changes and modifications: Read the rest of this entry »

Share this post:

No Comments

Review of Help+Manual 6 in tcworld Magazine

Marc Achtelig from Indoition has written a detailed review of Help+Manual 6 and compares it to RoboHelp and MadCap Flare. Read the full article in tcworld e-magazine!

Help & Manual remains the most pragmatic and flexible among Help authoring tools even with the new version. The online Help and the electronic media generated leave almost no wish unanswered.

Direct link:
http://www.tcworld.info/tcworld/technical-communication/article/new-version-of-help-manual/

Share this post:

,

2 Comments

Registration open for User Assistance Conference in Memphis, TN

Registration is open for the 2012 Conference for Software User Assistance in Memphis, Tennessee!

The focus of the Conference for Software User Assistance is on developing the best possible user experience for all types of software applications through well-designed interfaces and helpful and accessible support information.

Save the date: March 11-14, 2012!

Conference homepage:
http://www.writersua.com/conference/index.html

Agenda:
http://www.writersua.com/conference/agenda.htm

Share this post:

No Comments