normalize style, sorry :(
This commit is contained in:
Abraham Toriz
parent
ed3d8a7ab5
commit
4d96688b9b
|
|
@ -86,50 +86,50 @@ Tutorial
|
|||
.. _life-cycle:
|
||||
|
||||
Life Cycle
|
||||
^^^^^^^^^^^^^^^^
|
||||
..........
|
||||
|
||||
Tiempo has the following life cycle:
|
||||
|
||||
1. ``in``. Starts activity time tracking.
|
||||
2. ``out``. Ends time tracking.
|
||||
3. ``resume``. Resumes tracking.
|
||||
4. ``archive``. Archives tracking.
|
||||
1. ``t in``. Starts activity time tracking.
|
||||
2. ``t out``. Ends time tracking.
|
||||
3. ``t resume``. Resumes tracking.
|
||||
4. ``t archive``. Archives tracking.
|
||||
|
||||
At all times you can see the state of this cycle with 2 commands:
|
||||
|
||||
* ``list``. Displays time tracking summary.
|
||||
* ``display``. Displays tracking in depth.
|
||||
* ``t list``. Displays time tracking summary.
|
||||
* ``t display``. Displays tracking in depth.
|
||||
|
||||
So, let's start a new first task with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo in task1
|
||||
.. code-block:: shell-session
|
||||
|
||||
Checked into sheet "default".
|
||||
$ t in task1
|
||||
Checked into sheet "default".
|
||||
|
||||
Now you can list a summary of your activity with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo list
|
||||
.. code-block:: shell-session
|
||||
|
||||
Timesheet Running Today Total Time
|
||||
$ t list
|
||||
Timesheet Running Today Total Time
|
||||
|
||||
* default 0:02:04 0:02:04 0:02:04
|
||||
--------------------------------------------
|
||||
0:02:04 0:02:04 0:02:04
|
||||
* default 0:02:04 0:02:04 0:02:04
|
||||
--------------------------------------------
|
||||
0:02:04 0:02:04 0:02:04
|
||||
|
||||
You can stop tracking your time with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo out
|
||||
.. code:: shell-session
|
||||
|
||||
Checked out of sheet "default".
|
||||
$ t out
|
||||
Checked out of sheet "default".
|
||||
|
||||
You can see that tracking stopped if you list the summary again with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo list
|
||||
.. code:: shell-session
|
||||
|
||||
$ t list
|
||||
Timesheet Running Today Total Time
|
||||
|
||||
* default 0:00:00 0:04:21 0:04:21
|
||||
|
|
@ -138,17 +138,17 @@ You can see that tracking stopped if you list the summary again with:
|
|||
|
||||
You can resume your activity with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo resume
|
||||
.. code:: shell-session
|
||||
|
||||
$ t resume
|
||||
Resuming "task1"
|
||||
Checked into sheet "default".
|
||||
|
||||
You can now list the summary **or** display the traking in depth with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo display
|
||||
.. code:: shell-session
|
||||
|
||||
$ t display
|
||||
Timesheet: default
|
||||
Day Start End Duration Notes
|
||||
Mon Oct 24, 2022 18:57:03 - 19:01:25 0:04:21 task1
|
||||
|
|
@ -159,16 +159,16 @@ You can now list the summary **or** display the traking in depth with:
|
|||
|
||||
Finally, when you want to archive a task, first you stop it with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo out
|
||||
.. code:: shell-session
|
||||
|
||||
$ t out
|
||||
Checked out of sheet "default".
|
||||
|
||||
And then you archive it with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo archive
|
||||
.. code:: shell-session
|
||||
|
||||
$ t archive
|
||||
A total of 2 entries accounting for 9m 38s will be archived.
|
||||
Proceed? [y/N] y
|
||||
|
||||
|
|
@ -176,9 +176,9 @@ If you do ``list`` or ``display``, no activities are going
|
|||
to be active. If you want to see archive activities, you
|
||||
can do it with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo display full
|
||||
.. code:: shell-session
|
||||
|
||||
$ t display full
|
||||
Timesheet: _default
|
||||
Day Start End Duration Notes
|
||||
Mon Oct 24, 2022 18:57:03 - 19:01:25 0:04:21 task1
|
||||
|
|
@ -186,42 +186,42 @@ can do it with:
|
|||
0:09:38
|
||||
-----------------------------------------------------------
|
||||
Total 0:09:38
|
||||
|
||||
|
||||
With this you are now ready to use Tiempo!
|
||||
|
||||
Adding activities
|
||||
^^^^^^^^^^^^^^^^^
|
||||
.................
|
||||
|
||||
Most of the times you need to track more than one activity
|
||||
and switch between each other. So, let's do that.
|
||||
|
||||
First, start an activity with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo in \'My Task 1\'
|
||||
.. code:: shell-session
|
||||
|
||||
$ t in 'My Task 1'
|
||||
Checked into sheet "default".
|
||||
|
||||
When you need to start a new activity, first you stop
|
||||
When you need to start a new activity, first you stop
|
||||
the current one with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo out
|
||||
.. code:: shell-session
|
||||
|
||||
$ t out
|
||||
Checked out of sheet "default".
|
||||
|
||||
And then you start a new activity with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo in \'My Task 2\'
|
||||
.. code:: shell-session
|
||||
|
||||
$ t in \'My Task 2\'
|
||||
Checked into sheet "default".
|
||||
|
||||
You can ensure you are tracking the new activity with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo display
|
||||
.. code:: shell-session
|
||||
|
||||
$ t display
|
||||
Timesheet: default
|
||||
Day Start End Duration Notes
|
||||
Mon Oct 24, 2022 19:29:06 - 19:32:30 0:03:24 My Task 1
|
||||
|
|
@ -234,37 +234,37 @@ Now you can continue tracking your activities in the
|
|||
:ref:`Tiempo's Life Cycle <life-cycle>`.
|
||||
|
||||
Adding sheets
|
||||
^^^^^^^^^^^^^^
|
||||
.............
|
||||
|
||||
Usually you need to track activities for different projects
|
||||
or clients. So, let's add a new sheet to achieve that.
|
||||
|
||||
First, ensure you don't have any running activities with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo out
|
||||
.. code:: shell-session
|
||||
|
||||
$ t out
|
||||
Checked out of sheet "default".
|
||||
|
||||
Now, add a new sheet with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo sheet \'My Amazing Project\'
|
||||
.. code:: shell-session
|
||||
|
||||
$ t sheet \'My Amazing Project\'
|
||||
Switching to sheet 'My Amazing Project'
|
||||
|
||||
Then, start a new activity with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo in \'An Amazing Activity\'
|
||||
.. code:: shell-session
|
||||
|
||||
$ t in \'An Amazing Activity\'
|
||||
Checked into sheet "My Amazing Project".
|
||||
|
||||
You can check all your sheets and activities with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo display full
|
||||
.. code:: shell-session
|
||||
|
||||
$ t display full
|
||||
Timesheet: My Amazing Project
|
||||
Day Start End Duration Notes
|
||||
Mon Oct 24, 2022 19:56:55 - 0:00:35 An Amazing Activity
|
||||
|
|
@ -283,9 +283,9 @@ You can check all your sheets and activities with:
|
|||
|
||||
You can switch sheets by doing the same as above with:
|
||||
|
||||
.. code-block:: sh
|
||||
:caption: tiempo out && tiempo sheet default
|
||||
.. code:: shell-session
|
||||
|
||||
$ t out && tiempo sheet default
|
||||
Checked out of sheet "My Amazing Project".
|
||||
Switching to sheet 'default'
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue