diff options
Diffstat (limited to 'docs/docgen/html/guides/contributing-language.html')
| -rw-r--r-- | docs/docgen/html/guides/contributing-language.html | 298 |
1 files changed, 0 insertions, 298 deletions
diff --git a/docs/docgen/html/guides/contributing-language.html b/docs/docgen/html/guides/contributing-language.html deleted file mode 100644 index 13f3d207..00000000 --- a/docs/docgen/html/guides/contributing-language.html +++ /dev/null @@ -1,298 +0,0 @@ - - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - <title>Contributing a new language — zmNinja documentation</title> - - - - - - - - - - - - - - - - - - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> - - - - - - <link rel="index" title="Index" - href="../genindex.html"/> - <link rel="search" title="Search" href="../search.html"/> - <link rel="top" title="zmNinja documentation" href="../index.html"/> - <link rel="next" title="Building from Source" href="source.html"/> - <link rel="prev" title="Desktop port tips" href="desktop.html"/> - - - <script src="../_static/js/modernizr.min.js"></script> - -</head> - -<body class="wy-body-for-nav" role="document"> - - - <div class="wy-grid-for-nav"> - - - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-scroll"> - <div class="wy-side-nav-search"> - - - - <a href="../index.html" class="icon icon-home"> zmNinja - - - - - <img src="../_static/ninja.png" class="logo" /> - - </a> - - - - - - - -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> - - - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - - - - - - - <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="FAQ.html">zmNinja FAQ</a></li> -<li class="toctree-l1"><a class="reference internal" href="validating-api.html">Validating APIs</a></li> -<li class="toctree-l1"><a class="reference internal" href="desktop.html">Desktop port tips</a></li> -<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing a new language</a><ul> -<li class="toctree-l2"><a class="reference internal" href="#adding-a-new-language">Adding a new language</a></li> -<li class="toctree-l2"><a class="reference internal" href="#main-language-file">Main Language file</a></li> -<li class="toctree-l2"><a class="reference internal" href="#translating-help-language-file">Translating Help language file</a></li> -<li class="toctree-l2"><a class="reference internal" href="#how-to-recognize-a-new-language">How to recognize a new language:</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="source.html">Building from Source</a></li> -<li class="toctree-l1"><a class="reference external" href="http://pliablepixels.github.io/zmeventnotification/docgen/html/index.html">Event Notification Server</a></li> -</ul> - - - - </div> - </div> - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="../index.html">zmNinja</a> - - </nav> - - - - <div class="wy-nav-content"> - <div class="rst-content"> - - - - - - - - - - - - - - - - -<div role="navigation" aria-label="breadcrumbs navigation"> - - <ul class="wy-breadcrumbs"> - - <li><a href="../index.html">Docs</a> »</li> - - <li>Contributing a new language</li> - - - <li class="wy-breadcrumbs-aside"> - - - <a href="../_sources/guides/contributing-language.rst.txt" rel="nofollow"> View page source</a> - - - </li> - - </ul> - - - <hr/> -</div> - <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> - <div itemprop="articleBody"> - - <div class="section" id="contributing-a-new-language"> -<h1>Contributing a new language<a class="headerlink" href="#contributing-a-new-language" title="Permalink to this headline">¶</a></h1> -<p>If you are familiar with using git, I’d prefer if you follow the Pull -Request process -<a class="reference external" href="https://github.com/pliablepixels/zmNinja/blob/master/CONTRIBUTING.md#steps-for-code-contribution">here</a>.</p> -<div class="section" id="adding-a-new-language"> -<h2>Adding a new language<a class="headerlink" href="#adding-a-new-language" title="Permalink to this headline">¶</a></h2> -<ul class="simple"> -<li>Languages translations are available -<a class="reference external" href="https://github.com/pliablepixels/zmNinja/tree/master/www/lang">here</a></li> -<li>To contribute a new language, add a new <code class="docutils literal"><span class="pre">locale-xx.json</span></code> (where -<code class="docutils literal"><span class="pre">xx</span></code> is your language code).</li> -<li>Ideally, you should also provide a language translation for the -zmNinja help file inside -<a class="reference external" href="https://github.com/pliablepixels/zmNinja/tree/master/www/lang/help">lang/help</a></li> -</ul> -<p>The best way is to simply look at an existing language translation and -follow the same model for yours. If any language translation keywords -are missed, it will fallback to English.</p> -</div> -<div class="section" id="main-language-file"> -<h2>Main Language file<a class="headerlink" href="#main-language-file" title="Permalink to this headline">¶</a></h2> -<ul class="simple"> -<li>Make sure there is no comma after the last element</li> -<li>Comments are not allowed</li> -<li>Make sure you don’t add ellipsis “…” anywhere, they are added to -messages in code when needed</li> -<li>After you complete the translation file, do the following:</li> -</ul> -<p>(replace <code class="docutils literal"><span class="pre">-it</span></code> with the language you are working on)</p> -<p><code class="docutils literal"><span class="pre">python</span> <span class="pre">./checklang.py</span> <span class="pre">-f</span> <span class="pre">locale-it.json</span> <span class="pre">-b</span></code></p> -<p>This validates your JSON file, makes sure all keys are in sync with -en -and if valid, creates pretty-locale-it.json. If you are sure it looks -good,</p> -<p><code class="docutils literal"><span class="pre">python</span> <span class="pre">./checklang.py</span> <span class="pre">-f</span> <span class="pre">locale-it.json</span> <span class="pre">-b</span> <span class="pre">-o</span></code></p> -<p>This validates your JSON file,makes sure all keys are in sync with -en -and if valid, OVERWRITES your local file with a pretty formatted -version, which is what you should PR</p> -</div> -<div class="section" id="translating-help-language-file"> -<h2>Translating Help language file<a class="headerlink" href="#translating-help-language-file" title="Permalink to this headline">¶</a></h2> -<ul class="simple"> -<li>Located inside lang/help</li> -<li>Please be careful not to mess up the html tags, please only focus on -text translation</li> -</ul> -</div> -<div class="section" id="how-to-recognize-a-new-language"> -<h2>How to recognize a new language:<a class="headerlink" href="#how-to-recognize-a-new-language" title="Permalink to this headline">¶</a></h2> -<p>(This is only for zmNinja developers. Not relevant for language -translators)</p> -<ul class="simple"> -<li>Modify languages array in NVR.js (look for <code class="docutils literal"><span class="pre">var</span> <span class="pre">languages</span></code>)</li> -<li>Register language glob code in app.js - make sure its added to array list and mapping (look for <code class="docutils literal"><span class="pre">registerAvailableLanguageKeys</span></code>)</li> -</ul> -</div> -</div> - - - </div> - <div class="articleComments"> - - </div> - </div> - <footer> - - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - - <a href="source.html" class="btn btn-neutral float-right" title="Building from Source" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - - - <a href="desktop.html" class="btn btn-neutral" title="Desktop port tips" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> - - </div> - - - <hr/> - - <div role="contentinfo"> - <p> - © Copyright 2019, Pliable Pixels. - - </p> - </div> - Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. - -</footer> - - </div> - </div> - - </section> - - </div> - - - - - - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT:'../', - VERSION:'', - COLLAPSE_INDEX:false, - FILE_SUFFIX:'.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt' - }; - </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/js/theme.js"></script> - - - - - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.StickyNav.enable(); - }); - </script> - - -</body> -</html>
\ No newline at end of file |