summaryrefslogtreecommitdiff
path: root/docs/html/users_guide/editors.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/html/users_guide/editors.html')
-rw-r--r--docs/html/users_guide/editors.html145
1 files changed, 145 insertions, 0 deletions
diff --git a/docs/html/users_guide/editors.html b/docs/html/users_guide/editors.html
new file mode 100644
index 0000000..d6d5ce6
--- /dev/null
+++ b/docs/html/users_guide/editors.html
@@ -0,0 +1,145 @@
+
+<!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" />
+ <title>Visual Editors &#8212; Cheetah3 - The Python-Powered Template Engine</title>
+ <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../',
+ VERSION: '3.1.0',
+ 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>
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="Useful Web Links" href="links.html" />
+ <link rel="prev" title="Batteries included: templates and other libraries" href="libraries.html" />
+ </head>
+ <body>
+ <div class="related" role="navigation" aria-label="related navigation">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="links.html" title="Useful Web Links"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="libraries.html" title="Batteries included: templates and other libraries"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="../index.html">Cheetah3 - The Python-Powered Template Engine</a> &#187;</li>
+ <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Cheetah User’s Guide</a> &#187;</li>
+ </ul>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="libraries.html"
+ title="previous chapter">Batteries included: templates and other libraries</a></p>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="links.html"
+ title="next chapter">Useful Web Links</a></p>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/users_guide/editors.rst.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+ </div>
+<div id="searchbox" style="display: none" role="search">
+ <h3>Quick search</h3>
+ <form class="search" action="../search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="visual-editors">
+<h1>Visual Editors<a class="headerlink" href="#visual-editors" title="Permalink to this headline">¶</a></h1>
+<p>(visualEditors)</p>
+<p>This chapter is about maintaining Cheetah templates with visual
+editors, and the tradeoffs between making it friendly to both text
+editors and visual editors.</p>
+<p>Cheetah’s main developers do not use visual editors. Tavis uses
+{emacs}; Mike uses {vim}. So our first priority is to make
+templates easy to maintain in text editors. In particular, we don’t
+want to add features like Zope Page Template’s
+placeholder-value-with-mock-text-for-visual-editors-all-in-an-XML-tag.
+The syntax is so verbose it makes for a whole lotta typing just to
+insert a simple placeholder, for the benefit of editors we never
+use. However, as users identify features which would help their
+visual editing without making it harder to maintain templates in a
+text editor, we’re all for it.</p>
+<p>As it said in the introduction, Cheetah purposely does not use
+HTML/XML tags for $placeholders or #directives. That way, when you
+preview the template in an editor that interprets HTML tags, you’ll
+still see the placeholder and directive source definitions, which
+provides some “mock text” even if it’s not the size the final
+values will be, and allows you to use your imagination to translate
+how the directive output will look visually in the final.</p>
+<p>If your editor has syntax highlighting, turn it on. That makes a
+big difference in terms of making the template easier to edit.
+Since no “Cheetah mode” has been invented yet, set your
+highlighting to Perl mode, and at least the directives/placeholders
+will show up in different colors, although the editor won’t
+reliably guess where the directive/placeholder ends and normal text
+begins.</p>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related" role="navigation" aria-label="related navigation">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="links.html" title="Useful Web Links"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="libraries.html" title="Batteries included: templates and other libraries"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="../index.html">Cheetah3 - The Python-Powered Template Engine</a> &#187;</li>
+ <li class="nav-item nav-item-1"><a href="index.html" >Cheetah User’s Guide</a> &#187;</li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ &#169; Copyright 2017, Oleg Broytman; 2009-2012, R. Tyler Croy; 2001-2008, The Cheetah Development Team..
+ Last updated on Mar 03, 2018.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
+ </div>
+ </body>
+</html> \ No newline at end of file