Manuel d'intégration


  1. Installation
  2. Choix du moteur de génération des images

Installation

  • Arrêter le serveur
  • Télécharger les jars du plugin et ajouter-les (ametys-plugin-flipbook-1.4.0.jar et ametys-plugin-flipbook-resources-1.4.0.jar)  dans le répertoire WEB-INF/lib de votre application Ametys

  • Ajouter le menu permettant d'insérer des PDF intéractifs dans le fichier WEB-INF/params/cms-ribbon-default.xml. L'identifiant du bouton est org.ametys.flipbook.editor.Insert
    Ajoutez-le dans le groupe "Insertion" de l'onglet contextuel d'édition (org.ametys.cms.content.EditionTab)

<tabs>
	<tab label="plugin.cms:RIBBON_TABS_TAB_CONTENT_EDIT_LABEL" id="org.ametys.cms.content.EditionTab" contextualColor="1" contextualGroup="Z" contextualLabel="plugin.cms:RIBBON_TABS_TAB_CONTENT_EDIT_LABEL">
    	<groups>
			[...]
			<group label="plugin.cms:RIBBON_TABS_TAB_CONTENT_EDIT_GROUPS_GROUP_INSERT_LABEL" icon="">
				<large>
					[...]
				</large>
				<medium>
					[...]
					<control id="org.ametys.flipbook.editor.Insert"/>
				</medium>
				<small>
					[...]
				</small>
			 </group>
			[...]
		</groups>
	<tab>
	[...]
</tabs>

Attention ! Si le groupe contient une description <large>, <medium> et <small> , il faut ajouter le bouton dans les 3.

 

  • Redémarrer le serveur

Choix du moteur de génération des images

L'affichage d'un fichier PDF comporte deux phases : les pages du fichier PDF sont extraites sous la forme d'images PNG, puis la visionneuse affiche celles-ci.

La génération des pages sous forme d'images étant un point d'extension, plusieurs options sont disponibles pour réaliser cette opération :

  • Via la librairie java Apache PDFBox
  • En utilisant un programme externe en ligne de commandes, comme pdftoppm
Moteur d'extractionNom de l'extensionSystèmes d'exploitationQualité de l'extraction
Librairie java Apache PDFBox

org.ametys.plugins.flipbook.convertor.Pdfbox

Tousbonne
Programme externe en ligne de commandes

org.ametys.plugins.flipbook.convertor.CommandLine

Linux et MacOS uniquementtrès bonne

Le choix du moteur de génération des images se fait dans le fichier de configuration "".

Utilisation d'Apache PDFBox

Il s'agit de la solution par défaut car c'est la plus simple à mettre en oeuvre : il n'y a pas de programme externe à installer, la librairie est déjà fournie avec le CMS et fonctionne avec tous les systèmes d'exploitation. Cependant, la qualité des images extraites est moins bonne qu'en utilisant un programme externe.

Pour l'utiliser, il suffit de ne rien renseigner dans le fichier "WEB-INF/param/runtime.xml" pour le point d'extension "org.ametys.plugins.flipbook.Document2ImagesConvertor" (ou d'utiliser l'extension org.ametys.plugins.flipbook.convertor.Pdfbox).

Utilisation d'un programme externe en ligne de commandes (pdftoppm)

La solution peut fonctionner avec n'importe quel programme en ligne de commandes qui extrait les pages d'un fichier PDF sous forme d'images PNG numérotées. Cette section détaille l'utilisation du programme pdftoppm.

Cette solution présente l'avantage de la qualité : les images extraites sont parfaitement conformes au document PDF d'origine. Cependant, il est nécessaire d'installer un programme externe, et il n'est pas possible de l'utiliser dans un environnement Windows.

Pour utiliser cette solution, il faut renseigner la ligne suivante dans le fichier "WEB-INF/param/runtime.xml de votre application

<org.ametys.plugins.flipbook.Document2ImagesConvertor>org.ametys.plugins.flipbook.convertor.CommandLine</org.ametys.plugins.flipbook.Document2ImagesConvertor>

Cette solution est à privilégier si l'environnement le permet.

Installation du programme

Il faut ensuite installer le programme mettant la commande pdftoppm à disposition. Le plus utilisé est Poppler.

Pour installer ce programme sous Debian/Ubuntu :

$ sudo apt-get install poppler-utils

Configuration

L'utilisation d'un programme externe en ligne de commandes nécessite un paramètre de configuration correspondant à la commande de conversion: voir le Manuel d'administration.

 

 

 

 

Retour en haut

Flipbook