Descrição da estrutura da documentação

Descrição geral da estrutura

O conjunto das documentações dos produtos em tecnologia SAFE X3 está guardado na base de dados.

• tabela ADOCUMENT para a estrutura de parágrafos,
• tabela ADOCCLB para os textos,
• tabela ADOCBLB para os ficheiros diversos,
• tabela ADOCFNC para as ligações,
• tabela ADOCFLD para as ajudas sobre campos.

A maneira cujos dados são guardados nas tabelas está definida no anexo a seguir.

Geração da documentação.

• Uma primeira função de geração, permite criar, para cada entidade a documentar, o esqueleto, sob a forma de vários parágrafos normalizados, da documentação.
• Uma segunda função de geração parte destes dados e do texto registados para gerar uma documentação final, ao formato HTML. Cada ficha corresponde a um parágrafo, pois que as documentações são organizadas sob a forma de uma lista de parágrafos.

Estrutura de um parágrafo

• um código língua,
• Um tipo de documetnto :
• A documentação funcional (a explicação da maneira cuja função é utilizável) está identificada pelo tipo AFC.
• As documentações que descrevem a parametrização (parâmetros, códigos atividade, documentos automáticos...) são identificados pelo código de objeto que os gere (ADP, ACV, GAU nos exemplos precedentes).
• As documentações diversas (anexos, por exemplo, tal que este) são identificados pelo código DI. Os menus e sub menus são definidos pelo código APM
• um código que corresponde e que está documentado e que permitirá de identificar a documentação : por exemplo o código da função, o código do parâmetro, o código atividade, o código do documento automático...
• Um nível e um sub-nível, que descrevem as imbricações de parágrafos.
  O título do primeiro parágrafo de cada nível está retomado numa tabela das matérias quie permite apontar diretamente sobre as sessões de documentação. Quando mais de um parágrafo existe num sub-nível dado, uma sub-tabela das matérias foram criadas pelos níveis correspondentes.
• Um código parágrafo que determina a maneira cujo texto HTML vai ser gerado.
• Um código ecrã, que define se deseja inserir, no quadro do parágrafo correspondente, um ícone permitindo de desdobrar a ajuda sobre campo relativo a um dado ecrã.
• Um código de atividade, herdado do dicionário no momento da regeneração, que permite de fazer nomeadamente a distinção entre fichas standard e específicas, mas também de criar as documentações adaptadas em dossiers dados em não gerando que parágrafos e as documentações correspondentes aos códigos atividade ativados sobre o dossier.

 De referir que um parágrafo de código atividade FAL (sempre falso)  não está nunca tomado em conta para o tratamento de geração, mesmo se pede uma geração completa. Isto permite desativar os parágrafos gerados que não se deseja encontrar numa documentação.

Uma vez a fase de geração a partir do dicionário feito, é possível completar as fichas criadas na tabela ADOCUMENT, e de reacrescentar outros (nomeadamente de tipo diversos). A supressão de uma ficha na tabela ADOCUMENT significará a supressão do parágrafo na documentação final (mas se o parágrafo está gerido a partir do dicionário, uma regeração a partir do dicionário o recreará).

 É importante de notar que os parágrafos estão listados na ordem na qual eles devem aparecer (o parágrafo TIT sendo o primeiro, por exemplo). Excepto caso particular e parágrafos genéricos (MIS,MIN nomeadamente), é aconselhado de respeitar a ordem.

Os parágrafos que existem se reafixam em várias categorias

Os parágrafos gerados automaticamente

Certos parágrafos retomam automaticamente, com uma atualização em página dada, os elementos emitidos do dicionário e ou da tabela das ligações.
Chama-se isso dos parágrafos geridos. Neste caso, a geração da tabela ADOCUMENT, o parágrafo está criado se os elementos do dicionário ou da tabela das ligações o justifiquem, com um texto vazio. Não é necessário de preencher o texto, pois que os elementos do dicionário serão automaticamente apresentados no parágrafo.
Se um texto está registado na ficha, será automaticamente reacrescentado no fim do paragrafo. Neste caso, a regeração não suprimirá o parágrafo, mesmo se, na seguida de evolução do dicionário, este parágrafo não se justifica mais.

Os parágrafos criados vazios ou parâmetros clássicos

Certos parágrafos são criados automaticamente na geração depois o dicionário, mas sem nenhum texto, porque se trata de parágrafos livres habitualmete presentes num tipo de documentação dada. O texto registado na tabela ADOCUMENT está então retomado na documentação final, sem nenhuma atualização particular. Certos parágrafos não são criados automaticamente na fase de geração do dicionário, mas podem ser criadas pelo seguinte. Recordam-se nos parágrafos livres na seguida deste documento.

Ligações hypertextos

