Differences between revisions 1 and 23 (spanning 22 versions)
Revision 1 as of 2009-10-20 19:38:59
Size: 1781
Editor: KaiJaeger
Comment:
Revision 23 as of 2012-03-05 14:36:28
Size: 974
Editor: KaiJaeger
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= User Command ADOC (Dyalog) = ## page was copied from UserCommands/ScriptManager
<<TableOfContents>>
Line 3: Line 4:
= User Command "ScriptManager" =
Line 4: Line 6:
`ScriptManager` (ScriptManager) is a utility useful to manage scripts in a workspace.
Line 5: Line 8:
[[ADOC]] is a utility useful to generate documentation (semi-) automatically from class scripts as well as namespace scripts. Obviously it makes sense to make `ScriptManager` available as a User Command.
Line 7: Line 10:
Obviously it makes sense to make ADOCs services available as a User Command. This page offers a small class script `ScriptManager_UC.dyalog` which is designed to do exactly that.
Line 9: Line 12:
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.
Line 11: Line 14:
== Assumptions == == Problem with SALT ==
Line 13: Line 16:
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. 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 15: Line 18:
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`. == Download ==
Line 17: Line 20:
The script '''ADOC''' attached to this page needs to go into `SALT\SPICE` [[attachment:ScriptManager_UC.zip | Download]] the script.
Line 19: Line 22:
== 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

      ]?ADOC.List
Command "ADOC.List".
Script location: ........\SALT\Spice\ADOC
Prints a list with all sorts of information to the session

]ADOC.Browse ADOC -b=Opera
Watch your browser
}}}
== Version ==
The script is version 1.0.0 from 2011-08-04
Line 47: Line 26:

-- 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


CategoryDyalogUserCommands