protoml-parser
Version:
ProtoML is a lightweight, declarative markup language designed for writing and structuring meeting protocols, notes and task lists in a human-readable and machine-parseable format.
27 lines (26 loc) • 1.05 kB
HTML
<html>
<head>
<meta charset="UTF-8">
<title>Protoml Help - ProtoML 1.4.2+build67</title>
<link rel="stylesheet" href="help.css">
</head>
<body>
<nav class="topnav">
<a href="../toc.html">Contents</a>
<span class="version">ProtoML 1.4.2+build67</span>
</nav>
<main class="page">
<h1>Protoml Help</h1>
<div class="topic-meta">Topic: <code>protoml-help</code></div>
<h2>Explanation</h2>
<p>Displays detailed documentation for a specific help module located in the <code>/docs</code> directory.</p>
<p>The module should be a <code>.pml</code> file starting with <code>@help</code>, and contain fields such as <code>=name:</code>, <code>=docs:</code> and optionally <code>=examples:</code>.</p>
<p>For the broader guided documentation path, use the generated CHM contents page in <code>docs/chm/toc.html</code> or <code>protoparser chm</code> on Windows.</p>
<h2>Examples</h2>
<pre><code>protoparser --docs meeting
protoparser --docs protoml-parser
protoparser --docs protoml-chm</code></pre>
</main>
</body>
</html>