$Id: readme.txt,v 1.11 2008-05-30 21:12:29 fraynaud Exp $
=========================================
Toute la documentation d'openMairie sur:
[All the documentation of openMairie on:]
http://www.openmairie.org
=========================================
Translate in english readme_english.txt
Pre requis :
============
Vous devez avoir installer:
- un serveur apache et php
- une base de donnes : mysql ou postgresql
En fait, reportez vous aux installations de :
- sous windows : wamp (http://www.wampserver.com/) ou easyphp(http://easyphp.fr/)
- sous linux : lamp
Dans le cas de postgresql, vous devez aussi installer postgresql
(http://www.postgresqlfr.org/)
Si vous debutez, il est plus simple de garder mysql qui est package avec
easyphp ou wamp.
Depuis la version 1.11, il est possible de faire une installation simplifie(1)
Cette installation est interressante :
- si vous voulez faire un essai rapide
- si vous n avez pas d autres applications openMairie
- si vous souhaitez mettre en place openCimetiere chez votre fournisseur d acces
(attention il faut avoir un acces une base de donnes mysql ou pgsql)
L installation traditionnelle avec les dependances reste possible (2), elle est
prferer si vous avez la matrise de votre serveur.
Avec la version 1.11, il y a de nombreux scripts d integration de donnes si
vous etes en phase de saisie de donnes en masse(3)
Vous pouvez parametrer votre recherche globale (4)
Comment sont stocker vos photos et vos documents ?(5)
Enfin, quelques liens sur des documentations fonctionnelles openCimetiere (6)
Lien sur les documentations (6)
1- Installation simplifie [par defaut]
====================================
1.1 - Installation de openmairie_cimetiere
copier le repertoire openmairie_cimetiere sur votre serveur
exemples
wamp/www/openmairie_cimetiere
sous linux (debian) : var/www/openmairie_cimetiere
1.2 - Initialisation de la base en MySQL ou postgresql
creer la base opencimetiere sur mysql ou pgsql
Ensuite, il faut creer les tables de la base de donnes
puis executer les scripts SQL suivants :
- en mysql :
openmairie_cimetiere/data/mysql/init.sql
- en pgsql
openmairie_cimetiere/data/pgsql/init.sql
la premiere initialisation se fait avec init.sql
les modifications de version se font avec ver numero-de-version
exemple: pour passer a la version 1.08 : ver1.08.sql
1.3 parametrer la connexion dans /dyn/base.php
parametrage par defaut :
* collectivite 1 (sur mysql) : coll[1] est un tableau php qui contient les parametres
de connexion suivants
'titre => 'opencimetiere (mysql)',[parametrage opencimetiere]
'phptype' => 'mysql', [ne pas changer parametrage dbpear]
'dbsyntax' => '',[ne pas changer parametrage dbpear]
'username' => 'root', [par defaut sur wamp easyphp ou lamp /
a voir avec le fournisseur d acces le cas echeant]
'password' => '' [par defaut sur wamp easyphp ou lamp /
a voir avec le fournisseur d acces le cas echeant]
'protocol' => '',
'hostspec' => 'localhost', [nom de serveur par defaut wamp ou easyphp]
'port' => '', [ne pas changer parametrage dbpear]
'socket' => '', [ne pas changer parametrage dbpear]
nom de la base => 'opencimetiere', [parametrage opencimetiere]
format date par defaut =>'AAAA-MM-JJ' [[parametrage opencimetiere ne pas changer]
* collectivite 2 (sur mysql) : coll[1] est un tableau php qui contient les parametres
de connexion suivants
'titre => 'opencimetiere (pgsql)',[parametrage opencimetiere]
'phptype' => 'pgsql', [ne pas changer parametrage dbpear]
'dbsyntax' => 'pgsql',[ne pas changer parametrage dbpear]
'username' => 'postgres', [par defaut install postgres /
a voir avec le fournisseur d acces le cas echeant]
'password' => 'postgres' [par defaut install postgres/
a voir avec le fournisseur d acces le cas echeant]
'protocol' => 'tcp',
'hostspec' => 'localhost', [nom de serveur par defaut wamp ou easyphp]
'port' => '5432', [ne pas changer parametrage dbpear]
'socket' => '', [ne pas changer parametrage dbpear]
nom de la base => 'opencimetiere', [parametrage opencimetiere]
format date par defaut =>'AAAA-MM-JJ' [[parametrage opencimetiere ne pas changer]
ATTENTION :
Ne pas oublier de faire une sauvegarde du repertoire /trs ou sont stockes toutes
les donnees numerisees (photos, arretes, autorisation ...)
Sous linux mettre les droits d ecriture (voir 2.5)
Mise en place du logo (voir 2.6)
2. Installation d'opencimetiere avec les dependances
=================================================
Cette installation est plus complexe mettre en oeuvre par contre elle est plus
coherente par rapport a un serveur apache si plusieurs applications utilisent
les mmes composants.
Vous pouvez vous reporter sur le document plus complet de l adullact l adresse suivante
http://openmairie.org/demonstration/opencimetiere-1/installation_opencimetiere.pdf/view
2.1 - installer les 3 librairies (obligatoires)
exemple avec wamp ou linux (ubuntu ou debian)
pear : wamp/php/pear usr/share/php/PEAR
PEAR Base System PHP : http://pear.php.net/package/PEAR
pear db : http://www.pear.php.net/package/DB
fpdf : wamp/php/fpdf usr/share/fpdf
http://www.fpdf.org
openmairie : wamp/php/openmairie ou usr/share/php/openmairie
http://www.openmairie.org
version >= 2.01
2.2 - modifier le chemin dans php.ini
* exemple sous windows avec wamp5
include_path= ".;c:\wamp\php\includes;c:\wamp\php\pear;c:\wamp\php\fpdf;c:\wamp\php\openmairie"
* exemple avec linux (version debian ou ubuntu : etc/php5/apache2/php.ini):
include_path = ".:/usr/share/php:/usr/share/php/openmairie:/usr/share/fpdf"
2.3 - Installation de openmairie_cimetiere
* copier le repertoire openmairie_cimetiere sur votre serveur
exemples
wamp/www/openmairie_cimetiere
sous linux (debian) : var/www/openmairie_cimetiere
2.4 - Initialisation de la base en MySQL
creer la base opencimetiere
puis executer les scripts SQL suivants :
* avec mysql
openmairie_cimetiere/data/mysql/init.sql = cration des tables (obligatoire)
* ou avec postgre
openmairie_cimetiere/data/pgsql/init.sql = cration des tables (obligatoire)
parametrer la connexion dans /dyn/base.php
* dans dyn/var.inc mettre les variables suivante vide
$path_fpdf, $path_om, $path_pear
la premiere initialisation se fait avec init.sql
les modifications de version se font avec ver numero-de-version
exemple: pour passer a la version 1.08 : ver1.08.sql
2.5- Sous linux : mettre les droits d ecriture pour apache (www-data)
* Repertoire trs : transfert de fichier
/var/www/openmairie_cimetiere$ sudo chown www-data:www-data trs
/var/www/openmairie_cimetiere$ sudo chmod 755 trs
* Repertoire tmp : ecriture des resultats de traitement
/var/www/openmairie_cimetiere$ sudo chown www-data:www-data tmp
* Repertoire sql/mysql/ ecriture modification des etats et sous etats
/var/www/openmairie_cimetiere$ sudo chown www-data:www-data mysql
/var/www/openmairie_cimetiere$ sudo chown www-data:www-data mysql
* Repertoire sql/pgsql/ ecriture modification des etats et sous etats
/var/www/openmairie_cimetiere$ sudo chown www-data:www-data pgsql
/var/www/openmairie_cimetiere$ sudo chown www-data:www-data pgsql
(distribution debian ou ubuntu)
2.6 logo par collectivit (version 1.10)
Lettre type et tat :
Pour chaque collectivite mettre le logo dans le trs/coll correspondant
(coll= numero de la collectivit)
Attention le logo doit porte le meme nom qu en trs : ex : logopdf.png
trs/1 logopdf.png
trs/2 logopdf.png ...
3 - Integration de donnes (version 1.11)
======================
Dans var.inc possibilit ou non de faire apparaitre l integration dans le menu
dyn/var.inc -> variable $integration_temp
voir rec/methode_integration.pdf pour explication de la mthode
4 - recherche globale (version 1.11)
=================
Le recherche globale est parametrable dans dyn/var.inc pour optimiser les
temps de reponse long au demarrage de l appli
// 1 = calcul toutes occurences puis recherche possible sur saisie
// 0 = uniquement calcul sur saisie recherche
$global_flag=1; (par defaut)
Si vous avez de nombreuses concessions (plus de 5000) mettre 0.
5 - stockage des photos, documents PDF (actes de concession, fichemanuelle ...)
==================================
Il est proposer une option pour classer les dossiers et photos par repertoire
d une centaine de concession pour que ce soit plus facile grer qu un stock
de milliers de photos et dossiers dans un mme repertoire.
Cette option deconnecte la possibilit de modifier le fichier (eviter la complexit)
Le stockage de dossier par repertoire d une centaine de concession est un parametre
dans var.inc: $dossierparcentaine=1;
Par defaut le parametre est 1.
Si vous avez moins de 300 concessions, vous pouvez mettre le parametre 0
(cela fera moins de 1000 documents dans un repertoire)
Les documents sont identifis de la maniere suivante dans le respertoire trs:
si le collectivite =1 et si $dossierparcentaine=1
Pour la concession numero 1512 :
la photo est stocke en : trs/1/15/p_1512.jpeg
le 1er dossier : trs/1/15/d_1512.pdf
le 2eme dossier : trs/1/15/d_1512_2.pdf
ATTENTION :
Ne pas oublier de faire une sauvegarde du repertoire /trs ou sont stockes toutes
les donnees numerisees (photos, arretes, autorisation ...)
6 Documentation fonctionnelle
===========================
Documentation de l association des maires 74
http://openmairie.org/demonstration/opencimetiere-1/documentation_1-05.pdf/view
Documentation propose par la ville de Toulouse
http://openmairie.org/demonstration/opencimetiere-1/manuelutilisateuropencimetiere4sept2007.pdf/view
7 conseil aux developpeurs
========================
Avant de vous lancer dans le code pour modifier l application :
- vous pouvez modifier de nombreux parametres dans dyn/var.inc
- vous pouvez modifier tous les tats, sous-etats, lettre type depuis le menu
Si malgre ces possibilits de paramtrage, vous souhaitez modifier le code, il a
t laiss obj/concession_toulouse.class.php comme exemple de possibilit de
modification de code en surchargeant les mthodes existantes:
concession_toulouse.class.php herite de concession.class.php et surcharge les
methodes de concession.class.php
En fait, vous limitez votre maintenance que sur la partie rajoute.
Modifiez ensuite le menu : tab.php?obj=concession_toulouse au lieu de concession