WIKI

Como utilizar o domínio Wiki?

ADSRT.WIKI.FAQ-11395
O domínio WIKI permite gerenciar atributos de texto em um padrão "Wiki". O atributo é composto por um texto longo que aceita várias formatações explicadas abaixo:

Parágrafos

Duas quebras de linha seguidas (formando uma linha em branco) evidenciam uma quebra de parágrafo, provocando um espaçamento entre um parágrafo e outro.

Títulos e sub-títulos

Para incluir um título, basta iniciar e terminar a linha com "=".
Exemplos: 
= Título nível 1 =
== Título nível 2 ==
=== Título nível 3 ===
==== Título nível 4 ====
Renderizado assim:

Título nível 1

Título nível 2

Título nível 3

Título nível 4



Listas de tópicos (não numeradas)

Para caracterizar que uma linha é um tópico, deve-se iniciar com "*" ou "-". Se forem incluídos vários "**", então o wiki assume como sendo sub-níveis de tópicos.
Exemplo: 
* Tópico 1
* Tópico 2
** Tópico 2.1
** Tópico 2.2
*** Tópico 2.2.1
* Tópico 3
ou: 
- Tópico 1
- Tópico 2
-- Tópico 2.1
-- Tópico 2.2
--- Tópico 2.2.1
- Tópico 3

Renderizado assim:

Listas numeradas

Para caracterizar que uma linha é um tópico, deve-se iniciar com "#". Se forem incluídos vários "##", então o wiki assume como sendo sub-níveis de tópicos.
Exemplo: 
# Tópico 1
# Tópico 2
## Tópico 2.1
## Tópico 2.2
### Tópico 2.2.1
# Tópico 3
Renderizado assim:
  1. Tópico 1
  2. Tópico 2
    1. Tópico 2.1
    2. Tópico 2.2
      1. Tópico 2.2.1
  3. Tópico 3

Tamanho fixo (códigos-fonte)

Para criar um bloco de código-fonte, usando tamanho fixo e que respeita identações formadas por um determinado número de espaços, deve-se iniciar a linha com um espaço.

Exemplo: 
public void teste() {
   //...
}

Negrito, itálico, sublinhado,...

Para formatar caractéres dentro do texto, deve-se utilizar as mesmas tags utilizadass no HTML:
< b > ... < /b > para negrito.
< i > ... < /i > para itálico.
< u > ... < /u > para sublinhado.

Links externos

Os links podem ser simplesmente inseridos incluindo o http na frente.
Exemplo: http://www.prd.inf.br

Note que para encerrar um link, é obrigatório existir um espaço (ou o final da linha).


Tabelas

Se deseja formar uma tabela, basta utilizar o caractér "|" (pipe) como separador das colunas. A primeira linha da tabela será considerada o cabeçalho.
O uso de mais de um pipe concomitante, indica que a célula anterior pode usar o espaço destas células (formando um merge das colunas).
Observações:

Exemplo: 
|Título da coluna 1 |Título da coluna 2 |Título da coluna 3 | Título da coluna 4 | Título da coluna 5 | Título da coluna 6
|Um texto           |bla-bla-bla        |hohoho             | alinhado ao centro | Alinhado na direita| bababababa
| (al.dir)|Esta segunda coluna tem um texto muito extenso e precisa fazer merge com a terceira coluna|| centro | direita| c6

Renderiza:
Título da coluna 1 Título da coluna 2 Título da coluna 3 Título da coluna 4 Título da coluna 5 Título da coluna 6
Um texto bla-bla-bla hohoho alinhado ao centro Alinhado na direita bababababa
(al.dir)Esta segunda coluna tem um texto muito extenso e precisa fazer merge com a terceira coluna centro direita c6

Caixas de Atenção, Dica, e outros tipos


Blocos especiais podem ser criados da seguinte forma: 
__Tipo [: titulo] __
texto do bloco...
__

O tipo irá determinar a classe do bloco, que por sua vez irá determinar as características do mesmo. Os seguintes tipos são reconhecidos:
O título é opcional. Quando não informado, o próprio tipo é usado..

Exemplos:

