Date de publication: le vendredi 28 novembre 2008 à 22h34
Dernière modification: par Pascal BOYER le samedi 4 septembre 2010 à 03h03
« Article précédent: eZ Newsletter 1.5.3 : installation et configuration - Chapitre 1
» Article suivant: eZ Newsletter 1.5.3 : Appendice A - Chapitre 4

eZ Newsletter v1.5.3 - Guide d'installation  

2 Installing eZ Newsletter / Installer eZ Newsletter 

2.1 Download the packages / Télécharger les packages

First, download the extension package from http://ez.no/download/add_ons/ez_newsletter/ez_newsletter_stable_releases. Extract the archive into a temporary directory. You only need to copy the extensions you want to use into your eZ Publish extension directory. 
Vous devez, dans un premier temps, télécharger le package de l'extension depuis la page web située à l'adresse suivante : http://ez.no/download/add_ons/ez_newsletter/ez_newsletter_stable_releases . Extrayez ensuite le contenu de cette archive dans un répertoire temporaire. Vous devez alors simplement copier les extensions que vous souhaitez utiliser dans le répertoire extension/ de eZ Publish ( Ndt: eZ Newsletter se compose de plusieurs extensions).

2.2 Explanation of the Extensions / Présentation des extensions composant eZ Newsletter 

2.2.1 eZ Newsletter

This extension provides the core functionality of the newsletter. It is used to create newsletters, manage subscriptions, count link clicks, send out the messages and parse the bounces. 
Cette extension, qui fournit les fonctionnalités de base du système newsletter, est également utilisée pour créer les newsletters, gérer les souscriptions, compter les clics sur les liens, envoyer les messages et analyser les rebonds.

2.2.2 eZ Newsletter builder

This extension is only needed when you want to use the custom editorial interface that is installed when you use the Setup Wizard to install eZ Newsletter. In this documentation we will concentrate on integrating the eZ Newsletter into the standard eZ Publish Administration Interface instead of adding another siteaccess. 
Cette extension n'est nécessaire que si vous souhaitez bénéficier de l'interface éditoriale personnalisée installée par l'assistant de configuration dont vous vous êtes servi pour l'installation de eZ Newsletter. Dans cette documentation nous nous concentrerons sur l'intégration de eZ Newsletter à l'interface d'administration de eZ Publish plutôt qu'à l'ajout d'un nouveau siteaccess.

2.2.3 eZ Label

This extension enables users to mark content objects with labels (for example to label all articles that should be included in the next newsletter). 
Cette extension permet aux utilisateurs de marquer les objets de contenu avec des étiquettes (étiquetter, par exemple, tous les articles liés à la prochaine newsletter).

2.2.4 eZ Newsletter designs

This extension contains three different newsletter designs for common newsletter use cases. It includes a layout for a company newsletter, a news site newsletter and a shop newsletter. The templates have been made for use with the content classes newsletter_issue and newsletter_article. To use the templates as-is, you must use these content classes. To use other content classes, you must customize the templates. 
Cette extension contient trois designs différents adaptés aux cas courant d'utilisation d'une newsletter. Elle inclus donc une mise en page correspondant à une newsletter d'entreprise, à une newsletter de site d'information et à une newsletter de boutique en ligne. Les templates ont été conçus pour utiliser les classes de contenu newsletter_issue et newsletter_article. Pour fonctionner avec d'autres classes de contenu vous devrez personnaliser ces templates.

We recommend that you use the designs as a reference for your own newsletter designs.  
Nous vous recommandons d'utiliser ces designs comme référence pour réaliser vos propres designs de newsletter.

Hint: when you create newsletter designs you should fall back to linked images in the HTML and to the HTML4 specification with limited CSS usage. This is recommended because of the limitation of many email clients when it comes to handling XHTML. 
Astuce: lors de la création de designs pour vos newsletter essayez d'insérer les images à partir du code HTML, de respecter les spécifications HTML4 et de faire un usage modéré de CSS. Cette recommandation découle des limites de nombreux clients mail à gérer le XHTML.

