Estrutura de diretórios e arquivos do Axe

A sua instalação do Axe é composta de uma série de pastas e de arquivos, que devem seguir uma estrutura específica refletida no seu arquivo de configuração geral (axe_config.php).

Vamos imaginar que você descompactou o Axe no seu servidor, no diretório /users/fulano/www/blog. No primeiro nível, logo após a descompactação, você verá os 4 diretórios básicos do Axe:

  • /users/fulano/www/blog/axe
  • /users/fulano/www/blog/axethemes
  • /users/fulano/www/blog/axepreview
  • /users/fulano/www/blog/links

Para maior clareza, a partir de agora vamos nos referir a eles apenas pelos nomes (ou seja: axe, axethemes, axepreview e links).

Além dos 4 diretórios acima, a operação do Axe criará junto a eles mais arquivos e diretórios: o feed, o index, as tags e, em um diretório criado para cada ano, os posts em HTML.

Os 4 diretórios básicos do Axe

Os 4 diretórios básicos são criados no momento da descompactação do Axe na pasta em que você vai criar seu blog. Eis as suas funções:

  • axe: armazena o Axe em si (executáveis, bibliotecas e configuração), bem como os arquivos de dados que geram o conjunto de posts, tags, indexes, feed e sitemap a cada rebuild.
  • axethemes: abriga um ou mais temas, que são diretórios contendo o formato do index, dos posts e dos feeds, bem como complementos na forma de estilos CSS, imagens e mais.
  • axepreview: diretório onde são gravadas as versões preliminares de posts para visualização pelo autor, sem publicação.
  • links: diretório para compatibilidade com URLs numéricas (estilo "? p=999") de blogs importados do WordPress.

Estrutura do diretório axe

O diretório axe é o mais importante para o ciclo de vida do seu blog, e no conteúdo dele se destacam:

  • axe.php - é o executável pelo qual você passará, através dos parâmetros do axe.php, todos os seus comandos de publicação e administração do blog.
  • axe_config_exemplo.php - é o exemplo de arquivo de configuração do Axe, que você deve copiar para axe_config.php, no mesmo diretório, e editar de acordo com os dados do seu blog e servidor.
  • staging - é onde você deve gravar seus arquivos-texto de entrada, que serão pré-publicados pelo comando axe.php -d
  • drafts - é onde o Axe armazena os posts pré-publicados pelo comando axe.php -d, prontos para serem pré-visualizados, publicados ou atualizados usando os parâmetros -v, -P e -U do Axe.
  • descriptors - é onde os arquivos de dados correspondentes aos posts e tags são armazenados e catalogados internamente pelo Axe. Os arquivos HTML publicados não residem aqui, e sim no diretório principal do seu blog (no nosso exemplo, /users/fulano/www/blog)
  • plugins - é onde são armazenados os plugins (ainda não documentados).
  • authors - é onde você pode armazenar arquivos descritivos dos autores do seu blog. Por exemplo, se um post tiver como autor "Augusto César Campos", e neste diretório constar um arquivo augusto-cesar-campos.html, o conteúdo dele ficará disponível para exibição junto ao texto, caso o seu tema faça uso da variável de exibição %%POSTBIO%%.

Estrutura do diretório axethemes

Dentro do seu diretório axethemes vem pré-instalado o tema Panzer, criado especificamente para o Axe, com recursos simples de tipografia, uma coluna lateral direita, um cabeçalho e um rodapé.

Ele foi construído para adaptar-se automaticamente a larguras comuns de desktops, smart TVs, tablets e smartphones, e está à sua disposição para edição.

Comece pelo arquivo panzer/footer.php, que é onde estão definidas tanto a barra lateral quanto o rodapé. Não há problema em remover as menções ao Axe que vêm pré-instaladas, a licença open source do Axe permite ツ

As definições de estilo estão todas no arquivo panzer/css/style.css, e as referências ao conteúdo dos seus posts e aos parâmetros do seu blog são feitas por meio das variáveis de exibição, sempre apresentadas entre 2 pares de sinais de percentual. Exemplo: %%POSTAUTHOR%%

Você pode criar outros temas, armazenando-os em diretórios vizinhos ao panzer, dentro do axethemes. Não esqueça de editar o arquivo axe/axe_config.php para ativá-los.

Recomenda-se não editar o tema panzer mantendo-o no mesmo diretório original, pois um upgrade ou reinstalação do Axe irá sobrepor as suas alterações. Mude o seu nome, ou copie-o.

Se os seus temas ficarem legais e você desejar disponibilizá-los sob uma licença open source, entre em contato informando a URL onde os interessados podem encontrá-lo, juntamente com uma screenshot correspondente!