Exceto caso particular declarado a seguir, a criação de um parágrafo criado uma âncora de mesmo nome no texto. Está assim possível de criar uma ligação hyper-texto versus o parágrafo em questão (o caminho da ligação sendo document.htm#ancreem vez de ser document.htm neste caso). Assim, para ir diretamente sobre a documentação do 3º separador da função de gestão dos utilizadores (GESAUS), utilizar-se-á uma ligação versus GESAUS.htm#ON3.

Os códigos de parágrafos que podem existir em vários exemplares numa documentação devem dispor de uma ligação por parágrafo. Neste caso, a relação se exprime sob a forma PARAG_LEV_SLEV, onde PARAG é o código do parágrafo, LEV o nível, e SLEV o sub-nivel. Assim, para um parágrafo de tipo MIS situado ao nível 140, sob-nivel 40 da documentação ADO_FCT, a ligação será ADO_FCT#MIS_140_40.

Os diferentes tipos de documentação

O campo Tipo de documentação define o que vai ser documentado.

O quadro a seguir descreve os tipos de documentação possíveis :

Indicações sobre certas documentações

Documentos de tipo AFC

A documentação de tipo AFC é a mais completa. Ela permite descrever em detalhe a função, seus pré-requisitos de parametrização (um conjunto de subparágrafos automatizados), seu interface utilizador (separadores com integração de ajuda sobre campo, botões, items de menu), e de anexos (listas, lista de erros e tabelas genéricas).
Uma parte dos parágrafos que a composta está totalmente gerido depois o dicionário, mas a maior parte dos parágrafos devem estar registados. O código associado a esta documentação e o código da função (tal que está definida no dicionário das funções) O nome do ficheiro html correspondente gerido no sub-diretório FCT do diretório de documentação.
Ela pode ser chamadas depois todo o ecrã da função via a tecla F1

Aferando o ficheiro de documentação HTML gerado e para as documentações de tipo AFC unicamente, o conjunto dos parágrafos considerados como fazendo parte da colocação em obra da função são reagrupados num outro ficheiro HTML afim de separar a parte funcional da parte tecnica. Uma ligaçao está criada no ficheiro HTML original versus o ficheiro HTML de colocação para cada tipo de parágrafos implicados.
Os parágrafos implicados são :

• Todos os parágrafos de nível 30 (os pré-requisitos)
• Todos os parágrafos de nivel 100 (as tabelas colocadas em obra)

Documentos de tipo DI

As documentações de tipo DI não estão religados a um elemento do dicionário. Elas permitem criar os anexos técnicos, documentações gerais. Por exemplo, nas documentações standards, GESAWA.htm é a documentação associada aos eventos de workflow. GES_AWA.htm, documentação de tipo DI, é o anexo técnico associado.
As documentações de tipo DI são geradas no diretório FCT.
Para evitar ums colisão com as documrntações funcionais, a norma consiste a inserir pelo menos um caracter "_" no código.

Documentações de tipo ACV, ADM, ADP, AHI, AOE, ARP, AWA, CDA, CDE, GAU, PS1, ADC

As documentações de tipo ACV, ADM, ADP, AHI, AOE, ARP, AWA, CDA, CDE, GAU, PS1, ADC são documentos de tipo objeto, que estão acessíveis por Alt + F1 depois uma função de parametrização. Elas permitem descrever a ficha corrente do ponto de vista da sua lógica de parametrização. Regista-se pouco texto em geral no tipo de documentação (essencialmente a utilização ou a descrição do código em questão, eventualemente algumas observações).
Alguns códigos do parágrafo são especificamente dedicados a este tipo de documentação. O código associado a esta documentação é o código da ficha correspondente. O ficheiro de documentação está gerada no sub-diretorio OBJ. É composto do código de objeto, seguido da chave da ficha.

Exemplos
- O código de atividade BPA está gerado sob o nome ACV_BPA.htm.
- O modelo de importação exportação BPR está gerado sob o nome AOE_BPR.htm. 

 De referir que a chave dos parâmetros é uma chave em duas partes integrando o capítulo correspondente. Por exemplo, a ajuda sobre o parâmetro ADMUSR (Capítulo SUP) está então gerado sob o nome ADP_SUP_ADMUSR.htm.

Documentações de tipo AML, ATB, ATY

As documentações de tipo AML, ATB, ATY são documentos descrevendo a estrutura dos dados.
Elas são acessíveis depois o sumário de ajuda.
Um único parágrafo existe neste tipo de documentação (é o parágrafo de título, que permite fazer preceder a documentação gerida por outro lado de um cometário eventual). Elas são geradas no direcrório MCD, e retomam o código da tabela (nome pré-fixado) o código do tipo de datas prefixada por ATY_, e o número do menu local sob a forma MEN####.htm (####sendo o número do menu sobre 4 cifras, completado a esquerda por zeros).

As documetações de tipo APM

As documetações de tipo APM são os menus de ajuda.
Estas documentações são geradas a partir do dicionário e um único parágrafo existe para este tipo de documentação É possível criar outros para descrever os menus suplementares organizando a documentação (neste caso, o parágrafo contém a lista das documentações chamadas). É também possível acrescentar as ligações de documentações suplementares nas documtações geradas deste tipo.

As documentações de tipo FI

As documentações de tipo FI permitem simplesmnte extrair as documentações. A norma de nomeação destas documentações determina o sítio onde os ficheiros são criados. Encontrar-se-á o detalhe no paragráfo correspondente.

Os menus de documentação

Toda a função gera as fichas que podem ser documtados pela função de gestão de documetação, às condições seguintes:

• Definir, na tabela diversa 910, um código de doc correspondente ao código de objeto cLes paragraphes inpliqués sont :ujo se deseja gerar a documentação sobre a ficha.
• O tipo de documentação corresponde ao tipo de objeto, a chave da chave principal da ficha que se documenta (trata-se de uma chave em várias partes, elas são separadas pelo caracter de sublinhado "_").
• Gerir as documentações ao formato HTML (por defeito, elas são criadas no diretório OBJ, directório das ajudas sobre o objeto)
• a chamada de ajuda se faz, sobre uma ficha dada, por Alt + F1.

Exemplos
AFC (ajuda funcional) corresponde à ajuda sobre as funções, ou objeto AFC gera as funções É o mesmo para as documentações ADP (parâmetros), ACT (ações), ACV (códigos atividade...).

Desde que o código de um objeto está presente na tabela diversa 910, um menu Documentação aparece automaticamente na barra de menus do objeto correspondente.
As funções acessiveis pelo menu são descritas a seguir.

Documentação / Parágrafos

Esta função permite aceder à gestão da documentação, sobre o primeiro parágrafo da documentação (se ela existe) associada à ficha corrente.

Documentação / Ligações

Esta função permite aceder à gestão das ligações. Ela permite definir as relações entre a ficha corrente e de outras fichas (por exemplo das ligações entre funções e parâmetros). Estas ligações, puramente documentários, permitindo alimentar o mecanismo de geração dos esqueletos de documentação.

Documentação / Geração

Parágrafos preliminares

Estes parágrafos introduzem a documentação funcional.

Código TIT (título)

Esta capítulo define o título da documentação no seu intitulado

Quando a documentação funcional está gerada a partir do dicionário, este capítulo está automaticamente criado ao nível (10,10).

Para as documentações do dicionário (tabelas, menus locais, tipos de dados), logo é o único parágrafo, o texto é um texto preliminar que será inserido antes os quadros descrevendo a estrutura técnica do dicionário.

Para as documentações descrevendo um menu (tipo APM), é possível de reacrescentar as ligações versus outras ajudas, em os identificando pelo seu código. A codificação de uma linha está então a seguinte :

• seja o código da função (ajuda funcional) Exemplo: GESAUS
• seja o código de ajuda precedida pelo seu tipo, todo o separado pelo caracer "/". Exemplo: DI/ADO_FCT
• seja uma das duas sintaxes precedentes seguido do caracter "#" e do nome de baliza, para se posicionar diretamente ao meio do documento. Exemplo: GESAUS#ON3

Para todos os outros tipos de documentação, não é possível de colocar no texto que uma série de palavras chave separadas por vírgulas, que serão inseridas no ficheiro HTML, na rubrica keyword (palavras chave para as pesquisas, não aparecem no texto por outro lado). Assim, neste caso, não existe realmente de parágrafo associado no documento "HTML" produto (de de outro lado de âncora).

Gera-se este tipo de parâmetro para todos os tipos de documentação. Se este parágrafo leva um código atividade e se gera o doc para um dossier sobre o qual o código atividade não está ativado, a documentação não foi gerada.

Em particular, se este parágrafo leva o código atividade FAL :

• a documentação final não está jamais gerada.
• Uma regeração de um esqueleto de documentação não gera nada para mais (ela pára se o parâmetro TIT existe com o código atividade FAL)

Por outro lado, se o intitulado do título não foi registada na ficha, é pesquisado no dicionário em função do contexto. Isto permite nomeadamente de gerir os caso particulares, Tais que as ajudas sobre funções RPT*, ou o nome do grupo cujo deve estar aquele do dicionário.

Código PRE (apresentação)

Este parágrafo define a apresentação da entidade documentada (função,código atividade, parâmetro de dimesionamento, parâmetro... todas as documentações são respeitadas) É um parágrafo criado vazio automaticamente ao nível (10,20).

Este primeiro parágrafo aparece na documentação funcional final.

 Não é necessário de colocar um texto para a apresentaçaõ dos códigos de atividade dependendo de um outro código (um texto automático está utilizado se o texto esta vazio).

Parágrafos de pré-requisitos funcionais

Estes parágrafos descrevem pré-requisitos necessários à execução da função. Podem então estar presentes em toda a documentação funcional, mesmo se certos podem assim ser presentes em outras documentações (as documentações sobre códigos de atividade, sobre listas, sobre eventos de workflow...)

NOTA para as Documentações de tipo AFC (e unicamente AFC) : No ficheiro de documentação de HTML gerado, o conjunto dos parágrafos de "Pré.requisitos" são de ora avante escritos num ficheiro HTML anexo de colcação em obra afim de separar a parte funcional da parte técnica. Uma ligação está criada no ficheiro HTML, original versus HTML de colocação em obra

Lista dos parágrafos :

Código PRQ (pré-requisitos)

Este parágrafo definindo os pré-requisitos está presente nas documentações sobre função, sobre listas, sobre modelos de import/export.

Trata-se de um parágrafo introdutivo criado vazio ao nível (30,10). Na documentação sobre função,não é criado que se um outro parágrafo de pré-requisito está criado (então que está sempre criado nas documentações sobre importação/exportação e sobre a lista).

O texto não é obrigatório (se não existe texto, o parágrafo existirá simplesmente como um inter-título).

Código ACV (códigos atividade)

Apresentado na documentação das funções, assim que a documentação dos parâmetros e dos códigos atividade, trata-se de umparágrafo gerado ao nível (30,20) com o estilo 4 :

• na documentação das funções, é gerado a partir do dicionário, desde logo que pelo menos um código atividade está detetado (pesquisamos-o na função, na janela associada à função, no objeto, a consulta, as tabelas associadas) Pode-se igualmente associar um código atividade a uma função para a tabela das ligações ADOCFNC. É então um sub-parágrafo do parágrafo PRQ.
• na documentação dos parâmetros, é gerado a partir de uma pesquisa nos dicionários no dicionário e pelas ligações entre parâmetros e código atividade.
• Nas documentações descrevendo um código de atividade. É gerado em tendo conta dos códigos atividades dependendo do código de atividade documentada (esta dependência está encontrada no dicionário).

Com a geração da documentação final, pesquisa-se os códigos atividade com o mesmo algoritmo no dicionário, apresentamos sob forma de quadro com as ligações das relações versus a documentação descrevendo o código atividade.

De referir que a pesquisa sistemática em todo o dicionário pode, em cascata, reestabelecer um número importante de códigos atividades não desejados na lista. Afim de permitir de fazer uma ordenação, uma funcionalidade particular existe : a presença do código atividade FAL (sempre falso) nas relações de documentação inibe a pesquisa dos códigos atividades no dicionário. Não restam então que as ligações versus os códigos atividade (FAL exclu) estritamente mencionados nas relações.

Código ADP (parâmetros)

Apresentado na documentação das funções, assim que a documentação dos parâmetros e dos modelos de importação/exportação, trata-se de umparágrafo gerado ao nível (30,30) com o estilo 4 :

• na documentação das funções, define a lista dos parâmetros associados à função, e é gerado a partir das relações entre função e parâmetro ou parâmetro e função (as relações reciprocas são também analisados). É então um sub-parágrafo do parágrafo PRQ.
• na documentação dos parâmetros, é gerada a partir de uma pesquisa no dicionário (os parâmetros de um mesmo grupo e de um mesmo capítulo são incluidos), e pelas associações entre parâmetro e parâmetro na tabela das ligações.
• nas documentações descrevendo um modelo de importação/exportação, descreve os parâmetros ligados (pesquisados pela exploração das ligações entre modelos e parâmetros ou reciprocamente na tabela das ligações).

A geração da documetação final, os parâmetros são ordenados por família, afixados nas lista com as relações sobre a documentação decrevendo o parâmetro geral.

Código ANM (contadores)

Presente na documentação das funções, trata-se de um parágrafo gerado ao nível (30, 40) com o estilo 4, que dá a lista dos contadores utilizados pela função. É gerado desde logo que pelo menos um contador está detetado na tabela das ligações (pode-se associar um contador a uma função) É então um sub-parágrafo do parágrafo PRQ.

A geração da documentação final, os contadores são apresentados em lista.

Código GAU (documentos auto)

Presente na documentação das funções, trata-se de um parágrafo gerado ao nível (30, 50) com o estilo 5, que dá a lista dos contadores utilizados pela função. É gerado desde logo que pelo menos um documento automático está detetado na tabela das ligações (pode-se associar um contador a uma função) É um sub-parágrafo de parágrafo PRQ, que é precedido de um inter-título complementar, de estilo justo inferior ao estilo do parágrafo (4 por defeito), nomedado Interface contabilística, que introduz globalmente os parâmetros GAU e CDE.

A geração da documentação final, os documentos automáticos são apresentados em quadro com uma ligação versus a documentação que os descreve.

Código CDE (secções/defeito)

Presente na documentação das funções, trata-se de um parágrafo gerado ao nível (30, 60) com o estilo 5, que dá a lista dos códigos secção utilizados pela função. É gerado desde logo que pelo menos um código secção está detetado na tabela das relações (pode-se associar um código secção a uma função). É um sub-parágrafo de parágrafo PRQ, que é precedido de um inter-título complementar, de estilo justo inferior ao estilo do parágrafo (4 por defeito), nomedado Interface contabilística, que introduz globalmente os parâmetros GAU e CDE.

A geração da documentação final, os documentos secção são apresentados em quadro com uma ligação versus a documentação que os descreve.

Código HAB (habilitações)

Na documentação funcional, este parágrafo opcional está normalmente um sub-parágrafo do parágrafo PRQ.

É um parágrafo gerado por defeito ao nível (30,70), com o estilo 4, desde logo que uma das condições seguintes foi realizado :

• a função dispõe de direitos de acesso geridos em função do estabelecimento.
• opções de habilitação existem no dicionário para a função.
• a função é de tipo objeto (deste facto as opções criação/supressão modificação existente por defeito).
• um código de acesso está declarado ao nível de objeto se a função é deste tipo.

A geração da documentação final, um conjunto de textos automáticos está criado em função do contexto (gestão por códigos de acesso, opções de habilitação presentes no dicionário...).

Código TRS (transações)

Na documentação funcional, este parágrafo opcional está normalmente um sub-parágrafo do parágrafo PRQ. É gerado a partir de relações entre funções e transações (a relação de tipo TRS associando uma função à função permitindo de parametrizar as transações). A geração se faz ao nível (30,80), com o estilo 4.

A geração da documentação final, estas transações são colocadas em página, e de ligações versus a documentação funcional correspondente são inseridas.

Código ECC (ecrãs consulta)

Na documentação funcional, este parágrafo opcional está normalmente um sub-parágrafo do parágrafo PRQ. É gerado a partir do dicionário, em pesquisando a lista dos códigos de consulta encontrados no dossier onde a documentação foi gerida.

Observa-se que este parágrafo está gerado à mesma fila que o parágrafo TRS, o que é logico, poisque os dois não podem cohabitar (um afeta as consultas, os outros os objectos), e que outro correspondem todos os dois a variantes de ecrãs. A geração se faz ao nível (30,80), com o estilo 4.

A geração da documentação final, este códigos ecrã são presentes em quadro.

Código PRQ (outros pré-requisitos)

Apresenta a documentação das funções, trata-se de um parágrafo gerado ao nível (30,90) com o estilo 4, que dá uma série de pré-requisitos outros apresentados sob a forma de sub-parágrafos com inter-títulos de estilo 5 :

• O primeiro de entre eles dá a lista das tabelas diversas a atualizar. É alimentado por estas ligações entre funções e tabelas diversas.
• o segundo dá a lista das tabelas da base a atualizar. É alimentado pelas ligações entre função e tabelas (pelo código AT2, o código ATB alimentando as tabelas atualizadas).
• o terceiro dá a lista dos menus locais que é necessário de preencher. É alimentado por estas ligações entre funções e menus locais.
• o último sub-parágrafo, nomeado Pré-requisitos diversos, está presente se um texto foi acrescentado na documentação Se o texto começa por um título (com uma balisa de tipo Hn, n sendo um numero), o inter-título Pré-requisitos diversos não foi inserido.

Descrição do interface

Estes parágrafos gerados descrevem a organização da janela de registo associado à função. Eles não são gerados automaticamente que se existe uma janela associada à função A geração final incluirá ajuda funcional se o campo Ecrã apresenta na ficha está preenchida.

Estes parágrafos são os seguintes :

Código ECC (decrição ecrã)

Este parágrafo constitui uma introdução que permite nomeadamente definir o número de separadores, de descrever as particularidads da lista esquerda se existir uma.

Quando a documentação funcional está gerada a partir do dicionário, este capítulo está automaticamente criado ao nível (40,50), com o estilo 3

Código ENT (cabeçalho ecrã)

Este parágrafo descreve os campos de cabeçalho da janela (se existir uma). O texto que está registado está inserido tal que na documentação final. Desde logo que o código de ecrã está preenchido no parâmetro, a barra de título inclui um pequeno ícone em forma de seta descedente, que desbobra automaticamente a lista dos camps do cabeçalho (e as ajudas correspondentes). O texto está em princípio utilizado para dar o detalhe dos campos componentes a chave de objeto, ou os critérios da consulta.

Quando a documentação funcional está gerada a partir do dicionário, este capítulo está automaticamente criado ao nível (40, 100), com o estilo 3, desde logo a janela correspondente à função utiliza efetivamente uma máscara em cabeçalho.

Códigos ON1 a ONF (separadores)

Estes parágrafos descrevem cada um dos separadores da janela associada à função. A barra de título inclui um pequeno Ícone em forma de seta descendente, que desdobra automaticamente a lista dos campos do separador (e as ajudas correspondentes) se o campo ecrã está registado na ficha, o que é o caso em geração automática.

Este texto está em princípio para dar as infomações sobre os campos presentes no separador (sem forçosamente dar o detalhe de ajuda sobre cada campo, poisque a ajuda em linha por campo está também disponível por desdobramento). Em ausência de texto registado, um texto genérico convida o utilizador a desbobrar com ajuda sobre o campo.

Quando a documentação funcional está gerado a partir do dicionário, este tipo de capítulo está automaticamente criada ao nível 40, a partir da descrição da janela associada à função. Os sub-níveis de geração são calculados a partir da fila de separador (campo ROWMSK), afim de respeitar a ordem de apresentação dos separadores da função quando acrescenta os separadores específicos que devem se inserir entre dois separadores existentes. O sub-nível é igual à fila multiplicada por 200. Assim, se as filas estão numeradas de 10 em 10, obtem-se as filas 2000,4000,6000. A fila máxima possível é 19800, e o mínimo é 200.

No momento da geração da documentação, os parágrafos descrevendo as ações Botão sobre quadro (clique direito)são criadas automaticamente na seguida do parágrafo ligado a cada separador, em sendo numerados de 5 em 5 (afim de deixar a possibilidade de intercalar os parágrafos diversos)

Códigos BOT (cliques sobre quadro)

Estes parágrafos descrevem cada uma das funções acessíveis por clique direito sobre um quadro. Podem existir vários (com o mesmo código : A âncora correspondente é então BOT_LEV_SLEV, onde LEV é o nível, e SLEV o sub-nível). Cada um dos botões deve estar inserido, na ordem dos parágrafos, justo após o parágrafo descrevendo o separador sobre o qual está colocado

Quando a documentação funcional está gerada a partir do dicionário, estes parágrafos são automaticaemnte criados ao nível 40, com um sem numeração indo de 5 em 5 a partir do número de separador (2005, 2010, 2015...após o separador de fila 10, por exemplo). O estilo por defeito utilizado é o número 6, e um inter-título nomeado Funções acessíveis por clique direito sobre quadro, de estilo 5, está colocado em cabeçalho dos parágrafos consecutivos deste tipo.

Códigos BOU (botões)

Estes parâmetros descrevem cada um botões acessíveis em baixo de ecrã Podem existir vários (com o mesmo código : A âncora correspondante é então BOU_LEV_SLEV, onde LEV é o nível, e SLEV o sub-nível). Estes botões são normalmente colocados, após os parágrafos associados aos separadores. O primeiro de entre eles é um parágrafo introdutivo, cujo título utiliza um estilo standard (3 por defeito). O título dos capítulos consecutivos BOU segundo está presente num quadro de botão (o que significa que o texto deve corresponder ao texto do botão). O texto correspondente está então colocado à direita de cada botão.

Quando a documentação funcional está gerado a partir do dicionário, estes parágrafos são automaticamente criadas ao nível 70, com um sub-nível começando a 10 (título do capítulo cansagrado aos botões) e indo de 10 em 10 (20 para o primeiro botão, 30 para o seguinte, etc.).

Código BME (Barra de menus)

Estes parágrafos descrevem cada um das funções acessíveis pela barra de menus. Podem existir vários (com o mesmo código : A âncora correspondente é então BME_LEV_SLEV, onde LEV é o nível, e SLEV o sub-nível). Estes parágrafos são colocados após os parágrafos O primeiro de entre eles é um parágrafo introdutivo, cujo título utiliza um estilo standard (3 por defeito). O título dos capítulos consecutivos está em estilo standard 4.

Quando a documentação funcional está gerada a partir do dicionário, estes parágrafos são automaticamente criadas ao nível 80, com um sub-nível começando a 10 (título do capítulo consagrado aos menus) e indo de 10 em 10 (20 para o primeiro botão, 30 para o seguinte, etc.).

Parágrafos anexos

Estes parágrafos de conclusão dá as informações anexas (lista dos erros, listas, tarefas,batch ...). Estas são as seguintes :

Códigos RPT (Listas)

Apresenta na documentação das funções, trata-se de um parágrafo gerado ao nível (50, 10) com o estilo 4, que dá a lista dos utilizados pela função. É gerado a partir do dicionário (pesquisa a partir dos códigos de impressão definidos no dicionário das funções para Impressão e Lista, em pesquisando se estas listas estão associadas na tabela dos códigos impressões). Completa-se esta lista de estados para aqueles eventualmente encontrados em pesquisando as ligações entre a função e das listas na tabela das ligações.

A geração da documentação final, um quadro está gerado, contendo as listas lançáveis depois a função, com as ligações "hyper-textes" versus as documentações correspondentes.

Código ABT (tarefas batch)

Presente na documentação das funções, trata-se de um parágrafo gerado ao nível (60, 10) com o estilo 4, que dá a lista das tarefas batch utilizáveis para lançar a função em plano traseiro. É gerado a partir do dicionário (pesquisa na tabela das tarefas batch). Completa-se esta lista de tarefas para aquelas eventualmente encontradas em pesquisando as ligações entre a função e das listas na tabela das ligações.

Na geração da documentação final, um quadro está gerado, contendo a listas das tarefas existentes.

Código ERR (Erros)

Este parágrafo, cujo texto registado está diretamente inserido no documento, está dedicado à lista dos erros que podem ser afixados no momento de utilização da função. Inserem-se aqui os erros muito particulares à função. Com efeito, um conjunto de erros genéricos são listados num documento dedicado, e uma ligação versus este documento está automaticamente inserido neste parágrafo. Este parágrafo está por outro lado criado vazio.

Este tipo de parágrafo pode ser igualmente utilizado na documentação sobre modelos de import/export, com as mesmas características.

Quando a documentação funcional está gerada a partir do dicionário, este capítulo está automaticamente ao nível (80,10), com o estilo 3. Se não existe texto associado ao parágrafo, um texto assinalando que apenas os erros conhecidos são de erros genéricos (acessíveis via a relação). Senão, o texto dá os erros e o texto explicativo correspondentes. É recomendado de utilizar o estilo H5 para o texto de erro, e o estilo de parágrafo por defeito para a explicação, o que dá o resultado seguinte :

 É possível utilizar a sintaxe L4G mess() para dar o texto de erro. Isto permite ter exatamente o texto de erro e de ter a mesma tradução.

Ter-se-á então por exemplo :

que dará no momento da geração

Código ATB (tabelas geradas)

Presente na documentação das funções, assim que na documentação dos parâmetros de dimensionamento, modelos de importação/exportação, listas, "idles" regras de Workflow, e eventos desencadeando as estatísticas, trata-se de um parágrafo geradoao nível (100,10) com o estilo 3 :

• na documentação das funções, é gerado a partir do dicionário, desde logo que pelo menos uma tabela está detetada (pesquisam-se no objeto,na consulta). Pode-se igualmente associar uma tabela a uma função pela tabela das ligações.
  NOTA para as Documentações de tipo AFC (e unicamente AFC) : No ficheiro de documentação de HTML gerado, este parágrafo de "Tabelas colocadas em obra" está de ora avante escrito num ficheiro HTML anexo de colocação em obra afim de separar a parte funcional da parte técnica. Uma ligação está criada no ficheiro HTML, original versus HTML de colocação em obra
• nas outas documentações, o princípio é o mesmo : se o dicionário permite encontrar as tabelas, ou das ligações são encontradas, o parágrafo foi gerado.
• no caso da documentação dos parâmetros de dimensionamento, as tabelas listadas são aquelas cujo dimensionamento depende do parâmetro.

Na geração da documentação final, apresentam-se as tabelas num quadro, em incluindo uma ligação versus o dicionário das tabelas e também versus o objeto, quando existe, que permite gerar a tabela em questão. As tabelas globais a todos os dossiers, se existem, seja isolados num parágrafo dedicado.

Parágrafos particulares

Estes parágrafos podem ser inseridos por todo o lado na documentação, para gerar as exceções ou os parágrafos suplementares não previstos. Permitem também segmentar um parágrafo muito longo (o comprimento do texto registado sem um parágrafo sendo limitado por construção). Como o código utilizado para estes paragrafos pode estar repetido, não exuste âncora do mesmo nome colocado acima (âncoras técnicas, numeradas com o código do parágrafo, seguido do nível e do sub-nível, separados pelo caracter "_" são assim criados) Estes parágrafos são os seguintes :

Códigos MIS (Diversos)

Trata-se aqui de um parágrafo diverso presente na tabela das matérias ligadas ao nível no qual se encontra. Dá-se um título, um estilo, e um texto a inserir.

Na medida onde vários parágrafos deste tipo podem existir num doc, âncora correspondente a estes parágrafos é MIS_LEV_SLEV, onde LEVé o nível e SLEV o sub-nível.

Códigos MIN (Diversos)

Trata-se aqui de um parágrafo diverso presente na tabela das matérias ligadas ao nível no qual se encontra. Dá-se um título, um estilo, e um texto a inserir.

Na medida onde vários parágrafos deste tipo podem existir num doc, a âncora correspondente a estes parágrafos é MIN_LEV_SLEV, onde LEVé o nível e SLEV o sub-nível.

Códigos LNK (Ligações)

Este tipo de parágrafo permite inserir as tabelas das matérias sob a forma :

• seja a lista das ligações de cabeçalho (situado na barra de título da documentação). Isto supõe que o parágrafo de tipo LNK se encontra ao mesmo nível que o parágrafo TIT da documentação correspondente. O título do parágrafo dá então o título do documento corrente tal que está definida na lista das relações.
• seja de uma lista de ligações (como uma tabela de matérias) no caso geral. Este tipo de parágrafo permite inserir as ligações versus as documentações não directamente acessíveis na hierarquia na qual o documento se encontra.

No caso onde a relação define um parágrafo separado, o título e o estilo são ignorados, e nenhuma entrada aparece na tabelas das matérias. Mas se deseja acrescentar um título a este parágrafo de ligações, é suficiente de fazer preceder de um parágrafo de tipo MIS ou MIN

As ligações são definidas no texto do parágrafo sob uma das formas seguintes :

• CODE_FONCTION
• CODE_FONCTION#ancre
• TYPE/CODE
• TYPE/CODE#ancre

O significado dos elementos é a seguinte :

• CODE_FONCTION é o código de uma documetação funcional (de tipo AFC ou DI) : a relação apontará sobre os sub-diretório FCT, onde se encontra este tipo de documentação.
• TYPE corresponde aos diferentes tipos de documentação : ADC, AD, ACV por exemplo... O código que segue é o código da documentação
• âncora corresponde a uma âncora de parágrafo, se deseja se posicionar directamente sobre um parágrafo dado. A âncora está ignorada se se trata de uma ligação de cabeçalho.

A geração, cada ligação está explorada : a documentação correspondente está pesquisado na tabela ADOCUMENT(se ela não existe, a ligação não está inserida) e o título da documentação

Códigos INC (Inclusão)

Este parâmetro permite incluir tal que um parágrafo já escrito numa outra documentação.

Todo o parágrafo pode estar incluido, na exceção do parágrafo de tipo TIT. Se se retoma um parágrafo de apresentação associado a uma outra documentação, o parágrafo INC que substitui deve ser primeiro deste tipo da documentação, e de encadear sobre um parágrafo de tipo PRE.

Na medida onde vários parágrafos deste tipo podem existir num doc, âncora correspondente a estes parágrafos é MIS_LEV_SLEV, onde LEVé o nível e SLEV o sub-nível.

O parágrafo a retomar deve então ser identificada no texto do parágrafo de inclusão, sob uma das duas formas seguintes :

• TYPE/CODE
• TYPE/CODE/NIVEAU/SOUS-NIVEAU

O nível e sub-nível não são obrigatórios (o parágrafo de mesmo nível e de mesmo sub-nível sendo retomados por defeito na documentação ligada).

Por exemplo, se pretende inserir o parágrafo relativo ao primeiro separador da ficha utilizador, que está definida ao nível 40 e ao sub-nível 200, colocar-se-á no parágrafo de inclusão o texto seguinte:

AFC/GESAUS/40/200

De referir que tudo é retomado do parágrafo de origem (título, estilo, texto, atualização, ajuda sobre campos), exceto o nível e o sub-nível que restam aqueles de origem (as ruturas de tabelas das materias restam assim respeitadas). O título da tabela das matérias corresponde ao título do parágrafo INC de origem, a âncora criada e utilizável para as relações corrresponde a uma âncora genérica INC_rang_sous-rang.

Parágrafos reservados às outras documentações

Estes parágrafos são espacíficos a tipos de documentações outras que as documentações sobre função. Estas são as seguintes :

Código LEV (nível)

Este parágrafo está específico às documentações sobre parâmetros. Está gerado a partir do dicionário ao nível (30,10).

Na geração final, um texto é gerado, indicando o nível de definição do parãmetro, assim que o nome da variável global associada se ela existe. Si aucune variable globale n'est trouvée, un texte précisant qu'il n'en existe pas est inséré, sauf si le texte de la fiche a été renseigné (on suppose dans ce cas qu'il peut être amené à citer une variable non déclarée dans le dictionnaire).