The example templates use some overrides based on sections that act as “mini” sites for the newsletters. If you use the templates on another eZ Publish site, you will probably want to disable the overrides and instead use direct links to the site content. 
Les templates d'exemple utilisent des surcharges basées sur les sections, ces dernières agissant, pour les newsletter, comment des «mini» sites. Si vous utilisez ces templates sur une autre installation eZ Publish, vous devrez probablement désactiver les surcharges pour utiliser à la place des liens directs vers le contenu du site.

2.2.5 eZ Mailimport

This extension converts emails from a mailbox into eZ Publish content objects. 
Cette extension convertit les mails en provenance d'une boîte aux lettres en objets de contenu eZ Publish.

2.2.6 eZ Approve 2

This extension provides advanced approval functionalities for eZ Publish (not limited to eZ Newsletter). Its functionality is beyond the scope of this manual. For more information see: http://ez.no/developer/contribs/workflow/ezapprove2 
Cette extension apporte à eZ Publish des fonctionnalités d'approbation avancées (pas seulement limitées à eZ Newsletter). Ces fonctionnalités dépassant le cadre de ce document, vous pouvez vous reporter au lien http://ez.no/developer/contribs/workflow/ezapprove2  pour de plus amples informations.

2.2.7 eZ Newsletter classes, Newsletter structure and Newsletter demo content

The only component in this extension that might be required is the content classes newsletter_issue and newsletter_article. However, because you have already made a custom installation, we assume you are going to create custom classes as well. Otherwise you can install the class package with the package import in the Administration Interface. 
Les seuls composants requis de cette extension sont les classes de contenu newsletter_issue et newsletter_article. Cependant, puisque vous avez déjà votre propre installation, nous supposons que vous créerez vos propres classes. Dans le cas contraire installez le package de classes à l'aide du système d'importation de l'Interface d'Administration.

2.3 Setting up the eZ Newsletter extension / Paramétrer l'extension eZ Newsletter 

2.3.1 Copy the extension / Copier l'extension

After unpacking the extensions (as described above), copy the extension eznewsletter to your eZ Publish extension directory (.../ezpublish/extension/eznewsletter/). 
Les extensions extraites (comme indiqué plus haut), copiez l'extension eznewsletter dans votre répertoire extension/ (.../ ezpublish/extension/eznewsletter/).

2.3.2 Import the sql schema / Importer le schéma sql

Because eZ Newsletter uses some custom tables, you must import the database schema (eznewsletter/sql/mysql/eznewsletter.sql) into your MySQL Database. For example: 
Parce que eZ Newsletter utilise certaines tables qui lui sont propres, vous devez importer le schéma de la base de données ( eznewsletter/sql/mysql/eznewsletter.sql) dans votre base de données MySQL. Par exemple:

mysql -u user -p ezdb < eznewsletter/sql/mysql/eznewsletter.sql

2.3.3. Add the newsletter tab to the Administration Interface navigation bar / Ajouter un onglet newsletter à la barre de navigation de l'interface d'administration

To activate the newsletter tab in the Administration Interface siteaccess you must add the following setting to the menu.ini configuration file of your administrative siteaccess (located by default at settings/siteaccess/ezwebin_site_admin/menu.ini.append.php) : 
Pour activer l'onglet newsletter dans l'interface d'administration, ajoutez le paramètre suivant au fichier de configuration menu.ini de votre siteaccess d'administration (placé par défaut dans settings/siteaccess/ezwebin_site_admin/ menu.ini.append.php) :

[TopAdminMenu]
Tabs[]=eznewsletter

The newsletter tab should be immediately visible in the Administration Interface. 
L'onglet newsletter devrait être immédiatement visible dans l'interface d'administration.

2.3.4 Create the overrides for classes / Créer les sucharges des classes

For each content class that should be used as newsletter content you must create an override for the edit view. For example, when you create a content class named mynewsletter you have to add the following override to the administrative siteaccess: 
Pour chaque classe de contenu utilisée pour créer du contenu de la newsletter doit exister une surcharge de la vue d'édition. Lorsque vous créez, par exemple, une classe de contenu nommée mynewsletter vous devez ajouter la surcharge suivante au siteaccess d'administration:

[edit_mynewsletter]
Source=content/edit.tpl
MatchFile=edit_article.tpl
Subdir=templates
Match[class_identifier]=mynewsletter

