Topic: INLINE-ONLINE-HELP for macros (1 of 2), Read 35 times, 1 File Attachment
Conf: VEDIT Macro Library
From: Christian Ziemski
Date: Sunday, June 09, 2002 07:03 AM


I've written a little macro to help implementing online help in your own macros.

This way it's possible to document a macro and to do the online help in one strike.


Just document your macro as usual with a more or less detailed ;-) description in the beginning (lines with leading //'s).

Then place a tag <DOC> as starting point in front of the part to be displayed as online help
and a tag </DOC> as end point below that part.

Then use the key assignment (I use Shft-F1) to extract and show the above marked part.

The attached macro contains the necessary commands and could be used as example and demonstration.


Or it could be downloaded here:
http://home.t-online.de/home/christian.ziemski/vedit/macros/inline-help.vdm


A little bit of history:

The idea for this macro was born while improving my "Xtended List Maintaining and Converting (to HTML) tool".
( http://home.t-online.de/home/christian.ziemski/vedit/macros/xlist-mc.vdm )
That macro is a bit complex and so it makes sense to help other people in using it.
But it was boring to write the macro documentation for programmers and another online help for the users.
So I joined both and a new Shft-F1 was born.


Christian

 
INLINE-HELP.VDM (2KB)

 


Topic: Re: INLINE-ONLINE-HELP for macros (2 of 2), Read 14 times
Conf: VEDIT Macro Library
From: Christian Ziemski
Date: Sunday, March 14, 2004 05:42 PM

On Sun, 09 Jun 2002 07:03:00 -0500, I wrote:

>I've written a little macro to help implementing online help in your own
>macros. This way it's possible to document a macro and to do the online
>help in one strike.
>
>Just document your macro as usual with a more or less detailed ;-) description
>in the beginning (lines with leading //'s).
>
>Then place a tag as starting point in front of the part to be displayed
>as online help and a tag
as end point below that part.
>
>Then use the key assignment (I use Shft-F1) to extract and show the above
>marked part.


That old version uses a normal VEDIT text window to display the help.
A bit updated:
http://ziemski.privat.t-online.de/vedit/macros/inline-help.vdm

Today I wrote a new version that uses my scrollable DI_1() technique:
http://ziemski.privat.t-online.de/vedit/macros/inline-help2.vdm


Christian