Código REM (observações)

Este parágrafo está específico às documentações sobre parâmetros, sobre documentos automáticos,e sobre os códigos secções por defeito. Está criado vazio a partir do dicionário ao nível (70,10).

O texto registado na ficha está suposto permitir de fazer as observações diversas.

Código PAR (parâmetro das ações)

Este parágrafo está específico às documentações sobre ações Está geradoa partir do dicionário ao nível (30,10), para permitir de dar a lista dos parâmetros da ação.

A geração da documentação final, uma frase introdutiva está criada, seguida de um quadro apresentando os parágrafos, o seu título, e o tipo de dados. Na ausência de parâmetros, uma frase negativa está inserida.

Código UTI (utilizações da ação)

Este parágrafo está específico às documentações sobre ações Está criado vazio a partir do dicionário ao nível (40,10).

O texto registado na ficha está suposto descrever as utilizações da ação.

Se este parágrafo está vazio no momento da geração da documentação final, não se o gera mais.

Código ACT (acções associadas às ações)

Este parágrafo está específico às documentações sobre ações Está geradoa partir do nível (50,10), para permitir de dar a lista das ações ligadas à ação documentada. A geração se faz a partir das ligações (e das ligações reciprocas) encontradas entre ação e ação

A geração da documentação final, uma frase introdutiva está criada, seguida de um quadro apresentando as ações, com uma ligação versus a documentação correspondente.

