Help Authoring

Suggestions and bug reports forum for Ams Plugin Maker
Post Reply
User avatar
Shrek
Registered User
Posts: 49
Joined: Mon Aug 12, 2013 10:10 pm

Help Authoring

Post by Shrek »

Getting the source to the compiled help would help with editing it afterwards to add custom images and url's.

On the Index section options not filed in become N/A, it would be better to not create any reference at all if its not needed.

Being able to pick a colour other than orange would be good.

In the code example publishing the code with syntax highlighting would be an improvement.

In the code example the description is mandatory, it might be better if it's optional.
User avatar
Serkan
Developer
Developer
Posts: 214
Joined: Thu Jul 04, 2013 8:44 pm
Location: Windows.h
Contact:

Post by Serkan »

Shrek wrote:Getting the source to the compiled help would help with editing it afterwards to add custom images and url's.
maybe an option can be added to keep a copy of generated help files (html,hhc,hpp ,css)

but , APM installs HTML Help WorkShop as a dependency , and you can use it to decompile generated help file (chm) and then recompile after made desired chages
you can use this option for now
Shrek wrote: On the Index section options not filed in become N/A, it would be better to not create any reference at all if its not needed.
it was in the todo list for ver1.1 but somehow it is forgotten , it will be fixed in next version
Shrek wrote:
In the code example publishing the code with syntax highlighting would be an improvement.
Thanks for suggestion , syntax highlighting to sample codes will be added to next version
Shrek wrote:
In the code example the description is mandatory, it might be better if it's optional.
Thanks for suggestion , it will be optional in next version
User avatar
Shrek
Registered User
Posts: 49
Joined: Mon Aug 12, 2013 10:10 pm

Post by Shrek »

Great stuff, one more thing, setting the help window title to 'My Plugin Help' would be better than the 'HTML Help' that appears.
madolak
Registered User
Posts: 35
Joined: Sun Sep 08, 2013 9:59 am
Contact:

Post by madolak »

Hello shrek
You can use "Softnay WinCHM Pro 4.3"
That is very powerful software to create and edit CHM file
You can import your "chm help file" and edit that html code
by
User avatar
Shrek
Registered User
Posts: 49
Joined: Mon Aug 12, 2013 10:10 pm

Post by Shrek »

Thanks, I was testing this:

www.chmeditor.com/

but will give yours a try too.
Post Reply