===============
celcatsanitizer
===============

Présentation de celcatsanitizer
===============================
Qu’est-ce que celcatsanitizer ?
-------------------------------

celcatsanitizer est un outil basé sur Django_ permettant de reformater
les emplois du temps générés par Celcat.

Les emplois du temps, accessibles à travers un navigateur web,
deviennent ainsi plus lisibles (notamment sur les appareils mobiles),
plus rapides à charger et plus légers.

Les pages générées par celcatsanitizer ont étées conçues pour être les
plus légères possibles, tout en restant lisibles et fournies en
informations. Les pages peuvent être chargées sans CSS, et peuvent
êtres rendues sans problèmes par une large gamme de navigateurs.

celcatsanitizer est aussi capable d’exporter les emplois du temps en
ICS_.

Le parseur de celcatsanitizer est optimisé pour les emplois du temps
de l’Université Paul Sabatier, mais il est possible de le modifier. 

Vous pouvez trouver une instance de celcatsanitizer à l’adresse
https://edt.pa1ch.fr/. Cette instance utilise les emplois du temps de
l’Université Paul Sabatier.

.. _Django: https://www.django-project.com/
.. _ICS: https://fr.wikipedia.org/wiki/ICalendar

Qu’est-ce que n’est pas celcatsanitizer ?
-----------------------------------------
celcatsanitizer n’est pas capable de produire un emploi du temps de
lui-même, seulement de reformater ceux produits par Celcat.

Notes importantes
-----------------
Affiliation
```````````
celcatsanitizer est un projet mené par des étudiants. Il n’est soutenu
d’aucune manière par Celcat ou l’Université Paul Sabatier.

Licence
```````
celcatsanitizer est sous licence AGPL3_, ce qui signifie, entre
autres, que toute modification de son code source **doit** être
redistribuée.

.. _AGPL3: https://www.gnu.org/licenses/agpl-3.0.fr.html

Utilisation de celcatsanitizer
==============================

.. toctree::
   :maxdepth: 2

   usage/installation
   usage/commands/cleancourses
   usage/commands/listtimetables
   usage/commands/reparse
   usage/commands/timetables
   usage/versions

Développement
=============

.. toctree::
   :maxdepth: 2

   dev/contribute
   dev/xml
   dev/roadmap