Création d'une balise de composant

La balise "Component" permet de faire référence au contenu d'un composant dans un modèle de présentation ou une conception d'élément.

Pourquoi et quand exécuter cette tâche

Format d'une balise de composant :

[Component name=" " context=" " format=" " separator=" " compute=" " 
htmlencode=" " awareness=" " presentation=" " startPage=" " resultsPerPage=" " start=" " end=" " ]

Pour créer une balise de composant, procédez comme suit :

Procédure

  1. Cliquez sur Insérer une balise dans un modèle de présentation ou une zone de conception d'élément. La boîte de dialogue Aide sur les balises s'ouvre.
  2. Sélectionnez Composant comme type de balise.
  3. Sélectionnez un composant à afficher à l'aide de la balise. Ce paramètre est ajouté à la balise en tant que paramètre name=" " :
  4. Cliquez sur OK pour ajouter la balise à votre conception de navigateur.

Que faire ensuite

Lorsque vous ajoutez la balise à votre conception, vous pouvez également ajouter les paramètres suivants à la balise :
Tableau 1. Paramètres de balise supplémentairesCe tableau répertorie les autres paramètres qui peuvent être ajoutés manuellement à cette balise.
Paramètres des balises Détails
name=" " Pour utiliser la bibliothèque spécifiée dans l'URL de la page en cours, indiquez name="./item".
Remarque : Si vous spécifiez name="./item", le nom de la bibliothèque n'apparaît pas dans le modèle de présentation ou la conception d'élément. Le chemin d'accès réel n'est pas résolu tant que l'objet n'est pas rendu.
context=" " Ce paramètre n'est utilisé que lorsque vous référencez une balise de composant au sein d'une conception d'élément de personnalisation pour afficher les résultats d'une règle de personnalisation qui recherche des composants.
start=" "

end=" "

Les attributs start et end sont utilisés pour encapsuler les données renvoyées par d'autres balises, telles que les balises HTML. Ces attributs ne sont pas obligatoires.
format=" " Ce paramètre est facultatif et ne peut être utilisé qu'avec certains types de composant :
Lorsque vous référencez un composant d'image :
Utilisez format="url" pour effectuer le rendu de l'URL d'un composant d'image uniquement.
Utilisez format="tag" pour effectuer le rendu d'une balise d'image complète. L'image est affichée sur la page rendue. Ce paramètre est utilisé par défaut si aucun format n'est spécifié.
Lorsque vous référencez un composant de ressource de fichier :
Si la ressource de fichier est un fichier convertible en HTML, vous pouvez convertir ce fichier en HTML puis effectuer un rendu de ce dernier directement dans votre contenu Web à l'aide du paramètre parameter.
Voici quelques exemples des types de fichier pris en charge :
  • documents de traitement de texte (*.doc, *.odt)
  • Feuilles de calcul (.xls)
  • Fichiers HTML (*.htm, *.html)
  • Fichiers texte (.txt)
D'autres types de fichier peuvent également être adaptés mais il est nécessaire de les tester au préalable.
Maximum Cache Size :

Si l'élément HTML converti est supérieur à la taille de cache par défaut définie par la propriété resourceserver.maxCacheObjectSize dans le service WCM WCMConfigService, chaque demande qui contient ce fichier est convertie dynamiquement au lieu d'utiliser la copie mise en cache. Cette méthode a un impact sur les performances. Il peut être nécessaire d'augmenter la taille de la propriété resourceserver.maxCacheObjectSize pour permettre la prise en charge de la conversion des fichiers de grande taille. Vous devez vérifier que le système dispose d'une mémoire suffisante pour permettre cette augmentation de la taille du cache. Vous pouvez également être amené à diviser le fichier en plusieurs fichiers séparés que vous pouvez convertir séparément au lieu d'augmenter la taille du cache.

Lorsque vous référencez les composants de ressource de fichier et d'image :
  • Utilisez format="mimetype" pour effectuer le rendu du type MIME d'un fichier ou d'une image. Si aucun type MIME valide ne peut être déterminé, "www/unknown" est rendu.
  • Utilisez format="filename" pour effectuer le rendu du nom d'un fichier ou d'une image.
  • Utilisez format="size" pour effectuer le rendu de la taille d'un fichier ou d'une image à l'aide de l'unité la plus appropriée. Si la ressource est inférieure à 1 kilooctet, la taille est rendue en octets. Si la taille de la ressource est inférieure à 1 mégaoctet, la taille est rendue en kilooctets. En revanche, si la taille est supérieure ou égale à 1 mégaoctet, elle est rendue en mégaoctets.
  • Utilisez format="size_bytes" pour effectuer le rendu de la taille d'un fichier ou d'une image en octets. Seule la valeur numérique est affichée.
  • Utilisez format="size_KB" pour effectuer le rendu de la taille d'un fichier ou d'une image en kilooctets. Seule la valeur numérique est affichée.
  • Utilisez format="size_MB" pour effectuer le rendu de la taille d'un fichier ou d'une image en mégaoctets. Seule la valeur numérique est affichée.
