Arthur Brandao 4 年之前
父节点
当前提交
7f5980b742

+ 8 - 8
text/app/Application.md

@@ -24,8 +24,8 @@ Toute la partie métier de l'application a été écrite en javascript sans fram
 
 #### Lancement
 
-Cette application ne peut être lancé uniquement avec Electron, il est **impossible** de lancer l'application autrement.
-En effet l'application utilise des fonctionnalité propre à Electron (et node.js) et ne peut donc être lancé que dans cet environnement.
+Cette application ne peut être lancée uniquement avec Electron, il est **impossible** de lancer l'application autrement.
+En effet l'application utilise des fonctionnalités propre à Electron (et node.js) et ne peut donc être lancée que dans cet environnement.
 
 Pour lancer l'application il suffit d'utiliser l'une des commandes suivantes
 
@@ -42,8 +42,8 @@ De même lors de la fermeture de l'application si des fichiers temporaires on é
 
 #### Compilation
 
-Il est théoriquement possible de compiler ce projet pour avoir un éxecutable de l'application. Cependant la compilation n'a jamais été testé.
-De plus la structure du projet prévu pour montrer l'interet et les possibilités d'Electron n'est pas fait pour être compilé et déployé sous forme d'executable.
+Il est théoriquement possible de compiler ce projet pour avoir un ecutable de l'application. Cependant la compilation n'a jamais été testée.
+De plus la structure du projet prévu pour montrer l'intéret et les possibilités d'Electron n'est pas fait pour être compilé et déployé sous forme d'exécutable.
 La compilation est gérée par `Electron forge` et peut être lancé avec la commande suivante :
 
 ```bash
@@ -62,13 +62,13 @@ Les source de cette application sont disponible dans le dossier `app/` à la rac
 - Le dossier `main/` qui contient le code source du processus principal d'Electron (plus d'informations dans la note Electron). 
 Les fichiers dans le dossier sont les fichiers de code éxecuté par Electron, le dosser `function/` regroupe les fonctions utilitaire pour ces fichiers et
 le dossier `asset/` contient les icones utilisés par l'application.
-- Le dossier `renderer/` qui contient les fichiers pour le rendus de l'application. C'est dans ce dossier que ce trouve la base de code commune entre les deux version de l'application.
-Les fichier HTML à la racine du dossier sont les pages qui sont chargées par Electron au lancement. 
+- Le dossier `renderer/` qui contient les fichiers pour le rendus de l'application. C'est dans ce dossier que ce trouve la base de code commune entre les deux versions de l'application.
+Les fichiers HTML à la racine du dossier sont les pages qui sont chargées par Electron au lancement. 
 Le dossier `common/` regroupe tous les fichiers Javascript et CSS commun à toutes les pages de l'application.
 Le dossier `page/` contient toutes les pages de l'application, chaque page possède son propre dossier avec ces fichiers HTML et Javascript.
-Enfin dans le dossier `service/` ce trouve des class utilitaire pour gérer par exemple le stockage ou le routage entre les pages.
+Enfin dans le dossier `service/` ce trouve des class utilitaires pour gérer par exemple le stockage ou le routage entre les pages.
 
 De plus le dossier `helper/` regroupe des fichiers de fonctions utilitaire à thème (par exemple la gestion des fichiers).
 Ces fonctions sont utilisé dans toutes l'application (y comprit dans le fichier `main.js` qui est le fichier principal de l'application).
-Pour finir le dossier `data/` sert à stoquer les infos du dernier lancement (quel version de l'application a été utilisée, pour reset les données en cas de changement), 
+Pour finir le dossier `data/` sert à stoquer les infos du dernier lancement (quel version de l'application a été utilisée, pour reset les données en cas de changement, 
 ainsi que les fichiers temporaires

+ 3 - 3
text/app/Cliquez sur moi.md

@@ -3,7 +3,7 @@ Ceci est une note. Elle contient des informations diverses. Cette note explique
 #### Ajouter une note
 
 Il est possible d'ajouter autant de note que vous voulez.
-Pour ajouter une note il suffit d'appuyer sur le bouton + ou de faire Ctrl+N, une nouvelle fenetre s'ouvre pour créer la note. 
+Pour ajouter une note il suffit d'appuyer sur le bouton + ou de faire Ctrl+N, une nouvelle fenêtre s'ouvre pour créer la note. 
 Chaque note apparaitra sous forme de carte dans la page d'accueil. 
 Cliquez dessus pour voir ce qu'elles contiennent. 
 La création d'une note utilise un éditeur WYSIWYG markdown pour mettre en forme le texte (avec des titres, du code, ...).
@@ -11,14 +11,14 @@ La création d'une note utilise un éditeur WYSIWYG markdown pour mettre en form
 #### Modifier une note
 
 Il est aussi possible de modifier une note, pour ce faire cliquez simplement sur le bouton modifier sur la carte ou lorsque la note est affichée. 
-La modification ouvre la page d'édtion dans une nouvelle fenetre
+La modification ouvre la page d'édition dans une nouvelle fenetre
 Le système d'édition est le même que pour l'ajout et utilise le markdown pour mettre en forme le texte.
 
 #### Supprimer une note
 
 Pour supprimer une note il suffit de cliquez sur le bouton supprimer sur la carte ou dans la note. 
 Une demande de confirmation apparait pour valider ou non la suppression.
-Toute note est définitivement supprimé et ne peut être récupérée.
+Toute note est définitivement supprimée et ne peut être récupérée.
 
 #### Modifier le nom d'utilisateur
 

+ 7 - 7
text/app/Electron.md

@@ -1,6 +1,6 @@
 Electron permet de faire des applications avec les technologies web (HTML 5 / CSS 3 / Javascript). 
-Les applications créée avec Electron peuvent être compiler pour tous les OS existant, ce qui permet avec une seul base de code d'avoir un executable pour tous les environement. 
-De plus les applications Electron utilise les éléments d'interfaces de l'OS cible, de ce fait l'application ressemblera à une application native de l'OS
+Les applications créée avec Electron peuvent être compiler pour tous les OS existant, ce qui permet avec une seul base de code d'avoir un executable pour tous les environements. 
+De plus les applications Electron utilise les éléments d'interfaces de l'OS cible, de ce fait l'application ressemblera à une application native de l'OS.
 
 #### Principe
 
@@ -16,14 +16,14 @@ Dans cette version de l'application le moteur de Node est utilisé partout, mais
 Electron possède deux types de processus, le processus principal et les processus de rendus.
 Le processus principal est celui du fichier `main.js` chargé lors du lancement de l'application, 
 les processus de rendus correspondent chaqu'un à une fenêtre de l'application.
-Les fenêtre peuvent être visible ou non (ainsi le calcul du nombre premier est fait dans un processus de rendu lié à une fenêtre invisible).
+Les fenêtres peuvent être visible ou non (ainsi le calcul du nombre premier est fait dans un processus de rendu lié à une fenêtre invisible).
 
 Les deux types de processus peuvent communiquer entre eux par le biais d'evenements et d'écouteurs sur ces derniers.
-Chaqu'un possède des fonctionnalités qui lui sont propre et l'autre ne peux pas réaliser 
+Chaqu'un possède des fonctionnalités qui lui sont propre et que l'autre ne peux pas réaliser 
 (par exemple les notifications ne peuvent être émise que depuis un processus de rendu).
 
 Au lancement de l'application le fichier `main.js` est éxécuté. Dans un premier temps il va charger les autres fichiers utilisés dans le processus principal.
 Ces fichiers servent par exemple à gérer les différents menus de l'application.
-Ensuite l'application va charger la page HTML correspondant au dashboard et ouvrir un fenêtre (et donc un processus den rendu).
-Dans ce processus de rendu tous les import javascript vont être chargé les balises script dans le fichier HTML.
-Le fichier principal pour le chargements des dépendances et des fonctions necessaires pour l'application est `electronotes.js`
+Ensuite l'application va charger la page HTML correspondant au dashboard et ouvrir un fenêtre (et donc un processus de rendu).
+Dans ce processus de rendu tous les imports javascript vont être chargé par les balises script dans le fichier HTML.
+Le fichier principal pour le chargements des dépendances et des fonctions necessaires pour les processus de rendus est `electronotes.js`

+ 8 - 8
text/app/Fonctionalités.md

@@ -1,17 +1,17 @@
-Dans cette version de l'application la majorité des fonctionnalités de l'application sont implementé en utilisant Electron. 
-Plusieurs fois le mot `CtrlOrCmd` apparait dans cette note pour définir les raccourcis clavier.
- Quand ce mot est présent cela signifie que le raccourcis sur Linux et Windows utilise la touche Ctrl plus une autre 
- alors que sur Mac on utilisara la touche Cmd en plus de l'autre.
+Dans cette version de l'application la majorité des fonctionnalités de l'application sont implementées en utilisant Electron. 
+Plusieurs fois la mention `CtrlOrCmd+Lettre` apparait dans cette note pour définir les raccourcis clavier. 
+Quand ce mot est présent cela signifie que le raccourcis sur Linux et Windows utilise la touche Ctrl plus une lettre 
+alors que sur Mac on utilisara la touche Cmd en plus de la lettre.
 
 #### Menu d'application
 
-L'application possède un menu d'application (souvent situé en haut de l'application) possède 4 sous-menus :
+Electronotes possède un menu d'application (souvent situé en haut) qui possède 4 sous-menus :
 
 - **Fichier** : Gestion des notes
     - ***Nouveau*** *(CtrlOrCmd+N)* : Ouvre la fenêtre de création d'une nouvelle note
     - ***Importer*** *(CtrlOrCmd+I)* : Importe une note à partir d'un fichier. Plus d'informations dans `Export / Import`
     - ***Reset*** *(CtrlOrCmd+R)* : Remet l'application dans son état d'origine avant toutes modifications
-- **Démo** : Démonstration posibilités d'Electron
+- **Démo** : Démonstration des posibilités d'Electron
     - ***Calcul nombre premier*** : Permet de calculer si un nombre donné est premier. 
     Le but est de montré qu'Electron est capable de faire des calculs en arrière plan sans impacter le reste de l'application. 
     Pour que le calcul ne soit pas trop rapide il faut renseigner un nombre vers les 10 milliards
@@ -40,7 +40,7 @@ Le menu contextuel s'affiche en faisant clic droit dans l'application. Il propos
 #### Export / Import
 
 Il est possible d'importer et d'exporter des notes sous deux format, en markdown et en JSON.
-Quand l'export est fait en markdown un le titre de la note devient le nom du fichier et le contenue est le même.
+Quand l'export est fait en markdown le titre de la note devient le nom du fichier et sont contenue devient celui du fichier.
 Dans le cas de l'export en JSON un fichier avec le format ci-dessous seras généré :
 
 ```json
