Changeset 44:5f48fc9d6e7d in stamper for docs/_build/html/using.html

Timestamp:

Aug 14, 2014, 9:17:17 AM (10 years ago)

Author:

Borja Lopez <borja@…>

Branch:

default

Phase:

public

Message:

Added charts generation documentation

Added information on how to get the list of full arguments on the command
line for the stamps tool

File:

• docs/_build/html/using.html (modified) (4 diffs)

docs/_build/html/using.html

@@ -61 +61 @@
 <li><a class="reference internal" href="#per-day-details" id="id9">Per day details</a></li>
 <li><a class="reference internal" href="#timeline" id="id10">Timeline</a></li>
-<li><a class="reference internal" href="#full-list-of-arguments" id="id11">Full List of arguments</a></li>
-</ul>
-</li>
-<li><a class="reference internal" href="#date-based-filtering" id="id12">Date-based filtering</a></li>
+<li><a class="reference internal" href="#charts" id="id11">Charts</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#stamps-full-list-of-arguments" id="id12">stamps - full List of arguments</a></li>
+<li><a class="reference internal" href="#date-based-filtering" id="id13">Date-based filtering</a></li>
 </ul>
 </li>
@@ -200 +201 @@
 </div>
 </div>
-<div class="section" id="full-list-of-arguments">
-<h3><a class="toc-backref" href="#id11">Full List of arguments</a><a class="headerlink" href="#full-list-of-arguments" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="charts">
+<h3><a class="toc-backref" href="#id11">Charts</a><a class="headerlink" href="#charts" title="Permalink to this headline">¶</a></h3>
+<p>You can generate some nice charts from your stamps. So far only bar charts
+showing the total time per day can be generated, but you can filter them by
+<strong>ID</strong> and/or date. Some examples:</p>
+<ul>
+<li><p class="first">Render a chart of all the times already stamped, by <strong>ID</strong>:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">stamps</span> <span class="o">-</span><span class="n">g</span>
+</pre></div>
+</div>
+</li>
+<li><p class="first">Render a chart of the stamps for the last 4 days:</p>
+<div class="highlight-python"><div class="highlight"><pre>stamps -g 4d
+</pre></div>
+</div>
+</li>
+<li><p class="first">Render a chart of the stamps for the <strong>ID</strong> <em>stamper</em> for the last week:</p>
+<div class="highlight-python"><div class="highlight"><pre>stamps -g stamper 1w
+</pre></div>
+</div>
+</li>
+</ul>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The charts will be saved into <strong>~/.workstamps-charts</strong>, in <a class="reference external" href="http://en.wikipedia.org/wiki/Scalable_Vector_Graphics">SVG</a> format.
+The name of the chart will be generated based on the current date and
+time, and a <em>symbolic link</em> called <strong>chart-latest.svg</strong> will be created,
+pointing to the latest chart generated.</p>
+</div>
+</div>
+</div>
+<div class="section" id="stamps-full-list-of-arguments">
+<h2><a class="toc-backref" href="#id12">stamps - full List of arguments</a><a class="headerlink" href="#stamps-full-list-of-arguments" title="Permalink to this headline">¶</a></h2>
+<p>You can get the full list of arguments from the command line too:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">stamps</span> <span class="o">-</span><span class="n">h</span>
+</pre></div>
+</div>
+<p>or:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">stamps</span> <span class="o">--</span><span class="n">help</span>
+</pre></div>
+</div>
 <p>stamps: show recorded times information</p>
 <pre class="literal-block">
@@ -254 +294 @@
 </dl>
 </div>
-</div>
 <div class="section" id="date-based-filtering">
-<span id="id2"></span><h2><a class="toc-backref" href="#id12">Date-based filtering</a><a class="headerlink" href="#date-based-filtering" title="Permalink to this headline">¶</a></h2>
+<span id="id2"></span><h2><a class="toc-backref" href="#id13">Date-based filtering</a><a class="headerlink" href="#date-based-filtering" title="Permalink to this headline">¶</a></h2>
 <p>Most of the results returned by the <em>stamps</em> tool can be filtered using the
 following date-based filters:</p>
@@ -328 +367 @@
 <li><a class="reference internal" href="#per-day-details">Per day details</a></li>
 <li><a class="reference internal" href="#timeline">Timeline</a></li>
-<li><a class="reference internal" href="#full-list-of-arguments">Full List of arguments</a></li>
-</ul>
-</li>
+<li><a class="reference internal" href="#charts">Charts</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#stamps-full-list-of-arguments">stamps - full List of arguments</a></li>
 <li><a class="reference internal" href="#date-based-filtering">Date-based filtering</a></li>
 </ul>