Differences between revisions 12 and 15 (spanning 3 versions)
Revision 12 as of 2008-12-19 10:11:05
Size: 1726
Editor: KaiJaeger
Comment:
Revision 15 as of 2009-02-12 08:27:02
Size: 1567
Editor: KaiJaeger
Comment:
Deletions are marked like this. Additions are marked like this.
Line 9: Line 9:
 * Display a help file, satrting with the default topic.  * Display a help file, starting with the default topic.
Line 15: Line 15:
To get details about how to use {{{ShowChmHelp}}}, execute: You can get details about how to use {{{ShowChmHelp}}} with [[ADOC | ADOC ]]; execute:
Line 36: Line 36:
[[attachment:ShowChmHelp.ZIP | (Manage this attachment)]] or get the whole thing from the AplWikiRepository, including the development workspace and the script and maybe more for any development or for running the test cases:
Line 38: Line 38:
'''or''' the whole thing, including the development workspace and the script and maybe more for any development or for running the test cases:

[[http://aplteam2.com/aplwiki/ShowChmhelp?action=AttachFile&do=get&target=ShowChmHelp_Dev.ZIP | Download development stuff (including the script)]]

[[attachment:ShowChmHelp_Dev.ZIP | (Manage this attachment)]]
{{{
svn list svn://aplteam2.com/os/dyalog/ShowChmHelp/tags
}}}

How to display Help Files from APL

ShowChmHelp is part of the CategoryAplApl project.

Overview

This class serves two simple purposes:

  • Display a help file, starting with the default topic.
  • Display a particular (named) topic in a particular help file

You must create an instance before you can use the methods the class is coming with, and you must make sure that the Destructor is called at some point because otherwise APL might crash. This is neither a fault of the class nor of APL, it's simply how the underlying DLL is defined.

You can get details about how to use ShowChmHelp with ADOC; execute:

#.ADOC.Browse #.ShowChmHelp

For a full version history: History

Version Information

Original author:

KaiJaeger

Responsible:

KaiJaeger

Email:

kai@aplteam.com

Current state:

1.0.0

Download

You have two options: you can either download the script for usage:

Download ShowChmFile script right now

or get the whole thing from the AplWikiRepository, including the development workspace and the script and maybe more for any development or for running the test cases:

svn list svn://aplteam2.com/os/dyalog/ShowChmHelp/tags

If you plan to contribute please note that all stuff published as part of the APLAPL project must follow certain APLAPL-specific standards.


CategoryAplApl

ShowChmHelp (last edited 2018-03-03 11:37:59 by KaiJaeger)