APL Wiki|
Size: 2887
Comment: Documentation improved
|
Size: 1816
Comment: New version of th ADOC script added
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## page was renamed from UserCommand_Adoc ## page was renamed from UserCommandAdoc = User Command ADOC (Dyalog) = |
= User Command ADOC = |
| Line 11: | Line 9: |
| == 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. Note that this script only deal with two issues: * Figure out what command the user want to invoke, "Browse" or "List". * Find the real work horse and call it, see below. 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 real [[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 Dyalog APL 32bit 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`. |
Refer to UserCommands/WhereShouldTheyGo for advice how to organize your User Commands. |
| Line 25: | Line 15: |
| ]?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.HELP Displays help regarding ADOC. ADOC.List Prints syntax of all public stuff to the session. ]?ADOC.Browse Command "ADOC.Browse". Syntax: 1 arguments; accepts switches -b= Script location: ........\....\....\ADOC Gathers information from a class script, compiles an HTML page with these pieces of information and displays it in your default browser. |
|
| Line 43: | Line 16: |
| Command "ADOC.List". Script location: ........\...\...\ADOC |
Command "ADOC.List". Syntax: 1 arguments; accepts switches -full Script location: C:\UserCommands\ADOC_UC |
| Line 49: | Line 22: |
| ]ADOC.Help Watch your browser |
]?ADOC.Browse Command "ADOC.Browse". Syntax: accepts switches -caption= -browser= Script location: C:\UserCommands\ADOC_UC Gathers all sort of information from a class script and compiles an HTML page from it which is then displayed with your default browser. Examples: ]ADOC.Browse ADOC ⍝ Single class ]ADOC.Browse ADOC,WinFile ⍝ Two classes, no blank in between! ]ADOC.Browse ADOC,WinFile -caption="My Doc" ]ADOC.Browse ADOC,WinFile -caption="My Doc" browser="c:\opera.exe Available switches: -caption="Your caption" -browser="full path to a browser which is not your default one" ]ADOC.Help |
| Line 57: | Line 47: |
| [[attachment:ADOC.dyalog | Download]] the script. | [[attachment:ADOC_UC.zip | Download]] the script. |
| Line 60: | Line 50: |
| The script is version 1.0.3 from 2011-01-24 | The User Command script is version 1.5.0 from 2015-04-04. The ADOC script is version 4.0.1 from 2015-04-14. |
User Command ADOC
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.
Refer to UserCommands/WhereShouldTheyGo for advice how to organize your User Commands.
Samples
Given that the two different ADOC scripts went into the right folders, this would be a sample session:
]?ADOC.List
Command "ADOC.List". Syntax: 1 arguments; accepts switches -full
Script location: C:\UserCommands\ADOC_UC
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.Browse
Command "ADOC.Browse". Syntax: accepts switches -caption= -browser=
Script location: C:\UserCommands\ADOC_UC
Gathers all sort of information from a class script and
compiles an HTML page from it which is then displayed
with your default browser.
Examples:
]ADOC.Browse ADOC ⍝ Single class
]ADOC.Browse ADOC,WinFile ⍝ Two classes, no blank in between!
]ADOC.Browse ADOC,WinFile -caption="My Doc"
]ADOC.Browse ADOC,WinFile -caption="My Doc" browser="c:\opera.exe
Available switches:
-caption="Your caption"
-browser="full path to a browser which is not your default one"
]ADOC.Help
Shows extensive information about ADOC. It's basically doing `ADOC.Browse ADOC`.
Download
Download the script.
Version
The User Command script is version 1.5.0 from 2015-04-04. The ADOC script is version 4.0.1 from 2015-04-14.
Author: KaiJaeger