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


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • docs/_build/html/_sources/using.txt

    r42 r44  
    131131
    132132
    133 
    134 
    135 Full List of arguments
    136 ++++++++++++++++++++++
     133Charts
     134++++++
     135
     136You can generate some nice charts from your stamps. So far only bar charts
     137showing the total time per day can be generated, but you can filter them by
     138**ID** and/or date. Some examples:
     139
     140- Render a chart of all the times already stamped, by **ID**::
     141
     142    stamps -g
     143
     144- Render a chart of the stamps for the last 4 days::
     145
     146    stamps -g 4d
     147
     148- Render a chart of the stamps for the **ID** *stamper* for the last week::
     149
     150    stamps -g stamper 1w
     151
     152.. note::
     153
     154   The charts will be saved into **~/.workstamps-charts**, in SVG_ format.
     155   The name of the chart will be generated based on the current date and
     156   time, and a *symbolic link* called **chart-latest.svg** will be created,
     157   pointing to the latest chart generated.
     158
     159
     160stamps - full List of arguments
     161-------------------------------
     162
     163You can get the full list of arguments from the command line too::
     164
     165  stamps -h
     166
     167or::
     168
     169  stamps --help
    137170
    138171.. argparse::
     
    188221
    189222
     223.. _SVG: http://en.wikipedia.org/wiki/Scalable_Vector_Graphics
     224
    190225.. [1] http://repos.betabug.ch/stamp
Note: See TracChangeset for help on using the changeset viewer.