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.
43 lines (42 loc) • 2.25 kB
HTML
<html>
<head>
<meta charset="UTF-8">
<title>Register - 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>Register</h1>
<div class="topic-meta">Topic: <code>register</code></div>
<h2>Explanation</h2>
<p><code>protoparser register "<dir>" <format></code> scans a directory recursively and builds a governance-oriented register for document-like <code>.pml</code> files.</p>
<p>Supported formats are <code>statistics</code>, <code>json</code>, <code>html</code>, and <code>pdf</code>.</p>
<p>This <code>register</code> command is a document portfolio report for governance-style <code>.pml</code> collections. It is not related to macro package registries, <code>macro_install add_registry</code>, or <code>protoml.registry.json</code>.</p>
<p>The register is intended for document portfolios such as meetings, contracts, onboarding files, compliance material, and internal records. It highlights:</p>
<ul>
<li>missing governance metadata such as <code>record_id</code>, <code>author</code>, <code>version</code>, or <code>status</code></li>
<li>expired documents via <code>@valid_until</code></li>
<li>documents due for review via <code>@review_date</code></li>
<li>documents with open tasks</li>
<li>status distributions across the directory</li>
</ul>
<p>For governance-sensitive <code>.pml</code> files, ProtoML also supports detached file signatures through:</p>
<ul>
<li><code>protoparser sign pml "./file.pml" ...</code></li>
<li><code>protoparser verify pml "./file.pml" ...</code></li>
<li><code>protoparser trust "./file.pml" -trustRegistry=...</code></li>
</ul>
<p>That signature workflow is complementary to directory-level register reports.</p>
<p>Use it on document directories rather than broad repository roots when possible.</p>
<h2>Examples</h2>
<pre><code>protoparser register "meetings" statistics
protoparser register "contracts" html
protoparser -v register "examples/feature-suite" statistics</code></pre>
</main>
</body>
</html>