Edit Installation Guide

docs/installation-guide.md

+---
+title:  Installation & usage documentation
+subtitle: Instalation Guide of Gazelle Objects Checker
+authors: Achraf Achkari
+date: 19/10/2021
+---
+
 # Instalation Guide of Gazelle Objects Checker
 
 ### Table of Content
@@ -68,9 +75,10 @@ The resources models are packaged in a module called `UML Models`.
 
 you need to have `git` and `maven` installed<br><br>
 Run the following command:
-> `git clone https://gitlab.inria.fr/gazelle/library/gazelle-objects-checker.git`
->
-> `cd gazelle-objects-checker`
+```bash
+> git clone https://gitlab.inria.fr/gazelle/library/gazelle-objects-checker.git
+> cd gazelle-objects-checker
+```
 
 > Notice: the install of gazelle-objects-checker will be done in the [Generate Artifact](#generateArtifact) section.<br>
 You can skip tests if you want, but it's not recommand to do.
@@ -91,17 +99,19 @@ The unit tests are _environement independents_.
 The integration tests create some temporary resources (UML Models) using the `uml-modes` (no need to have it installed locally, it has been packaged in [Nexus](https://gazelle.ihe.net/nexus/#nexus-search;quick~uml-models))
 <br>
 **Run Unit tests**
->`cd gazelle-objects-checker`
-> 
-> `mvn test`
-> 
+```bash
+> cd gazelle-objects-checker
 
+> mvn test
+```
 
 **Run Integration Tests**
->`cd gazelle-objects-checker`
->
-> `mvn verify`
-> 
+```bash
+> cd gazelle-objects-checker
+
+> mvn verify
+```
+
 If Something went wrong, make sure you have mentioned in maven logs:
 - Resources created successfully
 - Ressources deleted successfully
@@ -144,11 +154,11 @@ After having all tests working _(not mandatory but recommanded)_ we can now inst
 The Artifact generated is a `.jar` suffixed by `jar-with-dependencies` as it's created as a **standalone** application.
 <br><br>
 To do we run the following command:
->`mvn clean install`
-> 
-> or
-> 
-> `mvn clean install -DskipTests=true` (to skip tests)
+```bash
+> mvn clean install
+or
+> mvn clean install -DskipTests=true` (to skip tests)
+```
 
 > Alert: even if GOC is in Standalone mode, it's need to have the Archetype installed locally at **Runtime**
 > 
@@ -161,9 +171,11 @@ The Artifcat is generated at _**gazelle-objects-checker/hl7templates-packager-ja
 
 > _**HINT**_: if you still have compile errors, you can install just the archetypes module (as it's required at runtime) with:
 > 
-> `cd gazelle-objects-checker/archetype/generated-validator`
+> ```bash
+> cd gazelle-objects-checker/archetype/generated-validator
 > 
-> `mvn clean install`
+> mvn clean install
+> ```
 > 
 > And retrieve GOC Artifact from nexus.
 > 
@@ -261,18 +273,22 @@ Move to the hl7templates-packager-jar/target directory and run the following com
 
 Generic command with all possible parameters: <br>
 
->`java -jar hl7templates-packager-jar-X.X.X[-SNAPSHOT]-jar-with-dependencies.jar -bbr <Path_To_BBR> 
+```bash
+> java -jar hl7templates-packager-jar-X.X.X[-SNAPSHOT]-jar-with-dependencies.jar -bbr <Path_To_BBR> 
 -out <Path_To_Output> -mvn <Path_To_MVN> [-serviceName <Service_Name>] [-HL7TEMP_CDACONFFOLDERNAME <cdabasic|cdaepsos>] 
  [-ignoreTemplateIdRequirements <true|false>] [-ignoreCdaBasicRequirements <true|false>]
-[-versionLabel <version>] [-rootClassName <Root_ClassName>] [-HL7TEMP_RESOURCES_PATH <Path_To_Resources>]` 
+[-versionLabel <version>] [-rootClassName <Root_ClassName>] [-HL7TEMP_RESOURCES_PATH <Path_To_Resources>]
+```
 
 _The [X.X.X] to the current used version of GOC, and it's not present if we retrieve a release from Nexus._
 
 Example with SEQUOIA:
->`java -jar hl7templates-packager-jar-3.0.0-SNAPSHOT-jar-with-dependencies.jar -bbr ~/Documents/BBR-SEQUOIA.xml
-> -out home/mylap/Documents/GOC-OUTPUT/output-sequoia-mu3 -mvn /opt/apache-maven-3.5.4/bin/mvn
-> -serviceName "HL7 - C-CDA R2.1 - Meaningful Use Stage 3" -ignoreTemplateIdRequirements 
-> -ignoreCdaBasicRequirements  -versionLabel 2.1`
+```bash
+> java -jar hl7templates-packager-jar-3.0.0-SNAPSHOT-jar-with-dependencies.jar -bbr ~/Documents/BBR-SEQUOIA.xml
+ -out home/mylap/Documents/GOC-OUTPUT/output-sequoia-mu3 -mvn /opt/apache-maven-3.5.4/bin/mvn
+ -serviceName "HL7 - C-CDA R2.1 - Meaningful Use Stage 3" -ignoreTemplateIdRequirements 
+ -ignoreCdaBasicRequirements  -versionLabel 2.1
+```
 
 **For logs:**
 >Root folder of the provided output path
@@ -291,11 +307,13 @@ We will suppose we generated a validator with a BBR containing the following ver
 _We didn't use the SEQUOIA's BBR because the validator needs a hack (access to SVS) before it could be used_
 
 Open the following directory:
->`cd <Path_To_Output>/epsos5-validator-app/bin`
-> 
-> `chmod +x validator.sh`  [if on linux] 
-> 
-> `./validator.sh -path <Path_to_CDA.xml> -out <Path_To_output_result.xml>`
+```bash
+> cd <Path_To_Output>/epsos5-validator-app/bin
+
+> chmod +x validator.sh  #if on linux 
+
+> ./validator.sh -path <Path_to_CDA.xml> -out <Path_To_output_result.xml>
+```
 
 Here is a summary of possible parameters for the validator:
 <table>
@@ -345,7 +363,10 @@ Here is a summary of possible parameters for the validator:
 </table>
 
 Here is an example to validate a document with normal case: 
->`./validator.sh -path /home/mylap/eHDSI_CDA.xml -out ../../results1.xml`
+
+```bash
+> ./validator.sh -path /home/mylap/eHDSI_CDA.xml -out ../../results1.xml
+```
 
 <div id='extra'/>