Panoramica del visualizzatore di documentazione Yelp

Il Visualizzatore di documentazione Yelp consente di visualizzare la documentazione relativa a GNOME e ad altri componenti in vari formati. Questi formati includono i file docbook, le pagine di aiuto HTML, le pagine man e le pagine info (il supporto per pagine man e info può essere compilato come opzione facoltativa). Indipendentemente dal formato del documento originale, Yelp cerca di fornire un aspetto uniforme.

Il Visualizzatore di documentazione Yelp è internazionalizzato, ovvero supporta la visualizzazione dei documenti in diverse lingue. I documenti devono essere localizzati o tradotti per ciascuna lingua e installati nel modo appropriato per poter essere visualizzati.

È possibile avviare il Visualizzatore di documentazione Yelp in uno dei modi seguenti:

• Scegliere System (Sistema) → Help (Aiuto).

• Nella riga di comando, digitare yelp.

Interfaccia del Visualizzatore di documentazione Yelp

Nel riquadro del visualizzatore viene visualizzato l'indice o la documentazione. Utilizzare l'indice per individuare la documentazione necessaria.

Il Visualizzatore di documentazione Yelp contiene gli elementi descritti nella seguente tabella.

Barra dei menu

File

Utilizzare questo menu per aprire una nuova finestra, visualizzare la pagina About this Document (Informazioni su questo documento), stampare il documento corrente o chiudere la finestra.

Edit (Modifica)

Utilizzare questo menu per copiare, selezionare, trovare o impostare le preferenze.

Go (Vai)

Utilizzare questo menu per spostarsi avanti o indietro alla pagina principale dell'aiuto. Quando si visualizza un documento docbook, utilizzare questo menu per passare alla sezione successiva, precedente o alla pagina dell'indice.

Bookmarks (Segnalibri)

Utilizzare questo menu per aggiungere o modificare segnalibri.

Help (Aiuto)

Visualizzare informazioni sul Visualizzatore di documentazione Yelp e sui contributori al progetto mediante la voce di menu About (Informazioni). Aprire questo documento dalla voce di menu dei contenuti o premendo F1.

Barra degli strumenti

Back (Indietro)

Spostarsi indietro nella cronologia del documento.

Forward (Avanti)

Spostarsi avanti nella cronologia del documento.

Home (pagina principale)

Ritornare all'indice principale.

Search (cercare)

Cercare in tutti i documenti di aiuto del desktop una parola o frase particolare.

Utilizzo di Yelp

È possibile utilizzare Yelp per eseguire le seguenti azioni:

• Aprire documenti

• Cercare documenti

• Visualizzare la pagina di informazioni di un documento

• Stampare una pagina o un documento

• Impostare le preferenze per utilizzare i documenti

• Aggiungere e modificare i segnalibri

Come aprire un documento mediante l'interfaccia grafica utente

• Aprire un documento mediante il Visualizzatore di documentazione Yelp nei modi seguenti:
  • In un'applicazione, scegliere Help (Aiuto) → Contents (Sommario) e utilizzare l'indice per individuare il documento desiderato.
  • Trascinare un file Docbook XML dal file manager nel lanciatore o finestra Yelp.
  • Premere F1.

  ---

  Suggerimento - Per ricaricare il documento DocBook attualmente aperto, premere Ctrl +R. Questa combinazione di tasti consente di visualizzare le modifiche ai documenti in tempo reale.

  ---

Ricerca di documenti

Questa sezione descrive come cercare documenti.

Come cercare in una pagina corrente

1. Scegliere Edit (Modifica) → Find (Trova) o premere Ctrl+F.

   La barra di ricerca viene visualizzata nella parte inferiore della finestra.

2. Nel campo Find (Trova) della barra di ricerca digitare la parola o la frase che si desidera cercare, quindi premere Invio.

   Se la parola o la frase viene trovata nella pagina, la prima occorrenza viene evidenziata. Premere nuovamente Invio per evidenziare l'occorrenza successiva.

3. (Opzionale) Fare clic su Close (Chiudi) nella barra di ricerca per chiudere.

Come cercare documenti indicizzati

1. Fare clic sul campo Search (Cerca) nella barra degli strumenti o premere Alt+ S.
2. Digitare la parola o la frase che si desidera cercare, quindi premere Invio.

   Viene visualizzato un elenco di tutti i documenti corrispondenti in cui è stata trovata la parola o la frase.

3. Fare clic sul nome del documento per visualizzare una pagina corrispondente.

   Dopo averla visualizzata, fare clic sul pulsante per tornare indietro all'elenco dei risultati della ricerca.

Come aprire una nuova finestra

1. Fare clic su File → New Window (Nuova finestra).
2. Premere Ctrl+N.

Come visualizzare informazioni su un documento DocBook

Questa opzione è disponibile solo per la documentazione DocBook. Le note legali e i contributori alla documentazione sono elencati in questa sezione.

• Scegliere File → About This Document (Informazioni su questo documento) per visualizzare le informazioni sul documento attualmente aperto.

Come stampare la pagina corrente