Lorsque vous référencez un composant de lien :
Utilisez format="url" pour effectuer le rendu de l'URL complète de la cible du composant de lien. Par exemple:
wps/wcm/myconnect/Library/Site+Area/Content
Utilisez format="namepath" pour effectuer le rendu du chemin de site de la cible du composant de lien uniquement. Par exemple:
/Library/Site Area/Content

Si la cible est un autre composant de lien, le nom de chemin de la cible finale est rendu.

Utilisez format="titlepath" pour effectuer le rendu du chemin de titre de site de la cible du composant de lien. Par exemple:
/Library/Site Area Title/Content Title

Si la cible est un autre composant de lien, le chemin de titre de la cible finale est rendu.

Utilisez format="id" pour effectuer le rendu de l'ID de la cible du composant de lien uniquement. Si la cible est un autre composant de lien, l'ID de la cible finale est rendu.

Utilisez format="tag" pour effectuer le rendu d'une balise de lien complète. Ce paramètre est utilisé par défaut si aucun format n'est spécifié. Par exemple:
<a href="/wps/wcm/myconnect/Library/Site+Area/Content></a>
Remarque : L'URL créée par le composant de liaison a un nom qualifié complet lors de son affichage via un portail. Si vous souhaitez créer une URL dont le nom n'est pas complet, utilisez l'option "noprefix" :
  • format="noprefixurl"
  • format="noprefixpath"
  • format="noprefixtag"
