From 59e91bc8931a386974a3817e9849aad1ca7fc186 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 21 Oct 2015 14:14:51 +0200 Subject: add docs --- docs/fr/Developpeur/Creer_un_nouveau_theme.md | 9 +++++ docs/fr/Developpeur/Depot_git.md | 23 +++++++++++++ docs/fr/Developpeur/Docker.md | 9 +++++ .../fr/Developpeur/Ecrire_fichier_configuration.md | 39 ++++++++++++++++++++++ docs/fr/Developpeur/Vagrant.md | 34 +++++++++++++++++++ docs/fr/Developpeur/v2.md | 9 +++++ 6 files changed, 123 insertions(+) create mode 100644 docs/fr/Developpeur/Creer_un_nouveau_theme.md create mode 100644 docs/fr/Developpeur/Depot_git.md create mode 100644 docs/fr/Developpeur/Docker.md create mode 100644 docs/fr/Developpeur/Ecrire_fichier_configuration.md create mode 100644 docs/fr/Developpeur/Vagrant.md create mode 100644 docs/fr/Developpeur/v2.md (limited to 'docs/fr/Developpeur') diff --git a/docs/fr/Developpeur/Creer_un_nouveau_theme.md b/docs/fr/Developpeur/Creer_un_nouveau_theme.md new file mode 100644 index 00000000..15e89ce3 --- /dev/null +++ b/docs/fr/Developpeur/Creer_un_nouveau_theme.md @@ -0,0 +1,9 @@ +--- +language: Français +currentMenu: theme +subTitle: Créer un nouveau thème +--- + +# Créer un nouveau thème + +TODO \ No newline at end of file diff --git a/docs/fr/Developpeur/Depot_git.md b/docs/fr/Developpeur/Depot_git.md new file mode 100644 index 00000000..458e32ca --- /dev/null +++ b/docs/fr/Developpeur/Depot_git.md @@ -0,0 +1,23 @@ +--- +language: Français +currentMenu: repo +subTitle: Dépôt git de wallabag +--- + +# Dépôt git de wallabag + +Si vous souhaitez contribuer au projet en proposant de nouvelles fonctionnalités ou en corrigeant des bugs, il faut suivre les recommandations que vous lirez ci-dessous concernant le dépôt Git disponible à cette adresse : [https://github.com/wallabag/wallabag](https://github.com/wallabag/wallabag). + +## État des lieux + +Pour la gestion des différentes versions de wallabag, nous utilisons Git. + +Nous utilisons plusieurs branches pour le code source de l'application web de wallabag : + +* la branche `master` : c'est la branche stable, celle qui est téléchargée pour tous ceux qui souhaitent installer wallabag pour leur utilisation. +* la branche `dev` : avant d'être sur la branche `master`, toutes les corrections de bugs et nouvelles fonctionnalités doivent passer par cette branche. Cette branche n'est pas conseillée pour une utilisation en production. +* la branche `v2-symfony` : c'est la branche de la refonte de wallabag. Un chapitre complet lui est consacré. + +## Workflow + +Toutes les consignes concernant le dépôt Git se trouve dans [le fichier CONTRIBUTING.md de wallabag](https://github.com/wallabag/wallabag/blob/master/CONTRIBUTING.md). Merci de le lire attentivement avant toute modification. \ No newline at end of file diff --git a/docs/fr/Developpeur/Docker.md b/docs/fr/Developpeur/Docker.md new file mode 100644 index 00000000..b5c9af81 --- /dev/null +++ b/docs/fr/Developpeur/Docker.md @@ -0,0 +1,9 @@ +--- +language: Français +currentMenu: docker +subTitle: Docker +--- + +# Docker + +TODO \ No newline at end of file diff --git a/docs/fr/Developpeur/Ecrire_fichier_configuration.md b/docs/fr/Developpeur/Ecrire_fichier_configuration.md new file mode 100644 index 00000000..e90b6526 --- /dev/null +++ b/docs/fr/Developpeur/Ecrire_fichier_configuration.md @@ -0,0 +1,39 @@ +--- +language: Français +currentMenu: site_config +subTitle: Écrire un fichier de configuration +--- + +# Écrire un fichier de configuration + +wallabag peut utiliser des fichiers de configuration spécifiques à un site pour lire les articles de ce site. Ces fichiers sont stockés dans le répertoire [`inc/3rdparty/site_config/standard`](https://github.com/wallabag/wallabag/tree/master/inc/3rdparty/site_config/standard). + +Le format utilisé pour ces fichiers est [XPath](http://www.w3.org/TR/xpath20/). Inspirez-vous des exemples dans le répertoire pour en créer de nouveaux. + +## Génération automatique de fichiers de configuration + +@FiveFilters a créé un [outil très utile](http://siteconfig.fivefilters.org/) pour créer des fichiers de configuration. Vous devez taper l'adresse d'un article qui vous intéresse. puis vous sélectionnez le contenu que vous souhaitez. + +![siteconfig](https://lut.im/RNaO7gGe/l9vRnO1b) + +Vous devez confirmer cette zone en essayant avec d'autres articles. +Quand vous avez trouvé la bonne zone, cliquez simplement sur *Download Full-Text RSS site config* (Téléchargez la configuration du site Full-Text RSS) pour télécharger le fichier à inclure dans le répertoire. + +## Génération manuelle de fichiers de configuration + +Si l'outil de FiveFilters ne marche pas tel qu´attendu, regardez la source d'un article (Ctrl+U sur Firefox ou Chromium). Cherchez votre contenu parmi le code source et repérez l'attribut `class` ou `id` de la zone que vous souhaitez. + +Une fois que vous avez obtenu l'attribut `id` ou `class`, vous pouvez écrire par exemple l'une ou l'autre de ces lignes : + +``` +body: //div[@class='myclass'] +body: //div[@id='myid'] +``` + +Ensuite, testez votre fichier de configuration avec d'autres articles du même site. Si vous avez trouvé le bon contenu mais que vous voulez enlever des parties inutiles, ajoutez la ligne suivante (avec l'attribut `class` correspondant à la partie inutile) : + +``` +strip: //div[@class='hidden'] +``` + +Vous pouvez regarder d'autres options pour les fichiers de configuration de sites [sur l'aide du site de FiveFilters](http://help.fivefilters.org/customer/portal/articles/223153-site-patterns). diff --git a/docs/fr/Developpeur/Vagrant.md b/docs/fr/Developpeur/Vagrant.md new file mode 100644 index 00000000..b2f83bc8 --- /dev/null +++ b/docs/fr/Developpeur/Vagrant.md @@ -0,0 +1,34 @@ +--- +language: Français +currentMenu: vagrant +subTitle: Vagrant +--- + +# Vagrant + +Pour vous permettre de mettre en place rapidement la configuration requise pour wallabag, nous vous proposons un fichier Vagrantfile. + +[Définition Wikipedia](http://fr.wikipedia.org/wiki/Vagrant) + + Vagrant est un logiciel libre et open-source pour la création et la configuration des environnements de développement virtuel. Il peut être considéré comme un wrapper autour du logiciel de virtualisation comme VirtualBox. + +## Utiliser Vagrant pour wallabag + +Voici la procédure pour exécuter wallabag au sein d'un conteneur Vagrant : + + wget -O wallabag-dev.zip https://github.com/wallabag/wallabag/archive/dev.zip + unzip wallabag-dev.zip + cd wallabag-dev + vagrant up + +Accédez maintenant à `http://localhost:8003` et à vous de jouer ! + +## Qu'a installé le Vagrantfile ? + +Le script installe un serveur LAMP, à savoir : + +* Ubuntu 14.04 +* Un serveur web Apache2 +* PHP5 +* SQLite ou MySQL ou PostgreSQL pour PHP +* XDebug pour PHP diff --git a/docs/fr/Developpeur/v2.md b/docs/fr/Developpeur/v2.md new file mode 100644 index 00000000..470213d0 --- /dev/null +++ b/docs/fr/Developpeur/v2.md @@ -0,0 +1,9 @@ +--- +language: Français +currentMenu: v2 +subTitle: wallabag v2 / symfony2 +--- + +# wallabag v2 / symfony2 + +TODO \ No newline at end of file -- cgit v1.2.3