APL Wiki|
Size: 1781
Comment:
|
Size: 1765
Comment: New version
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = User Command ADOC (Dyalog) = |
= User Command ADOC = |
| Line 4: | Line 3: |
| Line 7: | Line 5: |
| 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 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. The ADOC User Command assumes that there is a sibling folder of `SALT` 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`. The script '''ADOC''' attached to this page needs to go into `SALT\SPICE` |
Refer to UserCommands/WhereShouldTheyGo for advice how to organize your User Commands. |
| Line 20: | Line 12: |
| Line 24: | Line 15: |
| ]?ADOC "??" for general help, "?CMD" for more specific info on command CMD |
]?ADOC.List Command "ADOC.List". Syntax: 1 arguments; accepts switches -full Script location: C:\UserCommands\ADOC_UC |
| Line 27: | Line 19: |
| 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 |
Prints a list with all sorts of information to the session about all public stuff given in the script specified in the right argument |
| Line 33: | Line 23: |
| Command "ADOC.Browse". Syntax: 1 arguments; accepts switches -b= Script location: ........\SALT\Spice\ADOC Gathers all sort of information from a class script |
Command "ADOC.Browse". Syntax: accepts switches -caption= -browser= Script location: C:\UserCommands\ADOC_UC |
| Line 37: | Line 26: |
| ]?ADOC.List Command "ADOC.List". Script location: ........\SALT\Spice\ADOC Prints a list with all sorts of information to the session |
Gathers all sort of information from a class script and compiles an HTML page from it which is then displayed with your default browser. |
| Line 42: | Line 30: |
| ]ADOC.Browse ADOC -b=Opera Watch your 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`. |
| Line 46: | Line 45: |
| == Download == [[attachment:ADOC_UC.zip | Download]] the script. == Version == The User Command script is version 1.6.0 from 2015-10-06. |
|
| Line 47: | Line 53: |
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.6.0 from 2015-10-06.
Author: KaiJaeger