Código REC (valores recomendados)

Este parágrafo está específico às documentações sobre parâmetros, e sobre parâmetros de dimensionamento. Está criado vazio no caso dos parâmetros, e gerado no caso das variáveis de dimensionamento (uma linha por defeito está criada se o parágrafo está vazio, dando o valor encontrado no dossier de referência). A criação de facto ao nível (30,10).

O texto registado na ficha está suposto descrever os valores recomendados para o parâmetro em questão.

Código AFC (funções afetadas)

Este parágrafo está específico às documemntações sobre códigos atividade, sobre parâmetros gerais e sobre listas. É geradoao nível (40,10) para os códigos atividades e as listas, e ao nível (50,10) para os parâmetros gerais, para permitir dar :

• a lista das funções afetadas pelo código atividade. A geração se faz a partir das ligações reciprocas às ligações entre funções e códigos de atividade, assim que para os códigos atividades encontradas quando uma exploração sumária do dicionário (apenas as funções dependendo diretamente do código atividade são retomadas). A geração da documentação final, uma frase introdutiva foi criada, seguida de uma lista de funções com uma ligação sobre a documentação correspondante.
• O meio de aceder à lista (grupos de impressão, e lista das funções susceptíveis de lançar a lista) A geração se faz então por análise do dicionário e por leitura a partir das ligações reciprocas às ligações entre funções e listas. A geração da documentação final, uma frase introdutiva está criada, seguimento de um texto automático indicando se a lista está ou não diretamente executável, a qual grupo de impressão pertence, e enfim uma lista de funções susceptíveis de lançar a lista com uma ligação sobre a documentação correspondente.
• as funções particularmente impactadas pelo parâmetro.

