> N.B. : ne pas insérer de tiret dans le nom de dossier du plugin.
### Activation du plugin
### Activation
Activer le plugin depuis la section *Site web > Modules externes* (requiert rôle avec niveau d'autorisation suffisant).
Activer le plugin depuis la section *Site web > Modules externes* (requiert un rôle avec niveau d'autorisation suffisant).
### Paramètre du plugin
### Paramètres
Depuis *Site web* > *Modules externes* > *Modules installés* : XML To HTML PLUGIN *Paramètres* : choisir le *Format / Vocabulaire XML* dans le menu déroulant : JATS ou TEI.
Depuis *Site web* > *Modules externes* > *Modules installés* : XML To HTML PLUGIN > *Paramètres* : choisir le *Format / Vocabulaire XML* dans le menu déroulant : JATS ou TEI.
Choix de la XSL d'import à mobiliser : TEI ou JATS.
> Deux transformations sont fournies dans le plugin :
>
> - intégration d'un flux XMLJATS (`jats2html.xsl`, fork de https://github.com/ncbi/JATSPreviewStylesheets/blob/master/xslt/main/jats-html.xsl) ;
> - intégration d'un flux XMLTEI *Commons Publishing* (`tei2html.xsl`).
Deux transformations sont fournies dans le plugin :
- intégration d'un flux XML-JATS (`jats2html.xsl`, fork de https://github.com/ncbi/JATSPreviewStylesheets/blob/master/xslt/main/jats-html.xsl) ;
- intégration d'un flux XML-TEI *Commons Publishing* (`tei2html.xsl`).
@@ -116,14 +114,14 @@ Ajouter les fichiers qui génèreront les pages HTML des chapitres :
>
> - *Flux des travaux* > *Production*
> - *Fichiers publiables*
> - **Transférér le fichier* : ajouter les archives `zip` (contenant le fichier XML et les images associées).
> - *Transférér le fichier* : ajouter les archives `zip` (contenant le fichier XML et les images associées).
- *Sélectionner les fichiers*
- Cocher l'option *Inclure tous les fichiers de toutes les étapes de production accessibles.* pour afficher la liste des fichiers issus du *Flux des travaux*, étape *Production*.
- Cocher l'option *Inclure tous les fichiers de toutes les étapes de production accessibles* pour afficher la liste des fichiers issus du *Flux des travaux*, étape *Production*.
- Sélectionner les fichiers disponibles via le *Flux des travaux* pour la publication en plein-texte.
@@ -134,8 +132,7 @@ Ajouter les fichiers qui génèreront les pages HTML des chapitres :
-*Modifier le fichier*
- Suivre les étapes pour charger un fichier (*Transférer la soumission*, *Métadonnées*, *Terminer*)
- Attribuer, pour chaque fichier, les autorisations pour la diffusion plein texte :
- [important !] Attribuer, pour chaque fichier, les autorisations pour la diffusion plein texte :
-*Approbation*
-*Modalités de téléchargement* : *Accès libre*.
@@ -150,7 +147,7 @@ Passer dans l'onglet *Chapitres* afin d'ajouter les chapitres et affecter le.s f
> !! vérifier release note 3.4 pour mesurer les changements
À partir de la même page, il est possible de prévisualiser la publication (*Aperçu*) et de la publier (*Publier*).
@@ -162,21 +159,21 @@ Ajouter une épreuve :
- Étiquette : "HTML" ;
- Transférer le fichier
- Sélectionner l'élément de l'article ("Texte de l'article" ou autre type de document) ;
- Sélectionner le type de document ("Texte de l'article" ou autre type de document) ;
- Charger l'archive `zip` exporté depuis *XMLMind* puis cliquer sur *Continue*
- (facultatif) Éditer le nom du fichier soumis puis *Continue*
-*Terminer*
À partir de la même fenêtre, il est possible de prévisualiser la publications (*Aperçu*) et de programmer sa publication (*Calendrier de publication*).
À partir de la même page, il est possible de prévisualiser la publication (*Aperçu*) et de programmer sa publication (*Calendrier de publication*).
#### Remarques
-**Quick submit plugin** : L'archive `.zip` peut être fournie lors de la soumission, compatible avec le `quick submit plugin`.
**Quick submit plugin** : L'archive `.zip` peut être fournie lors de la soumission, compatible avec le `quick submit plugin`.
@@ -184,10 +181,10 @@ Ajouter une épreuve :
### Structure des archives soumises au plugin
Le plugin gère deux structure pour les fichiers soumis :
Le plugin gère deux structures pour les fichiers soumis :
1. chargement d'un fichier xml + chargement une à une des images associées à l'article ;
2. chargement d'une archive au format zip contenant le fichier xml + les images associées.
2. chargement d'une archive au format `zip` contenant le fichier xml + les images associées.
@@ -202,15 +199,19 @@ Dans le second cas :
### Feuilles de transformations XSLT
#### TEI Commons Publishing to HTML
- Gestion des index
**Roadmap**
- Internationalisation des labels d'affichage
#### JATS Publishing 1.3 to HTML
#### JATS Publishing 1.3 to HTML
**Roadmap**
@@ -218,6 +219,10 @@ Dans le second cas :
#### Ajouter une feuille de transformation XSLT
### Interactivité de la page web (javascript)
Par défaut :
@@ -227,11 +232,11 @@ Par défaut :
- Illustrations :
- circulation depuis les titres des illustrations vers les illustrations (panneau latéral) ;
- Tableaux, double mode de visualisation :
- seul le titre est affiché, cliquer sur le titre pour afficher le contenu dans le corps du texte ;
- seul le titre est affiché, cliquer sur le titre pour afficher le contenu dans la fenêtre principale ;
- cliquer sur l'îcone <spanstyle="font-weight:bold;color:#0a84ff;">↗</span> pour ouvrir le tableau dans une fenêtre externe ;
- Références bibliographiques : navigation des liens de références courtes vers les références longues ;
- Index : listes dépliables des index, lien pour chaque occurrence avec retour au texte ;
Changes for README.md: 139 added lines, 89 removed lines.
Original line number
Diff line number
Diff line
@@ -6,29 +6,67 @@
**Ce plugin est en cours de développement, son usage n'est pas destiné à être utilisé en production.**
Plugin OJS and OMP for XML loading and conversion to HTML, developed as part of the [FNSO FAIREST](https://www.ouvrirlascience.fr/fair-environment-for-structured-editing/) FNSO (French National Fund for Open Science) project ([IR Métopes](https://www.metopes.fr/) et [Certic](https://www.certic.unicaen.fr/home/)) :
- generates an HTML page for full-text dissemination;
- via XSLT transformation;
- from XML-JATS Publishing 1.3 or XML-TEI Commons Publishing files;
- uploads associated images via the same archive;
- customisable layout elements (template, CSS, javascript).
Plugin OJS and OMP to convert XML to HTML via XSL transformation.
Developed as part of the [FNSO FAIREST](https://www.ouvrirlascience.fr/fair-environment-for-structured-editing/) FNSO (French National Fund for Open Science) project.
Activate the plugin from *Website > Plugins* with suffisant permission level.
These steps are done from *Publication* > *Publication Formats* tab.
## Settings
#### Add HTML publication format
> Deux transformations sont fournies dans le plugin :
>
> - prenant du XML JATS en entrée (issue de https://github.com/ncbi/JATSPreviewStylesheets/blob/master/xslt/main/jats-html.xsl) ;
> - prenant du XML TEI *Commons Publishing* (`tei2html.xsl`).
Lors de la <u>première création</u> d'une publication au format HTML pour un ouvrage :
-*Add publication format*
- Name: "HTML"
Permet de choisir la XSL d'import mobilisée : TEI ou JATS.
- Publication Format: *Digital (DA)*
Depuis *Website* > *Plugins* > *Installed Plugins* : XML To HTML PLUGIN *settings* : choisir le *Format / XML Vocabulary* dans le menu déroulant : JATS ou TEI.
#### Add sources files for HTML generation
## Notes techniques
Add files that will produce chapters HTML pages:
Le plugin peut gérer 2 cas d'utilisation pour les fichiers soumis :
1. upload d'un fichier xml + upload une à une des images associées à l'article
2. upload d'une archive au format zip contenant le fichier xml + les images associées
- Option 1: files that have already been uploaded to any submission stage are available as *Production Ready Files*.
Dans le second cas :
- l'archive est dézippée dans le dossier du zip
- le dossier décompressé est renommé avec l'id unique généré par ojs
- le fichier xml est rennomé avec ce même identifiant : `[id]/[id].xml`
- les urls des images sont de la forme `[idarticle]/zimage/[id1]/[id2][nom_image].[extension]`
> **Remimder**
> - *Workflow* > *Production*
>- *Production Ready Files* tab
> - *Upload File*: add `zip` files (containing XML file and linked images)
-*Select Files*
- Check *Show files from all accessible workflow stages* to display files from *Workflow*, *Production* step.
## Interactivité de la page web (javascript)
- Select available files from *workflow* for full-text dissemination.
- Tables des matières cliquable
- Circulation depuis les appels de notes faire les notes et retour
- Figures
- circulation depuis les titres des images vers les images (panneau latéral)
- Tableaux, double mode de visualisation
- Seul le titre est affiché, cliquer sur le titre pour afficher le contenu dans le corps du texte.
- Cliquer sur l'îcone <spanstyle="font-weight:bold;color:#0a84ff;">↗</span> pour ouvrir le tableau dans une fenêtre externe.
- Références bibliographiques : navigation des liens de références courtes vers les références longues.
- Index : listes dépliables des index, lien pour chaque occurrence avec retour au texte.
- Dark mode : mode de lecture sombre.
- Option 2: load files for full-text dissemination.
**Roadmap**
-*Change File*
- Follow the steps to upload a file (*Upload file*, *Review Details*, *Confirm*)
-Figures : affichage des illustrations dans une fenêtre externe (visualiseur IIIF).
- Plusieurs jeux de notes
- Division de la fenêtre principale (texte et panneaux) redimensionnable.
-[important!] For each file, set approval for full-text dissemination:
-*Set approval*
-*Set terms* : *Open Access*
## Fonctionnement utilisateur [OMP] : procédure de chargement des fichiers
#### Create chapters
Ces étapes sont réalisées à l'étapes de *Publication* > onglet *Publication Formats*.
Go to *Chapters* tab to add chapter and assign publication format(s).
- Add chaper : *Add Chapter*; a least, type a title and save;
- Select file(s) corresponding to the chapter (`zip`, possibly PDF, epub…)
### Définir le format de publication HTML
Lors de la <u>première création</u> d'une publication au format HTML pour un ouvrage :
From the same page, you can preview (*Preview*) and publish it (*Publish*).
- Ajouter un format de publication
- Nom : "HTML"
- Type : *Digital (DA)*
### OJS: Load files
These steps are done from *Publication* > *Galleys* tab.
### Ajouter les fichiers sources pour la production des pages HTML
Ajouter les fichiers qui génèreront les pages HTML des chapitres :
- Option 1 : les fichiers pour la diffusion plein-texte sont issus des étapes du *worflow*, stockés comme *Production Ready Files*.
*Add Galley*
> **Rappel**
>
> - *Workflow* > *Production*
> - onglet *Production Ready Files*
> - **Upload File* : ajouter les archives `zip` (contenant le fichier XML et les images associées)
-*Upload archive*: upload `zip` archive exported from *XMLMind* then click *Continue*;
- (optional) Edit file name then *Continue*
-*Confirm*
From the same page, you can preview (*Preview*) and schedule publication (*Schedule publication*).
- *Select Files*
- Cocher l'option *Show files from all accessible workflow stages* pour afficher la liste des fichiers issus *Workflow*, étape *Production*.
- Sélectionner les fichiers disponibles via le *workflow* pour la publication en plein-texte.
#### Remarks
**Quick submit plugin**: `.zip` can be upload from submission step, compatible with `quick submit plugin`.
- Option 2 : charger les fichiers pour publication plein-texte.
-*Change File*
- Suivre les étapes pour charger un fichier (*Upload file*, *Review Details*, *Confirm*)
## Technical notes
- Attribuer, pour chaque fichier, les autorisations pour la diffusion plein texte :
### Structure of archives submitted to the plugin
-*Set approval*
-*Set terms* : *Open Access*
The plugin manages two structures for sumitted files:
1. upload of an xml file + upload images one by one;
2. upload of a `zip` archive containing xml file + all associated images.
### Constituer les chapitres
Passer dans l'onglet *Chapters* afin d'ajouter les chapitres et affecter le.s format.s de publication.
In the second case :
- Ajouter un chapitre : *Add Chapter* ; a minima, saisir la métadonnée titre ; sauvegarder ;
- Cliquer sur le titre du chapitre et sélectionner les fichiers (formats) à associer (`zip`, éventuellement PDF, epub…)
- archive is decompressed into the zip folder;
- unzipped folder is renamed with the unique id generated by ojs;
- xml file is renamed with the same identifier: `[id]/[id].xml`;
- image urls are `[idarticle]/zimage/[id1]/[id2][nom_image].[extension]`.
**Publier**
### Feuilles de transformations XSLT
#### TEI Commons Publishing to HTML
### Remarques
-**Quick submit plugin** : L'archive `.zip` peut être fournie lors de la soumission, compatible avec le `quick submit plugin`.
- Index management
**Roadmap**
- Internationalisation des labels d'affichage
#### JATS Publishing 1.3 to HTML
**Roadmap**
- Internationalisation of display labels
## Fonctionnement utilisateur [OJS] : procédure de chargement des fichiers
#### Add a XSLT
- Accéder à l'étape ***Publication*** / Go to ***Publication***
- Puis l'onglet ***Épreuves*** / Then on tab ***Galleys***
- Ajouter une épreuve / *Add Galley*
- Nom : "HTML" / *Galley Label* : "HTML" ;
- 1. Charger l'archive zip exporté depuis *XMLMind* (en tant que "Texte de l'article" ou autre type de document) puis cliquer sur *Continue* / *Upload archive (choose "Text Article" or else Article Component type) then Continue*
2. (facultatif) Éditer le nom du fichier soumis puis *Continue* / *Edit file name then Continue*
3. Confirmer / *Confirm*
- Prévisualiser / *Preview*
- Calendrier de publication / *Schedule publication*
### Web page interactivity (javascript)
By default:
- Clickable table of content;
- Navigation from notes calls to notes and back;
- Illustrations :
- navigation from titles to illustrations (lateral pane);
- Tables, double display:
- only title is displayed, click on the title to display the content in the main text pane;
- click ont <spanstyle="font-weight:bold;color:#0a84ff;">↗</span> icon to opeb table in an external window;
- Bibliographical citations: navigation from short citations to extended ones;
- Index: fold-out index lists, link for each occurrence with way back to text;
- Dark mode : dark reading mode.
**Roadmap**
- Figures: illustrations displayed in external window (IIIF viewer);
- Several sets of notes;
- Resizable main window (text and panels).
### Remarques
### Styling content (CSS)
-**Quick submit plugin** : L'archive `.zip` peut être fournie lors de la soumission, compatible avec le `quick submit plugin`.
