MANUAL DE UTILIZAÇÃO. Help & Manual Versão Build 2537

Transcrição

1 MANUAL DE UTILIZAÇÃO Help & Manual Versão Build 2537

2 Sumário Introdução... 3 Histórico Tópicos Configuração dos popups Estilos Criação de Estilos Importação de Estilos Variáveis Snippets Comments e Bookmarks Toggles Links Âncoras Hotspots Impict Publicação do Projeto out-12 Pág. 2 / 36

3 Introdução Este documento apresenta informações importantes para o setor de Documentação e Padronização na utilização do Help & Manual. Ele contempla apenas as funcionalidades mais usadas para confecção dos manuais. out-12 Pág. 3 / 36

4 Histórico Data Versão Descrição Autor Criação do documento. 31/10/ Como configurar retângulos, linhas e balões na primeira utilização do Impict. Débora Borges Débora Borges out-12 Pág. 4 / 36

5 1. Tópicos A estrutura do Help & Manual é simples e possui semelhanças com o Explorer e ferramentas de edição de texto como Word e Open Office. Para trabalhar com o Help, é necessária a criação de tópicos, que são organizados no que chamamos de árvore, sendo cada um deles independente. Para criar tópicos na arvore, o usuário deve selecionar um tópico existente e utilizar a opção Add topic (adicionar tópico), na aba Project. O tópico a ser criado pode ser inserido antes (Add before selected Topic), depois (Add after selected Topic) ou dentro (Add child Topic) do tópico selecionado. Através dessa opção também é possível excluir o tópico selecionado: Delete item. Outra forma de realizar essa ação é utilizando o botão direito do mouse sobre o tópico que será usado como referência para adição de um novo item. out-12 Pág. 5 / 36

6 Uma vez determinada a posição do novo tópico, será aberta uma janela para que sejam definidas algumas características do novo tópico, tais como descrição (Topic Heading), ID (Topic ID) e formato do ícone (TOC Icon). O tópico inserido pode ser apenas mais um tópico do projeto, mas também pode ser utilizado para: Fazer um link para outro projeto de Help: Link to External Help Fazer um link para uma página da web: Web Link Incluir um projeto de Help inteiro no projeto corrente: Include Help Project out-12 Pág. 6 / 36

7 Ao acionar o botão OK será criado, no local selecionado, o novo item com a descrição e ID informados. A descrição informada será mostrada na árvore e também na barra de título, localizada na parte superior do tópico. out-12 Pág. 7 / 36

8 out-12 Pág. 8 / 36

9 O ID pode ser visualizado/editado na aba Topic Options. Sua descrição não deve possuir espaços os caracteres especiais. Os botões presentes na barra de navegação têm as opções de Mover para a Esquerda, Mover para Cima, Mover para Baixo e Mover para a Direita, além de editar a descrição do tópico selecionado e out-12 Pág. 9 / 36

10 imprimi-lo. out-12 Pág. 10 / 36

11 O ícone do tópico pode ser alterado depois de sua inclusão. Para isso, selecionar o tópico desejado com o botão direito do mouse e escolher a opção Chance Icon. out-12 Pág. 11 / 36

12 Para que o tópico inserido seja um tópico sem texto, selecioná-lo com o botão direito do mouse e escolher a opção Convert to Chapter Without Text. 2. Configuração dos popups Para fazer um popup, devem ser seguidos os mesmos passos para inserção de um tópico. Depois de criar o tópico, o usuário deve ir à opção Project Files / Topic Files / Topics e procurar pelo tópico que acabou de criar. Na aba Topic Options, o campo Topic Class deve estar configurado com a opção Popup. out-12 Pág. 12 / 36

13 3. Estilos Os estilos são utilizados para definir como será o texto de cada parte da documentação tais como fonte, tamanho, espaçamento, parágrafo etc. O Help permite a criação de estilos ou a importação dos estilos de um projeto existente. 3.1 Criação de Estilos Para criar um estilo, na aba Write, escolher a opção Styles / Edit Styles. Na tela apresentada, é possível adicionar um estilo (botão ) ou remover um estilo (botão ). out-12 Pág. 13 / 36

