APL Wiki|
Size: 1241
Comment: New
|
Size: 1567
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = ShowChmFile = | = How to display Help Files from APL = {{{ShowChmHelp}}} is part of the CategoryAplApl project. |
| Line 7: | Line 9: |
| * Display a help file, satrting with the default topic. | * Display a help file, starting with the default topic. |
| Line 13: | Line 15: |
| To get details about how to use {{{ShowChmFiles}}}, execute: | You can get details about how to use {{{ShowChmHelp}}} with [[ADOC | ADOC ]]; execute: |
| Line 16: | Line 18: |
| #.ADOC.Browse #.ShowHelpChm | #.ADOC.Browse #.ShowChmHelp |
| Line 19: | Line 21: |
| For a full version history: [[ShowChmFile/History| History]] | For a full version history: [[ShowChmHelp/History| History]] |
| Line 30: | Line 32: |
| ## [[http://aplteam2.com/aplwiki/ADOC/DownloadPage?action=AttachFile&do=get&target=ADOC.ZIP | Download ShowChmFile right now]] | You have two options: you can either download the script for usage: |
| Line 32: | Line 34: |
| [[attachment:ShowChmFile.ZIP | Manage the attachment]] | [[http://aplteam2.com/aplwiki/ShowChmhelp?action=AttachFile&do=get&target=ShowChmHelp.ZIP | Download ShowChmFile script right now]] |
| Line 34: | Line 36: |
| ## [[http://aplteam2.com/aplwiki/ADOC?action=AttachFile&do=get&target=ADOC_Dev.ZIP | Download development version]] | 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 36: | Line 38: |
| [[attachment:ShowChmFile_Dev.ZIP | Manage the attachment]] | {{{ 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 [[AplAplStandards|APLAPL-specific standards]]. |
| Line 38: | Line 45: |
| CategoryOpenSourceApl CategoryAplApl | CategoryAplApl |
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: |
|
Responsible: |
|
Email: |
|
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.