APL Wiki|
Size: 2726
Comment: Minor update
|
Size: 974
Comment:
|
| 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) = |
## page was copied from UserCommands/ScriptManager <<TableOfContents>> = User Command "ScriptManager" = |
| Line 5: | Line 6: |
| [[ADOC]] is a utility useful to generate documentation (semi-) automatically from class scripts as well as namespace scripts. | `ScriptManager` (ScriptManager) is a utility useful to manage scripts in a workspace. |
| Line 7: | Line 8: |
| Obviously it makes sense to make ADOC's services available as a User Command. | Obviously it makes sense to make `ScriptManager` available as a User Command. |
| Line 9: | Line 10: |
| This page offers a small class script `ADOC` which is designed to do exactly that. | This page offers a small class script `ScriptManager_UC.dyalog` which is designed to do exactly that. |
| Line 11: | Line 12: |
| == 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. |
Refer to UserCommands/WhereShouldTheyGo for advice how to organize your User Commands. |
| Line 14: | Line 14: |
| 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`. | == Problem with SALT == |
| Line 16: | Line 16: |
| 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`. }}} |
When you get a "Target namespace not found" error reported by SALT but crashing ScriptManager than you are using an outdated version of SALT. Ask Dyalog for a better version of SALT where this bug got fixed. |
| Line 54: | Line 20: |
| [[attachment:ADOC.dyalog | Download]] the script. | [[attachment:ScriptManager_UC.zip | Download]] the script. |
| Line 57: | Line 23: |
| The script is version 1.0.2 from 2010-12-26 | The script is version 1.0.0 from 2011-08-04 |
| Line 61: | Line 27: |
| -- KaiJaeger <<DateTime(2011-08-04T20:13:42Z)>> |
User Command "ScriptManager"
Overview
ScriptManager (ScriptManager) is a utility useful to manage scripts in a workspace.
Obviously it makes sense to make ScriptManager available as a User Command.
This page offers a small class script ScriptManager_UC.dyalog which is designed to do exactly that.
Refer to UserCommands/WhereShouldTheyGo for advice how to organize your User Commands.
Problem with SALT
When you get a "Target namespace not found" error reported by SALT but crashing ScriptManager than you are using an outdated version of SALT. Ask Dyalog for a better version of SALT where this bug got fixed.
Download
Download the script.
Version
The script is version 1.0.0 from 2011-08-04
Author: KaiJaeger
-- KaiJaeger 2011-08-04 20:13:42