14 out-12 Pág. 14 / 36

15 A criação do estilo pode também ser feita a partir de uma formatação de um texto previamente digitado. Para isso, escolher a opção Create Style from Selection Importação de Estilos Para importar um estilo, escolher a opção Edit Styles e acionar o botão. Será aberta uma janela do Explorer para que seja escolhido o projeto do qual serão importados os estilos. Essa ação substitui todos os estilos que o projeto atual possui. out-12 Pág. 15 / 36

16 4. Variáveis As variáveis são usadas para inserir textos que geralmente são muito utilizados no arquivo. Ao publicar o projeto, elas são exibidas com o valor que foi indicado no momento de sua configuração. Para criar uma variável, escolher a opção Variable disponível na aba Project. Ao selecionar essa opção, é exibida uma janela com as variáveis existentes no projeto. Para adicionar novas variáveis e editar as existentes, selecionar o botão More, que direciona para o tópico Text Variábles. O usuário pode ir direto nessa opção através do caminho Configuration / Common Properties / Text Variables. Para editar uma variável já existente, modificar o preenchimento do campo Value. Para inserir uma nova, usar o botão Add. out-12 Pág. 16 / 36

17 Para inserir uma variável nos textos, digitar o nome que foi definido para ela (Variable Name) entre os caracteres <% %>. Quando projeto for publicado, será exibido o valor (Value) da variável. Exemplo: <%LOC%> (nome da variável) digitado no projeto LOCALIZAÇÃO (valor da variável) exibido no arquivo publicado 5. Snippets Os snippets são utilizados quando um mesmo tópico precisa ser utilizado várias vezes, ou seja, uma documentação/tela aparece várias vezes. Geralmente esse recurso é utilizado para as telas espelho, evitando que seja necessário manter várias documentações da mesma tela, ou para telas que aparecem out-12 Pág. 17 / 36

18 mais de uma vez no mesmo sistema, como algumas telas de consulta que são iguais as de cadastro, porém com funcionalidades limitadas. Para utilização desse recurso no caso das telas espelho, primeiramente deve existir um arquivo na extensão hmxp. Para criá-lo, basta escolher essa opção na hora de salvar. Ao criar esse arquivo, é criada também uma pasta com vários arquivos de extensão XML, os quais correspondem aos tópicos do projeto. out-12 Pág. 18 / 36

19 Uma vez criado o arquivo, na aba Write, escolher a opção Snippet, que abre a janeja Insert Snippet. A opção From File é utilizada quando o snippet utilizará outro arquivo, que deve obrigatoriamente ter a extensão hxmp. No campo Snippet file, indicar o arquivo XML desejado, que possui a descrição do ID da tela. Esses arquivos ficam dentro da pasta Topics. out-12 Pág. 19 / 36

20 out-12 Pág. 20 / 36

21 Já a opção From Topic é utilizada quando o snippet for do projeto que se está trabalhando. No campo Select topic, informar o ID da tela desejada. Depois de inserido, o snippet se apresenta como uma imagem e não é possível editá-lo. Para edição, é necessário modificar o arquivo fonte. 6. Comments e Bookmarks Os Bookmarks e Comments são utilizados para inserir informações importantes da equipe de Documentação, como quem atualizou uma determinada tela, por que um determinado campo não foi documentado etc. Essas observações somente ficam visíveis quando o arquivo do Help é aberto, não ficando visíveis nos arquivos publicados. Para inserir um Comment, na aba Write, escolher a opção Insert Comment, que abre uma janela para que seja descrita a observação desejada. out-12 Pág. 21 / 36

22 out-12 Pág. 22 / 36

