Lutece : guide intégrateur
Paramétrer les extensions
Partager ses contenus de façon aisée, voter, proposer de commenter, avec modération ou sans modération, les articles de son site en un click, c'est ce que permet le plug-in plugin-extend. Chacune des extensions possède une configuration par défaut qu'il est possible de paramétrer.
Le paramétrage par défaut des extensions
Le paramétrage est accessible depuis le menu Contenu > Gestion des extensions de contenu par le bouton "Modifier la configuration par défaut".
L'écran permet de modifier le paramétrage par défaut de l'ensemble des extensions en utilisant la liste des extensions et en cliquant sur le bouton "Modifier la configuration par défaut" pour passer d'une extension à une autre.
Les réseaux sociaux
Il faut dans cet écran choisir quels seront les réseaux sociaux affichés par défaut. Accéder au paragraphe "Gérer les réseaux sociaux"
Les votes
Les options disponibles sont ici le choix d'une notification, du type de vote, de la restriction sur le vote: période d'activation, unicité, authentification et limite du nombre. Accéder au paragraphe "Gérer les votes"
Les commentaires
Les options sont la modération, le nombre de commentaires à afficher, l'emplacement du formulaire de commentaires, l'utilisation d'un éditeur en front-office, les notifications et la gestion des messages.
Votre opinion
Les options disponibles sont ici le choix d'une notification et la gestion du message d'information.
Gérer les réseaux sociaux
Si une liste des réseaux les plus courants est initialisée, vous pouvez en ajouter, en supprimer ou modifier les codes par défaut.
Comment configurer un réseau social ?
L'écran de modification, identique à l'écran de création, permet de définir le nom et le code javascript associé. Les trois zones, header, body et footer correspondent aux bookmarks que l'on retrouvre dans le modèle de page comme page_frameset.html (head,body et footer).
Les réseaux sociaux choisis apparaitront sur le site à l'endroit que vous aurez déterminé lors de l'élaboration de votre charte graphique.
Gérer les types de votes
La liste des types de votes disponibles est initialisée par défaut mais vous pouvez la modifier avec vos propres paramètres.
Comment configurer un type de vote ?
Le contenu du modèle peut être complètement modifié, vous avez une aide dans la partie droite de l'écran qui vous donne la liste de bookmarks freemarker pouvant être utilisés dans votre code de modèle -contenu de la template-.
Gérer les boutons d'actions
La liste des boutons d'action disponibles est initialisée par défaut mais vous pouvez la personnaliser avec vos propres boutons.
Comment configurer un bouton ?
Le contenu peut être entièrement personnalisé avec la possiblité de définir pour quel type de ressource (page, document, digg...) sera défini le bouton en utilisant les bookmarks correspondant à l'identifiant de la ressource -bookmark "@id_resource"- et/ou au type de ressource -bookmark "@type_resource"-.
Les extensions dans les modèles html
Dans le page_frameset.html, le modèle de page principal de Lutece, les bookmarks "extend" sont présents afin d'être prêts à fonctionner sans faire d'autre modification. En fonction de votre charte, vous pouvez modifier l'emplacement des bookmarks notamment dans la partie "content".
<!DOCTYPE html>
<html lang="fr">
<head>
<base href="${base_url}">
<title>${favourite} - ${page_name}</title>
...
<#if isExtendInstalled?? && isExtendInstalled >
<#if page_id??>
@Extender[${page_id},PAGE,opengraph,{header:true}]@
</#if>
@Extender[ExtendParameteredId,document,opengraph,{header:true}]@
@Extender[ExtendParameteredId,DIRECTORY_RECORD,opengraph,{header:true}]@
</#if>
...
</head>
<body id="home">
<!-- header -->
${page_header}
<!-- end header -->
<!-- Page path -->
${page_path}
<#if page_id?? && isExtendInstalled?? && isExtendInstalled >
<!-- extends -->
@Extender[${page_id},PAGE,opengraph,{header:false,footer:false}]@
@Extender[${page_id},PAGE,hit,{show:true}]@
@Extender[${page_id},PAGE,rating,{show:"all"}]@
@Extender[${page_id},PAGE,actionbar]@
</#if>
<!-- content -->
${page_content}
<#if page_id?? && isExtendInstalled?? && isExtendInstalled>
@Extender[${page_id},PAGE,comment]@
@Extender[${page_id},PAGE,feedback]@
</#if>
<!-- footer -->
${page_footer}
<#if page_id?? && isExtendInstalled?? && isExtendInstalled >
@Extender[${page_id},PAGE,opengraph,{footer:true}]@
</#if>
</body>
</html>
Utilisez les extends des contenus dans les modèles html et les xsl
Pour afficher un contenu particulier en front office, il faut ajouter le marker suivant dans une template :
@Extender[<idExtendableResource>,<resourceType>,<extenderType>,<parameters>]@
où :
<idExtendableResource> correspond à l'ID de la ressource (ex : 1) <resourceType> correspond au type de ressource. Exemples (attention, le ype est sensible à la casse) :
| Type de ressource | Description |
|---|---|
| PAGE | Il s'agit des pages classiques d'un portail Lutèce |
| document | Il s'agit des documents du plugin-document |
<extenderType> correspond au type de l'extension. Exemples (attention, le type est sensible à la casse) :
| Type d'extension | Description |
|---|---|
| comment | Pour commenter les ressources |
| hit | Pour le nombre de vues sur la ressource |
| rating | Pour voter les ressources |
| feedback | Pour donner son avis sur les ressources |
<parameters> correspond aux paramètres supplémentaires à ajouter pour les extensions (ex : {show:true})
Quelques exemples :
| Markeur | Description |
|---|---|
| @ Extender[1,document,comment]@ | Affiche les commentaires pour le document ayant l'ID 1. |
| @ Extender[1,document,hit,{show:true}]@]@ | Affiche le nombre de vues sur le document ayant l'ID 1. |
| @ Extender[1,document,hit,{show:false}]@ | N'affiche pas le nombre de vues pour le document ayant l'ID 1, mais incrémente le compteur. |
| @ Extender[1,document,hit,{increment:true}]@ | incrémente le compteur |
| @ Extender[1,document,hit,{increment:false}]@ | n'incrémente pas le compteur |
| @ Extender[1,document,rating,{show:"vote"}]@ | Affiche la note du document ayant l'ID 1@ |
| @ Extender[1,document,rating,{show:"voteAction"}]@ | Affiche les liens pour voter le document ayant l'ID 1 |
| @ Extender[1,document,rating,{show:"all"}]@ | Affiche la note et les liens du document ayant l'ID 1 |
| @ Extender[2,PAGE,feedback]@ | Affiche un formulaire pour donner son avis sur la page ayant l'ID 2 |
Ci dessous un exemple de xsl qui inclut les informations issues des extends comment, hit et vote pour une liste de documents.
<?xml version="1.0"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:param name="site-path" select="site-path" />
<xsl:param name="target" select="target" />
<xsl:param name="page-id" select="page-id" />
<xsl:variable name="portlet-id" select="portlet/portlet-id" />
<xsl:template match="portlet">
<div class="portlet">
<xsl:apply-templates select="document-list-portlet/document" />
</div>
</xsl:template>
<xsl:template match="document">
<xsl:if test="not(string(document-xml-content)='null')">
<a href="{$site-path}?document_id={document-id}&portlet_id={$portlet-id} {$target}">
<xsl:for-each select="descendant::*">
<xsl:value-of select="document-title" />
</xsl:for-each>
</a>
<!-- Inclusion des information des extend: Vote, Commentaires et Hits -->
<xsl:if test="document-rating">
<img src="images/local/skin/plugins/extend/modules/rating/stars_{document-rating}.png" alt="Score" title="Score" />
(<xsl:value-of select="document-number-rating" />)
</xsl:if>
<xsl:if test="document-number-comment">
<xsl:value-of select="document-number-comment" /> commentaires
</xsl:if>
<xsl:if test="document-number-hits">
<xsl:value-of select="document-number-hits" /> vues
</xsl:if>
</xsl:if>
</xsl:template>
</xsl:stylesheet>
Habillage des extend
Il est possible de modifier le rendu graphique des "extends" pour les habiller selon votre charte.
Les fichiers modèles des modules sont placés dans cette arborescence WEB-INF/templates/skin/plugins/extends/modules/ où chaque sous répertoire contiendra les modèles à savoir:
- actionbar : Barre de boutons
- comment : Commentaires
- feedback : Votre opinion
- hit: Nombre de hit
- opengraph : Réseaux sociaux
- rating: Votes.