Assistência ao utilizador para autores de conteúdo

Suplemento RenderURL

Utilize o suplemento de apresentação RenderURL para criar URLs que definem ou remover parâmetros de apresentação.

A sintaxe deste suplemento é a seguinte:

[Plugin:RenderURL copyCurrentParams="" escape="" uri="" uriMode="" 
prefix.key="" prefix.value="" prefix.mode="" prefix.type=""]

Este suplemento utiliza os seguintes atributos:

copyCurrentParams: Utilize este atributo para determinar se pretende que o estado actual do portal e os parâmetros codificados no estado sejam copiados para o novo URL. Os valores válidos são true e false. O valor predefinido é false.
escape: Utilize este atributo para definir a mudança de código utilizada para escrever o URL. Especifique um dos seguintes valores: xml, json, javascript ou none. A predefinição é xml.

Para definir, adicionar ou remover parâmetros de apresentação pública ou particular, utilize os seguintes atributos. Utilize o prefix antes dos atributos para correlacionar atributos key, value, type e mode que referenciam o mesmo parâmetro de apresentação. O prefixo não pode conter um carácter de ponto final (. ).

prefix.key

Utilize este atributo para definir o nome do parâmetro. Para o valor, especifique o identificador simples de um parâmetro particular ou público.

Suporte limitado para parâmetros de apresentação pública não declarados: O IBM® Digital Data Connector (DDC) for WebSphere Portal também fornece suporte limitado para parâmetros públicos que não são declarados no descritor de implementação do Visualizador de conteúdo da Web. Pode identificar esses parâmetros através do nome totalmente qualificado no formato {ns}localname. Os parâmetros de apresentação pública não declarados não funcionam quando utilizados com o WSRP. Por predefinição, não são incluídos na chave da cache de fragmentos de portlets, se a colocação em cache de fragmentos de portlets estiver activada.

prefix.value

Utilize este atributo para definir, adicionar ou remover valores de um parâmetro. O prefix tem de corresponder a um dos conjuntos de key apresentados anteriormente. Para definir parâmetros com vários valores, adicione vários atributos prefix.value ao controlo do suplemento de apresentação.

prefix.type

Utilize este atributo para determinar o tipo de parâmetro que pretende que seja definido. Os valores válidos são private e public.

prefix.mode

Utilize este atributo para determinar as acções que pretende realizar com os valores de parâmetros. Os valores válidos para este atributo são os seguintes:

set

Este é o modo predefinido. Utilize este modo para definir o valor para o parâmetro. Ao utilizar este modo, o valor do parâmetro que definiu substitui um valor existente.

adicionar

Utilize este modo para adicionar um valor para o parâmetro. Ao utilizar este modo, o valor do parâmetro que definiu é adicionado aos valores existentes. Se utilizar este modo, mas não existir nenhum valor de parâmetro, é definido um novo parâmetro.

remove

Utilize este modo para eliminar o parâmetro ou os respectivos valores. Utilize este modo apenas para parâmetros de apresentação particular com copyCurrentParams="true" ou para parâmetros de apresentação pública. Pode utilizar este modo de uma de duas formas:

Para remover totalmente o parâmetro, não transmita quaisquer valores.
Para remover apenas valores específicos de um parâmetro de apresentação, transmita apenas os valores que pretende remover.

Para aceder a um suplemento de processador do portal, utilize os seguintes atributos. Se também especificar parâmetros de apresentação pública, esses parâmetros são aplicados após a resolução ter sido concluída.

uri: Utilize este atributo para especificar um URI válido que identifica o recurso que pretende que seja processado.
uriMode: Utilize este atributo para especificar o modo de resolução. Os valores válidos são view e download. O suplemento avalia o atributo uriMode apenas se não forem definidos quaisquer parâmetros de apresentação pública no mesmo controlo do suplemento de apresentação.

Para incluir adicionalmente parâmetros apenas para o processador, utilize um dos seguintes atributos:

prefix.type="uri": Especifique o tipo de parâmetro para identificar o mesmo como parâmetro de processador.
prefix.key: Defina o nome do parâmetro para o processador. O prefixo pode ser qualquer cadeia.
prefix.value: Defina o valor do parâmetro para o processador. Para definir parâmetros com vários valores, adicione os vários atributos value ao controlo do suplemento de apresentação.

Exemplos

Todos estes atributos podem ser combinados. Exemplos:

O seguinte controlo de suplemento cria um URL que executa as duas acções seguintes:

Define um parâmetro de apresentação particular private1.
Adiciona vários valores [pv1, pv2] ao parâmetro de apresentação pública public1.

[Plugin:RenderURL copyCurrentParams="true" 
    pr1.key="private1" pr1.value="v1"                  
    pr1.type="private" pr1.mode="set"
    pr2.key="public1"  pr2.value="pv1" pr2.value="pv2" 
    pr2.type="public"  pr2.mode="add"]

O seguinte controlo de suplemento cria um URL que executa as duas acções seguintes:
- Define um parâmetro de apresentação pública com vários valores utilizando nome qualificado (QName) {http://ibm.com}prp1 do parâmetro.
- Remove o parâmetro de apresentação particular denominado private1.
```
[Plugin1:RenderURL copyCurrentParams="true" 
    pr1.key="private1" pr1.type="private" pr1.mode="remove"
    pr2.key="{http://ibm.com}prp1" pr2.value="pv1" pr2.value="pv2" 
    pr2.type="public"  pr2.mode="set"]
```
O seguinte controlo de suplemento cria um URL que executa as duas acções seguintes:
- Processa o URI para uma página identificada pelo parâmetro do URI.
- Adiciona o valor do parâmetro de apresentação pública utilizando o nome qualificado (QName) {http://ibm.com}prp1 do parâmetro na página processada no passo anterior. Define o valor como pv1.
```
[Plugin:RenderURL copyCurrentParams="true" uri="nm:oid:pageid" 
    pr2.key="{http://ibm.com}prp1" pr2.value="pv1" 
    pr2.type="public" pr2.mode="add"] 
```

Os seguintes exemplos demonstram como pode definir parâmetros de apresentação quando o formulário é submetido, de modo a que estes parâmetros possam ser lidos pelas portlets apresentadas na página de resultado do formulário.

O seguinte exemplo define um parâmetro de apresentação particular, ou seja, um parâmetro que apenas pode ser visualizado pela mesma ocorrência da portlet na página que defini o parâmetro. Para definir o valor do parâmetro, especifique o mesmo do seguinte modo:
```
<form method="get" action="[Plugin:RenderURL copyCurrentParams="true"]">
    
    <input type="text" name="param1">
    <input type="submit" value="Submit">
</form>
```
Para ler o valor do parâmetro, utilize o seguinte controlo na página para a qual o formulário é submetido: [Plugin:RenderParam key="param1"]
O seguinte exemplo define exactamente um parâmetro de apresentação pública, ou seja, um parâmetro que pode ser visualizado por todas as ocorrências da portlet. O exemplo utiliza o parâmetro CUSTOM_CONTEXT que é reservado e declarado no ficheiro portlet.xml pela portlet de apresentação. Para definir o valor do parâmetro, especifique o mesmo do seguinte modo:
```
<form method="get" action="[Plugin:RenderURL copyCurrentParams="true"]">
    
    <input type="text" name="CUSTOM_CONTEXT">
    <input type="submit" value="Submit">
</form>
```
Para ler o valor do parâmetro, utilize o seguinte controlo na página para a qual o formulário é submetido: [Plugin:RenderParam key="CUSTOM_CONTEXT"]