DokuWiki

Este documento descreve o motor Wiki (WikiEngine) em uso neste SiteWiki.

No site oficial do DokuWiki, existem os seguintes documentos importantes:

• Lista de Novas Funcionalidades pedidas pelos utilizadores.
• Comparação de Funcionalidades com outros motores Wiki.

Do conjunto das diversas características deste WikiEngine, estas são as que mais se evidenciam:

• É desenvolvido com base na linguagem PHP.
• É licenciado com a licença OSI-compliant GPL - Free and Open-Source Software License.
• Não requer um motor de base de dados, pois guarda o conteúdo em bruto em Raw Text Files, que só por si já constituem informação útil e prática. Pode-se, por exemplo, usar este conteúdo em bruto noutros sistemas ou aplicações, sem ser necessário qualquer funcionalidade de exportação; pode-se, também, visualizar este conteúdo em bruto em editores de texto.
• Segue os standards XHTML 1.0 Transitional e CSS Level 2, obedecendo às regras de validação da W3C.
• Incorpora um RSS Feeder, compatível com a norma RSS 1.0.
• Opcionalmente, notifica o administrador do SiteWiki de alterações aos documentos.
• Incorpora um Editor GUI, bastante útil e prático, que ajuda imensa na utilização das regras de formatação do texto mais adequadas. As próprias regras de formatação são muito intuitivas e simples de aprender.
• Detecta conflitos de edição no documento. No entanto, cada autor tem um dado tempo limite que lhe permite editar o documento sem conflitos. Este tempo pode ser re-inicializado após se prever o conteúdo através do Editor GUI.
• Avisa o autor que o conteúdo editado ainda não foi guardado, caso o autor tente sair da edição do documento sem gravar.
• Permite editar secções de uma página, separadas por cabeçalhos.
• Cria automaticamente uma tabela de conteúdos em cada página (pode ser desligada).
• Reconhece código-fonte em diversas linguagens (Syntax Highlight).
• Reconhece ligações a pastas partilhadas por sistemas Windows (Windows Shares).
• Reconhece, opcionalmente, palavras CamelCase como sendo ligações a outras páginas Wiki (WikiPages).
• Agrupa documentos sobre um mesmo assunto um pastas, designadas por namespaces.
• Instalação simples, bastando editar um ficheiro de configuração.
• Gera documentos HTML estáticos, que servem de cache a documentos sem alterações durante um dado período.

Estas funcionalidades ainda não existem neste excelente motor Wiki (WikiEngine):

• BackLinks - A futura release irá incluir esta capacidade.
• Orphan/Wanted Pages - O motor de pesquisa precisa de ser melhorado para encontrar não só os BackLinks mas também as páginas orfãs ou não existentes. A futura release irá incluir esta capacidade.
• Page Deletion/Rename - Uma página pode ter sido criada sem que tenha o nome mais indicado. Um botão Rename iria permitir renomear uma página (e todos os seus backlinks), e caso o novo novo fosse vazio a página seria removida do sistema do ficheiros (sem actualizar os backlinks). Ou então, na página índice, botões à frente de cada página permitem apagar a página ou renomear a página e todos os seus backlinks. Este processo é bastante complicado, e talvez por principio, não se deva permitir apagar páginas nem renomear. Qualquer página nestas condições deve ter o conteúdo editado, indicando tratar-se uma página antiga sem evolução e qual a nova página com esse conteúdo. Qual a melhor prática em Wiki sobre este tópico?
• Edit / View Page Buttons - Numa página que está a ser vista, o botão deve indicar Edit, mas numa página que está a ser editada o botão deve indicar View. A futura release irá incluir esta capacidade.
• Read-Only Pages - Numa página protegida contra escrita, o botão deve indicar See Raw, para permitir ver o conteúdo não formatado da página.
• Recent Changes - Mostrar as modificações mais recentes às páginas do namespace corrente e dos seus sub-namespaces. Somente quando se está no namespace de topo é que o botão deve indicar All Recent Changes.
• Index - Mostrar as páginas do namespace corrente e dos seus sub-namespaces. Somente quando se está no namespace de topo é que o botão deve indicar Full Index.
• Page Content Template - O editor GUI mostra para o namespace corrente, quais as templates disponíveis que servem de base ao conteúdo das suas páginas. Ao escolher uma template, o texto é automaticamente inserido, sem remover o texto existente.
• Diff Enhanced - Além de se corrigir o bug de Editing Conflict Save, a página de Revisões deve facilitar a comparação duas revisões quaisquer, sem forçar a que uma dela seja a revisão actual.
• Edit Summary - Todas as revisões gravadas como sendo um minor update não devem pertencer à lista de revisões do documento? No entanto todas as revisões devem ter uma indicação (um sumário) das alterações efectuadas, para ser mais fácil encontrar uma dada página na lista de revisões. Esta funcionalidade quando ligada, não deve permitir que se grave uma nova revisão sem sumário da edição.
• Text Search/Replace - O editor GUI deve permitir que um texto seja encontrado e substituído por outro, se possível usando expressões regulares POSIX (GNU sed).