APL Wiki|
Size: 1724
Comment:
|
Size: 2221
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## page was renamed from APLTreeHelp| APLTreeHelp on the APL Wiki = APLTreeHelp = |
= Markdown2Help = |
| Line 7: | Line 6: |
| `APLTreeHelp` is part of the CategoryAplTree project. | `Markdown2Help` is part of the CategoryAplTree project. |
| Line 11: | Line 10: |
| 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 variables that hold [[https://daringfireball.net/projects/markdown/|Markdown]] text defining a help page. This makes you completely independent from any 3rd-party tools for creating and maintaining help files. |
| Line 15: | Line 14: |
| This is how `APLTreeHelp`'s own help page looks like: | Note that the now outdated project `APLTreeHelp` offered exactly the same functionality. The difference is that in `APLTreeHelp` help pages were represented by dynamic functions returning a vector of vectors with tags and text. Markdown has significant advantages when it comes to editing a help page. That's why `APLTreeHelp` was replaced by `Markdown2Help`. |
| Line 17: | Line 16: |
| To give it a try just download `APLTreeHelp`, unzip it, load it into a Dyalog session and call this function: | This is what `Markdown2Help`'s own help page looks like: {{attachment:Markdown2Help_01.png}} To give it a try just download `Markdown2Help`, unzip it, load it into a Dyalog session and call this function: |
| Line 20: | Line 23: |
| #.APLTreeHelp.Selfy 1 | #.Markdown2Help.Selfie 1 |
| Line 23: | Line 26: |
| {{attachment:APLTreeHelp_01.png}} | If you want to investigate `Markdown2Help`'s own help pages look into `#.Markdown2Help.HelpHelp` with the Workspace Explorer: |
| Line 25: | Line 28: |
| If you want to investigate `APLTreeHelp`'s own help pages look into `#.APLTreeHelp.HelpHelp` via the Workspace Explorer and it becomes clear: | {{attachment:Markdown2Help_02.png}} |
| Line 27: | Line 30: |
| {{attachment:APLTreeHelp_02.png}} | Note how the namespaces reflect nodes and the variables reflect help topics. |
| Line 29: | Line 32: |
| Note how the namespaces reflect nodes and the functions reflect help topics. | This is what a typical help variable looks like: |
| Line 31: | Line 34: |
| This is how a typical help function looks like: | {{attachment:Markdown2Help_03.png}} |
| Line 33: | Line 36: |
| {{attachment:APLTreeHelp_03.png}} | == How to start == |
| Line 35: | Line 38: |
| There will be soon an article in Vector regarding `APLTreeHelp`. | Since version version 2.2.0 there is a method `CreateStub` available that makes it easy to start a new help system. |
| Line 37: | Line 40: |
| == Project Page == | Just call it and provide a proper name as the right argument. If it's not supposed to live in `#` you can specify the name of the namespace it shall be created in as the left argument. |
| Line 39: | Line 42: |
| For bug reports, future enhancements and a full version history see [[APLTreeHelp/ProjectPage]] | It will then create a couple of pages and a node and finally display it. |
| Line 41: | Line 44: |
| == Version Information == ||Original author: ||KaiJaeger || ||Responsible: ||KaiJaeger || ||Email: || kai@aplteam.com || |
== Requirements == |
| Line 46: | Line 46: |
| <<Include(AplTreeDownloads)>> | `Markdown2Help` needs at least version 14.0. <<Include(APLTreeDownloads)>> |
Markdown2Help
Contents
Markdown2Help 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 variables that hold Markdown text defining a help page. 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.
Note that the now outdated project APLTreeHelp offered exactly the same functionality. The difference is that in APLTreeHelp help pages were represented by dynamic functions returning a vector of vectors with tags and text. Markdown has significant advantages when it comes to editing a help page. That's why APLTreeHelp was replaced by Markdown2Help.
This is what Markdown2Help's own help page looks like:
To give it a try just download Markdown2Help, unzip it, load it into a Dyalog session and call this function:
#.Markdown2Help.Selfie 1
If you want to investigate Markdown2Help's own help pages look into #.Markdown2Help.HelpHelp with the Workspace Explorer:
Note how the namespaces reflect nodes and the variables reflect help topics.
This is what a typical help variable looks like:
How to start
Since version version 2.2.0 there is a method CreateStub available that makes it easy to start a new help system.
Just call it and provide a proper name as the right argument. If it's not supposed to live in # you can specify the name of the namespace it shall be created in as the left argument.
It will then create a couple of pages and a node and finally display it.
Requirements
Markdown2Help needs at least version 14.0.