KeywordDocumenter, optional tool to document module keywords

[Petr Schreiber]

This is work in progress tool for documenting your modules.

Its description is available in ReadMe.TXT:


Document revision from 27-02-2011

KeywordDocumenter.tbasic
=========================

Tool to help with documenting keywords, while preserving "neutral" data format, post processable to HTML or other formats.

How to use?

- Fill description
- Fill syntax
- Choose return type or add your own
- Press "Auto fill" to get prefilled template for parameters
- Fill other fields
- Press "Save", it will create file named after the keyword
- Press "Clear all" and go for other keyword :)


Make_All.bat
============

This batch file, as its name says, will "Make all". That means it will first ask you for information such as name, version and support website for your library, and then it will automatically generate HTML files from your previously created keyword definitions.

Once finished with documenting, run this file to generate HTML to HTMLOutput directory.


To compose the final CHM help file, you need to download Microsoft HTML Help Workshop (http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en)

May the tool serve you well :)


Petr

UPDATED: 27-02-2011

[D.J.Peters]

hello Petr
i tryed your tool i like it good job.

thanx for that

Joshy

[Petr Schreiber]

Thanks Joshy,

it is possible it has still hardcoded some of TBGL related stuff, like copyright message inside.
But the rest should work fine.


Petr

[D.J.Peters]

i never used the help workshop before
must i create for every created *.html file an topic item to create a compiled *.chm file ?

Joshy

[Petr Schreiber]

Yes,

but if you closely examine the structure of table of contents file, you can see it can be easily generated by script, as it is some kind of HTML. The IDE of HTML Help Workshop is very unstable, I recommend to create scripts autogenerating the TOC for you, and use the HHW just for compiling.


Petr

[Petr Schreiber]

New version uploaded,

removed some TBGL specific parts and fixed autofill bug.


Petr

[kryton9]

A good idea and nice simple interface Petr. Looks good. I didn't use it but looked at the image. If I ever make a module, it will be something of great help, thanks.