O sistema de Ajuda do LibreOffice precisa evoluir e ser mais efetivo para os usuários.

O sistema de Ajuda do LibreOffice foi concebido em 2005. Desde então não evoluiu tecnologicamente, com exceção de uma versão online num servidor wiki (e acessível quando a Ajuda local não está instalada).

Trabalhei recentemente para transformar nosso antigo sistema de Ajuda numa versão moderna para navegadores da internet. O resultado parcial está disponível no website (temporário) https://helponline.libreoffice.org/6.0/pt-BR/text/shared/main0108.html – considere que o trabalho ainda não terminou.

As páginas XML da ajuda são transformadas em HTML “responsivo”, nativo e estático. Esta abordagem possui algumas vantagens:

• Funciona em qualquer navegador moderno
• Apesenta as mesmas funcionalidades do sistema de ajuda local
• Preserva os processos atuais de desenvolvimento, autoria da Ajuda, tradução e lançamento do LibreOffice.
• Possibilidade de ler as páginas da Ajuda no seu celular ou tablet.
• Fica fácil acrescentar marcação nas páginas para melhorar a indexação dos resultados trazidos por buscadores.

A desvantagem é um aumento de espaço em disco no servidor.

Transformar XML em HTML para qualquer navegador

As páginas da ajuda forma feitas quando o padrão de HTML estava na versão 3.2 e, desde então muitos desenvolvimentos nos trouxeram o HTML 5 em todos os principais navegadores. Hoje temos poucas vantagens em manter o XML atual e a maioria de sua funcionalidade pode ser substituída e melhorada com HTML, Javascript e folha de estilos (CSS), como por exemplo adicionar uma navegação melhorada e conteúdo multimídia.

Preservação das funcionalidades da Ajuda

Utilizando folhas de estilos (CSS) e Javascript, foi possível emular e preservar as funcionalidades do sistema de ajuda offline: página, índice, busca e conteúdo.

Dispositivos móveis

Pode-se perguntar por que uma aplicação desktop necessita de um sistema de ajuda que caiba numa tela de celular ou tablet. Na realidade, as páginas da ajuda podem ser abertas não somente pelo seu navegador do desktop mas também ser referenciadas para outros usos – tais como simples navegação na ou serem respostas a uma busca na internet.

Busca na internet

Muitos sabem que as páginas encontradas por um mecanismo de busca depende de uma configuração cuidadosa das páginas HTML, entre outras obrigações. O domínio da otimização para buscadores é uma avenida aberta para melhorias na maneira que escrevemos nosso conteúdo e a configuração apropriada. Opiniões e recomendações da comunidade são bem-vindas nesta área. Para começar a ajuda online contém um conjunto de microdados do schema.org sob a esquema TechArticle.

O que vem pela frente na ajuda do LibreOffice

Mesmo com estas melhorias, uma solução melhor ainda pode ser buscada. O principal problema persiste em encontrar uma ferramenta que possa ajudar a editar o XML da ajuda, e tornar fácil a inserção de multimídia e ou outro conteúdo qualquer. Editar XML puro não é coisa divertida para a maioria das pessoas e é feita em editores de texto simples ou pela antiga extensão Help Authoring. Duas abordagens são possíveis aqui para facilitar o trabalho de escrever páginas de Ajuda:

Melhorar a extensão Help Authoring para tratar as melhorias no conteúdo da ajuda do LibreOffice (por exemplo, multimídia), ou progressivamente migrar para HTML(5) nativo, para beneficiar-se das centenas de editores HTML ‘WYSIWYG’ disponíveis online e como aplicação individual…

A extensão Help Authoring é instalada no LibreOffice para permitir editar uma página da ajuda com o Writer. Sua vantagem é executar uma sequência de checagens do XML, mas ao mesmo tempo torna-se um desafio modernizar as macros Basic, a transformação XSLT e os estilos contidos na extensão.

Por outro lado, a estratégia seria de progressivamente acrescentar novas marcações em HTML puro no DTD (Document Type Definition), lentamente e cuidadosamente afastando-se a marcação complexa do XML. Por exemplo, a marcação XML atual

<paragraph id=”hd_id3147331″ role=”heading” level=”1″ xml-lang=”en-US”>

pode ser substituída seguramente pela conhecida marcação HTML

<h1 id=”hd_id3147331″>

por que sabemos que role=”heading” and level=”1” significa unicamente <h1> e xml-lang não é mais usada. Um ‘de-para’ parcial das marcações XHP para HTML5 encontra-se aqui.

Conclusão

Queremos tornar nossa aplicação de ajuda mais amigável, fornecendo um conteúdo moderno e tronando-se uma referência para o LibreOffice na internet. O novo leiaute da ajuda online é um passo nesta direção, mas muito ainda deve ser feito e a comunidade LibreOffice está convidada a nos ajudar. Participe já!