More Help Insight Customization

Written by Baoquan Zuo on . Posted in Documentation Insight

Documentation Insight has shipped and it supports most tags in the Delphi Documentation Guidelines.

Luckily, it’s possible to customize the built-in Help Insight to make it support the tags and look better. The following snapshots show our effort. : )

Updated: Feb, 7th, 2011, V0.9.2 released (Fixed the encoding issue)

Download

Download Now

Additional Note

You should backup your local HelpInsight.xsl file and then extract the downloaded zip file to the corresponding location.

RAD Studio 2007 or 2009: {$BDS}\ObjRepos

RAD Studio 2010 or XE:  {$BDS}\ObjRepos\en

Credits

Hope you will like it. Any ideas or bug reports, Please leave us a message or write to us at support@devjetsoftware.com.

Copyright Note: It’s not allowed to distribute this package without the permission of DevJET. It’s recommended that you use a hyper link to this post.

Trackback from your site.

Comments (10)

  • David

    |

    when you write:
    “You should backup your local HelpInsight.xsl file and then extract the downloaded zip file to the corresponding location.”

    Do you mean backup your local HelpInsight.css? The zip file does not contain a HelpInsight.xsl

    Reply

    • Paul

      |

      I’m sorry that I may not say so clear. The zip file contains a folder (HelpInsight) and a file named HelpInsight.xsl. You need to extract all of them to the corresponding location. So you should override the old HelpInsight.xsl.

      Reply

    • Paul

      |

      The most possible reason is that Help Insight can’t find the css file. Please open your $(BDS)\ObjRepos ($(BDS)\ObjRepos\en in D2010 or higher) folder, and then ensure the following files/directories exist:

      HelpInsight.xsl
      HelpInsight folder
      HelpInsight\Configurations.xml
      HelpInsight\HelpInsight.css
      HelpInsight\Icons\*.*

      You might not extract the files in the zip file into the correct location.

      In addition, I have updated the template to solve the encoding issue. Please download the V0.9.2
      Thanks for your report!

      Reply

  • Alex Zed

    |

    Thank you for the bug fixation, installed 0.9.2 version and everything is good with encoding, I see Cyrillics right.

    Reply

    • Paul

      |

      My Pleasure :^)

      Reply

  • Simon J Stuart

    |

    This is the best modification to CodeInsight I’ve ever seen! I’m just wondering if you’d have any objection to me bunlding this in with my RADPlates plugin, along with a simple menu option to switch between the DevJet and original seamlessly.

    Thanks!

    Reply

    • Paul

      |

      Thank you! It was supposed to be integrated with the future Documentation Insight distribution.

      Reply

      • Simon J Stuart

        |

        Sorry… I’m not sure if that was a “yay” or “nay” to my prior question. Is this modification slated to be a defacto standard in XE2 by any chance?

        Thanks again :)

        Reply

        • Paul

          |

          (Sorry, this comment was spamed by my gmail…)
          We are trying to make it true : )

          Reply

Leave a comment