Agrupando um conjunto da ajuda JavaHelp
Consulte também
Um conjunto da ajuda JavaHelp fornece arquivos de ajuda que explicam os recursos e a funcionalidade de um módulo.
Para criar um novo conjunto da ajuda JavaHelp:
- Clique com o botão direito do mouse em um projeto de módulo e escolha Novo > Arquivo/Pasta. No assistente para Novo arquivo, escolha Conjunto da ajuda JavaHelp na categoria Desenvolvimento de módulos no NetBeans.
- Na página Local, note os arquivos que serão criados e também note que foram colocados em uma nova pasta chamada docs:
- -about.html. Um arquivo HTML de exemplo que é registrado no arquivo idx.xml, no arquivo map.xml e no arquivo toc.xml.
- -hs.xml. Arquivo Conjunto da ajuda.
- -idx.xml. Arquivo Índice. Usando o ID do mapa criado no arquivo map.xml, você adiciona itens ao arquivo idx.xml, com o nome do tópico que você deseja que seja exibido no índice.
- -map.xml. Arquivo Mapa. Cada arquivo HTML deve ser registrado no arquivo de mapa. O ID do mapa que você cria para o arquivo HTML é usado no arquivo toc.xml e no arquivo idx.xml.
- -toc.html. Arquivo Sumário. Usando o ID do mapa criado no arquivo map.xml, você adiciona itens ao arquivo toc.xml, com o nome do tópico que você deseja que seja exibido no índice analítico.
- -helpset.xml. O arquivo de referência é registrado no arquivo layer.xml.
Observação: Cada um dos nomes acima tem como prefixo o nome do projeto. Por exemplo, se o nome do projeto for myproject, os arquivos acima serão myproject-about.html, myproject-hs.xml, etc.
- Clique em Finalizar.
Opcionalmente, se não desejar incluir no módulo os conjuntos da ajuda JavaHelp padrão do IDE, você pode ocultá-los. Principalmente quando estiver criando um aplicativo rich client com apoio na Plataforma NetBeans, é improvável que você queira que os conjuntos da ajuda JavaHelp do IDE sejam incluídos no aplicativo.
Para ocultar um conjunto da ajuda JavaHelp:
- Na janela Projetos, expanda o nó Arquivos importantes.
- No nó Arquivos importantes, expanda o nó XML de camada e, em seguida, aguarde um momento enquanto os nós são carregados.
- Expanda o nó <this layer in context>.
- Dentro do nó Services/JavaHelp, selecione os nós dos conjuntos JavaHelp que deseja excluir. Escolha Excluir.
No arquivo layer.xml, observe que marcas foram adicionadas, cada uma com um sinalizador _hidden. Quando o módulo está instalado, o sinalizador _hidden informa o IDE, ou o aplicativo incorporado à plataforma NetBeans, para excluir os itens especificados.
- Consulte também
- Sobre o desenvolvimento de módulo e a plataforma NetBeans
- Sobre a plataforma NetBeans
Notificações legais