Help+Manual News

Deploying eWriter for Software Documentation


Publish eWriter eBooks with Help+Manual

If you are using eWriter books as documentation for your software you will want to open specific topics in the help from your application. To do that you need to be able to reference the viewer directly, so it is best to install it along with your software. You can’t be sure that the user will have it or where it will be otherwise. You also need to consider the following issues:

  • You should always make your help calls explicitly to the version of the viewer that you have installed.
  • You are allowed to and should redistribute the viewer application with your own software.

Read on to learn how to get this set up and working optimally.

Step 1: Get the eViewer.exe executable from the Help+Manual program directory

The current version of eViewer.exe is always included in the Help+Manual program directory. You just need to include it in your own installation. It doesn’t require any special installation or registry keys. It will actually run fine from a USB stick. If you wish you can rename the viewer file and re-sign it with your own certificate so that it matches the rest of your software. That is entirely up to you and we don’t have a problem with it.

Don’t register the .ewriter extension

We also recommend that you do not register the .ewriter extension as part of your installation. Instead, always make your calls explicitly to your installed eViewer.exe and your own help files. This guarantees that you are using the same viewer that was up to date when you generated your help. However, you will also want your users to be able to open your help files themselves by double-clicking on them. So read on to learn how to do that.

Consider using a different extension for your own help files

It is also fine and actually a good idea to change the extension of your help files to anything you like. If you do this, you can register your own custom extension to your installed version of the eViewer application so that your users can open your help files themselves by double-clicking on them.

Then you don’t get any conflicts if the user gets .ewriter files from somewhere else. If they open .ewriter files on Windows 10 they will get the Windows Store version of eViewer automatically (and that extension is required for the Store viewer), and then you don’t have any conflicts: The .ewriter extension is always used for the Store version and your application always opens your help files with your installed version of the viewer.

Comments are closed.