Differences between revisions 5 and 10 (spanning 5 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.Selfy 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 5 as of 2014-09-13 10:24:57 → 
  Size: 1482
  Editor: KaiJaeger
  Comment:
+   ← Revision 10 as of 2015-02-02 13:04:58 → ⇥
  Size: 1795
  Editor: KaiJaeger
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 11:
-This application allows you to create a CHM-like help file (including an "Index" and a "Search" tab) by simply creating direct function returning text according to a simple set of rules. This makes you completely independent from any 3rd-party tools for creating and maintaining help files.
+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 15:
-This is how `APLTreeHelp`'s own help page looks like:
+This is what `APLTreeHelp`'s own help page looks like:

{{attachment:APLTreeHelp_01.png}}
-Line 23:
+Line 25:
-If you want to investigate `APLTreeHelp`'s own help pages look into `#.APLTreeHelp.HelpHelp` via the Workspace Explorer and it becomes clear.
+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}}
-Line 26:
+Line 36:
+== Requirements ==

`APLTreeHelp` needs at least version 14.0.