APL Wiki|
Size: 771
Comment:
|
Size: 2471
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. || /!\ || Under Construction || |
`Markdown2Help` is part of the CategoryAplTree project. |
| Line 12: | Line 9: |
| ... | |
| Line 14: | Line 10: |
| == Details == ... |
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 17: | Line 12: |
| It has the benefit of allowing you to edit your help pages while developing or tracing your application. | |
| Line 18: | Line 14: |
| == Examples == ... |
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: {{attachment:Markdown2Help_01.png}} 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: {{attachment:Markdown2Help_02.png}} Note how the namespaces reflect nodes and the variables reflect help topics. This is what a typical help variable looks like: {{attachment:Markdown2Help_03.png}} == 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. |
| Line 23: | Line 50: |
| For bug reports, future enhancements and a full version history see [[APLTreeHelp| APLTreeHelp on the APL Wiki/ProjectPage]] | For bug reports, future enhancements and a full version history see [[Markdown2Help/ProjectPage]] |
| Line 30: | Line 57: |
| <<Include(AplTreeDownloads)>> | <<Include(APLTreeDownloads)>> |
Markdown2Help
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.
Project Page
For bug reports, future enhancements and a full version history see Markdown2Help/ProjectPage
Version Information
Original author: |
|
Responsible: |
|
Email: |