Inspire form for Inspire and ISO 19115/19139 metadata
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
jest
src
.babelrc
.editorconfig
.gitignore
CHANGELOG.md
LICENSE
README.md
_package.json
favicon.ico
package-lock.json
package.json
version.txt
webpack.config.js

README.md

mdEdit2

Outil simple et ouvert de saisie, modification et consultation de fiches de métadonnées conformes au format ISO 19139 / INSPIRE.

La présente documentation est adressée aux personnes souhaitant installer mdEdit et contribuer au projet.

Un Guide d'utilisation de mdEdit est également disponible.

La version de développement est la version master. Pour la dernière version stable, consulter la branche stable.

Fonctionnalités principales

  • Création de fiches de métadonnées ISO/INSPIRE
  • Modification de fiches de métadonnées ISO/INSPIRE
  • Visualisation/consultation de fiches de métadonnées ISO/INSPIRE
  • Import de fichiers au format XML ISO/Inspire
  • Export de fichiers au format XML ISO/Inspire

NB: l'application mdEdit ne propose pas de zone de stockage. Les fichiers vers lesquels pointe la fiche de métadonnées (miniature, documentation, données, etc.) doivent être stockés sur un serveur public (ex.: dropbox) pour ensuite être accessibles facilement.

Installation de l'application

Prérequis

Un serveur web avec PHP (testé avec les versions 5.6 et 7.0).

Procédure

mdEdit ne nécessite pas d'installation particulière. Il suffit de placer les fichiers contenus dans le dossier build sur un serveur web fonctionnant avec PHP.

Configuration

La configuration de mdEdit se fait principalement via les fichiers contenus dans le répertoire config.

Utilisation

Interface

L'interface a été conçue pour être simple et facilement utilisable par toute personne disposant d'un minimum de connaissance en terme de description de données géographiques.

A compléter

Permaliens et paramètre d'URL

Il est possible de définir plusieurs propriétés via des paramètres d'URL. Cela permet entre autre de personnaliser l'interface de l'application en se connectant via une URL spécifique.

"model"

Un modèle spécifique de la liste contenue dans "config/models/models.json" peut être utilisé en précisant son identifiant, c'est à dire son numéro d'ordre dans le fichier en commençant à 1. Ainsi, pour utiliser le premier modèle de la liste, il faut ajouter dans l'URL index.html?model=1 ou &model=1.

"view"

Une vue spécifique de la liste contenue dans config/views/views.json peut-être utitisée en précisant son identifiant, c'est à dire son numéro d'ordre dans le fichier en commençant à 1. Ainsi si l'on souhaite utiliser la deuxième vue de la liste, il faut ajouter dans l'URL index.html?view=2 ou &view=2.

"lang"

Une langue spécifique peut-être utilisée en précisant le paramètre "lang" et le code de la langue sur 2 caratères (fr pour français, de pour allemand, en pour anglais, etc.). Aini, pour forcer l'affichage en allemand (pour peut que cette traduction existe...), il faut ajouter dans l'URL index.html?lang=de ou &lang=de.

Choix techniques et développement

Les choix sont réalisés afin que:

  • L'application soit moderne dans son graphisme et ses fonctionnalités
  • L'application reste légère et maintenable
  • L'application n'impose pas d'exigences particulières pour l'installation et l'utilisation
  • L'application puisse fonctionner en mode connecté et déconnecté
  • L'application ne nécessite pas d'authentification (possibilité d'ajouter une authentification HTTP côté serveur si nécessaire)

Langages utilisés

  • JS, HTML et CSS côté interface utilisateur
  • PHP pour le téléchargement des fichiers XML (version web)
  • Python (serveur embarqué pour usage desktop)
  • Markdown pour la documentation

Principaux frameworks et bibliothèques utilisés

Attention: migration de Bootstrap 3 vers Bootstrap 4 lors du passage de la version 2.0 à 2.1 de mdEdit.

  • jquery - version 3.3.1
  • twitter bootstrap - version 4.1.3
  • angular js - version 1.7.5
  • angularjs / ui router - version 1.0.20
  • ui-bootstrap4 - version 3.0.5
  • showdown - version 1.9.0
  • xml-js - version 1.6.8
  • lodash - verison 4.17.11
  • lodash-uuid - version 0.0.3
  • rename-keys - version 2.0.1
  • jsonpath - version 1.0.0

Pour plus de détails sur les versiond es librairies utilisées, consultez le fichier package.json.

Contribution

Installation de l'environnement de développement

Le développement de mdEdit 2 est principalement basé sur nodejs et webpack. NodeJs doit être installé.

Cloner le dépôt GitHub:

git clone https://github.com/geograndest/mdedit2.git
cd mdedit2

Installer les modules

npm install

Lancer l'environnement de développement

npm run serve

Pour compiler le code (cf. dossier build)

npm run build