Home

O limarka é uma ferramenta de comando de linha (sem interface gráfica) que gera PDFs em conformidade com as Normas da ABNT a partir de textos escritos em Markdown.

Bem vindo ao wiki do limarka. Por favor escolha seu tópico na barra lateral à direita.

Passos rápidos para utilização

• Verifique exemplos de PDFs gerado pelo limarka: modelo inicial
• Vídeos demonstrativos - recomendo assistir em velocidade rápida (vá em configurações do vídeo e altere a velocidade)

Instalação

A página sobre Instalação no wiki possui detalhes sobre a instalação. A instalação recomendada pode ser realizada com os comandos a seguir:

sudo apt-get install ruby-full texlive-full pandoc pdftk poppler-utils xclip jabref
sudo gem install limarka

Utilização

Baixando um esqueleto

Um esqueleto (modelo contendo os arquivos básicos para iniciar um trabalho) pode ser baixado executando:

wget https://github.com/abntex/trabalho-academico-limarka/archive/master.zip -O master.zip; unzip master.zip; rm master.zip
cd trabalho-academico-limarka-master

Verificando o conteúdo do trabalho

Inspecione o arquivo trabalho_academico.md com seu editor de texto preferido:

gedit trabalho-academico.md&

Alterando os dados de configuração

Abra o arquivo configuracao.pdf, altere os dados da capa (Instituição, Autor, Título, Local e Ano), salve o arquivo PDF com o mesmo nome configuracao.pdf.

Gerando o PDF do trabalho (compilação)

Veja a ajuda do comando:

limarka help exec

Execute o comando:

limarka exec

Abrindo o PDF

O comando xdg-open no Ubuntu abre o arquivo com o aplicativo associado ao seu tipo:

xdg-open x*.pdf

Você também pode abrir no gerenciador de arquivos.

Como o limarka funciona

Acessando as ajudas

O limarka é uma ferramenta de comandos de linha com subcomandos. A ajuda é acessada utilizando o subcomando help.

$ limarka help
Commands:
  limarka configuracao help  # Exporta e atualiza configurações
  limarka cronograma         # Imprime código para facilitar elaboração de Cronograma
  limarka exec               # Executa o sistema para geração do documento latex e compilação
  limarka fig ARQUIVO        # Imprime códigos para inclusão de imagens em conformidade com ABNT (em LaTeX)
  limarka help [COMMAND]     # Describe available commands or one specific command
  limarka importa ARQUIVO    # Cria um arquivo trabalho-academico.md com o conteúdo convertido de ARQUIVO
  limarka ref                # Adiciona ou referencia bibliografia
  limarka tab                # Imprime códigos para inclusão de tabelas em conformidade com ABNT (em LaTeX)

Para acessar a ajuda de um subcomando, invoque help <subcomando>. Veja um exemplo para acessar a ajuda do subcomando importa:

$ limarka help importa
Usage:
  limarka importa ARQUIVO

Description:
  Converte documento do Word (ou similar) para trabalho-academico.md. O arquivo será criado no mesmo diretório que contém ARQUIVO. Útil quando 
  possuímos um arquivo já digitado no word e desejamos utilizar o limarka. Mantém, por exemplo, as marcações de itálico, negrito e notas de 
  rodapé.

Configuração

A configuração do limarka é realizada no arquivo configuracao.pdf (ou configuracao.yaml -- uso avançado).

Esse arquivo possui um formulário que possibilita o configurar diversos aspectos do trabalho. O usuário deve preencher o formulário e salvar/sobrescrever o PDF com os dados alterados. O limarka irá ler o conteúdo desse arquivo e realizar as ações apropriadas.

O arquivo configuracao.pdf é autoexplicativo, informa as configurações possíveis e os resultados esperados.

Para mais detalhes consulte:

• Configuração

Escrevendo o trabalho com Markdown

A principal funcionalidade do limarka é possibilitar a escrita do trabalho acadêmico na linguagem Markdown. Todos os arquivos de texto (*.md) utilizam a mesma sintaxe.

Os principais arquivos de texto são:

• trabalho-academico.md (corpo do trabalho)
• anexos.md e apendices.md e (requer habilitação na configuração)

Também é possível incluir códigos Latex (como fórmulas, tabelas etc) no texto.

Para mais detalhes consulte:

• Sintaxe

Referências bibtex

O limarka utiliza um arquivo bibtex (referencias.bib) para gerenciar as referências. Você pode utilizar o JabRef para gerencias as referências:

jabref referencias.bib&

A escolha do sistema de referenciação (Numérico ou Alfanumérico) na configuração possui um grande impacto na produção do texto. Experimente os dois sistemas e escolha qual que irá utilizar.

Para mais detalhes consulte:

• Referências
• Comando limarka ref add

Performance

O tempo de execução é altamente influenciado pelo processo de compilação do Latex. Ao executar sobre um proposta genérica, sem invocar a compilação em PDF o processo demorou aproximadamente 2,5 segundos:

$ rm xxx*
$ time limarka --no-compila-tex

real	0m2.457s
user	0m2.088s
sys	0m0.428s

Ao invocar com a compilação PDF o tempo subiu para aproximadamente 15,6 segundos:

$ rm xxx*
$ time limarka

real	0m15.674s
user	0m18.112s
sys	0m1.732s

Próximos passos

Para usuários

• Arquivos
• Editores

Para usuários avançados

• Templates

Para desenvolvedores

• Desenvolvimento