Documentation Insight V1.3.1 (Build 98) Released

Written by Baoquan Zuo on . Posted in Documentation Insight

This minor update of Documentation Insight includes some nice enhancements on the WYSIWYG editor:

+ Added Undo/Redo support for all actions (<c>, <paramref>, <note>, etc)

* Automatically add new line when pasting to an editable table such as exceptions, seealso, etc

* Improved double-clicking behavior

1) Selecting adjacent word without space

2) Selecting entire <see> element in editing mode

# Fixed wrong documentation of unit when applying region directive

# Fixed a bug on License Validation

Please go to the Downloads page to get the latest version.

FREE Documentation Insight licenses for Active Open Source Projects

Written by Baoquan Zuo on . Posted in Announcements, Documentation Insight

There are so many good open source projects in the Delphi community and most of us can benefit from them. However, it often appears that we are not sure about the usage of a class, a method or a parameter as they are not documented in the source code.

Documentation Insight is a powerful documentation tool which can help us visually read and write documentation in the IDE. Many users are very pleased with it. We think it will be great if more and more open source projects are well documented. So if you are the author or one of major comitters of an active open source project, you may have an opportunity to get a FREE license of Documentation Insight.

Note: The donated license should be used for non-commericial use in principle but you can get a BIG discount if you wanna order it for commercial use.

To get more information on Documentation Insight, please visit the Product page:

Email: support@devjetsoftware.com

A special release of Documentation Insight for Delphi 2009 Users

Written by Baoquan Zuo on . Posted in Documentation Insight

We have been requested to support Delphi 2009 for Documentation Insight by several guys. Now it is coming…

Note:

  • You don’t need to install this version if you have not yet installed Delphi 2009.
  • This version is not intended to be a “final” release, so please don’t distribute it.

Known Issues:

For RAD Studio 2007/2009,  the integration with VCL API Documentation is only for experimental purpose as its structure is not so regular. It works great in RAD Studio 2010/XE.

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.

Documentation Insight V1.x Roadmap

Written by Baoquan Zuo on . Posted in Documentation Insight

Documentation Insight is an add-in which helps you visually read and write documentation in the Delphi / RAD Studio IDE. It has shipped.

We will keep improving this product. Here is the plan for V1.x:

1. Syntax Parser

  • Extract more metadata such as Parameter Optional/Default
  • Fix bugs in parsing some VCL units (implementation section)
  • Considering support for the {$I} directive
  • Considering support for the {$IF} and {$IFEND} directives
