APL Wiki|
Size: 2232
Comment:
|
Size: 2726
Comment: Minor update
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## page was renamed from UserCommand_Adoc | |
| Line 3: | Line 4: |
| Line 5: | Line 5: |
| Line 8: | Line 7: |
| Obviously it makes sense to make ADOCs services available as a User Command. | Obviously it makes sense to make ADOC's services available as a User Command. |
| Line 13: | Line 12: |
| Line 16: | Line 14: |
| That script, which represents the ADOC User Command, assumes that there is a sibling folder of `SALT` available named `UserCommands`. Please make sure that the [[ADOC]] script is copied into this folder `UserCommands`. This enables the User Command script to address the real ADOC script as `..\UserCommands\ADOC`. | That script, which represents the ADOC User Command, assumes that there is a sibling folder of your APL installation folder available named `UserCommands`. Please make sure that the [[ADOC]] script is copied into this folder `UserCommands`. This enables the User Command script to address the '''real''' ADOC script `{MyDyalogInstallationFolder}..\UserCommands\ADOC`. For example, in case your version of APL is installed in `C:\Program Files (x86)\Dyalog\Dyalog APL 12.1 Unicode` which is the default on Windows 7 64 bit, then the folder `UserCommands` is supposed to be located at `C:\Program Files (x86)\Dyalog\UserCommands`. |
| Line 19: | Line 19: |
| Line 47: | Line 46: |
| ]ADOC.Browse ADOC -b=Opera | ]ADOC.Help |
| Line 49: | Line 48: |
Shows extensive information about ADOC. It's basically doing `ADOC.Browse ADOC`. |
|
| Line 51: | Line 52: |
| == Download == [[attachment:ADOC.dyalog | Download]] the script. |
|
| Line 52: | Line 57: |
The scripts is version 1.0 from 2009-10-20 |
The script is version 1.0.2 from 2010-12-26 |
| Line 56: | Line 60: |
User Command ADOC (Dyalog)
Overview
ADOC is a utility useful to generate documentation (semi-) automatically from class scripts as well as namespace scripts.
Obviously it makes sense to make ADOC's services available as a User Command.
This page offers a small class script ADOC which is designed to do exactly that.
Assumptions
When User Commands got introduced in Dyalog with version 12.1, the User Commands where expected to reside in a sub folder Salt\Spice inside the Dyalog installation folder. This means that the script ADOC.dyalog attached to this page must go into this directory. Only then the User Commd "ADOC" is recognized.
That script, which represents the ADOC User Command, assumes that there is a sibling folder of your APL installation folder available named UserCommands. Please make sure that the ADOC script is copied into this folder UserCommands. This enables the User Command script to address the real ADOC script {MyDyalogInstallationFolder}..\UserCommands\ADOC.
For example, in case your version of APL is installed in C:\Program Files (x86)\Dyalog\Dyalog APL 12.1 Unicode which is the default on Windows 7 64 bit, then the folder UserCommands is supposed to be located at C:\Program Files (x86)\Dyalog\UserCommands.
Samples
Given that the two different ADOC scripts went into the right folders, this would be a sample session:
]?ADOC
"??" for general help, "?CMD" for more specific info on command CMD
Group Name Description
===== ==== ===========
ADOC ADOC.Browse Creates full documentation and displayes it in the default browser
ADOC.List Prints syntax of all public stuff to the session
]?ADOC.Browse
Command "ADOC.Browse". Syntax: 1 arguments; accepts switches -b=
Script location: ........\SALT\Spice\ADOC
Gathers all sort of information from a class script,
compiles an HTML page with these pieces of information
and displays it in a browser. Use the -b flag to specify
a browser different from your default browser.
]?ADOC.List
Command "ADOC.List".
Script location: ........\SALT\Spice\ADOC
Prints a list with all sorts of information to the session
about all public stuff given in the script specified in the right argument
]ADOC.Help
Watch your browser
Shows extensive information about ADOC. It's basically doing `ADOC.Browse ADOC`.
Download
Download the script.
Version
The script is version 1.0.2 from 2010-12-26
Author: KaiJaeger