:: Creare l'Help :: |
---|
Si può vedere nelle pagine dedicate alla programmazione di script
Python come risulti semplice realizzare
delle finestre di dialogo che guidino l'utente nell'inserire i dati necessari per una successiva
elaborazione. Si noterà che le finestre di dialogo degli esempi, rispetto ai comandi forniti a
corredo con Grass, sono prive del tasto
Aiuto; si andrà ora ad ovviare a questa mancanza spiegando
passo dopo passo come realizzare i file di help per i propri comandi e in quale cartella
inserirli per permetterne la visualizzazione.
1. Creazione del file di help Non bisogna essere esperti programmatori HTML per creare un file di help con Grass, difatti è sufficiente andare nella finestra del Layer Manager, selezionare il tab Command console e digitare il nome dello script Python seguito dalle seguenti opzioni --html-description. Nella finestra di output superiore verrà mostrato il codice HTML generato per il relativo comando. Nella figura sottostante è riportato il risultato di quanto descritto per lo script v.somma.py.
Con l'apposito tasto Save Output si effettua il salvataggio del testo. A questo punto con un qualsiasi editor di testo si eliminano tutte le parti che precedono il tag <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> e che seguono il tag </html>. Si salva il file con il nome della funzione e estensione ".py.html" cioè se lo script si chiama "v.somma.py" il relativo file di help va denominato "v.somma.py.html". 3. Copia del file di help realizzato nell'apposita cartella Innanzitutto, assicurarsi di avere i privilegi necessari per accedere alla cartella di installazione di Grass, quindi copiare il file nella cartella: InstallazioneGRASS\docs\html. A questo punto avviando il comando personalizzato apparirà il tasto di Aiuto come nell'esempio sotto riportato.
Argomenti correlati:
|