Support Limitation

While we made good experiences running the Microsoft CHM Compiler using Wine we can not guarantee its operation due to a lot of possible combinations of operating systems and Wine versions and configurations.

If you install Wine on your Confluence server and it can not run the Microsoft CHM Compiler we might not be able to help you in the scope of our product support.

Please use an evaluation license of Scroll CHM Exporter to verify if you can use the product on your Confluence server.

If you need further compatibility information, please have a look at the Wine AppDB page on Microsoft HTML Workshop.

If your Confluence instance is running under Linux or other Unix operating systems (like Mac OS X), you need to set up a Wine environment including the CHM Compiler.

Before you begin: Make sure you have properly installed Wine on your Confluence server.

To setup and configure Microsoft HTML Workshop under Wine for the first time, perform the following steps:

  1. When Wine has never been executed before, the default Wine environment doesn't exist. Then run the winecfg command to set up an environment.
    Typically, the Wine environment is created here:
    Linux/home/<USERNAME>/.wine
    Mac OS X/Users/<USERNAME>/.wine
    (info) Please note: drive_c is mapped to c: in the Wine configuration commandlin tool winecfg.

  2. Make sure you have cabextract installed (http://www.cabextract.org.uk/).
  3. Open the Wine configuration tool using the winecfg command, and perform the following steps:
    1. Set the Windows version to Windows 2000 (or above).
    2. Add library overrides to use the native versions for itss.dll and itircl.dll.
  4. Download htmlhelp.exe from here: http://www.microsoft.com/en-us/download/details.aspx?id=21138.
  5. Install this library using the following command from the download directory:

    wine htmlhelp.exe
    CODE
  6. Extract and register native libraries:

    cabextract -F hhupd.exe htmlhelp.exe
    cabextract -F itircl.dll hhupd.exe
    cabextract -F itss.dll hhupd.exe
    CODE

    With a 32 bit Wine installation:

    32 bit Wine

    cp -a itircl.dll ~/.wine/drive_c/windows/system32/
    cp -a itss.dll ~/.wine/drive_c/windows/system32/
    wine regsvr32 /s 'C:\WINDOWS\SYSTEM32\itircl.dll'
    wine regsvr32 /s 'C:\WINDOWS\SYSTEM32\itss.dll'
    
    CODE

    Or with a 64 bit Wine installation:

    64 bit Wine

    cp -a itircl.dll ~/.wine/drive_c/windows/syswow64/ 
    cp -a itss.dll ~/.wine/drive_c/windows/syswow64/ 
    wine regsvr32 /s 'C:\WINDOWS\syswow64\itircl.dll' 
    wine regsvr32 /s 'C:\WINDOWS\syswow64\itss.dll'
    CODE
  7. Download Microsoft Foundation Classes update, extract it, and install it:

    Please note that that link below (http://activex.microsoft.com/controls/vc/mfc40.cab) no longer works. As we are not allowed to distribute the file, and we couldn't find the working link on Microsoft website, you would have to obtain the file some other way.

    wget http://activex.microsoft.com/controls/vc/mfc40.cab
    cabextract mfc40.cab
    wine mfc40.exe
    wget -N http://activex.microsoft.com/controls/vc/mfc40.cab
    cabextract -F mfc40.exe mfc40.cab
    cabextract -F mfc40.dll mfc40.exe
    CODE

    With a 32 bit Wine installation:

    32 bit Wine

    cp -a mfc40.dll ~/.wine/drive_c/windows/system32/
    CODE

    Or with a 64 bit Wine installation:

    64 bit Wine

    cp -a mfc40.dll ~/.wine/drive_c/windows/syswow64/
    CODE

Example (Mac OS X)

After successful installation and configuration on Mac OS X, your .wine directory should look like this: