Quick introduction to MarkAPL

By now you are likely aware that MarkAPL converts Markdown to HTML5.

All you need is the Tatin package MarkAPL.

1. Quick start

1.1. Making MarkAPL available

Assuming that you have some Markdown in the workspace:

      MyMarkdown←'# MarkAPL' 'All about **_MarkAPL_**'

There are two possible scenarios:

1.2. Converting Markdown into HTML

To convert Markdown into HTML, call the Markdown2HTML method:

      (html ns)←MarkAPL.Markdown2HTML MyMarkdown
      50↑∊html
<a id="markapl" class="autoheaderlink"><h1>MarkAPLstrong></p>

Note that not only the HTML but also a namespace ns is returned which, among other stuff, has a variable report that might carry warnings and error reports. Ideally report is empty.

This way of calling Markdown2HTML relies entirely on defaults. If you are not happy with those you must specify parameters in one of two ways:

1.3. Creating a fully fledged HTML page with a parameter space

To instruct MarkAPL to generate a complete HTML page, you can either specify outputFilename or set the createFullHtmlPage flag to 1:

      parms←MarkAPL.CreateParms
      parms.createFullHtmlPage←1
      (html ns)←parms MarkAPL.Markdown2HTML MyMarkdown
      ⍪4↑html
 <!DOCTYPE html>
 <html>
 <head>
 <meta charset="utf-8">

Setting outputFilename has the additional benefit of writing the HTML to that file.

Note that parms is a namespace that stores default values. You can list them by calling parms.∆List.

1.4. Create a fully fledged HTML page with embedded parameters

To make MarkAPL generate a complete HTML page, you can embed outputFilename or createFullHtmlPage into the Markdown:

      (html ns)←MarkAPL.Markdown2HTML (⊂'[parm]:createFullHtmlPage=1'),MyMarkdown
      ⍪4↑html
 <!DOCTYPE html>
 <html>
 <head>
 <meta charset="utf-8">

2. Documentation

3. Misc

Please send comments, suggestions and bug reports to kai@aplteam.com.

Kai Jaeger ⋄ 2016-02-17

Last update: 2023-08-13