AutoHotkey Community

 

Natural Docs Custom Installer
Custom installer for Natural Docs, that can be used for AHK script documentation.

Download         Documentation





Links:

• Non-Compiled version
  Non-Compiled version is there for historical reasons, as a base for future versions and for people who would like to additional tweak modules.
  Download non-compiled (~12MB archive, 46MB on disk)
  
• See how documentation looks like - full, ahk style (created with mkdoc) or single, default style (created with "mkdoc s")
• Natural Docs Homepage
• How to document
• Making Ndoc to work with AHK

_________________

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

_________________

when I perform cmd mkdoc
I have this error:




I don't understand

So, you have to manually add to your PATH environment variable the directory where perl.exe is installed.

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.

_________________

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.

_________________

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

mkdocs.ahk


If you run this in scripts dir after running mkdoc, you will get single html file as documentation. You can also merge it with mkdoc.bat by adding at its end:


Then instead mkdoc you can type mkdoc s to make documentation and merge files at the same time. You must put mkdocs.ahk at the same location as mkdoc.bat

_________________

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:

Before installing it I removed all path entries referring to perl.
The former package worked fine.

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).

_________________

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

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.

_________________

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.

_________________

This is Incredibly awesome and useful! It worked like a charm...
Thanks majkinetor!

_________________
-Ace

*** version 1-1.c ***
+ Added AHK.css style and set to be default. Created by freakkk. You can use any other style by renaming them to Default.css.
+ Instalation improved.


You can see how new style looks here.

_________________

Sillent update:
- AHK style tweaks.

_________________