This project has moved and is read-only. For the latest updates, please go here.

Images not visible in MS Help Viewer

Nov 22, 2010 at 11:41 AM


I am trying to generate help in MS Help Viewer format by including <img src = "..\Images\file1.gif"> tag in the xml comments. but after generating .mshc file and prssing F1, image is not visible. However the same works if i generate HTML help(.chm).

Also after integrating .mshc file with VS2010 and pressing F1, the exact page is not opened rather i get the following page with options to select one of the searched page

  Visual Studio 2010
The topic you requested could not be found in local help.
1 Have you installed the local help content?
How to install and configure local help using Help Library Manager.
2 Check online for your topic at:

<form action="" accept-charset="UNKNOWN" enctype="application/x-www-form-urlencoded" method="get"><input name="method" type="hidden" value="search" /> <input name="PageSize" type="hidden" value="10" /><input name="PageNumber" type="hidden" value="1" /><input name="locale" type="hidden" value="en-US" /><input name="ProductVersion" type="hidden" value="100" /><input name="Product" type="hidden" value="VS" /></form>

Results 1-9 of about 9 for NEWCALENDAR1

NewCalendar Method
[Missing <summary> documentation for "M:Ingr.SPAT.AdminItemsEnvironment.AdminItemsEnvironmentResources.NewCalendar(Ingr.SPAT.CommonFramework.UIGenericUtility.objDict)"]

New Calendar Window

NewCalendarKeys Class
This class contains control names for each control added under command node - NewCalendar

NewCalendarKeys Fields

Ingr.SPAT.AdminItemsEnvironment Namespace
[Missing <summary> documentation for "N:Ingr.SPAT.AdminItemsEnvironment"]

AdminItemsEnvironmentResources Class
This class contains High Level Function for the command Node - NewForm

NewCalendarKeys Members

AdminItemsEnvironmentResources Methods

AdminItemsEnvironmentResources Members




Nov 22, 2010 at 9:44 PM

MS Help Viewer treats the URLs differently.  I think you should be able to get the image URLs to work correctly in the XML comments by removing the relative path part ("..\").  That's how the Sandcastle image URLs differ when built for MS Help Viewer.  The search question is better posted on the MSDN Dev Doc forum.



Jan 17, 2014 at 11:58 AM
Edited Jan 17, 2014 at 3:14 PM
HI guys,

I have similar problem with missing images. Here are some facts:
  1. I am building all four build types - Chm, Help2, Help3 and Web
  2. The images are visible in all builds except Help3
  3. The images are visible (in all Visual Studios - 2010, 2012 and 2013) if I build the project without API, but are missing when the API is included
  4. The images are visible in VS2010 (with API)
  5. The images are not visible in VS2012 (without API)
  6. The images are not visible in VS2013 (without API)
  7. When I click on an image, causes some script error: image
  8. Here is a quote from the source of a page with missing image:
  <div class="mediaNear">
            <img src="ms-xhelp:///?method=asset&amp;id=media\overview.png&amp;package=TELERIK_UI_FOR_WINFORMS_DOCUMENTATION.mshc&amp;topiclocale=EN-US" alt="overview" title="overview" />
Any ideas what might be causing this.? I am using VS2005 style if this matters.

PS. I have tried with VS2010 style, the result is the same:
VS2010 style
locally build help WITH API:
  • VS2010 - ok
  • VS2012 - no images
  • VS2013 - no images
locally build help NO API:
  • VS2010 - ok
  • VS2012 - ok
  • VS2013 - ok
Jan 17, 2014 at 8:54 PM
It's rather odd that the images come and go based on whether or not the API content is there. I haven't seen that before nor has it been reported. If you can send me an example that demonstrates the problem, I'll look into it. First though, if you aren't on the latest release, it might be worth updating to see if that corrects the issue. Earlier releases did have problems in Help Viewer 2.0/2.1 that have since been fixed.

Jan 18, 2014 at 7:52 AM
Here are a few links. I am including builds both with and without API and the proj file if needed:
With API
Project file

Let me know if you have any ideas or need additional information.

Thanks for looking into this.
Jan 19, 2014 at 9:31 PM
You didn't say what release of SHFB you are using. Based on the behavior I'm going to guess that it is an older release since the VS2005 style had a number of issues with Help Viewer 2.0/2.1 that have since been fixed. As suggested above, update to the latest release of SHFB, rebuild your help files and see if that corrects the issue. I think it probably will.

Jan 20, 2014 at 7:28 AM
Hi Eric,

sorry for omitting this information. I am using SHFB and Sandcastle I have tried both with VS2005 and VS2010 style and the results are the same.
Jan 20, 2014 at 6:44 PM
I'm not sure what to tell you. I haven't seen that problem nor has anyone else reported it. I did extract the content of your help file and did notice a custom style sheet and script file. If you have customized the presentation style in some way, that may have broken something. I'd suggest creating a small test project using the stock presentation style to see if you have the same issue.

What you could do is uninstall SHFB and Sandcastle and see if there are any files left in the installation folders that were perhaps modified in a prior release that are blocking installation of the updated files. You might also check the DXROOT and SHFBROOT environment variables to make sure they are pointing at the right locations on the off chance that they are not.

Jan 20, 2014 at 7:18 PM
Indeed, we have a small customization on one of the script files - it changes the text of the header and footer mailto's. I will test with default settings and will report the results back.