App-pandoc-preprocess
view release on metacpan or search on metacpan
ppp-Documentation.html view on Meta::CPAN
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<meta name="author" content="Daniel Bruder" />
<title>ppp Documentation</title>
<style type="text/css">code{white-space: pre;}</style>
</head>
<body>
<div id="header">
<h1 class="title"><code>ppp</code> Documentation</h1>
<h2 class="author">Daniel Bruder</h2>
<h3 class="date">Version 0.9.0</h3>
</div>
<!-- <#ifdef HANDOUT>
Explanation of the gpp feature ...
<#endif>
-->
<p></p>
<h1 id="abstract"><span class="header-section-number">1</span> Abstract</h1>
<p><em><code>ppp</code> allows you to use pandoc in new ways by rendering ASCII-markup to beautiful pictures right from within pandoc’s verbatim environments.</em></p>
<p><em>See below for illustrative examples and detailed usage instructions.</em></p>
<p><em>Bonus on top: Leaving out <code>ppp</code> form the typesetting pipeline will still render your document and the verbatims with the ASCII-markup will still stay readable!</em></p>
<hr />
<p></p>
<h1 id="general-usage"><span class="header-section-number">2</span> General usage</h1>
<p>In each case, you will use pandoc’s verbatim environment, set the rendering engine and additional options:</p>
<pre><code>~~~~~ {.renderer .option1 .option2=value2}
--- RENDERER-SPECIFIC MARKUP GOES HERE ---
~~~~~</code></pre>
<h2 id="general-renderers"><span class="header-section-number">2.1</span> General Renderers</h2>
<p>The renderers available to <code>ppp</code> are:</p>
<ul>
<li>ditaa</li>
<li>yuml diagrams:
<ul>
<li>class diagramas (cf. Figure )</li>
<li>usecase diagramas (cf. Figure )</li>
<li>activity diagramas (cf. Figure )</li>
</ul></li>
<li>dot</li>
<li>neato</li>
<li>rdfdot</li>
<li>plantuml</li>
</ul>
<h2 id="general-options"><span class="header-section-number">2.2</span> General Options</h2>
<p>This is a list of the general options, compatible with any type of renderer:</p>
<ul>
<li><code>.scale=90%</code></li>
<li><code>.label=fig:my-figure</code></li>
<li><code>.title="Some label for the figure"</code></li>
</ul>
<hr />
<p></p>
<h1 id="ditaa-diagrams"><span class="header-section-number">3</span> ditaa Diagrams</h1>
<p>In order to generate <code>ditaa</code>-diagrams, ditaa needs to be installed.</p>
<p>For an exhaustive list of options and possibilities, please check the <a href="http://ditaa.sourceforge.net/">ditaa homepage</a>.</p>
<h2 id="ditaa-options"><span class="header-section-number">3.1</span> ditaa Options</h2>
( run in 0.784 second using v1.01-cache-2.11-cpan-39bf76dae61 )