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

Style for Help Viewer 2.0

Topics: Developer Forum
Jul 12, 2012 at 11:07 AM
Edited Jul 12, 2012 at 11:08 AM


I'm building a documentation that I want to install in the Help Viewer 2.0 collection. All is fine except I can't make it to display correctly. Here is the situation:

Styles vs2005 and vs2010 are not displayed at all. The page is blank and the source for the vs2010 style looks like this

When used the Hana style I've got this:

and this when using prototype.

Could you provide some guidance how to achieve consistent look with the Help Viewer 2.0? Thanks.

Jul 12, 2012 at 8:08 PM

Are you talking about conceptual content or API topics?  I find it odd that nothing works so if it's conceptual content, perhaps your topic files are ill-formed and do not contain the required parent elements.  Also the VS2010 style, may not work that well in the Help 2 collection as it wasn't designed for it.  The VS2005 style will work fine there.



Jul 13, 2012 at 7:07 AM
Edited Jul 13, 2012 at 7:08 AM

I can confirm that VS2005 works fine on my end. However I am looking forward to the VS2010 to be updated. In regards to the error that you are getting with the Hana style, I am getting the same with VS2005 when IFrame is used in the topic.

Jul 13, 2012 at 10:30 AM
Edited Jul 13, 2012 at 10:33 AM

Hmm, I'm not actually sure I'm using the correct version number. I'm trying to use the help viewer that is coming with VS 2012. Is that 2.0 or 3? Confused :-S

Jul 13, 2012 at 1:49 PM

its 2.0

Jul 13, 2012 at 1:52 PM
Edited Jul 13, 2012 at 3:17 PM

So I was correct. It looks like I've set something not right or ... dunno. 

Eric, do you have any plans on updating/creating a style that will fit to the 2.0?


Just found something strange. As in the first post when generated in vs2010 style the content displayed by the Help 2.0 is gone

But when I unzipped the .mshc and opened the same html file all content is there as it should be. Is it possible that something in the process of installing is going wrong?

Jul 13, 2012 at 4:09 PM

Sorry, a misunderstanding on my part, I saw "Help Viewer 2.0" but was thinking Help 2.0 (HxS).  None of your links are working for me so I can't see your examples.  However, if it builds, it should work.  There are a couple of conditions though right now.  In the first release of SHFB v1.9.4.0, there were some issues with the SelfBranded property which tended to set itself incorrectly based on the selected presentation style.  Make sure you've got the refresh published on 04/29 (you do if you downloaded it after that date) and if it's set to true, set the SelfBranded project property back to false.

Also, the help viewer in the Windows 8 Preview would not show the content.  That may also be the case on the Windows 8 RC.  I believe that is Help Viewer 3.0 and that is what comes with VS 2012 (2.0 came with VS 2010).  As such, that may be why it isn't working.  Don sent me a workaround for that but haven't implemented it yet.  Under Windows XP and Windows 7, the content should show up though using Help Viewer 2.0 (the one that came with VS 2010).  Also, bear in mind that Prototype and Hana are deprecated styles and nothing has been done to them to allow them to work at all with MS Help Viewer.  If they work at all, it's pure luck.  There are no plans to get them working for it either, only the VS2005 and VS2010 styles are supported.



Jul 16, 2012 at 6:38 AM

Just to clarify something. Visual Studio 2010 comes with Help Viewer 1.1, which Visual Studio 2012 comes with Help Viewer 2.0. There is no Help Viewer 3.0.

Take a look here: