Natural Docs Custom Installer

Summary
Natural Docs Custom Installer
OverviewThis is custom installer for natural docs code generation language.
InstallationUnpack archive to the directory of your choice and execute Install.exe.
How to useThe documentation is generated in the _doc folder after you execute mkdoc in it.
Links
About

Overview

This is custom installer for natural docs code generation language.

If you have compiled version this installation

  • Created mkdoc batch script and added its parent folder to the machine PATH.
  • Added pre-installed Natural Docs for *.ahk and *.ndoc files, compiled with perl2exe so it doesn’t require Perl installation.

If you have non-compiled version this installation

  • Installed Perl.
  • Updated appropriate environment variables.
  • Created mkdoc batch script and added its parent folder to the machine PATH.
  • Added pre-installed Natural Docs for *.ahk and *.ndoc files.

Installation

Unpack archive to the directory of your choice and execute Install.exe.

How to use

The documentation is generated in the _doc folder after you execute mkdoc in it.  That will create documentation for all ahk and ndoc files in that folder and its subfolders.  *.ndoc extension should be used for non-ahk related documentation.

After installation start console in the folder with your AHK scripts and type

mkdoc

or

mkdoc s

First command creates documentation in the _doc folder.  Inside it, you will find index.html which contains root document of the documentation system for all documents created.  This system includes menu, index, glosary and ajax search engine.

S option will create single documentation file without menu and search engine.  It doesn’t create _doc folder and names the documentation file by the same name as the script.

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

If you want to tweak Naturl Docs project file, it is located in _doc\_ndProj sub-folder.  For instance, you can change order of the menu items by editing Menu.txt.  See Natural Docs Customization section online for details.

About

  • Version 1.1-c by majkinetor
  • AHK CSS Style by freakkk
Close