A* Pandoc support

Purpose

A* Pandoc provides extensions to markdown suitable for technical documents within the A* framework, i.e.

1. Checkboxes/Questions/Labels in generated PDF. In particular this includes A* naming and numbering for each entry.
2. Including files using a simple notation including nesting.
3. Anything else we want to add to our markdown to pandoc to PDF/CSV generation process.

a-pandoc is run as a preprocessor on all markdown (*.md) by the standard A* build system (make).

Examples

Commands are used to generate uniquely named PDF fields for use within A*, e.g. the output:

= Lab1 ? Is it too hot? ? What is the temperature in the lab?

*Gen1MaxP What is the active power?

Is generated by:

 = Lab1
 ? Is it too hot?
 ? What is the temperature in the lab?
 =
 *Gen1MaxP What is the active power?

Line based syntax

The syntax is line based and uses the first character of each line to determine the operation, i.e.

First char	Action	Example
<	Include one or more files using glob(n)
?	Checkbox for yes/no	? Too hot
*	Text entry for a result	* Temperature
%	Job/task step	% Commissioned
=	Set prefix to following names	=Gen1

TODO: tasks, signoffs, .., indents of ’#’ headings, per names error handling and messages.

Including files: ’<’

Files can be included directly in the output, e.g.

  <SECURITY.md

Includes the contents of SECURITY.md

Purpose

Review security for this component.

Notes

SubNotes

OtherSubnotes

The filename is a glob(n) pattern so you can include multiple files such as:

  <../*/SECURITY.md

The files are included in dictionary order.

This is typically used to generate documents containing information across all components.

Checkboxes, Forms and Forums

Checkboxes:

=Sun ### What were the solar conditions for this test?

*DirDeg What was the magnetic bearing to the sun? *ElevationDeg What was the in ?RiseT What time did the sun rise at

\appendix

Generator Include Example

This example uses Actuals.md and Parametersmd which contain in order to generate tests for two generators. Of course Actuals.md could also be used for other units such as feeders.

 =Gen1 ### Generator 1
 <Actuals.md
 <Parameters.md
 =Gen2 ### Generator 2
 <Actuals.md
 <Parameters.md

=Gen1 ## Generator 1 *P Active Power from local controller *Q Reactive Power from local controller *S Apparent Power from local controller

See the Generator User Manual for details for parameter access. The password is availble from Bruceor Rose.

*MaxPPa Maximum Power Parameter from local controller *DroopPctPa Droop from local controller

=Gen2 ## Generator 2 *P Active Power from local controller *Q Reactive Power from local controller *S Apparent Power from local controller

See the Generator User Manual for details for parameter access. The password is availble from Bruceor Rose.

*MaxPPa Maximum Power Parameter from local controller *DroopPctPa Droop from local controller

Commissioning Example

 =Pv1Step
 ? Ground cleared?
 ? Foundations installed?
 ? System working?

=Pv1Step ? Ground cleared? % Foundations installed? ? System working? & Completed

<wiki: Lab1 <tickets: *