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

Atenção
Evite usar títulos nível 1 em informações de um registro. Normalmente, o nível 1 é o próprio documento em si e os títulos informados dentro dos elementos deveriam ser de nível 2 ou mais.

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<br>Linha 2
*** Tópico 2.2.1
* Tópico 3
ou: 
- Tópico 1
- Tópico 2
-- Tópico 2.1
-- Tópico 2.2<br>Linha 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

Listas de palavra chave

Para definir listas "indexadas" por palavra/expressão-chaves na forma de tópicos, deve-se iniciar com ":" e terminar a expressão com outro ":". Se forem incluídos vários "::", então o wiki assume como sendo sub-níveis de tópicos.
Exemplo: 
:Estabelecimento: Texto para descrever a expressão.
:Situação: Texto para a situação...
::Pendente: Sub-tópico da situação.
::Cancelado: Outro sub-tópico da situação.
:::Sub-sub-tópico: bla bla bla.
Renderizado assim:

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

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, erro 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

O texto 
__Erro: Ação não permitida__
Não é possível executar porque...
__
fica:
Ação não permitida
Não é possível executar porque...

O texto 
__Código: SQL para buscar menus sem pai__
select mn.menu, it.nome as interface
, im.sequencia
, im.ativo
, mn.titulo as titulo_menu
, (select sm.menu from menus sm where sm.id = im.sub_menu_id) as submenu
from itens_menus im
join menus mn on mn.id = im.menu_id
left join interfaces_sistemas it on it.id = im.interface_id
order by mn.menu, im.sequencia, it.nome;
__
fica:
SQL para buscar menus sem pai
select mn.menu, it.nome as interface
, im.sequencia
, im.ativo
, mn.titulo as titulo_menu
, (select sm.menu from menus sm where sm.id = im.sub_menu_id) as submenu
from itens_menus im
join menus mn on mn.id = im.menu_id
left join interfaces_sistemas it on it.id = im.interface_id
order by mn.menu, im.sequencia, it.nome;

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. 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]
As macros disponíveis são definidas no ambiente de produção através da preferencia RT.WIKI.DEFAULT_MACROS. Abaixo, seguem os links para a documentação das macros disponíveis nos respectivos ambientes.

Ver:

Fluxogramas

O domínio Wiki possui um bloco especial para criar fluxogramas a partir de um texto simples inserido em um bloco "flowchart".

O texto apresentado dentro do bloco é dividido em 2 partes:
  1. Definição dos elementos que compõe o fluxo, e
  2. Fluxo entre estes elementos (opcional).

Na primeira parte, a definição dos elementos é por linhas no seguinte formato: 
tipo nome [texto]
Os tipos conhecidos são:

O nome é um identificador que será utilizado na segunda parte (fluxo). Não podem existir dois elementos com o mesmo nome.
[texto] é o que será apresentado dentro do bloco do fluxograma. Caso não informado, será usado o próprio nome.

O fluxograma mais simples seria assim: 
__flowchart: __
task Executar
__

Para criar um texto com várias linhas, deve ser incluída a primeira linha junto da definição e informadas as outras linhas abaixo, iniciando com ".". 
__flowchart: __
task p1 Avaliar,
. detalhar e
. estimar
__

A segunda parte, serão definidos os fluxos (linhas) entre os elementos. Caso não informada, o Wiki simplesmente liga todas as atividades definidas na primeira parte.
O fluxo é definido informando os elementos a serem ligados separados por "->": 
__flowchart: __
task planejar
task executar
task validar
start->planejar->executar->validar->end
__
O uso dos elementos "start" e "end" é obrigatório.

No caso do fluxo que sai dos elementos do tipo "cond", deve-se acrescentar "(yes)" e "(no)" para indicar os caminhos distintos: 
__flowchart: Processo de execução das ocorrências__
task avaliar
task aprovar
task programar Priorizar e programar a ocorrência
task cancelar
cond aprovado
input registrar Registrar aprovação

start->avaliar->aprovar->aprovado
aprovado(yes)->registrar->programar->end
aprovado(no)->cancelar->end
__

Processo de execução das ocorrências

No caso do fluxo que sai dos elementos do tipo "thread", deve-se acrescentar "(path1)" e "(path2)" para indicar os caminhos distintos: 
__flowchart: __
task receber
task executar
thread t +
task separar
task registrar

start->receber->executar->t
t(path1,right)->separar->end
t(path2,bottom)->registrar->end
__

Observações:


Ver também: