Refactory - abntex/limarka GitHub Wiki
- 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)
Inspecione o arquivo trabalho_academico.md com seu editor de texto preferido:
gedit trabalho-academico.md&
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é.
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:
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
eapendices.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:
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