Documenti HTML


La produzione dei documenti html permette la creazione di una documentazione navigabile. E' importante prevedere un sistema di link che permetta all'utente di saltare da una parte all'altra del sito. E' altrettanto importante prevedere una struttura della documentazione.

La documentazione html viene generata seguendo gli standard grafici stabiliti dal sito internet di AR. Il sistema è concepito in modo che questi standard grafici possano essere alterati senza modificare in modo significativo il sistema di produzione della documentazione.

La struttura di navigazione prevista prevede quattro percorsi separati:

  1. Un percorso analitico che segue la struttura del sistema di documentazione. I documenti vengono cercati nell'ambito della propria classe , usando quando è possibile il sistema di categorizzazione.
  2. Ogni manuale è una collection strutturata di documenti. Ogni manuale ha un indice generale. Questo indice rappresenta un percorso di consultazione dei documenti. Percorso che può attraversare liberamente i DCL.
  3. Un percorso guidato basato su pagine di ingresso e di raccordo. Questo percorso è analogo a quello previsto dai manuali e permette di creare una consultazione web friendly della documentazione.
  4. Un percorso di inseguimento che si basa sul sistema dei riferimenti incrociati tra documenti. Ogni documento riporta l'elenco dei:
    1. Documenti a cui appartiene. I documenti padroni sono documenti di determinate classi il cui scopo è quello di raggruppare blocchi di documentazione. Un tipico esempio sono i documenti della classe sys.
    2. Documenti che vengono citati da questo documento.
    3. Documenti che citano questo documento.
  5. Un percorso libero fornito dal motore di ricerca.
req.04okyki • LastModified: 14-9-2007 • John Peter Arnold