Differences between revisions 1 and 13 (spanning 12 versions)

APLTreeHelp

(Show (Hide table-of-contents) table-of-contents)

Contents

APLTreeHelp

APLTreeHelp is part of the CategoryAplTree project.

Overview

This application allows you to create a CHM-like help file (including an "Index" and a "Search" tab) by simply creating direct functions returning text according to a set of simple rules. This makes you completely independent from any 3rd-party tools for creating and maintaining help files.

It has the benefit of allowing you to edit your help pages while developing or tracing your application.

This is what APLTreeHelp's own help page looks like:

To give it a try just download APLTreeHelp, unzip it, load it into a Dyalog session and call this function:

      #.APLTreeHelp.Selfie 1

If you want to investigate APLTreeHelp's own help pages look into #.APLTreeHelp.HelpHelp via the Workspace Explorer and it becomes clear:

Note how the namespaces reflect nodes and the functions reflect help topics.

This is what a typical help function looks like:

There will be soon an article in Vector regarding APLTreeHelp.

Requirements

APLTreeHelp needs at least version 14.0.

Project Page

For bug reports, future enhancements and a full version history see APLTreeHelp/ProjectPage

Version Information

Original author:	KaiJaeger
Responsible:	KaiJaeger
Email:	kai@aplteam.com

CategoryAplTree

-  ⇤ ← Revision 1 as of 2014-08-21 16:44:01 → 
  Size: 762
  Editor: KaiJaeger
  Comment:
+   ← Revision 13 as of 2016-06-15 21:11:33 → ⇥
  Size: 1833
  Editor: KaiJaeger
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
-= APLTreeHelp| APLTreeHelp on the APL Wiki =
+## page was copied from APLTreeHelp
## page was renamed from APLTreeHelp| APLTreeHelp on the APL Wiki
= APLTreeHelp =
-Line 6:
+Line 8:
-`APLTreeHelp| APLTreeHelp on the APL Wiki` is part of the CategoryAplTree project.

||  /!\ || Under Construction ||
+`APLTreeHelp` is part of the CategoryAplTree project.
 Line 11:
-...
-Line 13:
+Line 12:
-== Details ==
...
+This application allows you to create a CHM-like help file (including an "Index" and a "Search" tab) by simply creating direct functions returning text according to a set of simple rules. This makes you completely independent from any 3rd-party tools for creating and maintaining help files.
-Line 16:
+Line 14:
+It has the benefit of allowing you to edit your help pages while developing or tracing your application.
-Line 17:
+Line 16:
-== Examples ==
...
+This is what `APLTreeHelp`'s own help page looks like:

{{attachment:APLTreeHelp_01.png}}

To give it a try just download `APLTreeHelp`, unzip it, load it into a Dyalog session and call this function:

{{{
      #.APLTreeHelp.Selfie 1
}}}

If you want to investigate `APLTreeHelp`'s own help pages look into `#.APLTreeHelp.HelpHelp` via the Workspace Explorer and it becomes clear:

{{attachment:APLTreeHelp_02.png}}

Note how the namespaces reflect nodes and the functions reflect help topics.

This is what a typical help function looks like:

{{attachment:APLTreeHelp_03.png}}

There will be soon an article in Vector regarding `APLTreeHelp`. 

== Requirements ==

`APLTreeHelp` needs at least version 14.0.
-Line 22:
+Line 44:
-For bug reports, future enhancements and a full version history see [[APLTreeHelp| APLTreeHelp on the APL Wiki/ProjectPage]]
+For bug reports, future enhancements and a full version history see [[APLTreeHelp/ProjectPage]]
-Line 29:
+Line 51:
-<<Include(AplTreeDownloads)>>
+<<Include(APLTreeDownloads)>>