@@ -51,7 +51,7 @@ Dans le cas de l'export en JSON un fichier avec le format ci-dessous seras gén
 }
 ```
 
-C'est ce type de fichier qui est utilisé pour importer les notes par défaut de l'application.
+C'est ce type de fichier qui est utilisé pour importer les notes dans l'application (les fichiers markdown importés sont transformés dans ce format).
 C'est aussi sous cette forme que sont stocker les données dans l'application.
 
 Pour le choix du type d'export ce fait dans le menu contextuel, par défaut l'export ce fait en markdown. Pour exporter une note il suffit de faire un cliquez-doposez d'une note de l'application vers un gestionnaire de fichier.

+ 1 - 1
text/src/Application.md

@@ -58,6 +58,6 @@ Le dossier `js/` contient les fichiers avec les fonctions javascript utilisées.
 Le fichier `binder.js` (écrit pour le projet) contient des fonctions pour automatiser l'affichage de données dans le document HTML et le fichier `script.js` contient des fonctions utilitaire pour l'application. 
 Enfin le dossier `data/` contient les données des notes présentent par défaut.
 
-De plus le dossier `helper/` regroupe des fichiers de fonctions utilitaire sur un thème (par exemple la gestion des fichiers).
+De plus le dossier `helper/` regroupe des fichiers de fonctions utilitaires sur un thème (par exemple la gestion des fichiers).
 Ces fonctions sont utilisé uniquement dans le  fichier `main.js` (qui est le fichier principal de l'application) dans cette version.
 Pour finir le dossier `data/` sert à stoquer les infos du dernier lancement (quel version de l'application a été utilisée, pour reset les données en cas de changement).

+ 2 - 2
text/src/Cliquez sur moi.md

@@ -17,7 +17,7 @@ Le système d'édition est le même que pour l'ajout et utilise le markdown pour
 
 Pour supprimer une note il suffit de cliquez sur le bouton supprimer sur la carte ou dans la note. 
 Attention il n'y a aucune demande de confirmation. 
-Toute note est définitivement supprimé et ne peut être récupérée.
+Toute note est définitivement supprimée et ne peut être récupérée.
 
 #### Modifier le nom d'utilisateur
 
@@ -28,7 +28,7 @@ Le nom est alors modifié en direct et sauvegardé.
 
 Le menu en haut à droite de la page contient des liens vers le site d'electron et du git du projet. 
 Le bouton reset permet de remettre à zero l'application. 
-Remettre à zero l'application supprimera toutes les notes ajouté par l'utilisateur et remettra les notes par défaut dans leur état d'origine
+Remettre à zero l'application supprimera toutes les notes ajoutées par l'utilisateur et remettra les notes par défaut dans leur état d'origine.
 
 #### Infos sur l'application
 

+ 9 - 9
text/src/Electron.md

@@ -1,11 +1,11 @@
 Electron permet de faire des applications avec les technologies web (HTML 5 / CSS 3 / Javascript). 
-Les applications créée avec Electron peuvent être compiler pour tous les OS existant, ce qui permet avec une seul base de code d'avoir un executable pour tous les environement.
-De plus les applications Electron utilise les éléments d'interfaces de l'OS cible, de ce fait l'application ressemblera à une application native de l'OS
+Les applications créée avec Electron peuvent être compiler pour tous les OS existant, ce qui permet avec une seul base de code d'avoir un executable pour tous les environements.
+De plus les applications Electron utilise les éléments d'interfaces de l'OS cible, de ce fait l'application ressemblera à une application native de l'OS.
 
 #### Source
 
-Les sources de cette application sont exactement les même que lorsque l'application est lancé sur un serveur HTTP. 
-Les fichiers utilisé sont exactement les même. Pour plus d'informations sur les dossiers sources, ce referrer à la partie `Source` de la note application.
+Les sources de cette application sont exactement les mêmes que lorsque l'application est lancée sur un serveur HTTP. 
+Les fichiers utilisés sont exactement les mêmes. Pour plus d'informations sur les dossiers sources, se referrer à la partie `Source` de la note application.
 
 #### Principe
 
@@ -14,13 +14,13 @@ Chromium est utilisé pour le rendu des fichiers HTML et Node.js pour éxécuter
 
 #### Fonctionnement
 
-Lors du lancement de l'application Electron le fichier main.js est appelé. Ce fichier permet de lancer l'application avec ou sans l'intégration d'Electron. 
-Dans le cas de cette application (sans intégration d'Electron) l'application va seulement chargé la page index.html 
-dans le dossier `src/` (la création de la fenetre est gérée par des fonctions communes aux deux versions et possède donc toujours un icone). 
-Lorsque toutes les fenetres sont fermées l'application s'arrete sauf sur Mac ou il faut utiliser Cmd+Q (fonctionnement par defaut d'Electron sur Mac).
+Lors du lancement de l'application Electron le fichier `main.js` est appelé. Ce fichier permet de lancer l'application avec ou sans l'intégration d'Electron. 
+Dans le cas de cette application (sans intégration d'Electron) l'application va seulement charger la page `index.html` 
+dans le dossier `src/` (la création de la fenêtre est gérée par des fonctions communes aux deux versions). 
+Lorsque toutes les fenêtres sont fermées l'application s'arrete sauf sur Mac ou il faut utiliser Cmd+Q (fonctionnement par defaut d'Electron sur Mac).
 
 #### Menu
 
 Cette version de l'application étant identique à la version web, elle n'a aucun code spécifique a Electron. 
 De ce fait aucune indication n'est donné pour générer les menus. En l'abscence d'indications Electron genere uniquement une menu d'application (en haut de l'application) par défaut et aucun menu contextuel (clic droit). 
-Le menu est anglais et contient des raccourcis souvent utilisé comme copié/collé, agrandir ou minimiser la fenetre, ...
+Le menu est anglais et contient des raccourcis souvent utilisé comme copier/coller, agrandir ou minimiser la fenetre, ...