APL Wiki|
Size: 1660
Comment:
|
Size: 799
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = ShowChmHelp = | = How to display Help Files from APL = <<TableOfContents>> {{{ShowChmHelp}}} is part of the CategoryAplTree project. |
| Line 7: | Line 11: |
| * Display a help file, satrting with the default topic. | * Display a help file, starting with the default topic. |
| Line 13: | Line 17: |
| To get details about how to use {{{ShowChmHelp}}}, execute: | You can get details about how to use {{{ShowChmHelp}}} with the [[ADOC | ADOC ]] user command; execute: |
| Line 16: | Line 20: |
| #.ADOC.Browse #.ShowChmHelp | ]ADOC #.ShowChmHelp |
| Line 19: | Line 23: |
| For a full version history: [[ShowChmHelp/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: [[http://aplteam2.com/aplwiki/ShowChmhelp?action=AttachFile&do=get&target=ShowChmHelp.ZIP | Download ShowChmFile script right now]] [[attachment:ShowChmHelp.ZIP | (Manage this attachment)]] '''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 script]] [[attachment:ShowChmHelp_Dev.ZIP | (Manage this attachment)]] If you plan to contribute please note that all stuff published as part of the APLAPL project must follow certain [[AplAplStandards|APLAPL-specific standards]]. |
<<Include(APLTreeDownloads)>> |
| Line 45: | Line 26: |
| CategoryOpenSourceApl CategoryAplApl | CategoryAplTree |
How to display Help Files from APL
ShowChmHelp is part of the CategoryAplTree 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 the ADOC user command; execute:
]ADOC #.ShowChmHelp