From ad742fe983b6723bffb9390a922cdd50e6a088fc Mon Sep 17 00:00:00 2001 From: Esquilax76 Date: Wed, 11 Jan 2017 19:17:13 +0100 Subject: [PATCH] update readme --- hdoc_to_neo4j/README.md | 34 ++++++++++++++++++++++++---------- opale_to_neo4j/README.md | 32 ++++++++++++++++++++++++-------- 2 files changed, 48 insertions(+), 18 deletions(-) diff --git a/hdoc_to_neo4j/README.md b/hdoc_to_neo4j/README.md index 660eb26..045260d 100644 --- a/hdoc_to_neo4j/README.md +++ b/hdoc_to_neo4j/README.md @@ -35,36 +35,50 @@ WARNINGS: User documentation ------------------ -You have to respect the following steps : +1 - Place one or several files (.hdoc) in the "input" folder -1 - Placer un ou plusieurs fichiers (format hdoc) dans le dossier input +2 - Run the "runWithNode" file (choose the extension according to your OS) -2 - Modifier le fichier config.json (dans le dossier node) avec la base de données locale et le mot de passe personnel (base publique à venir) - -3 - Lancer le fichier runWithNode (choisissez l'extension selon votre OS) - -4 - Admirez le graph créé avec neo4j dans votre navigateur (sur localhost:7474) +3 - Admire the graph created with neo4j in your browser (on localhost:7474) Unsupported ----------- -There is no shared public database for now. -The "References" links are not fully supported yet. The opale_to_hdoc part is done, but needs an implementation in hdoc_to_neo4j. Known bugs ---------- - Todo ---- +Create a new type of link for references (a first version of the "voir aussi" section is done in opale_to_hdoc) +Create and import a .grass file for nodes and links style +Use metadata (as a new attribute to the node) to search all nodes related to a topic +Create a public database Technical notes --------------- +Here are some requests which could be useful : + +==> Display all data +MATCH (n) return n + +==> Delete all data +MATCH (n) detach delete n + +==> Display all exercises +MATCH (n:exercise) return n + +==> Display all nodes linked with the searched one +MATCH (n) WHERE n.title =~ '(?i).*Algèbre.*' MATCH(n)-[:LIEN*1..10]->(d) RETURN distinct d; + +==> Delete a single node +MATCH (n) WHERE n.title =~ '(?i).*Gestion du personnel.*' detach n delete n + Capitalisation diff --git a/opale_to_neo4j/README.md b/opale_to_neo4j/README.md index 606424f..56c092c 100644 --- a/opale_to_neo4j/README.md +++ b/opale_to_neo4j/README.md @@ -37,34 +37,50 @@ User documentation You have to respect the following steps : -1 - Placer un ou plusieurs archives (format scar) dans le dossier input +1 - Place one or several archives (.scar) in the "input" folder -2 - Modifier le fichier config.json (dans le dossier ../hdoc_to_neo4j/node) avec la base de données locale et le mot de passe personnel (base publique à venir) +2 - Run the "runWithNode" file (choose the extension according to your OS) -3 - Lancer le fichier runWithNode (choisissez l'extension selon votre OS) - -4 - Admirez le graph créé avec neo4j dans votre navigateur (sur localhost:7474) +3 - Admire the graph created with neo4j in your browser (on localhost:7474) Unsupported ----------- -There is no shared public database for now. -The "References" links are not fully supported yet. The opale_to_hdoc part is done, but needs an implementation in hdoc_to_neo4j. Known bugs ---------- - Todo ---- +Create a new type of link for references (a first version of the "voir aussi" section is done in opale_to_hdoc) +Create and import a .grass file for nodes and links style +Use metadata (as a new attribute to the node) to search all nodes related to a topic +Create a public database Technical notes --------------- +Here are some requests which could be useful : + +==> Display all data +MATCH (n) return n + +==> Delete all data +MATCH (n) detach delete n + +==> Display all exercises +MATCH (n:exercise) return n + +==> Display all nodes linked with the searched one +MATCH (n) WHERE n.title =~ '(?i).*Algèbre.*' MATCH(n)-[:LIEN*1..10]->(d) RETURN distinct d; + +==> Delete a single node +MATCH (n) WHERE n.title =~ '(?i).*Gestion du personnel.*' detach n delete n + Capitalisation -- GitLab