Documentation

Cette aide couvre l'intégralité ou presque des fonctionnalités de l'outil Scribbook. Si jamais des explications n'étaient pas claires, n'hésitez pas à me faire un retour via le formulaire de contact : j'essayerai d'adapter la documentation en conséquence.

Le tableau de bord est la première chose que vous créez une fois inscrit à scribbook. Il présente tout d'abord un encart utilisateur simple (pour le moment), vous renseignant sur votre abonnement et l'espace que vous utilisez sur Scribbook.

En cliquant sur le jolie bouton Afficher mes statistiques, vous affichez un nouvel encart qui vous présente toute une série de statistiques personnelles. Avec ça vous allez pouvoir suivre au plus près votre évolution sur Scribbook !

A terme, on intégrera un peu de gamization optionnelle (badge, level, etc...) afin de vous encourager dans votre passion/votre travail.

C'est aussi depuis cet écran que vous pourrez consulter la liste de vos projets, leur évolution (jauge d'objectif si vous en avez défini) et en créer des nouveaux. Durant l'Alpha et la Beta, il n'y a aucune limite concernant le nombre de projet que vous pouvez posséder.

Au niveau de la liste des projets, vous avez la possibilité par tuile de :

  • Editer : modifier le nom ou la description du projet
  • Cloner : permet de cloner un projet et l'intégralité de son contenu (scènes, etc...)
  • Effacer : supprimer définitivement un projet (à faire uniquement lorsque l'on est sûr de ce que l'on fait ^^)

Pour créer un nouveau projet, il suffit de cliquer sur le "NOUVEAU PROJET" ce qui ouvrira une popup de création.

Scribbook vous fourni un certain nombre de canvas qui vous aiderons à structurer vos projets (Méthode flocon, le voyage du héros, etc.). Si vous ne savez pas quoi choisir, essayez les tous ! Le plus simple pour débuter peut aussi être de partir sur le canvas simple, de l'adapter à votre goût, puis de vous en servir comme canvas pour vos autres projets par exemple (fonction clonage).

Vous pouvez aussi vous fixez des objectifs d'écritures ! Ainsi bye bye la procrastination !

Le projet s'ouvre directement suite à sa création.

Le menu de gauche PLAN est la base managériale de votre projet. Il permet de gérer la répartition de vos scènes, de vos chapitres etc... Ce menu hierarchique permet le Drag & Drop, c'est à dire que vous pouvez déplacer fichiers et/ou dossiers à l'aide de votre souris.

1. Clics et Sélections

Un simple clic sélectionne un fichier ou un répertoire.
Un second clic (lent - sinon double clic) sur un fichier/répertoire déjà sélectionné enclenche la sélection multiple.
Une sélection multiple sur un répertoire sélectionne tout le contenu de celui-ci.

Pour dé-sélectionner en mode sélection multiple :

  • Re-cliquer sur le fichier que l'on souhaite enlever de la sélection (comme un interrupteur on/off).
  • ? - Autre méthode à prévoir

Un double clic sur un fichier ouvre ce fichier en édition.
Un double clic sur un répertoire ouvre l'intégralité des fichiers en édition bout à bout (compilation).
A terme le double clic sur répertoire sera paramétrable par utilisateur.

En fonction de la sélection - simple ou multiple, fichier ou répertoire - les options qui s'offrent à vous ne sont pas les mêmes. Un clic droit de votre souris (ou maintient du touch sur mobile) ouvre un menu d'action différent en fonction de la sélection.

2. Actions sur sélection simple

2.1 Actions de base

Nouveau Texte

Permet de créer un texte vierge. Il est à noter que l'entrée est directement sauvegarder (pas besoin de l'ouvrir et de faire une sauvegarde supplémentaire). Aucun des champs de la popup n'est obligatoire :
  • Label : si non présent (no label)
  • Synopsis et Pitch
Raccourci clavier : SHIFT (Maj) + T

Nouveau Dossier

Permet de créer un dossier vide. Aucun des champs de la popup n'est obligatoire :
  • Label : si non présent (no label)
  • Synopsis et Pitch (au niveau d'un dossier pour le moment ce n'est pas exploité.)
Raccourci clavier : SHIFT (Maj) + F

Modifier le nom de fichier / du dossier

Permet de modifier "en ligne", soit directement dans l'arborescence le nom du fichier ou du dossier sélectionné.
Raccourci clavier : SHIFT (Maj) + Clic Gauche

Ouvrir le fichier / une compilation du dossier

Sur un fichier, ouvre celui-ci dans l'éditeur de scribbook.
Sur un dossier, ouvre une compilation bout à bout de tous les fichiers du dossier dans l'éditeur de scribbook.

Dupliquer

