Commit 27882082 authored by Edith Cannet's avatar Edith Cannet
Browse files

màj readme pour utilisateur

parent 4e68b840
Loading
Loading
Loading
Loading
+78
Changes for README.md: 78 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -6,6 +6,7 @@ Plugin OJS/OMP de conversion XML vers HTML via transformation XSLT.
Testé sur OJS 3.3.0-7 et 3.3.0-12, OMP 3.3.0-4



## Installation

````
@@ -14,15 +15,20 @@ git clone git@git.unicaen.fr:fnso/fairest/xml2html-pkp-plugin.git xml2html
````
Attention : pas de tiret dans le nom de dossier du plugin



## Activation du plugin

Activer le plugin depuis la section *admin > website > plugins* d'OJS ou OMP



## Modification XSL

Éditer ou remplacer le fichier *2html.xsl*. La tranformation fournie (issue de https://github.com/ncbi/JATSPreviewStylesheets/blob/master/xslt/main/jats-html.xsl) prend du XML JATS en entrée.



## Notes techniques

Le plugin peut gérer 2 cas d'utilisation pour les fichiers soumis :
@@ -35,3 +41,75 @@ Dans le second cas :
 - 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]



## Fonctionnement utilisateur : procédure de chargement des fichiers

Ces étapes sont réalisées à l'étapes de *Publication* > onglet *Publication Formats*.



**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 :

- Ajouter un format de publication
  - Nom : "HTML"

  - Type : *Digital (DA)*



**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*.

    > **Rappel**
    >
    > - *Workflow* > *Production*
    > - onglet *Production Ready Files*
    > - **Upload File* : ajouter les archives `zip`  (contenant le fichier XML et les images associées)
    
    
      - *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.
    


- Option 2 : charger les fichiers pour publication plein-texte.

  - *Change File*
  - Suivre les étapes pour charger un fichier (*Upload file*, *Review Details*, *Confirm*)

- Attribuer, pour chaque fichier, les autorisations pour la diffusion plein texte :

  - *Set approval*
  - *Set terms* : *Open Access*



**Constituer les chapitres**

Passer dans l'onglet *Chapters* afin d'ajouter les chapitres et affecter le.s format.s de publication.

- 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…)



**Publier**



**Quick submit plugin** : L'archive `.zip` peut être fournie lors de la soumission, compatible avec le `quick submit plugin`.

- La prévisualisation (bouton `preview`) à partir de publication ne fonctionne pas (ne semble pas gênant).

- Affichage une fois la soumission rattachée à un numéro.

- Passage par la *landing page*.