23 O Bookmark é usado para marcar um determinado tópico. Ao fazer essa marcação, é possível vincular uma observação a ela. Para inseri-lo, na aba Project, utilizar a opção Bookmark. 7. Toggles O recurso Toggles é utilizado para inserir informações adicionais para o usuário, que são intituladas de Saiba Mais. Na aba Write, escolher a opção Toggle, exibindo a janela Insert Toggle, que deve ser preenchida de acordo com a figura abaixo: out-12 Pág. 23 / 36

24 out-12 Pág. 24 / 36

25 Depois de inserir o Saiba Mais, formatá-lo conforme os estilos da figura abaixo: out-12 Pág. 25 / 36

26 8. Links O Help permite um dinamismo ao texto com a criação de links. Esses links podem ser internos ou para uma página de internet. É possível fazer links para outros projetos, porém, como liberamos manuais individualmente, não estamos usando essa funcionalidade no momento. Para fazer um link para outro tópico, selecionar o texto onde será feito o link e na aba Write, escolher a opção Link. Isso também pode ser feito através do atalho do teclado Ctrl + L ou ainda arrastando o texto para o tópico desejado. out-12 Pág. 26 / 36

27 8.1 Âncoras As âncoras são usadas para especificar o ponto para o qual se deseja fazer o link. Na aba Write, escolher a opção Insert topic anchor. Essa ação também pode ser feita por meio do atalho do teclado Ctrl + H. É exibida a janela Insert Anchor e no campo Anchor ID deve ser indicado o nome da âncora, que não deve possui espaços ou caracteres especiais. out-12 Pág. 27 / 36

28 A âncora é criada no local onde foi colocado o cursor do mouse e é uma espécie de sublink para o tópico. Ao fazer um link para o tópico em questão, pode-se indicar também uma âncora. Dessa forma, o link irá direcionar exatamente para onde está a âncora e não para o início do tópico. 8.2 Hotspots Os hotspots são links em imagens. Para criá-los, após escolher a imagem que será inserida no manual, acionar o botão, que direciona para a tela Picture Hotspot Editor. out-12 Pág. 28 / 36

29 Nessa tela, são criados os links através da barra de ferramentas existente na parte superior. out-12 Pág. 29 / 36

30 9. Impict O Impict é uma ferramenta de edição de imagem presente no Help & Manual. Para acessá-lo, na aba Project, escolher a opção Impict. out-12 Pág. 30 / 36

31 out-12 Pág. 31 / 36

32 Nos lados direito e esquerdo da ferramenta, há uma série de opções que podem ser utilizadas para edição das imagens. out-12 Pág. 32 / 36

33 out-12 Pág. 33 / 36

34 Normalmente, ao utilizar o Impic pela primeira vez, a cor das linhas e dos balões vem com um padrão diferente do que utilizamos. Para configurá-los corretamente, é necessário seguir os seguintes passos: 1) Desenhar o balão/linha/retângulo; 2) Ir na opção View > Reset Defults para que a barra de ferramentas seja exibida no lado esquerdo da tela; 3) Para os retângulos, Fill tool deve-se escolher a opção Clear. Shap Tool deve estar com Width 2 e Color Vermelho; 4) Para os balões, inserir o balão; 5) A janela Callout Text é exibida. No campo Fill Color é definida a cor do preenchimento do balão e no campo Border Color, a cor da linha do balão; 6) Para mudar a fonte e a cor da letra, clicar no botão Change Font. out-12 Pág. 34 / 36

35 10. Publicação do Projeto Para publicar um manual, na aba Project, escolher a opção Publish. No campo Publish Format, escolher o formato da publicação dentre as opções: HTML Help (.chm), WebHelp, Adobe PDF, Apple ibooks (Epub Format), Microsoft Visual Studio Help, Microsoft Word ou Windows e-book. Após escolher o formato desejado, acionar o botão Publish Now!. out-12 Pág. 35 / 36

36 out-12 Pág. 36 / 36