Visão Geral

Este é um toolkit para criar a navegação para manuais em HTML. Já que a grande maioria dos manuais possui uma estrutura hierárquica simples, implementamos algumas funções em JavaScript para ajudar na criação de vários manuais do Tecgraf - mas não é necessário conhecer JavaScript para usar o WebBook.

Utilizamos a metáfora de um livro: ele é composto por várias páginas, arrumadas em seqüência, com um sumário para localizar determinadas informações. O usuário pode ir para a primeira página, para a seguinte, para a anterior ou para uma página qualquer localizada pelo índice de páginas. A mesma metáfora é utilizada por sistemas comerciais como o HTML Help da Microsoft, usado nas distribuições do MSDN e do TechNet. 

O toolkit oferece todo o suporte necessário para se navegar pelas diversas páginas do livro e permite alternar entre os diferentes idiomas disponíveis. Mas o diferencial do WebBook é sua portabilidade, pois ele depende apenas de um navegador, podendo ser utilizado para qualquer tipo de documentação online e offline. E o melhor: está disponível de graça para todos.

Para entender como o toolkit funciona, consulte o Guia.

O WebBook está disponível em http://www.tecgraf.puc-rio.br/webbook.

Autores

WebBook foi criado por:

Antonio Escaño Scuri
Mark Stroetzel Glasberg

Agradecimentos

Agradecemos a Diego Nehab, pela primeira versão do código JavaScript para o gerenciamento da árvore e a Mark Stroetzel Glasberg pelo conversor para HTML Help da primeira versão do webbook.

A Henrique Pinheiro por várias melhorias na versão 2.

A Nalla Senthilnathan pelo Applet Java de busca simples. A Cristina Ururahy pela ajuda no Applet Java.

Download

webbook302.tar.gz  ou
webbook302.zip

Histórico

Versão 3.0.2 (Dez 2006)

Modificado o Applet Java para funcionar com muitos arquivos. Java não estava conseguindo abrir muitos arquivos simulaneamente nas respectivas threads. Agora abre apenas um arquivos por vez em uma única thread. O código foi atualizado para poder ser compilado em versões atuais do Java.

Versão 3.0.1 (Nov 2006)

Adicionado suporte para uma busca simples usando um Applet Java creado por Nalla Senthilnathan.
Corrigidos os links de download.

Versão 3.0 (Nov 2006)

O arquivo de configuração em Lua está de volta. O código em JavaScript foi reduzido ao minimo. A árvore é agora descrita em Lua, então um script constroi a árvore em HTML com JavaScript somente onde é necessário.

Os frames e a árvore são agora arquivos estáticos em HTML de forma que mecanismos de busca possam facilmente encontrar as páginas internas do manual a partir do frame inicial (index.html).

A barra de ferramentas foi movida para dentro da área da árvore e a barra de título agora possui uma caixa de pesquisa do Google para um determinado site. A localização dos arquivos de configuração mudou da pasta "wb_usr" para a pasta corrente. Visual mais limpo da árvore sem imagens em nós ou folhas (parametros use_items e use_folders não são mais suportados).

O parametro revision_date não é mais usado. Novo parametro search_link deve ser acrescentado. As funções para sincronização automática a partir de links nas páginas de conteúdo não são mais suportadas e devem ser removidas. Veja no Guia como migrar do WebBook 2 para o WebBook 3.

Versão 2.1 (Dez 2004)

Novo script em Lua 3 para gerar um arquivo HTML Help em Windows a partir dos arquivos do WebBook.

Versão 2.0 (Nov 2002)

Árvore totalmente nova, navegação mais rápida, novo design, melhor organização de código, descrição da árvore mais simples em Javascript (independência de Lua).

Versão 1.1 (Ago 2002)

Permite chamadas externas para posicionar em uma determinada página. Ver exemplo.

Versão 1.0 (Jan 2001)

Primeira versão.

Pendências

Licença

Copyright 1994-2009 Tecgraf / PUC-Rio.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.