Asistencia al usuario para autores de contenido

Plug-in de parámetro de representación

Utilice el plug-in de representación de RenderParam para acceder a los parámetros de representación públicos y privados desde el contenido web.

La sintaxis para este plug-in es la siguiente:

[Plugin:RenderParam key="" type="" defaultValue="" separator="" escape=""]

Este plug-in utiliza los atributos siguientes:

key

Utilice este atributo para especificar el nombre del parámetro de representación al que desea acceder.

type

Utilice este atributo para especificar el tipo de parámetro que desea leer. Para el tipo, especifique uno de los valores siguientes:

any: Especifique este valor de tipo para recuperar los valores de parámetros de tipo private o public. Este valor no incorpora parámetros de tipo query.
private: Especifique este valor de tipo para recuperar los valores de un parámetro de representación privada.
public: Especifique este valor de tipo para recuperar los valores de un parámetro de representación pública.
query: Especifique este valor de tipo para recuperar los valores de un parámetro de consulta que se especificó en un enlace a contenido web. Para obtener más información sobre cómo especificar parámetros de consulta en enlaces a contenido web, lea Escribir enlaces en el contenido web.

defaultValue

Utilice este atributo para especificar el valor que desee que se devuelva si no existe el parámetro de representación al que se hace referencia o si tiene un valor de null.

separator

Utilice este atributo para especificar el separador que desea utilizar para separar los valores de un parámetro de representación que tenga más de un valor.

escape

Utilice este atributo para especificar el escape que desee aplicar para escribir el URL. Especifique uno de los valores siguientes xml, json, javascript o none. El valor predeterminado es none.

Ejemplos

Para recuperar el valor de un parámetro de representación privado con el nombre key1, utilice el siguiente código de plug-in:
```
[Plugin:RenderParam key="key1" type="private"]
```
Para insertar el valor defaultValue en el contenido, si el parámetro de representación con el nombre key1 no existe o si el valor es null, utilice el siguiente código de plug-in:
```
[Plugin:RenderParam key="key1" type="private" defaultValue="defaultValue"]
```
Para recuperar el valor de un parámetro de representación público, utilice el nombre completo (QName) del parámetro en el formato definido por javax.xml.namespace.QName.valueOf(String). Ejemplos:
- Para acceder al parámetro de presentación de contexto público de Web Content Manager, utilice el siguiente código de plug-in:
```
[Plugin:RenderParam key="{http://www.ibm.com/xmlns/prod/datatype/content}context" type="public"]
```
- Para acceder al parámetro de representación de contexto personalizado de Web Content Manager, utilice la siguiente etiqueta de plug-in:
```
[Plugin:RenderParam key="{http://www.ibm.com/xmlns/prod/datatype/content}custom-context" type="public"] 
```
Si conoce el identificador corto del parámetro de representación público del descriptor de despliegue del portlet portlet.xml, también puede utilizar dicho identificador corto. Ejemplos:
- Para acceder al parámetro de presentación de contexto público de Web Content Manager, utilice la siguiente etiqueta de plug-in:
```
[Plugin:RenderParam key="PUBLIC_CONTEXT" type="public"]
```
- Para acceder al parámetro de representación de contexto personalizado de Web Content Manager, utilice la siguiente etiqueta de plug-in:
```
[Plugin:RenderParam key="CUSTOM_CONTEXT" type="public"]
```
Para recuperar el valor de un parámetro de representación con el nombre key1, independientemente de si se trata de un parámetro de representación privado o público, utilice el siguiente código de plug-in:
```
[Plugin:RenderParam key="key1" type="any"] 
```
Para separar varios valores de un parámetro de representación con el nombre key1, por ejemplo, utilizando un punto y coma, utilice el siguiente código de plug-in:
```
[Plugin:RenderParam key="key1" type="any" separator=";"]
```
Para recuperar el valor de un parámetro de consulta que se ha pasado a un URL de resolución de Web Content Manager con el nombre key1, utilice el siguiente código de plug-in:
```
[Plugin:RenderParam key="key1" type="query"]
```