O Formato Asciidoc

  1. blog
  2. asciidoc
  3. desenvolvimento-web
  4. jbake

 10 March 2015    J.A. Gaeta Mendes    

Apresentação

Asciidoc é um formato de documento de texto para escrever notas, documentação, artigos, livros, _ebooks, apresentações, páginas da web, páginas de manual (man pages) e blogs, podendo ser convertido em diversos outros formatos, tais como HTML, PDF, EPUB e páginas de manual.

Finalidade deste documento

O propósito deste artigo é demonstrar as inúmeras vantagens de edição no formato Asciidoc, como esta caixa para destaque de texto, por exemplo.

Uma outra funcionalidade muito da hora do formato Asciidoc são os blocos de advertência, incluindo ícones da biblioteca font awsome icons, conforme podemos ver no exemplo a seguir:

Um parágrafo de advertência atrai a atenção do leitor para alguma informação auxiliar. Seu propósito é representado por um ícone no início do parágrafo. O efeito do destaque é mesmo perfeito para editoração eletrônica e sua implementação é extremamente versátil.

Aqui estão outros tipos de advertência pré-formatadas:

Uma dica…​
Não se esqueça…​
Atenção para…​
Cuidado com…​

Muito bacana, não é mesmo…​ e tudo isso pode ser feito num editor de texto puro, como vim, emacs, leafpad, bloco de notas do windows, enfim, você pode se concentrar apenas no texto, bastando algumas marcações semelhantes aos formatos Markdown para fazer a mágica.

O editor Atom tem um plugin que permite ir visualizando o resultado à medida em que você vai escrevendo. É o meu preferido para editar esse tipo de arquivo.

Veja mais um exemplo, agora de uma citação famosa:

Oitenta e sete anos atrás, nossos pais ergueram neste continente uma nova nação…​

— Abraham Lincoln
Discurso na inauguração do cemitério de Gettysburg.

E mais uma:

Uma pessoa que nunca errou, nunca tentou nada novo.
— Albert Einstein

Para edição de código de programação, podemos combinar a meu SyntaxHighlighter preferido, em JavaScript, com as chamadas para destaque das linhas do Asciidoc, como demonstrado no exemplo abaixo:

/* HelloWorld.java */     // (1)

public class HelloWorld { // (2)
  public static void main(String[] args) {     // (3)
      System.out.println("Olá mundão velho!"); // (4)
  }
}
1 Comentário
2 Declaração da classe HelloWorld
3 Método main() → início do programa
4 Método para exibir a mensagem no console

Estão disponíveis também algumas funcionalidades que ainda se encontram na fase experimental, mas já podemos constatar que acrescentam requintes de formatação muito interessantes. Veja uma demonstração abaixo:

Atalhos de teclado comuns nos navegadores
Atalho Propósito

F11

Muda para tela cheia

Ctrl+T

Abre uma nova aba

Ctrl+Shift+N

Abre janela para navegação anônima

Ctrl++

Aumenta o zoom

Só para você ter uma ideia da facilidade de montar a tabela acima, o código correspondente é o seguinte:

:experimental:
[options="header", caption=""]
.Atalhos de teclado comuns nos navegadores
|===
|Atalho |Propósito

|kbd:[F11]
|Muda para tela cheia

|kbd:[Ctrl+T]
|Abre uma nova aba

|kbd:[Ctrl+Shift+N]
|Abre janela para navegação anônima

|kbd:[Ctrl + +]
|Aumenta o zoom
|===

Fantástico, não é mesmo? Creio que esta pequena demonstração já serviu para deixar todo mundo com água na boca, aguçando seu desejo de aprender mais sobre o Asciidoc, a fim de incrementar a formatação dos seus artigos com extrema facilidade, tornando-os muito mais atraentes.

comments powered by Disqus