Código AT2 (tabelas a preencher)

Este parágrafo está específico às documentações sobre modelos de import/export Está geradaao nível (30,30), com o estilo 4, para permitir dar a lista das tabelas que são supostas ser registadas para poder utilizar o modelo correspondente, e é um sub-parágrafo do capítulo PRQ. A geração se faz a partir das ligações entre modelos de import/export e tabela (de tipo AT2).

Na geração da documentação final, apresentam-se as tabelas num quadro, precedidos de uma fase introdutiva, em incluindo uma ligação versus o dicionário das tabelas e também versus o objeto, quando existe, que permite de gerir a tabela em questão. As tabelas globais a todos os dossiers, se existem, seja isolados num parágrafo dedicado.

Código CHO (campos obrigatórios)

Este parágrafo está específico às documentações sobre modelos de import/export Está criada vaziaao nível (40, 10), para permitir dar a lista dos campos supostos serem obrigatórios para que o modelo possa funcionar.

Código CRI (critérios de lançamento)

Este parágrafo está específico às documentações sobre listas, e às documentações sobre sub-programas.

No caso destas listas, é um parágrafo gerado por defeito ao nível (30,30), com o estilo 4, a partir dos dados do dicionário das listas, afim de permitir gerar os textos automáticos seguintes :

• uma frase introdutiva, seguida da lista dos parâmetros da lista (uma frase negativa se não existem parâmetros)
• uma frase indicando o comportamento particular dos parâmetros início / fim se existirem.
• uma frase indicando, se é o caso, que de um dos parãmetros pode ser registado com vários valores (segmentação da lista).
• uma frase indicando, se é o caso, que um filtro dos dados está feito em função do estabelecimento segundo as habilitações do utilizador.
• uma frase indicando, se é o caso, que a lista não pode ser imprimida que sobre uma impressora de tipo particular.