To prevent users from accidentally choosing the wrong class when they create a new newsletter type, eZ Newsletter the class identifiers must also be in the eznewsletter.ini configuration file (usually located in  /settings/override/eznewsletter.ini.append.php): 
Pour éviter que des utilisateurs choisissent accidentellement la mauvaise classe lorsqu'ils créent un nouveau type de newsletter, les identifiants des classes eZ Newsletter doivent également être présents dans le fichier de configuration eznewsletter.ini (normalement situé dans /settings/override/ eznewsletter.ini.append.php)

[NewsletterTypeSettings]
ClassLimitation[]=mynewsletter

2.3.5 Configure the default host / Configurer l'hôte par défaut

In the eznewsletter.ini, you can also add the URL of your public siteaccess. If you don't do this, you will need to build the URLs referring to the website in your templates. 
Dans le fichier eznewsletter.ini vous pouvez également indiquer l'URI de votre siteaccess public. Dans le cas contraire, vous devrez créer, dans vos templates, les URI renvoyant au site web.

[HostSettings]
defaulthost=http://www.example.com

This is needed because the cronjobs run in the context of the administration siteaccess, which makes it possible to have a preview of the newsletter in the Administration Interface. You can then access this by using the operator eZDefaultHostname(). 
Ceci est rendu nécessaire en raison de la tâche cron s'exécutant dans le contexte du siteacces d'administration permettant ainsi d'avoir une pré-visualisation de la newsletter dans l'interface d'administration. Vous pouvez alors accéder à cela grâce à l'opérateur eZDefaultHostname().

2.3.6 Create a template extension and your custom newsletter designs / Créer un template et ses propres designs de newsletter

If you imported the classes newsletter_issue and newsletter_article from the package eznewsletter_classes.ezpkg you can simply activate the extension eznewsletter_designs. Otherwise you must make a design extension that contains your custom newsletter layouts (called “newsletter designs”). 
Si vous avez importé les classes newsletter_issue et newsletter_article  à partir du package eznewsletter_classes.ezpkg vous pouvez alors simplement activez l'extension eznewsletter_designs. Dans le cas contraire vous devez créer une extension de design contenant vos propres mises en page de la newsletter (nommée « newsletter designs»).

To do this, create a design extension as normal. Add an INI-file newsletterdesigns.ini.append.php to your extension with these settings: 
Vous devez pour cela créer une extension de design puis y ajouter un fichier de configuration newsletterdesigns.ini.append.php contenant les paramètres suivants:

[Designs]
Design[]
Design[]=acme
 
 [acme]
Description=The acme design
PreviewImage=acme_thumbnail.jpg

In the Design configuration block, define the identifier of the available newsletter designs. For each newsletter design you must create a section (named after the identifier) that will hold a descriptive name for the layout and the name of a preview image. Place the preview image in the image directory of your extension. 
Définissez, dans la section de configuration [Designs], l'identifiant des designs disponibles de la newsletter. Pour chacun d'eux vous devez créer une section (nommée d'après l'identifiant) contenant un nom descriptif de la mise en page ainsi que le nom de l'image de prévisualisation que vous placerez dans le répertoire de votre extension.

Now you can create the template. To do so you have to create a directory with the same name as the identifier you chose in the template folder (in this example mynewsletter/design/mynewsletter/templates/acme/sendout). Create a subdirectory called sendout that will contain the templates used during sendout. 
Vous pouvez à présent créer le template. Pour cela, créez un répertoire de même nom que l'indentifiant que vous avez retenu dans le dossier de templates (dans cet exemple mynewsletter/design/mynewsletter/templates/acme/sendout). Créez un sous-répertoire sendout qui contiendra les templates utilisés lors de l'envoi des newsletters.

