APL Wiki|
Size: 1239
Comment:
|
Size: 799
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = ShowChmFile = | = 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 {{{ShowChmFiles}}}, execute: | You can get details about how to use {{{ShowChmHelp}}} with the [[ADOC | ADOC ]] user command; execute: |
| Line 16: | Line 20: |
| #.ADOC.Browse #.ShowHelpChm | ]ADOC #.ShowChmHelp |
| Line 19: | Line 23: |
| For a full version history: [[ShowChmFile/History| History]] | <<Include(APLTreeDownloads)>> |
| Line 21: | Line 25: |
| == Version Information == ||Original author:||KaiJaeger|| ||Responsible:||KaiJaeger|| ||Email:||kai@aplteam.com|| ||Current state:||1.0.0|| == Download == [[http://aplteam2.com/aplwiki/ShowChmHelp?action=AttachFile&do=get&target=ShowChmFile.ZIP | Download ShowChmFile right now]] [[attachment:ShowChmFile.ZIP | Manage the attachment]] ## [[http://aplteam2.com/aplwiki/ADOC?action=AttachFile&do=get&target=ADOC_Dev.ZIP | Download development version]] [[attachment:ShowChmFile_Dev.ZIP | Manage the attachment]] |
|
| Line 38: | 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