Markdown2Help

(Hide table-of-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:

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:

Markdown2Help_02.png

Note how the namespaces reflect nodes and the variables reflect help topics.

This is what a typical help variable looks like:

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.

Project Page

For bug reports, future enhancements and a full version history see Markdown2Help/ProjectPage

Version Information

Original author:

KaiJaeger

Responsible:

KaiJaeger

Email:

kai@aplteam.com

APLTree downloads

Using an APLTree member

  1. If you just want to consume (use) an APLTree member then you have several choices:
    • Note that accessing it via ftp allows you to download older versions as well while the dedicated download page offers just the most current version.

Contributing

If you want to contribute to an APLTree project see HowToContributeToTheAPLTreeProject for details.

Get the full project

If for some reason you need access to, say, the test cases then you need to get more then just the script (or application) itself.

HowToContributeToTheAPLTreeProject explains how to get a project onto your local machine. Just ignore any additional steps.

Create a new APLTree sub project

In order to create a new APLTree project you need some advice. Ask KaiJaeger for help: mailto:kai@aplteam.com


CategoryAplTree

Markdown2Help (last edited 2017-01-15 11:09:11 by KaiJaeger)