Documentazione

• Lingua (campo LAN)

Questo campo fa riferimento alla tabella delle lingue, e definisce la lingua nella quale è scritta la documentazione.

• Tipo di doc (campo TYP)

Questo campo definisce il tipo della documentazione. Ogni tipo è associato ad un tipo di elementi documentati (documentazione funzionale, che descrive una scheda del dizionario o dei valori di parametrizzazione, che descrive la struttura del dizionario, diverse).

Quando un tipo di documentazione corrisponde ad un codice oggetto, viene creata automaticamente una voce Documentazione nella barra di menù dell'oggetto in questione. Si può allora documentare le schede inserite nell'oggetto in questione. Ecco perché l'help funzionale è codificato AFC (codice dell'oggetto Funzioni), l'help sui parametri generali è codificato ADP(codice dell'oggetto Parametri)...

Le regole per battezzare le documentazioni sono definite in una documentazione allegata.

• Codice (campo COD)

Questo campo definisce il codice della documentazione. Corrisponde in principio al codice della scheda (funzione, parametro...) che si documenta. Le regole per chiamare le documentazioni sono definite in una documentazione allegata.

• Livello (campo LEV)

Questo livello stabilisce una gerarchia nei paragrafi. Ogni primo paragrafo di un livello è presente nella tabella degli argomenti principale (a meno che non sia di tipo MIN).

• Sotto livello (campo SUBLEV)

Questo sotto livello stabilisce una sotto gerarchia nei paragrafi. Non appena vi è più di un sottolivello per livello di documentazione, viene creata una tabella degli argomenti secondari nel primo sotto paragrafo di un livello, che fa apparire dei collegamenti verso i sotto paragrafi successivi (sempre che il sotto paragrafo sia di tipo MIN).

• Paragrafo (campo PAR)

Il codice paragrafo determina la maniera in cui è generato il paragrafo nel documento finale. Può trattarsi di una semplice copia del testo, o di una generazione più sofisticata dipendente dal dizionario. Una documentazione allegata dettaglia i codici paragrafi utilizzabili in funzione del tipo di documentazione.

• Videata (campo MSK)

Quando si inserisce in questo campo un codice videata, un'icona presente sul titolo del paragrafo nella documentazione generata permette di espandere una sezione contenente l'elenco dei campi della videata e l'help si campo associato. Si consiglia allora di utilizzare uno stile di paragrafo uguale a 4 (riga piena sulla quale l'icona di espansione appare leggibile).

• Descrizione (campo TIT)

Questo campo è il titolo del paragrafo. Se è vuoto, viene attribuito un titolo di default iin funzione del tipo di paragrafo (sia in creazione che in modifica).

Nel caso dei paragrafi diversi che non figurano nelle tabelle degli argomenti (di tipo MIN), il fatto di indicare il titolo con il solo carattere " ! "disattiva l'inserimento di un titolo.

• Codice attività (campo CODACT)

Questo codice attività, ereditato dal dizionario al momento della rigenerazione, permette generalmente di fare la distinzione tra schede standard e specifiche, ma anche di creare delle documentazioni adattate a determinati dossier generando solo i paragrafi e le documentazioni corrispondenti ai codici attività sul dossier. Si noti che il codice attività FAL (sempre falso) viene considerato in maniera particolare: un paragrafo avente questo codice non viene mai preso in conto dall'elaborazione di generazione, anche se si richiede una generazione completa. Ciò permette di disattivare dei paragrafi generati che non si vuole ritrovare in una documentazione.

• Modulo (campo MODULE)

Modulo di appartenenza del paragrafo della documentazione.

• Stile (campo STY)

Lo stile fa riferimento ad un valore numerico corrispondente ad un tag "H1","H2,"H3"... a seconda del numero scelto. Se questo campo è vuoto, di default, assume 3 come valore. Per i sotto paragrafi, si consiglia di utilizzare 4, 5 o 6, secondo il livello. Il titolo 4 viene presentato in una banda: un'icona che dà accesso all'help su campo appare se una videata è associata al paragrafo.

• Priorità traduzione (campo PRIO)

• Gruppo proprietario (campo CREGRP)

Questo campo permette di visualizzare il Gruppo che ha creato la relativa documentazione.

E' disponibile solo negli ambienti nei quali questa nozione è stata implementata. Ciò riguarda quegli ambienti nei quali il parametro utente GRPDEV esiste.

NOTE: Il gruppo appare in Rosso quando il gruppo dell'utente è diverso dal gruppo di creazione trovato nella tabella AOBJGRPDEV

• Validazione (campo VLDDAT)

Corrisponde alla data alla quale la scheda è stata considerata come validata.

• campo VLDFLG

Questo flag significa che la scheda è stata considerata come valida.

• campo TEXTE

Questo campo permette di inserire il testo del paragrafo così come apparirà nella documentazione finale. Alcuni casi particolari vanno menzionati:

• certi paragrafi non sono inseriti tali e quali. E' il caso in particolare dei paragrafi di titolo, che contengono un elenco di parole chiave inserite nel codice HTML della documentazione (campo Keywords).
• certi paragrafi sono generati a partire dal dizionario. Il testo inserito è allora un complemento (prima o dopo il testo generato a seconda dei casi), ed in generale non è obbligatorio.
• nelle documentazioni di tipo APM (sommari delle documentazioni corrispondenti a dei livelli di menù), il testo inserito viene interpretato come un elenco di link supplementari alle documentazioni corrispondenti (i link automatici sono generati).