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.
52 lines (49 loc) • 2.82 kB
HTML
<html>
<head>
<meta charset="UTF-8">
<title>Documentation Index - 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 Documentation</h1>
<p>ProtoML is a lightweight document language for meetings, protocols, task lists, reusable content, shared participants, shared tags, and structured exports.</p>
<p>The repository includes the parser, renderers, CLI tools, bundled macros, the Electron viewer, and Windows CHM help generation.</p>
<h2>Start here</h2>
<ul>
<li><a href="01_installation.html">Installation And Release Use</a></li>
<li><a href="02_quick_start.html">Quick Start</a></li>
<li><a href="06_concepts.html">ProtoML Concepts</a></li>
<li><a href="07_authoring_guide.html">Authoring Guide</a></li>
<li><a href="08a_reuse_and_imports.html">Reuse And Imports Guide</a></li>
<li><a href="08_macro_registry_guide.html">Own Macro Registry Guide</a></li>
<li><a href="13_macro_security_trust_model.html">Macro Security And Trust Model</a></li>
<li><a href="14_validation_and_analysis_workflows.html">Validation And Analysis Workflows</a></li>
<li><a href="15_governance_documents.html">Governance Documents</a></li>
<li><a href="16_release_and_packaging.html">Release And Packaging</a></li>
<li><a href="11_examples_cookbook.html">Examples Cookbook</a></li>
</ul>
<h2>By role</h2>
<ul>
<li>Authors: Quick Start, Authoring Guide, Reuse And Imports Guide, Outputs And Rendering</li>
<li>Macro users: Macros Guide, Reuse And Imports Guide, Own Macro Registry Guide, Macro Security And Trust Model, Examples Cookbook</li>
<li>CLI users: CLI Reference, Outputs And Rendering, Validation And Analysis Workflows, Release And Packaging</li>
<li>Viewer users: Viewer Guide</li>
<li>Governance-focused users: Governance Documents, Validation And Analysis Workflows</li>
<li>Users exploring the language surface: Reference Map</li>
</ul>
<h2>What lives where</h2>
<ul>
<li><code>README.md</code> for project overview, installation, quick start, and release structure</li>
<li><code>docs/*.pml</code> for built-in CLI help topics via <code>protoparser --docs <topic></code></li>
<li><code>docs/chm/</code> for generated Windows CHM help project files and compiled output</li>
<li><code>examples/</code> for runnable feature and macro-registry examples</li>
</ul>
</main>
</body>
</html>