Differences between revisions 1 and 19 (spanning 18 versions)
⇤ ← Revision 1 as of 2009-10-20 19:38:59 →
Size: 1781
Editor: KaiJaeger
Comment:
← Revision 19 as of 2011-08-04 20:13:42 → ⇥
Size: 2598
Editor: KaiJaeger
Comment: New User Command
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= User Command ADOC (Dyalog) = <<TableOfContents>>
Line 3: Line 3:
= User Command ScriptManager (Dyalog) =
Line 4: Line 5:
`ScriptManager` (ScriptManager) is a utility useful to manage scripts in a workspace.
Line 5: Line 7:
[[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 9:
Obviously it makes sense to make ADOCs services available as a User Command.

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 12: Line 12:
In order to make `ScriptManager` available as a user command the script `ScriptManager_UC.dyalog` ("UC" for User Command) attached to this page must go somewhere where Dyalog is able to find it. There are to options:
Line 13: Line 14:
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.  * Move it into `Salt\Spice` inside the Dyalog installation folder. That's where the Dyalog User Commands are located.
 * Create a particular folder for your own User Commands.
Line 15: Line 17:
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`. Although the first option is certainly easier, it's actually the second one which is recommended. There are a couple of reasons:
Line 17: Line 19:
The script '''ADOC''' attached to this page needs to go into `SALT\SPICE`  * Messing Dyalog scripts with your scripts is not a good idea.
 * When a new version of Dyalog arrives you are in trouble.
 * Having a separate folder for your own User Commands allows you to overwrite a Dyalog User Command with an improved version you are not going to loose in case of an update or a new version.
Line 19: Line 23:
== Samples == To make your own User Command folder work you have to do a couple of things:
Line 21: Line 25:
Given that the two different ADOC scripts went into the right folders, this would be a sample session:  1. Add the folder to the SALT search path.
 1. Create another folder which is going to host the "real thing". A recommended name is "!UserCommandCode".
 1. Copy the script `ScriptManager_UC.dyalog` from the ScriptManager page into that folder.
 1. Create a registry entry pointing to that new folder with the name `HKEY_CURRENT_USER\Software\Dyalog\Dyalog APL/W 12.1 Unicode\SALT\CodeFolder`
Line 23: Line 30:
{{{
      ]?ADOC
"??" for general help, "?CMD" for more specific info on command CMD		 Note that the script attached to this page only deals with one issue: find the real work horse and call it, see below.
Line 27: Line 32:
 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		 In order to achieve that the script `ScriptManager_UC.dyalog` reads the `HKEY_CURRENT_USER\Software\Dyalog\Dyalog APL/W 12.1 Unicode\SALT\CodeFolder` from the Windows registry. It then tries to load the "real" `ScriptManager` script from that folder.
Line 32: Line 34:
      ]?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		 Note that not only our examples given on this page but also the code in `ScriptManager_UC.dyalog` all refer to version 12.1 Unicode of Dyalog. If your are using a different version of Dyalog of course you must change the script, otherwise it's not going to work.
Line 37: Line 36:
      ]?ADOC.List
Command "ADOC.List".
Script location: ........\SALT\Spice\ADOC
Prints a list with all sorts of information to the session		 == Download ==
Line 42: Line 38:
]ADOC.Browse ADOC -b=Opera
Watch your browser
}}}		 [[attachment:ScriptManager_UC.zip | Download]] the script.

== Version ==
The script is version 1.0.0 from 2011-08-04
Line 47: Line 44:

-- KaiJaeger <<DateTime(2011-08-04T20:13:42Z)>>

Contents

  1. User Command ScriptManager (Dyalog)
    1. Overview
    2. Assumptions
    3. Download
    4. Version

User Command ScriptManager (Dyalog)

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.

Assumptions

In order to make ScriptManager available as a user command the script ScriptManager_UC.dyalog ("UC" for User Command) attached to this page must go somewhere where Dyalog is able to find it. There are to options:

  • Move it into Salt\Spice inside the Dyalog installation folder. That's where the Dyalog User Commands are located.

  • Create a particular folder for your own User Commands.

Although the first option is certainly easier, it's actually the second one which is recommended. There are a couple of reasons:

  • Messing Dyalog scripts with your scripts is not a good idea.
  • When a new version of Dyalog arrives you are in trouble.
  • Having a separate folder for your own User Commands allows you to overwrite a Dyalog User Command with an improved version you are not going to loose in case of an update or a new version.

To make your own User Command folder work you have to do a couple of things:

  1. Add the folder to the SALT search path.

  2. Create another folder which is going to host the "real thing". A recommended name is "UserCommandCode".

  3. Copy the script ScriptManager_UC.dyalog from the ScriptManager page into that folder.

  4. Create a registry entry pointing to that new folder with the name HKEY_CURRENT_USER\Software\Dyalog\Dyalog APL/W 12.1 Unicode\SALT\CodeFolder

Note that the script attached to this page only deals with one issue: find the real work horse and call it, see below.

In order to achieve that the script ScriptManager_UC.dyalog reads the HKEY_CURRENT_USER\Software\Dyalog\Dyalog APL/W 12.1 Unicode\SALT\CodeFolder from the Windows registry. It then tries to load the "real" ScriptManager script from that folder.

Note that not only our examples given on this page but also the code in ScriptManager_UC.dyalog all refer to version 12.1 Unicode of Dyalog. If your are using a different version of Dyalog of course you must change the script, otherwise it's not going to work.

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