Module d'Export PDF des pages

Fonctionnalités

Ce module permet de créer un lien permettant d'exporter une ou plusieurs pages d'Automne au format PDF.

Plus précisément, il est possible d'exporter :

• une page selon son identifiant ou bien la page en cours de navigation.
• un ensemble de pages définies par leurs identifiants.
• une arborescence complète de pages.

De plus, vous avez la possibilité de créer une table des matières dans le PDF lorsque vous exportez plusieurs pages.

Installation

Pré requis :

Ce module ne nécessite aucun pré-requis supplémentaires par rapport aux pré-requis de base d'Automne.

Installation et mise en route du module :

Le module se présente sous la forme d'un patch Automne. Son installation est donc simple, il vous suffit d'uploader le fichier disponible en téléchargement sur ce site directement dans l'interface d'administration d'Automne pour déclencher son installation automatique.

Pour cela, allez dans l'interface d'administration d'Automne avec un compte administrateur puis, dans le panneau latéral, allez dans "Administration" > "Paramètres Serveur" > "Mises à jour". Fournissez le fichier du module dans le champ "Fichier de mise à jour" puis cliquez sur valider.

Une fois le module installé, il est nécessaire de créer différentes rangées de contenu qui définiront les liens d'export que vous pourrez ensuite insérer dans vos pages. Voir le paragraphe "fonctionnement" ci-dessous pour plus d'informations.

Mise à jour du module :

Pour mettre à jour le module, il vous suffit, comme pour son installation d'uploader le fichier de la dernière version du module dans l'interface d'administration d'Automne. Cela déclenchera sa mise à jour automatique.

Fonctionnement

Ce module repose exclusivement sur la création de tags spécifiques au module dans les rangées spécifiques. Vous trouverez ci-dessous le détail de ces tags.

Les tags ci-dessous ne fonctionnent pas pour le moment au sein des tags block des modules polymod. Ce support est prévu pour une future version du module

Exporter un PDF d'une ou plusieurs pages :

<atm-pdf-link> ... {{href}} ... </atm-pdf-link> 

• {{href}} : Cette valeur sera remplacée par l'adresse du document PDF produit. Elle est usuellement placée dans l'attribut href d'un lien.

Ce tag supporte les attributs suivants, tous optionnels :

• title : Chaîne de caractères. Permet de spécifier le titre du PDF. Si cet attribut n'existe pas, le titre de la page exportée sera employé.
• subtitle : Chaîne de caractères. Permet de spécifier le sous titre du PDF. Si cet attribut n'existe pas, l'adresse de la page en cours sera employé.
• page : Nombre entier. Permet de spécifier la page à exporter en PDF. Si cet attribut n'existe pas, la page en cours sera exportée. Cet attribut n'est pas pris en compte si l'attribut pages existe.
• subpages : Booléen. Permet d'exporter aussi les sous pages de la page exportée.
• pages : Liste d'identifiants de pages séparés par des virgules. Permet de spécifier les pages à exporter en PDF. Cet attribut n'est pas pris en compte si l'attribut subpages existe.
• exclude : Liste d'identifiants de pages séparés par des virgules. Permet d'exclure une ou plusieurs pages de l'export.
• crosswebsite : Booléen. Permet de traverser la limite des sites web. Cet attribut n'est employé que si l'attribut subpages est employé. Si cet attribut n'existe pas, l'export se limitera aux pages du site en cours.
• maxlevel : Nombre entier. Permet de spécifier le nombre de niveaux maximum de profondeur. Si cet attribut n'existe pas, l'export n'aura pas de limite de profondeur.
• language : Chaîne de caractères. Code de la langue à employer pour les libellés du pied de page. Si cet attribut n'existe pas, la langue de la page en cours sera utilisée.
• toc : Booléen. Ajoute la table des matières aux PDF générés. Si cet attribut n'existe pas, la table des matière sera automatiquement ajoutée aux PDF comportant plusieurs pages exportées.
• cache : Nombre entier. Durée de la mise en cache du PDF généré en secondes. Si cet attribut n'existe pas, une mise en cache d'une heure (3600 secondes) sera employé. Spécifiez 0 pour désactiver la mise en cache. Pour des raisons de performances, une mise en cache de 5 minutes (300 secondes) minimum sera utilisée pour les exports de plusieurs pages.
• keeprequest : Booléen. Conserve les données GET de la page en cours pour générer le PDF. Cela permet de générer un PDF comportant des données dynamiques identiques à celles de la page contenant le tag atm-pdf-link.

Exemples :

PDF de la page courante :

<atm-pdf-link><a href="{{href}}" target="_blank">Télécharger le PDF</a></atm-pdf-link>

PDF de la page 3 et de ses sous pages moins la page 28 :

<atm-pdf-link page="3" subpages="true" excluded="28" title="Titre du PDF"><a href="{{href}}" target="_blank">Télécharger le PDF</a></atm-pdf-link>

PDF des pages 3, 5 et 7 :

<atm-pdf-link pages="3,5,6" title="Titre du PDF"><a href="{{href}}" target="_blank">Télécharger le PDF</a></atm-pdf-link>

Exclure certaines données d'une page de l'export PDF :

<atm-pdf-skip> ... </atm-pdf-skip>

Ce tag permet d'exclure des morceaux de contenu présents dans une page de l'export PDF.

Insérez ce tag dans les rangées employées dans les pages et toutes les données se trouvant dans ce tag ne seront pas exportées dans le PDF.