59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
# org-report-stats
|
||
Compte rendu html des tâches réalisées dans des fichiers Orgmode.
|
||
|
||
Ce dépot permet plusieurs choses:
|
||
- convertir des fichiers orgmode en json
|
||
- faire fonctionner un serveur web express / node pour afficher un compte rendu HTML interprêtant un fichier json représentant des tâches orgmode exportées à partir d'ox-json dans emacs.
|
||
pour le lancer: npm start.
|
||
- convertir des exports de services numériques en fichier tsv et json, afin d'être utilisé par les autres parties pour en faire un compte rendu en html.
|
||
|
||
![report in preview](screenshot.png "screenshot of the report in html")
|
||
# Prérequis
|
||
* une connaissance d'Orgmode pour exporter les tâches archivées
|
||
* un export json de vos tâches archivées (voir ox-json)
|
||
* mettre l'export json dans le dossier source
|
||
* avoir Nodejs en version stable et installer les modules node.
|
||
|
||
# Utilisation
|
||
## Configuration
|
||
Vérifiez les variables de chemin dans **parse_orgmode_to_json.mjs**, surtout outputAbsolutePath pour avoir un lieu de génération de fichier.
|
||
|
||
## compiler les fichiers org et les convertir en json
|
||
Il suffit de lancer cette commande du Makefile
|
||
```bash
|
||
make convert
|
||
```
|
||
Elle réalise la concaténation des fichiers tasks.org et tasks.org_archive faite dans all_tasks.org qui est ensuite utilisé par le script **parse_orgmode_to_json.mjs** pour fabriquer un fichier json.
|
||
|
||
la sortie est générée dans "outputAbsolutePath" définie dans "parse_orgmode_to_json.mjs"
|
||
|
||
## Données générées
|
||
### Des statistiques
|
||
|
||
* Les nombres et le type de tâches agrégées par semaine, mois et années.
|
||
* le nombre de tâches avec une date.
|
||
* le nombre de tâches sans date.
|
||
|
||
* la date de la tâche la plus ancienne
|
||
* données agrégées
|
||
* Les nombres de fois que des tags sont utilisés dans les tâches.
|
||
* Les nombres de fois que des mots sont utilisés dans les tâches.
|
||
* des données sur l'auteur, la date de génération du json, le fichier source .org ayant servi à la conversion.
|
||
|
||
|
||
###
|
||
|
||
## voir le rendu
|
||
Lancer l'exécution du fichier app avec node, et consulter l'output html.
|
||
```bash
|
||
npm start
|
||
```
|
||
|
||
## Memacs
|
||
Les scripts inspirés de Memacs (le package python-pip) sont dans le dossier **converters**, ils permettent de convertir des fichiers exportés de divers outils numériques en feuilles de calcul pour avoir un historique général d'activités simple à lire pour les humains, et facile à analyser pour d'autres scripts.
|
||
|
||
|
||
# feuille de route TODO
|
||
Proposer une sortie json qui soit du même format que l'export ox-json d'emacs.
|
||
|
||
# DONE |