Merge branch 'feature/HowToContribute' into 'develop'

Travail sur README.md

J'ai sorti quelques infos du fichier **README.md**. Tout ce qui concernait de la doc technique se trouve dans un dossier **doc**.

J'ai également ajouté un chapitre **Comment contribuer**, et réorganisé les différentes parties de README.md pour garder les informations importantes en tête de page.

See merge request !38
This commit is contained in:
Olivier PEREZ 2015-03-26 13:58:30 +01:00
commit cddbcbba73
8 changed files with 191 additions and 138 deletions

BIN
OPSession.inc.zip Normal file

Binary file not shown.

212
README.md
View File

@ -1,26 +1,81 @@
[![](https://git.framasoft.org/assets/logo-black-f52905a40830b30aa287f784b537c823.png)](https://git.framasoft.org)
# Présentation du projet
![English:](http://upload.wikimedia.org/wikipedia/commons/thumb/a/ae/Flag_of_the_United_Kingdom.svg/20px-Flag_of_the_United_Kingdom.svg.png) **Framasoft uses GitLab** for the development of its free softwares. Our Github repositories are only mirrors.
![Gitlab](https://git.framasoft.org/assets/logo-black-f52905a40830b30aa287f784b537c823.png)[https://git.framasoft.org](https://git.framasoft.org)
![English](http://upload.wikimedia.org/wikipedia/commons/thumb/a/ae/Flag_of_the_United_Kingdom.svg/20px-Flag_of_the_United_Kingdom.svg.png) **Framasoft uses GitLab** for the development of its free softwares. Our Github repositories are only mirrors.
If you want to work with us, **fork us on [git.framasoft.org](https://git.framasoft.org)**. (no registration needed, you can sign in with your Github account)
![Français :](http://upload.wikimedia.org/wikipedia/commons/thumb/c/c3/Flag_of_France.svg/20px-Flag_of_France.svg.png) **Framasoft utilise GitLab** pour le développement de ses logiciels libres. Nos dépôts Github ne sont que des mirroirs.
![Français](http://upload.wikimedia.org/wikipedia/commons/thumb/c/c3/Flag_of_France.svg/20px-Flag_of_France.svg.png) **Framasoft utilise GitLab** pour le développement de ses logiciels libres. Nos dépôts Github ne sont que des mirroirs.
Si vous souhaitez travailler avec nous, **forkez-nous sur [git.framasoft.org](https://git.framasoft.org)**. (l'inscription n'est pas nécessaire, vous pouvez vous connecter avec votre compte Github)
* * *
Framadate est un fork du projet STUdS : https://sourcesup.cru.fr/projects/studs/
---
Framadate est le projet qui motorise framadate.org pour framasoft.org
# Validations des pages
Toutes les pages sont validées HTML 4.01 Strict.
Le CSS est validé CSS 2.1.
# Technologies utilisées
* PHP 5.4.4, php-gettext
* PostgreSQL, mysql
* Apache
* iCalcreator
* POedit
* Icônes : Deleket (http://deleket.deviantart.com/) et DryIcons (http://dryicons.com)
# Compatibilités des navigateurs
_Dernière mise à jour le 21 avril 2014_
| Navigateur | Version testée |
|------------|-------------------------|
| Firefox | Ubuntu 13.10/FF28 |
| Chrome | Ubuntu 13.10/Chromium33 |
| Opera | (non testé) |
| Konqueror | (non testé) |
| Links | (non testé, inutile) |
| Safari | (non testé) |
| IE | Win7/IE9 |
# Comment contribuer
## De votre côté
1. Créer un compte sur [https://git.framasoft.org](https://git.framasoft.org)
1. Créer un fork du projet principal : [Créer le fork](https://git.framasoft.org/framasoft/framadate/fork/new)
1. Créer une branche nommée feature/[Description]
* Où [Description] est une description en anglais très courte de ce qui va être fait
1. Faire des commits dans votre branche
1. Pusher la branche sur votre fork
1. Demander une merge request
## La suite se passe de notre côté
1. Quelqu'un relira votre travail
* Essayez de rendre ce travail plus facile en organisant vos commits
1. S'il y a des remarques sur le travail, le relecteur fera des commentaires sur la merge request
1. Si la merge request lui semble correcte il peut merger votre travail avec la branche **develop**
## Corrections suite à une relecture
La relecture de la merge request peut vous amener à faire des corrections.
Vous pouvez faire ces corrections dans votre branche, ce qui aura pour effet de les ajouter à la merge request.
## Comprendre le code
Un fichier est dédié à l'appréhension du code de framadate : [Document technique](doc/TECHNICAL.md).
---
Framadate est un fork du projet [STUdS](https://sourcesup.cru.fr/projects/studs/), il motorise framadate.org pour framasoft.org
Les auteurs principaux de Framadate sont :
- Simon LEBLANC
- Pierre-Yves GOSSET
* Simon LEBLANC
* Pierre-Yves GOSSET
Les auteurs principaux du projet STUdS sont :
- Guilhem BORGHESI
- Raphaël DROZ
* Guilhem BORGHESI
* Raphaël DROZ
==========================================================================
---
Université de Strasbourg - Direction Informatique
Auteur : Guilhem BORGHESI
@ -38,7 +93,7 @@ Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
pris connaissance de la licence CeCILL-B, et que vous en avez accepté les
termes. Vous pouvez trouver une copie de la licence dans le fichier LICENCE.
==========================================================================
---
Université de Strasbourg - Direction Informatique
Author : Guilhem BORGHESI
@ -56,130 +111,11 @@ The fact that you are presently reading this means that you have had
knowledge of the CeCILL-B license and that you accept its terms. You can
find a copy of this license in the file LICENSE.
==========================================================================
---
=============================================================================
Fichiers de l'application
=============================================================================
index.php
La page d'accueil de STUdS
studs.php
La page de présentation de sondage
adminstuds.php
La page d'administration réservée à l'auteur du sondage
infos_sondage.php
La page (1/2) de création de sondage récupérant les informations générales
choix_date.php
La page de création (2/2) pour un sondage pour déterminer une date
choix_autre.php
La page de création (2/2) pour un sondage sur un sujet quelconque
creation_sondage.php
Le fichier qui récupérent les informations des pages précédentes pour procéder à l'insertion du nouveau sondage dans la base PostgreSQL
style.css
Le fichier CSS de style pour toute l'application
app/inc/constants.php
Le fichier contenant les constantes à changer en fonction de la machine locale
app/inc/functions.php
Le fichier contenant quelques fonctions récurrentes de l'application
app/inc/i18n.php
Le fichier contenant quelques fonctions récurrentes de l'application relatives à l'internationalisation
README
Ce fichier
INSTALL
Le fichier contenant les informations d'installation sur l'application
CHANGELOG
Le fichier contenant toutes les modifications de l'application entre les différentes versions
contacts.php
La page permettant aux usagers de poser une question à l'administrateur de l'application
apropos.php
La page expliquant les détails techniques relatifs à l'application et les dernieres modifications et celles à venir sur l'application
bandeaux.php
Le fichier contenant tous les bandeaux des pages PHP de l'application
favicon.ico
L'icone de favoris de l'application
sources.php
La page qui propose les sources de l'application
exportics.php
Le fichier d'export de la meilleure date au format iCAL (fichier .ICS)
exportcsv.php
Le fichier d'export de tous le tableau des participants avec leurs réponses dans un tableur (format .CSV)
exportpdf.php
Le fichier d'export de la lettre de convocation que le créateur du sondage pourra envoyer aux participants (format .PDF)
admin/
Le répertoire réservé à l'administrateur de l'application
admin/.htaccess
Le fichier gérant les droits restreints du répertoire ADMIN
admin/.htpasswd
Le fichier contenant les passwd des logins ayant accès au répertoire ADMIN
admin/index.php
La page présentant tous les sondages actuellement dans la base à l'administrateur
admin/log_studs.txt
Le fichier contenant un historique de toutes les creations/suppressions de sondage dans la base
errors/
Le répertoire contenant toutes les pages d'erreurs
errors/error-forbidden.php
La page qui indique dans la charte graphique de l'application l'erreur "501 forbidden"
errors/maintenance.php
La page qui indique que l'application est en maintenance temporaire
export/
Le répertoire qui contient tous les exports ICS
iCalcreator/
Le répertoire qui contient les librairies d'export en iCal
php2pdf/
Le répertoire qui contient les librairies d'export en PDF
scripts/
Le répertoire qui contient tous les scripts de l'application
sources/
Le répertoire qui contient les sources de l'application disponible sur la page sources.php
locale/
Le répertoire qui contient les fichiers de traduction modifiables (.po) et compilés (.mo)
au format gettext
=============================================================================
Validations des pages
=============================================================================
Toutes les pages de STUdS sont validées HTML 4.01 Strict.
La CSS de STUdS est validée CSS 2.1.
=============================================================================
Technologies utilisées
=============================================================================
- PHP 5.4.4, php-fpdf, php-adodb, php-gettext
- PostgreSQL, mysql
- Apache
- iCalcreator
- POedit
- Icônes : Deleket (http://deleket.deviantart.com/) et DryIcons (http://dryicons.com)
=============================================================================
Compatibilités des navigateurs
Dernière mise à jour le 21 avril 2014
=============================================================================
- Firefox : Ubuntu 13.10/FF28
- Chrome : Ubuntu 13.10/Chromium33
- Opera (non testé)
- Konqueror
- Links (non testé, inutile)
- Safari (non testé)
- IE : Win7/IE9
-----------------
Janvier 2008
Guilhem BORGHESI
Université de Strasbourg
Mai 2010
Raphaël DROZ, raphael.droz@gmail.com
Janvier 2008
Guilhem BORGHESI
Université de Strasbourg
Mai 2010
Raphaël DROZ, raphael.droz@gmail.com

19
admin/stdout.log Normal file
View File

@ -0,0 +1,19 @@
20150228 182306 [EXPIRATION] Going to purge 13 poll(s)...
20150228 182307 [EXPIRATION_SUCCESS] id: 4hivgatchum83trk, title:Essai Beta, format: D, admin: Olivier
20150228 182307 [EXPIRATION_SUCCESS] id: 5pcnnw15pi2vkk3p, title:dsdfds, format: D, admin: kjlkj
20150228 182307 [EXPIRATION_SUCCESS] id: bsr43n7u7e9wd149, title:Verre de l'amitié, format: D, admin: Hub
20150228 182307 [EXPIRATION_SUCCESS] id: cnz4nzqy9s88fxp2, title:Sortie Bergère le 31 octobre 2014, format: D, admin: Sophie
20150228 182307 [EXPIRATION_SUCCESS] id: gq1jz2f6hz93vdma, title:Signature Formats Ouverts Éducation, format: A, admin: Quentin
20150228 182308 [EXPIRATION_SUCCESS] id: huubu9csxjai36t5, title:Révision des salaires des permantents framasoft, format: A, admin: Luc
20150228 182308 [EXPIRATION_SUCCESS] id: jtk2bwokdzgk2u8g, title:Formation borne, format: D, admin: Maxime
20150228 182308 [EXPIRATION_SUCCESS] id: k9qefueia6b78u6n, title:Déj ou bière, format: D, admin: Valentin
20150228 182308 [EXPIRATION_SUCCESS] id: lk9hiju93fvodb7x, title:Réunion carnet hypothèse , format: D, admin: Jocelyn Aznar
20150228 182308 [EXPIRATION_SUCCESS] id: qtu6l5rpp6umwhbr, title:Réunion Gitoyen d'octobre 2014, format: D, admin: olive
20150228 182308 [EXPIRATION_SUCCESS] id: rz3kt5wajmyxhv4h, title:AJIL Paris novembre 2014, format: D, admin: olive
20150228 182309 [EXPIRATION_SUCCESS] id: v9whjlr77txwa24b, title:Présentation du Projet Santé Trans' pour les UEEH, format: D, admin: Lou
20150228 182309 [EXPIRATION_SUCCESS] id: wor85ej6td1b7v3c, title:test, format: D, admin: test
20150228 182405 [DELETE_SLOT] id:kczrqvormnd34n23, slot:toto
20150228 182437 [EXPIRATION] Going to purge 1 poll(s)...
20150228 182437 [EXPIRATION_SUCCESS] id: yzno16w3x423kguz, title:Atelier audit JS, format: A, admin: Armony
20150228 191645 [EXPIRATION] Going to purge 1 poll(s)...
20150228 191645 [EXPIRATION_SUCCESS] id: 3tkz9zcfs7odkdk5, title:aaa, format: A, admin: moimoi

2
composer.bat Normal file
View File

@ -0,0 +1,2 @@
php %COMPOSER_HOME%\bin\composer.phar update
pause

13
doc/TECHNICAL.md Normal file
View File

@ -0,0 +1,13 @@
# Main language
The main language of framadate is PHP.
# Treeview of the project
To understand what is the purpose of each page, may be you can look in the [Tree view](TREEVIEW.md) documentation.
# Smarty - template engine
The template engine [Smarty](www.smarty.net) is used for the dynamique pages.
# Database
The database is available throught the class **FramaDB**, to use it you should use the object _$connect_ which is created by the file _init.php_.
This file init.php is included in each page.

72
doc/TREEVIEW.md Normal file
View File

@ -0,0 +1,72 @@
# Treeview of framadate
Here are the main files and directories you need to know in order to develop on framadate project.
## Admin
* admin/
* Le répertoire réservé à l'administrateur de l'application
* admin/index.php
* The admin home page, it holds links to other admin pages
* admin/logs.php
* The page to see the application logs
* admin/migration.php
* This page do the needed migration at loading
* admin/polls.php
* The list of all polls
* admin/purge.php
* The page to manually trigger the purge (even if the purge is still executed at poll creation)
## Main
### Root files
* index.php
* Landing page framadate
* studs.php
* La page de présentation de sondage
* adminstuds.php
* La page d'administration réservée à l'auteur du sondage
* infos_sondage.php
* La page (1/2) de création de sondage récupérant les informations générales
* choix_date.php
* La page de création (2/2) pour un sondage pour déterminer une date
* choix_autre.php
* La page de création (2/2) pour un sondage sur un sujet quelconque
* creation_sondage.php
* Le fichier qui récupérent les informations des pages précédentes pour procéder à l'insertion du nouveau sondage dans la base PostgreSQL
* bandeaux.php
* Le fichier contenant tous les bandeaux des pages PHP de l'application
* favicon.ico
* L'icone de favoris de l'application
* exportcsv.php
* Le fichier d'export de tous le tableau des participants avec leurs réponses dans un tableur (format .CSV)
* CHANGELOG.md
* Le fichier contenant toutes les modifications de l'application entre les différentes versions
### app/ directory
* app/inc/config.template.php
* Le fichier contenant le paramètrage de l'application, il faut le dupliquer vers app/inc/config.php avant de l'éditer
* app/inc/constants.php
* Le fichier contenant les constantes de l'application
* app/inc/i18n.php
* Le fichier contenant quelques fonctions récurrentes de l'application relatives à l'internationalisation
* app/inc/init.php
* Le fichier chargé à l'initialisation de chaque page
* app/inc/smarty.php
* Le fichier qui prépare le context de Smarty
### other directories
* tpl/
* The directory that hold all the Smarty templates
* css/style.css et css/frama.css
* Les fichiers CSS de style pour toute l'application
* scripts/
* Le répertoire qui contient tous les scripts de l'application
* locale/
* Le répertoire qui contient les fichiers de traduction modifiables (.po) et compilés (.mo) au format gettext

5
locale.bat Normal file
View File

@ -0,0 +1,5 @@
msgfmt -o locale\fr_FR\LC_MESSAGES\Studs.mo locale\fr_FR\LC_MESSAGES\Studs.po
msgfmt -o locale\es_ES\LC_MESSAGES\Studs.mo locale\es_ES\LC_MESSAGES\Studs.po
msgfmt -o locale\de_DE\LC_MESSAGES\Studs.mo locale\de_DE\LC_MESSAGES\Studs.po
msgfmt -o locale\en_GB\LC_MESSAGES\Studs.mo locale\en_GB\LC_MESSAGES\Studs.po
pause

6
php.ini Normal file
View File

@ -0,0 +1,6 @@
display_errors = Off
error_reporting = E_ALL & ~E_NOTICE
log_errors = On
error_log = /var/log/apache2/error.log
ignore_repeated_errors = On
register_globals = Off