O texto 
__Atenção__
Não devem ser utilizados blocos dentro de outros blocos!
__
é apresentado assim:
Atenção
Não devem ser utilizados blocos dentro de outros blocos!

Informando um título diferente do tipo: 
__Dica: Dicas úteis__
...
__
fica:
Dicas úteis
Use e abuse das formatações Wiki

Dentro do bloco, pode usar toda as outras formatações normalmente:

Comentários: 
__Comentário__
"O estilo visual relacionado...
__
é apresentado assim:
Comentário
"O estilo visual relacionado com o bloco é definido por duas classes CSS. O nome da classe do corpo é igual ao nome do tipo (em minusculo e removendo as acentuações). O nome da classe de título do bloco é igual a do corpo acrescentando um "-title" atrás."

Colunas nomeadas

Uma variação para as tabelas são as colunas nomeadas. Cada linha é iniciada por um identificador da coluna formado por um caracter "(", seguido de um nome e seguido de um ")". O nome é livre, mas sugere-se utilizar algo curto, possivelmente apenas uma letra. A primeira linha de uma tabela de colunas nomeadas será sempre marcada como cabeçalho e consequentemente apresentará o seu conteúdo em negrito.
Posteriormente, os conteúdos serão inseridos na respectiva coluna até o final. Note que duas linhas na mesma coluna formarão uma célula com duas linhas.

Exemplo: 
(u) Usuário
(s) Sistema
(u) Abre a interface de cadastro de ocorrências
(s) Apresenta a tela de filtros das ocorrencias
(u) Informa o responsável
(u) Clica em [Listar]
(s) Sistema apresenta a lsita de ocorrências do usuário
(u) Seleciona a primeira ocorrência
(s) Apresenta tela de consulta da ocorrencia

Renderiza:
Usuário
Sistema
Abre a interface de cadastro de ocorrências
Apresenta a tela de filtros das ocorrencias
Informa o responsável
Clica em [Listar]
Sistema apresenta a lsita de ocorrências do usuário
Seleciona a primeira ocorrência
Apresenta tela de consulta da ocorrencia

Macros

O Wiki permite incluir elementos resultantes de macros processadas através de uma tag de escopo. Estas macros são informadas da seguinte forma: 
[tag:parâmetros]

Os parâmetros são variam de tag para tag. As tags utilizadas dentro do ambiente do Telescope são:

Link Telescope

[t:nome-global ]
Estabelece um link para um determinado elemento do Telescope conforme o nome global informado. O link selecionará automaticamente a tela conforme o tipo de elemento informado (entidade, interface, etc.) 

[t:#id-do-elemento ]
Funciona da mesma forma que a opção anterior mas usando o ID do elemento no lugar do nome global. 

[t:nome-global; label]
O parâmetro "label" indica o que deve ser utilizado como texto para o link. Os valores permitidos são: 

[faq:id-do-elemento ]
Indica uma FAQ referenciada utilizando o ID da FAQ..

Exemplos: 
[t:ADSRT.TEXT; global-name]
[t:ADSRT.TEXT; name]
[t:ADSRT.TEXT; title]
[t:ADSRT.TEXT; singular]

é renderizado:

ADSRT.TEXT
TEXT
Texto


InclusãoTelescope

[i:nome-global ; atributo]
Funciona de forma muito semelhante ao link Telescope, mas apenas inclui um atributo de um elemento do repositório. Especialmente útil quando se deseja enriquecer a descrição de uma interface com a descrição de uma entidade ou atributo.

Exemplos: 
[i:ADSRT.TEXT]
ou 
[i:ADSRT.TEXT; description]

é renderizado:
Domínio primitivo para representar/implementar atributos do tipo texto.

Propriedades (format)


text-transform


validações



[i:ADSRT.TEXT; title]
é renderizado:
Texto 

[i:ADSRT.TEXT; short]
é renderizado: 


[i:ADSRT.TEXT; singular]
é renderizado: 


[i:ADSRT.TEXT; notes]
é renderizado:



Ícone ou imagem do skin corrente

[icon:file-name]
Mostra uma imagem.
Exemplo: 
[icon:calendar.png]
Renderiza:
[icon:calendar.png]


Imagem cadastrada no Telescope

[image:nome-global]
Renderiza: