Easy Header - Beta

[johngb]

Here is a little plug-in which will make documenting your programs just a little easier. It's in beta at present as I would like to get comments on its usability and any extras you think would be useful.

The plug-in will allow you to use a set of header templates which you fill out with the relevant details and can then paste in to the IDE or copy to clipboard.

An example set of templates is provided and includes a default subroutine header, Program header, Macro header, ISR header. These are defined in a text file which you can edit with Notepad or something similar.

Certain fields can be incorporated into a template and will get automatically filled in by the application when a template is opened. All supported fields are shown in the Program Template topped and tailed with "%" characters.

You can edit a template displayed in the application as a normal text document. There is a RH mouse menu which supports undo, redo,copy and paste.

The options dialog lets you choose whether to paste into the IDE or copy to the clipboard. You can also choose the character you want to use to signify comments. Also, you can let Easy Header set the width of the header to a specific value manually or take the right hand gutter margin used by the IDE.

I think most of the options are pretty self explanatory.

The attached Zip file contains the executable, a Sample Template file and an MCP file. (As its only a beta I have not built an install for it at present).

Installation

Hi, its great to see you visiting our forum. Why not try Proton Compiler for FREE? Download the FREE version of Proton Compiler, Its called Amicus18 and its available from HERE Already using proton Compiler??? Get rid of these pesky messages... get LICENSED USER STATUS

Copy the files into PlugIns\JGBTools - If JGBTools doesn't exist, create it.
You should then get a new EasyHeader Icon in your toolbar. Please try it out and let me know if there are features you would like see added or aspects which you would like changed.

[Tim]

Hi John as you will know as I have been testing it, I think its very good, it makes the whole process of documenting so much easier.

People should try this its very good.

[joesaliba]

Hi John,

I tried your Easyheader but when it comes to copy to clipboard an error comes pops out. Attached screen shot.

Thank you
Regards

Joseph

[johngb]

Open your Options dialog, at the bottom of the dialog you will see Default Template file. Click on Change and navigate to the template I provided with the install.

Then you can choose a template and start from there.

It works for me this is what I get when I paste to clipboard from the default template:

[joesaliba]

Thank you John,

I will try it.

Regards

Joseph

[johngb]

As I have had no comments save from Tim on Easy Header I take it that there is little interest in the application. I will not, therefore, be publishing updates or maintaining this product beyond its current beta.

I will be updating it for my own use as and when I see fit. If there are users out there who would like to see updates, please PM me and I will endeavour to keep you up to date.

[Tasos Stratis]

Thank you very much also for this nice application, now understend how it works

You will keep us organize

Wheel Done ! ! !

[DaveS]

Sorry John I’m as guilty as the rest, I did mean to post a report early, but was trying to repeat an error that occurred with Easy Header, (floating point error divide by 0).

Problem found
The problem is settings dialog doesn't update registry, I edited the reg to point to an Easy Header template file now alls okay & can change to a different file.
Conclusion plug needs to a valid path to work cannot handle a blank entry.

I have done the same myself when modifying code related to the registry.

As for improvements button to edit template, me be shell to notepad would save writing an editor.

I very useful plug I hope we can persuade you to continue to carry on developing and improving this plug on the forum.

DaveS

[johngb]

Thanks I will sort it out. I only lashed it together to get some feedback on what additional facilities would be useful, I should have called it very beta as you did.

I could add it more automation and intelligence into the program but I wanted a measure of what others would find useful. It would appear that not many comment their code or they haven't bothered to take a closer look at Easy Header.

Can I assume you would be interested in further updates?

[joesaliba]

John,

I already sent you a PM. Yes, I would be interested.

Thank you
Regards

Joseph