2021-02-05 22:38:46 -06:00
|
|
|
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8" />
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
|
|
|
<title>Configuration — ZAZ documentation</title>
|
|
|
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
|
|
|
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
|
|
|
|
|
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
|
|
|
|
<script src="../_static/jquery.js"></script>
|
|
|
|
|
<script src="../_static/underscore.js"></script>
|
|
|
|
|
<script src="../_static/doctools.js"></script>
|
|
|
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
|
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
|
|
|
<link rel="prev" title="Introduction" href="intro.html" />
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
|
|
|
|
|
|
|
|
</head><body>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="document">
|
|
|
|
|
<div class="documentwrapper">
|
|
|
|
|
<div class="bodywrapper">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="body" role="main">
|
|
|
|
|
|
|
|
|
|
<div class="section" id="configuration">
|
|
|
|
|
<h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
|
|
|
|
|
<ul class="simple">
|
|
|
|
|
<li><p>Create new extension:</p></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p><code class="docutils literal notranslate"><span class="pre">./zaz.py</span> <span class="pre">-new</span> <span class="pre">-t</span> <span class="pre">~/projects</span> <span class="pre">-n</span> <span class="pre">MyGreatExtension</span></code></p>
|
|
|
|
|
<ul class="simple">
|
|
|
|
|
<li><p>Move to new folder:</p></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p><code class="docutils literal notranslate"><span class="pre">cd</span> <span class="pre">~/projects/MyGreatExtension</span></code></p>
|
|
|
|
|
<ul class="simple">
|
|
|
|
|
<li><p>Edit file <code class="docutils literal notranslate"><span class="pre">conf.py</span></code></p></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p><code class="docutils literal notranslate"><span class="pre">vim</span> <span class="pre">conf.py</span></code></p>
|
|
|
|
|
<div class="section" id="parameters">
|
|
|
|
|
<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
|
|
|
|
|
<p><strong>Configure correctly this options, before you start code your extension.</strong></p>
|
|
|
|
|
<p>Only modify this options.</p>
|
2021-02-05 22:46:31 -06:00
|
|
|
<div class="section" id="type-extension">
|
|
|
|
|
<h3>Type extension<a class="headerlink" href="#type-extension" title="Permalink to this headline">¶</a></h3>
|
|
|
|
|
<p><strong>TYPE_EXTENSION</strong></p>
|
2021-02-05 22:52:33 -06:00
|
|
|
<p>The type extension that you want develop.</p>
|
2021-02-05 22:46:31 -06:00
|
|
|
<ul class="simple">
|
|
|
|
|
<li><dl class="simple">
|
|
|
|
|
<dt>Integer</dt><dd><ul>
|
|
|
|
|
<li><p>1 = Normal extension</p></li>
|
|
|
|
|
<li><p>2 = New components</p></li>
|
|
|
|
|
<li><p>3 = Calc addin</p></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p>Example:</p>
|
|
|
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">TYPE_EXTENSION</span> <span class="o">=</span> <span class="mi">1</span>
|
|
|
|
|
</pre></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2021-02-05 22:56:36 -06:00
|
|
|
<div class="section" id="version">
|
|
|
|
|
<h3>Version<a class="headerlink" href="#version" title="Permalink to this headline">¶</a></h3>
|
2021-02-05 22:52:33 -06:00
|
|
|
<p><strong>VERSION</strong></p>
|
|
|
|
|
<ul class="simple">
|
|
|
|
|
<li><dl class="simple">
|
|
|
|
|
<dt>String</dt><dd><ul>
|
2021-02-05 22:56:36 -06:00
|
|
|
<li><p>The current version of extension, look: <a class="reference external" href="https://semver.org/">Semantic Versioning</a></p></li>
|
2021-02-05 22:52:33 -06:00
|
|
|
</ul>
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p>Example:</p>
|
|
|
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">VERSION</span> <span class="o">=</span> <span class="s1">'0.1.0'</span>
|
|
|
|
|
</pre></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2021-02-05 22:56:36 -06:00
|
|
|
<div class="section" id="name">
|
|
|
|
|
<h3>Name<a class="headerlink" href="#name" title="Permalink to this headline">¶</a></h3>
|
|
|
|
|
<p><strong>NAME</strong></p>
|
|
|
|
|
<ul class="simple">
|
|
|
|
|
<li><dl class="simple">
|
|
|
|
|
<dt>String</dt><dd><ul>
|
|
|
|
|
<li><p>Your extension name, not used spaces.</p></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p>Example:</p>
|
|
|
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">NAME</span> <span class="o">=</span> <span class="s1">'MyGreatExtension'</span>
|
|
|
|
|
</pre></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2021-02-05 22:59:39 -06:00
|
|
|
<div class="section" id="id-extension">
|
|
|
|
|
<h3>ID extension<a class="headerlink" href="#id-extension" title="Permalink to this headline">¶</a></h3>
|
|
|
|
|
<p>The internal name for extension.</p>
|
|
|
|
|
<p><strong>ID</strong></p>
|
|
|
|
|
<blockquote>
|
|
|
|
|
<div><ul class="simple">
|
|
|
|
|
<li><dl class="simple">
|
|
|
|
|
<dt>String</dt><dd><ul>
|
|
|
|
|
<li><p>Should be unique, used URL inverse</p></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div></blockquote>
|
|
|
|
|
<p>Example:</p>
|
|
|
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">ID</span> <span class="o">=</span> <span class="s1">'org.yourname.extensionname'</span>
|
|
|
|
|
</pre></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2021-02-06 21:20:00 -06:00
|
|
|
<div class="section" id="locales">
|
|
|
|
|
<h3>Locales<a class="headerlink" href="#locales" title="Permalink to this headline">¶</a></h3>
|
|
|
|
|
<p>If your extension will be multi-language (recommended)</p>
|
|
|
|
|
<p><strong>USE_LOCALES</strong></p>
|
|
|
|
|
<blockquote>
|
|
|
|
|
<div><ul class="simple">
|
|
|
|
|
<li><p>Bool</p></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div></blockquote>
|
|
|
|
|
<p>Example:</p>
|
|
|
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">USE_LOCALES</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
|
|
</pre></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="section" id="domain-for-locales">
|
|
|
|
|
<h3>Domain for locales<a class="headerlink" href="#domain-for-locales" title="Permalink to this headline">¶</a></h3>
|
|
|
|
|
<p>The base name for generate files POT</p>
|
|
|
|
|
<p><strong>DOMAIN</strong></p>
|
|
|
|
|
<blockquote>
|
|
|
|
|
<div><ul class="simple">
|
|
|
|
|
<li><p>String</p></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div></blockquote>
|
|
|
|
|
<p>Example:</p>
|
|
|
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">DOMAIN</span> <span class="o">=</span> <span class="s1">'base'</span>
|
|
|
|
|
</pre></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="section" id="path-pygettext">
|
|
|
|
|
<h3>Path pyGetText<a class="headerlink" href="#path-pygettext" title="Permalink to this headline">¶</a></h3>
|
|
|
|
|
<p>Absolute path for tool <cite>pygettext.py</cite> for generate POT.</p>
|
|
|
|
|
<p><strong>PATH_PYGETTEXT</strong></p>
|
|
|
|
|
<blockquote>
|
|
|
|
|
<div><ul class="simple">
|
|
|
|
|
<li><p>String</p></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div></blockquote>
|
|
|
|
|
<p>Example:</p>
|
|
|
|
|
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">PATH_PYGETTEXT</span> <span class="o">=</span> <span class="s1">'/usr/lib/python3.9/Tools/i18n/pygettext.py'</span>
|
|
|
|
|
</pre></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2021-02-05 22:38:46 -06:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
|
|
|
<div class="sphinxsidebarwrapper">
|
|
|
|
|
<h1 class="logo"><a href="../index.html">ZAZ</a></h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Navigation</h3>
|
|
|
|
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|
|
|
|
<ul class="current">
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
|
|
|
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Configuration</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="#parameters">Parameters</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<div class="relations">
|
|
|
|
|
<h3>Related Topics</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="../index.html">Documentation overview</a><ul>
|
|
|
|
|
<li>Previous: <a href="intro.html" title="previous chapter">Introduction</a></li>
|
|
|
|
|
</ul></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
<div id="searchbox" style="display: none" role="search">
|
|
|
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
|
|
|
<div class="searchformwrapper">
|
|
|
|
|
<form class="search" action="../search.html" method="get">
|
|
|
|
|
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
|
|
|
<input type="submit" value="Go" />
|
|
|
|
|
</form>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<script>$('#searchbox').show(0);</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="clearer"></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="footer">
|
|
|
|
|
©2021, Mauricio Baeza.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.4.3</a>
|
|
|
|
|
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../_sources/main/config.rst.txt"
|
|
|
|
|
rel="nofollow">Page source</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
