Sovrascrivere i portlets in Plone 3.0

Scopo

Era piuttosto facile personalizzare uno dei portlet standard con le versioni precedenti di Plone 3.0: bastava copiare un modello di pagina appropriato al tema del portlet e fare quello che si voleva, cambiandolo con linguaggio XHTML. Si potrebbe anche creare un nuovo portlet allo stesso modo - basta creare un template per il nuovo portlet e registrare questo portlet con il tuo sito di proprietà.

In Plone 3.0 i portlets sono diventati leggermente più complessi,ma molto più potenti al tempo stesso! Il vantaggio è evidente adesso, giusto? ;)  Sono serviti da un pacchetto separato di python e hanno davvero una grande flessibilità di gestione. Quindi, vale la pena di provare questo nuovo meccanismo per rendersi conto di quanto è potente.

Prerequisiti

La prima cosa da menzionare è che non si tratta di una personalizzazione TTW (Through The Web). Se hai bisogno di un trucco veloce e sporco, dai un'occhiata allo strumento portal_view_customizations. Questo aiuto presuppone che desideri avere le modifiche in un modo ripetibile, in modo che tu possa avere le stesse modifiche su qualsiasi sito in cui hai installato il prodotto.

Un'altra cosa che potresti considerare è che non hai bisogno di questa tecnica nei casi in cui desideri personalizzare un portlet in Plone 3.0. Se hai appena personalizzato i portlets utilizzati nelle precedenti versioni di Plone o se vuoi continuare a utilizzare i portlets nel modo dell' "era 3.0"  (che noi sconsigliamo vivamente) dovresti dare un'occhiata a ClassicPortlet che viene dato con Plone 3.0.

E per ultimo, prima di continuare, se desideri personalizzare qualsiasi portlets standard rimuovendo tutta la logica di back-end  (realizzando un portlet statico), non farlo! E' meglio installare plone.portlet.static e giocare con esso, creando portlets statici quando ne hai bisogno.

Presumiamo che hai creato il tema MyTheme Plone 3 con DIYPloneStyle o ZopeSkel. Non stiamo qui a spiegare tutti gli aspetti della creazione di un tema di Plone 3.0.

Il concetto chiave nel lavoro con i portlet in Plone 3.0 è l'utilizzo di Zope 3 skin layer - lo stesso che usiamo quando sovrascriviamo una viewlet. Presumiamo che hai almeno il seguente numero minimo di file nella cartella MyTheme / browser:

- browser/
    - __init__.py
    - configure.zcml
    - interfaces.py

Il processo di sovrasrittura dei portlets è il seguente:

• Scegli il portlet che vuoi sovrascrivere;
• Registra una skin layer se ancora non ne hai una in interfaces.py;
• Aggiungi il comando speciale <plone:portletRenderer /> per MyTheme / browser / configure.zcml;
• Definisci un attributo del Portlet per il comando <plone:portletRenderer />. Si tratta di un portlet fornitore di dati per i quali viene usata questo tipo di sovrascrittura. Questo può essere di classe o di interfaccia. Ad esempio plone.app.portlets.portlets.navigation.INewsPortlet;
• Definisci un nuovo template di attributo per il comando <plone:portletRenderer />. Quando lo aggiungi verrà utilizzata l'impostazione predefinita del renderer per il portlet che stai sovrascrivendo, ma con il tuo template;
• In caso di necessità di personalizzare il comportamento di default per il portlet, devi utilizzare l'attributo di classe, invece del semplice modello. Questa nuova classe agirà in qualità di renderer per il portlet, al posto di quella di default;
• Definisci gli attributi layer per il comando <plone:portletRenderer /> con MyTheme browser layer. L'attributo layer del portletRenderer associa un particolare IPortletRenderer con un particolare browser layer (nel nostro caso MyTheme layer). Quando il nostro layer è in vigore (cioè MyTheme è installato) il nuovo renderer sarà usato al posto di quello predefinito;
• Aggiungi un nuovo modello di MyTheme / browser che implementa il renderer;
• Riavvia Zope e divertiti.
  

Step by step

1. Scegliere il portlet

Prima di tutto dobbiamo decidere quale portlet vorremmo personalizzare. Poi scegliere il Portlet News. Se dai un'occhiata al portlet news standard, vedrai news_icon images in-front of the titles. Sbarazzati di loro in XHTML solo per prova.

<plone:portlet
    name="portlets.News"
    interface=".news.INewsPortlet"
    assignment=".news.Assignment"
    renderer=".news.Renderer"
    addview=".news.AddForm"
    editview=".news.EditForm"
    />

from plone.theme.interfaces import IDefaultPloneLayer

class IThemeSpecific(IDefaultPloneLayer):
    """Marker interface that defines a Zope 3 skin layer bound to a Skin
       Selection in portal_skins.
    """

<include package="plone.app.portlets" />

<interface
   interface=".interfaces.IThemeSpecific"
   type="zope.publisher.interfaces.browser.IBrowserSkinType"
   name="My Theme"
   />

<plone:portletRenderer
   portlet="plone.app.portlets.portlets.news.INewsPortlet"
   template="mytheme_news.pt"
   layer=".interfaces.IThemeSpecific"
   />

<img tal:replace="structure item_icon/html_tag" />

<!-- <img tal:replace="structure item_icon/html_tag" /> -->

Credits