mirror of
https://github.com/ae-utbm/sith.git
synced 2025-07-11 20:39:23 +00:00
Revert "Cleaned doc folder as it was unused"
This reverts commit 8716f2a01e
.
This commit is contained in:
55
doc/frequent/subscriptions.rst
Normal file
55
doc/frequent/subscriptions.rst
Normal file
@ -0,0 +1,55 @@
|
||||
.. _add_subscription:
|
||||
|
||||
Ajouter une nouvelle cotisation
|
||||
===============================
|
||||
|
||||
Il arrive régulièrement que le type de cotisation proposé varie en prix et en durée au cours des années. Le projet étant pensé pour être utilisé par d'autres associations dans la mesure du possible, ces cotisations sont configurables directement dans les paramètres du projet.
|
||||
|
||||
Comprendre la configuration
|
||||
---------------------------
|
||||
|
||||
Pour modifier les cotisations disponnibles, tout se gère dans la configuration avec la variable *SITH_SUBSCRIPTIONS*. Dans cet exemple, nous allons ajouter une nouvelle cotisation d'un mois.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from django.utils.translation import gettext_lazy as _
|
||||
|
||||
SITH_SUBSCRIPTIONS = {
|
||||
# Voici un échantillon de la véritable configuration à l'heure de l'écriture.
|
||||
# Celle-ci est donnée à titre d'exemple pour mieux comprendre comment cela fonctionne.
|
||||
"un-semestre": {"name": _("One semester"), "price": 15, "duration": 1},
|
||||
"deux-semestres": {"name": _("Two semesters"), "price": 28, "duration": 2},
|
||||
"cursus-tronc-commun": {
|
||||
"name": _("Common core cursus"),
|
||||
"price": 45,
|
||||
"duration": 4,
|
||||
},
|
||||
"cursus-branche": {"name": _("Branch cursus"), "price": 45, "duration": 6},
|
||||
"cursus-alternant": {"name": _("Alternating cursus"), "price": 30, "duration": 6},
|
||||
"membre-honoraire": {"name": _("Honorary member"), "price": 0, "duration": 666},
|
||||
"un-jour": {"name": _("One day"), "price": 0, "duration": 0.00555333},
|
||||
|
||||
# On rajoute ici notre cotisation
|
||||
# Elle se nomme "Un mois"
|
||||
# Coûte 6€
|
||||
# Dure 1 mois (on résonne en semestre, ici c'est 1/6 de semestre)
|
||||
"un-mois": {"name": _("One month"), "price": 6, "duration": 0.166}
|
||||
}
|
||||
|
||||
Créer une migration
|
||||
-------------------
|
||||
|
||||
La modification de ce paramètre est étroitement lié à la génération de la base de données. Cette variable est utilisé dans l'objet *Subscription* pour générer les *subscription_type*. Le modifier requiers de générer une migration de basse de données.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
./manage.py makemigrations subscription
|
||||
|
||||
.. note::
|
||||
|
||||
N'oubliez pas d'appliquer black sur le fichier de migration généré.
|
||||
|
||||
Rajouter la traduction pour la cotisation
|
||||
-----------------------------------------
|
||||
|
||||
Comme on peut l'observer, la cotisation a besoin d'un nom qui est internationalisé. Il est donc nécessaire de le traduire en français. Pour rajouter notre traduction de *"One month"* il faut se référer à cette partie de la documentation : :ref:`translations`.
|
53
doc/frequent/weekmail.rst
Normal file
53
doc/frequent/weekmail.rst
Normal file
@ -0,0 +1,53 @@
|
||||
Modifier le weekmail
|
||||
====================
|
||||
|
||||
Le site est capable de générer des mails automatiques composé de l’agrégation d'articles composé par les administrateurs de clubs. Le contenu est inséré dans un template standardisé et contrôlé directement dans le code. Il arrive régulièrement que l'équipe communication souhaite modifier ce template. Que ce soit les couleurs, l'agencement ou encore la bannière ou le footer, voici tout ce qu'il y a à savoir sur le fonctionnement du weekmail en commençant par la classe qui le contrôle.
|
||||
|
||||
.. autoclass:: com.models.Weekmail
|
||||
:members:
|
||||
|
||||
Modifier la bannière et le footer
|
||||
---------------------------------
|
||||
|
||||
Comme on peut l'observer plus haut, ces éléments sont contrôlés par les méthodes *get_banner* et *get_footer* de la classe *Weekmail*. Les modifier est donc très simple, il suffit de modifier le contenu de la fonction et de rajouter les nouvelles images dans les statics.
|
||||
|
||||
Les images sont à ajouter dans dans **core/static/com/img** et sont à nommer selon le type (banner ou footer), le semestre (Automne ou Printemps) et l'année.
|
||||
|
||||
Exemple : *weekmail_bannerA18.jpg* pour la bannière de l'automne 2018.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
# Sélectionner le fichier de bannière pour le weekmail de l'automne 2018
|
||||
|
||||
def get_banner(self):
|
||||
return "http://" + settings.SITH_URL + static("com/img/weekmail_bannerA18.jpg")
|
||||
|
||||
.. note::
|
||||
|
||||
Penser à prendre les images au format **jpg** et que les images soient le plus léger possible, c'est bien mieux pour l'utilisateur final.
|
||||
|
||||
.. note::
|
||||
|
||||
Pensez à laisser les anciennes images dans le dossier pour que les anciens weekmails ne soient pas affectés par les changements.
|
||||
|
||||
Modifier le template
|
||||
--------------------
|
||||
|
||||
Comme on peut le voir dans la documentation de la classe, il existe deux templates différents. Un des templates est en texte pur et sert pour le rendu dégradé des lecteurs de mails ne supportant pas le HTML et un autre fait un rendu en HTML.
|
||||
|
||||
Ces deux templates sont respectivement accessibles aux emplacements suivants :
|
||||
|
||||
* com/templates/com/weekmail_renderer_html.jinja
|
||||
* com/templates/com/weekmail_renderer_text.jinja
|
||||
|
||||
.. note::
|
||||
|
||||
Pour le rendu HTML, pensez à utiliser le CSS et le javascript le plus simple possible pour que le rendu se fasse correctement dans les clients mails qui sont souvent capricieux.
|
||||
|
||||
.. note::
|
||||
|
||||
Le CSS est inclus statiquement pour que toute modification ultérieure de celui-ci n'affecte pas les versions précédemment envoyées.
|
||||
|
||||
.. warning::
|
||||
|
||||
Si vous souhaitez ajouter du contenu, n'oubliez pas de bien inclure ce contenu dans les deux templates.
|
Reference in New Issue
Block a user