Assistência ao utilizador para autores de conteúdo

Suplemento RenderParam

Utilize o suplemento de apresentação RenderParam para aceder a parâmetros de apresentação públicos e particulares a partir do conteúdo da Web.

A sintaxe deste suplemento é a seguinte:
[Plugin:RenderParam key="" type="" defaultValue="" separator="" escape=""]
Este suplemento utiliza os seguintes atributos:
key
Utilize este atributo para especificar o nome do parâmetro de apresentação ao qual pretende aceder.
type
Utilize este atributo para especificar o tipo do parâmetro que pretende que seja lido. Para o tipo, especifique um dos seguintes valores:
any
Especifique este valor de tipo para obter os valores de um parâmetro do tipo private ou public. Este valor não incorpora parâmetros do tipo query.
private
Especifique este valor de tipo para obter os valores de um parâmetro de apresentação particular.
public
Especifique este valor de tipo para obter os valores de um parâmetro de apresentação público.
query
Especifique este valor de tipo para obter os valores de um parâmetro de consulta especificado numa ligação a conteúdo da Web. Para obter mais informações sobre como especificar parâmetros de consulta em ligações a conteúdo da Web, consulte Escrever ligações para conteúdo da Web.
defaultValue
Utilize este atributo para especificar o valor que pretende que seja devolvido se o parâmetro de apresentação endereçado não existir ou tiver um valor de null.
separator
Utilize este atributo para especificar o separador que pretende utilizar para separar os valores de um parâmetro de apresentação com mais do que um valor.
escape
Utilize este atributo para especificar a mudança de código que pretende que seja utilizada para escrever o URL. Especifique um dos seguintes valores xml, json, javascript ou none. O valor predefinido é none.

Exemplos

  • Para obter o valor de um parâmetro de apresentação particular denominado key1, utilize o seguinte controlo do suplemento:
    [Plugin:RenderParam key="key1" type="private"]
  • Para inserir o valor defaultValue no conteúdo, se o parâmetro de apresentação denominado key1 não existir ou se o valor for null, utilize o seguinte controlo do suplemento:
    [Plugin:RenderParam key="key1" type="private" defaultValue="defaultValue"]
  • Para obter o valor de um parâmetro de apresentação público, utilize o nome totalmente qualificado (QName) do parâmetro no formato definido por javax.xml.namespace.QName.valueOf(String). Exemplos:
    • Para aceder ao parâmetro de apresentação de contexto público do Web Content Manager, utilize o seguinte controlo do suplemento:
      [Plugin:RenderParam key="{http://www.ibm.com/xmlns/prod/datatype/content}context" type="public"]
    • Para aceder ao parâmetro de apresentação de contexto personalizado do Web Content Manager, utilize o seguinte controlo do suplemento:
      [Plugin:RenderParam key="{http://www.ibm.com/xmlns/prod/datatype/content}custom-context" type="public"] 
  • Se tiver conhecimento do identificador abreviado do parâmetro de apresentação público do descritor de implementação da portlet portlet.xml, também pode utilizar esse identificador abreviado. Exemplos:
    • Para aceder ao parâmetro de apresentação de contexto público do Web Content Manager, utilize o seguinte controlo do suplemento:
      [Plugin:RenderParam key="PUBLIC_CONTEXT" type="public"]
    • Para aceder ao parâmetro de apresentação de contexto personalizado do Web Content Manager, utilize o seguinte controlo do suplemento:
      [Plugin:RenderParam key="CUSTOM_CONTEXT" type="public"]
  • Para obter o valor de um parâmetro de apresentação denominado key1, independentemente do facto de corresponder a um parâmetro de apresentação particular ou público, utilize o seguinte controlo do suplemento:
    [Plugin:RenderParam key="key1" type="any"] 
  • Para separar vários valores de um parâmetro de apresentação denominado key1, por exemplo, utilizando ponto e vírgula, utilize o seguinte controlo do suplemento:
    [Plugin:RenderParam key="key1" type="any" separator=";"]
  • Para obter o valor de um parâmetro de consulta transmitido para um URL de resolução do Web Content Manager denominado key1, utilize o seguinte controlo do suplemento:
    [Plugin:RenderParam key="key1" type="query"]