diff options
| author | Laurent P. René de Cotret <laurent.decotret@outlook.com> | 2020-10-11 14:25:55 -0400 |
|---|---|---|
| committer | Laurent P. René de Cotret <laurent.decotret@outlook.com> | 2020-10-11 14:25:55 -0400 |
| commit | d78918108572c231029698a28f2c33c600d80e2d (patch) | |
| tree | a8b011bad7ec94382907c41adc21aefc82d0cf18 | |
| parent | 4aac452eb9aab0a5b6981c776a68e22c003b52b9 (diff) | |
[skip ci] updated manual1.0.0.0
| -rw-r--r-- | docs/MANUAL.html | 506 | ||||
| -rw-r--r-- | docs/index.html | 94 | ||||
| -rw-r--r-- | docs/plots/10777036210790392404.png | bin | 90298 -> 0 bytes | |||
| -rw-r--r-- | docs/plots/12543562454472456169.html | 85 | ||||
| -rw-r--r-- | docs/plots/12543562454472456169.txt (renamed from docs/plots/5729111110920201489.txt) | 2 | ||||
| -rw-r--r-- | docs/plots/4676898955002368852.png | bin | 0 -> 90603 bytes | |||
| -rw-r--r-- | docs/plots/4676898955002368852.txt (renamed from docs/plots/10777036210790392404.txt) | 2 | ||||
| -rw-r--r-- | docs/plots/5729111110920201489.html | 85 |
8 files changed, 387 insertions, 387 deletions
diff --git a/docs/MANUAL.html b/docs/MANUAL.html index 34269a3..5c34991 100644 --- a/docs/MANUAL.html +++ b/docs/MANUAL.html @@ -4,7 +4,7 @@ <meta charset="utf-8" /> <meta name="generator" content="pandoc" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> - <title>pandoc-plot 0.9.4.0 manual</title> + <title>pandoc-plot 1.0.0.0 manual</title> <style> code{white-space: pre-wrap;} span.smallcaps{font-variant: small-caps;} @@ -83,7 +83,7 @@ </head> <body> <header id="title-block-header"> -<h1 class="title">pandoc-plot 0.9.4.0 manual</h1> +<h1 class="title">pandoc-plot 1.0.0.0 manual</h1> </header> <!-- The file MANUAL.md is automatically generated by the tools/mkmanual.ps1 script. Do not edit manually. @@ -115,59 +115,59 @@ The file MANUAL.md is automatically generated by the tools/mkmanual.ps1 script. <h3 id="captions">Captions</h3> <p>You can also specify a caption for your image. This is done using the optional <code>caption</code> parameter.</p> <p><strong>Markdown</strong>:</p> -<div class="sourceCode" id="cb1"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true"></a><span class="in">```{.matlabplot caption="This is a simple figure with a **Markdown** caption"}</span></span> -<span id="cb1-2"><a href="#cb1-2" aria-hidden="true"></a><span class="in">x = 0: .1 : 2*pi;</span></span> -<span id="cb1-3"><a href="#cb1-3" aria-hidden="true"></a><span class="in">y1 = cos(x);</span></span> -<span id="cb1-4"><a href="#cb1-4" aria-hidden="true"></a><span class="in">y2 = sin(x);</span></span> -<span id="cb1-5"><a href="#cb1-5" aria-hidden="true"></a></span> -<span id="cb1-6"><a href="#cb1-6" aria-hidden="true"></a><span class="in">figure</span></span> -<span id="cb1-7"><a href="#cb1-7" aria-hidden="true"></a><span class="in">plot(x, y1, 'b', x, y2, 'r-.', 'LineWidth', 2)</span></span> -<span id="cb1-8"><a href="#cb1-8" aria-hidden="true"></a><span class="in">```</span></span></code></pre></div> +<div class="sourceCode" id="cb1"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="in">```{.matlabplot caption="This is a simple figure with a **Markdown** caption"}</span></span> +<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="in">x = 0: .1 : 2*pi;</span></span> +<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="in">y1 = cos(x);</span></span> +<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a><span class="in">y2 = sin(x);</span></span> +<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a></span> +<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="in">figure</span></span> +<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a><span class="in">plot(x, y1, 'b', x, y2, 'r-.', 'LineWidth', 2)</span></span> +<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a><span class="in">```</span></span></code></pre></div> <p><strong>LaTex</strong>:</p> -<div class="sourceCode" id="cb2"><pre class="sourceCode latex"><code class="sourceCode latex"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true"></a><span class="kw">\begin</span>{<span class="ex">minted</span>}[caption=This is a simple figure with a caption]{matlabplot}</span> -<span id="cb2-2"><a href="#cb2-2" aria-hidden="true"></a><span class="vs">x = 0: .1 : 2*pi;</span></span> -<span id="cb2-3"><a href="#cb2-3" aria-hidden="true"></a><span class="vs">y1 = cos(x);</span></span> -<span id="cb2-4"><a href="#cb2-4" aria-hidden="true"></a><span class="vs">y2 = sin(x);</span></span> -<span id="cb2-5"><a href="#cb2-5" aria-hidden="true"></a></span> -<span id="cb2-6"><a href="#cb2-6" aria-hidden="true"></a><span class="vs">figure</span></span> -<span id="cb2-7"><a href="#cb2-7" aria-hidden="true"></a><span class="vs">plot(x, y1, 'b', x, y2, 'r-.', 'LineWidth', 2)</span></span> -<span id="cb2-8"><a href="#cb2-8" aria-hidden="true"></a><span class="kw">\end</span>{<span class="ex">minted</span>}</span></code></pre></div> +<div class="sourceCode" id="cb2"><pre class="sourceCode latex"><code class="sourceCode latex"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="kw">\begin</span>{<span class="ex">minted</span>}[caption=This is a simple figure with a caption]{matlabplot}</span> +<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="vs">x = 0: .1 : 2*pi;</span></span> +<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="vs">y1 = cos(x);</span></span> +<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="vs">y2 = sin(x);</span></span> +<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a></span> +<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="vs">figure</span></span> +<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a><span class="vs">plot(x, y1, 'b', x, y2, 'r-.', 'LineWidth', 2)</span></span> +<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="kw">\end</span>{<span class="ex">minted</span>}</span></code></pre></div> <p>Caption formatting unfortunately cannot be determined automatically. To specify a caption format (e.g. “markdown”, “LaTeX”, etc.), see <a href="#configuration">Configuration</a>.</p> <h3 id="link-to-source-code">Link to source code</h3> <p>In case of an output format that supports links (e.g. HTML), the embedded image generated by <code>pandoc-plot</code> can show a link to the source code which was used to generate the file. Therefore, other people can see what code was used to create your figures.</p> <p>You can turn this on via the <code>source=true</code> key:</p> <p><strong>Markdown</strong>:</p> -<div class="sourceCode" id="cb3"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true"></a><span class="in">```{.mathplot source=true}</span></span> -<span id="cb3-2"><a href="#cb3-2" aria-hidden="true"></a><span class="in">...</span></span> -<span id="cb3-3"><a href="#cb3-3" aria-hidden="true"></a><span class="in">```</span></span></code></pre></div> +<div class="sourceCode" id="cb3"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="in">```{.mathplot source=true}</span></span> +<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="in">...</span></span> +<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="in">```</span></span></code></pre></div> <p><strong>LaTex</strong>:</p> -<div class="sourceCode" id="cb4"><pre class="sourceCode latex"><code class="sourceCode latex"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true"></a><span class="kw">\begin</span>{<span class="ex">minted</span>}[source=true]{mathplot}</span> -<span id="cb4-2"><a href="#cb4-2" aria-hidden="true"></a><span class="vs">...</span></span> -<span id="cb4-3"><a href="#cb4-3" aria-hidden="true"></a><span class="kw">\end</span>{<span class="ex">minted</span>}</span></code></pre></div> +<div class="sourceCode" id="cb4"><pre class="sourceCode latex"><code class="sourceCode latex"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="kw">\begin</span>{<span class="ex">minted</span>}[source=true]{mathplot}</span> +<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="vs">...</span></span> +<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a><span class="kw">\end</span>{<span class="ex">minted</span>}</span></code></pre></div> <p>or via a <a href="#Configuration">configuration file</a>.</p> <h3 id="preamble-scripts">Preamble scripts</h3> <p>If you find yourself always repeating some steps, inclusion of scripts is possible using the <code>preamble</code> parameter. For example, if you want all Matplotlib plots to have the <a href="https://matplotlib.org/tutorials/introductory/customizing.html#sphx-glr-tutorials-introductory-customizing-py"><code>ggplot</code></a> style, you can write a very short preamble <code>style.py</code> like so:</p> -<div class="sourceCode" id="cb5"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true"></a><span class="im">import</span> matplotlib.pyplot <span class="im">as</span> plt</span> -<span id="cb5-2"><a href="#cb5-2" aria-hidden="true"></a>plt.style.use(<span class="st">'ggplot'</span>)</span></code></pre></div> +<div class="sourceCode" id="cb5"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> matplotlib.pyplot <span class="im">as</span> plt</span> +<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a>plt.style.use(<span class="st">'ggplot'</span>)</span></code></pre></div> <p>and include it in your document as follows:</p> -<div class="sourceCode" id="cb6"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true"></a><span class="in">```{.matplotlib preamble=style.py}</span></span> -<span id="cb6-2"><a href="#cb6-2" aria-hidden="true"></a><span class="in">plt.figure()</span></span> -<span id="cb6-3"><a href="#cb6-3" aria-hidden="true"></a><span class="in">plt.plot([0,1,2,3,4], [1,2,3,4,5])</span></span> -<span id="cb6-4"><a href="#cb6-4" aria-hidden="true"></a><span class="in">plt.title('This is an example figure')</span></span> -<span id="cb6-5"><a href="#cb6-5" aria-hidden="true"></a><span class="in">```</span></span></code></pre></div> +<div class="sourceCode" id="cb6"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="in">```{.matplotlib preamble=style.py}</span></span> +<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="in">plt.figure()</span></span> +<span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a><span class="in">plt.plot([0,1,2,3,4], [1,2,3,4,5])</span></span> +<span id="cb6-4"><a href="#cb6-4" aria-hidden="true" tabindex="-1"></a><span class="in">plt.title('This is an example figure')</span></span> +<span id="cb6-5"><a href="#cb6-5" aria-hidden="true" tabindex="-1"></a><span class="in">```</span></span></code></pre></div> <p>Which is equivalent to writing the following markdown:</p> -<div class="sourceCode" id="cb7"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true"></a><span class="in">```{.matplotlib}</span></span> -<span id="cb7-2"><a href="#cb7-2" aria-hidden="true"></a><span class="in">import matplotlib.pyplot as plt</span></span> -<span id="cb7-3"><a href="#cb7-3" aria-hidden="true"></a><span class="in">plt.style.use('ggplot')</span></span> -<span id="cb7-4"><a href="#cb7-4" aria-hidden="true"></a></span> -<span id="cb7-5"><a href="#cb7-5" aria-hidden="true"></a><span class="in">plt.figure()</span></span> -<span id="cb7-6"><a href="#cb7-6" aria-hidden="true"></a><span class="in">plt.plot([0,1,2,3,4], [1,2,3,4,5])</span></span> -<span id="cb7-7"><a href="#cb7-7" aria-hidden="true"></a><span class="in">plt.title('This is an example figure')</span></span> -<span id="cb7-8"><a href="#cb7-8" aria-hidden="true"></a><span class="in">```</span></span></code></pre></div> +<div class="sourceCode" id="cb7"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="in">```{.matplotlib}</span></span> +<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a><span class="in">import matplotlib.pyplot as plt</span></span> +<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a><span class="in">plt.style.use('ggplot')</span></span> +<span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a></span> +<span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a><span class="in">plt.figure()</span></span> +<span id="cb7-6"><a href="#cb7-6" aria-hidden="true" tabindex="-1"></a><span class="in">plt.plot([0,1,2,3,4], [1,2,3,4,5])</span></span> +<span id="cb7-7"><a href="#cb7-7" aria-hidden="true" tabindex="-1"></a><span class="in">plt.title('This is an example figure')</span></span> +<span id="cb7-8"><a href="#cb7-8" aria-hidden="true" tabindex="-1"></a><span class="in">```</span></span></code></pre></div> <p>The equivalent LaTeX usage is as follows:</p> -<div class="sourceCode" id="cb8"><pre class="sourceCode latex"><code class="sourceCode latex"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true"></a><span class="kw">\begin</span>{<span class="ex">minted</span>}[include=style.py]{matplotlib}</span> -<span id="cb8-2"><a href="#cb8-2" aria-hidden="true"></a></span> -<span id="cb8-3"><a href="#cb8-3" aria-hidden="true"></a><span class="kw">\end</span>{<span class="ex">minted</span>}</span></code></pre></div> +<div class="sourceCode" id="cb8"><pre class="sourceCode latex"><code class="sourceCode latex"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="kw">\begin</span>{<span class="ex">minted</span>}[include=style.py]{matplotlib}</span> +<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a></span> +<span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a><span class="kw">\end</span>{<span class="ex">minted</span>}</span></code></pre></div> <p>This <code>preamble</code> parameter is perfect for longer documents with many plots. Simply define the style you want in a separate script! You can also import packages this way, or define functions you often use.</p> <h3 id="support-for-interactive-plots">Support for interactive plots</h3> <p>Starting with version 0.8.0.0, <code>pandoc-plot</code> supports the creation of interactive plots (if a toolkit supports it). All you need to do is set the save format to <code>html</code>. The resulting plot is fully self-contained, so it can be displayed offline.</p> @@ -178,74 +178,74 @@ The file MANUAL.md is automatically generated by the tools/mkmanual.ps1 script. <h3 id="compatibility-with-pandoc-crossref">Compatibility with pandoc-crossref</h3> <p><a href="https://github.com/lierdakil/pandoc-crossref"><code>pandoc-crossref</code></a> is a pandoc filter that makes it effortless to cross-reference objects in Markdown documents.</p> <p>You can use <code>pandoc-crossref</code> in conjunction with <code>pandoc-plot</code> for the ultimate figure-making pipeline. You can combine both in a figure like so:</p> -<div class="sourceCode" id="cb9"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true"></a><span class="in">```{#fig:myexample .plotly_python caption="This is a caption"}</span></span> -<span id="cb9-2"><a href="#cb9-2" aria-hidden="true"></a><span class="in"># Insert figure script here</span></span> -<span id="cb9-3"><a href="#cb9-3" aria-hidden="true"></a><span class="in">```</span></span> -<span id="cb9-4"><a href="#cb9-4" aria-hidden="true"></a></span> -<span id="cb9-5"><a href="#cb9-5" aria-hidden="true"></a>As you can see in @fig:myexample, ...</span></code></pre></div> +<div class="sourceCode" id="cb9"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="in">```{#fig:myexample .plotly_python caption="This is a caption"}</span></span> +<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a><span class="in"># Insert figure script here</span></span> +<span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a><span class="in">```</span></span> +<span id="cb9-4"><a href="#cb9-4" aria-hidden="true" tabindex="-1"></a></span> +<span id="cb9-5"><a href="#cb9-5" aria-hidden="true" tabindex="-1"></a>As you can see in @fig:myexample, ...</span></code></pre></div> <p>If the above source is located in file <code>myfile.md</code>, you can render the figure and references by applying <code>pandoc-plot</code> <strong>first</strong>, and then <code>pandoc-crossref</code>. For example:</p> -<div class="sourceCode" id="cb10"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true"></a><span class="ex">pandoc</span> --filter pandoc-plot --filter pandoc-crossref -i myfile.md -o myfile.html</span></code></pre></div> +<div class="sourceCode" id="cb10"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pandoc</span> --filter pandoc-plot --filter pandoc-crossref -i myfile.md -o myfile.html</span></code></pre></div> <h2 id="detailed-usage">Detailed usage</h2> <p><code>pandoc-plot</code> is a command line executable with a few functions. You can take a look at the help using the <code>-h</code>/<code>--help</code> flag:</p> -<div class="sourceCode" id="cb11"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true"></a><span class="ex">pandoc-plot</span> 0.9.4.0 - generate figures directly in documents</span> -<span id="cb11-2"><a href="#cb11-2" aria-hidden="true"></a></span> -<span id="cb11-3"><a href="#cb11-3" aria-hidden="true"></a><span class="ex">Usage</span>: pandoc-plot.EXE [(-v<span class="kw">|</span><span class="ex">--version</span>) <span class="kw">|</span> <span class="ex">--full-version</span> <span class="kw">|</span> <span class="kw">(</span><span class="ex">-m</span><span class="kw">|</span><span class="ex">--manual</span><span class="kw">)</span>] </span> -<span id="cb11-4"><a href="#cb11-4" aria-hidden="true"></a> [<span class="ex">COMMAND</span>] [AST]</span> -<span id="cb11-5"><a href="#cb11-5" aria-hidden="true"></a> <span class="ex">This</span> pandoc filter generates plots from code blocks using a multitude of</span> -<span id="cb11-6"><a href="#cb11-6" aria-hidden="true"></a> <span class="ex">possible</span> renderers. This allows to keep documentation and figures in perfect</span> -<span id="cb11-7"><a href="#cb11-7" aria-hidden="true"></a> <span class="ex">synchronicity.</span></span> -<span id="cb11-8"><a href="#cb11-8" aria-hidden="true"></a></span> -<span id="cb11-9"><a href="#cb11-9" aria-hidden="true"></a><span class="ex">Available</span> options:</span> -<span id="cb11-10"><a href="#cb11-10" aria-hidden="true"></a> <span class="ex">-v</span>,--version Show version number and exit.</span> -<span id="cb11-11"><a href="#cb11-11" aria-hidden="true"></a> <span class="ex">--full-version</span> Show full version information and exit.</span> -<span id="cb11-12"><a href="#cb11-12" aria-hidden="true"></a> <span class="ex">-m</span>,--manual Open the manual page in the default web browser and</span> -<span id="cb11-13"><a href="#cb11-13" aria-hidden="true"></a> <span class="ex">exit.</span></span> -<span id="cb11-14"><a href="#cb11-14" aria-hidden="true"></a> <span class="ex">-h</span>,--help Show this help text</span> -<span id="cb11-15"><a href="#cb11-15" aria-hidden="true"></a></span> -<span id="cb11-16"><a href="#cb11-16" aria-hidden="true"></a><span class="ex">Available</span> commands:</span> -<span id="cb11-17"><a href="#cb11-17" aria-hidden="true"></a> <span class="ex">toolkits</span> Show information on toolkits and exit.</span> -<span id="cb11-18"><a href="#cb11-18" aria-hidden="true"></a> <span class="ex">clean</span> Clean output directories where figures from FILE and</span> -<span id="cb11-19"><a href="#cb11-19" aria-hidden="true"></a> <span class="ex">log</span> files might be stored. WARNING: All files in</span> -<span id="cb11-20"><a href="#cb11-20" aria-hidden="true"></a> <span class="ex">those</span> directories will be deleted.</span> -<span id="cb11-21"><a href="#cb11-21" aria-hidden="true"></a> <span class="ex">write-example-config</span> Write example configuration to a file and exit.</span> -<span id="cb11-22"><a href="#cb11-22" aria-hidden="true"></a></span> -<span id="cb11-23"><a href="#cb11-23" aria-hidden="true"></a><span class="ex">More</span> information can be found via the manual (pandoc-plot --manual) <span class="ex">or</span> the</span> -<span id="cb11-24"><a href="#cb11-24" aria-hidden="true"></a><span class="ex">repository</span> README, located at https://github.com/LaurentRDC/pandoc-plot</span></code></pre></div> +<div class="sourceCode" id="cb11"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pandoc-plot</span> 0.9.4.0 - generate figures directly in documents</span> +<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a></span> +<span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a><span class="ex">Usage</span>: pandoc-plot.EXE [(-v<span class="kw">|</span><span class="ex">--version</span>) <span class="kw">|</span> <span class="ex">--full-version</span> <span class="kw">|</span> <span class="kw">(</span><span class="ex">-m</span><span class="kw">|</span><span class="ex">--manual</span><span class="kw">)</span>] </span> +<span id="cb11-4"><a href="#cb11-4" aria-hidden="true" tabindex="-1"></a> [<span class="ex">COMMAND</span>] [AST]</span> +<span id="cb11-5"><a href="#cb11-5" aria-hidden="true" tabindex="-1"></a> <span class="ex">This</span> pandoc filter generates plots from code blocks using a multitude of</span> +<span id="cb11-6"><a href="#cb11-6" aria-hidden="true" tabindex="-1"></a> <span class="ex">possible</span> renderers. This allows to keep documentation and figures in perfect</span> +<span id="cb11-7"><a href="#cb11-7" aria-hidden="true" tabindex="-1"></a> <span class="ex">synchronicity.</span></span> +<span id="cb11-8"><a href="#cb11-8" aria-hidden="true" tabindex="-1"></a></span> +<span id="cb11-9"><a href="#cb11-9" aria-hidden="true" tabindex="-1"></a><span class="ex">Available</span> options:</span> +<span id="cb11-10"><a href="#cb11-10" aria-hidden="true" tabindex="-1"></a> <span class="ex">-v</span>,--version Show version number and exit.</span> +<span id="cb11-11"><a href="#cb11-11" aria-hidden="true" tabindex="-1"></a> <span class="ex">--full-version</span> Show full version information and exit.</span> +<span id="cb11-12"><a href="#cb11-12" aria-hidden="true" tabindex="-1"></a> <span class="ex">-m</span>,--manual Open the manual page in the default web browser and</span> +<span id="cb11-13"><a href="#cb11-13" aria-hidden="true" tabindex="-1"></a> <span class="ex">exit.</span></span> +<span id="cb11-14"><a href="#cb11-14" aria-hidden="true" tabindex="-1"></a> <span class="ex">-h</span>,--help Show this help text</span> +<span id="cb11-15"><a href="#cb11-15" aria-hidden="true" tabindex="-1"></a></span> +<span id="cb11-16"><a href="#cb11-16" aria-hidden="true" tabindex="-1"></a><span class="ex">Available</span> commands:</span> +<span id="cb11-17"><a href="#cb11-17" aria-hidden="true" tabindex="-1"></a> <span class="ex">toolkits</span> Show information on toolkits and exit.</span> +<span id="cb11-18"><a href="#cb11-18" aria-hidden="true" tabindex="-1"></a> <span class="ex">clean</span> Clean output directories where figures from FILE and</span> +<span id="cb11-19"><a href="#cb11-19" aria-hidden="true" tabindex="-1"></a> <span class="ex">log</span> files might be stored. WARNING: All files in</span> +<span id="cb11-20"><a href="#cb11-20" aria-hidden="true" tabindex="-1"></a> <span class="ex">those</span> directories will be deleted.</span> +<span id="cb11-21"><a href="#cb11-21" aria-hidden="true" tabindex="-1"></a> <span class="ex">write-example-config</span> Write example configuration to a file and exit.</span> +<span id="cb11-22"><a href="#cb11-22" aria-hidden="true" tabindex="-1"></a></span> +<span id="cb11-23"><a href="#cb11-23" aria-hidden="true" tabindex="-1"></a><span class="ex">More</span> information can be found via the manual (pandoc-plot --manual) <span class="ex">or</span> the</span> +<span id="cb11-24"><a href="#cb11-24" aria-hidden="true" tabindex="-1"></a><span class="ex">repository</span> README, located at https://github.com/LaurentRDC/pandoc-plot</span></code></pre></div> <h3 id="as-a-filter">As a filter</h3> <p>The most common use for <code>pandoc-plot</code> is as a pandoc filter, in which case it should be called without arguments. For example:</p> -<div class="sourceCode" id="cb12"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true"></a><span class="ex">pandoc</span> --filter pandoc-plot -i input.md -o output.html</span></code></pre></div> +<div class="sourceCode" id="cb12"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pandoc</span> --filter pandoc-plot -i input.md -o output.html</span></code></pre></div> <p>If <code>pandoc-plot</code> fails to render a code block into a figure, the filtering will not stop. Your code blocks will stay unchanged.</p> <p>You can chain other filters with it (e.g., <a href="https://github.com/lierdakil/pandoc-crossref"><code>pandoc-crossref</code></a>) like so:</p> -<div class="sourceCode" id="cb13"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true"></a><span class="ex">pandoc</span> --filter pandoc-plot --filter pandoc-crossref -i input.md -o output.html</span></code></pre></div> +<div class="sourceCode" id="cb13"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pandoc</span> --filter pandoc-plot --filter pandoc-crossref -i input.md -o output.html</span></code></pre></div> <h3 id="syntax">Syntax</h3> <p>The syntax for code blocks in documents is shown below. <code>pandoc-plot</code> looks for code blocks with a specific class, depending on the toolkit you want to use. <code>pandoc-plot</code> will run the code and capture the figure output. There can only be <strong>one</strong> figure per code block.</p> <p>The possible parameters and options are described in <a href="#parameters-and-options">further below</a>.</p> <h4 id="markdown">Markdown</h4> -<div class="sourceCode" id="cb14"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true"></a> <span class="in">```{.cls param1=value1 param2=value2 ...}</span></span> -<span id="cb14-2"><a href="#cb14-2" aria-hidden="true"></a><span class="in"> # script content</span></span> -<span id="cb14-3"><a href="#cb14-3" aria-hidden="true"></a><span class="in"> ```</span></span></code></pre></div> +<div class="sourceCode" id="cb14"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a> <span class="in">```{.cls param1=value1 param2=value2 ...}</span></span> +<span id="cb14-2"><a href="#cb14-2" aria-hidden="true" tabindex="-1"></a><span class="in"> # script content</span></span> +<span id="cb14-3"><a href="#cb14-3" aria-hidden="true" tabindex="-1"></a><span class="in"> ```</span></span></code></pre></div> <h4 id="latex">LaTeX</h4> <p>Note that the <code>minted</code> LaTeX package need not be installed.</p> -<div class="sourceCode" id="cb15"><pre class="sourceCode latex"><code class="sourceCode latex"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true"></a><span class="kw">\begin</span>{<span class="ex">minted</span>}[param1=value1, param2=value2, ...]{cls}</span> -<span id="cb15-2"><a href="#cb15-2" aria-hidden="true"></a><span class="vs">...</span></span> -<span id="cb15-3"><a href="#cb15-3" aria-hidden="true"></a><span class="kw">\end</span>{<span class="ex">minted</span>}</span></code></pre></div> +<div class="sourceCode" id="cb15"><pre class="sourceCode latex"><code class="sourceCode latex"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a><span class="kw">\begin</span>{<span class="ex">minted</span>}[param1=value1, param2=value2, ...]{cls}</span> +<span id="cb15-2"><a href="#cb15-2" aria-hidden="true" tabindex="-1"></a><span class="vs">...</span></span> +<span id="cb15-3"><a href="#cb15-3" aria-hidden="true" tabindex="-1"></a><span class="kw">\end</span>{<span class="ex">minted</span>}</span></code></pre></div> <h3 id="parameters-and-options">Parameters and options</h3> <p>There are parameters that affect the figure that will be included in your document. Here are all the possible general parameters, in Markdown syntax:</p> -<div class="sourceCode" id="cb16"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true"></a> <span class="in">```{.cls </span></span> -<span id="cb16-2"><a href="#cb16-2" aria-hidden="true"></a><span class="in"> .language</span></span> -<span id="cb16-3"><a href="#cb16-3" aria-hidden="true"></a><span class="in"> directory=(path) </span></span> -<span id="cb16-4"><a href="#cb16-4" aria-hidden="true"></a><span class="in"> caption=(text) </span></span> -<span id="cb16-5"><a href="#cb16-5" aria-hidden="true"></a><span class="in"> format=(PNG|PDF|SVG|JPG|EPS|GIF|TIF|WEBP|HTML) </span></span> -<span id="cb16-6"><a href="#cb16-6" aria-hidden="true"></a><span class="in"> source=(true|false) </span></span> -<span id="cb16-7"><a href="#cb16-7" aria-hidden="true"></a><span class="in"> preamble=(path) </span></span> -<span id="cb16-8"><a href="#cb16-8" aria-hidden="true"></a><span class="in"> dpi=(integer)</span></span> -<span id="cb16-9"><a href="#cb16-9" aria-hidden="true"></a><span class="in"> dependencies=[...]</span></span> -<span id="cb16-10"><a href="#cb16-10" aria-hidden="true"></a><span class="in"> file=(path)</span></span> -<span id="cb16-11"><a href="#cb16-11" aria-hidden="true"></a><span class="in"> executable=(path) </span></span> -<span id="cb16-12"><a href="#cb16-12" aria-hidden="true"></a><span class="in"> caption_format=(text)</span></span> -<span id="cb16-13"><a href="#cb16-13" aria-hidden="true"></a><span class="in"> }</span></span> -<span id="cb16-14"><a href="#cb16-14" aria-hidden="true"></a><span class="in"> # script content</span></span> -<span id="cb16-15"><a href="#cb16-15" aria-hidden="true"></a><span class="in"> ```</span></span></code></pre></div> +<div class="sourceCode" id="cb16"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a> <span class="in">```{.cls </span></span> +<span id="cb16-2"><a href="#cb16-2" aria-hidden="true" tabindex="-1"></a><span class="in"> .language</span></span> +<span id="cb16-3"><a href="#cb16-3" aria-hidden="true" tabindex="-1"></a><span class="in"> directory=(path) </span></span> +<span id="cb16-4"><a href="#cb16-4" aria-hidden="true" tabindex="-1"></a><span class="in"> caption=(text) </span></span> +<span id="cb16-5"><a href="#cb16-5" aria-hidden="true" tabindex="-1"></a><span class="in"> format=(PNG|PDF|SVG|JPG|EPS|GIF|TIF|WEBP|HTML) </span></span> +<span id="cb16-6"><a href="#cb16-6" aria-hidden="true" tabindex="-1"></a><span class="in"> source=(true|false) </span></span> +<span id="cb16-7"><a href="#cb16-7" aria-hidden="true" tabindex="-1"></a><span class="in"> preamble=(path) </span></span> +<span id="cb16-8"><a href="#cb16-8" aria-hidden="true" tabindex="-1"></a><span class="in"> dpi=(integer)</span></span> +<span id="cb16-9"><a href="#cb16-9" aria-hidden="true" tabindex="-1"></a><span class="in"> dependencies=[...]</span></span> +<span id="cb16-10"><a href="#cb16-10" aria-hidden="true" tabindex="-1"></a><span class="in"> file=(path)</span></span> +<span id="cb16-11"><a href="#cb16-11" aria-hidden="true" tabindex="-1"></a><span class="in"> executable=(path) </span></span> +<span id="cb16-12"><a href="#cb16-12" aria-hidden="true" tabindex="-1"></a><span class="in"> caption_format=(text)</span></span> +<span id="cb16-13"><a href="#cb16-13" aria-hidden="true" tabindex="-1"></a><span class="in"> }</span></span> +<span id="cb16-14"><a href="#cb16-14" aria-hidden="true" tabindex="-1"></a><span class="in"> # script content</span></span> +<span id="cb16-15"><a href="#cb16-15" aria-hidden="true" tabindex="-1"></a><span class="in"> ```</span></span></code></pre></div> <ul> <li><code>cls</code> must be one of the following: <code>matplotlib</code>, <code>matlabplot</code>, <code>plotly_python</code>, <code>plotly_r</code>, <code>mathplot</code>, <code>octaveplot</code>, <code>ggplot2</code>, <code>gnuplot</code>, <code>graphviz</code>, <code>bokeh</code>, <code>plotsjl</code>.</li> </ul> @@ -265,144 +265,144 @@ The file MANUAL.md is automatically generated by the tools/mkmanual.ps1 script. </ul> <h4 id="code-highlighting">Code highlighting</h4> <p>If your editor supports code highlighting in code blocks, you can also include the programming language. In Markdown:</p> -<div class="sourceCode" id="cb17"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true"></a> <span class="in">```{.language .cls (options)}</span></span> -<span id="cb17-2"><a href="#cb17-2" aria-hidden="true"></a><span class="in"> # script content</span></span> -<span id="cb17-3"><a href="#cb17-3" aria-hidden="true"></a><span class="in"> ```</span></span></code></pre></div> +<div class="sourceCode" id="cb17"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a> <span class="in">```{.language .cls (options)}</span></span> +<span id="cb17-2"><a href="#cb17-2" aria-hidden="true" tabindex="-1"></a><span class="in"> # script content</span></span> +<span id="cb17-3"><a href="#cb17-3" aria-hidden="true" tabindex="-1"></a><span class="in"> ```</span></span></code></pre></div> <p>or Latex:</p> -<div class="sourceCode" id="cb18"><pre class="sourceCode latex"><code class="sourceCode latex"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true"></a> <span class="kw">\begin</span>{<span class="ex">minted</span>}[(options)]{language, cls}</span> -<span id="cb18-2"><a href="#cb18-2" aria-hidden="true"></a><span class="vs"> # script content</span></span> -<span id="cb18-3"><a href="#cb18-3" aria-hidden="true"></a><span class="vs"> </span><span class="kw">\end</span>{<span class="ex">minted</span>}</span></code></pre></div> +<div class="sourceCode" id="cb18"><pre class="sourceCode latex"><code class="sourceCode latex"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a> <span class="kw">\begin</span>{<span class="ex">minted</span>}[(options)]{language, cls}</span> +<span id="cb18-2"><a href="#cb18-2" aria-hidden="true" tabindex="-1"></a><span class="vs"> # script content</span></span> +<span id="cb18-3"><a href="#cb18-3" aria-hidden="true" tabindex="-1"></a><span class="vs"> </span><span class="kw">\end</span>{<span class="ex">minted</span>}</span></code></pre></div> <p>For example, for GGPlot2 figures:</p> -<div class="sourceCode" id="cb19"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true"></a> <span class="in">```{.r .ggplot2 caption=Highlighted code block}</span></span> -<span id="cb19-2"><a href="#cb19-2" aria-hidden="true"></a><span class="in"> # script content</span></span> -<span id="cb19-3"><a href="#cb19-3" aria-hidden="true"></a><span class="in"> ```</span></span></code></pre></div> +<div class="sourceCode" id="cb19"><pre class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a> <span class="in">```{.r .ggplot2 caption=Highlighted code block}</span></span> +<span id="cb19-2"><a href="#cb19-2" aria-hidden="true" tabindex="-1"></a><span class="in"> # script content</span></span> +<span id="cb19-3"><a href="#cb19-3" aria-hidden="true" tabindex="-1"></a><span class="in"> ```</span></span></code></pre></div> <p>or (Latex):</p> -<div class="sourceCode" id="cb20"><pre class="sourceCode latex"><code class="sourceCode latex"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true"></a> <span class="kw">\begin</span>{<span class="ex">minted</span>}[caption=Highlighted code block]{r, ggplot2}</span> -<span id="cb20-2"><a href="#cb20-2" aria-hidden="true"></a><span class="vs"> # script content</span></span> -<span id="cb20-3"><a href="#cb20-3" aria-hidden="true"></a><span class="vs"> </span><span class="kw">\end</span>{<span class="ex">minted</span>}</span></code></pre></div> +<div class="sourceCode" id="cb20"><pre class="sourceCode latex"><code class="sourceCode latex"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a> <span class="kw">\begin</span>{<span class="ex">minted</span>}[caption=Highlighted code block]{r, ggplot2}</span> +<span id="cb20-2"><a href="#cb20-2" aria-hidden="true" tabindex="-1"></a><span class="vs"> # script content</span></span> +<span id="cb20-3"><a href="#cb20-3" aria-hidden="true" tabindex="-1"></a><span class="vs"> </span><span class="kw">\end</span>{<span class="ex">minted</span>}</span></code></pre></div> <p>This way, you benefit from code highlighting <em>and</em> <code>pandoc-plot</code>.</p> <h3 id="interactive-html-figures">Interactive HTML figures</h3> <p>Interactive HTML figures are available for a few toolkits, e.g. <code>bokeh</code>. To make a figure interactive, use the output format <code>format=html</code>. This only makes sense if your output file is also HTML.</p> <p>You can take a look at the <a href="https://laurentrdc.github.io/pandoc-plot/">demonstration page</a> for an example result.</p> <p>Many interactive plots rely on javascript scripts stored on the internet. If you want to have a self-contained document that can be viewed offline – or you want your document to work for the next 10 years –, you can use pandoc’s <code>--self-contained</code> flag:</p> -<div class="sourceCode" id="cb21"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true"></a><span class="ex">pandoc</span> --self-contained --filter pandoc-plot -i mydoc.md -o webpage.html </s |