Permet de dupliquer un fichier ou un dossier (et l'intégralité de son contenu).

Supprimer

Permet de supprimer un fichier ou un dossier. Il est à noter que les fichiers supprimés sont déplacer dans la CORBEILLE et peuvent être restaurés ou supprimés définitivement.

3. Actions sur sélection multiple

Fusionner

Fusionne bout à bout toutes les scènes sélectionnées en un seul et même fichier (le premier hiérarchiquement). Les autres fichiers disparaissent suite à la fusion (envoyés dans la corbeille).

Utilisée sur un répertoire, la fusion s'effectue sur tous les fichiers le constituant dans l'ordre hiérarchique de l'arbre.

Dupliquer

Permet de dupliquer les fichiers sélectionnés. Les nouveaux fichiers sont suffixés " - copie".

Ouvrir bout à bout

Permet d'ouvrir bout à bout dans l'éditeur compilé les fichiers sélectionnés.

Comparer deux fichiers (expérimental 0.1)

Cette fonctionnalité permet de comparer de manière brute le contenu de deux fichiers (si vous ne sélectionnez plus, le menu est grisé). Pour le moment cette fonctionnalité se limite à une comparaison purement visuelle.

L'éditeur de Scribbook est un éditeur wysiwyg (« what you see is what you get ») classique, c'est à dire qu'il permet de composer visuellement le résultat obtenu (contrairement à un éditeur markdown par exemple). Je ne vous ferai pas l'affront de détailler ce que sont les options italiques ou mises en gras. Je vais plutôt vous parler des options et outils que nous y avons ajouté.


La sauvegarde de vos écrits

D'abord un petit laïus pour vous expliquer comment Scribbook sauvegarde vos textes et la sécurité qui entoure ce processus.

1. Sauvegarde locale

L'application sauvegarde maintenant toutes les 5 secondes une image du fichier ouvert en cours sans aucune action de votre part (avec son synopsis s'il y a lieu). La sauvegarde est locale à votre navigateur (Firefox, Chrome, etc...).

Pour information, les navigateurs modernes autorisent les applications web à stoker jusqu'à 5 Mo de données en local.


2. Sauvegarde distante

Dès que vous commencer à saisir dans un fichier ouvert l'icône Cloud Sync  devient orange indiquant que la sauvegarde locale et distante sont différentes (non synchronisées). Appuyer quand vous le souhaitez sur le bouton lance une sauvegarde distante. Si la sauvegarde distante est réussi, l’icône passe du vert au noir classique.

Scribbook lance en automatique une sauvegarde distante toutes les 5 minutes en tache de fond du fichier ouvert en cours. Dans tous les cas lorsqu'une synchronisation/sauvegarde distante est lancée, Scribbook vérifie post sauvegarde que la copie distante est identique à la dernière sauvegarde locale et si tout va bien nettoie alors le local.

Désolé si je vous ai perdu ! En gros vous avez toujours une copie fraîche en local tant que le distant est pas identique à ce que vous avez sous les yeux.


3. Restauration sur panne

Vous l'avez remarqué le jolie En ligne en haut à droite ? En gros si vous perdez le réseau pendant que vous écrivez, que cela ne vous arrête plus : la sauvegarde continue en locale ! A la reprise du réseau vous n'aurez plus qu'à synchroniser.

Vous devez arrêter alors que le réseau n'est pas revenu ? Pas grave non plus, en rouvrant le projet à votre prochaine connexion Scribbook vous proposera de restaurer et de reprendre là où vous vous êtes arrêtés ! Seule limite : pour la restauration il faudra vous connecter (donc du réseau) pour initier le processus de reprise.



Syllaber - Découpe et compte de syllabes poétiques

Cet outil permet de découper et compter les syllabes d'un poème ou haïku tout en respectant les règles de la poésie française : diérèses, synérèses, élisions, etc... Pour développer cet outil je suis partie d'une découpe syllabique standard. Puis, j'ai appliqué les règles "sonores" spécifiques de la langue française : "ph", "gn", etc... Enfin, le plus dure, j'ai ajouté les règles de la poésie classique. Pour cela, je me suis appuyé sur les web ressources suivantes :

1 - Diérèse et synérèse

- Essai sur la diérèse et la synérèse (Darius Hyperion)
- Tableau des Accouplements de Voyelles (Martin Saint René)

2 - Règles : E Caduc / E Muet

- L'école De Versification

3 - Autres : trouver des listes d'exceptions (ca peut servir à d'autres)

- Verbe.mobi
- Le bien nommé : Devoir conjugual
- La boite à outils de la recherche de mots

Limites

Malgré toute ma bonne volonté et mes mois de travail, cet outil n'est pas parfait ! Déjà, c'est une version Beta : donc n'hésitez pas à me remonter les bugs par le formulaire de contact, je vous répondrai rapidement.

Il existe aussi une liste de limite identifiée qui font que le résultat peut être amené à débat :
  • Il me manque peut-être (sûrement) quelques verbes dérivés de venir/tenir dans mes exceptions de synérèse et diérèse des "ien"
  • Il me manque peut-être (sûrement) quelques mots communs terminant en "ION" dans mes exceptions de synérèse et diérèse
  • Il me manque peut-être quelques verbes terminant en "IER" dans les exceptions de synérèse et diérèse de "IONS"/"IER"/"IEZ"/"IÉ"/etc...
  • Certains mots sont en synérèse ou diérèse en fonction de leur ["son"/"sens"] ce que je ne peux détecter pour le moment. Ex : INFLUENT (ILS INFLUENT / ILS SONT INFLUENTS).Je pense améliorer ce système mais pas de suite : pour l'instant j'indique "choix de l'auteur synérèse/diérèse"
  • Il me manque sûrement des mots dans ma liste des mots en h muets (pour les règles de e muet/ e caduc)
  • Post Malherbe ! (les "e" muets... le restent. Ex : Marie et non Marieeeeu)
  • Et bien sûr, il y a la licence poétique... Mais ça, c'est une autre histoire ^o^
N'hésitez pas à me remonter tout ce qui vous semble perspicace !
...