Plug-in de paramètre de rendu

Utilisez le plug-in de rendu RenderParam pour accéder aux paramètres de rendu publics et privés à partir de votre contenu Web.

La syntaxe de ce plug-in est la suivante :
[Plugin:RenderParam key="" type="" defaultValue="" separator="" escape=""]
Ce plug-in utilise les attributs suivants :
key
Cet attribut permet d'indiquer le nom du paramètre de rendu auquel vous voulez accéder.
type
Cet attribut permet d'indiquer le type du paramètre qui doit être lu. Pour le type, indiquez une des valeurs suivantes :
any
Indiquez cette valeur de type pour extraire les valeurs de paramètre de type private ou public. Cette valeur n'incorpore pas les paramètres de type query.
private
Indiquez cette valeur de type pour extraire les valeurs d'un paramètre de rendu privé.
public
Indiquez cette valeur de type pour extraire les valeurs d'un paramètre de rendu public.
query
Indiquez cette valeur de type po extraire les valeurs d'un paramètre de requête qui a été spécifié dans un lien vers un contenu Web. Pour plus d'informations sur la manière de spécifier des paramètres de requête dans des liens vers un contenu Web, voir Ecriture de liens vers un contenu Web.
defaultValue
Cet attribut permet d'indiquer la valeur qui doit être renvoyée si le paramètre de rendu concerné n'existe pas ou a pour valeur null.
separator
Cet attribut permet d'indiquer le séparateur à utiliser pour séparer les valeurs d'un paramètre de rendu ayant plusieurs valeurs.
escape
Cet attribut permet d'indiquer la séquence d'échappement à utiliser pour écrire l'adresse URL. Indiquez l'une des valeurs suivantes : xml, json, javascript ou none. La valeur par défaut est none.

Exemples

  • Pour extraire la valeur d'un paramètre de rendu privé portant le nom key1, utilisez la balise de plug-in suivante :
    [Plugin:RenderParam key="key1" type="private"]
  • Pour insérer la valeur defaultValue dans votre contenu, si le paramètre de rendu portant le nom key1 n'existe pas ou si la valeur est null, utilisez la balise de plug-in suivante :
    [Plugin:RenderParam key="key1" type="private" defaultValue="defaultValue"]
    
  • Pour extraire la valeur d'un paramètre de rendu public, utilisez le nom complet (QName) du paramètre dans le format défini par javax.xml.namespace.QName.valueOf(String). Exemples :
    • Pour accéder au paramètre de rendu de contexte public de Web Content Manager, utilisez la balise de plug-in suivante :
      [Plugin:RenderParam key="{http://www.ibm.com/xmlns/prod/datatype/content}context" type="public"]
    • Pour accéder au paramètre de rendu de contexte personnalisé de Web Content Manager, utilisez la balise de plug-in suivante :
      [Plugin:RenderParam key="{http://www.ibm.com/xmlns/prod/datatype/content}custom-context" type="public"] 
  • Si vous connaissez l'identificateur abrégé du paramètre de rendu public via le descripteur de déploiement de portlet portlet.xml, vous pouvez également utiliser cet identificateur abrégé. Exemples :
    • Pour accéder au paramètre de rendu de contexte public de Web Content Manager, utilisez la balise de plug-in suivante :
      [Plugin:RenderParam key="PUBLIC_CONTEXT" type="public"]
    • To access the custom context render parameter of Web Content Manager, use the following plug-in tag:
      [Plugin:RenderParam key="CUSTOM_CONTEXT" type="public"]
  • Pour extraire la valeur d'un paramètre de rendu portant le nom key1, utilisez la balise de plug-in suivante, qu'il s'agisse d'un paramètre de rendu privé ou public :
    [Plugin:RenderParam key="key1" type="any"] 
  • Pour séparer plusieurs valeurs d'un paramètre de rendu portant le nom key1, par exemple, à l'aide d'un point-virgule, utilisez la balise de plug-in suivante :
    [Plugin:RenderParam key="key1" type="any" separator=";"]
  • Pour extraire la valeur d'un paramètre de requête transmis à une URL de résolution Web Content Manager et portant le nom key1, utilisez la balise de plug-in suivante :
    [Plugin:RenderParam key="key1" type="query"]