Pandoc Utility

Description

Built into PSEC is the public domain utility described at Pandoc - a universal document converter.It uses the 2.18 version of April 04, 2022.

Usage for Help .md Files

In Workflow usage it is used to convert help .md files stored with the tasks .rtf files suitable for loading into a Windows Form rich textbox.

Usage for PSEC Documentation

In generating this set of documentation it is used to convert the .md files and extracted .md files from .ps1 and .psm1 files into HTML documents.

This is carried out by the org.srp.psec.docs.GenPsecDocs utility supplied with the PSEC installation and orchestrated by the Generate Documentation Workflow.

In this mode the startup cost is noticeable so the files are merged into one stream with a file separator marker.

The Pandoc converter is then called once.

The resulting output is split into the desired .HTML files (with some final post-processing to adjust the internal links.