Telescope (core)

Índice

Central de documentação

ADS.CAD_DOCUMENTATION

Descrição

Interface EXPERIMENTAL que permite consultar e editar vários tipos de elementos do repositório do Telescope, aceitando padrões de formatação no estilo [[adsrt.wiki]].

Para abrir esta interface, utilize no menu "Desenvolvimento" > "Documentação".

Nesta interface é possível editar os títulos e descrições dos seguintes elementos:

Campos:

Tipo de componente. São apresentados apenas os tipos que são indexados na documentação.
Nome do documento em seu escopo. No caso de FAQ (ou Artigo), será simplesmente um número.
Nome global do documento no Telescope. É formado pelo nome do escopo concatenado com a identificação do documento/FAQ.
Título do documento ou nome global do documento (caso não tenha um título informado).
Título do documento.
Texto com o conteúdo do documento.
Tipo de documento.
Nome global do escopo. Pode ser um sistema, uma interface, etc.
Nome do sistema ao qual o documento está vinculado.
Nome do build. Caso informado, filtra documentos apenas dos sistemas deste build.
Link para o detalhamento técnico do elemento que está associado ao documento (se houver).
Texto que descreve o componente resumido em uma única linha. Usado para documentação do sistema em locais onde não é necessário entrar em detalhes (ex: "hint" de uma interface). Dependendo do tipo de componente, a descrição curta é o seu objetivo (porque o sistema precisa deste componente?).
Indica se deve ou não adicionar os componentes deste tipo na indexação de busca para a documentação.

Operações

Topo

Pesquisar

Ao pesquisar, o usuário poderá informar critérios de filtro para listar apenas os registros desejados. Normalmente depois de informar os filtros desejados, o usuário deverá executar a operação "Listar".
Obtenha maiores detalhes em Como utilizar a tela de pesquisa?.
Topo

Listar

Apresenta uma lista com os registros que atendem os filtros informados. Clique no registro para selecioná-lo. Caso o registro desejado seja o primeiro (ou único), é possível selecioná-lo pressionando a tecla ENTER.
Topo

Consultar

A operação de consulta é executada quando o usuário clica em um registro da lista ou após a inclusão de um novo registro.
A operação consiste em uma tela que apresenta os dados detalhados do registro específico apenas para consulta e oferece todas as operações possíveis sobre ele (alterar, excluir, etc.).
Topo

Alterar

Tela que permite a alteração de um registro.
Topo

Pesquisa simples (SEARCH)

Campos utilizados para pesquisa genérica
Topo

Novo

Permite criar novos registros no sistema. Informe os campos e pressione em Salvar.
Topo

Excluir

A exclusão do registro pode ser disparada a partir da tela de consulta e/ou de manutenção do mesmo.
O registro somente será excluído se todas as condições necessárias forem encontradas, gerando um erro, caso alguma destas condições não estiver sendo atendida.

Configurações

ADS.CAD_DOCUMENTATION.OPCOES_TIPO_INCLUSAO

Opções que permite inclusão

Lista com opções de componente que permitem inclusão.

Tipo: TEXT_LONG

Valor padrão: select tipo_componente, titulo from tipos_componentes where indexar = 'S' and id not in (59,13,22,12) order by titulo