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

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/_sources/using.txt (modified) (2 diffs)

docs/_build/html/_sources/using.txt

@@ -131 +131 @@
 
 
-
-
-Full List of arguments
-++++++++++++++++++++++
+Charts
+++++++
+
+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
+**ID** and/or date. Some examples:
+
+- Render a chart of all the times already stamped, by **ID**::
+
+    stamps -g
+
+- Render a chart of the stamps for the last 4 days::
+
+    stamps -g 4d
+
+- Render a chart of the stamps for the **ID** *stamper* for the last week::
+
+    stamps -g stamper 1w
+
+.. note::
+
+   The charts will be saved into **~/.workstamps-charts**, in SVG_ format.
+   The name of the chart will be generated based on the current date and
+   time, and a *symbolic link* called **chart-latest.svg** will be created,
+   pointing to the latest chart generated.
+
+
+stamps - full List of arguments
+-------------------------------
+
+You can get the full list of arguments from the command line too::
+
+  stamps -h
+
+or::
+
+  stamps --help
 
 .. argparse::
@@ -188 +221 @@
 
 
+.. _SVG: http://en.wikipedia.org/wiki/Scalable_Vector_Graphics
+
 .. [1] http://repos.betabug.ch/stamp