No caso dos sub-programas, é um parágrafo gerado por defeito ao nível (20,30), com o estilo 4, a partir dos dados do dicionário dos sub-programas, afim de permitir listar os parâmetros a passar ao sub-programa.

Código DES (descrição da lista)

Este parágrafo está específico às documentações sobre listas Está criado vazioao nível (40,10), para permitir descrever o conteúdo da lista.

Código CTX (contexto)

Este parágrafo está específico às documentações sobre Worflow, sobre eventos desencadeando as estatísticas, e sobre pontos de entrada.

Para os eventos desencadeantes as estatísticas e o Workflow, este parágrafo está criado vazio ao nível (30,10), para permitir descrever o contexto desencadeante.

Para os pontos de entrada, pode haver vários parágrafos deste tipo. Com efeito, uma documentação sobre ponto de entrada pode integrar vários pontos de entrada, e cada vez, um parágrafo APE definido a partir do nível 20, sub-nível 10, com um incremento de 10 sobre os níveis, está criado. Um parágrafo CTX associado está criado ao mesmo nível que o parâmetro APE correspondente, ao sub-nível 20. A âncora correspondente a estes parágrafos está então CTX_LEV_SLEV, onde LEV é o nível, e SLEV o sub-nível.

A geração da documentação final, este parágrafo integra as frases automaticas assinalando :

• que uma transação está em curso ou não (ligação de tipo TRS do dicionário dos tratamentos, o valor 1 associado significando que não existe transação, o valor 2 significando que existe uma).
• que um ficheiro rasto está aberto ou não (ligação de tipo TRA do dicionário dos tratamentos, o valor 1 associado significando que não existe ficheiro rasto aberto, o valor 2 significando que existe um).

Este parágrafo integra também, sob forma de quadro, uma lista das tabelas em linha. Esta lista é obtida pelas ligações do dicionário de tratamento versus as tabelas, uma ligação de tipo ATB significando que a tabela está aberta em estando preenchido no contexto, uma ligação de tipo AT2assinalando simplesmente que a tabela está aberta. É de notar que estas ligações podem se registar sob a forma CODE_TABLE [ABREVIATION], quando a tabela não está aberta sob a sua abreviação principal.

Código APE (ponto de entrada)

Este parágrafo está específico às documentações sobre pontos entrada.

Para os pontos de entrada, pode haver vários parágrafos deste tipo. Com efeito, uma documentação sobre ponto de entrada pode integrar vários pontos de entrada, e cada vez, um parágrafo APE definido a partir do nível 20, sub-nível 10, com um incremento de 10 sobre os níveis, está criado. A âncora correspondente a estes parágrafos está então APE_LEV_SLEV, onde LEV é o nível, e SLEV o sub-nível. Um parágrafo CTX associado está criado ao mesmo nível que o parágrafo APE correspondente, ao sub-nível 20.

Quando a documentação funcional está gerada a partir do dicionário, o primeiro destes parágrafos está automaticamente criado ao nível 20, sub-nível 10. Os seguintes são criados em espaçando os níveis de 10 em 10. O código dos pontos de entrada está reencontrado por uma ligação de tipo APE, a designação associada dando o código do ponto de entrada. Faz-se eventualmente seguir a ligação de tipo ATB, AT2, TRA, TRS, a ordem de declaração sendo importante (como pode se ter várias ligações APE, as outras ligações são supostas fazerem referência à última ligação declarada).

Este código de ponto de entrada se encontra em seguida no intitulado do parágrafo. Falta imperativamente que este código reste em cabeçalho do título (pode-se completar por um texto explicativo, separado do código por um espaço ou um parenteses aberto). Se esta precaução não está tomada, não se sabe mais gerar corretamente a documentação final.

A geração da documentação final, estes parágrafos integram as frases automaticas assinalando :

• que uma transação está em curso ou não (ligação de tipo TRS do dicionário dos tratamentos, o valor 1 associado significando que não existe transação, o valor 2 significando que existe uma).
• que um ficheiro rasto está aberto ou não (a ligação de tipo TRA do dicionário dos tratamentos, o valor 1 associado significando que não existe ficheiro rasto aberto, o valor 2 significando que existe um).

Integram também, sob forma de quadro, uma lista das tabelas em linha. Esta lista é obtida pelas ligações do dicionário de tratamento versus as tabelas, uma ligação de tipo ATB significando que a tabela está aberta em estando preenchido no contexto, uma ligação de tipo AT2assinalando simplesmente que a tabela está aberta. É de notar que estas ligações podem se registar sob a forma CODE_TABLE [ABREVIATION], quando a tabela não está aberta sob a sua abreviação principal.

Código OPM (modo operatório)

Este parágrafo está específico às documentações sobre documentos automáticos, e sobre secções por defeito. Está criado vazioao nível (30,10), para permitir descrever o modo operatório.

Código FLW (Descrição do fluxo)

Este parágrafo está específico às documentações sobre workflow. Não está nunca criado automaticamente, mas sugere-se de deslocar em (40,10). Sua utilidade está de descrever os encadeametos de workflow no qual este evento toma lugar.

Resumo das estruturas de parágrafo

Para cada tipo de documentação, encontrar-se-á, a seguir, os parágrafos gerados e sua estrutura por defeito (sendo entendido que os gráficos INC, LNK, MIS, e MIN podem ser inseridos livremente).

AFC (doc sobre função)

Esta documentação, criada no directório fct, pode conter os parágrafos seguintes :

ADP (doc sobre parâmetros)

Esta documentação, criada no directório obj, pode conter os parágrafos seguintes :

ACT (doc sobre ações)

Esta documentação, criada no directório obj, pode conter os parágrafos seguintes :

Afetando o parágrafo PRE, falta notar :

• que o seu conteúdo está diretamente visualizado no dicionário das ações, e que é modificável diretamente depois deste dicionário.
• que um texto por defeito (indicando que se trata de uma ação interna não utilizável em desenvolvimento específico) está gerado no parágrafo, se está vazio.

ACV (doc sobre códigos atividade)

Esta documentação, criada no directório obj, pode conter os parágrafos seguintes :

ADM (doc sobre variáveis de dimensionamento)

Esta documentação, criada no directório objeto, pode conter os parágrafos seguintes :

AOE (doc sobre modelos de import/export)

Esta documentação, criada no directório objeto, pode conter os parágrafos seguintes :

ARP (doc sobre listas)

Esta documentação, criada no directório objeto, pode conter os parágrafos seguintes :

AWA (doc sobre Workflow)

Esta documentação, criada no directório objeto, pode conter os parágrafos seguintes :

CDE (doc sobre códigos secção)

Esta documentação, criada no directório objeto, pode conter os parágrafos seguintes :

CDA (doc sobre destinos)

Esta documentação, criada no directório objeto, pode conter os parágrafos seguintes :

GAU (doc sobre documentos automáticos)

Esta documentação, criada no directório objeto, pode conter os parágrafos seguintes :

PS1 (doc sobre desencadeadores estatísticos)

Esta documentação, criada no directório objeto, pode conter os parágrafos seguintes :

ATB (dicionário das tabelas)

Não há que nenhum parágrafo neste tipo de documentação, que está criada no diretório mcd :

AML (dicionário dos menus locais)

Não há que nenhum parágrafo neste tipo de documentação, que está criada no diretório mcd :

ATY (dicionário dos tipos de dados)

Não há que nenhum parágrafo neste tipo de documentação, que está criada no diretório mcd :

ADC (dicionário dos pontos de entrada)

Esta documentação, criada no directório objeto, pode conter os parágrafos seguintes :

ASU (doc sobre sub-programa)

Esta documentação, criada no directório objeto, pode conter os parágrafos seguintes :

Afetando o parágrafo PRE, falta notar :

• que o seu conteúdo está diretamente visualizado no dicionário dos sub-programas, e que está modificável diretamente depois este dicionário.
• que um texto por defeito (indicando que se trata de um sub-programa interno não utilizável em desenvolvimento específico) está gerado no parágrafo, se está vazio.

AGB (logo sobre variáveis)

Esta documentação, criada no directório objeto, pode conter os parágrafos seguintes :

Afetando o parágrafo PRE, falta notar :

• que o seu conteúdo está diretamente visualizado no dicionário das variáveis, e que é modificável diretamente depois este dicionário.
• que um texto por defeito (indicando que se trata de uma variável interna não utilizável em desenvolvimento específico) está gerado no parágrafo, se está vazio.

APM (menus intermediário)

Esta documentação, criada no directório objeto, pode conter os parágrafos seguintes :

AD (Ajuda em linha da linguagem)

Este tipo de documentaação está utilizado nos dois casos :

