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.
35 lines (34 loc) • 1.65 kB
HTML
<html>
<head>
<meta charset="UTF-8">
<title>Graph - 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>Graph</h1>
<div class="topic-meta">Topic: <code>graph</code></div>
<h2>Explanation</h2>
<p><code>protoparser analyze <pml_file> graph</code> outputs a Mermaid-compatible graph with built-in styling for <code>.pml</code> imports and <code>@tags_import</code> relationships.</p>
<p>This is useful for understanding document structure and shared tag dependencies. The generated <code>.mmd</code> file is Mermaid source, so it should be opened in Mermaid-capable software such as the Mermaid Live Editor if you want to inspect or edit it directly. When <code>-output=...</code> is used, ProtoML now also writes a companion HTML preview next to the <code>.mmd</code> file for direct browser visualization.</p>
<p>The graph can be adjusted with:</p>
<ul>
<li><code>-graphView=compact</code></li>
<li><code>-graphView=full</code></li>
<li><code>-graphView=imports</code></li>
<li><code>-graphView=tags</code></li>
<li><code>-graphDirection=TD|LR|RL|BT</code></li>
</ul>
<p>It is recommended to wrap the file path and output path in double quotes.</p>
<h2>Examples</h2>
<pre><code>protoparser analyze "Meeting.pml" graph
protoparser analyze "Meeting.pml" graph -graphView=full -graphDirection=LR
protoparser analyze "Meeting.pml" graph -output="meeting-graph"</code></pre>
</main>
</body>
</html>