Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Made a few minor changes to the documentation.

  • Loading branch information...
commit cee7b4c8285eb13030cf2645e5a4fbef0e15c7ad 1 parent fc018ba
@liftoff authored
View
BIN  gateone/docs/build/doctrees/ReleaseNotes/index.doctree
Binary file not shown
View
BIN  gateone/docs/build/doctrees/UserGuide/index.doctree
Binary file not shown
View
BIN  gateone/docs/build/doctrees/environment.pickle
Binary file not shown
View
8 gateone/docs/build/html/Developer/embedding.html
@@ -29,7 +29,7 @@
<link rel="shortcut icon" href="../_static/favicon.png"/>
<link rel="top" title="Gate One 1.1.0 documentation" href="../index.html" />
<link rel="up" title="Developer Documentation" href="index.html" />
- <link rel="next" title="Release Notes" href="../ReleaseNotes/index.html" />
+ <link rel="next" title="Release Notes / Changelog" href="../ReleaseNotes/index.html" />
<link rel="prev" title="The Example Plugin" href="plugin_example.html" />
</head>
<body>
@@ -43,7 +43,7 @@
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
- <a href="../ReleaseNotes/index.html" title="Release Notes"
+ <a href="../ReleaseNotes/index.html" title="Release Notes / Changelog"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="plugin_example.html" title="The Example Plugin"
@@ -317,7 +317,7 @@
title="previous chapter">The Example Plugin</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../ReleaseNotes/index.html"
- title="next chapter">Release Notes</a></p>
+ title="next chapter">Release Notes / Changelog</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/Developer/embedding.txt"
@@ -350,7 +350,7 @@
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
- <a href="../ReleaseNotes/index.html" title="Release Notes"
+ <a href="../ReleaseNotes/index.html" title="Release Notes / Changelog"
>next</a> |</li>
<li class="right" >
<a href="plugin_example.html" title="The Example Plugin"
View
2  gateone/docs/build/html/Developer/index.html
@@ -278,7 +278,7 @@
title="previous chapter">User Guide</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="auth.html"
- title="next chapter"><tt class="docutils literal"><span class="pre">auth.py</span></tt> - Authentication Classes</a></p>
+ title="next chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">auth.py</span></tt> - Authentication Classes</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/Developer/index.txt"
View
2  gateone/docs/build/html/Developer/logviewer.html
@@ -208,7 +208,7 @@
<h4>Previous topic</h4>
<p class="topless"><a href="gateone.html"
- title="previous chapter"><tt class="docutils literal"><span class="pre">gateone.py</span></tt> - Gate One's Main Script</a></p>
+ title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">gateone.py</span></tt> - Gate One's Main Script</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="remote_syslog.html"
title="next chapter"><tt class="docutils literal"><span class="pre">remote_syslog.py</span></tt> - A module to send syslog messaged directly over UDP</a></p>
View
2  gateone/docs/build/html/Developer/terminal.html
@@ -1271,7 +1271,7 @@
<h4>Previous topic</h4>
<p class="topless"><a href="sso.html"
- title="previous chapter"><tt class="docutils literal"><span class="pre">sso.py</span></tt> - A Tornado Kerberos Single Sign-On Module</a></p>
+ title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">sso.py</span></tt> - A Tornado Kerberos Single Sign-On Module</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="termio.html"
title="next chapter"><tt class="docutils literal"><span class="pre">termio.py</span></tt> - Terminal Input/Output Module</a></p>
View
2  gateone/docs/build/html/Developer/termio.html
@@ -866,7 +866,7 @@
<h4>Previous topic</h4>
<p class="topless"><a href="terminal.html"
- title="previous chapter"><tt class="docutils literal docutils literal"><span class="pre">terminal.py</span></tt> - A Pure Python Terminal Emulator</a></p>
+ title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">terminal.py</span></tt> - A Pure Python Terminal Emulator</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="utils.html"
title="next chapter"><tt class="docutils literal docutils literal"><span class="pre">utils.py</span></tt> - Supporting Functions</a></p>
View
50 gateone/docs/build/html/ReleaseNotes/index.html
@@ -8,7 +8,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Release Notes &mdash; Gate One 1.1.0 documentation</title>
+ <title>Release Notes / Changelog &mdash; Gate One 1.1.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -52,10 +52,10 @@
<div class="bodywrapper">
<div class="body">
- <div class="section" id="release-notes">
-<span id="id1"></span><h1>Release Notes<a class="headerlink" href="#release-notes" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="id2">
-<h2>0.9<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
+ <div class="section" id="release-notes-changelog">
+<span id="release-notes"></span><h1>Release Notes / Changelog<a class="headerlink" href="#release-notes-changelog" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="id1">
+<h2>0.9<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<div class="section" id="release-date">
<h3>Release Date<a class="headerlink" href="#release-date" title="Permalink to this headline">¶</a></h3>
<p>October 13th, 2011</p>
@@ -69,14 +69,14 @@
</div>
</div>
</div>
+<div class="section" id="id2">
+<h2>1.0<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
<div class="section" id="id3">
-<h2>1.0<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
-<div class="section" id="id4">
-<h3>Release Date<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
+<h3>Release Date<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<p>March 6th, 2012</p>
</div>
-<div class="section" id="id5">
-<h3>Summary of Changes<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="id4">
+<h3>Summary of Changes<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
<p>This was the first packaged release of Gate One with commercial support available from <a class="reference external" href="http://liftoffsoftware.com/">Liftoff Software</a>. Highlights of changes since the beta:</p>
<blockquote>
<div><ul class="simple">
@@ -104,14 +104,14 @@
<p>See the git commit log for full details on all changes.</p>
</div>
</div>
+<div class="section" id="id5">
+<h2>1.1<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
<div class="section" id="id6">
-<h2>1.1<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
-<div class="section" id="id7">
-<h3>Release Date<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
+<h3>Release Date<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
<p>October Nth, 2012</p>
</div>
-<div class="section" id="id8">
-<h3>Summary of Changes<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="id7">
+<h3>Summary of Changes<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><ul class="simple">
<li>Now tracking changes in more detail.</li>
@@ -141,7 +141,7 @@
<li><strong>New Feature:</strong> Old user session logs are now automatically removed after a configurable time period. See the <tt class="xref py py-obj docutils literal"><span class="pre">session_logs_max_age</span></tt> option.</li>
<li><strong>New Feature:</strong> If you've set the number of rows/columns Gate One will now scale the size of each terminal in an attempt to fit it within the window. Looks much nicer than having a tiny-sized terminal in the upper left corner of the browser window.</li>
<li><strong>New Feature:</strong> Bookmarks can now be navigated via the keyboard. Ctrl-Alt-B will bring up the Bookmarks panel and you can then tab around to choose a bookmark.</li>
-<li><strong>New Feature:</strong> Gate One now includes a <tt class="docutils literal"><span class="pre">print</span></tt> stylesheet so if you print out a terminal it will actually look nice and readable. This wonderfully in conjunction with the &quot;Printable&quot; log view.</li>
+<li><strong>New Feature:</strong> Gate One now includes a <tt class="docutils literal"><span class="pre">print</span></tt> stylesheet so if you print out a terminal it will actually look nice and readable. This works wonderfully in conjunction with the &quot;Printable&quot; log view.</li>
<li><strong>New Feature:</strong> When copying text from a terminal it will now automatically be converted to plaintext (HTML formatting will be removed). It will also have trailing whitespace removed.</li>
<li><strong>New Feature:</strong> Added a new theme/text color scheme: Solarized. Thanks to Jakub Woyke for this contribution.</li>
<li><strong>Themes:</strong> Loads and loads of tweaks to improve Gate One's overall appearance in varying situations.</li>
@@ -204,6 +204,7 @@
<li><strong>gateone.js:</strong> Lots of minor API additions and changes. Too many to list; you'll just have to look at the docs. See: <a class="reference internal" href="../Developer/js_gateone.html#gateone-javascript"><em>gateone.js</em></a>.</li>
<li><strong>go_process.js:</strong> Before loading lines on the screen the Web Worker will now strip trailing whitespace. This should make copying &amp; pasting easier when dealing with multiple lines.</li>
<li><strong>index.html:</strong> Changed {{js_init}} to be {% raw js_init %} so people don't have to worry about Tornado's template engine turning things like quotes into HTML entities.</li>
+<li><strong>logviewer.py:</strong> The functions that play back and display .golog files have been modified to read log data in chunks to save huge amounts of memory. Playing back or displaying a gigantic log should now use as much memory as a small one (i.e. very little).</li>
<li><strong>terminal.py:</strong> Improved the ability of <tt class="xref py py-meth docutils literal"><span class="pre">Terminal.write()</span></tt> to detect and capture images by switching from using <a class="reference external" href="http://docs.python.org/2.7/library/re.html#re.match" title="(in Python v2.7)"><tt class="xref py py-func docutils literal"><span class="pre">re.match()</span></tt></a> to using <a class="reference external" href="http://docs.python.org/2.7/library/re.html#re.search" title="(in Python v2.7)"><tt class="xref py py-func docutils literal"><span class="pre">re.search()</span></tt></a>.</li>
<li><strong>terminal.py:</strong> Added a new global function: css_colors(). It just dumps the CSS style information for all the text colors that Terminal.dump_html() supports. The point is to make it easier for 3rd party apps to use dump_html().</li>
<li><strong>terminal.py:</strong> Added a new global at the bottom of the file: CSS_COLORS. It holds all the CSS classes used by the new css_colors() function.</li>
@@ -212,6 +213,7 @@
<li><strong>termio.py:</strong> Instances of <tt class="xref py py-obj docutils literal"><span class="pre">Multiplex()</span></tt> may now attach an <tt class="xref py py-obj docutils literal"><span class="pre">exitfunc</span></tt> that does exactly what you'd expect: It gets called when the spawned program is terminated.</li>
<li><strong>termio.py:</strong> You can now pass a string as the 'callback' argument to Multiplex.expect() and it will automatically be converted into a function that writes said string to the child process.</li>
<li><strong>termio.py:</strong> Changed <tt class="xref py py-obj docutils literal"><span class="pre">Multiplex.writeline()</span></tt> and <tt class="xref py py-obj docutils literal"><span class="pre">Multiplex.writelines()</span></tt> so they write <tt class="xref py py-obj docutils literal"><span class="pre">\r\n</span></tt> instead of just <tt class="xref py py-obj docutils literal"><span class="pre">\n</span></tt>. This should fix an issue with terminal programs that expect keystrokes instead of just newlines.</li>
+<li><strong>termio.py:</strong> The functions that handle how logs are finalized have been modified to reduce memory consumption by orders of magnitude. For example, when finalizing a humongous .golog, the <tt class="xref py py-obj docutils literal"><span class="pre">get_or_update_metadata()</span></tt> function will now read the file in chunks and be very conservative about the whole process instead of reading the entire log into memory before performing operations.</li>
<li><strong>utils.py:</strong> Increased the timeout value on the openssl commands since the default 5-second timeout wasn't long enough on slower systems.</li>
<li><strong>Playback Plugin:</strong> The logic that adds the playback controls has been modified to use the new <a class="reference internal" href="../Developer/js_gateone.html#GateOne.prefs.rowAdjust" title="GateOne.prefs.rowAdjust"><tt class="xref js js-attr docutils literal"><span class="pre">GateOne.prefs.rowAdjust</span></tt></a> property (JavaScript).</li>
<li><strong>Playback plugin:</strong> Whether or not the playback controls will appear can now be configured via the <tt class="xref py py-obj docutils literal"><span class="pre">GateOne.prefs.showPlaybackControls</span></tt> option. So if you're embedding Gate One and don't want the playback controls just pass <tt class="xref py py-obj docutils literal"><span class="pre">showPlaybackControls:</span> <span class="pre">false</span></tt> to <a class="reference internal" href="../Developer/js_gateone.html#GateOne.init" title="GateOne.init"><tt class="xref js js-func docutils literal"><span class="pre">GateOne.init()</span></tt></a>.</li>
@@ -239,20 +241,20 @@
</a></p>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
-<li><a class="reference internal" href="#">Release Notes</a><ul>
-<li><a class="reference internal" href="#id2">0.9</a><ul>
+<li><a class="reference internal" href="#">Release Notes / Changelog</a><ul>
+<li><a class="reference internal" href="#id1">0.9</a><ul>
<li><a class="reference internal" href="#release-date">Release Date</a></li>
<li><a class="reference internal" href="#summary-of-changes">Summary of Changes</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#id3">1.0</a><ul>
-<li><a class="reference internal" href="#id4">Release Date</a></li>
-<li><a class="reference internal" href="#id5">Summary of Changes</a></li>
+<li><a class="reference internal" href="#id2">1.0</a><ul>
+<li><a class="reference internal" href="#id3">Release Date</a></li>
+<li><a class="reference internal" href="#id4">Summary of Changes</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#id6">1.1</a><ul>
-<li><a class="reference internal" href="#id7">Release Date</a></li>
-<li><a class="reference internal" href="#id8">Summary of Changes</a></li>
+<li><a class="reference internal" href="#id5">1.1</a><ul>
+<li><a class="reference internal" href="#id6">Release Date</a></li>
+<li><a class="reference internal" href="#id7">Summary of Changes</a></li>
<li><a class="reference internal" href="#notable-bugs-fixes">Notable Bugs Fixes</a></li>
<li><a class="reference internal" href="#other-notable-changes">Other Notable Changes</a></li>
</ul>
View
2  gateone/docs/build/html/UserGuide/index.html
@@ -240,7 +240,7 @@
</div>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
-<p class="last">Themes are just CSS files and are easy to edit. <tt class="docutils literal"><span class="pre">black.css</span></tt> and <tt class="docutils literal"><span class="pre">white.css</span></tt> are in <tt class="docutils literal"><span class="pre">&lt;path</span> <span class="pre">to</span> <span class="pre">gateone&gt;/templates/themes</span></tt>. Copy one and start making your own! If it turns out pretty good send it to us and we'll include it in the code.</p>
+<p class="last">Themes are just CSS files and are easy to edit. <tt class="docutils literal"><span class="pre">black.css</span></tt> and <tt class="docutils literal"><span class="pre">white.css</span></tt> are in <tt class="docutils literal"><span class="pre">&lt;path</span> <span class="pre">to</span> <span class="pre">gateone&gt;/templates/themes</span></tt>. Copy one and start making your own! If it turns out pretty good send it to us and we'll include it with Gate One.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
View
8 gateone/docs/build/html/_sources/ReleaseNotes/index.txt
@@ -1,7 +1,7 @@
.. _release-notes:
-Release Notes
-=============
+Release Notes / Changelog
+=========================
0.9
---
@@ -83,7 +83,7 @@ Summary of Changes
* **New Feature:** Old user session logs are now automatically removed after a configurable time period. See the `session_logs_max_age` option.
* **New Feature:** If you've set the number of rows/columns Gate One will now scale the size of each terminal in an attempt to fit it within the window. Looks much nicer than having a tiny-sized terminal in the upper left corner of the browser window.
* **New Feature:** Bookmarks can now be navigated via the keyboard. Ctrl-Alt-B will bring up the Bookmarks panel and you can then tab around to choose a bookmark.
- * **New Feature:** Gate One now includes a ``print`` stylesheet so if you print out a terminal it will actually look nice and readable. This wonderfully in conjunction with the "Printable" log view.
+ * **New Feature:** Gate One now includes a ``print`` stylesheet so if you print out a terminal it will actually look nice and readable. This works wonderfully in conjunction with the "Printable" log view.
* **New Feature:** When copying text from a terminal it will now automatically be converted to plaintext (HTML formatting will be removed). It will also have trailing whitespace removed.
* **New Feature:** Added a new theme/text color scheme: Solarized. Thanks to Jakub Woyke for this contribution.
* **Themes:** Loads and loads of tweaks to improve Gate One's overall appearance in varying situations.
@@ -139,6 +139,7 @@ Other Notable Changes
* **gateone.js:** Lots of minor API additions and changes. Too many to list; you'll just have to look at the docs. See: :ref:`gateone-javascript`.
* **go_process.js:** Before loading lines on the screen the Web Worker will now strip trailing whitespace. This should make copying & pasting easier when dealing with multiple lines.
* **index.html:** Changed {{js_init}} to be {% raw js_init %} so people don't have to worry about Tornado's template engine turning things like quotes into HTML entities.
+ * **logviewer.py:** The functions that play back and display .golog files have been modified to read log data in chunks to save huge amounts of memory. Playing back or displaying a gigantic log should now use as much memory as a small one (i.e. very little).
* **terminal.py:** Improved the ability of :py:meth:`Terminal.write` to detect and capture images by switching from using :py:func:`re.match` to using :py:func:`re.search`.
* **terminal.py:** Added a new global function: css_colors(). It just dumps the CSS style information for all the text colors that Terminal.dump_html() supports. The point is to make it easier for 3rd party apps to use dump_html().
* **terminal.py:** Added a new global at the bottom of the file: CSS_COLORS. It holds all the CSS classes used by the new css_colors() function.
@@ -147,6 +148,7 @@ Other Notable Changes
* **termio.py:** Instances of `Multiplex()` may now attach an `exitfunc` that does exactly what you'd expect: It gets called when the spawned program is terminated.
* **termio.py:** You can now pass a string as the 'callback' argument to Multiplex.expect() and it will automatically be converted into a function that writes said string to the child process.
* **termio.py:** Changed `Multiplex.writeline()` and `Multiplex.writelines()` so they write `\\r\\n` instead of just `\\n`. This should fix an issue with terminal programs that expect keystrokes instead of just newlines.
+ * **termio.py:** The functions that handle how logs are finalized have been modified to reduce memory consumption by orders of magnitude. For example, when finalizing a humongous .golog, the `get_or_update_metadata()` function will now read the file in chunks and be very conservative about the whole process instead of reading the entire log into memory before performing operations.
* **utils.py:** Increased the timeout value on the openssl commands since the default 5-second timeout wasn't long enough on slower systems.
* **Playback Plugin:** The logic that adds the playback controls has been modified to use the new :js:attr:`GateOne.prefs.rowAdjust` property (JavaScript).
* **Playback plugin:** Whether or not the playback controls will appear can now be configured via the `GateOne.prefs.showPlaybackControls` option. So if you're embedding Gate One and don't want the playback controls just pass `showPlaybackControls: false` to :js:func:`GateOne.init`.
View
2  gateone/docs/build/html/_sources/UserGuide/index.txt
@@ -163,7 +163,7 @@ This controls the look and feel of Gate One. When selected, the chosen theme wi
White Theme
-.. tip:: Themes are just CSS files and are easy to edit. ``black.css`` and ``white.css`` are in ``<path to gateone>/templates/themes``. Copy one and start making your own! If it turns out pretty good send it to us and we'll include it in the code.
+.. tip:: Themes are just CSS files and are easy to edit. ``black.css`` and ``white.css`` are in ``<path to gateone>/templates/themes``. Copy one and start making your own! If it turns out pretty good send it to us and we'll include it with Gate One.
.. note:: The black scheme doesn't actually have a black background (it's #222)... Why? So the panels can have shadows which provides important contrast. Essentially, it is easier on the eyes.
View
8 gateone/docs/build/html/index.html
@@ -80,10 +80,10 @@
<li class="toctree-l2"><a class="reference internal" href="Developer/index.html#embeddeding-gate-one-into-other-applications">Embeddeding Gate One Into Other Applications</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="ReleaseNotes/index.html">Release Notes</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="ReleaseNotes/index.html#id2">0.9</a></li>
-<li class="toctree-l2"><a class="reference internal" href="ReleaseNotes/index.html#id3">1.0</a></li>
-<li class="toctree-l2"><a class="reference internal" href="ReleaseNotes/index.html#id6">1.1</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ReleaseNotes/index.html">Release Notes / Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="ReleaseNotes/index.html#id1">0.9</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ReleaseNotes/index.html#id2">1.0</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ReleaseNotes/index.html#id5">1.1</a></li>
</ul>
</li>
</ul>
View
BIN  gateone/docs/build/html/objects.inv
Binary file not shown
View
2  gateone/docs/build/html/searchindex.js
1 addition, 1 deletion not shown
View
8 gateone/docs/source/ReleaseNotes/index.rst
@@ -1,7 +1,7 @@
.. _release-notes:
-Release Notes
-=============
+Release Notes / Changelog
+=========================
0.9
---
@@ -83,7 +83,7 @@ Summary of Changes
* **New Feature:** Old user session logs are now automatically removed after a configurable time period. See the `session_logs_max_age` option.
* **New Feature:** If you've set the number of rows/columns Gate One will now scale the size of each terminal in an attempt to fit it within the window. Looks much nicer than having a tiny-sized terminal in the upper left corner of the browser window.
* **New Feature:** Bookmarks can now be navigated via the keyboard. Ctrl-Alt-B will bring up the Bookmarks panel and you can then tab around to choose a bookmark.
- * **New Feature:** Gate One now includes a ``print`` stylesheet so if you print out a terminal it will actually look nice and readable. This wonderfully in conjunction with the "Printable" log view.
+ * **New Feature:** Gate One now includes a ``print`` stylesheet so if you print out a terminal it will actually look nice and readable. This works wonderfully in conjunction with the "Printable" log view.
* **New Feature:** When copying text from a terminal it will now automatically be converted to plaintext (HTML formatting will be removed). It will also have trailing whitespace removed.
* **New Feature:** Added a new theme/text color scheme: Solarized. Thanks to Jakub Woyke for this contribution.
* **Themes:** Loads and loads of tweaks to improve Gate One's overall appearance in varying situations.
@@ -139,6 +139,7 @@ Other Notable Changes
* **gateone.js:** Lots of minor API additions and changes. Too many to list; you'll just have to look at the docs. See: :ref:`gateone-javascript`.
* **go_process.js:** Before loading lines on the screen the Web Worker will now strip trailing whitespace. This should make copying & pasting easier when dealing with multiple lines.
* **index.html:** Changed {{js_init}} to be {% raw js_init %} so people don't have to worry about Tornado's template engine turning things like quotes into HTML entities.
+ * **logviewer.py:** The functions that play back and display .golog files have been modified to read log data in chunks to save huge amounts of memory. Playing back or displaying a gigantic log should now use as much memory as a small one (i.e. very little).
* **terminal.py:** Improved the ability of :py:meth:`Terminal.write` to detect and capture images by switching from using :py:func:`re.match` to using :py:func:`re.search`.
* **terminal.py:** Added a new global function: css_colors(). It just dumps the CSS style information for all the text colors that Terminal.dump_html() supports. The point is to make it easier for 3rd party apps to use dump_html().
* **terminal.py:** Added a new global at the bottom of the file: CSS_COLORS. It holds all the CSS classes used by the new css_colors() function.
@@ -147,6 +148,7 @@ Other Notable Changes
* **termio.py:** Instances of `Multiplex()` may now attach an `exitfunc` that does exactly what you'd expect: It gets called when the spawned program is terminated.
* **termio.py:** You can now pass a string as the 'callback' argument to Multiplex.expect() and it will automatically be converted into a function that writes said string to the child process.
* **termio.py:** Changed `Multiplex.writeline()` and `Multiplex.writelines()` so they write `\\r\\n` instead of just `\\n`. This should fix an issue with terminal programs that expect keystrokes instead of just newlines.
+ * **termio.py:** The functions that handle how logs are finalized have been modified to reduce memory consumption by orders of magnitude. For example, when finalizing a humongous .golog, the `get_or_update_metadata()` function will now read the file in chunks and be very conservative about the whole process instead of reading the entire log into memory before performing operations.
* **utils.py:** Increased the timeout value on the openssl commands since the default 5-second timeout wasn't long enough on slower systems.
* **Playback Plugin:** The logic that adds the playback controls has been modified to use the new :js:attr:`GateOne.prefs.rowAdjust` property (JavaScript).
* **Playback plugin:** Whether or not the playback controls will appear can now be configured via the `GateOne.prefs.showPlaybackControls` option. So if you're embedding Gate One and don't want the playback controls just pass `showPlaybackControls: false` to :js:func:`GateOne.init`.
View
2  gateone/docs/source/UserGuide/index.rst
@@ -163,7 +163,7 @@ This controls the look and feel of Gate One. When selected, the chosen theme wi
White Theme
-.. tip:: Themes are just CSS files and are easy to edit. ``black.css`` and ``white.css`` are in ``<path to gateone>/templates/themes``. Copy one and start making your own! If it turns out pretty good send it to us and we'll include it in the code.
+.. tip:: Themes are just CSS files and are easy to edit. ``black.css`` and ``white.css`` are in ``<path to gateone>/templates/themes``. Copy one and start making your own! If it turns out pretty good send it to us and we'll include it with Gate One.
.. note:: The black scheme doesn't actually have a black background (it's #222)... Why? So the panels can have shadows which provides important contrast. Essentially, it is easier on the eyes.
Please sign in to comment.
Something went wrong with that request. Please try again.