| At line 1 added 47 lines |
| %%(display:none) |
| {{{ |
| WikiUp |
| }}} |
| /% |
| [{TableOfContents }]\\ |
| !!! Dove risiede la documentazione\\ |
| La documentazione risiede in membri di testo presenti in file DOC_xxx. Ciascun file è dedicato ad una famiglia di documenti:\\ |
| * ''DOC''; contiene la documentazione applicativa\\ |
| * ''DOC_VIS''; contiene i documenti visione delle applicazioni\\ |
| * ''DOC_OGG''; contiene la documentazione degli oggetti:\\ |
| ** ''Classi di autorizzazioni'', il membro è denominato A_xxxxxx (xxxxxxx è la classe)\\ |
| ** ''Archivi'', il membro è denominato F_xxxxxx (xxxxxxx è il file)\\ |
| ** ''Oggetti grafici Loocup'', il membro è denominato J1_xxxxxx (xxxxxxx è il componente)\\ |
| ** ''Configurazioni Loocup'', il membro è denominato L_xxxxxx (xxxxxxx è la configurazione)\\ |
| ** ''Oggetti Smeup'', il membro è denominato OG_xx (xx è l'oggetto)\\ |
| ** ''Info di dettaglio su oggetti Smeup'', il membro è denominato OG_xx_D (xx è l'oggetto). _1_Nota_n_; nella documentazione di un oggetto, quando questo è collegato ad un archivio (es. articoli, enti, risorse, ..) viene inserita la chiamata alla documentazione dell'archivio, se invece l'oggetto non è collegato ad un archivio (es. una data, lo schema informazioni, un elemento di settore, ...) viene creato un membro OG_xx_D in cui sono descritti ulteriori dettagli tecnici e implementativi.\\ |
| ** ''Programmi'', il membro è denominato P_xxxxxx (xxxxxxx è il programma)\\ |
| ** ''Tabella Smeup (Settore)'', il membro è denominato TA_xxx (xxx è la tabella)\\ |
| ** ''Valore fisso Smeup'', il membro è denominato V2_xxxxxx (xxxxxxx è il valore fisso)\\ |
| ** ''Valore dinamico Smeup'', il membro è denominato V3_xxxxxx (xxxxxxx è il valore dinamico)\\ |
| * ''DOC_SCH''; contiene la documentazione delle schede\\ |
| * ''DOC_VOC''; contiene la documentazione delle voci (glossari, definizioni, suggerimenti operativi, faq ...)\\ |
| * ''DOC_SER''; contiene la documentazione dei servizi\\ |
| * ''DOC_PRE''; contiene i membri per la creazione di documenti in formato presentazione\\ |
| * ''DOC_BOK''; contiene i membri per la creazione di documenti in formato libro (membri indici di documenti di dettaglio). In particolare il membro "C" contiene la lista dei manuali pubblicati e ul membro "C_USR" contiene le regole di autorizzazione per l'accesso ai manuali via internet.\\ |
| * ''DOC_ESE''; contiene i membri per la creazione di documenti di esempi per la comprensione\\ |
| * ''DOC_TAxxx''; serve per documentare gli elementi di particolari tabelle (es. Tabella B£P delle classi di autorizzazioni), ogni membro corrisponde all'elemento di tabella e il valore XXX nel file corrisponde al settore di tabella: es. DOC_TAB£P.\\ |
| \\ |
| !!! Responsabile di un manuale\\ |
| Il programma di composizione del manuale ricerca anche il responsabile e lo stampa nella copertina del documento. Ogni oggetto Sme.up può essere intestato ad un responsabile e ad uno o più assistenti. L'elenco dei responsabili è cablato in fondo al programma B£AR22.\\ |
| Vedi BASE Lista proprietari oggetti (OJ*PGM-B£AR22)\\ |
| \\ |
| !!! Come si modifica la documentazione\\ |
| Si utilizza il componente grafico di Loocup per la gestione dei testi:\\ |
| [Text editor|MBDOC_OPE-LOCEDT]\\ |
| \\ |
| !!! Elenco macro di documentazione\\ |
| [Elenco MACRO di documentazione|MBDOC-BXDOCU_40]\\ |
| \\ |
| !!! Come si gestiscono le immagini\\ |
| [LATEX - Gestire le immagini|MBDOC-LOCFRM_LTD]\\ |
| \\ |
| !!! Come integrare documentazione specifica del cliente\\ |
| La documentazione specifica del cliente può essere scritta in memebri di documentazione attiva seguiendo le stesse convenzioni e tecniche utilizzate dalla documentazione standard, l'unica differenza è che i membri di coumentazione attiva risiedono nella libreria degli oggetti specifici del cliente (''SME_xxx'').\\ |
| \\ |
| La documentazione attiva può essere anche utilizzata per descrivere altre tipologie di infromazioni utente (es. le procedure operative) in questi casi, dentro la libreria specifica ''SME_xxx''- si utilizza il file ''DOC_PER''.\\ |
