Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Rostiger/chronicle
A timeline visualisation tool.
https://github.com/Rostiger/chronicle
Last synced: 5 days ago
JSON representation
A timeline visualisation tool.
- Host: GitHub
- URL: https://github.com/Rostiger/chronicle
- Owner: Rostiger
- License: mit
- Created: 2020-01-23T17:35:23.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-09T10:37:03.000Z (over 4 years ago)
- Last Synced: 2024-08-01T12:30:19.261Z (3 months ago)
- Language: JavaScript
- Homepage: https://rostiger.github.io/chronicle/
- Size: 1.05 MB
- Stars: 30
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - Rostiger/chronicle - A timeline visualisation tool. (others)
README
# Chronicle
[Chronicle](https://rostiger.github.io/chronicle/) is a simple text-based timeline visualisation tool I created in an effort to better understand and know myself.
It was born from the realization of my difficulty to put events and phases of my past into context.
Chronicle is an attempt to collect, store and visualize this information in a single place and make it easily accessible.
# Usage
Chronicle creates a timeline with multiple lanes from text based data using [neauoire](https://github.com/neauoire)'s _Tablatal_ and _Indental_ formats and parsers.
Each lane represents one of the categories in the databox on the right. The black bar at the top displays the current year and month. Chronicle supports singular, continuous and ongoing events.
The data is stored in `database/chronicle.tbtl` and uses the following format:
```
FROM TO CAT DESCRIPTION
2018 APR 2019 SEP ID Event Description
```
`CAT` represents a category that must be defined in `database/settings.nbtl`
```
CATEGORIES
ID
NAME : TITLE
COLOR : #HEXCODE
```
A single month is currently the smallest time unit Chronicle supports. Singular events can be added by omiting the `TO` parameter:
```
FROM TO CAT DESCRIPTION
2018 APR ---- --- PRO Event Description
```
Ongoing events can be declared by adding an asterisk at the beginning of the `TO` parameter:
```
FROM TO CAT DESCRIPTION
2018 APR *--- --- PRO Event Description
```
# Extras
- See the [License](https://github.com/Rostiger/chronicle/blob/master/LICENSE) file for license rights and limitations (MIT).
- Live Version: (https://rostiger.github.io/chronicle/)
- Pull Requests are welcome!