Code Monkey home page Code Monkey logo

limarka's Introduction

logo

Build Status Coverage 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.

Quem utiliza o limarka diz que ele é fácil e prazeroso, descubra o porquê!

  • 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

Exemplo de utilização do limarka

logo

Como iniciar utilização

Contribuindo com o projeto

Veja como é fácil contribuir!

OpenCollectiveOpenCollective

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

Acesse o chat no gitter e fale conosco!

Desenvolvedor Web

Nós desejamos melhorar a experiência de utilização da ferramenta implementando um site que gere conteúdos dinâmicos, gostaria de contribuir?

Acesse o chat no gitter e fale conosco!

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

Funcionalidades do limarka

  • 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, Quadros, 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.

limarka's People

Contributors

edusantana avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

limarka's Issues

Permitir atualização de configuracao.pdf

Quando uma nova versão de configuracao.pdf for gerada deve ser possível salvar os dados preenchidos no formulário e depois restaurá-lo no novo arquivo de configuração.

Configuração de proposta ou projeto

Habilitar a opção de geração de uma proposta. Gerar um texto equivalente a:

Proposta de Dissertação submetida à Coordenação do Curso de Pós-Graduação em Informática da Universidade Federal da Paraíba como parte dos requisitos necessários para obtenção do grau de Mestre em Informática.

bundle exec rspec -t projeto

Configuração e geração do pre-textual

  • Folha de rosto (obrigatório)
  • Errata (opcional)
  • Folha de aprovação (obrigatório)
  • Dedicatória (opcional) #11
  • Agradecimentos (opcional) #12
  • Epígrafe (opcional) #13
  • Resumos (obrigatório) #14
  • Lista de ilustrações (opcional) #15
  • Lista de tabelas (opcional) #16
  • Lista de abreviaturas e siglas (opcional) #17
  • Lista de símbolos (opcional) #18
  • Sumário (obrigatório) #19

Renomear o repositório para limarka

O projeto precisa de um nome para ter uma identidade, acho que limarka está bom: Linguagem de Marcação baseada no Markdown e abnTeX2.

@laurocesar não tenho permissão para renomear o projeto, será que você poderia fazer isso?

Aumentar o provisionamento de inclusão de Figura

Exemplos de utilização:

Usuário deseja incluir uma Figura:

limarka fig --imagem casa.png --legenda "Casa do artista." --fonte "Autor" --dimensoes 100 80 65

ou

limarka fig -i casa.png -l "Casa do artista." -f "Autor" -d 100 80 65

O resultado é:

  • retornar o código latex para inclusão da imagem com a legenda e fonte especificadas.
  • se especificado as dimensões, os códigos serão replicados redimensionando as imagens. No exemplo acima seriam apresentados códigos para inclusão de 3 imagens.
  • é gerado um rótulo para referenciação \label{fig:casa} ou \label{casa}
  • Texto de referenciação também é gerado: \ref{fig:casa}

Apresentar uma lista de arquivos no diretório imagens, separada de dois grupos: Não incluídas e Incluídas.

A intenção é que o usuário invoque:

limarka fig

Opção de criar tabelas

tabela:cria => solicita cabeçalho utilizando uma notação amigável (Sexo(x)(Y))(n:Valor). Isso iria criar três colunas, com Sexo acima de (x) e (y) e alinhar coluna valor como numérico.

Manter configuração na master

Manter uma branch separada com os arquivos de configuração é muito trabalhoso, portanto o arquivo configuracao.odt e imagens/configuracao serão mantidas na branch master.

Para os usuários, podemos gerar uma release sem esses arquivos e incluir o configuracao.pdf.

Configurações serão realizadas em arquivo PDF

As configurações poderiam ser realizadas em um Arquivo .yaml, no entanto, faz parte da pesquisa verificar se os usuários iriam aceitar melhor edição de um arquivo PDF.

A branch configuração irá manter os arquivos fontes para geração do PDF com formulário (configuracao.odt), e somente o PDF (configuracao.pdf) será incluído na branch master.

Para diminuir o tamanho do arquivo configuracao.odt, todas as imagens serão vinculadas em vez de embutidas.

Corrigir dependência do pdf-forms

No momento a versão atual (v1.0.0) da dependência pdf-forms não suporta campo com multiplas linhas.

Realizei um pullrequest com a correção, estou aguardando que eles publiquem uma nova versão com a correção.

Por enquanto gerei uma versão em desenvolvimento local (https://github.com/edusantana/pdf-forms/tree/v1.0.1). Se outras pessoas forem utilizar, será necessário gerar o gem e instalar localmente.

Apresentar mensagem de erro amigável quando executada fora do diretório do projeto

A mensagem atual foi:

$ limarka 
/var/lib/gems/2.3.0/gems/limarka-0.2.0/lib/limarka/trabalho.rb:143:in `ler_configuracao_pdf': Arquivo não encontrado: configuracao.pdf (IOError)
    from /var/lib/gems/2.3.0/gems/limarka-0.2.0/lib/limarka/trabalho.rb:138:in `ler_configuracao'
    from /var/lib/gems/2.3.0/gems/limarka-0.2.0/lib/limarka/trabalho.rb:124:in `atualiza_de_arquivos'
    from /var/lib/gems/2.3.0/gems/limarka-0.2.0/lib/limarka/cli.rb:84:in `exec2'
    from /usr/lib/ruby/vendor_ruby/thor/command.rb:27:in `run'
    from /usr/lib/ruby/vendor_ruby/thor/invocation.rb:126:in `invoke_command'
    from /usr/lib/ruby/vendor_ruby/thor.rb:359:in `dispatch'
    from /usr/lib/ruby/vendor_ruby/thor/base.rb:440:in `start'
    from /var/lib/gems/2.3.0/gems/limarka-0.2.0/exe/limarka:6:in `<top (required)>'
    from /usr/local/bin/limarka:23:in `load'
    from /usr/local/bin/limarka:23:in `<main>'

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.