Criar ajuda do guia do usuário

Os documentos de ajuda do guia do usuário são agrupados em seções apropriadas na página e listados em uma ordem configurável. Adicione suas seções a uma página de ajuda.

Antes de Iniciar

Crie todos os seus documentos de ajuda a partir do registro da seção. Isso permite refinar os títulos, ajustar o posicionamento e decidir se são apropriados para a seção.

Função necessária: administrador

Procedimento

1. Crie uma página.
   1. Navegar até Guia do Usuário do sistema > Administração > Páginas da Ajuda e clique em Novo.
   2. Preencha o formulário.

      Tabela 1. Definições de campo da página de ajuda

      Campo	Descrição
      ID	Identificação de página usada pelo sistema para criar uma URL de ajuda.
      Aplicação	Escopo da aplicação para esta página de ajuda. Este campo é somente leitura e o padrão é o escopo Global.
      Título	Título de exibição desta página.

   3. Clique em Enviar.

      

2. Crie seções da página de ajuda e associe-as à página.
   1. Navegar até Guia do Usuário do sistema > Administração > Seções da Página da Ajuda e clique em Novo.

      

   2. Dê à sua seção um título exclusivo e conciso e clique em Enviar.
      A exibição retorna para a lista de seções.
   3. Crie seções adicionais para sua página de ajuda.
   4. Navegar até Guia do Usuário do sistema > Administração > Páginas da Ajuda e abra sua nova página.
   5. Na lista relacionada Página para seções, clique em Novo.
   6. Preencha o formulário.

      Tabela 2. Definições de campo de página para seção

      Campo	Descrição
      Coluna	Local da coluna na página desta seção. A primeira coluna é designada como 0 e a segunda coluna é designada como 1. Deve haver pelo menos uma entrada para a coluna 0 para que as seções sejam exibidas.
      Ordem	Ordem na qual as seções são exibidas nas colunas da página. Se nenhum número de ordem for definido, o sistema listará as seções em ordem alfabética.
      Aplicação	Escopo da aplicação para este registro. Este campo é somente leitura e o padrão é o escopo Global.
      Página	Página da Ajuda na qual esta seção aparece. Você pode usar o campo de pesquisa para mudar a página em que uma seção aparece.
      Seção	Nome da seção a ser exibida na página selecionada.

      

   7. Clique em Enviar.
   8. Opcional: Adicione seções à página de ajuda conforme necessário.
3. Crie um ou mais documentos.
   1. Navegar até Guia do Usuário do sistema > Administração > Seções da Página da Ajuda.
   2. Abra um registro de seção que você criou.
   3. Na lista relacionada Ajuda, clique em Novo para criar um documento de ajuda para essa seção.
   4. Preencha o formulário.

      Tabela 3. Definições do campo do documento de ajuda

      Campo	Descrição
      Número	Número do documento gerado automaticamente pelo sistema.
      Seção	Seção na qual este documento aparece.
      Ordem	Ordem de listagem deste documento na seção selecionada.
      Publicado	Data em que este documento foi criado.
      Atualizado em	Data em que este documento foi atualizado pela última vez.
      Descrição resumida	Breve descrição do conteúdo deste documento. Esta descrição é usada como o título do documento na página de ajuda.
      Texto	Conteúdo do documento, incluindo gráficos e tabelas. Você pode formatar sua entrada, criar listas com marcadores ou numeradas e anexar imagens.

      

   5. Clique em Enviar.
   6. Repita o processo para criar os documentos de ajuda necessários para essa seção.