logo

Build Status Gem Version Join the chat at https://gitter.im/abntex/limarka

Normas da ABNT em 2017: Atualizadas NBR 14724:2011 100%

Olá! Bem vindo ao limarka!

O limarka é uma ferramenta que possibilita seus usuários escreverem relatórios ou trabalhos de conclusão de curso (Monografia, TCC, Dissertação ou Tese) em arquivos somente texto e produzir PDFs em conformidades com as Normas da ABNT. A produção desse tipo de trabalho é um momento sensível na vida dos estudantes, que pode contribuir para evasão no ensino superior. O objetivo do limarka é liberar dos estudantes os esforços de formatação e adequação às Normas da ABNT, deixando-os concentrar-se no planejamento, execução e escrita de seus trabalhos.

Especificidades do limarka

  • Exige conhecimentos mínimos sobre as Normas da ABNT
  • Utiliza modelo com estilos pré-configurados com as normas e de fácil utilização
  • Utiliza sistema para gerenciamento de citações e elaboração das referências automaticamente
  • Gera o sumário automaticamente, sem esforço adicional
  • Permite a escrita do trabalho em arquivos somente texto, utilizando Markdown
  • As configurações são realizadas em um arquivo de formulário em PDF

Como iniciar utilização

Contribuindo com o projeto

Veja como é fácil contribuir!

Professor

  • Atualize sua página pessoal/institucional adicionando uma matéria ou link sobre o limarka
  • Solicite incluir o limarka como uma alternativa nos materiais de instruções de produção de trabalhos de conclusão, ou nas disciplinas de Metodologia.
  • Ao solicitar relatórios de atividades aos alunos, sugira a utilização do limarka.
  • Divulgue um notícia sobre o limarka nas listas de professores ou alunos.
  • Recomende a veiculação de uma matéria sobre o limarka na agência de noticias de sua instituição.
  • Sugira seus orientandos experimentarem o limarka.
  • Clique na estrela no repositório do projeto (equivale a um like)

Estudante

  • Utilize o limarka para elaboração de relatórios
  • Participe do experimente de uso da ferramenta - NECESSITA-SE URGENTEMENTE!
  • Compartilhe alguma notícia do limarka em suas redes sociais ou lista de alunos
  • Escreva seu trabalho de conclusão com o limarka e compartilhe sua experiência
  • Clique na estrela no repositório do projeto (equivale a um like)

Usuário Latex

  • Auxilie na criação de templates latex customizados para as instituições

Desenvolvedor Ruby

GitHub issues

Todas as formas de contribuição

Consulte o arquivo CONTRIBUTING.md para verificar todas as formas de contribuições.

Deseja entrar em contato?

O meio de comunicação oficial do limarka é uma sala de bate papo no gitter: Join the chat at https://gitter.im/abntex/limarka

Links

Por que escrever em Markdown em vez de Latex?

O LaTeX é ótimo e bastante útil para quem deseja percorrer uma carreira de Pesquisador. Muitos journals disponibilizam modelos somente em LaTeX para produção de artigos, aprender LaTeX irá ser útil nessa carreira. Mas se você não pretende utilizar LaTeX após a conclusão do seu curso, por que investir na longa curva de aprendizado do LaTeX?

Com o limarka você agora possui outra alternativa de investimento: aprender Markdown (que é bastante simples).

O Markdown é uma linguagem simples de marcação. Os princípios das linguagem simples de marcação estão sendo popularizados em diversas ferramentas de interação social, veja alguns exemplos: Github, Moodle, WhatsApp, Facebook Google Plus, Jekyll, etc.

Após ou durante conclusão do seu curso, você pretende:

  • Interagir através da escrita em redes sociais ou fóruns de discussão?
  • Editar Wikis ou formatar mensagens?
  • Participar em projetos no Github?
  • Escrever documentações de softwares?
  • Gerar código HTML a partir de texto?
  • Elaborar ebooks?

Se você respondeu afirmativamente a algumas dessas perguntas, aprender uma linguagem simples de marcação (como o Markdown) é um investimento rentável.

OBS: A implementação atual do limarka ainda exige conhecimentos mínimos do Latex.

Qual a relação do limarka com o abnTeX?

O abnTeX provém uma suíte para LaTeX que atende os requisitos das normas da ABNT (Associação Brasileira de Normas Técnicas) para elaboração de trabalhos acadêmicos como teses, dissertações, projetos de pesquisa e outros documentos do gênero.

O limarka converte os textos produzidos em Markdown para LaTeX, utilizando os modelos do abnTeX2 (que são extensivamente testados e incrementados pela comunidade nacional), produzindo um PDF em conformidade com as Normas da ABNT. O limarka é um projeto pertencente ao grupo do abnTeX.

Funcionalidades

  • Utilização da linguagem Markdown para escrita do texto;
  • Configurações através de formulário PDF ou arquivo YAML;
  • Possibilidade de inclusão de códigos Latex;
  • Facilidade para geração de códigos para inclusão de Figuras, Tabelas, Referências e Citações;
  • Facilidade em edição ou personalização de templates;
  • Facilidade de obter suporte ao código Latex gerado (compatível com o estilo do abnTeX2);

License

Esse gem é disponibilizado como software livre através da Licença MIT.