• Scegliere File → Print this Page (Stampa questa pagina) per stampare la pagina attualmente visualizzata.

Come stampare un documento Docbook

Questa opzione è disponibile solo per la documentazione DocBook.

• Fare clic su File → Print this Document (Stampa questo documento) per stampare un intero documento.

Come chiudere una finestra

• È possibile chiudere una finestra in uno dei seguenti modi:
  • Scegliere File → Close Window (Chiudi finestra).
  • Premere Ctrl+W

Come impostare le preferenze

• Scegliere Edit (Modifica) → Preferences (Preferenze).

  Le seguenti opzioni sono disponibili nella finestra di dialogo Preferences (Preferenze):

  • Use system fonts (Usa tipi di carattere di sistema) – consente di visualizzare la documentazione mediante i tipi di carattere predefiniti utilizzati da Oracle Solaris Desktop. Per scegliere i tipi di carattere preferiti per visualizzare la documentazione, deselezionare questa opzione e fare clic sui pulsanti accanto all'opzione Variable Width (Larghezza variabile) o Fixed Width (Larghezza fissa).

  • Variable Width (Larghezza variabile) – selezionare questo tipo di carattere quando non è richiesto un tipo di carattere con larghezza fissa o statica.

  • Fixed Width (Larghezza fissa) – selezionare questo tipo di carattere quando è necessario che tutti i caratteri di testo siano delle stesse dimensioni. Questo tipo di carattere è utilizzato per indicare comandi, blocchi del programma o altri testi inseriti in queste categorie.

  • Browse with caret (Esplorazione con cursore) – selezionare questa opzione per individuare il cursore mentre si sfoglia il documento.

Come aggiungere un segnalibro

1. Scegliere Bookmarks (Segnalibri) → Add Bookmark (Aggiungi segnalibro) o premere Ctrl+ D.

   Viene visualizzata la finestra Add Bookmark (Aggiungi segnalibro).

2. Digitare un titolo per il segnalibro nel campo apposito.
3. Fare clic su Add (Aggiungi) per aggiungere il segnalibro.

Come modificare i segnalibri

1. Scegliere Bookmarks (Segnalibri) → Edit Bookmarks (Modifica segnalibri) o premere Ctrl+ B.

   Viene visualizzata la finestra Bookmarks (Segnalibri). Fornisce le seguenti opzioni:

   • Open (aprire) – consente di aprire il segnalibro selezionato in una nuova finestra.

   • Rename (rinominare) – consente di rinominare il titolo di un segnalibro.

   • Remove (rimuovere) – consente di eliminare il segnalibro dalla raccolta.

2. Fare clic su Close (Chiudi) per uscire dalla finestra Bookmarks (Segnalibri).

Come visualizzare la guida

• Scegliere Help (Aiuto) → Contents (Sommario) per visualizzare la guida in linea del Visualizzatore di documentazione Yelp.

Esplorazione del Visualizzatore di documentazione Yelp

È possibile esplorare il Visualizzatore di documentazione Yelp Help Browser nei modi seguenti:

• Per tornare indietro nella cronologia documenti:

  • Scegliere Go (Vai) → Back (Indietro).

  • Premere Alt+freccia a sinistra.

  • Utilizzare il pulsante Back (Indietro) nella barra degli strumenti.

• Per spostarsi avanti nella cronologia documenti:

  • Scegliere Go (Vai) → Forward (Avanti).

  • Premere Alt+freccia a destra.

  • Utilizzare il pulsante Forward (Avanti) nella barra degli strumenti.

• Per visualizzare gli argomenti:

  • Scegliere Go (Vai) → Help Topics (Argomenti).

  • Premere Alt+Home.

  • Utilizzare il pulsante Help Topics (Argomenti) nella barra degli strumenti.

• Per visualizzare la sezione precedente:

  • Scegliere Go (Vai) → Previous Section (Sezione precedente).

  • Premere Alt+Su

• Per visualizzare la sezione successiva:

  • Scegliere Go (Vai) → Next Section (Sezione successiva).

  • Premere Alt+Giù

Apertura dei documenti dalla riga di comando

Il Visualizzatore documentazione Yelp consente di supportare l'apertura dei documenti dalla riga di comando. Può essere utilizzato un numero di URI (Uniform Resource Identifiers), tra cui:

-file:

Consente di accedere a un file con Yelp, ad esempio:

yelp file:///usr/share/gnome/help/gcalctool/C/gcalctool.xml

-ghelp: o -gnome-help:

Consente di accedere ai documenti di supporto di GNOME, disponibili in formato DocBook.

yelp ghelp:gcalctool

Se si desidera aprire il documento di supporto in una particolare sezione, aggiungere un punto di domanda al termine dell'URI, seguito dall'ID della sezione.

yelp ghelp:user-guide?yelp-advanced-cmdline

-man:

Consente di accedere a una particolare pagina man. È possibile aggiungere la sezione della pagina man che si desidera visualizzare se sono disponibili più pagine man con lo stesso nome. Il numero della sezione deve essere racchiuso tra parentesi e potrebbe essere 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:

Consente di accedere alla pagina di informazioni GNU.

yelp info:make