forked from ScoDoc/DocScoDoc
Mise à jour doc logos, documents, PV
This commit is contained in:
parent
9fc2d9655b
commit
df44c23d78
16
docs/FAQ.md
16
docs/FAQ.md
@ -110,19 +110,9 @@ garantie. Mais nous faisons de notre mieux:
|
||||
## Configuration
|
||||
### Comment changer les logos sur les documents PDF (PV...)
|
||||
|
||||
|
||||
Il faut (pour l'instant) être administrateur sur le serveur ScoDoc, et passer
|
||||
par l'onglet "configuration" accessible aux admins sur la page d'accueil.
|
||||
|
||||
Les logos sont stockés dans le répertoire `/opt/scodoc-data/config/logos/` et
|
||||
doivent être des images JPEG (extension `.jpg`). Il faut aussi indiquer les
|
||||
tailles des images dans le fichier de configuration `config/scodoc_config.py`,
|
||||
variable `CONFIG.LOGO_FOOTER_HEIGHT` etc.
|
||||
|
||||
* Sur les PV, `logo_header.jpg` est affiché en haut, et `logo_header.jpg` en bas de la page.
|
||||
* Sur les bulletins de notes, c'est configurable (et on peut utiliser d'autres
|
||||
logos), voir [ParametrageBulletins](ParametrageBulletins.md)
|
||||
|
||||
Il faut avoir un compte (web) administrateur sur ScoDoc, et passer
|
||||
par l'onglet "configuration" accessible sur la page d'accueil.
|
||||
Voir [la page sur la gestion des logos et images ](GestionLogos.md).
|
||||
|
||||
### Administration
|
||||
|
||||
|
||||
@ -115,9 +115,8 @@ pour un semestre de formation.
|
||||
Il s'agit d'un document PDF en format paysage, à imprimer sur
|
||||
papier ordinaire A4.
|
||||
|
||||
Les logos (IUT en haut, université en pied de page) ne sont actuellement pas
|
||||
paramétrables par l'utilisateur (il faut installer les images dans le sous-répertoire
|
||||
`logos` du logiciel).
|
||||
Les logos (IUT en haut, université en pied de page) sont
|
||||
paramétrables par l'utilisateur: voir [configuration des logos](GestionLogos.md).
|
||||
|
||||
|
||||
### Lettres d'avis individuelles
|
||||
|
||||
@ -1,29 +1,50 @@
|
||||
|
||||
# Gestions des logos et fonds de documents
|
||||
|
||||
Images (logos ou autre) à afficher sur des documents PDF générés par ScoDoc:
|
||||
|
||||
* Sur les PV, `logo_header.jpg` est affiché en haut, et `logo_header.jpg` en bas de la page.
|
||||
* Sur les bulletins de notes, c'est configurable (et on peut utiliser d'autres
|
||||
logos), voir [ParametrageBulletins](ParametrageBulletins.md)
|
||||
* Fonds de page: charger une image nommée `pvjury_background` pour les PV de
|
||||
jury (en format paysage) ou `letter_background`pour les bulletins et lettres
|
||||
de jury (en format portrait). Voir [paramétrage des PV](ParametragePV.md).
|
||||
|
||||
|
||||
## Informations techniques pour les développeurs et administrateurs curieux.
|
||||
|
||||
Normalement, l'administrateur n'a pas besoin d'intervenir dans les répertoires
|
||||
mentionnés ci-dessous (sauf pour veiller à ce que `/opt/scodoc-data` soit bien
|
||||
sauvegardé ou transféré lors des migrations).
|
||||
|
||||
La totalité des opérations nécessaires à l'utilisation de ScoDoc peuvent être
|
||||
réalisées par le menu de configuration des logos.
|
||||
|
||||
### Fichiers et répertoires associés aux logos
|
||||
|
||||
Les images (logos et fonds de document) sont enregistrées dans le répertoire `/opt/scodoc-data/config/logos` et ses sous-répertoires.
|
||||
|
||||
Normalement, l'administrateur n'a pas besoin d'intervenir dans ces répertoires, la totalité des opérations nécessaires
|
||||
pouvant être réalisées par le menu de configuration des logos.
|
||||
|
||||
Les images ajoutées par les utilisateurs ont toutes un nom de la forme `logo_<nom>.png` ou `logo_<nom>.jpg`
|
||||
(`<nom>` représente le nom d'usage du logo : header, footer, signature, ... au choix de l'utilsateur)
|
||||
Les sous-répertoires ont des noms de la forme `logos_<dept>` où `<dept>` est l'identifant numérique du département
|
||||
(`<nom>` représente le nom d'usage du logo : *header*, *footer*, signature, ... au choix de l'utilisateur)
|
||||
Les sous-répertoires ont des noms de la forme `logos_<dept>` où `<dept>` est
|
||||
l'identifiant numérique du département
|
||||
(la commande `flask list-depts` donne la correspondance cf. [Administration en ligne de commande](GuideConfig.md)).
|
||||
|
||||
Les fonds de page se distinguent uniquement des logos par leur nom (`<ext>` peut être soit `jpg`ou `png`) :
|
||||
Les **fonds de page** se distinguent uniquement des logos par leur nom (`<ext>` peut être soit `jpg`ou `png`) :
|
||||
|
||||
| Document | nom | fichier |
|
||||
|----------------------------------|-------------------------|--------------------------------|
|
||||
| pv de jury | pvjury_background | `logo_pvjury_background.<ext>` |
|
||||
| PV de jury | pvjury_background | `logo_pvjury_background.<ext>` |
|
||||
| bulletin de note | letter_background | `logo_letter_background.<ext>` |
|
||||
| lettre individuelle de décision | letter_background | `logo_letter_background.<ext>` |
|
||||
|
||||
## héritage scodoc7
|
||||
### Note: héritage scodoc7
|
||||
|
||||
Les serveurs scodoc7 utilisaient pour les fonds de page, des fichiers de nom `letter_background.<ext>` et `pvjury_background.<ext>`.
|
||||
Lors de la migration depuis scodoc7, ces fichiers ont placés dans le même répertoire que les images scodoc9.
|
||||
Pour assurer la compatibilité ascendante,
|
||||
leur présence est exceptionnellement prise en compte. Bien evidement, si un fichier scodoc9 (donc avec le préfixe `logo_`) est présent,
|
||||
il est prioritaire sur le fond de page "historique"
|
||||
Les serveurs ScoDoc 7 utilisaient pour les fonds de page, des fichiers de nom
|
||||
`letter_background.<ext>` et `pvjury_background.<ext>`. Lors de la migration
|
||||
depuis ScoDoc 7, ces fichiers ont placés dans le même répertoire que les images
|
||||
scodoc9. Pour assurer la compatibilité ascendante, leur présence est
|
||||
exceptionnellement prise en compte. Bien évidemment, si un fichier scodoc9 (donc
|
||||
avec le préfixe `logo_`) est présent, il est prioritaire sur le fond de page
|
||||
"historique".
|
||||
|
||||
|
||||
@ -2,8 +2,7 @@
|
||||
# Prise en main et paramétrage de ScoDoc 9
|
||||
|
||||
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> Cette
|
||||
page concerne la version ScoDoc 9, distribuée à partir de septembre 2021. Pour l'ancienne
|
||||
version, voir [cette page](GuideConfig7.md).
|
||||
page concerne la version ScoDoc 9, distribuée à partir de septembre 2021.
|
||||
|
||||
Ce document suppose que le logiciel a été installé suivant la procédure décrite dans
|
||||
[GuideInstallDebian11](GuideInstallDebian11.md).
|
||||
@ -48,7 +47,7 @@ immédiatement après la création.
|
||||
|
||||
## Création d'un utilisateur
|
||||
Cette opération s'effectue en général depuis le logiciel, via un formulaire
|
||||
ou un import excel. Pour créer un utilisateur depuis le terminal, lancer:
|
||||
ou un import Excel. Pour créer un utilisateur depuis le terminal, lancer:
|
||||
|
||||
flask user-create LOGIN ROLE DEPT
|
||||
|
||||
@ -78,7 +77,7 @@ sur la ligne de commande.
|
||||
|
||||
flask create-role role_name [permissions...]
|
||||
|
||||
Exemple: création d'une rôle "Observateur" ayant juste la persmision de "voir":
|
||||
Exemple: création d'une rôle "Observateur" ayant juste la permission de "voir":
|
||||
|
||||
flask create-role Observateur ScoView
|
||||
|
||||
@ -322,29 +321,18 @@ Options:
|
||||
|
||||
Les documents PDF (PV de jurys...) incluent les logos de l'établissement.
|
||||
Par défaut, ceux de l'IUT de Villetaneuse et de l'Université Paris 13 sont
|
||||
distribués. Pour les changer, placer vos logos (fichiers images JPEG ou PNG)
|
||||
dans le répertoire
|
||||
distribués. [Pour les changer, voir la FAQ](/FAQ/#comment-changer-les-logos-sur-les-documents-pdf-pv)
|
||||
|
||||
Si vous êtes administrateur système, vous pouvez aussi placer vos images (fichiers JPEG ou PNG)
|
||||
dans le répertoire
|
||||
|
||||
/opt/scodoc-data/config/logos
|
||||
|
||||
avec les noms `logo_header.jpg` (habituellement le logo de votre composante)
|
||||
et `logo_footer.jpg` (habituellement le logo de votre université ou école).
|
||||
|
||||
On peut fournir des logos par département en créant des sous-répertoires
|
||||
On peut fournir des images (logos, fond de pages) par département en créant des sous-répertoires
|
||||
|
||||
/opt/scodoc-data/config/logos/logo_<dept>/
|
||||
|
||||
pour y placer les fichiers images `logo_header.jpg` et `logo_footer.jpg`.
|
||||
|
||||
<!-- Ensuite, éditez le fichier
|
||||
|
||||
/opt/scodoc-data/config/logos
|
||||
|
||||
et changer les valeurs des variables `CONFIG.LOGO_FOOTER_ASPECT` et suivantes
|
||||
(ce n'est pas pratique, il faudrait modifier le code ScoDoc pour calculer ces valeurs
|
||||
à partir des fichiers images). -->
|
||||
|
||||
Enfin, redémarrez ScoDoc après avoir vidé les caches:
|
||||
Après quoi, redémarrez ScoDoc après avoir vidé les caches:
|
||||
|
||||
flask clear-cache
|
||||
sudo systemctl restart scodoc9
|
||||
|
||||
@ -1,94 +0,0 @@
|
||||
|
||||
# Prise en main et paramétrage de ScoDoc 7
|
||||
|
||||
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> Cette page
|
||||
concerne la version ScoDoc 7, et ne s'applique pas à la version ScoDoc 9 distribuée à partir de septembre 2021.
|
||||
Pour ScoDoc 9, voir [cette page](GuideConfig.md).
|
||||
|
||||
Ce document suppose que le ScoDOc 7 a été installé suivant la procédure décrite dans [GuideInstallDebianDix](GuideInstallDebianDix.md).
|
||||
|
||||
|
||||
|
||||
## Procédure à suivre pour créer un département et son utilisateur administrateur
|
||||
* Connectez-vous au site: `https://votre.site.fr/`
|
||||
|
||||
|
||||
Vous allez voir la page d'accueil de ScoDoc (il est possible que votre
|
||||
navigateur vous demande d'accepter un certificat).
|
||||
|
||||
Il n'y a pas de "département défini": c'est normal, lors de l'installation nous
|
||||
avons créé des bases de données, mais pas les interfaces web.
|
||||
|
||||
* Suivez le lien *Identifiez vous comme administrateur*. L'utilisateur *admin*
|
||||
est administrateur et a tous les droits sur !ScoDoc. C'est le seul à pouvoir
|
||||
créer un nouveau département.
|
||||
|
||||
Le logiciel va vous demander de changer immédiatement le mot de passe administrateur.
|
||||
Entrez l'identifiant et le mot de passe définis pendant l'installation.
|
||||
|
||||
Après vous être identifié sur la page d'accueil ScoDoc, vous avez maintenant un
|
||||
lien 'Administration de ScoDoc' qui vous permet d'ajouter un département, puis des utilisateurs.
|
||||
|
||||
* Ajouter un département (donnez le nom du département créé pendant l'installation)
|
||||
|
||||
* Ajouter un administrateur pour votre département: lien "Utilisateurs" (marge
|
||||
de gauche), puis suivre "ajouter un utilisateur". Donner à ce nouvel
|
||||
utilisateur les rôles `Admin`, `Ens` et `Secr` afin qu'il puisse effectuer
|
||||
toutes les opérations.
|
||||
|
||||
Quittez votre navigateur et reconnectez vous à ScoDoc avec votre nouvel utilisateur.
|
||||
|
||||
Vous pouvez si nécessaire créer plusieurs administrateurs par département (il
|
||||
est préférable que chaque compte ne soit utilisé que par une seule personne,
|
||||
pour éviter de divulguer les mots de passe et mieux suivre les opérations).
|
||||
|
||||
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;"
|
||||
alt="/!\" /> Surtout, évitez de travailler comme "admin": cet utilisateur doit
|
||||
être réservé à la création de départements. Prenez le temps de créer un
|
||||
utilisateur "chef de département !".
|
||||
|
||||
|
||||
|
||||
## Changement des logos apparaissant sur les documents
|
||||
Les documents PDF (PV de jurys...) incluent les logos de l'établissement. Par
|
||||
défaut, ceux de l'IUT de Villetaneuse et de l'Université Paris 13 sont
|
||||
distribués (ce n'est pas bien, ils ne sont sans doute pas sous licence libre !).
|
||||
Pour les changer, placer vos logos (fichiers images JPEG ou PNG) dans le
|
||||
répertoire
|
||||
```
|
||||
/opt/scodoc-data/config/logos
|
||||
```
|
||||
(en ScoDoc 7, c'était `/opt/scodoc/var/scodoc/config/logos`)
|
||||
|
||||
avec les noms `logo_header.jpg` (habituellement le logo de votre composante,
|
||||
mais faites comme vous voulez) et `logo_footer.jpg` (habituellement le logo de
|
||||
votre Université ou école).
|
||||
|
||||
Ensuite, éditez le fichier
|
||||
```
|
||||
/opt/scodoc-data/config/scodoc_local.py
|
||||
```
|
||||
(le créer s'il n'existe pas).
|
||||
Ce fichier doit contenir un dictionnaire sous la forme suivante:
|
||||
```
|
||||
CONFIG = {
|
||||
# Taille du l'image logo: largeur/hauteur
|
||||
# W/H
|
||||
CONFIG.LOGO_FOOTER_ASPECT = 326 / 96.0
|
||||
# Taille dans le document en millimetres
|
||||
CONFIG.LOGO_FOOTER_HEIGHT = 10
|
||||
# Proportions logo (donné ici pour IUTV)
|
||||
CONFIG.LOGO_HEADER_ASPECT = 549 / 346.0
|
||||
# Taille verticale dans le document en millimetres
|
||||
CONFIG.LOGO_HEADER_HEIGHT = 28
|
||||
... autres variables de configuration locale
|
||||
}
|
||||
```
|
||||
|
||||
Adaptez les valeurs des variables `LOGO_FOOTER_ASPECT` et suivantes à votre cas
|
||||
(ce n'est pas pratique, il faudrait modifier le code ScoDoc pour calculer ces
|
||||
valeurs à partir des fichiers images).
|
||||
|
||||
|
||||
Enfin, redémarrez ScoDoc (`/etc/init.d/scodoc start`).
|
||||
|
||||
@ -60,7 +60,7 @@ descr_demission || "Démission le 01/02/2000" ou vide si pas de démissio
|
||||
decision_jury || "Validé", "Ajourné", ... (code semestre
|
||||
descr_decision_jury| "Décision jury: Validé" (une phrase
|
||||
decisions_ue || noms (acronymes) des UE validées, séparées par des virgules.
|
||||
descr_decisions_ue|| " UE acquises: UE1, UE2", ou vide si pas de dec. ou paramètrage
|
||||
descr_decisions_ue|| " UE acquises: UE1, UE2", ou vide si pas de dec. ou paramétrage
|
||||
mention| Mention, calculée d'après la moyenne générale
|
||||
|
|
||||
**Absences:** |
|
||||
@ -95,16 +95,19 @@ Le balisage XML est celui de [ReportLab](http://www.reportlab.com/) (intra-parag
|
||||
### Logos
|
||||
Une balise supplémentaire est interprétée par ScoDoc pour insérer des logos (images).
|
||||
|
||||
Les logos sont des images au format JPEG (extension `.jpg` ou `.jpeg`) ou PNG (expension `.png`), téléversés sur le serveur scodoc et intégrables dans les documents html ou pdf.
|
||||
Les logos sont des images au format JPEG (extension `.jpg` ou `.jpeg`) ou PNG
|
||||
(extension `.png`), téléversés sur le serveur scodoc et intégrables dans les
|
||||
documents PDF. [Plus d'information sur la gestion des logos ici](GestionLogos.md).
|
||||
|
||||
Principes généraux :
|
||||
|
||||
* Un logo est désigné par un identifiant (nom) et peut être défini soit globalement, soit pour un département;
|
||||
|
||||
* le nom d'un logo est exclusiement composé de caractères alphanumériques ou du caractère '`-`';
|
||||
* le nom d'un logo est exclusivement composé de caractères alphanumériques ou du caractère '`-`';
|
||||
|
||||
* les logos définis globalement sont accessibles pour tous les départements. Toutefois, si un logo de même nom est également présent dans un département,
|
||||
, c'est le logo du département qui sera utilisé en lieu et place de logo global;
|
||||
* les logos définis globalement sont accessibles pour tous les départements.
|
||||
Toutefois, si un logo de même nom est également présent dans un département,
|
||||
c'est le logo du département qui sera utilisé en lieu et place de logo global;
|
||||
|
||||
* les logos de nom '`header`' et '`footer`' définis globalement ne peuvent être supprimés (mais peuvent être redéfinis).
|
||||
|
||||
@ -115,7 +118,7 @@ Ce formulaire comporte une section pour les définitions globales plus une secti
|
||||
|
||||
Une section présente la liste des logos avec leurs propriétés (la dimension est donnée à titre indicatif quand elle est disponible).
|
||||
|
||||
Pour chaque logo, les actions diponibles sont :
|
||||
Pour chaque logo, les actions disponibles sont :
|
||||
|
||||
* Le remplacement de l'image existante par un nouveau fichier ;
|
||||
|
||||
@ -135,7 +138,7 @@ Voir un exemple d'utilisation plus bas.
|
||||
|
||||
### Fond de page.
|
||||
Les modalités d'utilisation des fonds de pages sont similaires pour les PV, les lettres individuelles de décision et les bulletins.
|
||||
Celles-ci sont décrites ici: [Paramètrage des PV. Images de fond de page](/ParametragePV)
|
||||
Celles-ci sont décrites ici: [Paramétrage des PV. Images de fond de page](ParametragePV.md)
|
||||
|
||||
## Exemples
|
||||
### Exemple 1: Bulletins par défaut
|
||||
|
||||
@ -11,25 +11,31 @@ Le PV de jury est en format paysage et liste les résultats des étudiants chois
|
||||
L'exemple ci-dessus utilise une image de fond qui contient l'en-tête et le pied de page, avec des logos. Il faut fournir à ScoDoc une image de fond. Le plus simple est généralement de la composer dans un logiciel de traitement de texte, et de l'enregistrer en image: exporter en PDF puis convertir le PDF en image PNG ou JPEG de bonne résolution (300dpi , par exemple avec un logiciel comme Aperçu sur Mac.
|
||||
|
||||
L'image obtenue peut ensuite être téléversée sur le serveur de la même façon que pour un simple logo
|
||||
(voir la section [paramètrage des bulletins, section Logos](ParametrageBulletins.md)
|
||||
(voir la section [paramétrage des bulletins, section Logos](ParametrageBulletins.md)
|
||||
avec le nom "`pvjury_background`" ou "`letter_background`" selon le type de document visé.
|
||||
|
||||
Il ne reste plus qu'à activer l'option correspondante soit globalement dans le paramètrage du département, soit (pour les bulletins) dans par le menu réglage bulletin du semestre (qui a précédence):
|
||||
- Mettre l'image de fond sur les PV de jury (paysage)
|
||||
- Mettre l'image de fond sur les bulletins
|
||||
- Mettre l'image de fond sur les lettres individuelles de décision
|
||||
Il ne reste plus qu'à activer l'option correspondante soit globalement dans le
|
||||
paramétrage du département, soit (pour les bulletins) dans par le menu réglage
|
||||
bulletin du semestre (qui a priorité):
|
||||
|
||||
Note pour les serveurs migrés depuis scodoc7:
|
||||
Les anciennes configurations ayant suivi la migration depuis scodoc7 sont encore fonctionnelles.
|
||||
- Mettre l'image de fond sur les PV de jury (paysage)
|
||||
- Mettre l'image de fond sur les bulletins
|
||||
- Mettre l'image de fond sur les lettres individuelles de décision
|
||||
|
||||
L'image doit ensuite être enregistrée sur le serveur à un emplacement spécifique (seul l'administrateur du serveur peut faire cela):
|
||||
**Note** : pour les serveurs migrés depuis ScoDoc 7, les anciennes
|
||||
configurations sont normalement reprises automatiquement.
|
||||
|
||||
- Pour les PV de jury (A4 paysage), sous le chemin `/opt/scodoc/var/scodoc/config/logos/pvjury_background.png`
|
||||
- Pour les lettres individuelles (format A4 portrait), sous `/opt/scodoc/var/scodoc/config/logos/letter_background.png`
|
||||
L'image doit ensuite être enregistrée sur le serveur à un emplacement spécifique
|
||||
(seul l'administrateur du serveur peut faire cela): [voir la page sur la
|
||||
configuration les images](GestionLogos.md).
|
||||
|
||||
Ne pas oublier d'activer l'option *"Mettre l'image de fond sur les PV de jury"* dans les [paramètres du département](PreferencesScoDoc.md).
|
||||
Ne pas oublier d'activer l'option *"Mettre l'image de fond sur les PV de jury"*
|
||||
dans les [paramètres du département](PreferencesScoDoc.md).
|
||||
|
||||
**Note :** on peut aussi ajouter les logos séparément, mais il est plus commode de fournir une trame de fond complète. Voir [ici](GuideConfig/#changement-des-logos-apparaissant-sur-les-documents) si besoin.
|
||||
**Note :** on peut aussi ajouter les logos séparément, mais il est souvent plus
|
||||
commode de fournir une trame de fond complète. Voir
|
||||
[ici](GuideConfig/#changement-des-logos-apparaissant-sur-les-documents) si
|
||||
besoin.
|
||||
|
||||
## PV de Jury: textes, marges et autres paramètres
|
||||
|
||||
@ -43,9 +49,11 @@ Les paragraphes de texte utilisent un balisage identique à celui des bulletins
|
||||
|
||||
## Lettres individuelles
|
||||
|
||||
ScoDoc génère un docuement PDF contenant les letters de tous les étudiants du semestre ou d'un groupe.
|
||||
ScoDoc génère un document PDF contenant les lettres de tous les étudiants du semestre ou d'un groupe.
|
||||
|
||||
Le principe est le même, mais on fournit une trame de fond au format portrait, comme indiqué plus haut. Le texte de la lettre est configurable dans les préférences.
|
||||
Le principe est le même, mais on fournit une trame de fond au format portrait,
|
||||
comme indiqué plus haut. Le texte de la lettre est configurable dans les
|
||||
préférences.
|
||||
|
||||
<img src="/screens/LettresPreferences.png" width="50%">
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user