Differences between revisions 1 and 26 (spanning 25 versions)
Revision 1 as of 2009-10-20 19:38:59
Size: 1781
Editor: KaiJaeger
Comment:
Revision 26 as of 2012-11-01 20:37:14
Size: 563
Editor: KaiJaeger
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= User Command ADOC (Dyalog) = = User Command "Fire" =
Line 4: Line 4:
Fire is a powerful utility designed to search and replace strings in a workspace. Fire stands for FInd and REplace.
Line 5: Line 6:
[[ADOC]] is a utility useful to generate documentation (semi-) automatically from class scripts as well as namespace scripts. Fire is designed to be used as a User Command. Therefore the User Command script is part of the download of Fire itself. See [[Fire]] for details.
Line 7: Line 8:
Obviously it makes sense to make ADOCs services available as a User Command. == Version ==
The script is version 1.4.1 from 2012-11-01
Line 9: Line 11:
This page offers a small class script `ADOC` which is designed to do exactly that.

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

== 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
}}}
You can download just the script from this page: [[attachment:Fire__UC.dyalog]]
Line 47: Line 14:

-- KaiJaeger <<DateTime(2012-03-21T09:03:31Z)>>

User Command "Fire"

Overview

Fire is a powerful utility designed to search and replace strings in a workspace. Fire stands for FInd and REplace.

Fire is designed to be used as a User Command. Therefore the User Command script is part of the download of Fire itself. See Fire for details.

Version

The script is version 1.4.1 from 2012-11-01

You can download just the script from this page: Fire__UC.dyalog

Author: KaiJaeger

-- KaiJaeger 2012-03-21 09:03:31


CategoryDyalogUserCommands

UserCommands/fire (last edited 2019-05-30 07:57:07 by KaiJaeger)