Il Visualizzatore di documentazione Yelp consente di visualizzare la documentazione relativa a GNOME e ad altri componenti, fornita in diversi formati. Tali formati includono i file docbook, le pagine di aiuto in HTML, le pagine man e le pagine info (il supporto alle pagine man e info è compilato opzionalmente). Indipendentemente dai diversi formati supportati, Yelp cerca di fornire un aspetto uniforme per tutti i formati.
Il Visualizzatore di documentazione Yelp è internazionalizzato, supporta cioè la visualizzazione dei documenti in diverse lingue. I documenti devono essere localizzati o tradotti per ciascuna lingua e installati nel modo appropriato per far sì che il visualizzatore sia in grado di mostrarli.
È possibile avviare il Visualizzatore di documentazione Yelp nei modi seguenti:
Scegliere Aiuto e supporto
Eseguire il seguente comando: yelp
Quando si avvia il visualizzatore di documentazione Yelp, viene mostrata la seguente finestra.
Il visualizzatore di documentazione Yelp contiene i seguenti elementi in Figura 7.1, «Finestra di visualizzatore di documentazione Yelp»
Usare questo menù per aprire una nuova finestra, visualizzare la pagina informazioni sul documento corrente, stampare il documento corrente o chiudere la finestra.
Usare questo menù per copiare, selezionare tutto, trovare testo o impostare le proprie preferenze.
Usare questo menù per spostarsi indietro, avanti o alla pagina principale dell'aiuto. Quando si visualizza un documento DocBook, usare questo menù per spostarsi alla prossima sezione, quella precedente o all'indice.
Usare questo menù per aggiungere o modificare i segnalibri.
Per visualizzare informazioni riguardo Yelp e i contributori al progetto, selezionare F1.
. È possibile aprire questo documento scegliendo o premendoUsare questo pulsante per spostarsi indietro nella cronologia del documento.
Usare questo pulsante per spostarsi avanti nella cronologia del documento.
Usare questo pulsante per ritornare all'indice principale (mostrato in Figura 7.1, «Finestra di visualizzatore di documentazione Yelp»).
Il riquadro di esplorazione è l'area in cui viene mostrato l'indice della la documentazione. Usare l'indice per spostarsi tra la documentazione.
Per aprire un documento con Yelp, utilizzare l'indice per spostarsi al documento desiderato.
In alternativa, è possibile visualizzare un particolare documento avviando Yelp dalla riga di comando o trascinando un file all'interno di Yelp. Per maggiori informazioni, consultare Opening Specific Documents.
Per aprire una nuova finestra:
Fare clic su
→Usare la combinazione di tasti Ctrl+N
Per visualizzare informazioni riguardo il documento aperto:
Fare clic su
→
![]() |
|
Questa opzione è disponibile solo per i documenti DocBook. Di solito tale sezione presenta le note legali ed elenca i contributori alla documentazione. |
Per stampare un intero documento:
Fare clic su
→
![]() |
|
Questa opzione è disponibile solo per i documenti DocBook. |
Per chiudere una finestra in Yelp, procedere come segue:
Fare clic su
→Usare la combinazione di tasti Ctrl+W
Per impostare le proprie preferenze in Yelp:
Fare clic su
→Comparirà una finestra simile a Figura 7.2, «Finestra Preferenze di Yelp»:
Le opzioni presenti in questo dialogo fornisco le seguenti funzioni:
Selezionare questa opzione per visualizzare la documentazione utilizzando i tipi di carattere predefiniti per lo GNOME Desktop.
Per scegliere dei tipi di carattere personalizzati, deselezionare questa opzione e fare clic sui pulsanti accanto alle scritte Larghezza variabile o Larghezza fissa.
Questo è il tipo di carattere da usare quando non è richiesto un carattere statico o a larghezza fissa. La maggior parte del testo è di questo tipo.
Questo è il tipo di carattere da usare quando i caratteri devono essere della stessa dimensione. Questo tipo di carattere viene solitamente usato per identificare comandi, blocchi di codice o qualsiasi altro testo che rientri in queste categorie.
Selezionare questa opzione se si desidera vedere un cursore in Yelp Browser Pane. Questo consente di spostarsi nel documento più facilmente mostrando dove sia localizzato il cursore.
Per andare indietro nella cronologia del documento:
Fare clic su
→Usare la combinazione di tasti Alt+Sinistra
Usare il pulsante Indietro nella barra degli strumenti
Per andare avanti nella cronologia del documento:
Fare clic su
→Usare la combinazione di tasti Alt+Destra
Usare il pulsante Avanti nella barra degli strumenti
Per andare all'indice generale:
Fare clic su
→Usare la combinazione di tasti Alt+Home
Usare il pulsante Argomenti nella barra degli strumenti
Per spostarsi alla sezione precedente:
Fare clic su
→Usare la combinazione di tasti Alt+Su
![]() |
|
Questa opzione è disponibile solamente nei documenti scritti in DocBook. |
Per spostarsi alla sezione successiva:
Fare clic su
→Usare la combinazione di tasti Alt+Giù
![]() |
|
Questa opzione è disponibile solamente nei documenti scritti in DocBook. |
Per al sommario di un documento:
Fare clic su
→
![]() |
|
Questa opzione è disponibile solamente nei documenti scritti in DocBook. |
Per aggiungere un segnalibro per un documento particolare:
Fare clic su
→Usare la combinazione di tasti Ctrl+D
Apparirà una finestra simile a Figura 7.3, «Finestra Aggiungi segnalibro».
Inserire il titolo desiderato per il segnalibro nella casella di testo Titolo. Quindi fare clic su Aggiungi per aggiungere il segnalibro o fare clic su Annulla per annullare la richiesta.
Per modificare i propri segnalibri:
Fare clic su
→Usare la combinazione di tasti Ctrl+B
Apparirà una finestra simile a Figura 7.4, «Finestra Modifica segnalibri».
È possibile gestire i propri segnalibri usando questa finestra nei modi seguenti:
Usare questo pulsante per aprire il segnalibro selezionato in una nuova finestra.
Usare questo pulsante per rinominare il titolo del segnalibro.
Usare questo pulsante per eliminare il segnalibro dalla propria raccolta.
Una volta terminata la gestione dei propri segnalibri, fare clic sul pulsante Chiudi per uscire dalla finestra Segnalibri.
Per aprire un documento, come un file XML, dal gestore di file, aprire il documento nel gestore di file Nautilus oppure trascinare l'icona del documento dalla finestra di Nautilus sul riquadro documento di Yelp oppure sul lanciatore.
Visualizzatore di documentazione Yelp supporta l'apertura di documenti dalla riga di comando. È possibile utilizzare diversi URI (Uniform Resource Identifiers), compresi:
file:
Usare questo URI per accedere a un file con Yelp, per esempio:
yelp file:///usr/share/gnome/help/gcalctool/it/gcalctool.xml
ghelp:
o gnome-help:
Usare questo URI per accedere alla documentazione di aiuto di GNOME, tipicamente scritta nel formato DocBook.
yelp ghelp:gcalctool
Per aprire un documento in una particolare sezione, aggiungere un punto di domanda alla fine dello URI, seguito da un identificativo della sezione.
yelp ghelp:user-guide?yelp-advanced-cmdline
man:
Usare questo URI per accedere a una particolare pagina man. Nel caso ci sia più di una pagina man con lo stesso nome, è possibile aggiungere anche la sezione da visualizzare. Per fare ciò, è necessario inserire il numero della sezione tra parentesi tonde. Sarà quindi necessario fare in modo che la shell non interpreti le parentesi come dei comandi.
yelp man:gcalctool
o
yelp 'man:intro(1)'
yelp 'man:intro(2)'
info:
Usare questo URI per accedere a una particolare pagina GNU info.
yelp info:make
Questa sezione descrive alcune delle applicazioni ausiliarie utilizzate da Visualizzatore di documenti Yelp e fornisce alcune risorse utili per reperire ulteriori informazioni riguardo Visualizzatore di documenti Yelp.
Yelp fa uso di scrollkeeper per generare l'indice per la documentazione DocBook e HTML e per tenere traccia delle traduzioni di ogni singolo documento.
La documentazione fornita con GNOME fa uso di queste utilità per una serie di motivi:
Facilitano la traduzione dei documenti in altre lingue.
Forniscono un insieme di strumenti per aiutare la pacchettizzazione e l'installazione della documentazione nella posizione corretta e per registrare la documentazione con scrollkeeper.
Gestiscono la conversione dal formato DocBook in un formato adatto alla visualizzazione.
Yelp si avvale dei fogli di stile GNOME XSL per la conversione da DocBook a HTML. Gli autori delle applicazioni fanno affidamento sulle GNOME Documentation Build Utilities per installare e registrare la documentazione all'interno del sistema di aiuto.
Per maggiori informazioni su Visualizzatore di documentazione Yelp, consultare il sito web del Progetto di documentazione, http://live.gnome.org/Yelp, o iscriversi alla mailing list gnome-doc-devel-list@gnome.org.
Per aiutare nella stesura e nell'aggiornamento della documentazione per il progetto GNOME, visitare il sito web del Progetto di documentazione: http://live.gnome.org/DocumentationProject