This is version 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 . It is not the current version, and thus it cannot be edited.
[Back to current version]   [Restore this version]

Obiettivo#

All'interno dei miglioramenti alla documentazione vogliamo portare tutta la documentazione in una WIKI specifica. Ciò consentirà di avere i seguenti vantaggi:

• Disponibilità della documentazione sempre aggiornata
• Possibilità di ricerca
• Apertura alla successiva contribuzione

Riorganizzazione delprocesso di creazione della documentazione#

Costruttore dell'insieme paragrafi di un oggetto#

Un programma fornisce tutti i paragrafi di un documento richiesto eseguendo

1. Riindirizzo
   • Oggetti deviati
   • Risalita
2. Azioni di omogeneizzazione:
   • Inserimento di TAG mancanti ma assunti
   • Eliminazione di parti errate
   • Trasformazione delle parti ALIAS (esempi forme WIKI in forme SME.up. !!! diventa ::T01)
3. Gestione delle inclusioni
   • Mediante un servizio
   • Di altri membri

Trasformazione di sintassi#

Un programma riceve un paragrafo e restituisce la stringa del paragrafo trasformato nelle sintassi previste:

• WIKI (ISPWiki)
• LATEX
• Standard SME.up

Abbiamo i seguenti tipi di paragrafo

• Principali
  • Titolo
  • Testo
  • Lista puntata o numerata
  • Tabella
  • Oggetto
    • A documenti (Se MB o VO)
    • A oggetti
• Secondari
  • Campo (FLD)

Restano da sviluppare

• Copertina (P.COV HEA)
• Paragrafi
  • Monospace
  • Paragrafi speciali (attuali N01/N04)
  • Immagini

Generazione specifica WIKI#

Cosa generiamo#

• Indici globali (BOOK)
  • Lista dei BOOK
  • Un documento per ogni BOOK
• Documenti specifici
  • Tutti i membri MBDOC_xxx-yyyyyyyy
  • Tutte le voci VOxxx-yyyyy

Identificazione dei documenti WIKI#

• Documenti contenenti testo
  • SM-TpParametro-Oggetto
  • SM-MBDOC_ESE-ESE001
• Documenti di riferimenti
  • SM-TpParametro
  • SM-OGVO
  • SM-

Se riusciremo a portare l'indice come documento di particolari oggetti risolviamo la faccenda.

In tal modo tutti i documenti generati avranno prefisso SM- quindi l'eliminazione potrà essere selettiva.

Funzioni di generazione#

• Scheda (attualmente denominata WIKI)
  • Da completare
• Servizio B£SER_22
  • WIK.FLU genera il flusso di compilazione
  • WIK.DOC genera il contenuto di uno specifico oggetto

Note particolari#

- L'indice viene aggiunto se esistono più di due titoli - Il carattere £ nei nomi dei files viene sostituito con X (pensare a controindicazioni)

Sviluppi#

- Gestione prefisso SM- - Annullamento globale - Generazione di tutti e solo i documenti variati dopo una data. Potremmo generare un documento (non SM- per data indicante tutti i documenti modificati)

Problemi da risolvere#

COMPLETAMENTO A CURA DI OLIVIERO

Upload contenuti in server Wiki#

JspWiki basa il suo complesso di contenuti su files di testo "piatti". Quindi la popolazione del sito implica il posizionamento dei files in una cartella. Abbiamo stabilito di accedere a tale cartella via FTP. Le informazioni gestite al momento nella procedura di upload di un file (che chiameremo "nomefile") sono le seguenti:

• posizionamento della versione precedente del file che si andrà a sovrascrivere (qualora esista una versione in essere del file da fornire) nella cartella chiamata OLD/nomefile chimandolo n.txt (dove n è la versione del file)
• modifica del file page.properties con le informazioni di modifica del file.
  • l'attributo Author.n indica l'autore della modifica che ha portato alla n-esima versione del file "nomefile"
  • ...