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-03-05 14:54:08
Size: 1399
Editor: KaiJaeger
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= User Command ADOC (Dyalog) = <<TableOfContents>>

= User Command "Latest" =

/!\ This page is under construction
Line 5: Line 9:
[[ADOC]] is a utility useful to generate documentation (semi-) automatically from class scripts as well as namespace scripts. This User Command prints the fully qualified names of functions and operators together with time stamps and the user name to the session, sorted by time stamp (oldest first).
Line 7: Line 11:
Obviously it makes sense to make ADOCs services available as a User Command. Note that fns/opr in scripted namespaces are '''execluded'''. In the context of a command latest they don't offer real value since they all get the same time stamp when the script gets fixed. This is more often misleading than useful.
Line 9: Line 13:
This page offers a small class script `ADOC` which is designed to do exactly that. The following is a sample session taken in the workspace "wtutor95" every Dyalog installation is coming with.
Line 11: Line 15:
== 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:
An empty vector means ALL fns/opr:
Line 24: Line 17:
      ]?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
      ]q←Latest ⍬
      ⍴q
1 111
Line 46: Line 22:
A positive integer n is treated as "report n fns/opr changed most recently:
{{{
      ]Latest2 6
 #.DRAG 2000.08.14 11:09:27 Dyadic
 #.DOCKACCEPT 2000.08.15 10:17:15 Dyadic
 #.MAKE_Tutor 2003.03.17 13:54:39 Dyadic
 #.SET_TAB_STOPS 2003.03.17 13:54:59 Dyadic
 #.BMPDIR 2003.03.17 13:55:10 Dyadic
 #.TOPIC 2003.03.17 14:17:31 Dyadic

}}}

== Download ==

[[attachment:Latest.zip | Download]] the script and the workspace.

== Version ==
The script is version 1.0.0 from 2012-03-05
Line 47: Line 42:

-- KaiJaeger <<DateTime(2012-03-05T14:37:53Z)>>

User Command "Latest"

/!\ This page is under construction

Overview

This User Command prints the fully qualified names of functions and operators together with time stamps and the user name to the session, sorted by time stamp (oldest first).

Note that fns/opr in scripted namespaces are execluded. In the context of a command latest they don't offer real value since they all get the same time stamp when the script gets fixed. This is more often misleading than useful.

The following is a sample session taken in the workspace "wtutor95" every Dyalog installation is coming with.

An empty vector means ALL fns/opr:

      ]q←Latest ⍬                 
      ⍴q
1 111

A positive integer n is treated as "report n fns/opr changed most recently:

      ]Latest2 6
 #.DRAG           2000.08.14 11:09:27  Dyadic 
 #.DOCKACCEPT     2000.08.15 10:17:15  Dyadic 
 #.MAKE_Tutor     2003.03.17 13:54:39  Dyadic 
 #.SET_TAB_STOPS  2003.03.17 13:54:59  Dyadic 
 #.BMPDIR         2003.03.17 13:55:10  Dyadic  
 #.TOPIC          2003.03.17 14:17:31  Dyadic 

Download

Download the script and the workspace.

Version

The script is version 1.0.0 from 2012-03-05

Author: KaiJaeger

-- KaiJaeger 2012-03-05 14:37:53


CategoryDyalogUserCommands