Script de relecture pour Lodel
JavaScript CSS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
docs
img/svg
src
.gitattributes
.gitignore
Gruntfile.js
LICENSE.txt
README.md
package.json

README.md

Screlo - Script de relecture pour Lodel

Installation

Attention ! Les ressources sont actuellement récupérées via http://rawgit.com version dev/testing. Ne pas utiliser en production en l'état, sinon risque de blacklisting.

Étape 1 : installer le plugin Tampermonkey dans le navigateur :

Attention : depuis Firefox Quantum, screlo ne fonctionne plus avec Greasemonkey. Il faut utiliser Tampermonkey.

Étape 2 : ouvrir l'URL https://github.com/brrd/screlo/raw/master/dist/screlo.user.js avec le navigateur.

Étape 3 : accepter l'installation du script.

Utilisation

Le script s’exécute automatiquement au chargement de la page quand les scripts utilisateur sont activés.

Pour rétablir un affichage normal de la page, désactiver les scripts utilisateur et recharger la page.

Forcer les mises à jour

Les mises à jour sont automatiques sous Firefox mais pas sous Chrome (bug #4). Pour forcer la mise à jour, utiliser le bouton "A propos" > "Mise à jour" puis accepter la réinstallation du script.

Documentation

La liste complète des tests effectués par Screlo et des messages d'aide est disponible dans le dossier docs : https://github.com/brrd/screlo/tree/master/docs/ (document généré automatiquement d'après le code source).

Développement

  1. Cloner le projet
  2. Installer Grunt : $ npm install -g grunt-cli
  3. Installer les dépendances de développement dans le répertoire du projet : $ npm install
  4. $ grunt pour la génération du projet (voir les options ci-dessous)

Options Grunt

  • Réinstaller automatiquement l'userscript dans le navigateur : $ grunt --userpath="C:\path_to_your_firefox_profile\gm_scripts\screlo"--userpath est le répertoire où copier screlo.user.js.
  • Copier les ressources sur localhost (utile pour contourner les local files security policy du navigateur) : $ grunt --www="C:\path_to_www" --subfolder="screlo_dir_in_www"--www est le chemin de www sur le disque local et --subfolder le dossier où copier les ressources.
  • Utiliser les urls de la branche develop : $ grunt --develop

Remarque : les chemins vers les répertoires passés en argument ne doivent pas se terminer par / ou \.

Autres tâches

  • Générer la liste des tests et des informations dans docs/ à partir de src/tests-revues.js : $ grunt buildinfos

Licence

Screlo - Script de relecture pour Lodel
Copyright (C) 2015 Thomas Brouard (OpenEdition)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.