funky-framadate-front/site/user-guide/index.html

400 lines
20 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="canonical" href="https://framagit.org/framasoft/framadate/funky-framadate-front/user-guide/">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Guide utilisateur - Funky Framadate Front end</title>
<link href="../css/bootstrap.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/darcula.min.css">
<script src="../js/jquery-1.10.2.min.js" defer></script>
<script src="../js/bootstrap.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body>
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-dark">
<div class="container">
<a class="navbar-brand" href="..">Funky Framadate Front end</a>
<!-- Expander button -->
<button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
<span class="navbar-toggler-icon"></span>
</button>
<!-- Expanded navigation -->
<div id="navbar-collapse" class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Accueil <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="../index.fr/" class="dropdown-item">Framadate - funky version</a>
</li>
<li>
<a href="../TODO/" class="dropdown-item">en cours</a>
</li>
</ul>
</li>
<li class="dropdown active">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Guide utilisateur <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="./" class="dropdown-item active">Guide utilisateur</a>
</li>
<li>
<a href="../LICENCE.md" class="dropdown-item">None</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Guide administrateur <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="../changelog/" class="dropdown-item">Changelog</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Guide développeur <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="../GETTING_STARTED/" class="dropdown-item">Démarrer</a>
</li>
<li>
<a href="../customisation/" class="dropdown-item">Personnaliser</a>
</li>
<li>
<a href="../cadrage/accessibility/" class="dropdown-item">Accessibilité</a>
</li>
<li>
<a href="../cadrage/architecture/" class="dropdown-item">Architecture</a>
</li>
<li>
<a href="../dev-guide/CONTRIBUTE/" class="dropdown-item">Contribuer</a>
</li>
<li>
<a href="../angular/" class="dropdown-item">Angular</a>
</li>
<li>
<a href="../cadrage/i18n/" class="dropdown-item">Traduction</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Historique <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="../history.md" class="dropdown-item">Historique</a>
</li>
<li>
<a href="../cadrage/specifications-fonctionnelles/" class="dropdown-item">Spécifications</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Réunions</a>
<ul class="dropdown-menu">
<li>
<a href="../reunions/0_blank_notes/" class="dropdown-item">Modèle vierge</a>
</li>
<li>
<a href="../reunions/2020_08_09/" class="dropdown-item">20200809</a>
</li>
<li>
<a href="../reunions/2019_08_09/" class="dropdown-item">20190809</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav ml-auto">
<li class="nav-item">
<a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="nav-item">
<a rel="prev" href="../TODO/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="../changelog/" class="nav-link">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
<div class="navbar-header">
<button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
<span class="fa fa-angle-down"></span>
</button>
</div>
<div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
<ul class="nav flex-column">
<li class="nav-item" data-level="1"><a href="#guide-utilisateur" class="nav-link">Guide utilisateur</a>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#principe" class="nav-link">Principe</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#glossaire" class="nav-link">Glossaire</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#fonctionnalites-actuellement-dans-framadate-legacy-et-a-conserver" class="nav-link">Fonctionnalités actuellement dans framadate legacy et à conserver</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#participation-a-un-sondage" class="nav-link">Participation à un sondage</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#resultats" class="nav-link">Résultats</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#emails" class="nav-link">Emails</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#stockage-et-export-de-donnees" class="nav-link">Stockage et export de données</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-level="1"><a href="#nouveautes-dans-framadate-funky" class="nav-link">Nouveautés dans Framadate Funky</a>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#principales" class="nav-link">principales</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#nouveautes-secondaires" class="nav-link">Nouveautés secondaires</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-level="1"><a href="#idees-pour-de-futures-ameliorations-pertinence-a-verifier" class="nav-link">Idées pour de futures améliorations (pertinence à vérifier)</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<ul>
<li class="i18n-link i18n-link-not-found i18n-link-en">English: This page isn't translated to English.</li>
</ul>
<h1 id="guide-utilisateur">Guide utilisateur</h1>
<h2 id="principe">Principe</h2>
<p>Framadate permet de créer et répondre à des sondages demandant des disponibilité dans le temps à plusieurs personnes afin de détermnier un consensus pour organiser des rendez-vous.
Il faut donc qu'une personne crée un sondage et publie un lien aux personnes qu'elle souhaite réunir.</p>
<h2 id="glossaire">Glossaire</h2>
<table>
<thead>
<tr>
<th align="left">Terme</th>
<th align="left">Signification</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">Créateur</td>
<td align="left">Personne ayant créé le sondage</td>
</tr>
<tr>
<td align="left">Participant</td>
<td align="left">Personne invitée à participer ou ayant participé</td>
</tr>
<tr>
<td align="left">Archivage</td>
<td align="left">Empêcher votes et commentaires mais conserver les résultats</td>
</tr>
<tr>
<td align="left"><em>Slug</em></td>
<td align="left">Partie le l'URL identifiant un sondage de manière unique</td>
</tr>
</tbody>
</table>
<h2 id="fonctionnalites-actuellement-dans-framadate-legacy-et-a-conserver">Fonctionnalités actuellement dans framadate legacy et à conserver</h2>
<h3 id="generalites">Généralités</h3>
<p>Il existe deux types de sondage. Le type «dates» est adapté à la proposition de dates (voir <a href="#plages-horaires">§plages horaires</a>) et le type «texte», plus généraliste, ne contient que du texte. Ce choix est l'un des premiers choix effectués lors de la création d'un nouveau sondage.</p>
<p>Deux types d'acteurs sont distingués : la personne ayant créé le sondage et les personnes qui répondent au sondage. Ces deux types d'acteurs n'ont pas les mêmes droits sur le sondage : la personne ayant créé le sondage est la seule ayant des droits d'administration sur celui-ci, en plus des droits des participants. En particulier, les droits d'administration permettent d'ajuster les droits des participants.</p>
<h3 id="creation-dun-sondage">Création d'un sondage</h3>
<p>Il est nécessaire de fournir un email lors de la création du sondage. Cela permet aux créateurs de sondages de pouvoir obtenir via email la liste des sondages qu'ils ont créés.</p>
<p>Il est possible de choisir le <em>slug</em> dans l'URL du sondage, à condition que ce <em>slug</em> soit disponible.</p>
<p>Le sondage reste modifiable après sa création.</p>
<h3 id="plages-horaires">Plages horaires</h3>
<p>Les sondages de type «dates» permettent de proposer des jours et des plages horaires pour chaque journée.</p>
<p>Pour faciliter la saisie des dates proposées, il est demandé si les plages horaires sont les mêmes chaque jour ou si elles sont différentes selon les jours. Dans le premier cas, les plages horaires sont demandées uniquement pour le premier jour et sont automatiquement reproduites sur les autres jours.</p>
<p>Toujours pour faciliter la saisie des propositions, il est possible d'ajouter plusieurs jours consécutifs en sélectionnant le premier et le dernier jour plutôt qu'en sélectionnant chaque jour un à un.</p>
<h2 id="participation-a-un-sondage">Participation à un sondage</h2>
<h3 id="votes">Votes</h3>
<p>Les participants n'ont pas besoin de créer un compte ou de fournir leur email pour participer à un sondage.</p>
<p>Le créateur du sondage peut protéger le sondage par un mot de passe. Sans ce mot de passe, il est impossible de voir le sondage, donc impossible d'y voter. Attention cependant, le sondage est stocké en clair dans la base de données et ne bénéficie donc d'aucun chiffrement. <em># Le mot de passe, lui, est-il chiffré?</em></p>
<p>Le créateur du sondage choisit de permettre ou non les modifications des votes sur le sondage. Il a le choix entre les trois formules suivantes :</p>
<ul>
<li>ne pas permettre de modifier de réponse;</li>
<li>permettre de modifier uniquement sa propre réponse a un sondage (modalités d'identification encore non déterminées);</li>
<li>permettre de modifier toute réponse à un sondage (y compris celles des autres).</li>
</ul>
<h3 id="commentaires">Commentaires</h3>
<p>Les participants au sondage ont la possibilité de créer des commentaires sur le sondage. Seule la personne ayant les droits d'administration sur le sondage peut modifier les commentaires.</p>
<h2 id="resultats">Résultats</h2>
<p>Selon la configuration du sondage, les résultats peuvent n'être accessibles qu'à la personne ayant un accès d'administration ou bien être publics. Les personnes pouvant accéder aux résultats du sondage peuvent exporter ces résultats au format CSV.</p>
<h2 id="emails">Emails</h2>
<p>Lorsqu'une personne crée un sondage, un email reprenant les informations du sondage ainsi que les URL uniques servant à le modifier (lien d'administration) et à y participer (lien à transmettre aux participants) lui est envoyé. De plus, elle peut choisir de recevoir des emails lors d'un nouveau vote ou commentaire sur le sondage.</p>
<p>Une personne ayant créé au moins un sondage peut demander à recevoir par email la liste des sondages qu'elle a créés en utilisant cette adresse email.</p>
<h2 id="stockage-et-export-de-donnees">Stockage et export de données</h2>
<p>Les données sont stockées en clair sur le serveur. L'archivage (resp. suppression) automatique des sondages est effectué via cronjob 90 (resp. 120) jours après sa création. Il est possible pour l'administrateur d'un sondage de modifier la durée avant archivage et la suppression automatique suit toujours de 30 jours la date d'archivage.</p>
<p>L'export d'un sondage et des résultats d'un sondage est possible au format CSV ainsi que JSON.</p>
<h1 id="nouveautes-dans-framadate-funky">Nouveautés dans Framadate Funky</h1>
<p>Plus de détails dans la section <a href="../historique.md">Historique</a> pour connaître le cheminement des versions précédentes.
Les idées et rapports de bugs sont disponibles dans <a href="https://framagit.org/framasoft/framadate/funky-framadate-front/-/boards">le tableau des Issues</a> sur la forge logicielle.</p>
<h2 id="principales">principales</h2>
<ul>
<li>Accessibilité renforcée.</li>
<li>Traduction dynamique de toutes les phrases en choisissant la langue dans le menu.</li>
<li>Adapté aussi bien sur mobile que grands écrans à haute ou faible densité de pixels.</li>
<li>Anti-spam de commentaires.</li>
<li>Anti-spam de vote.</li>
<li>Tests unitaires et end-to-end.</li>
<li>Couverture de test.</li>
</ul>
<h2 id="nouveautes-secondaires">Nouveautés secondaires</h2>
<ul>
<li>Choix de réponses possibles. Proposer de ne répondre que «oui» ou rien, ou aller dans la nuance en proposant «oui», «peut-être», «non», « ? ». <em># Redondance ou le choix de réponses possibles de la première phrase concerne un autre choix?</em></li>
<li>Insertion d'images dans le sondage de type texte, avec des URL uniquement. Une seule image par title possible ou rien.</li>
<li>Thème sombre.</li>
<li>Duplication de sondage à partir d'un autre.</li>
<li>Boutons pour copier dans le presse-papier les liens publics et privés / admin des sondages.</li>
<li>Limiter le nombre de participants maximum</li>
</ul>
<h1 id="idees-pour-de-futures-ameliorations-pertinence-a-verifier">Idées pour de futures améliorations (pertinence à vérifier)</h1>
<ul>
<li>Gagner en vie privée en chiffrant certaines informations? Stockage zéro knowledge avec un chiffrement robuste à courbe elliptique.</li>
<li>À réfléchir : permettre à Framadate de faire entrer à des gens plusieurs plages de temps de disponibilité et le service déduit quelles sont les plages de temps favorables (calcul d'intersection sur des lignes discontinues). Cela pourrait être avec divers niveaux de détail. Comme https://omnipointment.com/ (qui est un logiciel privateur)</li>
<li>SSO du fédiverse?</li>
</ul></div>
</div>
</div>
<footer class="col-md-12">
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script>
var base_url = "..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../js/base.js" defer></script>
<script src="../search/main.js" defer></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="searchModalLabel">Search</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form>
<div class="form-group">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>