2. Editor
  • Improve the Code Editor
  • Add more short cuts
  • Improve User Experience (KEEP DOING)
  • Support the editing of <threadsafety> and <preliminary> tag.
  • Don’t insert a line break after some keywords such as var, type, private, etc. (DONE)
  • Collapse the generated region when saving doc (*)
  • Add a button to collapse all documentation regions in a source code file (*(DONE)
3. User Manual
  • Write more detailed user manual (chm)
  • Integrate latest Delphi Documentation Guidelines
4. Help Insight Transformation Template (DONE)
  • Provide a customizable template to make Help Insight support the syntax of all tags supported by DI.
  • Better looking and feel
5. Misc
  • Support RAD Studio 2009 (DONE)

Note: (*) These two features seems need extra support from Embarcadero since Open Tools API doesn’t provide any explicit function on some certain region.

We will do our best to achieve these goals but we have to say there is no any guarantee on this roadmap.

If you have any idea or wish, please leave us a message.

Baoquan Zuo (Paul)
DevJET Software

Documentation Insight Ships

Written by Baoquan Zuo on . Posted in Documentation Insight

We are so excited to announce that Documentation Insight ships now.

We have updated the website you can download the latest version from the page. It’s recommended that you visit the product page at http://www.devjetsoftware.com/products/documentation-insight/. We made a flash video to demonstrate how Documentation Insight helps you visually read and write documentation in the IDE.

Here is the change log since the Beta 3:

+ Support Delphi 7 (No Vcl Help Integration)
+ Support for members of an enumeration type
* Adjusted some layout of the toolbars
# Fixed a potential AV bug when closing the IDE while DI is floating.
# Fixed the Enter issue in a Code Editor
# Fixed the navigation issue when clicking a hyperlink in Vcl doc.
# Fixed two issues on layout
# Handled the exception when failed to parse xml doc
# Fixed a location issue for the first member of a type
# Fixed missing type information of a global variable

You may visit the Downloads page to download the full-functional 15 day trial version. If you can benefit from this product, please purchase a license. We offer 50% discount until Dec. 10th, 2010. You mustn’t miss it.

DevJET Software
Nov. 28th, 2010


Documentation Insight Beta 3 Released

Written by Baoquan Zuo on . Posted in Documentation Insight

Updated Dec. 30th, 2010: Documentation Insight has shipped! please visit here:  http://www.devjetsoftware.com/products/documentation-insight/
1. Introduction
Documentation Insight is an add-in for RAD Studio IDE and it provides a WYSIWYG editor to help you visually view and edit xml documentation.
2. Requirements
* Internet Explorer 7 or higher
* MSXML 6.0
* RAD Studio 2007/2010/XE (Delphi)
3. What’s new in Beta 3?
This release fixed many bugs: (Thanks to John Kaster & GunSmoker)
> Fixed the exception when using the identifier escape character “&”
> Fixed the wrong generated documentation for one-line code style:
var f: string;
class var f: string;
class threadvar f: string;
> Parameters of a routine, which locates in the implementation section, were missing.
> Focus issues
> Replace the non-breaking entity (&#160;) with a space
> Documentation will be lost when clicking the hyperlink of valueType/returnType
4. Download
(Not available)
5. What’s Next?
We are going to support Delphi 7/2009  and then release the final product. You are welcome to give us any suggestions/ideas.
Thanks for your support!
DevJET Software
Nov. 14th, 2010

Documentation Insight Beta 2 Released

Written by Baoquan Zuo on . Posted in Announcements, Documentation Insight, Products

Updated: Documentation Insight has shipped, please visit the product page.

1. Introduction

Documentation Insight is an add-in for RAD Studio IDE and it provides a WYSIWYG editor to help you visually view and edit xml documentation.

2. Requirements

  • Internet Explorer 7 or higher
  • MSXML 6.0
  • RAD Studio 2007/2010/XE (Delphi)

3. What’s new in Beta 2

+ Integrate with VCL help documentation (Preview).

+ More region styles (Customizable Caption or summary snippet).

+ Added a Shortcut Key (It’s Ctrl+Shift+D by default) to show/hide DI.

+ Added an option to insert line break before documentation to make code look beautiful.

+ Added an menu to explore syntax parser logs

* All unknown section tags will be reserved when saving documentation.

* Find nearest code element in the forward direction. (Interface section)

# Bug Fixes:

  • AV exception raised when closing a model view.
  • Option: Minimum lines of documentation (Thanks to Tygrys)
  • Parameters/Typeparameters missed when the count of the <param>/<typeparam> tags are mismatched from declared (Thanks to John Kaster)
  • Some Syntax Parser bug fixes

4. Download

Updated: This beta is not available, Please download the latest version from the Downloads page.)

5. Additional Information

Here is a snapshot to demonstrate the integration with VCL help documentation (Delphi XE). Enjoy it!

Note: You need to make sure that your local VCL help documentation has been correctly installed in order to try this feature. Documentation Insight just extracts necessary information from local help, the copyright of the contents belongs to Embarcadero.


Documentation Insight Beta 1 Released

Written by Baoquan Zuo on . Posted in Announcements, Documentation Insight, Products

Updated: Documentation Insight has shipped, please visit the product page.

We are very excited to announce that the first beta of Documentation Insight is now released!

1. Introduction

Documentation Insight is an add-in for the RAD Studio IDE and it provides a WYSIWYG editor to help you visually view and edit xml documentation.  Here are some snapshots of the product:

Snapshot1: Reading Mode (Navigation)

Snapshot 2: Editing mode

With Documentation Insight, you can easily bold/italic/underline/strikethrough text, start a bulleted list, a numbered list or a definition table, or insert an image, a hyper link, a code snippet or a note block, etc. And Documentation Insight will automatically generate xml documentation and update the source code in a second.

It’s so wonderful since you don’t have to remember the complicated syntax and deal with messy xml tags.

2. Environment Requirements:

  • Internet Explorer 7 or higher
  • MSXML 6.0
  • RAD Studio 2007/2010/XE

3.Download:

[Closed]

Note: This version is intended to preview and test. It will be expired on Oct. 31th, 2010. We’ll release a new version before it has been expired. Please see the Release Notes and the Help in the application folder.

P.S. We just released Delphi Documentation Guidelines. You must not miss it : ^)