Descripción general del visor de ayuda Yelp

El visor de ayuda Yelp permite ver documentación relacionada con GNOME y otros componentes en diferentes formatos. Entre estos formatos, se incluyen archivos docbook, páginas de ayuda HTML, páginas del comando man y páginas de información (es posible que se compile opcionalmente la compatibilidad con páginas del comando man y páginas de información). Yelp intenta proporcionar un aspecto unificado independientemente del formato original del documento.

El visor de ayuda Yelp está internacionalizado, lo que significa que permite ver documentos en diferentes idiomas. Los documentos deben estar localizados o traducidos en cada idioma, y deben estar instalados en el visor de ayuda Yelp para poder verlos.

Puede iniciar el visor de ayuda Yelp de una de las siguientes formas:

• Seleccione System (Sistema) → Help (Ayuda).

• En la línea de comandos, escriba yelp.

Interfaz del visor de ayuda Yelp

El panel del visor muestra la tabla de contenido o la documentación. Use la tabla de contenido para desplazarse a la documentación que necesita.

El visor de ayuda Yelp contiene los elementos que se describen en la siguiente tabla.

Barra de menús

File (Archivo)

Utilice este menú para abrir una nueva ventana, ver la página About this Document (Acerca de este documento), imprimir el documento actual o cerrar la ventana.

Edit (Editar)

Utilice este menú para copiar, seleccionar, buscar o establecer preferencias.

Go (Ir)

Utilice este menú para retroceder o avanzar a la página Help Topics (Temas de ayuda). Al visualizar un documento docbook, utilice este menú para desplazarse a la siguiente sección, a la sección anterior o a la página de contenido.

Bookmarks (Marcadores)

Utilice este menú para agregar o editar marcadores.

Help (Ayuda)

Permite ver información acerca del visor de ayuda Yelp y los colaboradores del proyecto con la opción de menú About (Acerca de). Para abrir este documento, utilice la opción de menú Contents (Contenido) o presione F1.

Barra de herramientas

Back (Atrás)

Permite retroceder en el historial de documentos.

Forward (Adelante)

Permite avanzar en el historial de documentos.

Home (Inicio)

Permite volver a la tabla de contenido principal.

Search (Buscar)

Permite buscar una palabra o frase específica en todos los documentos de ayuda del escritorio.

Uso de Yelp

Puede utilizar Yelp para realizar las siguientes acciones:

• Abrir documentos

• Buscar documentos

• Ver la página About this Document (Acerca de este documento) de un documento

• Imprimir una página o un documento

• Establecer preferencias para trabajar con documentos

• Agregar y editar marcadores

Cómo abrir un documento mediante la GUI

• Abra un documento a través del visor de ayuda Yelp de las siguientes maneras:
  • En una aplicación, seleccione Help (Ayuda) → Contents (Contenido) y utilice la tabla de contenido para desplazarse al documento deseado.
  • Arrastre un archivo XML DocBook del gestor de archivos al programa de ejecución o la ventana de Yelp.
  • Presione F1.

  ---

  Consejo - Para volver a cargar el documento DocBook abierto, presione Ctrl+R. Esta combinación de teclas permite ver los cambios en los documentos a medida que se realizan.

  ---

Búsqueda de documentos

En esta sección, se describe cómo buscar documentos.

Cómo realizar búsquedas en la página actual

1. Seleccione Edit (Editar) → Find (Buscar) o presione Ctrl+F.

   La barra de búsqueda aparece en la parte inferior de la ventana.

2. En el campo Find (Buscar) de la barra de búsqueda, escriba la palabra o frase que desea buscar y, a continuación, presione Intro.

   Si se encuentra la palabra o frase en la página, se resalta la primera aparición. Presione Intro de nuevo para resaltar la siguiente aparición.

3. (Opcional) Haga clic en Close (Cerrar) en la barra de búsqueda para cerrarla.

Cómo realizar búsquedas en documentos indexados

1. Haga clic en el campo de búsqueda de la barra de herramientas o presione Alt+S.
2. Escriba la palabra o frase que desea buscar y, a continuación, presione Intro.

   Se muestra una lista de todos los documentos donde aparece la palabra o frase.

3. Haga clic en el nombre del documento para ver una página con coincidencias.

   Cuando haya terminado de ver la página con coincidencias, haga clic en el botón Back (Atrás) de la barra de herramientas para volver a la lista de resultados de búsqueda.

Cómo abrir una ventana nueva

1. Haga clic en File (Archivo) → New Window (Ventana nueva).
2. Presione Ctrl+N.

Cómo mostrar información sobre un documento DocBook

Esta opción sólo está disponible para la documentación DocBook. Los avisos legales y los colaboradores de la documentación se muestran en esta sección.

• Seleccione File (Archivo) → About This Document (Acerca de este documento) para ver información sobre el documento abierto.

Cómo imprimir la página actual

• Seleccione File (Archivo) → Print this Page (Imprimir esta página) para imprimir la página que está viendo.

Cómo imprimir un documento DocBook

Esta opción sólo está disponible para la documentación DocBook.

• Haga clic en File (Archivo) → Print this Document (Imprimir este documento) para imprimir un documento completo.

Cómo cerrar una ventana

• Puede cerrar una ventana de cualquiera de las siguientes formas:
  • Seleccione File (Archivo) → Close Window (Cerrar ventana).
  • Presione Ctrl+W.

Cómo establecer preferencias

• Seleccione Edit (Editar) → Preferences (Preferencias).

  Están disponibles las siguientes opciones en el cuadro de diálogo Preferences (Preferencias):

  • Use system fonts (Usar tipografía del sistema): muestra la documentación con las fuentes predeterminadas que utiliza Oracle Solaris Desktop. Si desea elegir sus propias fuentes para mostrar la documentación, anule la selección de esta opción y haga clic en los botones junto a Variable Width (Anchura variable) o Fixed Width (Anchura fija).

  • Variable Width (Anchura variable): seleccione esta fuente cuando no se necesite una fuente de ancho estático o fijo.

  • Fixed Width (Anchura fija): seleccione esta fuente cuando todos los caracteres del texto deban ser del mismo tamaño. Esta fuente se utiliza para indicar comandos, bloques de programas u otro texto que se incluye en estas categorías.

  • Browse with caret (Examinar con cursor): seleccione esta opción para ubicar el cursor al examinar el documento.

Cómo agregar un marcador

1. Seleccione Bookmarks (Marcadores) → Add Bookmark (Añadir marcador) o presione Ctrl+D.

   Aparece la ventana Add Bookmark (Añadir marcador).

2. Escriba el marcador deseado en el campo Title (Título).
3. Haga clic en Add (Añadir) para agregar el marcador.

Cómo editar marcadores

1. Seleccione Bookmarks (Marcadores) → Edit Bookmarks (Editar marcadores) o presione Ctrl+B.

   Aparece la ventana Bookmarks (Marcadores). Proporciona las siguientes opciones:

   • Open (Abrir): permite abrir el marcador seleccionado en una ventana nueva.

   • Rename (Renombrar): permite cambiar el nombre del título de un marcador.

   • Remove (Eliminar): permite suprimir el marcador de la colección.

2. Haga clic en el botón Close (Cerrar) para salir de la ventana Bookmarks (Marcadores).

Cómo mostrar la ayuda

• Seleccione Help (Ayuda) → Contents (Contenido) para ver la ayuda en pantalla del visor de ayuda Yelp.

Navegación por el visor de ayuda Yelp

Puede navegar por el visor de ayuda Yelp de la siguiente manera:

• Para retroceder en el historial de documentos:

  • Seleccione Go (Ir) → Back (Atrás).

  • Presione Alt+tecla de flecha izquierda.

  • Utilice el botón Back (Atrás) de la barra de herramientas.

• Para avanzar en el historial de documentos:

  • Seleccione Go (Ir) → Forward (Adelante).

  • Presione Alt+tecla de flecha derecha.

  • Utilice el botón Forward (Adelante) de la barra de herramientas.

• Para ir a los temas de ayuda:

  • Seleccione Go (Ir) → Help Topics (Temas de ayuda).

  • Presione Alt+Inicio.

  • Utilice el botón Help Topics (Temas de ayuda) de la barra de herramientas.

• Para ir a la sección anterior:

  • Seleccione Go (Ir) → Previous Section (Sección anterior).

  • Presione Alt+Arriba.

• Para ir a la sección siguiente:

  • Seleccione Go (Ir) → Next Section (Sección siguiente).

  • Presione Alt+Abajo.

Apertura de documentos desde la línea de comandos

El visor de ayuda Yelp permite abrir documentos desde la línea de comandos. Es posible usar diferentes URI (identificadores uniformes de recursos), por ejemplo:

-file:

Permite acceder a un archivo con Yelp, por ejemplo:

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

-ghelp: o -gnome-help:

Permite acceder a los documentos de ayuda de GNOME, escritos en formato DocBook.

yelp ghelp:gcalctool

Si desea abrir el documento de ayuda en una sección concreta, agregue un signo de interrogación al final del URI, seguido del ID de sección.

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

-man:

Permite acceder a una página del comando man específica. Puede agregar la sección de la página del comando man que desea ver si hay varias páginas del comando man con el mismo nombre. El número de sección debe ir entre paréntesis y es posible que tenga que agregar caracteres de escape en el argumento para que el shell no interprete los paréntesis.

yelp man:gcalctool

o

yelp 'man:intro(1)'
yelp 'man:intro(2)'

-info:

Permite acceder a la página de información de GNU especificada.

yelp info:make