Visão geral do Yelp Help Browser

O aplicativo Yelp Help Browser permite exibir a documentação relacionada ao GNOME e a outros componentes em uma variedade de formatos. Esses formatos incluem arquivos docbook, páginas de ajuda em HTML, páginas man e páginas informativas (suporte a páginas man e páginas informativas pode, opcionalmente, ser compilado). O Yelp tenta fornecer uma aparência unificada, independentemente do formato original do arquivo.

O Yelp Help Browser é internacionalizado, ou seja, ele pode exibir documentos em vários idiomas. Os documentos devem ser localizados ou traduzidos para cada idioma e instalados para que o Yelp Help Browser possa exibi-los.

Você pode iniciar o Yelp Help Browser de uma das seguintes maneiras:

• Escolha System (Sistema) → Help (Ajuda).

• Na linha de comandos, digite yelp.

Interface do Yelp Help Browser

O painel do navegador exibe o sumário ou a documentação. Use o sumário para navegar para a documentação necessária.

O Yelp Help Browser contém os elementos descritos na tabela a seguir.

Barra de menus

File (Arquivo)

Use esse menu para abrir uma nova janela, exibir a página About this Document (Sobre este documento), imprimir o documento atual ou fechar a janela.

Edit (Editar)

Use esse menu para copiar, selecionar, encontrar ou definir preferências.

Go (Ir)

Use esse menu para navegar para frente ou para trás na página de tópicos da Ajuda. Ao exibir um documento docbook, use esse menu para navegar para a próxima seção, para a seção anterior ou para a página de sumário.

Bookmarks (Indicadores)

Use esse menu para adicionar ou editar marcadores.

Help (Ajuda)

Exiba informações sobre o Yelp Help Browser e os colaboradores do projeto por meio do item de menu About (Sobre). Abra esse documento a partir do item de menu Contents (Conteúdo) ou pressionando F1.

Barra de ferramentas

Back (Voltar)

Retorna ao histórico de documentos.

Forward (Avançar)

Avança no histórico de documentos.

Home (Início)

Retorna ao sumário principal.

Search (Pesquisar)

Pesquisa em todos os documentos de ajuda da área de trabalho uma palavra ou frase específica.

Como trabalhar com o Yelp

É possível utilizar o Yelp para executar as seguintes ações:

• Abrir documentos

• Pesquisar documentos

• Exibir a página About this Document (Sobre este documento) de um documento

• Imprimir uma página ou um documento

• Definir preferências para trabalhar com os documentos

• Adicionar e editar marcadores

Como abrir um documento pela GUI

• Abra um documento por meio do Yelp Help Browser de uma destas maneiras:
  • Em um aplicativo, escolha Help (Ajuda) → Contents (Conteúdo) e use o Sumário para navegar até o documento desejado.
  • Arraste um arquivo Docbook XML do gerenciador de arquivos para a janela ou o acionador do Yelp.
  • Pressione F1.

  ---

  Dica - Para recarregar o documento DocBook que está aberto atualmente, pressione Ctrl +R. Essa combinação de teclas permite exibir as alterações nos documentos à medida que são feitas.

  ---

Pesquisa de documentos

Esta seção descreve com procurar por documentos.

Como pesquisar em uma página atual

1. Escolha Edit (Editar) → Find (Localizar) ou pressione Ctrl+F.

   A barra de pesquisa aparece na parte inferior da janela.

2. No campo Find (Localizar) na barra de pesquisa, digite a palavra ou frase que deseja procurar e, em seguida, pressione Return.

   Se a palavra ou frase for encontrada na página, a primeira ocorrência será destacada. Pressione Return novamente para destacar a ocorrência seguinte.

3. (Opcional) Clique em Close (Fechar) na barra de pesquisa para fechá-la.

Como pesquisar documentos indexados

1. Clique no campo Search (Pesquisar) na barra de ferramentas ou pressione Alt+S.
2. Digite a palavra ou frase que deseja pesquisar e, em seguida, pressione Return.

   Uma lista de todos os documentos correspondentes nos quais a palavra ou frase foi encontrada é mostrada.

3. Clique o nome do documento para exibir a página correspondente.

   Após exibir uma página correspondente, clique no botão Back (Voltar) na barra de ferramentas para retornar à lista de resultados de pesquisa.

Como abrir uma nova janela

1. Clique em File (Arquivo) → New Window (Nova janela).
2. Pressione Ctrl+N.

Como exibir informações sobre um documento DocBook

Esta opção só está disponível para a documentação DocBook. Os avisos legais e os colaboradores da documentação estão listados nesta seção.

• Escolha File (Arquivo) → About This Document (Sobre este documento) para exibir as informações sobre o documento aberto atualmente.