To support sending out newsletters in different formats, the templates must be named text.tpl (for plaintext), html.tpl (make embedding possible), linked.tpl (often the same as html.tpl but without embedded images and attachments). (We strongly suggest you use links rather than embedded objects because of bandwith usage and processing time.) 
Pour d'expédier les newsletters dans différents formats, les templates doivent se nommer text.tpl (pour le format plaintext), html.tpl (permet d'intégrer des éléments directement à partir du code HTML), linked.tpl  (souvent identique à html.tpl mais sans intégration d'image et sans attachement). Nous vous suggérons fortement d'opter pour les liens plutôt que pour les objets attachés afin de préserver la bande passante et diminuer le temps d'exécution.

2.3.7 Create a subscription list and a newsletter type / Créer une liste d'abonnement et une newsletter

Log in to the Administration Interface and click on the newsletter tab in the top menu. 
Connectez-vous à l'interface d'administration puis cliquez sur l'onglet newsletter.

Before you create a newsletter type, you must create a subscription list, because the newsletter types need to have at least one list assigned to them before you can store them. 
Avant de créer une newsletter, créez une liste de souscription, les newsletters devant être liées à au moins une liste d'abonnement avant que vous puissiez les enregistrer.

After creating the list you can make your first newsletter type, associate it with the subscription list and select your custom design. The user handbook at http://ez.no/doc/extensions/newsletter contains more information on the user interface. 
Une fois la liste créée, créez votre première newsletter, associez-la à la liste de souscription puis sélectionnez un design. Le manuel des utilisateurs disponible à l'adresse http://ez.no/doc/extensions/newsletter  contient plus d'informations sur l'interface utilisateur.

2.4 Configure the roles and policies / Configurer les rôles et les permissions

To enable site visitors to subscribe to newsletters and manage their newsletter subscriptions, and to count the clicks on the links in the newsletter they receive, you must set up two policies. 
Pour autoriser les visiteurs du site à s'abonner aux newsletters, à gérer leurs souscriptions, à compter les clics sur les liens contenus par les newsletters qu'ils ont reçues, vous devez paramétrer deux permissions.

The first policy is newsletter.subscribe, which allows the user to subscribe to lists and manage their profile. 
La première, newsletter.subscribe, autorise l'utilisateur à s'abonner aux listes et à en gérer le profile.

Second, you must give the anonymous role the policy newsletter.read. This module can be used for the links in the newsletters. Every time a user accesses an object via this module, he will be redirected to the content and in the background the click will be counted. 
La seconde, newsletter.read, doit être affectée au rôle « anonymous». Ce module peut être utilisé pour les liens dans les newsletters. Chaque fois qu'un utilisateur accède à un objet via ce module, il est alors redirigé vers le contenu et le clic comptabilisé en arrière-plan.

2.5 Setting up the cronjob / Configurer les tâches cron

In the final step, set up a cronjob that processes the sendout. It is very important that you run the cronjob in the context of the admin siteaccess. Otherwise you can’t be sure that the same template overrides are active, etc. Unless you have a special setup you will simply define the siteaccess with the '-s' parameter for the cronjob scripts. For example, if your admin siteaccess is ezwebin_site_admin you would execute the cronjob like this: 
Vous devez en dernier lieu configurer une tâche cron gérant les envois. Il est très important que cette tâche cron s'exécute dans le contexte du siteaccess d'administration afin de s'assurer que les mêmes surcharges de template sont actives, etc... A moins que vous ayez une configuration spéciale, vous devrez simplement, à l'aide du paramètre « -s », indiquer le siteaccess au script cron. Si votre siteaccess d'administration est, par exemple, ezwebin_site_admin, vous devrez alors exécuter le script cron ainsi:

php ./runcronjobs.php -s ezwebin_site_admin send_newsletter

You should execute the cronjob at an interval based on sendout amount, traffic and server performance. Usually an interval of 30 minutes or 1 hour is sufficient. 
La fréquence d'exécution de cette tâche cron doit tenir compte de la quantité d'envoi, du trafic et des performances du serveur. Un intervalle de 30 à 60 minutes entre deux exécutions est généralement suffisant.

3. Further customization / Autres personnalisations

You now should have a working newsletter system. To customize it further, refer to the comments in the extension INI files. If you have a large number of newsletter subscribers, consider using the cluster_send cronjob, which distributes the messages to multiple mailservers by SMTP. 
Votre système de newsletter doit être à présent fonctionnel. Si vous souhaitez le personnliser, référez-vous aux commentaires des fichiers de configuration INI. Par ailleurs, si vous possédez un grand nombre d'abonnés, vous pouvez envisager l'utilisation de la tâche cron cluster_send qui distribue les messages, via SMTP, à plusieurs serveurs mail.

Commentaires