Posted by Alexander Halser in Technical Writing, Training on September 30, 2024
Accessibility has been a hot topic for quite a while, but now it’s getting serious. From July 2025 it’s going to be a legal requirement for all new products in the EU, and this also applies to websites and documentation. So how are we going to make HTML accessible?
As of July 2025, all new products in the EU must conform to the European Accessibility Act (EAA), and this includes websites, HTML documentation as well as hardware and software. Web designers and documentation authors are going to have to comply in time if they want to avoid some potentially eye-watering penalties.
Documentation in PDF and some other local file formats can be handled accessibly with updated software, but when it comes to HTML, authors are pretty much on their own. This article explains the basics of making HTML accessible and compliant.
Please note: This article is about accessible HTML in general. When you create Webhelp/HTML5 with Help+Manual, our tool already outputs the required accessibility tags and attributes for you. Look for updates tagged “ARIA” on this blog, to learn more about accessibility in Help+Manual. This article, however, is still useful for Help+Manual users who want to update customized Webhelp skins to make them accessible.
Posted by tim green in Documentation Authoring, Help+Manual, Technical Writing, Translation, Utilities on September 26, 2023
Soluling is a powerful new translation tool for Help+Manual projects, software user interfaces, web content and much more. It offers a unique combination of support for multiple machine translation services with human translators, along with translation and terminology memory. The most important points for Help+Manual users are:
For more information and downloads visit the Soluling website at https://www.soluling.com/.
Translating Help+Manual projects in Soluling is a simple process. Basically, you point the program at a HMXP project and it loads the project tree and its content in a spreadsheet-like interface. You can translate manually directly in the right column. Or if you are using machine translation you right-click in the empty target language column and choose your configured translation service. Similarly, you can also use your translation memory there once it has been set up. Any XML tags within the paragraphs are shown, but this doesn’t trip the system up. Sentences are always handled as entire units, no matter how many sub-tags they contain. This is a pleasant contrast to some other XML-based translation tools.
The spreadsheet paradigm makes bulk translation very simple. For a topic you select the topic file, press CTRL+A in the target column to select everything, then right-click and select your translation service or your translation memory. Translating the entire project with a single click works in the same way: Selecting the project name at the top of the tree on the left displays all the translatable elements in the entire project on the right. Then you just select them all and choose your translation service or your translation memory.
The integration of translation and terminology memory is another major feature of Soluling. Once you are satisfied with your translation you can save it to the integrated translation memory database for your project. When the Help+Manual project is updated you just need to apply the translation memory to get perfect translations for all the text that hasn’t changed. Then you only need to work on what is new and changed.
By default, translation memory works with sentences as the basic unit, but you can also configure Soluling to handle phrases and other meaningful language units in the translation memory. It is extensively and minutely configurable, like everything else in this impressive tool. And in addition to your own translation memory database, Soluling can also integrate the Microsoft Terminology Service and the MyMemory translation memory service.
Similarly, you can also configure a terminology database that will automatically translate any defined terms in the predefined way for maximum consistency. And here too, you can combine your own database with the Microsoft Terminology Service.
Soluling supports working on your translation projects in teams. You can generate Soluling packages to send to multiple translators and then integrate their results into your main project. And the translation memory and terminology databases can be maintained as cloud-based versions so that all translators can access them directly.
This goes beyond the scope of this review, but as already mentioned, Soluling isn’t only for translating Help+Manual projects, web content and a total of over 100 other different input formats. It is also a full software localization tool, with a complete set of powerful and configurable features for translating and localizing the entire user interface of your application. Visit the Soluling website for more information on this.
Posted by tim green in Browsers, CHM HTML Help, Documentation Authoring, eWriter, Help+Manual, Skins, Software Updates, Technical Writing, Utilities on July 12, 2023
We’re glad to announce the update of the Help+Manual Premium Pack add-on to version 5.1.0. This update includes a number of small but significant improvements to almost all the skins and is recommended for all users.
You can download and install the update with the link and credentials you received when you purchased. If you no longer have these, just contact support by email and we will help you out.
Posted by tim green in Documentation Authoring, Help+Manual, HelpXplain, Software Updates, Technical Writing on May 11, 2023
For the past couple of weeks I’ve been testing Help+Manual and related tools on the latest version of Windows 11 for ARM running on an M1 Mac under the new Parallels 18 virtual machine program.
I can cautiously recommend Parallels 18 for running Help+Manual and its necessary helper programs under the current and latest version of Windows 11 for ARM. Earlier versions of Windows 11 ARM and earlier versions of Parallels will NOT work satisfactorily, but these latest versions appear to be surprisingly good.
Warning: It is still early days, so this recommendation remains cautious. Even though everything appears to be stable, I still wouldn’t yet depend on it if I was buying a new computer as my only machine. However, I would already feel pretty good about using this as a second machine, provided I had a genuine, Intel-based Windows machine as a backup.
Posted by tim green in Documentation Authoring, Help+Manual, Technical Writing, Training on February 24, 2023
A while ago we reported about the online HM-based technical writing courses offered by Subash Sarath via his site Learn Tech Writing Fast. In the meantime, Subash has produced a video course that is now available on YouTube free of charge. You can access the course on his YouTube channel here (click the image to visit):
We should note that this is a fully independent production in which we did not participate ourselves. We would be interested to hear any feedback, which you can send to the regular EC Software support address or post on the user forum.
Posted by Alexander Halser in Help+Manual, Software Updates, Technical Writing on July 26, 2022
We are happy to announce the immediate release of eWriter Viewer V3 for MacOS.
With this update, eWriter viewer version 3 is complete. The viewer is now available for end-users for Windows (Windows XP until Windows 11) and for MacOS 11 (universal binary for Intel/ARM).
Download:
https://www.helpandmanual.com/ewriter/index.html
eWriter Viewer on MacOS screenshot
If you use the ewriter format as application online help for your own software, the redistributable eViewer executables have been updated as well.
The developer package includes executables for Win32/Win64/MacOS for redistribution, a tester application for Windows and MacOS and the complete documentation. Please download the eWriter developer package from the link below.
Download:
https://www.helpandmanual.com/download/eviewer-v3-developer-redist.zip
eViewer Tester screenshot
Posted by tim green in Documentation Authoring, Help+Manual, Technical Writing, Uncategorized, Utilities on May 28, 2022
Help+Manual is so powerful and multi-faceted that there’s always something new to discover. Even though I write the documentation, I still continue to find things that our developers have added that I didn’t yet know about. This morning I was looking in the program directory and I noticed a file called ScreenCapture.exe. What? I started it, and lo and behold it opened a completely stand-alone screen capture utility:
A quick call with the developers revealed that this behavior is intentional. Yes, you can use Help+Manual’s ScreenCapture.exe as a standalone tool for creating screenshots. It stores the images it creates in the Windows Clipboard, from where you can then insert them in any other application with CTRL+V or the right-click Paste command.
Tip: The same tool is also available in the HelpXplain program directory.
This standalone capture utility has now been updated with the version 8.4.4 release of Help+Manual. It can do everything that Help+Manual’s integrated screen capture can do, with the exception of creating HelpXplain-style screencasts:
When you complete the capture in stand-alone mode you will be asked whether you want to copy the captured image to the Windows Clipboard or save it to a file.
Multi-part captures need a transparent background in the areas between the captured screen elements. When these captures are saved to the Windows Clipboard, they are stored in two versions: A 32-bit PNG image with transparency, and a regular bitmap without transparency, which is necessary for programs unable to handle transparent PNGs. Which version is inserted from the Clipboard is automatic and depends on the program in which you are inserting the image.
If you want to use it, just create a shortcut to ScreenCapture.exe and you’re ready to go.
Posted by tim green in Browsers, CHM HTML Help, Documentation Authoring, Help+Manual, Scripting, Skins, Software Updates, Technical Writing, Utilities, WebHelp on February 1, 2022
We are happy to announce the release of Premium Pack 4.4.0 with three new features and a wide range of other improvements and fixes. Sandcastle Tidy puts your Microsoft Sandcastle documentation import fully under the control of the project stylesheet. Caret browsing support for tabbed navigation in the TOC and header has been added to the V3 and V4 skins. The Update Skin Config tool for transferring your settings from old to new skins has been significantly improved, now showing you only the settings in your old skin that are different from those in the new skin.
You can download and install the updated version with the download link and personal installation password you received when you purchased. If you no longer have these details please contact support@ec-software.com and we will help you out. See the Premium Pack product page for more details on Premium Pack 4 and visit our online store to purchase if you do not yet have it.
Posted by tim green in Documentation Authoring, Help+Manual, Technical Writing, Training on December 1, 2021
Longtime Help+Manual expert and technical writer Subash Sarath Lakshmi is offering an online course in which you can learn technical writing skills with Help+Manual.
The course is offered directly on the SkillShare site.
A software developer before he took up technical writing, Subash has been active in the IT industry for nearly three decades.
He has offered in-person trainings in technical writing and Help+Manual, but with the onset of the Covid pandemic he has now switched to online-only courses, which is also making them accessible to a more international audience.
Website: https://learntechwritingfast.com/
Course on Skillshare: https://skl.sh/30yadg5
Users who have completed the course have praised it in comments:
“The only course you’ll ever need if you want to learn Technical Writing or become a Technical Writer. From start to finish the course was like an exciting road trip.”
–David Ebenezer (Project Manager)
“I’ve just finished the Technical Writing course. I am from Austria and I’ve just started my new job as a Technical Writer at the Aescudata company. I liked the course very much, everything was explained clearly and with the assignments there was possibility to practice. I was really satisfied with your course and it is helpful for my daily work as a Technical Writer.”
–Julia Maderthaner (Technical Writer)
Posted by tim green in Documentation Authoring, Help+Manual, HelpXplain, PDF, Technical Writing, Training, Translation, Uncategorized, User Community on November 20, 2021
EC Software is delighted to welcome Naef Learning, our new full-service reseller for the Swiss market. In addition to selling the full range of EC Software products, Naef Learning backs this up with extensive support, training and maintenance services, plus documentation in German.
Services include: