Documentação

• Língua (campo LAN)

Esta zona faz referência à tabela das línguas, e define a língua na qual está escrita a documentação.

• Tipo de doc. (campo TYP)

Este campo define o tipo da documentação. Cada tipo está associado a um tipo de elementos documentados (documentação funcional, descrevendo uma ficha do dicionário ou dos valores de parametrização, descrevendo a estrutura do dicionário, diversos).

Quando um tipo de documentação corresponde a um código objecto, uma entrada Documentação está automáticamente criada na barra de menus do objecto em questão. Pode-se então documentar as fichas registadas no objecto em questão. É porquê a ajuda funcional é o código AFC (código do objeto Funções), a ajuda sobre parâmetros gerais está codificado ADP (código do objectoParâmetros)...

As regras para nomear as documentações são definidas numa documentação anexa.

• Cód. (campo COD)

Este campo define o código da documentação. Corresponde em principio ao código da ficha (função, parâmetro...) que se documenta. As regras para nomear as documentações são definidas numa documentação anexo.

• Nível (campo LEV)

Este nível estabelece uma hierarquia nos parágrafos. Cada primeiro parágrafo de um nível está presente na tabela das matérias principal (salvo se é de tipo MIN).

• Sub-nível (campo SUBLEV)

Este nível estabelece uma sub-hierarquia nos parágrafos. Desde então que existe de um sub-nível por nível de documentação, uma tabela das matérias secundárias está estabelecida no primeiro sub-parágrafo de um nível, fazendo aparecer relações versus os sub-parágrafos seguintes (salvo se o sub-parágrafo é de tipo MIN).

• Parágrafo (campo PAR)

O código parágrafo determina a maneira cuja está gerada o parágrafo no documento final. Pode ser uma simples recópia do texto, ou uma geração mais sofisticadas dependente do dicionário. Uma documentação anexa detalhe dos códigos parágrafos utilizáveis em função do tipo de documentação.

• Ecrã (campo MSK)

Quando um código de ecrã está registado neste campo, um pictograma presente sobre o título do parágrafo na documentação gerada permite de desdobrar uma secção contendo a lista dos campos do ecrã e a ajuda sobre o campo associado. É aconselhável de utilizar então um estilo de paràgrafo igual a 4 (faixa plena sobre a qual o pictograma de desdobramento aparece lisivelmente).

• Descr. (campo TIT)

Este campo é o título do parágrafo. Se está vazio, um título por defeito está atribuido em função do tipo de parágrafo (também em criação que em modificação).

Nos casos dos parágrafos diversos não figuram nas tabelas das matérias (de tipo MIN), o facto de preencher o título com o único caracter " ! "desactiva a inserção de um título.

• Cód. activ. (campo CODACT)

Este código de actividade, herdado do dicionário no momento da regeneração, permite 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 actividade activados sobre o dossier. Deve-se notar que o código actividade FAL (sempre falso) está tido em conta de maneira particular : um parágrafo marcado deste código não é jamais tido em conta pelo tratamento de geração, mesmo se se pede uma geração completa. Isto permite desactivar os parágrafos gerados que não se deseja encontrar numa documentação.

• Módulo (campo MODULE)

Módulo de pertença do parágrafo da documentação.

• Estilo (campo STY)

O estilo faz referência a um valor numérico correspondente a uma balisa "H1","H2","H3"...segundo o número escolhido. Se este campo está vazio, por defeito, é tomado igual a 3. Para sub-parágrafos, é aconselhado de utilizado 4,5 ou 6 segundo o nível. O título 4 é apresentado em faixa: um pictograma dando acesso às ajudas sobre campo e visível se um ecrã está associado ao parágrafo.

• Prioridade tradução (campo PRIO)

• Grupo proprietário (campo CREGRP)

Ce champs permet d'afficher le Groupe créateur de la documentation concernée.

Il n'est disponible que dans les environnements dans lesquels cette notion a été implémentée. Cela concerne les environnements dans lesquels le paramètre utilisateur GRPDEV existe.

NOTE : Le groupe est affiché en Rouge lorsque le groupe de l'utilisateur diffère du groupe créateur trouvé dans la table AOBJGRPDEV

• Validação (campo VLDDAT)

Corresponde à data na qual a ficha foi considerada como validada.

• campo VLDFLG

Este indicador significa que a ficha foi considerada como válida.

• campo TEXTE

Este campo permite de registar o texto do parágrafo tal que aparecerá na documentação final. Os casos particulares devem ser mencionados :

• certos parágrafos não são inseridos tais que eles. É nomeadamente o caso dos parágrafos de título, que contém uma lista de palavras chaves inseridas no código HTML da documentação (rubrica Keywords).
• certos parágrafos são gerados a partir do dicionário. O texto que está registado então em complemento (antes ou após o texto gerado segundo os casos), e não é em geral obrigatório.
• nos documentos de tipo APM (sumários das documentações correspondentes ao nível de menus), o texto registado está interpretado como uma lista de relações suplementares versus as documentações correspondentes (as ligações sendo geradas).