source: spip-zone/_plugins_/trad-lang/trunk/salvatore/README.md @ 119863

Last change on this file since 119863 was 119863, checked in by Cerdic, 2 years ago

Reorganisation : on ramene les fichiers de salvatore dans le dossier salvatore/ et mise a jour du readme de salvatore

  • Property svn:eol-style set to native
File size: 3.6 KB
Line 
1# Salvatore : Robot de gestion de traductions
2
3## Les outils fournis :
4
5Salvatore s'utilise via des fonctions spip-cli.
6
7* ```spip salvatore:tirer``` :
8        va chercher et met à jour les repositories et link les sous-repertoires contenant les modules de langue décrits dans le fichier traductions
9        Les depots sont checkout/update dans salvatore/depots/,
10        et leurs repertoires contenant les modules de langue sont ciblés par des liens symboliques placés dans modules/
11        On peut avoir plusieurs fois le même module extrait de plusieurs repositories differents ou de plusieurs repertoires du meme repository
12* ```spip salvatore:lire``` :
13        prend les fichiers de référence dans chaque dossier modules/xxx, et met à jour la base de données
14* ```spip salvatore:ecrire``` :
15        exporte les traductions depuis la base donnees dans chaque dossier modules/xxx, et prépare un fichier .json avec les infos de commit
16* ```spip salvatore:pousser``` :
17        commit et pousse sur chaque repo (git|svn) les différents fichiers de langue de chaque module modifie
18* ```inc/savlatore.php``` :
19        librairie commune aux outils  précédents
20
21## Installation et fonctionnement de tradlang
22
23Ces scripts nécessitent pour fonctionner :
241. SPIP v3.2.x
252. Trad-lang v3.0.x
263. créer le repertoire `salvatore/` a la racine du site avec les sous-dossiers `depots/` `modules/` et `tmp/`
274. créer également le sous-répertoire ```salvatore/traductions/``` dans le répertoire des scripts
28et y placer un ou des fichiers traductions.txt comportant les descriptions des modules à importer [comme cet exemple](http://zone.spip.org/trac/spip-zone/browser/traductions.txt)
29<br/>Pour récupérer ce fichier par svn, et uniquement celui-ci, se placer dans le répertoire `salvatore/` et lancer : ```svn co svn://zone.spip.org/spip-zone/ traductions --depth empty```
30        1. Cette commande ne crée qu'un répertoire SVN vide, puis lancer cette commande ```cd traductions && svn up traductions.txt```
31        2. Cette dernière commande ne récupère que le fichier traductions.txt
325. récupérer les fichiers de langue indiqués dans le fichier traductions.txt
33        1. Créer (s'il n'existe pas déjà) et modifier le fichier ```config/salvatore_passwd.inc```
34        2. Dans ce fichier, ajouter les variables suivantes:
35            * ```
36          $SVNUSER = 'user@svn.tld'; // correspondant au nom d'utilisateur du serveur SVN qui enverra les fichiers.
37          $SVNPASSWD = 'mot de passe'; // correspondant au mot de passe de l'utilisateur du serveur SVN qui enverra les fichiers.
38          $domaines_exceptions = array('git.spip.net');
39          $domaines_exceptions_credentials = array(
40            'git.spip.net' => array('user' => 'user git','pass'=>'mot de passe'),
41          );
42              ```
43    3. Lancer ensuite la commande : ```spip salvatore:tirer```
446. import dans la base des modules de langue et de leur contenu, dans le répertoire des scripts, lancer : ```spip salvatore:lire```
457. exporter le contenu de la base de donnée, dans le répertoire des scripts, lancer : ```spip salvatore:ecrire```
468. envoyer les modifications sur le SVN ou GIT,
47    1. pour ceci, vous devez pouvoir écrire sur les repositories grace aux logins/pass renseignés dans le fichier ```config/salvatore_passwd.inc```
48        2. Lancer ensuite la commande : ```spip salvatore:pousser```
49
50
51## Options possibles
52
53Plusieurs options peuvent être définies dans le fichier config/mes_options.php du site par exemple.
54
55```define('_EMAIL_ERREURS','nom@domaine.tld');```
56
57```define('_EMAIL_SALVATORE','salvatore@domaine.tld');```
58
59```define('_ID_AUTEUR_SALVATORE','23');```
60
61```define('_SPAM_ENCRYPT_NAME',true);```
62
63Pour plus de détails voir la fonction `salvatore_init()` de `inc/salvatore`
Note: See TracBrowser for help on using the repository browser.