SynopsX. A Lightweight XML Publishing Framework

SynopsX est un système de publication léger, entièrement fondé sur des technologies XML à partir de la base de données XML native BaseX. Initié par l'Atelier des Humanités Numériques de Lyon (AHN), le projet est développé comme logiciel libre par une équipe de plusieurs contributeurs issus du monde académique. Le logiciel libre et open source est basé sur les fonctionnalités RESTXQ implémentées par BaseX.

Dans son état actuel, le logiciel permet :

  • une publication personnalisée de sources textuelles XML-TEI,
  • une publication d'entrepôt OAI-PMH,
  • une articulation entre des sources EAD et XML-TEI,
  • de disposer d'un moteur de recherche sommaire,

Le code du logiciel se caractérise par son extrême concision et son caractère modulaire. Il est donc très aisé de se l'approprier et de l'adapter à ses propres besoins. Ce logiciel est déjà en production pour différentes applications web de l'ENS Lyon. Plusieurs partenaires membres du consortium Cahier lyonnais et parisiens (ANR Ampère, et Projet des Guides de Paris notamment) participent déjà au projet.

Start a new synopsX project (english documentation)

Java requirements on your computer :

  • Make sure you have the last Java JDK installed on your computer (having the last Java JRE version installed won't be enough). Download the last JDK Environnement from this Oracle Page: http://www.objis.com/formation-java/tutoriel-java-installation-jdk.html
  • Before downloading choose the appropriate version (system + processor: i.e. Mac OSX x64)
  • Go to you /Downloads/ page and double-click on the installation file: i.e.: jdk-8u60-macosx-x64.dmg or jdk-8u60-macosx-x64.exe
  • Complete installation
  • Open a terminal to check the Java JDK version with the following command: java -version

Install BaseX:

  • Go to http://basex.org/
  • Click on "Download BaseX 8.3"

Add Saxon processor HE to BaseX:

  • Dowload from (choose the zipped directory, on top of the page): http://sourceforge.net/projects/saxon/files/
  • Unzip downloaded file
  • Put content on the following directory: basex/lib

Install SynopsX:

  • Go to: https://github.com/ahn-ens-lyon/synopsx
  • If you don’t have a github app: download the zipped synopsX directory
  • Unzip synopsx-dev.zip
  • Rename synopsx-dev to synopsx
  • Place synopsx directory in basex/webapp

Démarrer un nouveau project synopsX (documentation en français)

Pré-requis Java :

  • Installez la dernière version de Java JDK sur votre ordinateur car l’environnement Java JRE ne sera pas suffisant : télécharger la dernière version sur cette page d’Oracle : http://www.objis.com/formation-java/tutoriel-java-installation-jdk.html
  • Choisissez la version à télécharger en fonction du système d’exploitation et du processeur de votre ordinateur (ex: Linux x64)
  • Allez dans votre page de téléchargements Downloads/ et double-cliquez sur le fichier d'installation : i.e. : jdk-8u60-macosx-x64.dmg ou jdk-8u60-macosx-x64.exe
  • Finalisez votre installation
  • Vous pouvez vérifier la version Java JDK installée avec la ligne suivante dans un terminal : java -version

Installer BaseX :

  • Allez sur : http://basex.org/
  • Cliquez sur : "Download BaseX 8.3"

Ajouter le processeur Saxon HE à BaseX :

  • Télécharger depuis (choisir le dossier zipé en haut de la page) : http://sourceforge.net/projects/saxon/files/
  • Dézipper le dossier téléchargé
  • Installer le contenu dans basex/lib

Installer SynopsX :

  • Allez sur : https://github.com/ahn-ens-lyon/synopsx
  • Si vous n’avez pas d'applicatif github cliquez sur : "download Zip"
  • déziper synopsx-dev.zip
  • renommer le dossier "synopsx-dev" en "synopsx"
  • Déposer le dossier synopsx dans basex/webapp