Enhance the DevStudio help


This topic is about making the help system faster and more useful. This tip is especially useful if you are using the MSDN CD but is applicable even if you are not.

Tip 1: Make help faster

I am sure all of you have noticed that help in VC5 is somewhat slow. What adds to the trouble is that the help files are so big that we leave them on the CD. The installer doesn't have the option of copying certain category of topics to the hard disk. It's either all or none. What we can do is manually copy the help files we access the most to the hard disk and set up the System Registry to use the files on the hard disk rather than on the CD. You can use the RegEdit program to find out what files correspond to which topic. Look at the keys under "\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\InfoViewer\5.0\Titles".

The files that I copied to my hard disk are:

Pdref.ivt Reference
Pdui.ivt User Interface Services
Vccore.ivt Visual C++ Programmer's Guide
Vclang.ivt C/C++ Language and C++ Libraries
Vcmfc.ivt Microsoft Foundation Class Reference

These files take a little less than 50 MB of hard disk space compared to over 600 MB hard disk space you would need if you installed it all on the hard disk.

Once you copy the files to the hard disk, you need to update the registry. You'll find these keys under the "\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\InfoViewer\5.0\Titles" key without the '.ivt' extension. Update the 'content' value for these keys to point to the file on the hard disk.

Tip 2: Use search filters

If you look under the help menu, you will see amongst others, two menuitems - Define Subsets and Select Subsets. An information subset lets you focus your searches or your browsing on topics in a particular category. For example, if you're interested only in the Win32 API, you could define a subset that contains only the documentation from the Win32 SDK. Once, you define a subset, you can use 'Select Subsets' to choose different subsets for full-text searching (Search Query Dialog), context-sensitive help (F1 lookup), and the table of contents (InfoView). You can still access all the other topics through the index search.

Tip 3: Remove the titles you never use

If you have installed the July version of MSDN, you must have noticed that anytime you press the F1 key you end up with a list of topics. The topics include entries in the Windows CE reference and the MFC 4.2 reference ( which is practically the same as MFC 5 ). This was a big nuisance for me. I don't want to see the topics for Windows CE listed since I am not programming for CE. If you've used tip# 2, you don't really have a problem, except when you are doing an index search. When you are using a search filter, it does not apply to the index search. This is useful since you occasionally need to be able to search for topics outside of your help filter. Since I didn't foresee working on Windows CE, this was still a problem because I still ended up on these pages occasionally.

Anyway, what I did was, I removed the topic entries from the System Registry. These are the ones that were causing me the most pain.

Devdoc This contained the MFC 4.2 reference
Wceide Visual C++ for Windows CE 1.0
Winceddk Windows CE DDK
Wincesdk Windows CE SDK

I search for the keys under the "\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\InfoViewer\5.0" that contained these words and I deleted them. Of course I noted down their values before deleting - just in case.

Next, lookup the value of "\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\InfoViewer\5.0\Keywords\CurrentPathname". This value holds the name of the keyword file. Delete this file from the hard disk. It will be recreated the next time you use the help command.



Comments

  • Visual C++ 6.0 help disaster - possible to get V5.0 interface?

    Posted by Legacy on 02/19/1999 12:00am

    Originally posted by: Craig

    I find the interface to the on-line help for Visual C++ 6.0 to be a
    complete disaster. The infoviewer tab has lost and the application which
    replaces it doesn't seem to support context sensitive help queries and
    neither the contents nor output windows can be freefloating meaning that one
    is always too small to use properly.

    Is there any way to restore the Visual C++ 5.0 interface which although not
    perfect was a lot better than the mess which has replaced it.

    thanks

    Reply
Leave a Comment
  • Your email address will not be published. All fields are required.

Top White Papers and Webcasts

  • With JRebel, developers get to see their code changes immediately, fine-tune their code with incremental changes, debug, explore and deploy their code with ease (both locally and remotely), and ultimately spend more time coding instead of waiting for the dreaded application redeploy to finish. Every time a developer tests a code change it takes minutes to build and deploy the application. JRebel keeps the app server running at all times, so testing is instantaneous and interactive.

  • Instead of only managing projects organizations do need to manage value! "Doing the right things" and "doing things right" are the essential ingredients for successful software and systems delivery. Unfortunately, with distributed delivery spanning multiple disciplines, geographies and time zones, many organizations struggle with teams working in silos, broken lines of communication, lack of collaboration, inadequate traceability, and poor project visibility. This often results in organizations "doing the …

Most Popular Programming Stories

More for Developers

Latest Developer Headlines

RSS Feeds