Cuckoo Troubleshooting guide|
In this section we mostly describe things that happen in products used by Cuckoo.
It aims to be useful but it can be inaccurate. Though we try to reproduce all problems, some information comes from user reports and couldn’t be checked.
Once you have fixed them, these environment problems don’t occur again.
Cuckoo has no hidden dependencies.
Our policy is to release tested versions only. Each version is at least as stable as the previous ones. It often includes performance enhancements, patches or usability improvements. Therefore we recommend to always using the last version.
Cuckoo is still in beta. It doesn’t mean that it breaks or can give unpredictable results. For its first alpha we used Cuckoo to write the pages of this site. Beta status means that:
In Word 2002 - at least in the French version - Cuckoo doesn’t detect comments. The reason is simple: Cuckoo checks for comments with:
If cr.Comments.Count > 0
Where cr is a character range. With Word 2002 cr.Comments.Count is zero even when there is a comment.
Cuckoo macros not displayed
You must see toHTML and WordCount on the Word toolbar.
Starting with Cuckoo 0.1.1 you must also see Settings on the Word toolbar.
There is a difference in term of function but no difference in term of mean between Cuckoo and a macro virus. Cuckoo starts commands and uses FileSystemObject, RegRead and RegWrite from WSH. Any Word macro can do that. Therefore Word allows disabling macros and anti virus can prevent running macros. To check your setting use Tools | Macro | Security. You should see this panel:
You can need to disable your anti virus to run Cuckoo.
We recommend setting the Security Level at medium.
Then when you open a document using the Cuckoo macro you get:
Click on the Enable Macros if you are sure that the document only includes the Cuckoo macros.
The error occurs when you run the toHTML macro and is displayed in a message box.
Compile error can be followed by:
An anti virus can prevent:
You can either:
If you choose the second option:
The MSXML version has an impact:
It matters because we cannot use a version-independent ProgID. To create an XML document in version 4, we use CreateObject("Msxml2.DOMDocument.4.0") whereas to create an XML document in version 3 we use CreateObject("Msxml2.DOMDocument.3.0").
The problem is complicated by the fact that you must add a reference on VBA. The library chosen here must match the ProgID used at CreateObject. The table below describes the behavior of Cuckoo.
We found that we had to register MSXML SP 4. We used this command:
The safest way to add an image to a Cuckoo document is Insert | Picture | From file...
Word supports images in many different ways:
Cuckoo only manages images inserted in the text.
The reasons are:
In some cases it is also possible to add an image to a Cuckoo document with Copy | Paste.
The reason why it doesn’t work all the time is related to the clipboard.
When you copy an image on the clipboard, it is actually your source application that makes the real work. It typically provides the image in different formats. When you paste the image, the target application imports the image in the most advanced format that it supports.
When you click on the Cuckoo document if the image is in a valid format, then you should see black handles around the image. We checked that the following operations are valid:
You can use another application to downgrade the quality of the clipboard. You paste in this application, you copy again and then you paste in the Cuckoo document.
You customize Cuckoo using the Setting macro.
Your settings are saved in the registry in HKEY_CURRENT_USER\Software\PageBox\Cuckoo.
toHTML manages the following values:
By default the XHTML file generated for an xxxx.doc file is xxxx.html.
Setting manages the following values:
For Table customisation values, all tags are set. For clarity we only show the CSS class that is used.
Settings also manages custom styles.
Cuckoo creates a key custom i for each custom style. This key contains:
You can export HKEY_CURRENT_USER\Software\PageBox\Cuckoo in a reg file. It allows a team to use the same settings.
Troubleshooting and bug report
If you get a problem not listed above such as a Word crash we recommend following the procedure that we present below.
In all bug reports, please indicate the Operating System, the Word version and the XML version.
If possible send us
Check the status line
In case of error the File Selection form is not hidden and a message is displayed on the bottom line.
Send us the exact message.
If the File selection form was not refreshed, try the plan B below.
Reproduce the problem with the VBA editor opened
To open the VBA editor, use Tools | Macro | Visual Basic Editor.
For some errors the VBA Editor will point the line where the error occurs.
Send us the name of the class, form or module and the line where the problem happens. Send us also the exact error message.
If the VBA editor points that code in the FileSelection form:
It just means that an exception occurred in a function called by wr.process and that it wasn’t catched.
In that case, set the trace.
Generate a trace
To set the trace on, click the Settings macro and check the Trace checkbox.
Send us the trace file.
We created a forum for Cuckoo users at http://sourceforge.net/forum/forum.php?forum_id=191582.
We copied there some interesting mails in the hope that they will be useful even if some issues are now addressed in a better way in Cuckoo.
Please use now the Cuckoo forum to submit your problems. Other users will get a chance to read the responses and perhaps to answer your questions.