• quando uma função de tipo Menu existe, a geração cria uma documentação de tipo APM, com um único parágrafo de tipo TIT. A geração final pesquisa a lista das funções associadas ao menu para listar as funções correspondentes. Ligações podem directamente ser acrescentadas no parágrafo neste caso particular (mesma sintaxe que os parágrafos LNK), afim de acrescentar as linhas de menu em seguida daqueles que são encontrados por outro lado no dicionário.
• Todos os menus intermédios associados às documentações diversas (códigos atividades evento Workflow...) são de tipo APM, com um nome começando pelo código associado ao tipo de documentação, seguimento de um caracter "_" e de um qualificante (módulo, família) se necessário para dispor de menus intermediários, o menu principal tendo o código TYPE_0. Por exemplo:
• os menus intermediários associados aos códigos atividade são : ACV_0 (raíz), ACV_1 (códigos atividade associados ao módulo número 1, ACV_2...
• os menus intermediários associados aos parâmetros são : ADP_0 (raíz), ADP_TC (parâmetros da categoria TC), ADP_SUP (parâmetros da categoria SUP)...

De referir que a criação de uma documentação outra permitindo realizar os menus intermédios deve ser feita sob a forma de uma documentação de tipo DI, com os parágrafos seguintes : um parágrafo TIT em (10,10), um parágrafo PRE em (10,20), parágrafo que pode estar vazio, eventualmente um primeiro parágrafo LNK na fila (10,30) para permitir de preencher a barra de título com as ligações de navegação, e um parágrafo LNK com uma fila superior ou igual a 20, para estabelecer a lista dos items de ligações do menu ele-mesmo.

FI (Ficheiros a extrair)

Este tipo de documentação está criada no diretório l4G. Esta documentação tem por momento uma estrutura livre. O único parágrafo obrigatório é:

Quando este único parágrafo existe, nenhuma geração de ficheiro ligado à ficha não está feito, mas o ficheiro ligado, se existe, está extraído sob o nome da documentação. Esta funcionalidade foi feita para permitir uma retoma ao idêntico do doc L4G existente, cada documento sendo visto como um ficheiro na base.

Desde que mais um parágrafo exista (nomeadamente se acrescentam parágrafos de tipos MIS ou MIN), a documentação está criada segundo as regras habituais

De referir que uma documentação cujo código se temina pelos caracteres _D se vê criado com um ficheiro terminando pelo caracter $. Com efeito, para evitar de criar as chaves contendo os caracteres especiais, utiliza-se esta regra de renomeação. Assim, as funções seg$, chr$, getenv$ são elas representadas pelas fichas SEG_D, CHR_D, GETENV_D.

Outros tipos de documentação

Este tipo é particular : trata-se unicamente de um marcador de ficheiros a extrair. As regras de nomeação são as seguintes :

• uma documentação de tipo FI e de código XXXXX_nnn está um marcador de ficheiros a extrair no diretório XXXXX (não importa qual os diretórios standard pode assim estar definido). Pode-se criar tantos parágrafos que se pretende ver para definir por exemplo os grupos de ficheiros diferentes.
• uma documentação "_nnn" é um marcador de ficheiros a extrair em todos os diretórios XXXXX para os quais uma documentação de tipo FI e de código XXXXX_nnn existe. Concretamente, na geração do doc de tipo FI e de código_XXXXXnnn, verifica-se se existem parágrafos de mesmo nível e de mesmo sub-nível na documentação de tipo FI e de code _nnn correspondente (o número deve ser idêntico). Se existem, estes ficheiros são extraidos então. Em seguida, extrai-se os ficheiros ligados ao doc de código "XXXXX_nnn". Assim, pode-se definir uma tal documentação um tronco comum de ficheiros cujos certos podem ser redestruidos pela extração do doc de código "XXXXX_nnn" correspondante.
• a documentação de tipo FI e de código _ (um único caracter "underscore") é um marcador de ficheiros cuja geração impede a criação de ficheiros especificamente no diretorio raíz da ajuda. Quando esta documentação está gerada, extrai-se então no diretório raíz todos os ficheiros anexados às documentações de tipo FI e de código "_nnn" se o primeiro número é 0 (e se o nível e sub-nível correspondem)

Outros tipos de documentações:

Os outros tipos de documentação (DI, IN, CS, DL, AM) são documentações cuja estrutura não está definida (mas cujos directórios de geração são definidos por relação ao tipo). O único parágrafo obrigatório é o parágrafo TIT.

Quando este único parágrafo existe, nenhuma geração de ficheiro ligado à ficha não está feito, mas o ficheiro ligado, se existe, está extraído sob o nome da documentação.

Desde que mais um parágrafo exista (nomeadamente se acrescentam parágrafos de tipos MIS ou MIN), a documentação está criada segundo as regras habituais

Os diretórios de geração são indicados no quadro a seguir:

Os sumários da documentação

Os sumários compõem a documentação são ligados aos tipos de documentação APM Normalmente, apenas um parágrafo existe neste caso :

Este parágrafo pode conter, sob forma de texto, uma lista de códigos de documentação. Neste caso, esta lista está acrescentada como tanto de ligações versus as documentações em questão (o título da documentação ligada retomada na documetação em questão). Isto permite à vez criar os sumários manualmnte, ou de reacrescentar a um sumário existente das ligações suplementares.

Com efeito, no momento da geração da documentação a partir do dicionário, gera automaticamente as documentações de tipo APM, com o limite parágrafo TIT. As codificações das documentações criadas, e os sumários gerados nos documentos criados em geração final, está descrito no quadro a seguir :

Para todos os tipos de documentação outros que aqueles listados acima, é possível de criar uma documentação cujo código será INDEX. Se esta documentação existe, uma ligação realizada diretamente depois cada documentação deste tipo na barra de título. As documentações de tipo IN, DL, por exemplo, utilizam um índice deste tipo.

Gestão das tabelas da documentações.

A estrutura da documentação está guardada na tabela ADOCUMENT. Esta tabela guarda, para cada parágrafo e sub-parágrafo, as suas características (nível, sub-nível, título, código atividade...).

Mas o texto do parágrafo está guardado à parte, na tabela ADOCCLB. Esta tabela não guarda os elementos das chaves do parágrafo, e o texto do parágrafo ele mesmo.

O interesse desta estrutura é a seguinte

• o conjunto dos parágrafos standards da documentaação são gurdados no dossier raíz do supervisor.
• A criação de um dossier, duplica-se no dossier tabela ADOCUMENT, mas em nenhum caso os textos dos documentos eles mesmos
• Todo o acréscimo de um parágrafo específico se faz no dossier filho, os textos anexados sendo guardados no mesmo dossier.
• Toda a modificação de um parágrafo standard provoca a cópia do registo correspondente da tabela ADOCCLB do dossier raíz versus o dossier filho.

Assim, não se guarda que os textos específicos no dossier filho.

Está de mesmo para os textos ligados na ajuda sobre campo : os textos standard são guardados na tabela ADOCFLD do dossier raíz, os textos específicos são guardados no dossier ele mesmo.

A geração da documentação, percorre-se a estrutura guardada no dossier local, e para cada parágrafo tomam-se em prioridade o texto presente no dossier local. Se não existe, retoma-se o texto presente no dossier raíz.