diff options
Diffstat (limited to 'docs/fr/developers')
| -rw-r--r-- | docs/fr/developers/01_First_steps.md | 202 | ||||
| -rw-r--r-- | docs/fr/developers/02_Github.md | 77 | ||||
| -rw-r--r-- | docs/fr/developers/03_Backend/01_Database_schema.md | 0 | ||||
| -rw-r--r-- | docs/fr/developers/03_Backend/02_Minz.md | 27 | ||||
| -rw-r--r-- | docs/fr/developers/03_Backend/03_External_libraries.md | 0 | ||||
| -rw-r--r-- | docs/fr/developers/03_Backend/04_Changing_source_code.md | 15 | ||||
| -rw-r--r-- | docs/fr/developers/03_Backend/05_Extensions.md | 335 | ||||
| -rw-r--r-- | docs/fr/developers/04_Frontend/01_View_files.md | 15 | ||||
| -rw-r--r-- | docs/fr/developers/04_Frontend/02_Design.md | 11 | ||||
| -rw-r--r-- | docs/fr/developers/05_Release_new_version.md | 112 |
10 files changed, 794 insertions, 0 deletions
diff --git a/docs/fr/developers/01_First_steps.md b/docs/fr/developers/01_First_steps.md new file mode 100644 index 000000000..400523e23 --- /dev/null +++ b/docs/fr/developers/01_First_steps.md @@ -0,0 +1,202 @@ +# Configurer son environnement + +**TODO** + +## Docker + +L'image Docker contenant l'environnement de développement de FreshRSS est accessible via : + +`$ docker pull marienfressinaud/freshrss` + +Vous pouvez lire [le fichier README du dépôt dédié](https://github.com/FreshRSS/docker-freshrss). + +# Architecture du projet + +**TODO** + +# Style de codage + +Si vous désirez contribuer au code, il est important de respecter le style de codage suivant. Le code actuel ne le respecte pas entièrement mais il est de notre devoir à tous de le changer dès que l'occasion se présente. + +Aucune nouvelle contribution ne respectant pas ces règles ne sera acceptée tant que les corrections nécessaires ne sont pas appliquées. + +## Espaces, tabulations et autres caractères blancs + +### Indentation +L'indentation du code doit être faite impérativement avec des tabulations. + +### Alignement + +Une fois l'indentation faite, il peut être nécessaire de faire un alignement pour simplifier la lecture. Dans ce cas, il faut utiliser les espaces. + +```php +$resultat = une_fonction_avec_un_nom_long($param1, $param2, + $param3, $param4); +``` + +### Fin de ligne + +Le caractère de fin de ligne doit être un saut de ligne (LF) qui est le caractère de fin de ligne des systèmes *NIX. Ce caractère ne doit pas être précédé par des caractères blanc. + +Il est possible de vérifier la présence de caractères blancs en fin de ligne grâce à Git avec la commande suivante : + +```bash +# commande à lancer avant l'ajout des fichiers dans l'index +git diff --check +# commande à lancer après l'ajout des fichiers dans l'index mais avant le commit +git diff --check --cached +``` + +### Fin de fichier + +Chaque fichier doit se terminer par une ligne vide. + +### Le cas de la virgule, du point et du point-virgule + +Il n'y a pas d'espace avant ces caractères, il y en a un après. + +### Le cas des opérateurs + +Chaque opérateur est entouré d'espaces. + +```php +if ($a == 10) { + // faire quelque chose +} + +echo $a ? 1 : 0; +``` + +### Le cas des parenthèses + +Il n'y a pas d'espaces entre des parenthèses. Il n'y a pas d'espaces avant une parenthèse ouvrante sauf si elle est précédée d'un mot-clé. Il n'y a pas d'espaces après une parenthèse fermante sauf si elle est suivie d'une accolade ouvrante. + +```php +if ($a == 10) { + // faire quelque chose +} + +if ((int)$a == 10) { + // faire quelque chose +} +``` + +### Le cas des fonctions chainées + +Ce cas se présente le plus souvent en Javascript. Quand on a des fonctions chainées, des fonctions anonymes ainsi que des fonctions de rappels, il est très facile de se perdre. Dans ce cas là, on ajoute une indentation supplémentaire pour toute l'instruction et on revient au même niveau pour une instruction de même niveau. + +```javascript +// Première instruction +shortcut.add(shortcuts.mark_read, function () { + //... + }, { + 'disable_in_input': true + }); +// Deuxième instruction +shortcut.add("shift+" + shortcuts.mark_read, function () { + //... + }, { + 'disable_in_input': true + }); +``` + +## Longueur des lignes + +Les lignes ne doivent pas dépasser 80 caractères. Il est cependant autorisé exceptionnellement de dépasser cette limite s'il n'est pas possible de la respecter mais en aucun cas, les lignes ne doivent dépasser les 100 caractères. + +Dans le cas des fonctions, les paramètres peuvent être déclarés sur plusieurs lignes. + +```php +function ma_fonction($param_1, $param_2, + $param_3, $param_4) { + // faire quelque chose +} +``` + +## Nommage + +L'ensemble des éléments du code (fonctions, classes, méthodes et variables) doivent être nommés de manière à décrire leur usage de façon concise. + +### Fonctions et variables + +Les fonctions et les variables doivent suivre la convention "snake case". + +```php +// une fontion +function nom_de_la_fontion() { + // faire quelque chose +} +// une variable +$nom_de_la_variable; +``` + +### Méthodes + +Les méthodes doivent suivre la convention "lower camel case". + +```php +private function nomDeLaMethode() { + // faire quelque chose +} +``` + +### Classes + +Les classes doivent suivre la convention "upper camel case". + +```php +abstract class NomDeLaClasse {} +``` + +## Encodage + +Les fichiers doivent être encodés en UTF-8. + +## Compatibilité avec PHP 5.3 + +Il ne faut pas demander l'indice d'un tableau qui est retourné par une fonction ou une méthode. Il faut passer par une variable intermédiaire. + +```php +// code compatible avec PHP 5.3 +$ma_variable = fonction_qui_retourne_un_tableau(); +echo $ma_variable[0]; +// code incompatible avec PHP 5.3 +echo fonction_qui_retourne_un_tableau()[0]; +``` + +Il ne faut pas utiliser la déclaration raccourcie des tableaux. + +```php +// code compatible avec PHP 5.3 +$variable = array(); +// code incompatible avec PHP 5.3 +$variable = []; +``` + +## Divers + +### Opérateurs +Les opérateurs doivent être en fin de ligne dans le cas de conditions sur plusieurs lignes. + +```php +if ($a == 10 || + $a == 20) { + // faire quelque chose +} +``` + +### Fin des fichiers + +Si le fichier ne contient que du PHP, il ne doit pas comporter de balise fermante + +### Tableaux + +Lors de l'écriture de tableaux sur plusieurs lignes, tous les éléments doivent être suivis d'une virgule (même le dernier). + +```php +$variable = array( + "valeur 1", + "valeur 2", + "valeur 3", +); +``` diff --git a/docs/fr/developers/02_Github.md b/docs/fr/developers/02_Github.md new file mode 100644 index 000000000..3d4bf9639 --- /dev/null +++ b/docs/fr/developers/02_Github.md @@ -0,0 +1,77 @@ +# Remonter un problème ou une suggestion + +Malgré le soin apporté à FreshRSS, il se peut que des bugs apparaissent encore. Le projet est jeune et le développement dynamique, aussi celui-ci pourra être corrigé rapidement. Il se peut aussi que vous ayez en tête une fonctionnalité qui n'existe pas encore. Que celle-ci vous paraisse idiote, farfelue, inutile ou trop spécifique, il ne faut surtout pas hésiter à nous la proposer ! Très souvent des "idées en l'air" ont trouvé une oreille attentive. Ce sont les regards externes qui font le plus évoluer le projet. + +Si vous êtes convaincus qu'il faut vous faire entendre, voici la marche à suivre. + +## Sur GitHub + +GitHub est la plate-forme à privilégier pour vos demandes. En effet, cela nous permet de pouvoir discuter à plusieurs sur un problème ou une suggestion et de faire émerger, souvent, des idées nouvelles. Ne négligeons pas cet aspect "social" ! + + 1. [Rendez-vous sur le gestionnaire de tickets de bugs](https://github.com/FreshRSS/FreshRSS/issues) + 2. Commencez par rechercher si une demande similaire n'a pas déjà été faite. Si oui, n'hésitez pas à ajouter votre voix à la demande. + 3. Si votre demande est nouvelle, [ouvrez un nouveau ticket de bug](https://github.com/FreshRSS/FreshRSS/issues/new) + 4. Rédigez enfin votre demande. Si vous maitrisez l'anglais, c'est la langue à privilégier car cela permet d'ouvrir la discussion à un plus grand nombre de personnes. Sinon, ce n'est pas grave, continuez en français :) + 5. Merci de bien vouloir suivre les quelques conseils donnés plus bas pour faciliter la prise en compte de votre ticket. + +## De façon informelle + +Tout le monde n'aime pas ou n'utilise pas GitHub pour des raisons aussi diverses que légitimes. C'est pourquoi vous pouvez aussi nous contacter de façon plus informelle. + +* Sur [les listes de diffusion](http://freshrss.org/announce-of-the-mailing-lists.html) +* À des évènements / rencontres autour du Logiciel Libre +* Autour d'une bière dans un bar +* Etc. + +## Conseils + +Voici quelques conseils pour bien présenter votre remontée de bug ou votre suggestion : + + +* **Faites attention à l'orthographe.** même si ce n'est pas toujours facile, faites votre maximum ;) +* **Donnez un titre explicite à votre demande**, quitte à ce qu'il soit un peu long. Cela nous aide non seulement à comprendre votre demande, mais aussi à retrouver votre ticket plus tard. +* **Une demande = un ticket.** Vous pouvez avoir des tas d'idées mais vous avez peur de spammer le gestionnaire de bugs : ça ne fait rien. Il vaut mieux avoir un peu trop de tickets que trop de demandes dans un seul. On s'occupera de fermer et regrouper les demandes qui le peuvent. +* Si vous remontez un bug, pensez à nous **fournir les logs de FreshRSS** (accessibles dans les dossier ''data/log/'' de FreshRSS) **et PHP** (l'emplacement peut varier selon les distributions, mais pensez à chercher dans ''/var/log/httpd'' ou ''/var/log/apache''). +* Si vous ne trouvez pas les fichiers de logs, précisez-le dans votre ticket afin que nous sachions que vous avez déjà cherché. +* Tous les bugs ne nécessitent pas les logs, mais si vous doutez, mieux vaut nous les fournir. Les logs sont importants et très utiles pour débugguer ! +* Il se peut que les logs puissent révéler des informations plus ou moins confidentielles, **faites attention à ne rien divulguer de sensible.** + +De plus, face à un bug, je ne peux que vous encourager à suivre le format de message suivant (tiré du [site de Max & Sam](http://sametmax.com/template-de-demande-daide-en-informatique/)) : + +---- + +**Quel est mon objectif ?** + +Donnez le contexte général de ce que vous essayiez de faire. + +**Qu’est-ce que j’ai essayé de faire ?** + +Expliquez pas à pas ce que vous avez fait afin que nous puissions reproduire le bug. + +**Quels résultats ai-je obtenus ?** + +Le bug : ce que vous voyez qui n'aurez pas dû se passer. Ici vous pouvez fournir les logs. + +**Quel était le résultat attendu ?** + +Afin que nous comprenions bien où est le problème... au moins selon vous :p + +**Quelle est ma situation ?** + +Pensez à donner les informations suivantes si vous les connaissez : + + 1. Quel navigateur ? Quelle version ? + 2. Quel serveur : Apache, Nginx ? Quelle version ? + 3. Quelle version de PHP ? + 4. MySQL ou SQLite ? Quelle version ? + 5. Quelle distribution sur le serveur ? Et… quelle version ? + +---- + +# Système de branches + +**TODO** + +# Proposer un patch + +**TODO**
\ No newline at end of file diff --git a/docs/fr/developers/03_Backend/01_Database_schema.md b/docs/fr/developers/03_Backend/01_Database_schema.md new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/docs/fr/developers/03_Backend/01_Database_schema.md diff --git a/docs/fr/developers/03_Backend/02_Minz.md b/docs/fr/developers/03_Backend/02_Minz.md new file mode 100644 index 000000000..7699f9390 --- /dev/null +++ b/docs/fr/developers/03_Backend/02_Minz.md @@ -0,0 +1,27 @@ +# Modèles + +**TODO** + +# Contrôleurs et actions + +**TODO** + +# Vues + +**TODO** + +# Routage + +**TODO** + +# Écriture des URL + +**TODO** + +# Internationalisation + +**TODO** + +# Comprendres les mécanismes internes + +**TODO** diff --git a/docs/fr/developers/03_Backend/03_External_libraries.md b/docs/fr/developers/03_Backend/03_External_libraries.md new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/docs/fr/developers/03_Backend/03_External_libraries.md diff --git a/docs/fr/developers/03_Backend/04_Changing_source_code.md b/docs/fr/developers/03_Backend/04_Changing_source_code.md new file mode 100644 index 000000000..0282dd9d2 --- /dev/null +++ b/docs/fr/developers/03_Backend/04_Changing_source_code.md @@ -0,0 +1,15 @@ +# Accès à la base de données + +**TODO** + +# Écrire une action et sa vue associée + +**TODO** + +# Gestion de l'authentification + +**TODO** + +# Gestion des logs + +**TODO** diff --git a/docs/fr/developers/03_Backend/05_Extensions.md b/docs/fr/developers/03_Backend/05_Extensions.md new file mode 100644 index 000000000..0478d77b8 --- /dev/null +++ b/docs/fr/developers/03_Backend/05_Extensions.md @@ -0,0 +1,335 @@ +# Fiche technique 0001 — Écriture d'extensions pour FreshRSS + +## Présentation de FreshRSS + +FreshRSS est un agrégateur de flux RSS / Atom écrit en PHP depuis octobre 2012. Le site officiel est situé à l'adresse [freshrss.org](http://freshrss.org) et son dépot Git est hébergé par Github : [github.com/FreshRSS/FreshRSS](https://github.com/FreshRSS/FreshRSS). + +## Problème à résoudre + +FreshRSS est limité dans ses possibilités techniques par différents facteurs : + +- La disponibilité des développeurs principaux ; +- La volonté d'intégrer certains changements ; +- Le niveau de « hack » nécessaire pour intégrer des fonctionnalités à la marge. + +Si la première limitation peut, en théorie, être levée par la participation de nouveaux contributeurs au projet, elle est en réalité conditionnée par la volonté des contributeurs à s'intéresser au code source du projet en entier. Afin de lever les deux autres limitations quant à elles, il faudra la plupart du temps passer par un « à-coté » souvent synonyme de « fork ». + +Une autre solution consiste à passer par un système d'extensions. En permettant à des utilisateurs d'écrire leur propre extension sans avoir à s'intéresser au cœur même du logiciel de base, on permet : + +1. De réduire la quantité de code source à assimiler pour un nouveau contributeur ; +2. De permettre d'intégrer des nouveautés de façon non-officielles ; +3. De se passer des développeurs principaux pour d'éventuelles améliorations sans passer par la case « fork ». + +Note : il est tout à fait imaginable que les fonctionnalités d'une extension puissent par la suite être intégrées dans le code initial de FreshRSS de façon officielle. Cela permet de proposer un « proof of concept » assez facilement. + + +## Comprendre les mécaniques de base (Minz et MVC) + +**TODO** : bouger dans 02_Minz.md + +Cette fiche technique devrait renvoyer vers la documentation officielle de FreshRSS et de Minz (le framework PHP sur lequel repose FreshRSS). Malheureusement cette documentation n'existe pas encore. Voici donc en quelques mots les principaux éléments à connaître. Il n'est pas nécessaire de lire l'ensemble des chapitres de cette section si vous n'avez pas à utiliser une fonctionnalité dans votre extension (si vous n'avez pas besoin de traduire votre extension, pas besoin d'en savoir plus sur le module `Minz_Translate` par exemple). + +### Architecture MVC + +Minz repose et impose une architecture MVC pour les projets l'utilisant. On distingue dans cette architecture trois composants principaux : + +- Le Modèle : c'est l'objet de base que l'on va manipuler. Dans FreshRSS, les catégories, les flux et les articles sont des modèles. La partie du code qui permet de les manipuler en base de données fait aussi partie du modèle mais est séparée du modèle de base : on parle de DAO (pour « Data Access Object »). Les modèles sont stockés dans un répertoire `Models`. +- La Vue : c'est ce qui représente ce que verra l'utilisateur. La vue est donc simplement du code HTML que l'on mixe avec du PHP pour afficher les informations dynamiques. Les vues sont stockées dans un répertoire `views`. +- Le Contrôleur : c'est ce qui permet de lier modèles et vues entre eux. Typiquement, un contrôleur va charger des modèles à partir de la base de données (une liste d'articles par exemple) pour les « passer » à une vue afin qu'elle les affiche. Les contrôleurs sont stockés dans un répertoire `Controllers`. + +### Le routage + +Afin de lier une URL à un contrôleur, on doit passer par une phase dite de « routage ». Dans FreshRSS, cela est particulièrement simple car il suffit d'indiquer le nom du contrôleur à charger dans l'URL à l'aide d'un paramètre `c`. Par exemple, l'adresse http://exemple.com?c=hello va exécuter le code contenu dans le contrôleur `hello`. + +Une notion qui n'a pas encore été évoquée est le système d'« actions ». Une action est exécutée *sur* un contrôleur. Concrètement, un contrôleur va être représenté par une classe et ses actions par des méthodes. Pour exécuter une action, il est nécessaire d'indiquer un paramètre `a` dans l'URL. + +Exemple de code : + +```php +<?php + +class FreshRSS_hello_Controller extends Minz_ActionController { + public function indexAction() { + $this->view->a_variable = 'FooBar'; + } + + public function worldAction() { + $this->view->a_variable = 'Hello World!'; + } +} + +?> +``` + +Si l'on charge l'adresse http://exemple.com?c=hello&a=world, l'action `world` va donc être exécutée sur le contrôleur `hello`. + +Note : si `c` ou `a` n'est pas précisée, la valeur par défaut de chacune de ces variables est `index`. Ainsi l'adresse http://exemple.com?c=hello va exécuter l'action `index` du contrôleur `hello`. + +Plus loin, sera utilisée la convention `hello/world` pour évoquer un couple contrôleur/action. + +### Gestion des vues + +Chaque vue est associée à un contrôleur et à une action. La vue associée à `hello/world` va être stockée dans un fichier bien spécifique : `views/hello/world.phtml`. Cette convention est imposée par Minz. + +Comme expliqué plus haut, les vues sont du code HTML mixé à du PHP. Exemple de code : + +```html +<p> + Phrase passée en paramètre : <?php echo $this->a_variable; ?> +</p> +``` + +La variable `$this->a_variable` a été passée précédemment par le contrôleur (voir exemple précédent). La différence est que dans le contrôleur il est nécessaire de passer par `$this->view` et que dans la vue `$this` suffit. + +### Accéder aux paramètres GET / POST + +Il est souvent nécessaire de profiter des paramètres passés par GET ou par POST. Dans Minz, ces paramètres sont accessibles de façon indistincts à l'aide de la classe `Minz_Request`. Exemple de code : + +```php +<?php + +$default_value = 'foo'; +$param = Minz_Request::param('bar', $default_value); + +// Affichera la valeur du paramètre `bar` (passé via GET ou POST) +// ou "foo" si le paramètre n'existe pas. +echo $param; + +// Force la valeur du paramètre `bar` +Minz_Request::_param('bar', 'baz'); + +// Affichera forcément "baz" puisque nous venons de forcer sa valeur. +// Notez que le second paramètre (valeur par défaut) est facultatif. +echo Minz_Request::param('bar'); + +?> +``` + +La méthode `Minz_Request::isPost()` peut être utile pour n'exécuter un morceau de code que s'il s'agit d'une requête POST. + +Note : il est préférable de n'utiliser `Minz_Request` que dans les contrôleurs. Il est probable que vous rencontriez cette méthode dans les vues de FreshRSS, voire dans les modèles, mais sachez qu'il ne s'agit **pas** d'une bonne pratique. + +### Accéder aux paramètres de session + +L'accès aux paramètres de session est étrangement similaire aux paramètres GET / POST mais passe par la classe `Minz_Session` cette fois-ci ! Il n'y a pas d'exemple ici car vous pouvez reprendre le précédent en changeant tous les `Minz_Request` par des `Minz_Session`. + +### Gestion des URL + +Pour profiter pleinement du système de routage de Minz, il est fortement déconseillé d'écrire les URL en dur dans votre code. Par exemple, la vue suivante doit être évitée : + +```html +<p> + Accéder à la page <a href="http://exemple.com?c=hello&a=world">Hello world</a>! +</p> +``` + +Si un jour il est décidé d'utiliser un système d'« url rewriting » pour avoir des adresses au format http://exemple.com/controller/action, toutes les adresses précédentes deviendraient ineffectives ! + +Préférez donc l'utilisation de la classe `Minz_Url` et de sa méthode `display()`. `Minz_Url::display()` prend en paramètre un tableau de la forme suivante : + +```php +<?php + +$url_array = array( + 'c' => 'hello', + 'a' => 'world', + 'params' => array( + 'foo' => 'bar', + ) +); + +// Affichera quelque chose comme .?c=hello&a=world&foo=bar +echo Minz_Url::display($url_array); + +?> +``` + +Comme cela peut devenir un peu pénible à utiliser à la longue, surtout dans les vues, il est préférable d'utiliser le raccourci `_url()` : + +```php +<?php + +// Affichera la même chose que précédemment +echo _url('hello', 'world', 'foo', 'bar'); + +?> +``` + +Note : en règle générale, la forme raccourcie (`_url()`) doit être utilisée dans les vues tandis que la forme longue (`Minz_Url::display()`) doit être utilisée dans les contrôleurs. + +### Redirections + +Il est souvent nécessaire de rediriger un utilisateur vers une autre page. Pour cela, la classe `Minz_Request` dispose d'une autre méthode utile : `forward()`. Cette méthode prend en argument le même format d'URL que celui vu juste avant. + +Exemple de code : + +```php +<?php + +$url_array = array( + 'c' => 'hello', + 'a' => 'world' +); + +// Indique à Minz de rediriger l'utilisateur vers la page hello/world. +// Notez qu'il s'agit d'une redirection au sens Minz du terme, pas d'une redirection que le navigateur va avoir à gérer (code HTTP 301 ou 302) +// Le code qui suit forward() va ainsi être exécuté ! +Minz_Request::forward($url_array); + +// Pour effectuer une redirection type 302, ajoutez "true". +// Le code qui suivra ne sera alors jamais exécuté. +Minz_Request::forward($url_array, true); + +?> +``` + +Il est très fréquent de vouloir effectuer une redirection tout en affichant un message à l'utilisateur pour lui indiquer comment s'est déroulée l'action effectuée juste avant (validation d'un formulaire par exemple). Un tel message est passé par une variable de session `notification` (note : nous parlerons plutôt de « feedback » désormais pour éviter la confusion avec une notification qui peut survenir à tout moment). Pour faciliter ce genre d'action très fréquente, il existe deux raccourcis qui effectuent tout deux une redirection type 302 en affectant un message de feedback : + +```php +<?php + +$url_array = array( + 'c' => 'hello', + 'a' => 'world' +); +$feedback_good = 'Tout s\'est bien passé !'; +$feedback_bad = 'Oups, quelque chose n\'a pas marché.'; + +Minz_Request::good($feedback_good, $url_array); + +// ou + +Minz_Request::bad($feedback_bad, $url_array); + +?> +``` + +### Gestion de la traduction + +Il est fréquent (et c'est un euphémisme) de vouloir afficher des phrases à l'utilisateur. Dans l'exemple précédent par exemple, nous affichions un feedback à l'utilisateur en fonction du résultat d'une validation de formulaire. Le problème est que FreshRSS possède des utilisateurs de différentes nationalités. Il est donc nécessaire de pouvoir gérer différentes langues pour ne pas rester cantonné à l'Anglais ou au Français. + +La solution consiste à utiliser la classe `Minz_Translate` qui permet de traduire dynamiquement FreshRSS (ou toute application basée sur Minz). Avant d'utiliser ce module, il est nécessaire de savoir où trouver les chaînes de caractères à traduire. Chaque langue possède son propre sous-répertoire dans un répertoire parent nommé `i18n`. Par exemple, les fichiers de langue en Français sont situés dans `i18n/fr/`. Il existe sept fichiers différents : + +- `admin.php` pour tout ce qui est relatif à l'administration de FreshRSS ; +- `conf.php` pour l'aspect configuration ; +- `feedback.php` contient les traductions des messages de feedback ; +- `gen.php` stocke ce qui est global à FreshRSS (gen pour « general ») ; +- `index.php` pour la page principale qui liste les flux et la page « À propos » ; +- `install.php` contient les phrases relatives à l'installation de FreshRSS ; +- `sub.php` pour l'aspect gestion des abonnements (sub pour « subscription »). + +Cette organisation permet de ne pas avoir un unique énorme fichier de traduction. + +Les fichiers de traduction sont assez simples : il s'agit seulement de retourner un tableau PHP contenant les traductions. Extrait du fichier `app/i18n/fr/gen.php` : + +```php +<?php + +return array( + 'action' => array( + 'actualize' => 'Actualiser', + 'back_to_rss_feeds' => '← Retour à vos flux RSS', + 'cancel' => 'Annuler', + 'create' => 'Créer', + 'disable' => 'Désactiver', + ), + 'freshrss' => array( + '_' => 'FreshRSS', + 'about' => 'À propos de FreshRSS', + ), +); + +?> +``` + +Pour accéder à ces traductions, `Minz_Translate` va nous aider à l'aide de sa méthode `Minz_Translate::t()`. Comme cela peut être un peu long à taper, il a été introduit un raccourci qui **doit** être utilisé en toutes circonstances : `_t()`. Exemple de code : + +```html +<p> + <a href="<?php echo _url('index', 'index'); ?>"> + <?php echo _t('gen.action.back_to_rss_feeds'); ?> + </a> +</p> +``` + +La chaîne à passer à la fonction `_t()` consiste en une série d'identifiants séparés par des points. Le premier identifiant indique de quel fichier on veut extraire la traduction (dans notre cas présent, de `gen.php`), tandis que les suivantes indiquent des entrées de tableaux. Ainsi `action` est une entrée du tableau principal et `back_to_rss_feeds` est une entrée du tableau `action`. Cela permet d'organiser encore un peu plus nos fichiers de traduction. + +Il existe un petit cas particulier qui permet parfois de se simplifier la vie : le cas de l'identifiant `_`. Celui-ci doit nécessairement être présent en bout de chaîne et permet de donner une valeur à l'identifiant de niveau supérieur. C'est assez dur à expliquer mais très simple à comprendre. Dans l'exemple donné plus haut, un `_` est associé à la valeur `FreshRSS` : cela signifie qu'il n'y a pas besoin d'écrire `_t('gen.freshrss._')` mais `_t('gen.freshrss')` suffit. + +### Gestion de la configuration + +## Écrire une extension pour FreshRSS + +Nous y voilà ! Nous avons abordé les fonctionnalités les plus utiles de Minz et qui permettent de faire tourner FreshRSS correctement et il est plus que temps d'aborder les extensions en elles-même. + +Une extension permet donc d'ajouter des fonctionnalités facilement à FreshRSS sans avoir à toucher au cœur du projet directement. + +### Les fichiers et répertoires de base + +La première chose à noter est que **toutes** les extensions **doivent** se situer dans le répertoire `extensions`, à la base de l'arborescence de FreshRSS. Une extension est un répertoire contenant un ensemble de fichiers et sous-répertoires obligatoires ou facultatifs. La convention veut que l'on précède le nom du répertoire principal par un « x » pour indiquer qu'il ne s'agit pas d'une extension incluse par défaut dans FreshRSS. + +Le répertoire principal d'une extension doit comporter au moins deux fichiers **obligatoire** : + +- Un fichier `metadata.json` qui contient une description de l'extension. Ce fichier est écrit en JSON ; +- Un fichier `extension.php` contenant le point d'entrée de l'extension. + +Il est possible aussi que vous ayez besoin de fichiers ou sous-répertoires additionnels selon vos besoins : + +- `configure.phtml` est le fichier contenant le formulaire permettant de paramétrer votre extension ; +- Un répertoire `static/` contenant fichiers CSS et JavaScript dont vous aurez besoin pour votre extension. Notez que si vous devez écrire beaucoup de CSS il est peut-être plus intéressant d'écrire un thème complet (mais ce n'est pas le sujet de cette fiche technique) ; +- Un répertoire `controllers` contenant des contrôleurs additionnels ; +- Un répertoire `i18n` contenant des traductions supplémentaires ; +- Des répertoires `layout` et `views` permettant de définir de nouvelles vues ou d'écraser les vues actuelles. + +De plus, il est de bon ton d'avoir un fichier `LICENSE` indiquant la licence sous laquelle est distribuée votre extension et un fichier `README` donnant une description détaillée de celle-ci. + +### Écrire le fichier metadata.json + +Le fichier `metadata.json` définit votre extension à travers un certain nombre d'éléments importants. Il doit contenir un tableau JSON valide contenant les entrées suivantes : + +- `name` : le nom de votre extension ; +- `author` : votre nom, éventuellement votre adresse mail mais il n'y a pas de format spécifique à adopter ; +- `description` : une description de votre extension ; +- `version` : le numéro de version actuel de l'extension ; +- `entrypoint` : indique le point d'entrée de votre extension. Il doit correspondre au nom de la classe contenue dans le fichier `extension.php` sans le suffixe `Extension` (donc si le point d'entrée est `HelloWorld`, votre classe s'appellera `HelloWorldExtension`) ; +- `type` : définit le type de votre extension. Il existe deux types : `system` et `user`. Nous étudierons cette différence juste après. + +Seuls les champs `name` et `entrypoint` sont requis. + +### Choisir entre extension « system » ou « user » + +### Écrire le fichier extension.php + +Ce fichier est le point d'entrée de votre extension. Il doit contenir une classe bien spécifique pour fonctionner. Comme évoqué plus haut, le nom de la classe doit être votre `entrypoint` suffixé par `Extension` (`HelloWorldExtension` par exemple). De plus, cette classe doit héritée de la classe `Minz_Extension` pour bénéficier des méthodes propres aux extensions. + +Votre classe va bénéficier de quatre méthodes à redéfinir : + +- `install()` est appelée lorsqu'un utilisateur va cliquer sur le bouton pour activer votre extension. Elle permet par exemple de mettre à jour la base de données d'un utilisateur afin de la rendre compatible avec l'extension. Elle retourne `true` si tout s'est bien passé ou, dans le cas contraire, une chaîne de caractères expliquant le problème ; +- `uninstall()` est appelée lorsqu'un utilisateur va cliquer sur le bouton pour désactiver votre extension. Ainsi, vous pourrez annuler les changements en base de données que vous avez potentiellement faits dans `install()`. Elle retourne `true` si tout s'est bien passé ou, dans le cas contraire, une chaîne de caractères expliquant le problème ; +- `init()` est appelée à chaque chargement de page *si l'extension est activée*. Elle va donc initialiser le comportement de l'extension. C'est la méthode la plus importante ; +- `handleConfigureAction()` est appelée lorsqu'un utilisateur charge le panneau de gestion de l'extension. Plus précisément, elle est appelée lorsque l'URL `?c=extension&a=configure&e=le-nom-de-votre-extension` est chargée. Vous devriez aussi écrire ici le comportement voulu lors de la validation du formulaire contenu dans votre fichier `configure.phtml`. + +De plus, vous disposerez d'un certain nombre de méthodes directement héritées de `Minz_Extension` que vous ne devriez pas redéfinir : + +- Les « getters » tout d'abord. La plupart sont suffisamment explicites pour ne pas les détailler : `getName()`, `getEntrypoint()`, `getPath()` (permet de récupérer le chemin vers votre extension), `getAuthor()`, `getDescription()`, `getVersion()`, `getType()` ; +- `getFileUrl($filename, $type)` va vous retourner l'URL vers un fichier du répertoire `static`. Le premier paramètre est le nom du fichier (sans `static/`), le deuxième est le type de fichier à servir (`css` ou `js`) ; +- `registerController($base_name)` va indiquer à Minz de prendre en compte le contrôleur donné dans le système de routage. Le contrôleur doit se situer dans votre répertoire `Controllers`, le nom du fichier doit être `<base_name>Controller.php` et le nom de la classe `FreshExtension_<base_name>_Controller`. + +TODO : + +- `registerViews()` +- `registerTranslates()` +- `registerHook($hook_name, $hook_function)` + +### Système de « hooks » + +TODO : + +- `entry_before_display` (`function($entry) -> Entry | null`) +- `entry_before_insert` (`function($entry) -> Entry | null`) +- `feed_before_insert` (`function($feed) -> Feed | null`) +- `post_update` (`function(none) -> none`) + +### Écrire le fichier configure.phtml + +TODO diff --git a/docs/fr/developers/04_Frontend/01_View_files.md b/docs/fr/developers/04_Frontend/01_View_files.md new file mode 100644 index 000000000..45174bf58 --- /dev/null +++ b/docs/fr/developers/04_Frontend/01_View_files.md @@ -0,0 +1,15 @@ +# Les fichiers .phtml + +**TODO** + +# Écrire une URL + +**TODO** + +# Afficher une icône + +**TODO** + +# Internationalisation + +**TODO** diff --git a/docs/fr/developers/04_Frontend/02_Design.md b/docs/fr/developers/04_Frontend/02_Design.md new file mode 100644 index 000000000..d05a4c44c --- /dev/null +++ b/docs/fr/developers/04_Frontend/02_Design.md @@ -0,0 +1,11 @@ +# Fichier modèle + +**TODO** + +# Écrire un nouveau thème + +**TODO** + +# Surcharger les icônes + +**TODO** diff --git a/docs/fr/developers/05_Release_new_version.md b/docs/fr/developers/05_Release_new_version.md new file mode 100644 index 000000000..731dc0c76 --- /dev/null +++ b/docs/fr/developers/05_Release_new_version.md @@ -0,0 +1,112 @@ +# Préparer la sortie + +Afin d'avoir le plus de retour possible avant une sortie, il est préférable de l'annoncer sur GitHub en créant un ticket dédié ([voir les exemples](https://github.com/FreshRSS/FreshRSS/search?utf8=%E2%9C%93&q=Call+for+testing&type=Issues)). Ceci est à faire **au moins une semaine à l'avance**. + +Il est aussi recommandé de faire l'annonce sur mailing@freshrss.org. + +# S'assurer de l'état de dev + +Avant de sortir une nouvelle version de FreshRSS, il faut vous assurer que le code est stable et ne présente pas de bugs majeurs. Idéalement, il faudrait que nos tests soient automatisés et exécutés avant toute publication. + +Il faut aussi **vous assurer que le fichier CHANGELOG est à jour** dans la branche de dev avec les mises à jour de la ou les version(s) à sortir. + +# Processus Git + +```bash +$ git checkout master +$ git pull +$ git merge --ff dev +$ vim constants.php +# Mettre à jour le numéro de version x.y.z de FRESHRSS_VERSION +$ git commit -a +Version x.y.z +$ git tag -a x.y.z +Version x.y.z +$ git push && git push --tags +``` + +# Mise à jour de update.freshrss.org + +Il est important de mettre à jour update.freshrss.org puisqu'il s'agit du service par défaut gérant les mises à jour automatiques de FreshRSS. + +Le dépot gérant le code se trouve sur GitHub : [FreshRSS/update.freshrss.org](https://github.com/FreshRSS/update.freshrss.org/). + +## Écriture du script de mise à jour + +Les scripts se trouvent dans le répertoire `./scripts/` et doivent être de la forme `update_to_x.y.z.php`. On trouve aussi dans ce répertoire `update_to_dev.php` destiné aux mises à jour de la branche de dev (ce script ne doit pas inclure de code spécifique à une version particulière !) et `update_util.php` contenant une liste de fonctions utiles à tous les scripts. + +Afin d'écrire un nouveau script, il est préférable de copier / coller celui de la dernière version ou de partir de `update_to_dev.php`. La première chose à faire est de définir l'URL à partir de laquelle sera téléchargée le package FreshRSS (`PACKAGE_URL`). L'URL est de la forme `https://codeload.github.com/FreshRSS/FreshRSS/zip/x.y.z`. + +Il existe ensuite 5 fonctions à remplir : + +- `apply_update()` qui se charge de sauvegarder le répertoire contenant les données, de vérifier sa structure, de télécharger le package FreshRSS, de le déployer et de tout nettoyer. Cette fonction est pré-remplie mais des ajustements peuvent être faits si besoin est (ex. réorganisation de la structure de `./data`). Elle retourne `true` si aucun problème n'est survenu ou une chaîne de caractères indiquant un soucis ; +- `need_info_update()` retourne `true` si l'utilisateur doit intervenir durant la mise à jour ou `false` sinon ; +- `ask_info_update()` affiche un formulaire à l'utilisateur si `need_info_update()` a retourné `true` ; +- `save_info_update()` est chargée de sauvegarder les informations renseignées par l'utilisateur (issues du formulaire de `ask_info_update()`) ; +- `do_post_update()` est exécutée à la fin de la mise à jour et prend en compte le code de la nouvelle version (ex. si la nouvelle version modifie l'objet `Minz_Configuration`, vous bénéficierez de ces améliorations). + +## Mise à jour du fichier de versions + +Lorsque le script a été écrit et versionné, il est nécessaire de mettre à jour le fichier `./versions.php` qui contient une table de correspondances indiquant quelles versions sont mises à jour vers quelles autres versions. + +Voici un exemple de fichier `versions.php` : + +```php +<?php + +return array( + // STABLE + '0.8.0' => '1.0.0', + '0.8.1' => '1.0.0', + '1.0.0' => '1.0.1', // doesn't exist (yet) + // DEV + '1.1.2-dev' => 'dev', + '1.1.3-dev' => 'dev', + '1.1.4-dev' => 'dev', +); +``` + +Et voici comment fonctionne cette table : + +- à gauche se trouve la version N, à droite la version N+1 ; +- les versions `x.y.z-dev` sont **toutes** mises à jour vers `dev` ; +- les versions stables sont mises à jour vers des versions stables ; +- il est possible de sauter plusieurs versions d'un coup à condition que les scripts de mise à jour le prennent en charge ; +- il est conseillé d'indiquer la correspondance de la version courante vers sa potentielle future version en précisant que cette version n'existe pas encore. Tant que le script correspondant n'existera pas, rien ne se passera. + +Il est **très fortement** indiqué de garder ce fichier rangé selon les numéros de versions en séparant les versions stables et de dev. + +## Déploiement + +Avant de mettre à jour update.freshrss.org, il est préférable de tester avec dev.update.freshrss.org qui correspond à la pré-production. Mettez donc à jour dev.update.freshrss.org et changez l'URL `FRESHRSS_UPDATE_WEBSITE` de votre instance FreshRSS. Lancez la mise à jour et vérifiez que celle-ci se déroule correctement. + +Lorsque vous serez satisfait, mettez à jour update.freshrss.org avec le nouveau script et en testant de nouveau puis passez à la suite. + +# Mise à jour des services FreshRSS + +Deux services sont à mettre à jour immédiatement après la mise à jour de update.freshrss.org : + +- rss.freshrss.org ; +- demo.freshrss.org (identifiants publics : `demo` / `demodemo`). + +# Annoncer publiquement la sortie + +Lorsque tout fonctionne, il est temps d'annoncer la sortie au monde entier ! + +- sur GitHub en créant [une nouvelle release](https://github.com/FreshRSS/FreshRSS/releases/new) ; +- sur le blog de freshrss.org au minimum pour les versions stables (écrire l'article sur [FreshRSS/freshrss.org](https://github.com/FreshRSS/freshrss.org)). +- sur Twitter (compte [@FreshRSS](https://twitter.com/FreshRSS)) ; +- et sur mailing@freshrss.org ; + +# Lancer la prochaine version de développement + +```bash +$ git checkout dev +$ vim constants.php +# Mettre à jour le numéro de version de FRESHRSS_VERSION +$ vim CHANGELOG.md +# Préparer la section pour la prochaine version +$ git add CHANGELOG.md && git commit && git push +``` + +Pensez aussi à mettre à jour update.freshrss.org pour qu'il prenne en compte la version de développement actuelle. |