Utilisez format="linktext" pour effectuer le rendu du texte du lien.
Lorsque vous référencez un composant de référence de composant :
Utilisez format="id" pour effectuer le rendu de l'ID de la cible du composant de référence de composant. Si la cible est un autre composant de référence de composant, l'ID de la cible finale est rendu.
Utilisez format="namepath" pour effectuer le rendu du chemin de nom de site de la cible du composant de référence de composant. Si la cible est un autre composant de référence de composant, le nom de chemin de la cible finale est rendu.
Utilisez format="titlepath" pour effectuer le rendu du chemin de titre de site de la cible du composant de référence de composant. Si la cible est un autre composant de référence de composant, le chemin de titre de la cible finale est rendu.
Lorsque vous référencez des composants de date :
Les formats suivants peuvent être définis lorsque des dates sont affichées :
  • format="DATE_SHORT"
  • format="DATE_MEDIUM"
  • format="DATE_LONG"
  • format="DATE_FULL"
  • format="DATE_TIME_SHORT"
  • format="DATE_TIME_MEDIUM"
  • format="DATE_TIME_LONG"
  • format="DATE_TIME_FULL"
  • format="TIME_SHORT"
  • format="TIME_MEDIUM"
  • format="TIME_LONG"
  • format="TIME_FULL"
  • format="DATE_SHORT_TIME_MEDIUM"
  • format="DATE_SHORT_TIME_LONG"
  • format="DATE_SHORT_TIME_FULL"
  • format="DATE_MEDIUM_TIME_SHORT"
  • format="DATE_MEDIUM_TIME_LONG"
  • format="DATE_MEDIUM_TIME_FULL"
  • format="DATE_LONG_TIME_SHORT"
  • format="DATE_LONG_TIME_MEDIUM"
  • format="DATE_LONG_TIME_FULL"
  • format="DATE_FULL_TIME_SHORT"
  • format="DATE_FULL_TIME_MEDIUM"
  • format="DATE_FULL_TIME_LONG"
  • format="RELATIVE" (La date relative s'affiche comme "today", "yesterday" ou le nombre de jours passés.)
  • format="MILLIS" (nombre de millisecondes depuis minuit, le 1er janvier, 1970 GMT)
Remarque : Tous les formats de date sont basés sur le fuseau horaire de l'utilisateur, à l'exception de format="MILLIS", qui ne dépend pas du fuseau horaire en cours.
Vous pouvez également configurer des formats définis par l'utilisateur pour les dates :
Lorsque vous référencez des composants de nombre :
Vous pouvez également configurer des formats définis par l'utilisateur pour les nombres :
Lorsque vous référencez des caractéristiques de l'utilisateur :
Lors du formatage des caractéristiques de l'utilisateur, le paramètre format est utilisé pour définir le paramètre LDAP à utiliser lors de l'affichage des caractéristiques de l'utilisateur. Par exemple:
  • format="cn" est utilisé pour afficher le nom usuel.
  • format="dn" est utilisé pour afficher le nom distinctif.
Longueur de caractère maximale :
Vous pouvez indiquer un nombre maximal de caractères à afficher en utilisant ce format :
  • format="length:number_of_characters"
Par exemple, pour afficher un maximum de 10 caractères, spécifiez le paramètre suivant :
  • format="length:10"
compute=" " Ce paramètre ne s'applique qu'aux composants de menu, de navigateur et de taxinomie. Spécifiez compute="always" lorsque vous référencez du code JSP dans une conception de composant et que vous souhaitez que ce code soit exécuté séparément sur chaque résultat renvoyé par un composant de menu, de navigateur et de taxinomie.

Par exemple, si un menu a référencé du code JSP qui utilise la méthode public DocumentId getCurrentResultId();, utilisez compute="always" pour exécuter le code JSP séparément dans chaque résultat renvoyé par le menu.

Si le paramètre n'est pas spécifié, compute="once" est utilisé. Il s'agit de la méthode par défaut permettant d'afficher les résultats de composants de menu, de navigateur et de taxinomie.

htmlencode=" " Si htmlencode="true", les caractères HTML réservés dans les composants qui affichent du texte sont convertis en entités de caractère. Par exemple, '<' est converti en '&lt;'. Ce paramètre est utile si vous souhaitez empêcher les utilisateurs d'ajouter un code malveillant ou de modifier la présentation de leur texte à l'aide de balises HTML.

Si ce paramètre n'est pas spécifié, le paramètre par défaut indiqué par la propriété cmpnt.htmlEncodeDefault dans le service WCM WCMConfigService est utilisé pour afficher du texte. Le paramètre par défaut spécifié par la propriété cmpnt.htmlEncodeUrls dans le service WCM WCMConfigService est utilisé pour l'affichage des URL. Par défaut, ces propriétés ont la valeur true.

awareness=" " Si awareness="true", les noms d'utilisateur sont affichés à l'aide de la fonction de découverte de personnes. Cette fonction affiche les noms des utilisateurs sous forme d'hyperliens, ce qui permet aux utilisateurs de contacter les personnes avec lesquelles elles veulent travailler. Partout où des liens de personnes sont présents, les utilisateurs peuvent cliquer dessus pour accéder à un menu d'actions permettant de collaborer, c.a.d de contacter et de travailler avec la personne désignée par le lien. Si, en tant qu'administrateur, vous configurez également un serveur HCL Sametime pour qu'il fonctionne avec HCL, les liens vers les personnes indiquent si le statut de la personne est Actif, Sorti, Déconnecté ou Ne pas déranger.

Si ce paramètre n'est pas spécifié, awareness="false" et la fonction de découverte de personnes ne sont pas utilisés.

presentation="itemname" Ce paramètre permet de spécifier le nom d'une présentation de liste à utiliser lors de l'affichage d'un composant de navigateur, de menu, de personnalisation ou de recherche. Ce paramètre écrase la présentation de liste qui est sélectionnée sur le composant proprement dit.
Pour utiliser la bibliothèque spécifiée dans l'URL de la page en cours, indiquez presentation="./item".
Remarque : Si vous indiquez presentation="./item", le nom de bibliothèque ne s'affiche pas dans la balise. Le chemin d'accès réel n'est pas résolu tant que l'objet n'est pas rendu.
startPage="number" Ce paramètre est facultatif et permet de définir quelle page de résultats afficher lorsqu'un composant de navigateur, de menu, de personnalisation ou de recherche est affiché en premier. Ce paramètre écrase la valeur Page de démarrage qui est spécifiée dans le composant proprement dit.
resultsPerPage="number" Ce paramètre est facultatif et permet de définir le nombre d'éléments à afficher sur chaque page de résultats qui est affichée par un composant de navigateur, de menu, de personnalisation ou de recherche. Ce paramètre écrase la valeur Résultats par page qui est spécifiée dans le composant proprement dit.
separator=" " Ce paramètre est utilisé uniquement lorsqu'une composant de sélection utilisateur est référencé. Il permet de définir le texte ou le code devant être rendu entre chaque sélection. Par exemple, pour ajouter un retour à la ligne entre chaque sélection, utilisez separator="<br>". Si aucun séparateur n'est défini, une virgule est placée entre les sélections.