Como imprimir a página atual

• Escolha File (Arquivo) → Print this Page (Imprimir esta página) para imprimir a página que você está exibindo no momento.

Como imprimir um documento Docbook

Esta opção só está disponível para a documentação DocBook.

• Clique em File (Arquivo) → Print this Document (Imprimir este documento) para imprimir um documento inteiro.

Como fechar uma janela

• É possível fechar uma janela de uma das seguintes maneiras:
  • Escolha File (Arquivo) → Close Window (Fechar janela).
  • Pressione Ctrl+W

Como definir preferências

• Escolha Edit (Editar) → Preferences (Preferências).

  As seguintes opções estão disponíveis na caixa de diálogo Preferências:

  • Use system fonts (Usar fontes de sistema) – Exiba a documentação usando as fontes padrão usadas pelo Oracle Solaris Desktop. Para escolher suas próprias fontes para exibir documentação, desmarque esta opção e clique nos botões próximos a Variable Width (Largura variável) ou Fixed Width (Largura fixa).

  • Variable Width (Largura variável) – Selecione esta fonte quando uma largura estática ou fixa não é necessária.

  • Fixed Width (Largura fixa) – Selecione esta fonte quando for preciso que todos os caracteres de texto sejam do mesmo tamanho. Esta fonte é usada para indicar comandos, blocos de programas ou outros textos que incluídos nessas categorias.

  • Browse with caret (Navegar com o cursor) – Selecione esta opção para localizar o cursor enquanto estiver navegando pelo documento.

Como adicionar um marcador

1. Escolha Bookmarks (Marcadores) → Add Bookmark (Adicionar marcador) ou pressione Ctrl+D.

   A janela Add Bookmark (Adicionar marcador) é exibida.

2. Digite um título de marcador desejado no campo Title (Título).
3. Clique em Add (Adicionar) para adicionar o marcador.

How to Edit Bookmarks (Como editar marcadores)

1. Escolha Bookmarks (Marcadores) → Edit Bookmarks (Editar marcadores) ou pressione Ctrl+B.

   A janela Bookmarks (Marcadores) é exibida. Ela fornece as seguintes opções:

   • Open (Abrir) – Abre o marcador selecionado em uma nova janela.

   • Rename (Renomear)– Renomeia o título de um marcador.

   • Remove (Remover) – Excluir o marcador do conjunto.

2. Clique em Close (Fechar) para sair da janela Bookmarks (Marcadores).

Como exibir a Ajuda

• Escolha Help (Ajuda) → Contents (Conteúdo) para exibir a ajuda on-line do Yelp Help Browser.

Navegação no Yelp Help Browser

Você pode navegar dentro do Yelp Help Browser da seguinte maneira:

• Para retornar ao histórico de documentos:

  • Escolha Go (Ir) → Back (Voltar).

  • Pressione Alt+tecla de seta para a esquerda.

  • Use o botão Back (Retornar) na barra de ferramentas.

• Para avançar no histórico de documentos:

  • Escolha Go (Ir) → Forward (Avançar).

  • Pressione Alt+tecla de seta para a direita.

  • Use o botão Forward (Avançar) na barra de ferramentas.

• Para ir para os tópicos da Ajuda:

  • Escolha Go (Ir) → Help Topics (Tópicos da ajuda).

  • Pressione Alt+Home.

  • Use o botão Help Topics (Tópicos da ajuda) na barra de ferramentas.

• Para ir para a seção anterior:

  • Escolha Go (Ir) → Previous Section (Seção anterior).

  • Pressione Alt+Up

• Para ir para a próxima seção:

  • Escolha Go (Ir) → Next Section (Próxima seção).

  • Pressione Alt+Down

Abertura de documentos na linha de comandos

O Yelp Help Browser permite abrir documentos na linha de comandos. Vários URIs (Uniform Resource Identifiers) podem ser usados, incluindo os seguintes:

-file:

Acessa um arquivo com o Yelp, por exemplo:

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

-ghelp: ou -gnome-help:

Acessa os documentos de ajuda do GNOME, que estão no formato DocBook.

yelp ghelp:gcalctool

Caso queira abrir o documento de ajuda em uma seção em particular, anexe um ponto de interrogação no fim do URI, seguido pelo ID de sessão.

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

-man:

Acessa uma página man específica. Você pode anexar a seção da página man que gostaria de exibir se houver várias páginas man com o mesmo nome. O número da seção deve estar entre parênteses e é possível que você tenha de escapar o argumento para que o shell não interprete o parênteses.

yelp man:gcalctool

ou

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

-info:

Acessa a página informativa do GNU especificada.

yelp info:make