Filtro pandoc para possibilitar contemplação das Normas da ABNT
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
exe
features
lib
spec
.gitignore
.rspec
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
pandoc_abnt.gemspec

README.md

pandoc_abnt

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/pandoc_abnt. To experiment with that code, run bin/console for an interactive prompt.

Filtro pandoc para elaborar documentos de acordo com as normas da abnt.

Installation

Add this line to your application's Gemfile:

gem 'pandoc_abnt'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pandoc_abnt

Requer pandoc v1.19.2.1.

Usage

O pandoc_abnt foi elaborado para ser utilizado com o limarka, mas projetado para ser utilizado separadamente:

pandoc --wrap=none -s --filter exe/pandoc_abnt documento.md -o documento.pdf

Funcionalidades

Fonte de Figuras e Tabelas

Para adicionar uma fonte a figura ou tabela, basta adicionar no parágrafo seguinte: Fonte: texto da fonte.

Exemplo de Figura:

![Título](imagem.png){#id escala=0.3}

Fonte: Autor.

Exemplo de Tabela:

  Right     Left     Center     Default
-------     ------ ----------   -------
     12     12        12            12
    123     123       123          123
      1     1          1             1

: Demonstration of simple table syntax. \label{mytable}

Fonte: Autor.

Você pode utilizar qualquer uma das sintaxes de tabela suportadas pelo pandoc.

OBS: O comando \label{} é necessário para permitir refenciar a tabela no Latex.

Quadros

Exemplo de sintaxe para criar Quadros:

Quadro perfil: Perfil dos voluntários do experimento

|Vol.|Formação acadêmica           |Experiência c/ Latex| Expeiência c/ Markdown|
|:-:|:----------------------------:|:------------------:|:---------------------:|
|1  |Ciência da Computação         |ShareLatex          |    Readme/Github      |
|2  |Engenharia da Computação      |Viu prof. utilizando|         -             |
|3  |Engenheiro elétrico (mestrando)|Utiliza para tudo  |         -             |

Fonte: Autor.

OBS: Esse Quadro deve ser referencia no texto com \autoref{perfil}.

Alíneas

A ABNT especifica que o texto das seções podem ser divididos em Alíneas, na prática você PODE utilizar uma lista ordenada por letras para separar o conteúdo de uma seção:

a) primeira alínea;

    Texto dentro da primeira alínea.

b) segunda alínea;

    Texto dentro da segunda alínea.

    Mais texto dentro da segunda alínea.

c) terceira alínea;

    Texto dentro da terceira alínea.

d) qualquer coisac.

    Texto dentro da quarta alínea.

Texto fora das alíneas.

OBS: Perceba que existem 4 espaços em branco indentado os parágrafos dentro das alíneas.

O pandoc_abnt implementa as seguintes funcionalidas:

  • Adiciona o parêntese automaticamente, caso tenha utilizado ponto: a. -> a)
  • Adiciona o ; em todas as alíneas, menos a última, que finaliza com ponto .. Mesmo que você que você tenha colocado a pontuação errada.
  • Aplica letra minúscula no início das alíneas automaticamente.

A alínea a seguir estaria em não conformidade com as Normas da ABNT (NBR 6024:2012). No entanto, o pandoc_abnt ajusta automaticamente para obter o resultado da alínea apresentada anteriormenete, elas são equivalentes:

a. Primeira alínea

    Texto dentro da primeira alínea.

b. Segunda alínea

    Texto dentro da segunda alínea.

    Mais texto dentro da segunda alínea.

c. Terceira alínea.

    Texto dentro da terceira alínea.

d. Qualquer coisac;

    Texto dentro da quarta alínea.

Texto fora das alíneas.

Pontuação das listas

De forma semelhante as pontuações das listas são inseridas automaticamente:

- Abacate
- Banana
- Côco

Será automaticamente corrigido para:

- abacate;
- banana;
- côco.

Para manter a primeira letra da lista em maiúsculo, deve-se utilizar um nonbreaking space:

- \ Alberto
- \ Bernadete
- \ Charles

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

A documentação é elaborada através das features do cucumber.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pandoc_abnt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.