AutoHotkey Community

[majkinetor]

 

Natural Docs Custom Installer

This is custom installer for Natural Docs, that can be used for AHK script documentation. Wiith it you don't have to think about installing natural docs prerequisites.

Installation

All you have to do is to unpack archive to the directory of your choice and execute Install.exe. After that you are ready to use it.

Usage

The documentation is generated in the _doc folder after you execute mkdoc in it. It will be created for all ahk and ndoc files in that folder and its subfolders.
After installation start console in the folder with your AHK scriipts and type mkdoc. This will create documentation for all scripts in that folder.

If you type mkdoc s that will create single html files for each ahk script.

If you have images, put them in the root of the script, or in \images folder.


Download:

• Compiled (~2MB archive, ~3MB on disk)
  
• Non compiled (~12MB archive, 46MB on disk)
  


You should use compiled version generaly as it is standalone, doesn't require nor Perl nor AutoHotKey as you may want to use Natural Docs for non-AHK related documentation. Non-Compiled version is there for people who would like to tweak modules by their own needs.

Links:

• Making Ndoc to work with AHK
  
• Natural Docs Homepage
  
• How to document
  
• Example of generated documentation and source for it

_________________

[majkinetor]

I found time to remove some unused Perl libraries.
Now, unpacked version is 7MB, packed 2MB.
_________________

[kiropes]

when I perform cmd mkdoc
I have this error:

[Andreone]

[majkinetor]

Yes.
If Perl is already detected in PATH, nothing is added. If you have perl reference in the PATH and you don't have perl, that means you probably uninstalled it once and didn't remove perl fromt the PATH.

Keep in mind to restart your frontend app when you finish installing. For instance, if you install custom installer from Total Commander, TC will still have old env vars after installation is finished, so you have to restart TC to so it refreshes env vars. This can be pretty long chain, if you have non Microsfot launchers like DesktopX (in this case, both DesktopX and TC have to be restarted...)

Anyway, the custom installer currently doesn't work. It seems I removed too many libraries to reduce its size. I will probably fix it today.
_________________

[majkinetor]

I fixed installer and now it works.

Also, there is a question now wether to add perl in PATH env var if it is found there, so that may fix initial problems with users that uninstalled Perl before using custom installer.
_________________

[majkinetor]

This is AHK script for merging NDoc HTML parts into the single html file (so no more MHT docs)

mkdocs.ahk

[Rabiator]

I installed the actual version of the installer, following the instructions of your first posting.

Now I get the following message, and I can't figure out the reason:

[majkinetor]

Ye, i screwed package a bit, didn't fix it yet. It seems I removed more libraries from Perl then NDoc uses it. It was a stupid thing to do anyway, just for those ppl who can't afor to have 40MB more wasted on perl...

Just download Perl and copy it in Ndoc\Perl folder to fix it.

Or wait for latest code with latest NDoc which is significantly upgraded and have support for images in help, superb Ajax search etc... I also added option to create single HTML file without ndoc project data by running "mkdoc s" (s as single html).
_________________

[Rabiator]

Thanks.
With Perl 5.10 (17 MB) and Natural Docs 1.4 it works like a charm!
I like the ability to include images as shown in your Common Dialogs documentation .
__________________________________________
Created with BBCodeWriter 7.0 - the one and only

[majkinetor]

I finally uploaded new version of custom installer. Its back to old good 12MB archive and now it can be used in directories with long names, you have "s" parameter to create single HTML and new Natural Docs that support images and Ajax search. Just put images in "\images" folder, or in root folder directly. To add them to code use "(see image.png)" Ndoc tag.
_________________

[majkinetor]

Entirely new version.

I managed to compile Natural Docs into exe. Now you don't need to have Perl on your machine, and size on the disk droped from 46MB to 3MB.

I also made special extension *.ndoc that you can use to create any kind of documentation this way. It works the same as *.ahk files but it is there so you don't confuse your arbitrary documentation with ahk scripts.

Also, AHK is not required any more.
_________________