Skip to content

Commit

Permalink
ajout de la section outils/compta (#314)
Browse files Browse the repository at this point in the history
* ajout de la section outils/compta

* amélioration de outils/compta

+ ajout à la TOC

* petites améliorations de outils/compta

- retrait des sous-titres voir et ajouter
+ touche de clavier
- retrait term SSH

* d'autre petites améliorations sur outils/compta

+ touche tab plus belle
+ l'exemple de ligne est une vrai ligne de tsv
+ correction de l'admonition

* fix tab + experiment term in admonition title

* fix admonition error

* fix link to services/ssh

* relecture de outils/Compta

* Apply suggestions from code review

Co-authored-by: Nicolas Peugnet <[email protected]>

---------

Co-authored-by: Nicolas Peugnet <[email protected]>
  • Loading branch information
vincent-peugnet and n-peugnet authored Nov 13, 2024
1 parent 97c7131 commit 6a98fc0
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 0 deletions.
80 changes: 80 additions & 0 deletions outils/compta.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
Comptabilité
============

CLUB1 n'utilise pas de compte en banque dédié.
Au lieu de ça, les membres qui ont dépensé de l'argent notent ces dépenses dans un [fichier de transactions](#fichier-de-transactions).
Lorsque des adhésions sont payées ou que l'on reçoit des dons,
ceux-ci sont transférés à l'une des personnes qui ont une balance négative.


Fichier de transactions
-----------------------

La comptabilité du club est consignée sur le serveur à l'aider d'un fichier de transactions.
Il se situe au chemin suivant :

/var/compta/transactions.tsv

Comme son extension l'indique, il s'agit d'un fichier TSV (*Tab Separated Values*).
Chaque ligne de ce fichier représente une transaction.
À l'intérieur, les différentes valeurs sont séparées par des *tabulations* (touche {kbd}`Tab ↹`).

Voici un exemple de ligne :

27 2019-01-10 +35 Nicolas Peugnet x adhesion Adhésion roquefort

La première colonne correspond à l'**identifiant unique** de chaque transaction.
Ce nombre doit toujours augmenter.
Ensuite, c'est la **date d'ajout** de la transaction.
Puis le **montant** de cette dernière.
On indique un `+` ou un `-` devant pour indiquer si c'est de l'argent qui entre ou qui sort.
Le **compte** qui a dépensé ou reçu l'argent viens ensuite.
Si le paiement est **effectué**, on ajoute un `x`.
Les différentes **catégories** sont `adhesion`, `don`, `infra` et `autre`.
Enfin, viens l'**intitulé**, qui est une courte description de la transaction.


```{admonition} Permissions
Ce fichier est accessible en lecture par tout les utilisateurs.
Donc n'hésitez pas à jeter un coup d'oeil !
En revanche, pour écrire dedans, il faut être membre du {term}`groupe` `compta`.
```


Usage
-----

Pour étudier ou modifier la liste des transactions,
il suffit d'ouvrir le fichier dans un éditeur de texte.
Mais bon, c'est pas forcément hyper confortable.
Pour palier à cela,
il est possible d'utiliser des commandes une fois que l'on est [connecté au serveur en SSH](/services/ssh.md).

En fonction de votre familiarité avec le {term}`terminal`,
deux options s'offrent à vous :


### Interface sympathique

Cette interface est faite pour être le plus simple possible.
Elle ne fait que poser des questions.

```{commande} compta
Interface conviviale de gestion de la comptabilité de CLUB1.
```


### Commandes pour un usage avancé

Les utilisateurs plus habitués à l'utilisation de la {term}`CLI`
peuvent directement utiliser ces deux commandes.

```{commande} compta-voir
Permet de consulter rapidement le contenu du fichier de comptabilité.
Il est possible de filtrer ou même d'afficher le total, en fournissant des options.
```

```{commande} compta-ajouter
Permet d'ajouter une transaction au fichier de comptabilité.
Il est nécessaire de remplir une grande partie des options.
```
1 change: 1 addition & 0 deletions outils/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ meta-doc
forum
aliases
newsletter
compta
ldap
dns
sauvegardes
Expand Down

0 comments on commit 6a98fc0

Please sign in to comment.