jexelmans
/
drawio2py


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
							
<!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="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Welcome to DrawioConvert’s documentation! &#8212; DrawioConvert 0.2 documentation</title>
    <link rel="stylesheet" href="_static/haiku.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" type="text/css" href="_static/styles.css" />
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/language_data.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="How to Execute DrawioConvert?" href="execute.html" /> 
  </head><body>
      <div class="header" role="banner"><h1 class="heading"><a href="#">
          <span>DrawioConvert 0.2 documentation</span></a></h1>
        <h2 class="heading"><span>Welcome to DrawioConvert’s documentation!</span></h2>
      </div>
      <div class="topnav" role="navigation" aria-label="top navigation">
      
        <p>
        <a class="uplink" href="#">Contents</a>
        &#160;&#160;::&#160;&#160;
        <a href="execute.html">How to Execute <code class="code docutils literal notranslate"><span class="pre">DrawioConvert</span></code>?</a>&#160;&#160;»
        </p>

      </div>
      <div class="content">
        
        
  <div class="section" id="welcome-to-drawioconvert-s-documentation">
<h1>Welcome to DrawioConvert’s documentation!<a class="headerlink" href="#welcome-to-drawioconvert-s-documentation" title="Permalink to this headline">¶</a></h1>
<p><code class="code docutils literal notranslate"><span class="pre">DrawioConvert</span></code> is a project that allows conversion from simple, yet
structured <a class="reference external" href="https://www.diagrams.net">draw.io</a> diagrams to any kind of file.
This usually provides a useful entrypoint for visual modelling of models that
comply to a textual framework.</p>
<p>Or, more specifically, this tool allows for the creation of graphical
interfaces for code frameworks. Note that, while this tool was written in
Python, any language is possible thanks to
<a class="reference external" href="https://jinja.palletsprojects.com/en/2.11.x/">Jinja 2</a>.</p>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><dl class="first docutils">
<dt>Standard Libraries:</dt>
<dd><ul class="first last">
<li><code class="code docutils literal notranslate"><span class="pre">xml</span></code> (for <code class="code docutils literal notranslate"><span class="pre">xml.etree.ElementTree</span></code>)</li>
<li><code class="code docutils literal notranslate"><span class="pre">urllib</span></code> (for <code class="code docutils literal notranslate"><span class="pre">urllib.parse.unquote</span></code>)</li>
<li><code class="code docutils literal notranslate"><span class="pre">argparse</span></code></li>
<li><code class="code docutils literal notranslate"><span class="pre">base64</span></code></li>
<li><code class="code docutils literal notranslate"><span class="pre">os</span></code></li>
<li><code class="code docutils literal notranslate"><span class="pre">re</span></code></li>
<li><code class="code docutils literal notranslate"><span class="pre">sys</span></code></li>
<li><code class="code docutils literal notranslate"><span class="pre">zlib</span></code></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>External Libraries:</dt>
<dd><ul class="first last">
<li><a class="reference external" href="https://jinja.palletsprojects.com/en/2.11.x/">Jinja 2</a></li>
<li>Anything else that is required for the converted files to work.</li>
</ul>
</dd>
</dl>
</li>
</ul>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last"><code class="code docutils literal notranslate"><span class="pre">DrawioConvert</span></code> does not execute the converted files, but only
generates them! The user is required to install all components for the
formalisms they like to use themselves.</p>
</div>
</div>
<div class="section" id="how-does-it-work">
<h2>How Does It Work?<a class="headerlink" href="#how-does-it-work" title="Permalink to this headline">¶</a></h2>
<p>The core idea behind <code class="code docutils literal notranslate"><span class="pre">DrawioConvert</span></code> is the use of so-called “formalisms”.
These are generic descriptions of how certain drawio files can (and should) be
interpreted. They are provided with some setup information, a few template
files, a drawio library and some documentation on their usage. From any drawio
file (made according to the specification identified by the formalism) a new
one will be generated that is complient with the drawn diagram and the selected
formalism.</p>
<p>This also allows drawio to be used for any block-based modelling language for
which a graphical representation can be given and code generation can be
defined.</p>
</div>
<div class="section" id="quick-links">
<h2>Quick Links<a class="headerlink" href="#quick-links" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="execute.html">How to Execute <code class="code docutils literal notranslate"><span class="pre">DrawioConvert</span></code>?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="execute.html#commandline-arguments">Commandline Arguments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="formalisms/create.html">How To Create Custom Formalisms?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="formalisms/create.html#structure">Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="formalisms/create.html#templates">Templates</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="builtin-formalisms">
<h2>Builtin Formalisms<a class="headerlink" href="#builtin-formalisms" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="formalisms/CBD.html">CBD Formalism</a></li>
</ul>
</div>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>


      </div>
      <div class="bottomnav" role="navigation" aria-label="bottom navigation">
      
        <p>
        <a class="uplink" href="#">Contents</a>
        &#160;&#160;::&#160;&#160;
        <a href="execute.html">How to Execute <code class="code docutils literal notranslate"><span class="pre">DrawioConvert</span></code>?</a>&#160;&#160;»
        </p>

      </div>

    <div class="footer" role="contentinfo">
        &#169; Copyright 2020, Randy Paredis.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
    </div>
  </body>
</html>